2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
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
10 /* ====================================================================
11 * Copyright 2005 Nokia. All rights reserved.
13 * The portions of the attached software ("Contribution") is developed by
14 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
17 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
18 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
19 * support (see RFC 4279) to OpenSSL.
21 * No patent licenses or other rights except those expressly stated in
22 * the OpenSSL open source license shall be deemed granted or received
23 * expressly, by implication, estoppel, or otherwise.
25 * No assurances are provided by Nokia that the Contribution does not
26 * infringe the patent or other intellectual property rights of any third
27 * party or that the license provides you with all the necessary rights
28 * to make use of the Contribution.
30 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
31 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
32 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
33 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
39 #include <openssl/evp.h>
40 #include <openssl/md5.h>
42 static int ssl3_generate_key_block(SSL *s, unsigned char *km, int num)
46 unsigned char buf[16], smd[SHA_DIGEST_LENGTH];
47 unsigned char c = 'A';
52 c = os_toascii[c]; /* 'A' in ASCII */
55 m5 = EVP_MD_CTX_new();
56 s1 = EVP_MD_CTX_new();
57 if (m5 == NULL || s1 == NULL) {
58 SSLerr(SSL_F_SSL3_GENERATE_KEY_BLOCK, ERR_R_MALLOC_FAILURE);
61 EVP_MD_CTX_set_flags(m5, EVP_MD_CTX_FLAG_NON_FIPS_ALLOW);
62 for (i = 0; (int)i < num; i += MD5_DIGEST_LENGTH) {
65 /* bug: 'buf' is too small for this ciphersuite */
66 SSLerr(SSL_F_SSL3_GENERATE_KEY_BLOCK, ERR_R_INTERNAL_ERROR);
70 for (j = 0; j < k; j++)
73 if (!EVP_DigestInit_ex(s1, EVP_sha1(), NULL)
74 || !EVP_DigestUpdate(s1, buf, k)
75 || !EVP_DigestUpdate(s1, s->session->master_key,
76 s->session->master_key_length)
77 || !EVP_DigestUpdate(s1, s->s3->server_random, SSL3_RANDOM_SIZE)
78 || !EVP_DigestUpdate(s1, s->s3->client_random, SSL3_RANDOM_SIZE)
79 || !EVP_DigestFinal_ex(s1, smd, NULL)
80 || !EVP_DigestInit_ex(m5, EVP_md5(), NULL)
81 || !EVP_DigestUpdate(m5, s->session->master_key,
82 s->session->master_key_length)
83 || !EVP_DigestUpdate(m5, smd, SHA_DIGEST_LENGTH))
85 if ((int)(i + MD5_DIGEST_LENGTH) > num) {
86 if (!EVP_DigestFinal_ex(m5, smd, NULL))
88 memcpy(km, smd, (num - i));
90 if (!EVP_DigestFinal_ex(m5, km, NULL))
94 km += MD5_DIGEST_LENGTH;
96 OPENSSL_cleanse(smd, sizeof(smd));
104 int ssl3_change_cipher_state(SSL *s, int which)
106 unsigned char *p, *mac_secret;
107 unsigned char exp_key[EVP_MAX_KEY_LENGTH];
108 unsigned char exp_iv[EVP_MAX_IV_LENGTH];
109 unsigned char *ms, *key, *iv;
112 #ifndef OPENSSL_NO_COMP
119 c = s->s3->tmp.new_sym_enc;
120 m = s->s3->tmp.new_hash;
121 /* m == NULL will lead to a crash later */
123 #ifndef OPENSSL_NO_COMP
124 if (s->s3->tmp.new_compression == NULL)
127 comp = s->s3->tmp.new_compression->method;
130 if (which & SSL3_CC_READ) {
131 if (s->enc_read_ctx != NULL)
133 else if ((s->enc_read_ctx = EVP_CIPHER_CTX_new()) == NULL)
137 * make sure it's initialised in case we exit later with an error
139 EVP_CIPHER_CTX_reset(s->enc_read_ctx);
140 dd = s->enc_read_ctx;
142 if (ssl_replace_hash(&s->read_hash, m) == NULL) {
143 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
146 #ifndef OPENSSL_NO_COMP
148 COMP_CTX_free(s->expand);
151 s->expand = COMP_CTX_new(comp);
152 if (s->expand == NULL) {
153 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE,
154 SSL_R_COMPRESSION_LIBRARY_ERROR);
159 RECORD_LAYER_reset_read_sequence(&s->rlayer);
160 mac_secret = &(s->s3->read_mac_secret[0]);
162 if (s->enc_write_ctx != NULL)
164 else if ((s->enc_write_ctx = EVP_CIPHER_CTX_new()) == NULL)
168 * make sure it's initialised in case we exit later with an error
170 EVP_CIPHER_CTX_reset(s->enc_write_ctx);
171 dd = s->enc_write_ctx;
172 if (ssl_replace_hash(&s->write_hash, m) == NULL) {
173 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
176 #ifndef OPENSSL_NO_COMP
178 COMP_CTX_free(s->compress);
181 s->compress = COMP_CTX_new(comp);
182 if (s->compress == NULL) {
183 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE,
184 SSL_R_COMPRESSION_LIBRARY_ERROR);
189 RECORD_LAYER_reset_write_sequence(&s->rlayer);
190 mac_secret = &(s->s3->write_mac_secret[0]);
194 EVP_CIPHER_CTX_reset(dd);
196 p = s->s3->tmp.key_block;
200 cl = EVP_CIPHER_key_length(c);
202 k = EVP_CIPHER_iv_length(c);
203 if ((which == SSL3_CHANGE_CIPHER_CLIENT_WRITE) ||
204 (which == SSL3_CHANGE_CIPHER_SERVER_READ)) {
221 if (n > s->s3->tmp.key_block_length) {
222 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
226 memcpy(mac_secret, ms, i);
228 EVP_CipherInit_ex(dd, c, NULL, key, iv, (which & SSL3_CC_WRITE));
230 #ifdef OPENSSL_SSL_TRACE_CRYPTO
231 if (s->msg_callback) {
233 int wh = which & SSL3_CC_WRITE ?
234 TLS1_RT_CRYPTO_WRITE : TLS1_RT_CRYPTO_READ;
235 s->msg_callback(2, s->version, wh | TLS1_RT_CRYPTO_MAC,
236 mac_secret, EVP_MD_size(m), s, s->msg_callback_arg);
238 s->msg_callback(2, s->version, wh | TLS1_RT_CRYPTO_KEY,
239 key, c->key_len, s, s->msg_callback_arg);
241 s->msg_callback(2, s->version, wh | TLS1_RT_CRYPTO_IV,
242 iv, k, s, s->msg_callback_arg);
247 OPENSSL_cleanse(exp_key, sizeof(exp_key));
248 OPENSSL_cleanse(exp_iv, sizeof(exp_iv));
251 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_MALLOC_FAILURE);
253 OPENSSL_cleanse(exp_key, sizeof(exp_key));
254 OPENSSL_cleanse(exp_iv, sizeof(exp_iv));
258 int ssl3_setup_key_block(SSL *s)
267 if (s->s3->tmp.key_block_length != 0)
270 if (!ssl_cipher_get_evp(s->session, &c, &hash, NULL, NULL, &comp, 0)) {
271 SSLerr(SSL_F_SSL3_SETUP_KEY_BLOCK, SSL_R_CIPHER_OR_HASH_UNAVAILABLE);
275 s->s3->tmp.new_sym_enc = c;
276 s->s3->tmp.new_hash = hash;
277 #ifdef OPENSSL_NO_COMP
278 s->s3->tmp.new_compression = NULL;
280 s->s3->tmp.new_compression = comp;
283 num = EVP_MD_size(hash);
287 num = EVP_CIPHER_key_length(c) + num + EVP_CIPHER_iv_length(c);
290 ssl3_cleanup_key_block(s);
292 if ((p = OPENSSL_malloc(num)) == NULL)
295 s->s3->tmp.key_block_length = num;
296 s->s3->tmp.key_block = p;
298 ret = ssl3_generate_key_block(s, p, num);
300 if (!(s->options & SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS)) {
302 * enable vulnerability countermeasure for CBC ciphers with known-IV
303 * problem (http://www.openssl.org/~bodo/tls-cbc.txt)
305 s->s3->need_empty_fragments = 1;
307 if (s->session->cipher != NULL) {
308 if (s->session->cipher->algorithm_enc == SSL_eNULL)
309 s->s3->need_empty_fragments = 0;
311 #ifndef OPENSSL_NO_RC4
312 if (s->session->cipher->algorithm_enc == SSL_RC4)
313 s->s3->need_empty_fragments = 0;
321 SSLerr(SSL_F_SSL3_SETUP_KEY_BLOCK, ERR_R_MALLOC_FAILURE);
325 void ssl3_cleanup_key_block(SSL *s)
327 OPENSSL_clear_free(s->s3->tmp.key_block, s->s3->tmp.key_block_length);
328 s->s3->tmp.key_block = NULL;
329 s->s3->tmp.key_block_length = 0;
332 int ssl3_init_finished_mac(SSL *s)
334 BIO *buf = BIO_new(BIO_s_mem());
337 SSLerr(SSL_F_SSL3_INIT_FINISHED_MAC, ERR_R_MALLOC_FAILURE);
340 ssl3_free_digest_list(s);
341 s->s3->handshake_buffer = buf;
342 (void)BIO_set_close(s->s3->handshake_buffer, BIO_CLOSE);
347 * Free digest list. Also frees handshake buffer since they are always freed
351 void ssl3_free_digest_list(SSL *s)
353 BIO_free(s->s3->handshake_buffer);
354 s->s3->handshake_buffer = NULL;
355 EVP_MD_CTX_free(s->s3->handshake_dgst);
356 s->s3->handshake_dgst = NULL;
359 int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len)
361 if (s->s3->handshake_dgst == NULL) {
363 /* Note: this writes to a memory BIO so a failure is a fatal error */
366 ret = BIO_write(s->s3->handshake_buffer, (void *)buf, (int)len);
367 return ret > 0 && ret == (int)len;
369 return EVP_DigestUpdate(s->s3->handshake_dgst, buf, len);
373 int ssl3_digest_cached_records(SSL *s, int keep)
379 if (s->s3->handshake_dgst == NULL) {
380 hdatalen = BIO_get_mem_data(s->s3->handshake_buffer, &hdata);
382 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS,
383 SSL_R_BAD_HANDSHAKE_LENGTH);
387 s->s3->handshake_dgst = EVP_MD_CTX_new();
388 if (s->s3->handshake_dgst == NULL) {
389 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS, ERR_R_MALLOC_FAILURE);
393 md = ssl_handshake_md(s);
394 if (md == NULL || !EVP_DigestInit_ex(s->s3->handshake_dgst, md, NULL)
395 || !EVP_DigestUpdate(s->s3->handshake_dgst, hdata, hdatalen)) {
396 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS, ERR_R_INTERNAL_ERROR);
401 BIO_free(s->s3->handshake_buffer);
402 s->s3->handshake_buffer = NULL;
408 int ssl3_final_finish_mac(SSL *s, const char *sender, int len, unsigned char *p)
411 EVP_MD_CTX *ctx = NULL;
413 if (!ssl3_digest_cached_records(s, 0))
416 if (EVP_MD_CTX_type(s->s3->handshake_dgst) != NID_md5_sha1) {
417 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, SSL_R_NO_REQUIRED_DIGEST);
421 ctx = EVP_MD_CTX_new();
423 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_MALLOC_FAILURE);
426 if (!EVP_MD_CTX_copy_ex(ctx, s->s3->handshake_dgst)) {
427 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_INTERNAL_ERROR);
431 ret = EVP_MD_CTX_size(ctx);
433 EVP_MD_CTX_reset(ctx);
437 if ((sender != NULL && EVP_DigestUpdate(ctx, sender, len) <= 0)
438 || EVP_MD_CTX_ctrl(ctx, EVP_CTRL_SSL3_MASTER_SECRET,
439 s->session->master_key_length,
440 s->session->master_key) <= 0
441 || EVP_DigestFinal_ex(ctx, p, NULL) <= 0) {
442 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_INTERNAL_ERROR);
446 EVP_MD_CTX_free(ctx);
451 int ssl3_generate_master_secret(SSL *s, unsigned char *out, unsigned char *p,
454 static const unsigned char *salt[3] = {
455 #ifndef CHARSET_EBCDIC
456 (const unsigned char *)"A",
457 (const unsigned char *)"BB",
458 (const unsigned char *)"CCC",
460 (const unsigned char *)"\x41",
461 (const unsigned char *)"\x42\x42",
462 (const unsigned char *)"\x43\x43\x43",
465 unsigned char buf[EVP_MAX_MD_SIZE];
466 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
469 #ifdef OPENSSL_SSL_TRACE_CRYPTO
470 unsigned char *tmpout = out;
474 SSLerr(SSL_F_SSL3_GENERATE_MASTER_SECRET, ERR_R_MALLOC_FAILURE);
477 for (i = 0; i < 3; i++) {
478 if (EVP_DigestInit_ex(ctx, s->ctx->sha1, NULL) <= 0
479 || EVP_DigestUpdate(ctx, salt[i],
480 strlen((const char *)salt[i])) <= 0
481 || EVP_DigestUpdate(ctx, p, len) <= 0
482 || EVP_DigestUpdate(ctx, &(s->s3->client_random[0]),
483 SSL3_RANDOM_SIZE) <= 0
484 || EVP_DigestUpdate(ctx, &(s->s3->server_random[0]),
485 SSL3_RANDOM_SIZE) <= 0
486 || EVP_DigestFinal_ex(ctx, buf, &n) <= 0
487 || EVP_DigestInit_ex(ctx, s->ctx->md5, NULL) <= 0
488 || EVP_DigestUpdate(ctx, p, len) <= 0
489 || EVP_DigestUpdate(ctx, buf, n) <= 0
490 || EVP_DigestFinal_ex(ctx, out, &n) <= 0) {
491 SSLerr(SSL_F_SSL3_GENERATE_MASTER_SECRET, ERR_R_INTERNAL_ERROR);
498 EVP_MD_CTX_free(ctx);
500 #ifdef OPENSSL_SSL_TRACE_CRYPTO
501 if (ret > 0 && s->msg_callback) {
502 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_PREMASTER,
503 p, len, s, s->msg_callback_arg);
504 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_CLIENT_RANDOM,
505 s->s3->client_random, SSL3_RANDOM_SIZE,
506 s, s->msg_callback_arg);
507 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_SERVER_RANDOM,
508 s->s3->server_random, SSL3_RANDOM_SIZE,
509 s, s->msg_callback_arg);
510 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_MASTER,
511 tmpout, SSL3_MASTER_SECRET_SIZE,
512 s, s->msg_callback_arg);
515 OPENSSL_cleanse(buf, sizeof(buf));
519 int ssl3_alert_code(int code)
522 case SSL_AD_CLOSE_NOTIFY:
523 return (SSL3_AD_CLOSE_NOTIFY);
524 case SSL_AD_UNEXPECTED_MESSAGE:
525 return (SSL3_AD_UNEXPECTED_MESSAGE);
526 case SSL_AD_BAD_RECORD_MAC:
527 return (SSL3_AD_BAD_RECORD_MAC);
528 case SSL_AD_DECRYPTION_FAILED:
529 return (SSL3_AD_BAD_RECORD_MAC);
530 case SSL_AD_RECORD_OVERFLOW:
531 return (SSL3_AD_BAD_RECORD_MAC);
532 case SSL_AD_DECOMPRESSION_FAILURE:
533 return (SSL3_AD_DECOMPRESSION_FAILURE);
534 case SSL_AD_HANDSHAKE_FAILURE:
535 return (SSL3_AD_HANDSHAKE_FAILURE);
536 case SSL_AD_NO_CERTIFICATE:
537 return (SSL3_AD_NO_CERTIFICATE);
538 case SSL_AD_BAD_CERTIFICATE:
539 return (SSL3_AD_BAD_CERTIFICATE);
540 case SSL_AD_UNSUPPORTED_CERTIFICATE:
541 return (SSL3_AD_UNSUPPORTED_CERTIFICATE);
542 case SSL_AD_CERTIFICATE_REVOKED:
543 return (SSL3_AD_CERTIFICATE_REVOKED);
544 case SSL_AD_CERTIFICATE_EXPIRED:
545 return (SSL3_AD_CERTIFICATE_EXPIRED);
546 case SSL_AD_CERTIFICATE_UNKNOWN:
547 return (SSL3_AD_CERTIFICATE_UNKNOWN);
548 case SSL_AD_ILLEGAL_PARAMETER:
549 return (SSL3_AD_ILLEGAL_PARAMETER);
550 case SSL_AD_UNKNOWN_CA:
551 return (SSL3_AD_BAD_CERTIFICATE);
552 case SSL_AD_ACCESS_DENIED:
553 return (SSL3_AD_HANDSHAKE_FAILURE);
554 case SSL_AD_DECODE_ERROR:
555 return (SSL3_AD_HANDSHAKE_FAILURE);
556 case SSL_AD_DECRYPT_ERROR:
557 return (SSL3_AD_HANDSHAKE_FAILURE);
558 case SSL_AD_EXPORT_RESTRICTION:
559 return (SSL3_AD_HANDSHAKE_FAILURE);
560 case SSL_AD_PROTOCOL_VERSION:
561 return (SSL3_AD_HANDSHAKE_FAILURE);
562 case SSL_AD_INSUFFICIENT_SECURITY:
563 return (SSL3_AD_HANDSHAKE_FAILURE);
564 case SSL_AD_INTERNAL_ERROR:
565 return (SSL3_AD_HANDSHAKE_FAILURE);
566 case SSL_AD_USER_CANCELLED:
567 return (SSL3_AD_HANDSHAKE_FAILURE);
568 case SSL_AD_NO_RENEGOTIATION:
569 return (-1); /* Don't send it :-) */
570 case SSL_AD_UNSUPPORTED_EXTENSION:
571 return (SSL3_AD_HANDSHAKE_FAILURE);
572 case SSL_AD_CERTIFICATE_UNOBTAINABLE:
573 return (SSL3_AD_HANDSHAKE_FAILURE);
574 case SSL_AD_UNRECOGNIZED_NAME:
575 return (SSL3_AD_HANDSHAKE_FAILURE);
576 case SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE:
577 return (SSL3_AD_HANDSHAKE_FAILURE);
578 case SSL_AD_BAD_CERTIFICATE_HASH_VALUE:
579 return (SSL3_AD_HANDSHAKE_FAILURE);
580 case SSL_AD_UNKNOWN_PSK_IDENTITY:
581 return (TLS1_AD_UNKNOWN_PSK_IDENTITY);
582 case SSL_AD_INAPPROPRIATE_FALLBACK:
583 return (TLS1_AD_INAPPROPRIATE_FALLBACK);
584 case SSL_AD_NO_APPLICATION_PROTOCOL:
585 return (TLS1_AD_NO_APPLICATION_PROTOCOL);