SipHash: make it possible to control the hash size through string controls
[openssl.git] / crypto / siphash / siphash_pmeth.c
1 /*
2  * Copyright 2007-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <stdio.h>
11 #include "internal/cryptlib.h"
12 #include <openssl/x509.h>
13 #include <openssl/x509v3.h>
14 #include <openssl/evp.h>
15 #include <openssl/err.h>
16 #include "internal/siphash.h"
17 #include "siphash_local.h"
18 #include "internal/evp_int.h"
19
20 /* SIPHASH pkey context structure */
21
22 typedef struct siphash_pkey_ctx_st {
23     ASN1_OCTET_STRING ktmp;     /* Temp storage for key */
24     SIPHASH ctx;
25 } SIPHASH_PKEY_CTX;
26
27 static int pkey_siphash_init(EVP_PKEY_CTX *ctx)
28 {
29     SIPHASH_PKEY_CTX *pctx;
30
31     if ((pctx = OPENSSL_zalloc(sizeof(*pctx))) == NULL) {
32         CRYPTOerr(CRYPTO_F_PKEY_SIPHASH_INIT, ERR_R_MALLOC_FAILURE);
33         return 0;
34     }
35     pctx->ktmp.type = V_ASN1_OCTET_STRING;
36
37     EVP_PKEY_CTX_set_data(ctx, pctx);
38     EVP_PKEY_CTX_set0_keygen_info(ctx, NULL, 0);
39     return 1;
40 }
41
42 static void pkey_siphash_cleanup(EVP_PKEY_CTX *ctx)
43 {
44     SIPHASH_PKEY_CTX *pctx = EVP_PKEY_CTX_get_data(ctx);
45
46     if (pctx != NULL) {
47         OPENSSL_clear_free(pctx->ktmp.data, pctx->ktmp.length);
48         OPENSSL_clear_free(pctx, sizeof(*pctx));
49         EVP_PKEY_CTX_set_data(ctx, NULL);
50     }
51 }
52
53 static int pkey_siphash_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
54 {
55     SIPHASH_PKEY_CTX *sctx, *dctx;
56
57     /* allocate memory for dst->data and a new SIPHASH_CTX in dst->data->ctx */
58     if (!pkey_siphash_init(dst))
59         return 0;
60     sctx = EVP_PKEY_CTX_get_data(src);
61     dctx = EVP_PKEY_CTX_get_data(dst);
62     if (ASN1_STRING_get0_data(&sctx->ktmp) != NULL &&
63         !ASN1_STRING_copy(&dctx->ktmp, &sctx->ktmp)) {
64         /* cleanup and free the SIPHASH_PKEY_CTX in dst->data */
65         pkey_siphash_cleanup(dst);
66         return 0;
67     }
68     memcpy(&dctx->ctx, &sctx->ctx, sizeof(SIPHASH));
69     return 1;
70 }
71
72 static int pkey_siphash_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
73 {
74     ASN1_OCTET_STRING *key;
75     SIPHASH_PKEY_CTX *pctx = EVP_PKEY_CTX_get_data(ctx);
76
77     if (ASN1_STRING_get0_data(&pctx->ktmp) == NULL)
78         return 0;
79     key = ASN1_OCTET_STRING_dup(&pctx->ktmp);
80     if (key == NULL)
81         return 0;
82     return EVP_PKEY_assign_SIPHASH(pkey, key);
83 }
84
85 static int int_update(EVP_MD_CTX *ctx, const void *data, size_t count)
86 {
87     SIPHASH_PKEY_CTX *pctx = EVP_PKEY_CTX_get_data(EVP_MD_CTX_pkey_ctx(ctx));
88
89     SipHash_Update(&pctx->ctx, data, count);
90     return 1;
91 }
92
93 static int siphash_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
94 {
95     SIPHASH_PKEY_CTX *pctx = EVP_PKEY_CTX_get_data(ctx);
96     const unsigned char* key;
97     size_t len;
98     int hash_size;
99
100     key = EVP_PKEY_get0_siphash(EVP_PKEY_CTX_get0_pkey(ctx), &len);
101     if (key == NULL || len != SIPHASH_KEY_SIZE)
102         return 0;
103     EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
104     EVP_MD_CTX_set_update_fn(mctx, int_update);
105     /* use default rounds (2,4) */
106     hash_size = SipHash_hash_size(&pctx->ctx);
107     return SipHash_Init(&pctx->ctx, key, hash_size, 0, 0);
108 }
109 static int siphash_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
110                             EVP_MD_CTX *mctx)
111 {
112     SIPHASH_PKEY_CTX *pctx = ctx->data;
113
114     *siglen = SipHash_hash_size(&pctx->ctx);
115     if (sig != NULL)
116         return SipHash_Final(&pctx->ctx, sig, *siglen);
117     return 1;
118 }
119
120 static int pkey_siphash_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
121 {
122     SIPHASH_PKEY_CTX *pctx = EVP_PKEY_CTX_get_data(ctx);
123     const unsigned char *key;
124     size_t len;
125     int hash_size;
126
127     switch (type) {
128
129     case EVP_PKEY_CTRL_MD:
130         /* ignore */
131         break;
132
133     case EVP_PKEY_CTRL_SET_DIGEST_SIZE:
134         if (p1 != SIPHASH_MIN_DIGEST_SIZE &&
135             p1 != SIPHASH_MAX_DIGEST_SIZE) {
136             return 0;
137         }
138         /* use default rounds (2,4) */
139         return SipHash_Init(&pctx->ctx, ASN1_STRING_get0_data(&pctx->ktmp), p1, 0, 0);
140
141     case EVP_PKEY_CTRL_SET_MAC_KEY:
142     case EVP_PKEY_CTRL_DIGESTINIT:
143         if (type == EVP_PKEY_CTRL_SET_MAC_KEY) {
144             /* user explicitly setting the key */
145             key = p2;
146             len = p1;
147         } else {
148             /* user indirectly setting the key via EVP_DigestSignInit */
149             key = EVP_PKEY_get0_siphash(EVP_PKEY_CTX_get0_pkey(ctx), &len);
150         }
151         if (key == NULL || len != SIPHASH_KEY_SIZE ||
152             !ASN1_OCTET_STRING_set(&pctx->ktmp, key, len))
153             return 0;
154         /* use default rounds (2,4) */
155         hash_size = SipHash_hash_size(&pctx->ctx);
156         return SipHash_Init(&pctx->ctx, ASN1_STRING_get0_data(&pctx->ktmp), hash_size, 0, 0);
157
158     default:
159         return -2;
160
161     }
162     return 1;
163 }
164
165 static int pkey_siphash_ctrl_str(EVP_PKEY_CTX *ctx,
166                                   const char *type, const char *value)
167 {
168     if (value == NULL)
169         return 0;
170     if (strcmp(type, "digestsize") == 0) {
171         size_t hash_size = atoi(value);
172
173         return pkey_siphash_ctrl(ctx, EVP_PKEY_CTRL_SET_DIGEST_SIZE, hash_size,
174                                  NULL);
175     }
176     if (strcmp(type, "key") == 0)
177         return EVP_PKEY_CTX_str2ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, value);
178     if (strcmp(type, "hexkey") == 0)
179         return EVP_PKEY_CTX_hex2ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, value);
180     return -2;
181 }
182
183 const EVP_PKEY_METHOD siphash_pkey_meth = {
184     EVP_PKEY_SIPHASH,
185     EVP_PKEY_FLAG_SIGCTX_CUSTOM, /* we don't deal with a separate MD */
186     pkey_siphash_init,
187     pkey_siphash_copy,
188     pkey_siphash_cleanup,
189
190     0, 0,
191
192     0,
193     pkey_siphash_keygen,
194
195     0, 0,
196
197     0, 0,
198
199     0, 0,
200
201     siphash_signctx_init,
202     siphash_signctx,
203
204     0, 0,
205
206     0, 0,
207
208     0, 0,
209
210     0, 0,
211
212     pkey_siphash_ctrl,
213     pkey_siphash_ctrl_str
214 };