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 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);
81 EVP_DigestInit_ex(m5, EVP_md5(), NULL);
82 EVP_DigestUpdate(m5, s->session->master_key,
83 s->session->master_key_length);
84 EVP_DigestUpdate(m5, smd, SHA_DIGEST_LENGTH);
85 if ((int)(i + MD5_DIGEST_LENGTH) > num) {
86 EVP_DigestFinal_ex(m5, smd, NULL);
87 memcpy(km, smd, (num - i));
89 EVP_DigestFinal_ex(m5, km, NULL);
91 km += MD5_DIGEST_LENGTH;
93 OPENSSL_cleanse(smd, sizeof(smd));
101 int ssl3_change_cipher_state(SSL *s, int which)
103 unsigned char *p, *mac_secret;
104 unsigned char exp_key[EVP_MAX_KEY_LENGTH];
105 unsigned char exp_iv[EVP_MAX_IV_LENGTH];
106 unsigned char *ms, *key, *iv;
109 #ifndef OPENSSL_NO_COMP
116 c = s->s3->tmp.new_sym_enc;
117 m = s->s3->tmp.new_hash;
118 /* m == NULL will lead to a crash later */
120 #ifndef OPENSSL_NO_COMP
121 if (s->s3->tmp.new_compression == NULL)
124 comp = s->s3->tmp.new_compression->method;
127 if (which & SSL3_CC_READ) {
128 if (s->enc_read_ctx != NULL)
130 else if ((s->enc_read_ctx = EVP_CIPHER_CTX_new()) == NULL)
134 * make sure it's initialised in case we exit later with an error
136 EVP_CIPHER_CTX_reset(s->enc_read_ctx);
137 dd = s->enc_read_ctx;
139 if (ssl_replace_hash(&s->read_hash, m) == NULL) {
140 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
143 #ifndef OPENSSL_NO_COMP
145 COMP_CTX_free(s->expand);
148 s->expand = COMP_CTX_new(comp);
149 if (s->expand == NULL) {
150 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE,
151 SSL_R_COMPRESSION_LIBRARY_ERROR);
156 RECORD_LAYER_reset_read_sequence(&s->rlayer);
157 mac_secret = &(s->s3->read_mac_secret[0]);
159 if (s->enc_write_ctx != NULL)
161 else if ((s->enc_write_ctx = EVP_CIPHER_CTX_new()) == NULL)
165 * make sure it's initialised in case we exit later with an error
167 EVP_CIPHER_CTX_reset(s->enc_write_ctx);
168 dd = s->enc_write_ctx;
169 if (ssl_replace_hash(&s->write_hash, m) == NULL) {
170 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
173 #ifndef OPENSSL_NO_COMP
175 COMP_CTX_free(s->compress);
178 s->compress = COMP_CTX_new(comp);
179 if (s->compress == NULL) {
180 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE,
181 SSL_R_COMPRESSION_LIBRARY_ERROR);
186 RECORD_LAYER_reset_write_sequence(&s->rlayer);
187 mac_secret = &(s->s3->write_mac_secret[0]);
191 EVP_CIPHER_CTX_reset(dd);
193 p = s->s3->tmp.key_block;
197 cl = EVP_CIPHER_key_length(c);
199 k = EVP_CIPHER_iv_length(c);
200 if ((which == SSL3_CHANGE_CIPHER_CLIENT_WRITE) ||
201 (which == SSL3_CHANGE_CIPHER_SERVER_READ)) {
218 if (n > s->s3->tmp.key_block_length) {
219 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
223 memcpy(mac_secret, ms, i);
225 EVP_CipherInit_ex(dd, c, NULL, key, iv, (which & SSL3_CC_WRITE));
227 #ifdef OPENSSL_SSL_TRACE_CRYPTO
228 if (s->msg_callback) {
230 int wh = which & SSL3_CC_WRITE ?
231 TLS1_RT_CRYPTO_WRITE : TLS1_RT_CRYPTO_READ;
232 s->msg_callback(2, s->version, wh | TLS1_RT_CRYPTO_MAC,
233 mac_secret, EVP_MD_size(m), s, s->msg_callback_arg);
235 s->msg_callback(2, s->version, wh | TLS1_RT_CRYPTO_KEY,
236 key, c->key_len, s, s->msg_callback_arg);
238 s->msg_callback(2, s->version, wh | TLS1_RT_CRYPTO_IV,
239 iv, k, s, s->msg_callback_arg);
244 OPENSSL_cleanse(exp_key, sizeof(exp_key));
245 OPENSSL_cleanse(exp_iv, sizeof(exp_iv));
248 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_MALLOC_FAILURE);
250 OPENSSL_cleanse(exp_key, sizeof(exp_key));
251 OPENSSL_cleanse(exp_iv, sizeof(exp_iv));
255 int ssl3_setup_key_block(SSL *s)
264 if (s->s3->tmp.key_block_length != 0)
267 if (!ssl_cipher_get_evp(s->session, &c, &hash, NULL, NULL, &comp, 0)) {
268 SSLerr(SSL_F_SSL3_SETUP_KEY_BLOCK, SSL_R_CIPHER_OR_HASH_UNAVAILABLE);
272 s->s3->tmp.new_sym_enc = c;
273 s->s3->tmp.new_hash = hash;
274 #ifdef OPENSSL_NO_COMP
275 s->s3->tmp.new_compression = NULL;
277 s->s3->tmp.new_compression = comp;
280 num = EVP_MD_size(hash);
284 num = EVP_CIPHER_key_length(c) + num + EVP_CIPHER_iv_length(c);
287 ssl3_cleanup_key_block(s);
289 if ((p = OPENSSL_malloc(num)) == NULL)
292 s->s3->tmp.key_block_length = num;
293 s->s3->tmp.key_block = p;
295 ret = ssl3_generate_key_block(s, p, num);
297 if (!(s->options & SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS)) {
299 * enable vulnerability countermeasure for CBC ciphers with known-IV
300 * problem (http://www.openssl.org/~bodo/tls-cbc.txt)
302 s->s3->need_empty_fragments = 1;
304 if (s->session->cipher != NULL) {
305 if (s->session->cipher->algorithm_enc == SSL_eNULL)
306 s->s3->need_empty_fragments = 0;
308 #ifndef OPENSSL_NO_RC4
309 if (s->session->cipher->algorithm_enc == SSL_RC4)
310 s->s3->need_empty_fragments = 0;
318 SSLerr(SSL_F_SSL3_SETUP_KEY_BLOCK, ERR_R_MALLOC_FAILURE);
322 void ssl3_cleanup_key_block(SSL *s)
324 OPENSSL_clear_free(s->s3->tmp.key_block, s->s3->tmp.key_block_length);
325 s->s3->tmp.key_block = NULL;
326 s->s3->tmp.key_block_length = 0;
329 int ssl3_init_finished_mac(SSL *s)
331 BIO *buf = BIO_new(BIO_s_mem());
334 SSLerr(SSL_F_SSL3_INIT_FINISHED_MAC, ERR_R_MALLOC_FAILURE);
337 ssl3_free_digest_list(s);
338 s->s3->handshake_buffer = buf;
339 (void)BIO_set_close(s->s3->handshake_buffer, BIO_CLOSE);
344 * Free digest list. Also frees handshake buffer since they are always freed
348 void ssl3_free_digest_list(SSL *s)
350 BIO_free(s->s3->handshake_buffer);
351 s->s3->handshake_buffer = NULL;
352 EVP_MD_CTX_free(s->s3->handshake_dgst);
353 s->s3->handshake_dgst = NULL;
356 void ssl3_finish_mac(SSL *s, const unsigned char *buf, int len)
358 if (s->s3->handshake_dgst == NULL)
359 BIO_write(s->s3->handshake_buffer, (void *)buf, len);
361 EVP_DigestUpdate(s->s3->handshake_dgst, buf, len);
364 int ssl3_digest_cached_records(SSL *s, int keep)
370 if (s->s3->handshake_dgst == NULL) {
371 hdatalen = BIO_get_mem_data(s->s3->handshake_buffer, &hdata);
373 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS, SSL_R_BAD_HANDSHAKE_LENGTH);
377 s->s3->handshake_dgst = EVP_MD_CTX_new();
378 if (s->s3->handshake_dgst == NULL) {
379 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS, ERR_R_MALLOC_FAILURE);
383 md = ssl_handshake_md(s);
385 || !EVP_DigestInit_ex(s->s3->handshake_dgst, md, NULL)
386 || !EVP_DigestUpdate(s->s3->handshake_dgst, hdata, hdatalen))
388 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS, ERR_R_INTERNAL_ERROR);
393 BIO_free(s->s3->handshake_buffer);
394 s->s3->handshake_buffer = NULL;
400 int ssl3_final_finish_mac(SSL *s, const char *sender, int len, unsigned char *p)
403 EVP_MD_CTX *ctx = NULL;
405 if (!ssl3_digest_cached_records(s, 0))
408 if (EVP_MD_CTX_type(s->s3->handshake_dgst) != NID_md5_sha1) {
409 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, SSL_R_NO_REQUIRED_DIGEST);
413 ctx = EVP_MD_CTX_new();
415 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_MALLOC_FAILURE);
418 if (!EVP_MD_CTX_copy_ex(ctx, s->s3->handshake_dgst)) {
419 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_INTERNAL_ERROR);
423 ret = EVP_MD_CTX_size(ctx);
425 EVP_MD_CTX_reset(ctx);
429 if ((sender != NULL && EVP_DigestUpdate(ctx, sender, len) <= 0)
430 || EVP_MD_CTX_ctrl(ctx, EVP_CTRL_SSL3_MASTER_SECRET,
431 s->session->master_key_length,
432 s->session->master_key) <= 0
433 || EVP_DigestFinal_ex(ctx, p, NULL) <= 0) {
434 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_INTERNAL_ERROR);
438 EVP_MD_CTX_free(ctx);
443 int ssl3_generate_master_secret(SSL *s, unsigned char *out, unsigned char *p,
446 static const unsigned char *salt[3] = {
447 #ifndef CHARSET_EBCDIC
448 (const unsigned char *)"A",
449 (const unsigned char *)"BB",
450 (const unsigned char *)"CCC",
452 (const unsigned char *)"\x41",
453 (const unsigned char *)"\x42\x42",
454 (const unsigned char *)"\x43\x43\x43",
457 unsigned char buf[EVP_MAX_MD_SIZE];
458 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
461 #ifdef OPENSSL_SSL_TRACE_CRYPTO
462 unsigned char *tmpout = out;
466 SSLerr(SSL_F_SSL3_GENERATE_MASTER_SECRET, ERR_R_MALLOC_FAILURE);
469 for (i = 0; i < 3; i++) {
470 if (EVP_DigestInit_ex(ctx, s->ctx->sha1, NULL) <= 0
471 || EVP_DigestUpdate(ctx, salt[i],
472 strlen((const char *)salt[i])) <= 0
473 || EVP_DigestUpdate(ctx, p, len) <= 0
474 || EVP_DigestUpdate(ctx, &(s->s3->client_random[0]),
475 SSL3_RANDOM_SIZE) <= 0
476 || EVP_DigestUpdate(ctx, &(s->s3->server_random[0]),
477 SSL3_RANDOM_SIZE) <= 0
478 || EVP_DigestFinal_ex(ctx, buf, &n) <= 0
480 || EVP_DigestInit_ex(ctx, s->ctx->md5, NULL) <= 0
481 || EVP_DigestUpdate(ctx, p, len) <= 0
482 || EVP_DigestUpdate(ctx, buf, n) <= 0
483 || EVP_DigestFinal_ex(ctx, out, &n) <= 0) {
484 SSLerr(SSL_F_SSL3_GENERATE_MASTER_SECRET, ERR_R_INTERNAL_ERROR);
491 EVP_MD_CTX_free(ctx);
493 #ifdef OPENSSL_SSL_TRACE_CRYPTO
494 if (ret > 0 && s->msg_callback) {
495 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_PREMASTER,
496 p, len, s, s->msg_callback_arg);
497 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_CLIENT_RANDOM,
498 s->s3->client_random, SSL3_RANDOM_SIZE,
499 s, s->msg_callback_arg);
500 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_SERVER_RANDOM,
501 s->s3->server_random, SSL3_RANDOM_SIZE,
502 s, s->msg_callback_arg);
503 s->msg_callback(2, s->version, TLS1_RT_CRYPTO_MASTER,
504 tmpout, SSL3_MASTER_SECRET_SIZE,
505 s, s->msg_callback_arg);
508 OPENSSL_cleanse(buf, sizeof(buf));
512 int ssl3_alert_code(int code)
515 case SSL_AD_CLOSE_NOTIFY:
516 return (SSL3_AD_CLOSE_NOTIFY);
517 case SSL_AD_UNEXPECTED_MESSAGE:
518 return (SSL3_AD_UNEXPECTED_MESSAGE);
519 case SSL_AD_BAD_RECORD_MAC:
520 return (SSL3_AD_BAD_RECORD_MAC);
521 case SSL_AD_DECRYPTION_FAILED:
522 return (SSL3_AD_BAD_RECORD_MAC);
523 case SSL_AD_RECORD_OVERFLOW:
524 return (SSL3_AD_BAD_RECORD_MAC);
525 case SSL_AD_DECOMPRESSION_FAILURE:
526 return (SSL3_AD_DECOMPRESSION_FAILURE);
527 case SSL_AD_HANDSHAKE_FAILURE:
528 return (SSL3_AD_HANDSHAKE_FAILURE);
529 case SSL_AD_NO_CERTIFICATE:
530 return (SSL3_AD_NO_CERTIFICATE);
531 case SSL_AD_BAD_CERTIFICATE:
532 return (SSL3_AD_BAD_CERTIFICATE);
533 case SSL_AD_UNSUPPORTED_CERTIFICATE:
534 return (SSL3_AD_UNSUPPORTED_CERTIFICATE);
535 case SSL_AD_CERTIFICATE_REVOKED:
536 return (SSL3_AD_CERTIFICATE_REVOKED);
537 case SSL_AD_CERTIFICATE_EXPIRED:
538 return (SSL3_AD_CERTIFICATE_EXPIRED);
539 case SSL_AD_CERTIFICATE_UNKNOWN:
540 return (SSL3_AD_CERTIFICATE_UNKNOWN);
541 case SSL_AD_ILLEGAL_PARAMETER:
542 return (SSL3_AD_ILLEGAL_PARAMETER);
543 case SSL_AD_UNKNOWN_CA:
544 return (SSL3_AD_BAD_CERTIFICATE);
545 case SSL_AD_ACCESS_DENIED:
546 return (SSL3_AD_HANDSHAKE_FAILURE);
547 case SSL_AD_DECODE_ERROR:
548 return (SSL3_AD_HANDSHAKE_FAILURE);
549 case SSL_AD_DECRYPT_ERROR:
550 return (SSL3_AD_HANDSHAKE_FAILURE);
551 case SSL_AD_EXPORT_RESTRICTION:
552 return (SSL3_AD_HANDSHAKE_FAILURE);
553 case SSL_AD_PROTOCOL_VERSION:
554 return (SSL3_AD_HANDSHAKE_FAILURE);
555 case SSL_AD_INSUFFICIENT_SECURITY:
556 return (SSL3_AD_HANDSHAKE_FAILURE);
557 case SSL_AD_INTERNAL_ERROR:
558 return (SSL3_AD_HANDSHAKE_FAILURE);
559 case SSL_AD_USER_CANCELLED:
560 return (SSL3_AD_HANDSHAKE_FAILURE);
561 case SSL_AD_NO_RENEGOTIATION:
562 return (-1); /* Don't send it :-) */
563 case SSL_AD_UNSUPPORTED_EXTENSION:
564 return (SSL3_AD_HANDSHAKE_FAILURE);
565 case SSL_AD_CERTIFICATE_UNOBTAINABLE:
566 return (SSL3_AD_HANDSHAKE_FAILURE);
567 case SSL_AD_UNRECOGNIZED_NAME:
568 return (SSL3_AD_HANDSHAKE_FAILURE);
569 case SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE:
570 return (SSL3_AD_HANDSHAKE_FAILURE);
571 case SSL_AD_BAD_CERTIFICATE_HASH_VALUE:
572 return (SSL3_AD_HANDSHAKE_FAILURE);
573 case SSL_AD_UNKNOWN_PSK_IDENTITY:
574 return (TLS1_AD_UNKNOWN_PSK_IDENTITY);
575 case SSL_AD_INAPPROPRIATE_FALLBACK:
576 return (TLS1_AD_INAPPROPRIATE_FALLBACK);
577 case SSL_AD_NO_APPLICATION_PROTOCOL:
578 return (TLS1_AD_NO_APPLICATION_PROTOCOL);