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
11 #include "../ssl_locl.h"
12 #include "internal/constant_time_locl.h"
13 #include <openssl/rand.h>
14 #include "record_locl.h"
16 static const unsigned char ssl3_pad_1[48] = {
17 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
18 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
19 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
20 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
21 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
22 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36
25 static const unsigned char ssl3_pad_2[48] = {
26 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
27 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
28 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
29 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
30 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
31 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c
35 * Clear the contents of an SSL3_RECORD but retain any memory allocated
37 void SSL3_RECORD_clear(SSL3_RECORD *r, size_t num_recs)
42 for (i = 0; i < num_recs; i++) {
45 memset(&r[i], 0, sizeof(*r));
50 void SSL3_RECORD_release(SSL3_RECORD *r, size_t num_recs)
54 for (i = 0; i < num_recs; i++) {
55 OPENSSL_free(r[i].comp);
60 void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num)
62 memcpy(r->seq_num, seq_num, SEQ_NUM_SIZE);
66 * Peeks ahead into "read_ahead" data to see if we have a whole record waiting
67 * for us in the buffer.
69 static int ssl3_record_app_data_waiting(SSL *s)
75 rbuf = RECORD_LAYER_get_rbuf(&s->rlayer);
77 p = SSL3_BUFFER_get_buf(rbuf);
81 left = SSL3_BUFFER_get_left(rbuf);
83 if (left < SSL3_RT_HEADER_LENGTH)
86 p += SSL3_BUFFER_get_offset(rbuf);
89 * We only check the type and record length, we will sanity check version
92 if (*p != SSL3_RT_APPLICATION_DATA)
98 if (left < SSL3_RT_HEADER_LENGTH + len)
105 * MAX_EMPTY_RECORDS defines the number of consecutive, empty records that
106 * will be processed per call to ssl3_get_record. Without this limit an
107 * attacker could send empty records at a faster rate than we can process and
108 * cause ssl3_get_record to loop forever.
110 #define MAX_EMPTY_RECORDS 32
112 #define SSL2_RT_HEADER_LENGTH 2
114 * Call this to get new input records.
115 * It will return <= 0 if more data is needed, normally due to an error
116 * or non-blocking IO.
117 * When it finishes, |numrpipes| records have been decoded. For each record 'i':
118 * rr[i].type - is the type of record
120 * rr[i].length, - number of bytes
121 * Multiple records will only be returned if the record types are all
122 * SSL3_RT_APPLICATION_DATA. The number of records returned will always be <=
125 /* used only by ssl3_read_bytes */
126 int ssl3_get_record(SSL *s)
129 int enc_err, rret, ret = -1;
132 SSL3_RECORD *rr, *thisrr;
136 unsigned char md[EVP_MAX_MD_SIZE];
137 unsigned int version;
140 size_t num_recs = 0, max_recs, j;
141 PACKET pkt, sslv2pkt;
143 rr = RECORD_LAYER_get_rrec(&s->rlayer);
144 rbuf = RECORD_LAYER_get_rbuf(&s->rlayer);
145 max_recs = s->max_pipelines;
151 thisrr = &rr[num_recs];
153 /* check if we have the header */
154 if ((RECORD_LAYER_get_rstate(&s->rlayer) != SSL_ST_READ_BODY) ||
155 (RECORD_LAYER_get_packet_length(&s->rlayer)
156 < SSL3_RT_HEADER_LENGTH)) {
160 rret = ssl3_read_n(s, SSL3_RT_HEADER_LENGTH,
161 SSL3_BUFFER_get_len(rbuf), 0,
162 num_recs == 0 ? 1 : 0, &n);
164 return rret; /* error or non-blocking */
165 RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_BODY);
167 p = RECORD_LAYER_get_packet(&s->rlayer);
168 if (!PACKET_buf_init(&pkt, RECORD_LAYER_get_packet(&s->rlayer),
169 RECORD_LAYER_get_packet_length(&s->rlayer))) {
170 al = SSL_AD_INTERNAL_ERROR;
171 SSLerr(SSL_F_SSL3_GET_RECORD, ERR_R_INTERNAL_ERROR);
175 if (!PACKET_get_net_2_len(&sslv2pkt, &sslv2len)
176 || !PACKET_get_1(&sslv2pkt, &type)) {
177 al = SSL_AD_INTERNAL_ERROR;
178 SSLerr(SSL_F_SSL3_GET_RECORD, ERR_R_INTERNAL_ERROR);
182 * The first record received by the server may be a V2ClientHello.
184 if (s->server && RECORD_LAYER_is_first_record(&s->rlayer)
185 && (sslv2len & 0x8000) != 0
186 && (type == SSL2_MT_CLIENT_HELLO)) {
190 * |num_recs| here will actually always be 0 because
191 * |num_recs > 0| only ever occurs when we are processing
192 * multiple app data records - which we know isn't the case here
193 * because it is an SSLv2ClientHello. We keep it using
194 * |num_recs| for the sake of consistency
196 thisrr->type = SSL3_RT_HANDSHAKE;
197 thisrr->rec_version = SSL2_VERSION;
199 thisrr->length = sslv2len & 0x7fff;
201 if (thisrr->length > SSL3_BUFFER_get_len(rbuf)
202 - SSL2_RT_HEADER_LENGTH) {
203 al = SSL_AD_RECORD_OVERFLOW;
204 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_PACKET_LENGTH_TOO_LONG);
208 if (thisrr->length < MIN_SSL2_RECORD_LEN) {
209 al = SSL_AD_HANDSHAKE_FAILURE;
210 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
214 /* SSLv3+ style record */
216 * TODO(TLS1.3): This callback only provides the "outer" record
217 * type to the callback. Somehow we need to pass the "inner"
221 s->msg_callback(0, 0, SSL3_RT_HEADER, p, 5, s,
222 s->msg_callback_arg);
224 /* Pull apart the header into the SSL3_RECORD */
225 if (!PACKET_get_1(&pkt, &type)
226 || !PACKET_get_net_2(&pkt, &version)
227 || !PACKET_get_net_2_len(&pkt, &thisrr->length)) {
228 al = SSL_AD_INTERNAL_ERROR;
229 SSLerr(SSL_F_SSL3_GET_RECORD, ERR_R_INTERNAL_ERROR);
233 thisrr->rec_version = version;
235 /* Lets check version. In TLSv1.3 we ignore this field */
236 if (!s->first_packet && !SSL_IS_TLS13(s)
237 && version != (unsigned int)s->version) {
238 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_WRONG_VERSION_NUMBER);
239 if ((s->version & 0xFF00) == (version & 0xFF00)
240 && !s->enc_write_ctx && !s->write_hash) {
241 if (thisrr->type == SSL3_RT_ALERT) {
243 * The record is using an incorrect version number,
244 * but what we've got appears to be an alert. We
245 * haven't read the body yet to check whether its a
246 * fatal or not - but chances are it is. We probably
247 * shouldn't send a fatal alert back. We'll just
253 * Send back error using their minor version number :-)
255 s->version = (unsigned short)version;
257 al = SSL_AD_PROTOCOL_VERSION;
261 if ((version >> 8) != SSL3_VERSION_MAJOR) {
262 if (RECORD_LAYER_is_first_record(&s->rlayer)) {
263 /* Go back to start of packet, look at the five bytes
265 p = RECORD_LAYER_get_packet(&s->rlayer);
266 if (strncmp((char *)p, "GET ", 4) == 0 ||
267 strncmp((char *)p, "POST ", 5) == 0 ||
268 strncmp((char *)p, "HEAD ", 5) == 0 ||
269 strncmp((char *)p, "PUT ", 4) == 0) {
270 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_HTTP_REQUEST);
272 } else if (strncmp((char *)p, "CONNE", 5) == 0) {
273 SSLerr(SSL_F_SSL3_GET_RECORD,
274 SSL_R_HTTPS_PROXY_REQUEST);
278 /* Doesn't look like TLS - don't send an alert */
279 SSLerr(SSL_F_SSL3_GET_RECORD,
280 SSL_R_WRONG_VERSION_NUMBER);
283 SSLerr(SSL_F_SSL3_GET_RECORD,
284 SSL_R_WRONG_VERSION_NUMBER);
285 al = SSL_AD_PROTOCOL_VERSION;
290 if (SSL_IS_TLS13(s) && s->enc_read_ctx != NULL
291 && thisrr->type != SSL3_RT_APPLICATION_DATA) {
292 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_RECORD_TYPE);
293 al = SSL_AD_UNEXPECTED_MESSAGE;
298 SSL3_BUFFER_get_len(rbuf) - SSL3_RT_HEADER_LENGTH) {
299 al = SSL_AD_RECORD_OVERFLOW;
300 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_PACKET_LENGTH_TOO_LONG);
305 /* now s->rlayer.rstate == SSL_ST_READ_BODY */
309 * s->rlayer.rstate == SSL_ST_READ_BODY, get and decode the data.
310 * Calculate how much more data we need to read for the rest of the
313 if (thisrr->rec_version == SSL2_VERSION) {
314 more = thisrr->length + SSL2_RT_HEADER_LENGTH
315 - SSL3_RT_HEADER_LENGTH;
317 more = thisrr->length;
320 /* now s->packet_length == SSL3_RT_HEADER_LENGTH */
322 rret = ssl3_read_n(s, more, more, 1, 0, &n);
324 return rret; /* error or non-blocking io */
327 /* set state for later operations */
328 RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_HEADER);
331 * At this point, s->packet_length == SSL3_RT_HEADER_LENGTH
332 * + thisrr->length, or s->packet_length == SSL2_RT_HEADER_LENGTH
333 * + thisrr->length and we have that many bytes in s->packet
335 if (thisrr->rec_version == SSL2_VERSION) {
337 &(RECORD_LAYER_get_packet(&s->rlayer)[SSL2_RT_HEADER_LENGTH]);
340 &(RECORD_LAYER_get_packet(&s->rlayer)[SSL3_RT_HEADER_LENGTH]);
344 * ok, we can now read from 's->packet' data into 'thisrr' thisrr->input
345 * points at thisrr->length bytes, which need to be copied into
346 * thisrr->data by either the decryption or by the decompression When
347 * the data is 'copied' into the thisrr->data buffer, thisrr->input will
348 * be pointed at the new buffer
352 * We now have - encrypted [ MAC [ compressed [ plain ] ] ]
353 * thisrr->length bytes of encrypted compressed stuff.
356 /* check is not needed I believe */
357 if (thisrr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
358 al = SSL_AD_RECORD_OVERFLOW;
359 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
363 /* decrypt in place in 'thisrr->input' */
364 thisrr->data = thisrr->input;
365 thisrr->orig_len = thisrr->length;
367 /* Mark this record as not read by upper layers yet */
372 /* we have pulled in a full packet so zero things */
373 RECORD_LAYER_reset_packet_length(&s->rlayer);
374 RECORD_LAYER_clear_first_record(&s->rlayer);
375 } while (num_recs < max_recs
376 && thisrr->type == SSL3_RT_APPLICATION_DATA
377 && SSL_USE_EXPLICIT_IV(s)
378 && s->enc_read_ctx != NULL
379 && (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_read_ctx))
380 & EVP_CIPH_FLAG_PIPELINE)
381 && ssl3_record_app_data_waiting(s));
384 * If in encrypt-then-mac mode calculate mac from encrypted record. All
385 * the details below are public so no timing details can leak.
387 if (SSL_READ_ETM(s) && s->read_hash) {
389 /* TODO(size_t): convert this to do size_t properly */
390 imac_size = EVP_MD_CTX_size(s->read_hash);
391 assert(imac_size >= 0 && imac_size <= EVP_MAX_MD_SIZE);
392 if (imac_size < 0 || imac_size > EVP_MAX_MD_SIZE) {
393 al = SSL_AD_INTERNAL_ERROR;
394 SSLerr(SSL_F_SSL3_GET_RECORD, ERR_LIB_EVP);
397 mac_size = (size_t)imac_size;
398 for (j = 0; j < num_recs; j++) {
401 if (thisrr->length < mac_size) {
402 al = SSL_AD_DECODE_ERROR;
403 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
406 thisrr->length -= mac_size;
407 mac = thisrr->data + thisrr->length;
408 i = s->method->ssl3_enc->mac(s, thisrr, md, 0 /* not send */ );
409 if (i == 0 || CRYPTO_memcmp(md, mac, mac_size) != 0) {
410 al = SSL_AD_BAD_RECORD_MAC;
411 SSLerr(SSL_F_SSL3_GET_RECORD,
412 SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
418 enc_err = s->method->ssl3_enc->enc(s, rr, num_recs, 0);
422 * 0: (in non-constant time) if the record is publically invalid.
423 * 1: if the padding is valid
424 * -1: if the padding is invalid
427 if (num_recs == 1 && ossl_statem_skip_early_data(s)) {
429 * We assume this is unreadable early_data - we treat it like an
435 RECORD_LAYER_set_numrpipes(&s->rlayer, 1);
438 al = SSL_AD_DECRYPTION_FAILED;
439 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BLOCK_CIPHER_PAD_IS_WRONG);
443 printf("dec %"OSSLzu"\n", rr[0].length);
446 for (z = 0; z < rr[0].length; z++)
447 printf("%02X%c", rr[0].data[z], ((z + 1) % 16) ? ' ' : '\n');
452 /* r->length is now the compressed data plus mac */
453 if ((sess != NULL) &&
454 (s->enc_read_ctx != NULL) &&
455 (!SSL_READ_ETM(s) && EVP_MD_CTX_md(s->read_hash) != NULL)) {
456 /* s->read_hash != NULL => mac_size != -1 */
457 unsigned char *mac = NULL;
458 unsigned char mac_tmp[EVP_MAX_MD_SIZE];
460 mac_size = EVP_MD_CTX_size(s->read_hash);
461 OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
463 for (j = 0; j < num_recs; j++) {
466 * orig_len is the length of the record before any padding was
467 * removed. This is public information, as is the MAC in use,
468 * therefore we can safely process the record in a different amount
469 * of time if it's too short to possibly contain a MAC.
471 if (thisrr->orig_len < mac_size ||
472 /* CBC records must have a padding length byte too. */
473 (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
474 thisrr->orig_len < mac_size + 1)) {
475 al = SSL_AD_DECODE_ERROR;
476 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
480 if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
482 * We update the length so that the TLS header bytes can be
483 * constructed correctly but we need to extract the MAC in
484 * constant time from within the record, without leaking the
485 * contents of the padding bytes.
488 ssl3_cbc_copy_mac(mac_tmp, thisrr, mac_size);
489 thisrr->length -= mac_size;
492 * In this case there's no padding, so |rec->orig_len| equals
493 * |rec->length| and we checked that there's enough bytes for
496 thisrr->length -= mac_size;
497 mac = &thisrr->data[thisrr->length];
500 i = s->method->ssl3_enc->mac(s, thisrr, md, 0 /* not send */ );
501 if (i == 0 || mac == NULL
502 || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0)
504 if (thisrr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + mac_size)
511 * A separate 'decryption_failed' alert was introduced with TLS 1.0,
512 * SSL 3.0 only has 'bad_record_mac'. But unless a decryption
513 * failure is directly visible from the ciphertext anyway, we should
514 * not reveal which kind of error occurred -- this might become
515 * visible to an attacker (e.g. via a logfile)
517 al = SSL_AD_BAD_RECORD_MAC;
518 SSLerr(SSL_F_SSL3_GET_RECORD,
519 SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
523 for (j = 0; j < num_recs; j++) {
526 /* thisrr->length is now just compressed */
527 if (s->expand != NULL) {
528 if (thisrr->length > SSL3_RT_MAX_COMPRESSED_LENGTH) {
529 al = SSL_AD_RECORD_OVERFLOW;
530 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_COMPRESSED_LENGTH_TOO_LONG);
533 if (!ssl3_do_uncompress(s, thisrr)) {
534 al = SSL_AD_DECOMPRESSION_FAILURE;
535 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_DECOMPRESSION);
540 if (SSL_IS_TLS13(s) && s->enc_read_ctx != NULL) {
543 if (thisrr->length == 0) {
544 al = SSL_AD_UNEXPECTED_MESSAGE;
545 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_RECORD_TYPE);
549 /* Strip trailing padding */
550 for (end = thisrr->length - 1; end > 0 && thisrr->data[end] == 0;
554 thisrr->length = end;
555 thisrr->type = thisrr->data[end];
556 if (thisrr->type != SSL3_RT_APPLICATION_DATA
557 && thisrr->type != SSL3_RT_ALERT
558 && thisrr->type != SSL3_RT_HANDSHAKE) {
559 al = SSL_AD_UNEXPECTED_MESSAGE;
560 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_RECORD_TYPE);
565 if (thisrr->length > SSL3_RT_MAX_PLAIN_LENGTH) {
566 al = SSL_AD_RECORD_OVERFLOW;
567 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
573 * So at this point the following is true
574 * thisrr->type is the type of record
575 * thisrr->length == number of bytes in record
576 * thisrr->off == offset to first valid byte
577 * thisrr->data == where to take bytes from, increment after use :-).
580 /* just read a 0 length packet */
581 if (thisrr->length == 0) {
582 RECORD_LAYER_inc_empty_record_count(&s->rlayer);
583 if (RECORD_LAYER_get_empty_record_count(&s->rlayer)
584 > MAX_EMPTY_RECORDS) {
585 al = SSL_AD_UNEXPECTED_MESSAGE;
586 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_RECORD_TOO_SMALL);
590 RECORD_LAYER_reset_empty_record_count(&s->rlayer);
594 RECORD_LAYER_set_numrpipes(&s->rlayer, num_recs);
598 ssl3_send_alert(s, SSL3_AL_FATAL, al);
603 int ssl3_do_uncompress(SSL *ssl, SSL3_RECORD *rr)
605 #ifndef OPENSSL_NO_COMP
608 if (rr->comp == NULL) {
609 rr->comp = (unsigned char *)
610 OPENSSL_malloc(SSL3_RT_MAX_ENCRYPTED_LENGTH);
612 if (rr->comp == NULL)
615 /* TODO(size_t): Convert this call */
616 i = COMP_expand_block(ssl->expand, rr->comp,
617 SSL3_RT_MAX_PLAIN_LENGTH, rr->data, (int)rr->length);
627 int ssl3_do_compress(SSL *ssl, SSL3_RECORD *wr)
629 #ifndef OPENSSL_NO_COMP
632 /* TODO(size_t): Convert this call */
633 i = COMP_compress_block(ssl->compress, wr->data,
634 (int)(wr->length + SSL3_RT_MAX_COMPRESSED_OVERHEAD),
635 wr->input, (int)wr->length);
641 wr->input = wr->data;
647 * ssl3_enc encrypts/decrypts |n_recs| records in |inrecs|
650 * 0: (in non-constant time) if the record is publically invalid (i.e. too
652 * 1: if the record's padding is valid / the encryption was successful.
653 * -1: if the record's padding is invalid or, if sending, an internal error
656 int ssl3_enc(SSL *s, SSL3_RECORD *inrecs, size_t n_recs, int send)
661 size_t bs, mac_size = 0;
663 const EVP_CIPHER *enc;
667 * We shouldn't ever be called with more than one record in the SSLv3 case
672 ds = s->enc_write_ctx;
673 if (s->enc_write_ctx == NULL)
676 enc = EVP_CIPHER_CTX_cipher(s->enc_write_ctx);
678 ds = s->enc_read_ctx;
679 if (s->enc_read_ctx == NULL)
682 enc = EVP_CIPHER_CTX_cipher(s->enc_read_ctx);
685 if ((s->session == NULL) || (ds == NULL) || (enc == NULL)) {
686 memmove(rec->data, rec->input, rec->length);
687 rec->input = rec->data;
690 /* TODO(size_t): Convert this call */
691 bs = EVP_CIPHER_CTX_block_size(ds);
695 if ((bs != 1) && send) {
698 /* we need to add 'i-1' padding bytes */
701 * the last of these zero bytes will be overwritten with the
704 memset(&rec->input[rec->length], 0, i);
706 rec->input[l - 1] = (unsigned char)(i - 1);
710 if (l == 0 || l % bs != 0)
712 /* otherwise, rec->length >= bs */
715 /* TODO(size_t): Convert this call */
716 if (EVP_Cipher(ds, rec->data, rec->input, (unsigned int)l) < 1)
719 if (EVP_MD_CTX_md(s->read_hash) != NULL) {
720 /* TODO(size_t): convert me */
721 imac_size = EVP_MD_CTX_size(s->read_hash);
724 mac_size = (size_t)imac_size;
726 if ((bs != 1) && !send)
727 return ssl3_cbc_remove_padding(rec, bs, mac_size);
732 #define MAX_PADDING 256
734 * tls1_enc encrypts/decrypts |n_recs| in |recs|.
737 * 0: (in non-constant time) if the record is publically invalid (i.e. too
739 * 1: if the record's padding is valid / the encryption was successful.
740 * -1: if the record's padding/AEAD-authenticator is invalid or, if sending,
741 * an internal error occurred.
743 int tls1_enc(SSL *s, SSL3_RECORD *recs, size_t n_recs, int send)
746 size_t reclen[SSL_MAX_PIPELINES];
747 unsigned char buf[SSL_MAX_PIPELINES][EVP_AEAD_TLS1_AAD_LEN];
748 int i, pad = 0, ret, tmpr;
749 size_t bs, mac_size = 0, ctr, padnum, loop;
750 unsigned char padval;
752 const EVP_CIPHER *enc;
758 if (EVP_MD_CTX_md(s->write_hash)) {
759 int n = EVP_MD_CTX_size(s->write_hash);
760 OPENSSL_assert(n >= 0);
762 ds = s->enc_write_ctx;
763 if (s->enc_write_ctx == NULL)
767 enc = EVP_CIPHER_CTX_cipher(s->enc_write_ctx);
768 /* For TLSv1.1 and later explicit IV */
769 if (SSL_USE_EXPLICIT_IV(s)
770 && EVP_CIPHER_mode(enc) == EVP_CIPH_CBC_MODE)
771 ivlen = EVP_CIPHER_iv_length(enc);
775 for (ctr = 0; ctr < n_recs; ctr++) {
776 if (recs[ctr].data != recs[ctr].input) {
778 * we can't write into the input stream: Can this ever
781 SSLerr(SSL_F_TLS1_ENC, ERR_R_INTERNAL_ERROR);
783 } else if (RAND_bytes(recs[ctr].input, ivlen) <= 0) {
784 SSLerr(SSL_F_TLS1_ENC, ERR_R_INTERNAL_ERROR);
791 if (EVP_MD_CTX_md(s->read_hash)) {
792 int n = EVP_MD_CTX_size(s->read_hash);
793 OPENSSL_assert(n >= 0);
795 ds = s->enc_read_ctx;
796 if (s->enc_read_ctx == NULL)
799 enc = EVP_CIPHER_CTX_cipher(s->enc_read_ctx);
802 if ((s->session == NULL) || (ds == NULL) || (enc == NULL)) {
803 for (ctr = 0; ctr < n_recs; ctr++) {
804 memmove(recs[ctr].data, recs[ctr].input, recs[ctr].length);
805 recs[ctr].input = recs[ctr].data;
809 bs = EVP_CIPHER_block_size(EVP_CIPHER_CTX_cipher(ds));
812 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds))
813 & EVP_CIPH_FLAG_PIPELINE)) {
815 * We shouldn't have been called with pipeline data if the
816 * cipher doesn't support pipelining
818 SSLerr(SSL_F_TLS1_ENC, SSL_R_PIPELINE_FAILURE);
822 for (ctr = 0; ctr < n_recs; ctr++) {
823 reclen[ctr] = recs[ctr].length;
825 if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds))
826 & EVP_CIPH_FLAG_AEAD_CIPHER) {
829 seq = send ? RECORD_LAYER_get_write_sequence(&s->rlayer)
830 : RECORD_LAYER_get_read_sequence(&s->rlayer);
832 if (SSL_IS_DTLS(s)) {
833 /* DTLS does not support pipelining */
834 unsigned char dtlsseq[9], *p = dtlsseq;
836 s2n(send ? DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer) :
837 DTLS_RECORD_LAYER_get_r_epoch(&s->rlayer), p);
838 memcpy(p, &seq[2], 6);
839 memcpy(buf[ctr], dtlsseq, 8);
841 memcpy(buf[ctr], seq, 8);
842 for (i = 7; i >= 0; i--) { /* increment */
849 buf[ctr][8] = recs[ctr].type;
850 buf[ctr][9] = (unsigned char)(s->version >> 8);
851 buf[ctr][10] = (unsigned char)(s->version);
852 buf[ctr][11] = (unsigned char)(recs[ctr].length >> 8);
853 buf[ctr][12] = (unsigned char)(recs[ctr].length & 0xff);
854 pad = EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_AEAD_TLS1_AAD,
855 EVP_AEAD_TLS1_AAD_LEN, buf[ctr]);
861 recs[ctr].length += pad;
864 } else if ((bs != 1) && send) {
865 padnum = bs - (reclen[ctr] % bs);
867 /* Add weird padding of upto 256 bytes */
869 if (padnum > MAX_PADDING)
871 /* we need to add 'padnum' padding bytes of value padval */
872 padval = (unsigned char)(padnum - 1);
873 for (loop = reclen[ctr]; loop < reclen[ctr] + padnum; loop++)
874 recs[ctr].input[loop] = padval;
875 reclen[ctr] += padnum;
876 recs[ctr].length += padnum;
880 if (reclen[ctr] == 0 || reclen[ctr] % bs != 0)
885 unsigned char *data[SSL_MAX_PIPELINES];
887 /* Set the output buffers */
888 for (ctr = 0; ctr < n_recs; ctr++) {
889 data[ctr] = recs[ctr].data;
891 if (EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS,
892 (int)n_recs, data) <= 0) {
893 SSLerr(SSL_F_TLS1_ENC, SSL_R_PIPELINE_FAILURE);
895 /* Set the input buffers */
896 for (ctr = 0; ctr < n_recs; ctr++) {
897 data[ctr] = recs[ctr].input;
899 if (EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_SET_PIPELINE_INPUT_BUFS,
900 (int)n_recs, data) <= 0
901 || EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_SET_PIPELINE_INPUT_LENS,
902 (int)n_recs, reclen) <= 0) {
903 SSLerr(SSL_F_TLS1_ENC, SSL_R_PIPELINE_FAILURE);
908 /* TODO(size_t): Convert this call */
909 tmpr = EVP_Cipher(ds, recs[0].data, recs[0].input,
910 (unsigned int)reclen[0]);
911 if ((EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds))
912 & EVP_CIPH_FLAG_CUSTOM_CIPHER)
915 return -1; /* AEAD can fail to verify MAC */
917 if (EVP_CIPHER_mode(enc) == EVP_CIPH_GCM_MODE) {
918 for (ctr = 0; ctr < n_recs; ctr++) {
919 recs[ctr].data += EVP_GCM_TLS_EXPLICIT_IV_LEN;
920 recs[ctr].input += EVP_GCM_TLS_EXPLICIT_IV_LEN;
921 recs[ctr].length -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
923 } else if (EVP_CIPHER_mode(enc) == EVP_CIPH_CCM_MODE) {
924 for (ctr = 0; ctr < n_recs; ctr++) {
925 recs[ctr].data += EVP_CCM_TLS_EXPLICIT_IV_LEN;
926 recs[ctr].input += EVP_CCM_TLS_EXPLICIT_IV_LEN;
927 recs[ctr].length -= EVP_CCM_TLS_EXPLICIT_IV_LEN;
933 if (!SSL_READ_ETM(s) && EVP_MD_CTX_md(s->read_hash) != NULL) {
934 imac_size = EVP_MD_CTX_size(s->read_hash);
937 mac_size = (size_t)imac_size;
939 if ((bs != 1) && !send) {
941 for (ctr = 0; ctr < n_recs; ctr++) {
942 tmpret = tls1_cbc_remove_padding(s, &recs[ctr], bs, mac_size);
944 * If tmpret == 0 then this means publicly invalid so we can
945 * short circuit things here. Otherwise we must respect constant
950 ret = constant_time_select_int(constant_time_eq_int(tmpret, 1),
955 for (ctr = 0; ctr < n_recs; ctr++) {
956 recs[ctr].length -= pad;
963 int n_ssl3_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send)
965 unsigned char *mac_sec, *seq;
966 const EVP_MD_CTX *hash;
967 unsigned char *p, rec_char;
973 mac_sec = &(ssl->s3->write_mac_secret[0]);
974 seq = RECORD_LAYER_get_write_sequence(&ssl->rlayer);
975 hash = ssl->write_hash;
977 mac_sec = &(ssl->s3->read_mac_secret[0]);
978 seq = RECORD_LAYER_get_read_sequence(&ssl->rlayer);
979 hash = ssl->read_hash;
982 t = EVP_MD_CTX_size(hash);
986 npad = (48 / md_size) * md_size;
989 EVP_CIPHER_CTX_mode(ssl->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
990 ssl3_cbc_record_digest_supported(hash)) {
992 * This is a CBC-encrypted record. We must avoid leaking any
993 * timing-side channel information about how many blocks of data we
994 * are hashing because that gives an attacker a timing-oracle.
998 * npad is, at most, 48 bytes and that's with MD5:
999 * 16 + 48 + 8 (sequence bytes) + 1 + 2 = 75.
1001 * With SHA-1 (the largest hash speced for SSLv3) the hash size
1002 * goes up 4, but npad goes down by 8, resulting in a smaller
1005 unsigned char header[75];
1007 memcpy(header + j, mac_sec, md_size);
1009 memcpy(header + j, ssl3_pad_1, npad);
1011 memcpy(header + j, seq, 8);
1013 header[j++] = rec->type;
1014 header[j++] = (unsigned char)(rec->length >> 8);
1015 header[j++] = (unsigned char)(rec->length & 0xff);
1017 /* Final param == is SSLv3 */
1018 if (ssl3_cbc_digest_record(hash,
1021 rec->length + md_size, rec->orig_len,
1022 mac_sec, md_size, 1) <= 0)
1025 unsigned int md_size_u;
1026 /* Chop the digest off the end :-) */
1027 EVP_MD_CTX *md_ctx = EVP_MD_CTX_new();
1032 rec_char = rec->type;
1034 s2n(rec->length, p);
1035 if (EVP_MD_CTX_copy_ex(md_ctx, hash) <= 0
1036 || EVP_DigestUpdate(md_ctx, mac_sec, md_size) <= 0
1037 || EVP_DigestUpdate(md_ctx, ssl3_pad_1, npad) <= 0
1038 || EVP_DigestUpdate(md_ctx, seq, 8) <= 0
1039 || EVP_DigestUpdate(md_ctx, &rec_char, 1) <= 0
1040 || EVP_DigestUpdate(md_ctx, md, 2) <= 0
1041 || EVP_DigestUpdate(md_ctx, rec->input, rec->length) <= 0
1042 || EVP_DigestFinal_ex(md_ctx, md, NULL) <= 0
1043 || EVP_MD_CTX_copy_ex(md_ctx, hash) <= 0
1044 || EVP_DigestUpdate(md_ctx, mac_sec, md_size) <= 0
1045 || EVP_DigestUpdate(md_ctx, ssl3_pad_2, npad) <= 0
1046 || EVP_DigestUpdate(md_ctx, md, md_size) <= 0
1047 || EVP_DigestFinal_ex(md_ctx, md, &md_size_u) <= 0) {
1048 EVP_MD_CTX_reset(md_ctx);
1052 EVP_MD_CTX_free(md_ctx);
1055 ssl3_record_sequence_update(seq);
1059 int tls1_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send)
1065 EVP_MD_CTX *hmac = NULL, *mac_ctx;
1066 unsigned char header[13];
1067 int stream_mac = (send ? (ssl->mac_flags & SSL_MAC_FLAG_WRITE_MAC_STREAM)
1068 : (ssl->mac_flags & SSL_MAC_FLAG_READ_MAC_STREAM));
1072 seq = RECORD_LAYER_get_write_sequence(&ssl->rlayer);
1073 hash = ssl->write_hash;
1075 seq = RECORD_LAYER_get_read_sequence(&ssl->rlayer);
1076 hash = ssl->read_hash;
1079 t = EVP_MD_CTX_size(hash);
1080 OPENSSL_assert(t >= 0);
1083 /* I should fix this up TLS TLS TLS TLS TLS XXXXXXXX */
1087 hmac = EVP_MD_CTX_new();
1088 if (hmac == NULL || !EVP_MD_CTX_copy(hmac, hash))
1093 if (SSL_IS_DTLS(ssl)) {
1094 unsigned char dtlsseq[8], *p = dtlsseq;
1096 s2n(send ? DTLS_RECORD_LAYER_get_w_epoch(&ssl->rlayer) :
1097 DTLS_RECORD_LAYER_get_r_epoch(&ssl->rlayer), p);
1098 memcpy(p, &seq[2], 6);
1100 memcpy(header, dtlsseq, 8);
1102 memcpy(header, seq, 8);
1104 header[8] = rec->type;
1105 header[9] = (unsigned char)(ssl->version >> 8);
1106 header[10] = (unsigned char)(ssl->version);
1107 header[11] = (unsigned char)(rec->length >> 8);
1108 header[12] = (unsigned char)(rec->length & 0xff);
1110 if (!send && !SSL_READ_ETM(ssl) &&
1111 EVP_CIPHER_CTX_mode(ssl->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
1112 ssl3_cbc_record_digest_supported(mac_ctx)) {
1114 * This is a CBC-encrypted record. We must avoid leaking any
1115 * timing-side channel information about how many blocks of data we
1116 * are hashing because that gives an attacker a timing-oracle.
1118 /* Final param == not SSLv3 */
1119 if (ssl3_cbc_digest_record(mac_ctx,
1122 rec->length + md_size, rec->orig_len,
1123 ssl->s3->read_mac_secret,
1124 ssl->s3->read_mac_secret_size, 0) <= 0) {
1125 EVP_MD_CTX_free(hmac);
1129 /* TODO(size_t): Convert these calls */
1130 if (EVP_DigestSignUpdate(mac_ctx, header, sizeof(header)) <= 0
1131 || EVP_DigestSignUpdate(mac_ctx, rec->input, rec->length) <= 0
1132 || EVP_DigestSignFinal(mac_ctx, md, &md_size) <= 0) {
1133 EVP_MD_CTX_free(hmac);
1138 EVP_MD_CTX_free(hmac);
1141 fprintf(stderr, "seq=");
1144 for (z = 0; z < 8; z++)
1145 fprintf(stderr, "%02X ", seq[z]);
1146 fprintf(stderr, "\n");
1148 fprintf(stderr, "rec=");
1151 for (z = 0; z < rec->length; z++)
1152 fprintf(stderr, "%02X ", rec->data[z]);
1153 fprintf(stderr, "\n");
1157 if (!SSL_IS_DTLS(ssl)) {
1158 for (i = 7; i >= 0; i--) {
1167 for (z = 0; z < md_size; z++)
1168 fprintf(stderr, "%02X ", md[z]);
1169 fprintf(stderr, "\n");
1176 * ssl3_cbc_remove_padding removes padding from the decrypted, SSLv3, CBC
1177 * record in |rec| by updating |rec->length| in constant time.
1179 * block_size: the block size of the cipher used to encrypt the record.
1181 * 0: (in non-constant time) if the record is publicly invalid.
1182 * 1: if the padding was valid
1185 int ssl3_cbc_remove_padding(SSL3_RECORD *rec,
1186 size_t block_size, size_t mac_size)
1188 size_t padding_length;
1190 const size_t overhead = 1 /* padding length byte */ + mac_size;
1193 * These lengths are all public so we can test them in non-constant time.
1195 if (overhead > rec->length)
1198 padding_length = rec->data[rec->length - 1];
1199 good = constant_time_ge_s(rec->length, padding_length + overhead);
1200 /* SSLv3 requires that the padding is minimal. */
1201 good &= constant_time_ge_s(block_size, padding_length + 1);
1202 rec->length -= good & (padding_length + 1);
1203 return constant_time_select_int_s(good, 1, -1);
1207 * tls1_cbc_remove_padding removes the CBC padding from the decrypted, TLS, CBC
1208 * record in |rec| in constant time and returns 1 if the padding is valid and
1209 * -1 otherwise. It also removes any explicit IV from the start of the record
1210 * without leaking any timing about whether there was enough space after the
1211 * padding was removed.
1213 * block_size: the block size of the cipher used to encrypt the record.
1215 * 0: (in non-constant time) if the record is publicly invalid.
1216 * 1: if the padding was valid
1219 int tls1_cbc_remove_padding(const SSL *s,
1221 size_t block_size, size_t mac_size)
1224 size_t padding_length, to_check, i;
1225 const size_t overhead = 1 /* padding length byte */ + mac_size;
1226 /* Check if version requires explicit IV */
1227 if (SSL_USE_EXPLICIT_IV(s)) {
1229 * These lengths are all public so we can test them in non-constant
1232 if (overhead + block_size > rec->length)
1234 /* We can now safely skip explicit IV */
1235 rec->data += block_size;
1236 rec->input += block_size;
1237 rec->length -= block_size;
1238 rec->orig_len -= block_size;
1239 } else if (overhead > rec->length)
1242 padding_length = rec->data[rec->length - 1];
1244 if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_read_ctx)) &
1245 EVP_CIPH_FLAG_AEAD_CIPHER) {
1246 /* padding is already verified */
1247 rec->length -= padding_length + 1;
1251 good = constant_time_ge_s(rec->length, overhead + padding_length);
1253 * The padding consists of a length byte at the end of the record and
1254 * then that many bytes of padding, all with the same value as the length
1255 * byte. Thus, with the length byte included, there are i+1 bytes of
1256 * padding. We can't check just |padding_length+1| bytes because that
1257 * leaks decrypted information. Therefore we always have to check the
1258 * maximum amount of padding possible. (Again, the length of the record
1259 * is public information so we can use it.)
1261 to_check = 256; /* maximum amount of padding, inc length byte. */
1262 if (to_check > rec->length)
1263 to_check = rec->length;
1265 for (i = 0; i < to_check; i++) {
1266 unsigned char mask = constant_time_ge_8_s(padding_length, i);
1267 unsigned char b = rec->data[rec->length - 1 - i];
1269 * The final |padding_length+1| bytes should all have the value
1270 * |padding_length|. Therefore the XOR should be zero.
1272 good &= ~(mask & (padding_length ^ b));
1276 * If any of the final |padding_length+1| bytes had the wrong value, one
1277 * or more of the lower eight bits of |good| will be cleared.
1279 good = constant_time_eq_s(0xff, good & 0xff);
1280 rec->length -= good & (padding_length + 1);
1282 return constant_time_select_int_s(good, 1, -1);
1286 * ssl3_cbc_copy_mac copies |md_size| bytes from the end of |rec| to |out| in
1287 * constant time (independent of the concrete value of rec->length, which may
1288 * vary within a 256-byte window).
1290 * ssl3_cbc_remove_padding or tls1_cbc_remove_padding must be called prior to
1294 * rec->orig_len >= md_size
1295 * md_size <= EVP_MAX_MD_SIZE
1297 * If CBC_MAC_ROTATE_IN_PLACE is defined then the rotation is performed with
1298 * variable accesses in a 64-byte-aligned buffer. Assuming that this fits into
1299 * a single or pair of cache-lines, then the variable memory accesses don't
1300 * actually affect the timing. CPUs with smaller cache-lines [if any] are
1301 * not multi-core and are not considered vulnerable to cache-timing attacks.
1303 #define CBC_MAC_ROTATE_IN_PLACE
1305 void ssl3_cbc_copy_mac(unsigned char *out,
1306 const SSL3_RECORD *rec, size_t md_size)
1308 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1309 unsigned char rotated_mac_buf[64 + EVP_MAX_MD_SIZE];
1310 unsigned char *rotated_mac;
1312 unsigned char rotated_mac[EVP_MAX_MD_SIZE];
1316 * mac_end is the index of |rec->data| just after the end of the MAC.
1318 size_t mac_end = rec->length;
1319 size_t mac_start = mac_end - md_size;
1322 * scan_start contains the number of bytes that we can ignore because the
1323 * MAC's position can only vary by 255 bytes.
1325 size_t scan_start = 0;
1327 size_t rotate_offset;
1329 OPENSSL_assert(rec->orig_len >= md_size);
1330 OPENSSL_assert(md_size <= EVP_MAX_MD_SIZE);
1332 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1333 rotated_mac = rotated_mac_buf + ((0 - (size_t)rotated_mac_buf) & 63);
1336 /* This information is public so it's safe to branch based on it. */
1337 if (rec->orig_len > md_size + 255 + 1)
1338 scan_start = rec->orig_len - (md_size + 255 + 1);
1342 memset(rotated_mac, 0, md_size);
1343 for (i = scan_start, j = 0; i < rec->orig_len; i++) {
1344 size_t mac_started = constant_time_eq_s(i, mac_start);
1345 size_t mac_ended = constant_time_lt_s(i, mac_end);
1346 unsigned char b = rec->data[i];
1348 in_mac |= mac_started;
1349 in_mac &= mac_ended;
1350 rotate_offset |= j & mac_started;
1351 rotated_mac[j++] |= b & in_mac;
1352 j &= constant_time_lt_s(j, md_size);
1355 /* Now rotate the MAC */
1356 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1358 for (i = 0; i < md_size; i++) {
1359 /* in case cache-line is 32 bytes, touch second line */
1360 ((volatile unsigned char *)rotated_mac)[rotate_offset ^ 32];
1361 out[j++] = rotated_mac[rotate_offset++];
1362 rotate_offset &= constant_time_lt_s(rotate_offset, md_size);
1365 memset(out, 0, md_size);
1366 rotate_offset = md_size - rotate_offset;
1367 rotate_offset &= constant_time_lt_s(rotate_offset, md_size);
1368 for (i = 0; i < md_size; i++) {
1369 for (j = 0; j < md_size; j++)
1370 out[j] |= rotated_mac[i] & constant_time_eq_8_s(j, rotate_offset);
1372 rotate_offset &= constant_time_lt_s(rotate_offset, md_size);
1377 int dtls1_process_record(SSL *s, DTLS1_BITMAP *bitmap)
1385 unsigned char md[EVP_MAX_MD_SIZE];
1387 rr = RECORD_LAYER_get_rrec(&s->rlayer);
1391 * At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
1392 * and we have that many bytes in s->packet
1394 rr->input = &(RECORD_LAYER_get_packet(&s->rlayer)[DTLS1_RT_HEADER_LENGTH]);
1397 * ok, we can now read from 's->packet' data into 'rr' rr->input points
1398 * at rr->length bytes, which need to be copied into rr->data by either
1399 * the decryption or by the decompression When the data is 'copied' into
1400 * the rr->data buffer, rr->input will be pointed at the new buffer
1404 * We now have - encrypted [ MAC [ compressed [ plain ] ] ] rr->length
1405 * bytes of encrypted compressed stuff.
1408 /* check is not needed I believe */
1409 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
1410 al = SSL_AD_RECORD_OVERFLOW;
1411 SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
1415 /* decrypt in place in 'rr->input' */
1416 rr->data = rr->input;
1417 rr->orig_len = rr->length;
1419 if (SSL_READ_ETM(s) && s->read_hash) {
1421 mac_size = EVP_MD_CTX_size(s->read_hash);
1422 OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
1423 if (rr->orig_len < mac_size) {
1424 al = SSL_AD_DECODE_ERROR;
1425 SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_LENGTH_TOO_SHORT);
1428 rr->length -= mac_size;
1429 mac = rr->data + rr->length;
1430 i = s->method->ssl3_enc->mac(s, rr, md, 0 /* not send */ );
1431 if (i == 0 || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0) {
1432 al = SSL_AD_BAD_RECORD_MAC;
1433 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,
1434 SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
1439 enc_err = s->method->ssl3_enc->enc(s, rr, 1, 0);
1442 * 0: (in non-constant time) if the record is publically invalid.
1443 * 1: if the padding is valid
1444 * -1: if the padding is invalid
1447 /* For DTLS we simply ignore bad packets. */
1449 RECORD_LAYER_reset_packet_length(&s->rlayer);
1453 printf("dec %ld\n", rr->length);
1456 for (z = 0; z < rr->length; z++)
1457 printf("%02X%c", rr->data[z], ((z + 1) % 16) ? ' ' : '\n');
1462 /* r->length is now the compressed data plus mac */
1463 if ((sess != NULL) && !SSL_READ_ETM(s) &&
1464 (s->enc_read_ctx != NULL) && (EVP_MD_CTX_md(s->read_hash) != NULL)) {
1465 /* s->read_hash != NULL => mac_size != -1 */
1466 unsigned char *mac = NULL;
1467 unsigned char mac_tmp[EVP_MAX_MD_SIZE];
1469 /* TODO(size_t): Convert this to do size_t properly */
1470 imac_size = EVP_MD_CTX_size(s->read_hash);
1471 if (imac_size < 0) {
1472 al = SSL_AD_INTERNAL_ERROR;
1473 SSLerr(SSL_F_DTLS1_PROCESS_RECORD, ERR_LIB_EVP);
1476 mac_size = (size_t)imac_size;
1477 OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
1480 * orig_len is the length of the record before any padding was
1481 * removed. This is public information, as is the MAC in use,
1482 * therefore we can safely process the record in a different amount
1483 * of time if it's too short to possibly contain a MAC.
1485 if (rr->orig_len < mac_size ||
1486 /* CBC records must have a padding length byte too. */
1487 (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
1488 rr->orig_len < mac_size + 1)) {
1489 al = SSL_AD_DECODE_ERROR;
1490 SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_LENGTH_TOO_SHORT);
1494 if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
1496 * We update the length so that the TLS header bytes can be
1497 * constructed correctly but we need to extract the MAC in
1498 * constant time from within the record, without leaking the
1499 * contents of the padding bytes.
1502 ssl3_cbc_copy_mac(mac_tmp, rr, mac_size);
1503 rr->length -= mac_size;
1506 * In this case there's no padding, so |rec->orig_len| equals
1507 * |rec->length| and we checked that there's enough bytes for
1510 rr->length -= mac_size;
1511 mac = &rr->data[rr->length];
1514 i = s->method->ssl3_enc->mac(s, rr, md, 0 /* not send */ );
1515 if (i == 0 || mac == NULL
1516 || CRYPTO_memcmp(md, mac, mac_size) != 0)
1518 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + mac_size)
1523 /* decryption failed, silently discard message */
1525 RECORD_LAYER_reset_packet_length(&s->rlayer);
1529 /* r->length is now just compressed */
1530 if (s->expand != NULL) {
1531 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH) {
1532 al = SSL_AD_RECORD_OVERFLOW;
1533 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,
1534 SSL_R_COMPRESSED_LENGTH_TOO_LONG);
1537 if (!ssl3_do_uncompress(s, rr)) {
1538 al = SSL_AD_DECOMPRESSION_FAILURE;
1539 SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_BAD_DECOMPRESSION);
1544 if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH) {
1545 al = SSL_AD_RECORD_OVERFLOW;
1546 SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
1552 * So at this point the following is true
1553 * ssl->s3->rrec.type is the type of record
1554 * ssl->s3->rrec.length == number of bytes in record
1555 * ssl->s3->rrec.off == offset to first valid byte
1556 * ssl->s3->rrec.data == where to take bytes from, increment
1560 /* we have pulled in a full packet so zero things */
1561 RECORD_LAYER_reset_packet_length(&s->rlayer);
1563 /* Mark receipt of record. */
1564 dtls1_record_bitmap_update(s, bitmap);
1569 ssl3_send_alert(s, SSL3_AL_FATAL, al);
1575 * retrieve a buffered record that belongs to the current epoch, ie,
1578 #define dtls1_get_processed_record(s) \
1579 dtls1_retrieve_buffered_record((s), \
1580 &(DTLS_RECORD_LAYER_get_processed_rcds(&s->rlayer)))
1583 * Call this to get a new input record.
1584 * It will return <= 0 if more data is needed, normally due to an error
1585 * or non-blocking IO.
1586 * When it finishes, one packet has been decoded and can be found in
1587 * ssl->s3->rrec.type - is the type of record
1588 * ssl->s3->rrec.data, - data
1589 * ssl->s3->rrec.length, - number of bytes
1591 /* used only by dtls1_read_bytes */
1592 int dtls1_get_record(SSL *s)
1594 int ssl_major, ssl_minor;
1598 unsigned char *p = NULL;
1599 unsigned short version;
1600 DTLS1_BITMAP *bitmap;
1601 unsigned int is_next_epoch;
1603 rr = RECORD_LAYER_get_rrec(&s->rlayer);
1607 * The epoch may have changed. If so, process all the pending records.
1608 * This is a non-blocking operation.
1610 if (!dtls1_process_buffered_records(s))
1613 /* if we're renegotiating, then there may be buffered records */
1614 if (dtls1_get_processed_record(s))
1617 /* get something from the wire */
1619 /* check if we have the header */
1620 if ((RECORD_LAYER_get_rstate(&s->rlayer) != SSL_ST_READ_BODY) ||
1621 (RECORD_LAYER_get_packet_length(&s->rlayer) < DTLS1_RT_HEADER_LENGTH)) {
1622 rret = ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH,
1623 SSL3_BUFFER_get_len(&s->rlayer.rbuf), 0, 1, &n);
1624 /* read timeout is handled by dtls1_read_bytes */
1626 return rret; /* error or non-blocking */
1628 /* this packet contained a partial record, dump it */
1629 if (RECORD_LAYER_get_packet_length(&s->rlayer) !=
1630 DTLS1_RT_HEADER_LENGTH) {
1631 RECORD_LAYER_reset_packet_length(&s->rlayer);
1635 RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_BODY);
1637 p = RECORD_LAYER_get_packet(&s->rlayer);
1639 if (s->msg_callback)
1640 s->msg_callback(0, 0, SSL3_RT_HEADER, p, DTLS1_RT_HEADER_LENGTH,
1641 s, s->msg_callback_arg);
1643 /* Pull apart the header into the DTLS1_RECORD */
1647 version = (ssl_major << 8) | ssl_minor;
1649 /* sequence number is 64 bits, with top 2 bytes = epoch */
1652 memcpy(&(RECORD_LAYER_get_read_sequence(&s->rlayer)[2]), p, 6);
1657 /* Lets check version */
1658 if (!s->first_packet) {
1659 if (version != s->version) {
1660 /* unexpected version, silently discard */
1662 RECORD_LAYER_reset_packet_length(&s->rlayer);
1667 if ((version & 0xff00) != (s->version & 0xff00)) {
1668 /* wrong version, silently discard record */
1670 RECORD_LAYER_reset_packet_length(&s->rlayer);
1674 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
1675 /* record too long, silently discard it */
1677 RECORD_LAYER_reset_packet_length(&s->rlayer);
1681 /* now s->rlayer.rstate == SSL_ST_READ_BODY */
1684 /* s->rlayer.rstate == SSL_ST_READ_BODY, get and decode the data */
1687 RECORD_LAYER_get_packet_length(&s->rlayer) - DTLS1_RT_HEADER_LENGTH) {
1688 /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
1690 rret = ssl3_read_n(s, more, more, 1, 1, &n);
1691 /* this packet contained a partial record, dump it */
1692 if (rret <= 0 || n != more) {
1694 RECORD_LAYER_reset_packet_length(&s->rlayer);
1699 * now n == rr->length, and s->packet_length ==
1700 * DTLS1_RT_HEADER_LENGTH + rr->length
1703 /* set state for later operations */
1704 RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_HEADER);
1706 /* match epochs. NULL means the packet is dropped on the floor */
1707 bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
1708 if (bitmap == NULL) {
1710 RECORD_LAYER_reset_packet_length(&s->rlayer); /* dump this record */
1711 goto again; /* get another record */
1713 #ifndef OPENSSL_NO_SCTP
1714 /* Only do replay check if no SCTP bio */
1715 if (!BIO_dgram_is_sctp(SSL_get_rbio(s))) {
1717 /* Check whether this is a repeat, or aged record. */
1719 * TODO: Does it make sense to have replay protection in epoch 0 where
1720 * we have no integrity negotiated yet?
1722 if (!dtls1_record_replay_check(s, bitmap)) {
1724 RECORD_LAYER_reset_packet_length(&s->rlayer); /* dump this record */
1725 goto again; /* get another record */
1727 #ifndef OPENSSL_NO_SCTP
1731 /* just read a 0 length packet */
1732 if (rr->length == 0)
1736 * If this record is from the next epoch (either HM or ALERT), and a
1737 * handshake is currently in progress, buffer it since it cannot be
1738 * processed at this time.
1740 if (is_next_epoch) {
1741 if ((SSL_in_init(s) || ossl_statem_get_in_handshake(s))) {
1742 if (dtls1_buffer_record
1743 (s, &(DTLS_RECORD_LAYER_get_unprocessed_rcds(&s->rlayer)),
1748 RECORD_LAYER_reset_packet_length(&s->rlayer);
1752 if (!dtls1_process_record(s, bitmap)) {
1754 RECORD_LAYER_reset_packet_length(&s->rlayer); /* dump this record */
1755 goto again; /* get another record */