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) {
64 if (k > sizeof(buf)) {
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
117 size_t n, i, j, k, cl;
120 c = s->s3->tmp.new_sym_enc;
121 m = s->s3->tmp.new_hash;
122 /* m == NULL will lead to a crash later */
123 if (!ossl_assert(m != NULL)) {
124 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
127 #ifndef OPENSSL_NO_COMP
128 if (s->s3->tmp.new_compression == NULL)
131 comp = s->s3->tmp.new_compression->method;
134 if (which & SSL3_CC_READ) {
135 if (s->enc_read_ctx != NULL)
137 else if ((s->enc_read_ctx = EVP_CIPHER_CTX_new()) == NULL)
141 * make sure it's initialised in case we exit later with an error
143 EVP_CIPHER_CTX_reset(s->enc_read_ctx);
144 dd = s->enc_read_ctx;
146 if (ssl_replace_hash(&s->read_hash, m) == NULL) {
147 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
150 #ifndef OPENSSL_NO_COMP
152 COMP_CTX_free(s->expand);
155 s->expand = COMP_CTX_new(comp);
156 if (s->expand == NULL) {
157 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE,
158 SSL_R_COMPRESSION_LIBRARY_ERROR);
163 RECORD_LAYER_reset_read_sequence(&s->rlayer);
164 mac_secret = &(s->s3->read_mac_secret[0]);
166 if (s->enc_write_ctx != NULL)
168 else if ((s->enc_write_ctx = EVP_CIPHER_CTX_new()) == NULL)
172 * make sure it's initialised in case we exit later with an error
174 EVP_CIPHER_CTX_reset(s->enc_write_ctx);
175 dd = s->enc_write_ctx;
176 if (ssl_replace_hash(&s->write_hash, m) == NULL) {
177 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
180 #ifndef OPENSSL_NO_COMP
182 COMP_CTX_free(s->compress);
185 s->compress = COMP_CTX_new(comp);
186 if (s->compress == NULL) {
187 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE,
188 SSL_R_COMPRESSION_LIBRARY_ERROR);
193 RECORD_LAYER_reset_write_sequence(&s->rlayer);
194 mac_secret = &(s->s3->write_mac_secret[0]);
198 EVP_CIPHER_CTX_reset(dd);
200 p = s->s3->tmp.key_block;
201 mdi = EVP_MD_size(m);
205 cl = EVP_CIPHER_key_length(c);
207 k = EVP_CIPHER_iv_length(c);
208 if ((which == SSL3_CHANGE_CIPHER_CLIENT_WRITE) ||
209 (which == SSL3_CHANGE_CIPHER_SERVER_READ)) {
226 if (n > s->s3->tmp.key_block_length) {
227 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_INTERNAL_ERROR);
231 memcpy(mac_secret, ms, i);
233 if (!EVP_CipherInit_ex(dd, c, NULL, key, iv, (which & SSL3_CC_WRITE)))
236 OPENSSL_cleanse(exp_key, sizeof(exp_key));
237 OPENSSL_cleanse(exp_iv, sizeof(exp_iv));
240 SSLerr(SSL_F_SSL3_CHANGE_CIPHER_STATE, ERR_R_MALLOC_FAILURE);
242 OPENSSL_cleanse(exp_key, sizeof(exp_key));
243 OPENSSL_cleanse(exp_iv, sizeof(exp_iv));
247 int ssl3_setup_key_block(SSL *s)
256 if (s->s3->tmp.key_block_length != 0)
259 if (!ssl_cipher_get_evp(s->session, &c, &hash, NULL, NULL, &comp, 0)) {
260 SSLerr(SSL_F_SSL3_SETUP_KEY_BLOCK, SSL_R_CIPHER_OR_HASH_UNAVAILABLE);
264 s->s3->tmp.new_sym_enc = c;
265 s->s3->tmp.new_hash = hash;
266 #ifdef OPENSSL_NO_COMP
267 s->s3->tmp.new_compression = NULL;
269 s->s3->tmp.new_compression = comp;
272 num = EVP_MD_size(hash);
276 num = EVP_CIPHER_key_length(c) + num + EVP_CIPHER_iv_length(c);
279 ssl3_cleanup_key_block(s);
281 if ((p = OPENSSL_malloc(num)) == NULL)
284 s->s3->tmp.key_block_length = num;
285 s->s3->tmp.key_block = p;
287 ret = ssl3_generate_key_block(s, p, num);
289 if (!(s->options & SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS)) {
291 * enable vulnerability countermeasure for CBC ciphers with known-IV
292 * problem (http://www.openssl.org/~bodo/tls-cbc.txt)
294 s->s3->need_empty_fragments = 1;
296 if (s->session->cipher != NULL) {
297 if (s->session->cipher->algorithm_enc == SSL_eNULL)
298 s->s3->need_empty_fragments = 0;
300 #ifndef OPENSSL_NO_RC4
301 if (s->session->cipher->algorithm_enc == SSL_RC4)
302 s->s3->need_empty_fragments = 0;
310 SSLerr(SSL_F_SSL3_SETUP_KEY_BLOCK, ERR_R_MALLOC_FAILURE);
314 void ssl3_cleanup_key_block(SSL *s)
316 OPENSSL_clear_free(s->s3->tmp.key_block, s->s3->tmp.key_block_length);
317 s->s3->tmp.key_block = NULL;
318 s->s3->tmp.key_block_length = 0;
321 int ssl3_init_finished_mac(SSL *s)
323 BIO *buf = BIO_new(BIO_s_mem());
326 SSLerr(SSL_F_SSL3_INIT_FINISHED_MAC, ERR_R_MALLOC_FAILURE);
329 ssl3_free_digest_list(s);
330 s->s3->handshake_buffer = buf;
331 (void)BIO_set_close(s->s3->handshake_buffer, BIO_CLOSE);
336 * Free digest list. Also frees handshake buffer since they are always freed
340 void ssl3_free_digest_list(SSL *s)
342 BIO_free(s->s3->handshake_buffer);
343 s->s3->handshake_buffer = NULL;
344 EVP_MD_CTX_free(s->s3->handshake_dgst);
345 s->s3->handshake_dgst = NULL;
348 int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len)
350 if (s->s3->handshake_dgst == NULL) {
352 /* Note: this writes to a memory BIO so a failure is a fatal error */
355 ret = BIO_write(s->s3->handshake_buffer, (void *)buf, (int)len);
356 return ret > 0 && ret == (int)len;
358 return EVP_DigestUpdate(s->s3->handshake_dgst, buf, len);
362 int ssl3_digest_cached_records(SSL *s, int keep)
368 if (s->s3->handshake_dgst == NULL) {
369 hdatalen = BIO_get_mem_data(s->s3->handshake_buffer, &hdata);
371 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS,
372 SSL_R_BAD_HANDSHAKE_LENGTH);
376 s->s3->handshake_dgst = EVP_MD_CTX_new();
377 if (s->s3->handshake_dgst == NULL) {
378 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS, ERR_R_MALLOC_FAILURE);
382 md = ssl_handshake_md(s);
383 if (md == NULL || !EVP_DigestInit_ex(s->s3->handshake_dgst, md, NULL)
384 || !EVP_DigestUpdate(s->s3->handshake_dgst, hdata, hdatalen)) {
385 SSLerr(SSL_F_SSL3_DIGEST_CACHED_RECORDS, ERR_R_INTERNAL_ERROR);
390 BIO_free(s->s3->handshake_buffer);
391 s->s3->handshake_buffer = NULL;
397 size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t len,
401 EVP_MD_CTX *ctx = NULL;
403 if (!ssl3_digest_cached_records(s, 0))
406 if (EVP_MD_CTX_type(s->s3->handshake_dgst) != NID_md5_sha1) {
407 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, SSL_R_NO_REQUIRED_DIGEST);
411 ctx = EVP_MD_CTX_new();
413 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_MALLOC_FAILURE);
416 if (!EVP_MD_CTX_copy_ex(ctx, s->s3->handshake_dgst)) {
417 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_INTERNAL_ERROR);
421 ret = EVP_MD_CTX_size(ctx);
423 EVP_MD_CTX_reset(ctx);
427 if ((sender != NULL && EVP_DigestUpdate(ctx, sender, len) <= 0)
428 || EVP_MD_CTX_ctrl(ctx, EVP_CTRL_SSL3_MASTER_SECRET,
429 (int)s->session->master_key_length,
430 s->session->master_key) <= 0
431 || EVP_DigestFinal_ex(ctx, p, NULL) <= 0) {
432 SSLerr(SSL_F_SSL3_FINAL_FINISH_MAC, ERR_R_INTERNAL_ERROR);
436 EVP_MD_CTX_free(ctx);
441 int ssl3_generate_master_secret(SSL *s, unsigned char *out, unsigned char *p,
442 size_t len, size_t *secret_size)
444 static const unsigned char *salt[3] = {
445 #ifndef CHARSET_EBCDIC
446 (const unsigned char *)"A",
447 (const unsigned char *)"BB",
448 (const unsigned char *)"CCC",
450 (const unsigned char *)"\x41",
451 (const unsigned char *)"\x42\x42",
452 (const unsigned char *)"\x43\x43\x43",
455 unsigned char buf[EVP_MAX_MD_SIZE];
456 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
459 size_t ret_secret_size = 0;
462 SSLerr(SSL_F_SSL3_GENERATE_MASTER_SECRET, ERR_R_MALLOC_FAILURE);
465 for (i = 0; i < 3; i++) {
466 if (EVP_DigestInit_ex(ctx, s->ctx->sha1, NULL) <= 0
467 || EVP_DigestUpdate(ctx, salt[i],
468 strlen((const char *)salt[i])) <= 0
469 || EVP_DigestUpdate(ctx, p, len) <= 0
470 || EVP_DigestUpdate(ctx, &(s->s3->client_random[0]),
471 SSL3_RANDOM_SIZE) <= 0
472 || EVP_DigestUpdate(ctx, &(s->s3->server_random[0]),
473 SSL3_RANDOM_SIZE) <= 0
474 /* TODO(size_t) : convert me */
475 || EVP_DigestFinal_ex(ctx, buf, &n) <= 0
476 || EVP_DigestInit_ex(ctx, s->ctx->md5, NULL) <= 0
477 || EVP_DigestUpdate(ctx, p, len) <= 0
478 || EVP_DigestUpdate(ctx, buf, n) <= 0
479 || EVP_DigestFinal_ex(ctx, out, &n) <= 0) {
480 SSLerr(SSL_F_SSL3_GENERATE_MASTER_SECRET, ERR_R_INTERNAL_ERROR);
485 ret_secret_size += n;
487 EVP_MD_CTX_free(ctx);
489 OPENSSL_cleanse(buf, sizeof(buf));
491 *secret_size = ret_secret_size;
495 int ssl3_alert_code(int code)
498 case SSL_AD_CLOSE_NOTIFY:
499 return (SSL3_AD_CLOSE_NOTIFY);
500 case SSL_AD_UNEXPECTED_MESSAGE:
501 return (SSL3_AD_UNEXPECTED_MESSAGE);
502 case SSL_AD_BAD_RECORD_MAC:
503 return (SSL3_AD_BAD_RECORD_MAC);
504 case SSL_AD_DECRYPTION_FAILED:
505 return (SSL3_AD_BAD_RECORD_MAC);
506 case SSL_AD_RECORD_OVERFLOW:
507 return (SSL3_AD_BAD_RECORD_MAC);
508 case SSL_AD_DECOMPRESSION_FAILURE:
509 return (SSL3_AD_DECOMPRESSION_FAILURE);
510 case SSL_AD_HANDSHAKE_FAILURE:
511 return (SSL3_AD_HANDSHAKE_FAILURE);
512 case SSL_AD_NO_CERTIFICATE:
513 return (SSL3_AD_NO_CERTIFICATE);
514 case SSL_AD_BAD_CERTIFICATE:
515 return (SSL3_AD_BAD_CERTIFICATE);
516 case SSL_AD_UNSUPPORTED_CERTIFICATE:
517 return (SSL3_AD_UNSUPPORTED_CERTIFICATE);
518 case SSL_AD_CERTIFICATE_REVOKED:
519 return (SSL3_AD_CERTIFICATE_REVOKED);
520 case SSL_AD_CERTIFICATE_EXPIRED:
521 return (SSL3_AD_CERTIFICATE_EXPIRED);
522 case SSL_AD_CERTIFICATE_UNKNOWN:
523 return (SSL3_AD_CERTIFICATE_UNKNOWN);
524 case SSL_AD_ILLEGAL_PARAMETER:
525 return (SSL3_AD_ILLEGAL_PARAMETER);
526 case SSL_AD_UNKNOWN_CA:
527 return (SSL3_AD_BAD_CERTIFICATE);
528 case SSL_AD_ACCESS_DENIED:
529 return (SSL3_AD_HANDSHAKE_FAILURE);
530 case SSL_AD_DECODE_ERROR:
531 return (SSL3_AD_HANDSHAKE_FAILURE);
532 case SSL_AD_DECRYPT_ERROR:
533 return (SSL3_AD_HANDSHAKE_FAILURE);
534 case SSL_AD_EXPORT_RESTRICTION:
535 return (SSL3_AD_HANDSHAKE_FAILURE);
536 case SSL_AD_PROTOCOL_VERSION:
537 return (SSL3_AD_HANDSHAKE_FAILURE);
538 case SSL_AD_INSUFFICIENT_SECURITY:
539 return (SSL3_AD_HANDSHAKE_FAILURE);
540 case SSL_AD_INTERNAL_ERROR:
541 return (SSL3_AD_HANDSHAKE_FAILURE);
542 case SSL_AD_USER_CANCELLED:
543 return (SSL3_AD_HANDSHAKE_FAILURE);
544 case SSL_AD_NO_RENEGOTIATION:
545 return (-1); /* Don't send it :-) */
546 case SSL_AD_UNSUPPORTED_EXTENSION:
547 return (SSL3_AD_HANDSHAKE_FAILURE);
548 case SSL_AD_CERTIFICATE_UNOBTAINABLE:
549 return (SSL3_AD_HANDSHAKE_FAILURE);
550 case SSL_AD_UNRECOGNIZED_NAME:
551 return (SSL3_AD_HANDSHAKE_FAILURE);
552 case SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE:
553 return (SSL3_AD_HANDSHAKE_FAILURE);
554 case SSL_AD_BAD_CERTIFICATE_HASH_VALUE:
555 return (SSL3_AD_HANDSHAKE_FAILURE);
556 case SSL_AD_UNKNOWN_PSK_IDENTITY:
557 return (TLS1_AD_UNKNOWN_PSK_IDENTITY);
558 case SSL_AD_INAPPROPRIATE_FALLBACK:
559 return (TLS1_AD_INAPPROPRIATE_FALLBACK);
560 case SSL_AD_NO_APPLICATION_PROTOCOL:
561 return (TLS1_AD_NO_APPLICATION_PROTOCOL);
562 case SSL_AD_CERTIFICATE_REQUIRED:
563 return SSL_AD_HANDSHAKE_FAILURE;