Add missing blank lines and cosmetic improvements
[openssl.git] / ssl / tls13_enc.c
1 /*
2  * Copyright 2016 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 <stdlib.h>
11 #include "ssl_locl.h"
12 #include <openssl/evp.h>
13 #include <openssl/kdf.h>
14
15 #define TLS13_MAX_LABEL_LEN     246
16
17 /* Always filled with zeros */
18 static const unsigned char default_zeros[EVP_MAX_MD_SIZE];
19
20 /*
21  * Given a |secret|; a |label| of length |labellen|; and a |hash| of the
22  * handshake messages, derive a new secret |outlen| bytes long and store it in
23  * the location pointed to be |out|. The |hash| value may be NULL. Returns 1 on
24  * success  0 on failure.
25  */
26 int tls13_hkdf_expand(SSL *s, const EVP_MD *md, const unsigned char *secret,
27                              const unsigned char *label, size_t labellen,
28                              const unsigned char *hash,
29                              unsigned char *out, size_t outlen)
30 {
31     const unsigned char label_prefix[] = "TLS 1.3, ";
32     EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, NULL);
33     int ret;
34     size_t hkdflabellen;
35     size_t hashlen;
36     /*
37      * 2 bytes for length of whole HkdfLabel + 1 byte for length of combined
38      * prefix and label + bytes for the label itself + bytes for the hash
39      */
40     unsigned char hkdflabel[sizeof(uint16_t) + sizeof(uint8_t) +
41                             + sizeof(label_prefix) + TLS13_MAX_LABEL_LEN
42                             + EVP_MAX_MD_SIZE];
43     WPACKET pkt;
44
45     if (pctx == NULL)
46         return 0;
47
48     hashlen = EVP_MD_size(md);
49
50     if (!WPACKET_init_static_len(&pkt, hkdflabel, sizeof(hkdflabel), 0)
51             || !WPACKET_put_bytes_u16(&pkt, outlen)
52             || !WPACKET_start_sub_packet_u8(&pkt)
53             || !WPACKET_memcpy(&pkt, label_prefix, sizeof(label_prefix) - 1)
54             || !WPACKET_memcpy(&pkt, label, labellen)
55             || !WPACKET_close(&pkt)
56             || !WPACKET_sub_memcpy_u8(&pkt, hash, (hash == NULL) ? 0 : hashlen)
57             || !WPACKET_get_total_written(&pkt, &hkdflabellen)
58             || !WPACKET_finish(&pkt)) {
59         WPACKET_cleanup(&pkt);
60         return 0;
61     }
62
63     ret = EVP_PKEY_derive_init(pctx) <= 0
64             || EVP_PKEY_CTX_hkdf_mode(pctx, EVP_PKEY_HKDEF_MODE_EXPAND_ONLY)
65                <= 0
66             || EVP_PKEY_CTX_set_hkdf_md(pctx, md) <= 0
67             || EVP_PKEY_CTX_set1_hkdf_key(pctx, secret, hashlen) <= 0
68             || EVP_PKEY_CTX_add1_hkdf_info(pctx, hkdflabel, hkdflabellen) <= 0
69             || EVP_PKEY_derive(pctx, out, &outlen) <= 0;
70
71     EVP_PKEY_CTX_free(pctx);
72
73     return ret == 0;
74 }
75
76 /*
77  * Given a |secret| generate a |key| of length |keylen| bytes. Returns 1 on
78  * success  0 on failure.
79  */
80 int tls13_derive_key(SSL *s, const unsigned char *secret, unsigned char *key,
81                      size_t keylen)
82 {
83     static const unsigned char keylabel[] = "key";
84
85     return tls13_hkdf_expand(s, ssl_handshake_md(s), secret, keylabel,
86                              sizeof(keylabel) - 1, NULL, key, keylen);
87 }
88
89 /*
90  * Given a |secret| generate an |iv| of length |ivlen| bytes. Returns 1 on
91  * success  0 on failure.
92  */
93 int tls13_derive_iv(SSL *s, const unsigned char *secret, unsigned char *iv,
94                     size_t ivlen)
95 {
96     static const unsigned char ivlabel[] = "iv";
97
98     return tls13_hkdf_expand(s, ssl_handshake_md(s), secret, ivlabel,
99                              sizeof(ivlabel) - 1, NULL, iv, ivlen);
100 }
101
102 int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
103                              const unsigned char *secret,
104                              unsigned char *fin, size_t finlen)
105 {
106     static const unsigned char finishedlabel[] = "finished";
107
108     return tls13_hkdf_expand(s, md, secret, finishedlabel,
109                              sizeof(finishedlabel) - 1, NULL, fin, finlen);
110 }
111
112 /*
113  * Given the previous secret |prevsecret| and a new input secret |insecret| of
114  * length |insecretlen|, generate a new secret and store it in the location
115  * pointed to by |outsecret|. Returns 1 on success  0 on failure.
116  */
117 int tls13_generate_secret(SSL *s, const EVP_MD *md,
118                           const unsigned char *prevsecret,
119                           const unsigned char *insecret,
120                           size_t insecretlen,
121                           unsigned char *outsecret)
122 {
123     size_t mdlen, prevsecretlen;
124     int ret;
125     EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, NULL);
126
127     if (pctx == NULL)
128         return 0;
129
130     mdlen = EVP_MD_size(md);
131
132     if (insecret == NULL) {
133         insecret = default_zeros;
134         insecretlen = mdlen;
135     }
136     if (prevsecret == NULL) {
137         prevsecret = default_zeros;
138         prevsecretlen = 0;
139     } else {
140         prevsecretlen = mdlen;
141     }
142
143     ret = EVP_PKEY_derive_init(pctx) <= 0
144             || EVP_PKEY_CTX_hkdf_mode(pctx, EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY)
145                <= 0
146             || EVP_PKEY_CTX_set_hkdf_md(pctx, md) <= 0
147             || EVP_PKEY_CTX_set1_hkdf_key(pctx, insecret, insecretlen) <= 0
148             || EVP_PKEY_CTX_set1_hkdf_salt(pctx, prevsecret, prevsecretlen)
149                <= 0
150             || EVP_PKEY_derive(pctx, outsecret, &mdlen)
151                <= 0;
152
153     EVP_PKEY_CTX_free(pctx);
154     return ret == 0;
155 }
156
157 /*
158  * Given an input secret |insecret| of length |insecretlen| generate the
159  * handshake secret. This requires the early secret to already have been
160  * generated. Returns 1 on success  0 on failure.
161  */
162 int tls13_generate_handshake_secret(SSL *s, const unsigned char *insecret,
163                                 size_t insecretlen)
164 {
165     return tls13_generate_secret(s, ssl_handshake_md(s), s->early_secret,
166                                  insecret, insecretlen,
167                                  (unsigned char *)&s->handshake_secret);
168 }
169
170 /*
171  * Given the handshake secret |prev| of length |prevlen| generate the master
172  * secret and store its length in |*secret_size|. Returns 1 on success  0 on
173  * failure.
174  */
175 int tls13_generate_master_secret(SSL *s, unsigned char *out,
176                                  unsigned char *prev, size_t prevlen,
177                                  size_t *secret_size)
178 {
179     const EVP_MD *md = ssl_handshake_md(s);
180
181     *secret_size = EVP_MD_size(md);
182     return tls13_generate_secret(s, md, prev, NULL, 0, out);
183 }
184
185 /*
186  * Generates the mac for the Finished message. Returns the length of the MAC or
187  * 0 on error.
188  */
189 size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
190                              unsigned char *out)
191 {
192     const EVP_MD *md = ssl_handshake_md(s);
193     unsigned char hash[EVP_MAX_MD_SIZE];
194     size_t hashlen, ret = 0;
195     EVP_PKEY *key = NULL;
196     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
197
198     if (!ssl_handshake_hash(s, hash, sizeof(hash), &hashlen))
199         goto err;
200
201     if (str == s->method->ssl3_enc->server_finished_label)
202         key = EVP_PKEY_new_mac_key(EVP_PKEY_HMAC, NULL,
203                                    s->server_finished_secret, hashlen);
204     else
205         key = EVP_PKEY_new_mac_key(EVP_PKEY_HMAC, NULL,
206                                    s->client_finished_secret, hashlen);
207
208     if (key == NULL
209             || ctx == NULL
210             || EVP_DigestSignInit(ctx, NULL, md, NULL, key) <= 0
211             || EVP_DigestSignUpdate(ctx, hash, hashlen) <= 0
212             || EVP_DigestSignFinal(ctx, out, &hashlen) <= 0)
213         goto err;
214
215     ret = hashlen;
216  err:
217     EVP_PKEY_free(key);
218     EVP_MD_CTX_free(ctx);
219     return ret;
220 }
221
222 /*
223  * There isn't really a key block in TLSv1.3, but we still need this function
224  * for initialising the cipher and hash. Returns 1 on success or 0 on failure.
225  */
226 int tls13_setup_key_block(SSL *s)
227 {
228     const EVP_CIPHER *c;
229     const EVP_MD *hash;
230     int mac_type = NID_undef;
231
232     s->session->cipher = s->s3->tmp.new_cipher;
233     if (!ssl_cipher_get_evp
234         (s->session, &c, &hash, &mac_type, NULL, NULL, 0)) {
235         SSLerr(SSL_F_TLS13_SETUP_KEY_BLOCK, SSL_R_CIPHER_OR_HASH_UNAVAILABLE);
236         return 0;
237     }
238
239     s->s3->tmp.new_sym_enc = c;
240     s->s3->tmp.new_hash = hash;
241
242     return 1;
243 }
244
245 static int derive_secret_key_and_iv(SSL *s, int send,
246                                     const unsigned char *insecret,
247                                     const unsigned char *hash,
248                                     const unsigned char *label,
249                                     size_t labellen, unsigned char *secret,
250                                     unsigned char *iv, EVP_CIPHER_CTX *ciph_ctx)
251 {
252     unsigned char key[EVP_MAX_KEY_LENGTH];
253     size_t ivlen, keylen, taglen;
254     const EVP_MD *md = ssl_handshake_md(s);
255     size_t hashlen = EVP_MD_size(md);
256     const EVP_CIPHER *ciph = s->s3->tmp.new_sym_enc;
257
258     if (!tls13_hkdf_expand(s, md, insecret, label, labellen, hash, secret,
259                            hashlen)) {
260         SSLerr(SSL_F_DERIVE_SECRET_KEY_AND_IV, ERR_R_INTERNAL_ERROR);
261         goto err;
262     }
263
264     /* TODO(size_t): convert me */
265     keylen = EVP_CIPHER_key_length(ciph);
266     if (EVP_CIPHER_mode(ciph) == EVP_CIPH_CCM_MODE) {
267         ivlen = EVP_CCM_TLS_IV_LEN;
268         if (s->s3->tmp.new_cipher->algorithm_enc
269                 & (SSL_AES128CCM8 | SSL_AES256CCM8))
270             taglen = EVP_CCM8_TLS_TAG_LEN;
271          else
272             taglen = EVP_CCM_TLS_TAG_LEN;
273     } else {
274         ivlen = EVP_CIPHER_iv_length(ciph);
275         taglen = 0;
276     }
277
278     if (!tls13_derive_key(s, secret, key, keylen)
279             || !tls13_derive_iv(s, secret, iv, ivlen)) {
280         SSLerr(SSL_F_DERIVE_SECRET_KEY_AND_IV, ERR_R_INTERNAL_ERROR);
281         goto err;
282     }
283
284     if (EVP_CipherInit_ex(ciph_ctx, ciph, NULL, NULL, NULL, send) <= 0
285         || !EVP_CIPHER_CTX_ctrl(ciph_ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)
286         || (taglen != 0 && !EVP_CIPHER_CTX_ctrl(ciph_ctx, EVP_CTRL_AEAD_SET_TAG,
287                                                 taglen, NULL))
288         || EVP_CipherInit_ex(ciph_ctx, NULL, NULL, key, NULL, -1) <= 0) {
289         SSLerr(SSL_F_DERIVE_SECRET_KEY_AND_IV, ERR_R_EVP_LIB);
290         goto err;
291     }
292
293 #ifdef OPENSSL_SSL_TRACE_CRYPTO
294     if (s->msg_callback) {
295         int wh = send ? TLS1_RT_CRYPTO_WRITE : 0;
296
297         if (ciph->key_len)
298             s->msg_callback(2, s->version, wh | TLS1_RT_CRYPTO_KEY,
299                             key, ciph->key_len, s, s->msg_callback_arg);
300
301         wh |= TLS1_RT_CRYPTO_IV;
302         s->msg_callback(2, s->version, wh, iv, ivlen, s,
303                         s->msg_callback_arg);
304     }
305 #endif
306
307     return 1;
308  err:
309     OPENSSL_cleanse(key, sizeof(key));
310     return 0;
311 }
312
313 int tls13_change_cipher_state(SSL *s, int which)
314 {
315     static const unsigned char client_handshake_traffic[] =
316         "client handshake traffic secret";
317     static const unsigned char client_application_traffic[] =
318         "client application traffic secret";
319     static const unsigned char server_handshake_traffic[] =
320         "server handshake traffic secret";
321     static const unsigned char server_application_traffic[] =
322         "server application traffic secret";
323     static const unsigned char resumption_master_secret[] =
324         "resumption master secret";
325     unsigned char *iv;
326     unsigned char secret[EVP_MAX_MD_SIZE];
327     unsigned char hashval[EVP_MAX_MD_SIZE];
328     unsigned char *hash = hashval;
329     unsigned char *insecret;
330     unsigned char *finsecret = NULL;
331     const char *log_label = NULL;
332     EVP_CIPHER_CTX *ciph_ctx;
333     size_t finsecretlen = 0;
334     const unsigned char *label;
335     size_t labellen, hashlen = 0;
336     int ret = 0;
337
338     if (which & SSL3_CC_READ) {
339         if (s->enc_read_ctx != NULL) {
340             EVP_CIPHER_CTX_reset(s->enc_read_ctx);
341         } else {
342             s->enc_read_ctx = EVP_CIPHER_CTX_new();
343             if (s->enc_read_ctx == NULL) {
344                 SSLerr(SSL_F_TLS13_CHANGE_CIPHER_STATE, ERR_R_MALLOC_FAILURE);
345                 goto err;
346             }
347         }
348         ciph_ctx = s->enc_read_ctx;
349         iv = s->read_iv;
350
351         RECORD_LAYER_reset_read_sequence(&s->rlayer);
352     } else {
353         if (s->enc_write_ctx != NULL) {
354             EVP_CIPHER_CTX_reset(s->enc_write_ctx);
355         } else {
356             s->enc_write_ctx = EVP_CIPHER_CTX_new();
357             if (s->enc_write_ctx == NULL) {
358                 SSLerr(SSL_F_TLS13_CHANGE_CIPHER_STATE, ERR_R_MALLOC_FAILURE);
359                 goto err;
360             }
361         }
362         ciph_ctx = s->enc_write_ctx;
363         iv = s->write_iv;
364
365         RECORD_LAYER_reset_write_sequence(&s->rlayer);
366     }
367
368     if (((which & SSL3_CC_CLIENT) && (which & SSL3_CC_WRITE))
369             || ((which & SSL3_CC_SERVER) && (which & SSL3_CC_READ))) {
370         if (which & SSL3_CC_HANDSHAKE) {
371             insecret = s->handshake_secret;
372             finsecret = s->client_finished_secret;
373             finsecretlen = EVP_MD_size(ssl_handshake_md(s));
374             label = client_handshake_traffic;
375             labellen = sizeof(client_handshake_traffic) - 1;
376             log_label = CLIENT_HANDSHAKE_LABEL;
377         } else {
378             insecret = s->master_secret;
379             label = client_application_traffic;
380             labellen = sizeof(client_application_traffic) - 1;
381             log_label = CLIENT_APPLICATION_LABEL;
382             /*
383              * For this we only use the handshake hashes up until the server
384              * Finished hash. We do not include the client's Finished, which is
385              * what ssl_handshake_hash() would give us. Instead we use the
386              * previously saved value.
387              */
388             hash = s->server_finished_hash;
389         }
390     } else {
391         if (which & SSL3_CC_HANDSHAKE) {
392             insecret = s->handshake_secret;
393             finsecret = s->server_finished_secret;
394             finsecretlen = EVP_MD_size(ssl_handshake_md(s));
395             label = server_handshake_traffic;
396             labellen = sizeof(server_handshake_traffic) - 1;
397             log_label = SERVER_HANDSHAKE_LABEL;
398         } else {
399             insecret = s->master_secret;
400             label = server_application_traffic;
401             labellen = sizeof(server_application_traffic) - 1;
402             log_label = SERVER_APPLICATION_LABEL;
403         }
404     }
405
406     if (!ssl3_digest_cached_records(s, 1)
407             || !ssl_handshake_hash(s, hashval, sizeof(hashval), &hashlen)) {
408         SSLerr(SSL_F_TLS13_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
409         goto err;
410     }
411
412     /*
413      * Save the hash of handshakes up to now for use when we calculate the
414      * client application traffic secret
415      */
416     if (label == server_application_traffic)
417         memcpy(s->server_finished_hash, hashval, hashlen);
418
419     if (label == client_application_traffic) {
420         /*
421          * We also create the resumption master secret, but this time use the
422          * hash for the whole handshake including the Client Finished
423          */
424         if (!tls13_hkdf_expand(s, ssl_handshake_md(s), insecret,
425                                resumption_master_secret,
426                                sizeof(resumption_master_secret) - 1,
427                                hashval, s->session->master_key, hashlen)) {
428             SSLerr(SSL_F_TLS13_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
429             goto err;
430         }
431         s->session->master_key_length = hashlen;
432     }
433
434     if (!derive_secret_key_and_iv(s, which & SSL3_CC_WRITE, insecret, hash,
435                                   label, labellen, secret, iv, ciph_ctx)) {
436         goto err;
437     }
438
439     if (label == server_application_traffic)
440         memcpy(s->server_app_traffic_secret, secret, hashlen);
441     else if (label == client_application_traffic)
442         memcpy(s->client_app_traffic_secret, secret, hashlen);
443
444     if (!ssl_log_secret(s, log_label, secret, hashlen)) {
445         SSLerr(SSL_F_TLS13_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
446         goto err;
447     }
448
449     if (finsecret != NULL
450             && !tls13_derive_finishedkey(s, ssl_handshake_md(s), secret,
451                                          finsecret, finsecretlen)) {
452         SSLerr(SSL_F_TLS13_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
453         goto err;
454     }
455
456     ret = 1;
457  err:
458     OPENSSL_cleanse(secret, sizeof(secret));
459     return ret;
460 }
461
462 int tls13_update_key(SSL *s, int send)
463 {
464     static const unsigned char application_traffic[] =
465         "application traffic secret";
466     const EVP_MD *md = ssl_handshake_md(s);
467     size_t hashlen = EVP_MD_size(md);
468     unsigned char *insecret, *iv;
469     unsigned char secret[EVP_MAX_MD_SIZE];
470     EVP_CIPHER_CTX *ciph_ctx;
471     int ret = 0;
472
473     if (s->server == send)
474         insecret = s->server_app_traffic_secret;
475     else
476         insecret = s->client_app_traffic_secret;
477
478     if (send) {
479         iv = s->write_iv;
480         ciph_ctx = s->enc_write_ctx;
481         RECORD_LAYER_reset_write_sequence(&s->rlayer);
482     } else {
483         iv = s->read_iv;
484         ciph_ctx = s->enc_read_ctx;
485         RECORD_LAYER_reset_read_sequence(&s->rlayer);
486     }
487
488     if (!derive_secret_key_and_iv(s, send, insecret, NULL, application_traffic,
489                                   sizeof(application_traffic) - 1, secret, iv,
490                                   ciph_ctx))
491         goto err;
492
493     memcpy(insecret, secret, hashlen);
494
495     ret = 1;
496  err:
497     OPENSSL_cleanse(secret, sizeof(secret));
498     return ret;
499 }
500
501 int tls13_alert_code(int code)
502 {
503     if (code == SSL_AD_MISSING_EXTENSION)
504         return code;
505
506     return tls1_alert_code(code);
507 }