af9adc30961586d6916ec2a3f98ae9c5e4c5e724
[openssl.git] / providers / implementations / kdfs / tls1_prf.c
1 /*
2  * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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 /*
11  * Refer to "The TLS Protocol Version 1.0" Section 5
12  * (https://tools.ietf.org/html/rfc2246#section-5) and
13  * "The Transport Layer Security (TLS) Protocol Version 1.2" Section 5
14  * (https://tools.ietf.org/html/rfc5246#section-5).
15  *
16  * For TLS v1.0 and TLS v1.1 the TLS PRF algorithm is given by:
17  *
18  *   PRF(secret, label, seed) = P_MD5(S1, label + seed) XOR
19  *                              P_SHA-1(S2, label + seed)
20  *
21  * where P_MD5 and P_SHA-1 are defined by P_<hash>, below, and S1 and S2 are
22  * two halves of the secret (with the possibility of one shared byte, in the
23  * case where the length of the original secret is odd).  S1 is taken from the
24  * first half of the secret, S2 from the second half.
25  *
26  * For TLS v1.2 the TLS PRF algorithm is given by:
27  *
28  *   PRF(secret, label, seed) = P_<hash>(secret, label + seed)
29  *
30  * where hash is SHA-256 for all cipher suites defined in RFC 5246 as well as
31  * those published prior to TLS v1.2 while the TLS v1.2 protocol is in effect,
32  * unless defined otherwise by the cipher suite.
33  *
34  * P_<hash> is an expansion function that uses a single hash function to expand
35  * a secret and seed into an arbitrary quantity of output:
36  *
37  *   P_<hash>(secret, seed) = HMAC_<hash>(secret, A(1) + seed) +
38  *                            HMAC_<hash>(secret, A(2) + seed) +
39  *                            HMAC_<hash>(secret, A(3) + seed) + ...
40  *
41  * where + indicates concatenation.  P_<hash> can be iterated as many times as
42  * is necessary to produce the required quantity of data.
43  *
44  * A(i) is defined as:
45  *     A(0) = seed
46  *     A(i) = HMAC_<hash>(secret, A(i-1))
47  */
48 #include <stdio.h>
49 #include <stdarg.h>
50 #include <string.h>
51 #include <openssl/evp.h>
52 #include <openssl/kdf.h>
53 #include <openssl/core_names.h>
54 #include <openssl/params.h>
55 #include <openssl/proverr.h>
56 #include "internal/cryptlib.h"
57 #include "internal/numbers.h"
58 #include "crypto/evp.h"
59 #include "prov/provider_ctx.h"
60 #include "prov/providercommon.h"
61 #include "prov/implementations.h"
62 #include "prov/provider_util.h"
63 #include "e_os.h"
64
65 static OSSL_FUNC_kdf_newctx_fn kdf_tls1_prf_new;
66 static OSSL_FUNC_kdf_freectx_fn kdf_tls1_prf_free;
67 static OSSL_FUNC_kdf_reset_fn kdf_tls1_prf_reset;
68 static OSSL_FUNC_kdf_derive_fn kdf_tls1_prf_derive;
69 static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_tls1_prf_settable_ctx_params;
70 static OSSL_FUNC_kdf_set_ctx_params_fn kdf_tls1_prf_set_ctx_params;
71 static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_tls1_prf_gettable_ctx_params;
72 static OSSL_FUNC_kdf_get_ctx_params_fn kdf_tls1_prf_get_ctx_params;
73
74 static int tls1_prf_alg(EVP_MAC_CTX *mdctx, EVP_MAC_CTX *sha1ctx,
75                         const unsigned char *sec, size_t slen,
76                         const unsigned char *seed, size_t seed_len,
77                         unsigned char *out, size_t olen);
78
79 #define TLS1_PRF_MAXBUF 1024
80
81 /* TLS KDF kdf context structure */
82 typedef struct {
83     void *provctx;
84
85     /* MAC context for the main digest */
86     EVP_MAC_CTX *P_hash;
87     /* MAC context for SHA1 for the MD5/SHA-1 combined PRF */
88     EVP_MAC_CTX *P_sha1;
89
90     /* Secret value to use for PRF */
91     unsigned char *sec;
92     size_t seclen;
93     /* Buffer of concatenated seed data */
94     unsigned char seed[TLS1_PRF_MAXBUF];
95     size_t seedlen;
96 } TLS1_PRF;
97
98 static void *kdf_tls1_prf_new(void *provctx)
99 {
100     TLS1_PRF *ctx;
101
102     if (!ossl_prov_is_running())
103         return NULL;
104
105     if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
106         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
107     ctx->provctx = provctx;
108     return ctx;
109 }
110
111 static void kdf_tls1_prf_free(void *vctx)
112 {
113     TLS1_PRF *ctx = (TLS1_PRF *)vctx;
114
115     if (ctx != NULL) {
116         kdf_tls1_prf_reset(ctx);
117         OPENSSL_free(ctx);
118     }
119 }
120
121 static void kdf_tls1_prf_reset(void *vctx)
122 {
123     TLS1_PRF *ctx = (TLS1_PRF *)vctx;
124     void *provctx = ctx->provctx;
125
126     EVP_MAC_CTX_free(ctx->P_hash);
127     EVP_MAC_CTX_free(ctx->P_sha1);
128     OPENSSL_clear_free(ctx->sec, ctx->seclen);
129     OPENSSL_cleanse(ctx->seed, ctx->seedlen);
130     memset(ctx, 0, sizeof(*ctx));
131     ctx->provctx = provctx;
132 }
133
134 static int kdf_tls1_prf_derive(void *vctx, unsigned char *key,
135                                size_t keylen)
136 {
137     TLS1_PRF *ctx = (TLS1_PRF *)vctx;
138
139     if (!ossl_prov_is_running())
140         return 0;
141
142     if (ctx->P_hash == NULL) {
143         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
144         return 0;
145     }
146     if (ctx->sec == NULL) {
147         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SECRET);
148         return 0;
149     }
150     if (ctx->seedlen == 0) {
151         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SEED);
152         return 0;
153     }
154     if (keylen == 0) {
155         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
156         return 0;
157     }
158
159     return tls1_prf_alg(ctx->P_hash, ctx->P_sha1,
160                         ctx->sec, ctx->seclen,
161                         ctx->seed, ctx->seedlen,
162                         key, keylen);
163 }
164
165 static int kdf_tls1_prf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
166 {
167     const OSSL_PARAM *p;
168     TLS1_PRF *ctx = vctx;
169     OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
170
171     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_DIGEST)) != NULL) {
172         if (strcasecmp(p->data, SN_md5_sha1) == 0) {
173             if (!ossl_prov_macctx_load_from_params(&ctx->P_hash, params,
174                                                    OSSL_MAC_NAME_HMAC,
175                                                    NULL, SN_md5, libctx)
176                 || !ossl_prov_macctx_load_from_params(&ctx->P_sha1, params,
177                                                       OSSL_MAC_NAME_HMAC,
178                                                       NULL, SN_sha1, libctx))
179                 return 0;
180         } else {
181             EVP_MAC_CTX_free(ctx->P_sha1);
182             if (!ossl_prov_macctx_load_from_params(&ctx->P_hash, params,
183                                                    OSSL_MAC_NAME_HMAC,
184                                                    NULL, NULL, libctx))
185                 return 0;
186         }
187     }
188
189     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SECRET)) != NULL) {
190         OPENSSL_clear_free(ctx->sec, ctx->seclen);
191         ctx->sec = NULL;
192         if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->sec, 0, &ctx->seclen))
193             return 0;
194     }
195     /* The seed fields concatenate, so process them all */
196     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SEED)) != NULL) {
197         for (; p != NULL; p = OSSL_PARAM_locate_const(p + 1,
198                                                       OSSL_KDF_PARAM_SEED)) {
199             const void *q = ctx->seed + ctx->seedlen;
200             size_t sz = 0;
201
202             if (p->data_size != 0
203                 && p->data != NULL
204                 && !OSSL_PARAM_get_octet_string(p, (void **)&q,
205                                                 TLS1_PRF_MAXBUF - ctx->seedlen,
206                                                 &sz))
207                 return 0;
208             ctx->seedlen += sz;
209         }
210     }
211     return 1;
212 }
213
214 static const OSSL_PARAM *kdf_tls1_prf_settable_ctx_params(
215         ossl_unused void *ctx, ossl_unused void *provctx)
216 {
217     static const OSSL_PARAM known_settable_ctx_params[] = {
218         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
219         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
220         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SECRET, NULL, 0),
221         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SEED, NULL, 0),
222         OSSL_PARAM_END
223     };
224     return known_settable_ctx_params;
225 }
226
227 static int kdf_tls1_prf_get_ctx_params(void *vctx, OSSL_PARAM params[])
228 {
229     OSSL_PARAM *p;
230
231     if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
232         return OSSL_PARAM_set_size_t(p, SIZE_MAX);
233     return -2;
234 }
235
236 static const OSSL_PARAM *kdf_tls1_prf_gettable_ctx_params(
237         ossl_unused void *ctx, ossl_unused void *provctx)
238 {
239     static const OSSL_PARAM known_gettable_ctx_params[] = {
240         OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
241         OSSL_PARAM_END
242     };
243     return known_gettable_ctx_params;
244 }
245
246 const OSSL_DISPATCH ossl_kdf_tls1_prf_functions[] = {
247     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_tls1_prf_new },
248     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_tls1_prf_free },
249     { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_tls1_prf_reset },
250     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_tls1_prf_derive },
251     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
252       (void(*)(void))kdf_tls1_prf_settable_ctx_params },
253     { OSSL_FUNC_KDF_SET_CTX_PARAMS,
254       (void(*)(void))kdf_tls1_prf_set_ctx_params },
255     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
256       (void(*)(void))kdf_tls1_prf_gettable_ctx_params },
257     { OSSL_FUNC_KDF_GET_CTX_PARAMS,
258       (void(*)(void))kdf_tls1_prf_get_ctx_params },
259     { 0, NULL }
260 };
261
262 /*
263  * Refer to "The TLS Protocol Version 1.0" Section 5
264  * (https://tools.ietf.org/html/rfc2246#section-5) and
265  * "The Transport Layer Security (TLS) Protocol Version 1.2" Section 5
266  * (https://tools.ietf.org/html/rfc5246#section-5).
267  *
268  * P_<hash> is an expansion function that uses a single hash function to expand
269  * a secret and seed into an arbitrary quantity of output:
270  *
271  *   P_<hash>(secret, seed) = HMAC_<hash>(secret, A(1) + seed) +
272  *                            HMAC_<hash>(secret, A(2) + seed) +
273  *                            HMAC_<hash>(secret, A(3) + seed) + ...
274  *
275  * where + indicates concatenation.  P_<hash> can be iterated as many times as
276  * is necessary to produce the required quantity of data.
277  *
278  * A(i) is defined as:
279  *     A(0) = seed
280  *     A(i) = HMAC_<hash>(secret, A(i-1))
281  */
282 static int tls1_prf_P_hash(EVP_MAC_CTX *ctx_init,
283                            const unsigned char *sec, size_t sec_len,
284                            const unsigned char *seed, size_t seed_len,
285                            unsigned char *out, size_t olen)
286 {
287     size_t chunk;
288     EVP_MAC_CTX *ctx = NULL, *ctx_Ai = NULL;
289     unsigned char Ai[EVP_MAX_MD_SIZE];
290     size_t Ai_len;
291     int ret = 0;
292
293     if (!EVP_MAC_init(ctx_init, sec, sec_len, NULL))
294         goto err;
295     chunk = EVP_MAC_CTX_get_mac_size(ctx_init);
296     if (chunk == 0)
297         goto err;
298     /* A(0) = seed */
299     ctx_Ai = EVP_MAC_CTX_dup(ctx_init);
300     if (ctx_Ai == NULL)
301         goto err;
302     if (seed != NULL && !EVP_MAC_update(ctx_Ai, seed, seed_len))
303         goto err;
304
305     for (;;) {
306         /* calc: A(i) = HMAC_<hash>(secret, A(i-1)) */
307         if (!EVP_MAC_final(ctx_Ai, Ai, &Ai_len, sizeof(Ai)))
308             goto err;
309         EVP_MAC_CTX_free(ctx_Ai);
310         ctx_Ai = NULL;
311
312         /* calc next chunk: HMAC_<hash>(secret, A(i) + seed) */
313         ctx = EVP_MAC_CTX_dup(ctx_init);
314         if (ctx == NULL)
315             goto err;
316         if (!EVP_MAC_update(ctx, Ai, Ai_len))
317             goto err;
318         /* save state for calculating next A(i) value */
319         if (olen > chunk) {
320             ctx_Ai = EVP_MAC_CTX_dup(ctx);
321             if (ctx_Ai == NULL)
322                 goto err;
323         }
324         if (seed != NULL && !EVP_MAC_update(ctx, seed, seed_len))
325             goto err;
326         if (olen <= chunk) {
327             /* last chunk - use Ai as temp bounce buffer */
328             if (!EVP_MAC_final(ctx, Ai, &Ai_len, sizeof(Ai)))
329                 goto err;
330             memcpy(out, Ai, olen);
331             break;
332         }
333         if (!EVP_MAC_final(ctx, out, NULL, olen))
334             goto err;
335         EVP_MAC_CTX_free(ctx);
336         ctx = NULL;
337         out += chunk;
338         olen -= chunk;
339     }
340     ret = 1;
341  err:
342     EVP_MAC_CTX_free(ctx);
343     EVP_MAC_CTX_free(ctx_Ai);
344     OPENSSL_cleanse(Ai, sizeof(Ai));
345     return ret;
346 }
347
348 /*
349  * Refer to "The TLS Protocol Version 1.0" Section 5
350  * (https://tools.ietf.org/html/rfc2246#section-5) and
351  * "The Transport Layer Security (TLS) Protocol Version 1.2" Section 5
352  * (https://tools.ietf.org/html/rfc5246#section-5).
353  *
354  * For TLS v1.0 and TLS v1.1:
355  *
356  *   PRF(secret, label, seed) = P_MD5(S1, label + seed) XOR
357  *                              P_SHA-1(S2, label + seed)
358  *
359  * S1 is taken from the first half of the secret, S2 from the second half.
360  *
361  *   L_S = length in bytes of secret;
362  *   L_S1 = L_S2 = ceil(L_S / 2);
363  *
364  * For TLS v1.2:
365  *
366  *   PRF(secret, label, seed) = P_<hash>(secret, label + seed)
367  */
368 static int tls1_prf_alg(EVP_MAC_CTX *mdctx, EVP_MAC_CTX *sha1ctx,
369                         const unsigned char *sec, size_t slen,
370                         const unsigned char *seed, size_t seed_len,
371                         unsigned char *out, size_t olen)
372 {
373     if (sha1ctx != NULL) {
374         /* TLS v1.0 and TLS v1.1 */
375         size_t i;
376         unsigned char *tmp;
377         /* calc: L_S1 = L_S2 = ceil(L_S / 2) */
378         size_t L_S1 = (slen + 1) / 2;
379         size_t L_S2 = L_S1;
380
381         if (!tls1_prf_P_hash(mdctx, sec, L_S1,
382                              seed, seed_len, out, olen))
383             return 0;
384
385         if ((tmp = OPENSSL_malloc(olen)) == NULL) {
386             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
387             return 0;
388         }
389
390         if (!tls1_prf_P_hash(sha1ctx, sec + slen - L_S2, L_S2,
391                              seed, seed_len, tmp, olen)) {
392             OPENSSL_clear_free(tmp, olen);
393             return 0;
394         }
395         for (i = 0; i < olen; i++)
396             out[i] ^= tmp[i];
397         OPENSSL_clear_free(tmp, olen);
398         return 1;
399     }
400
401     /* TLS v1.2 */
402     if (!tls1_prf_P_hash(mdctx, sec, slen, seed, seed_len, out, olen))
403         return 0;
404
405     return 1;
406 }