2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
60 #include <openssl/objects.h>
61 #include <openssl/evp.h>
62 #include <openssl/hmac.h>
63 #include <openssl/ocsp.h>
66 const char tls1_version_str[]="TLSv1" OPENSSL_VERSION_PTEXT;
68 #ifndef OPENSSL_NO_TLSEXT
69 static int tls_decrypt_ticket(SSL *s, const unsigned char *tick, int ticklen,
70 const unsigned char *sess_id, int sesslen,
74 SSL3_ENC_METHOD TLSv1_enc_data={
78 tls1_generate_master_secret,
79 tls1_change_cipher_state,
80 tls1_final_finish_mac,
81 TLS1_FINISH_MAC_LENGTH,
83 TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
84 TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
88 long tls1_default_timeout(void)
90 /* 2 hours, the 24 hours mentioned in the TLSv1 spec
91 * is way too long for http, the cache would over fill */
95 IMPLEMENT_tls1_meth_func(tlsv1_base_method,
96 ssl_undefined_function,
97 ssl_undefined_function,
102 if (!ssl3_new(s)) return(0);
103 s->method->ssl_clear(s);
107 void tls1_free(SSL *s)
112 void tls1_clear(SSL *s)
115 s->version=TLS1_VERSION;
119 long tls1_ctrl(SSL *s, int cmd, long larg, char *parg)
124 long tls1_callback_ctrl(SSL *s, int cmd, void *(*fp)())
130 #ifndef OPENSSL_NO_TLSEXT
131 unsigned char *ssl_add_clienthello_tlsext(SSL *s, unsigned char *p, unsigned char *limit)
134 unsigned char *ret = p;
138 if (ret>=limit) return NULL; /* this really never occurs, but ... */
140 if (s->tlsext_hostname != NULL)
142 /* Add TLS extension servername to the Client Hello message */
143 unsigned long size_str;
146 /* check for enough space.
147 4 for the servername type and entension length
148 2 for servernamelist length
149 1 for the hostname type
150 2 for hostname length
154 if ((lenmax = limit - ret - 9) < 0
155 || (size_str = strlen(s->tlsext_hostname)) > (unsigned long)lenmax)
158 /* extension type and length */
159 s2n(TLSEXT_TYPE_server_name,ret);
162 /* length of servername list */
165 /* hostname type, length and hostname */
166 *(ret++) = (unsigned char) TLSEXT_NAMETYPE_host_name;
168 memcpy(ret, s->tlsext_hostname, size_str);
173 if (!(SSL_get_options(s) & SSL_OP_NO_TICKET))
176 if (s->session && s->session->tlsext_tick)
177 ticklen = s->session->tlsext_ticklen;
180 /* Check for enough room 2 for extension type, 2 for len
183 if (limit - ret - 4 - ticklen < 0)
185 s2n(TLSEXT_TYPE_session_ticket,ret);
189 memcpy(ret, s->session->tlsext_tick, ticklen);
194 if (s->tlsext_status_type == TLSEXT_STATUSTYPE_ocsp)
197 long extlen, idlen, itmp;
201 for (i = 0; i < sk_OCSP_RESPID_num(s->tlsext_ocsp_ids); i++)
203 id = sk_OCSP_RESPID_value(s->tlsext_ocsp_ids, i);
204 itmp = i2d_OCSP_RESPID(id, NULL);
210 if (s->tlsext_ocsp_exts)
212 extlen = i2d_X509_EXTENSIONS(s->tlsext_ocsp_exts, NULL);
219 if ((long)(limit - ret - 7 - extlen - idlen) < 0) return NULL;
220 s2n(TLSEXT_TYPE_status_request, ret);
221 if (extlen + idlen > 0xFFF0)
223 s2n(extlen + idlen + 5, ret);
224 *(ret++) = TLSEXT_STATUSTYPE_ocsp;
226 for (i = 0; i < sk_OCSP_RESPID_num(s->tlsext_ocsp_ids); i++)
228 /* save position of id len */
229 unsigned char *q = ret;
230 id = sk_OCSP_RESPID_value(s->tlsext_ocsp_ids, i);
231 /* skip over id len */
233 itmp = i2d_OCSP_RESPID(id, &ret);
239 i2d_X509_EXTENSIONS(s->tlsext_ocsp_exts, &ret);
242 if ((extdatalen = ret-p-2)== 0)
249 unsigned char *ssl_add_serverhello_tlsext(SSL *s, unsigned char *p, unsigned char *limit)
252 unsigned char *ret = p;
255 if (ret>=limit) return NULL; /* this really never occurs, but ... */
257 if (!s->hit && s->servername_done == 1 && s->session->tlsext_hostname != NULL)
259 if (limit - ret - 4 < 0) return NULL;
261 s2n(TLSEXT_TYPE_server_name,ret);
265 if (s->tlsext_ticket_expected
266 && !(SSL_get_options(s) & SSL_OP_NO_TICKET))
268 if (limit - ret - 4 < 0) return NULL;
269 s2n(TLSEXT_TYPE_session_ticket,ret);
273 if (s->tlsext_status_expected)
275 if ((long)(limit - ret - 4) < 0) return NULL;
276 s2n(TLSEXT_TYPE_status_request,ret);
280 if ((extdatalen = ret-p-2)== 0)
287 int ssl_parse_clienthello_tlsext(SSL *s, unsigned char **p, unsigned char *d, int n, int *al)
292 unsigned char *data = *p;
293 s->servername_done = 0;
294 s->tlsext_status_type = -1;
300 if (data > (d+n-len))
303 while (data <= (d+n-4))
308 if (data+size > (d+n))
311 if (s->tlsext_debug_cb)
312 s->tlsext_debug_cb(s, 0, type, data, size,
313 s->tlsext_debug_arg);
314 /* The servername extension is treated as follows:
316 - Only the hostname type is supported with a maximum length of 255.
317 - The servername is rejected if too long or if it contains zeros,
318 in which case an fatal alert is generated.
319 - The servername field is maintained together with the session cache.
320 - When a session is resumed, the servername call back invoked in order
321 to allow the application to position itself to the right context.
322 - The servername is acknowledged if it is new for a session or when
323 it is identical to a previously used for the same session.
324 Applications can control the behaviour. They can at any time
325 set a 'desirable' servername for a new SSL object. This can be the
326 case for example with HTTPS when a Host: header field is received and
327 a renegotiation is requested. In this case, a possible servername
328 presented in the new client hello is only acknowledged if it matches
329 the value of the Host: field.
330 - Applications must use SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
331 if they provide for changing an explicit servername context for the session,
332 i.e. when the session has been established with a servername extension.
333 - On session reconnect, the servername extension may be absent.
337 if (type == TLSEXT_TYPE_server_name)
339 unsigned char *sdata;
345 *al = SSL_AD_DECODE_ERROR;
352 *al = SSL_AD_DECODE_ERROR;
359 servname_type = *(sdata++);
365 *al = SSL_AD_DECODE_ERROR;
368 if (s->servername_done == 0)
369 switch (servname_type)
371 case TLSEXT_NAMETYPE_host_name:
374 if(s->session->tlsext_hostname)
376 *al = SSL_AD_DECODE_ERROR;
379 if (len > TLSEXT_MAXLEN_host_name)
381 *al = TLS1_AD_UNRECOGNIZED_NAME;
384 if ((s->session->tlsext_hostname = OPENSSL_malloc(len+1)) == NULL)
386 *al = TLS1_AD_INTERNAL_ERROR;
389 memcpy(s->session->tlsext_hostname, sdata, len);
390 s->session->tlsext_hostname[len]='\0';
391 if (strlen(s->session->tlsext_hostname) != len) {
392 OPENSSL_free(s->session->tlsext_hostname);
393 s->session->tlsext_hostname = NULL;
394 *al = TLS1_AD_UNRECOGNIZED_NAME;
397 s->servername_done = 1;
401 s->servername_done = s->session->tlsext_hostname
402 && strlen(s->session->tlsext_hostname) == len
403 && strncmp(s->session->tlsext_hostname, (char *)sdata, len) == 0;
415 *al = SSL_AD_DECODE_ERROR;
420 else if (type == TLSEXT_TYPE_status_request
421 && s->ctx->tlsext_status_cb)
426 *al = SSL_AD_DECODE_ERROR;
430 s->tlsext_status_type = *data++;
432 if (s->tlsext_status_type == TLSEXT_STATUSTYPE_ocsp)
434 const unsigned char *sdata;
436 /* Read in responder_id_list */
441 *al = SSL_AD_DECODE_ERROR;
450 *al = SSL_AD_DECODE_ERROR;
457 *al = SSL_AD_DECODE_ERROR;
462 id = d2i_OCSP_RESPID(NULL,
466 *al = SSL_AD_DECODE_ERROR;
471 OCSP_RESPID_free(id);
472 *al = SSL_AD_DECODE_ERROR;
475 if (!s->tlsext_ocsp_ids
476 && !(s->tlsext_ocsp_ids =
477 sk_OCSP_RESPID_new_null()))
479 OCSP_RESPID_free(id);
480 *al = SSL_AD_INTERNAL_ERROR;
483 if (!sk_OCSP_RESPID_push(
484 s->tlsext_ocsp_ids, id))
486 OCSP_RESPID_free(id);
487 *al = SSL_AD_INTERNAL_ERROR;
492 /* Read in request_extensions */
497 *al = SSL_AD_DECODE_ERROR;
503 s->tlsext_ocsp_exts =
504 d2i_X509_EXTENSIONS(NULL,
506 if (!s->tlsext_ocsp_exts
507 || (data + dsize != sdata))
509 *al = SSL_AD_DECODE_ERROR;
514 /* We don't know what to do with any other type
518 s->tlsext_status_type = -1;
520 /* session ticket processed earlier */
529 int ssl_parse_serverhello_tlsext(SSL *s, unsigned char **p, unsigned char *d, int n, int *al)
534 unsigned char *data = *p;
536 int tlsext_servername = 0;
543 while(data <= (d+n-4))
548 if (data+size > (d+n))
551 if (s->tlsext_debug_cb)
552 s->tlsext_debug_cb(s, 1, type, data, size,
553 s->tlsext_debug_arg);
555 if (type == TLSEXT_TYPE_server_name)
557 if (s->tlsext_hostname == NULL || size > 0)
559 *al = TLS1_AD_UNRECOGNIZED_NAME;
562 tlsext_servername = 1;
564 else if (type == TLSEXT_TYPE_session_ticket)
566 if ((SSL_get_options(s) & SSL_OP_NO_TICKET)
569 *al = TLS1_AD_UNSUPPORTED_EXTENSION;
572 s->tlsext_ticket_expected = 1;
574 else if (type == TLSEXT_TYPE_status_request)
576 /* MUST be empty and only sent if we've requested
577 * a status request message.
579 if ((s->tlsext_status_type == -1) || (size > 0))
581 *al = TLS1_AD_UNSUPPORTED_EXTENSION;
584 /* Set flag to expect CertificateStatus message */
585 s->tlsext_status_expected = 1;
593 *al = SSL_AD_DECODE_ERROR;
597 if (!s->hit && tlsext_servername == 1)
599 if (s->tlsext_hostname)
601 if (s->session->tlsext_hostname == NULL)
603 s->session->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
604 if (!s->session->tlsext_hostname)
606 *al = SSL_AD_UNRECOGNIZED_NAME;
612 *al = SSL_AD_DECODE_ERROR;
622 int ssl_check_clienthello_tlsext(SSL *s)
624 int ret=SSL_TLSEXT_ERR_NOACK;
625 int al = SSL_AD_UNRECOGNIZED_NAME;
627 if (s->ctx != NULL && s->ctx->tlsext_servername_callback != 0)
628 ret = s->ctx->tlsext_servername_callback(s, &al, s->ctx->tlsext_servername_arg);
629 else if (s->initial_ctx != NULL && s->initial_ctx->tlsext_servername_callback != 0)
630 ret = s->initial_ctx->tlsext_servername_callback(s, &al, s->initial_ctx->tlsext_servername_arg);
632 /* If status request then ask callback what to do.
633 * Note: this must be called after servername callbacks in case
634 * the certificate has changed.
636 if ((s->tlsext_status_type != -1) && s->ctx->tlsext_status_cb)
639 r = s->ctx->tlsext_status_cb(s, s->ctx->tlsext_status_arg);
642 /* We don't want to send a status request response */
643 case SSL_TLSEXT_ERR_NOACK:
644 s->tlsext_status_expected = 0;
646 /* status request response should be sent */
647 case SSL_TLSEXT_ERR_OK:
648 if (s->tlsext_ocsp_resp)
649 s->tlsext_status_expected = 1;
651 s->tlsext_status_expected = 0;
653 /* something bad happened */
654 case SSL_TLSEXT_ERR_ALERT_FATAL:
655 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
656 al = SSL_AD_INTERNAL_ERROR;
661 s->tlsext_status_expected = 0;
665 case SSL_TLSEXT_ERR_ALERT_FATAL:
666 ssl3_send_alert(s,SSL3_AL_FATAL,al);
669 case SSL_TLSEXT_ERR_ALERT_WARNING:
670 ssl3_send_alert(s,SSL3_AL_WARNING,al);
673 case SSL_TLSEXT_ERR_NOACK:
674 s->servername_done=0;
680 int ssl_check_serverhello_tlsext(SSL *s)
682 int ret=SSL_TLSEXT_ERR_NOACK;
683 int al = SSL_AD_UNRECOGNIZED_NAME;
685 if (s->ctx != NULL && s->ctx->tlsext_servername_callback != 0)
686 ret = s->ctx->tlsext_servername_callback(s, &al, s->ctx->tlsext_servername_arg);
687 else if (s->initial_ctx != NULL && s->initial_ctx->tlsext_servername_callback != 0)
688 ret = s->initial_ctx->tlsext_servername_callback(s, &al, s->initial_ctx->tlsext_servername_arg);
690 /* If we've requested certificate status and we wont get one
693 if ((s->tlsext_status_type != -1) && !(s->tlsext_status_expected)
694 && s->ctx->tlsext_status_cb)
697 /* Set resp to NULL, resplen to -1 so callback knows
698 * there is no response.
700 if (s->tlsext_ocsp_resp)
702 OPENSSL_free(s->tlsext_ocsp_resp);
703 s->tlsext_ocsp_resp = NULL;
705 s->tlsext_ocsp_resplen = -1;
706 r = s->ctx->tlsext_status_cb(s, s->ctx->tlsext_status_arg);
709 al = SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE;
710 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
714 al = SSL_AD_INTERNAL_ERROR;
715 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
721 case SSL_TLSEXT_ERR_ALERT_FATAL:
722 ssl3_send_alert(s,SSL3_AL_FATAL,al);
725 case SSL_TLSEXT_ERR_ALERT_WARNING:
726 ssl3_send_alert(s,SSL3_AL_WARNING,al);
729 case SSL_TLSEXT_ERR_NOACK:
730 s->servername_done=0;
736 /* Since the server cache lookup is done early on in the processing of client
737 * hello and other operations depend on the result we need to handle any TLS
738 * session ticket extension at the same time.
741 int tls1_process_ticket(SSL *s, unsigned char *session_id, int len,
742 const unsigned char *limit, SSL_SESSION **ret)
744 /* Point after session ID in client hello */
745 const unsigned char *p = session_id + len;
748 /* If tickets disabled behave as if no ticket present
749 * to permit stateful resumption.
751 if (SSL_get_options(s) & SSL_OP_NO_TICKET)
754 if ((s->version <= SSL3_VERSION) || !limit)
758 /* Skip past cipher list */
763 /* Skip past compression algorithm list */
768 /* Now at start of extensions */
769 if ((p + 2) >= limit)
772 while ((p + 4) <= limit)
774 unsigned short type, size;
777 if (p + size > limit)
779 if (type == TLSEXT_TYPE_session_ticket)
781 /* If zero length note client will accept a ticket
782 * and indicate cache miss to trigger full handshake
786 s->tlsext_ticket_expected = 1;
787 return 0; /* Cache miss */
789 return tls_decrypt_ticket(s, p, size, session_id, len,
797 static int tls_decrypt_ticket(SSL *s, const unsigned char *etick, int eticklen,
798 const unsigned char *sess_id, int sesslen,
803 const unsigned char *p;
804 int slen, mlen, renew_ticket = 0;
805 unsigned char tick_hmac[EVP_MAX_MD_SIZE];
808 /* Need at least keyname + iv + some encrypted data */
811 /* Initialize session ticket encryption and HMAC contexts */
812 HMAC_CTX_init(&hctx);
813 EVP_CIPHER_CTX_init(&ctx);
814 if (s->ctx->tlsext_ticket_key_cb)
816 unsigned char *nctick = (unsigned char *)etick;
817 int rv = s->ctx->tlsext_ticket_key_cb(s, nctick, nctick + 16,
828 /* Check key name matches */
829 if (memcmp(etick, s->ctx->tlsext_tick_key_name, 16))
831 HMAC_Init_ex(&hctx, s->ctx->tlsext_tick_hmac_key, 16,
832 tlsext_tick_md(), NULL);
833 EVP_DecryptInit_ex(&ctx, EVP_aes_128_cbc(), NULL,
834 s->ctx->tlsext_tick_aes_key, etick + 16);
836 /* Attempt to process session ticket, first conduct sanity and
837 * integrity checks on ticket.
839 mlen = HMAC_size(&hctx);
841 /* Check HMAC of encrypted ticket */
842 HMAC_Update(&hctx, etick, eticklen);
843 HMAC_Final(&hctx, tick_hmac, NULL);
844 HMAC_CTX_cleanup(&hctx);
845 if (memcmp(tick_hmac, etick + eticklen, mlen))
847 /* Attempt to decrypt session data */
848 /* Move p after IV to start of encrypted ticket, update length */
849 p = etick + 16 + EVP_CIPHER_CTX_iv_length(&ctx);
850 eticklen -= 16 + EVP_CIPHER_CTX_iv_length(&ctx);
851 sdec = OPENSSL_malloc(eticklen);
854 EVP_CIPHER_CTX_cleanup(&ctx);
857 EVP_DecryptUpdate(&ctx, sdec, &slen, p, eticklen);
858 if (EVP_DecryptFinal(&ctx, sdec + slen, &mlen) <= 0)
861 EVP_CIPHER_CTX_cleanup(&ctx);
864 sess = d2i_SSL_SESSION(NULL, &p, slen);
868 /* The session ID if non-empty is used by some clients to
869 * detect that the ticket has been accepted. So we copy it to
870 * the session structure. If it is empty set length to zero
871 * as required by standard.
874 memcpy(sess->session_id, sess_id, sesslen);
875 sess->session_id_length = sesslen;
877 s->tlsext_ticket_expected = renew_ticket;
880 /* If session decrypt failure indicate a cache miss and set state to
884 s->tlsext_ticket_expected = 1;