Provide a function to send a KeyUpdate message
[openssl.git] / ssl / ssl_lib.c
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 /* ====================================================================
11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12  * ECC cipher suite support in OpenSSL originally developed by
13  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
14  */
15 /* ====================================================================
16  * Copyright 2005 Nokia. All rights reserved.
17  *
18  * The portions of the attached software ("Contribution") is developed by
19  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
20  * license.
21  *
22  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24  * support (see RFC 4279) to OpenSSL.
25  *
26  * No patent licenses or other rights except those expressly stated in
27  * the OpenSSL open source license shall be deemed granted or received
28  * expressly, by implication, estoppel, or otherwise.
29  *
30  * No assurances are provided by Nokia that the Contribution does not
31  * infringe the patent or other intellectual property rights of any third
32  * party or that the license provides you with all the necessary rights
33  * to make use of the Contribution.
34  *
35  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
39  * OTHERWISE.
40  */
41
42 #include <assert.h>
43 #include <stdio.h>
44 #include "ssl_locl.h"
45 #include <openssl/objects.h>
46 #include <openssl/lhash.h>
47 #include <openssl/x509v3.h>
48 #include <openssl/rand.h>
49 #include <openssl/ocsp.h>
50 #include <openssl/dh.h>
51 #include <openssl/engine.h>
52 #include <openssl/async.h>
53 #include <openssl/ct.h>
54
55 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
56
57 SSL3_ENC_METHOD ssl3_undef_enc_method = {
58     /*
59      * evil casts, but these functions are only called if there's a library
60      * bug
61      */
62     (int (*)(SSL *, SSL3_RECORD *, size_t, int))ssl_undefined_function,
63     (int (*)(SSL *, SSL3_RECORD *, unsigned char *, int))ssl_undefined_function,
64     ssl_undefined_function,
65     (int (*)(SSL *, unsigned char *, unsigned char *, size_t, size_t *))
66         ssl_undefined_function,
67     (int (*)(SSL *, int))ssl_undefined_function,
68     (size_t (*)(SSL *, const char *, size_t, unsigned char *))
69         ssl_undefined_function,
70     NULL,                       /* client_finished_label */
71     0,                          /* client_finished_label_len */
72     NULL,                       /* server_finished_label */
73     0,                          /* server_finished_label_len */
74     (int (*)(int))ssl_undefined_function,
75     (int (*)(SSL *, unsigned char *, size_t, const char *,
76              size_t, const unsigned char *, size_t,
77              int use_context))ssl_undefined_function,
78 };
79
80 struct ssl_async_args {
81     SSL *s;
82     void *buf;
83     size_t num;
84     enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
85     union {
86         int (*func_read) (SSL *, void *, size_t, size_t *);
87         int (*func_write) (SSL *, const void *, size_t, size_t *);
88         int (*func_other) (SSL *);
89     } f;
90 };
91
92 static const struct {
93     uint8_t mtype;
94     uint8_t ord;
95     int nid;
96 } dane_mds[] = {
97     {
98         DANETLS_MATCHING_FULL, 0, NID_undef
99     },
100     {
101         DANETLS_MATCHING_2256, 1, NID_sha256
102     },
103     {
104         DANETLS_MATCHING_2512, 2, NID_sha512
105     },
106 };
107
108 static int dane_ctx_enable(struct dane_ctx_st *dctx)
109 {
110     const EVP_MD **mdevp;
111     uint8_t *mdord;
112     uint8_t mdmax = DANETLS_MATCHING_LAST;
113     int n = ((int)mdmax) + 1;   /* int to handle PrivMatch(255) */
114     size_t i;
115
116     if (dctx->mdevp != NULL)
117         return 1;
118
119     mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
120     mdord = OPENSSL_zalloc(n * sizeof(*mdord));
121
122     if (mdord == NULL || mdevp == NULL) {
123         OPENSSL_free(mdord);
124         OPENSSL_free(mdevp);
125         SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
126         return 0;
127     }
128
129     /* Install default entries */
130     for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
131         const EVP_MD *md;
132
133         if (dane_mds[i].nid == NID_undef ||
134             (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
135             continue;
136         mdevp[dane_mds[i].mtype] = md;
137         mdord[dane_mds[i].mtype] = dane_mds[i].ord;
138     }
139
140     dctx->mdevp = mdevp;
141     dctx->mdord = mdord;
142     dctx->mdmax = mdmax;
143
144     return 1;
145 }
146
147 static void dane_ctx_final(struct dane_ctx_st *dctx)
148 {
149     OPENSSL_free(dctx->mdevp);
150     dctx->mdevp = NULL;
151
152     OPENSSL_free(dctx->mdord);
153     dctx->mdord = NULL;
154     dctx->mdmax = 0;
155 }
156
157 static void tlsa_free(danetls_record *t)
158 {
159     if (t == NULL)
160         return;
161     OPENSSL_free(t->data);
162     EVP_PKEY_free(t->spki);
163     OPENSSL_free(t);
164 }
165
166 static void dane_final(SSL_DANE *dane)
167 {
168     sk_danetls_record_pop_free(dane->trecs, tlsa_free);
169     dane->trecs = NULL;
170
171     sk_X509_pop_free(dane->certs, X509_free);
172     dane->certs = NULL;
173
174     X509_free(dane->mcert);
175     dane->mcert = NULL;
176     dane->mtlsa = NULL;
177     dane->mdpth = -1;
178     dane->pdpth = -1;
179 }
180
181 /*
182  * dane_copy - Copy dane configuration, sans verification state.
183  */
184 static int ssl_dane_dup(SSL *to, SSL *from)
185 {
186     int num;
187     int i;
188
189     if (!DANETLS_ENABLED(&from->dane))
190         return 1;
191
192     dane_final(&to->dane);
193     to->dane.flags = from->dane.flags;
194     to->dane.dctx = &to->ctx->dane;
195     to->dane.trecs = sk_danetls_record_new_null();
196
197     if (to->dane.trecs == NULL) {
198         SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
199         return 0;
200     }
201
202     num = sk_danetls_record_num(from->dane.trecs);
203     for (i = 0; i < num; ++i) {
204         danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
205
206         if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
207                               t->data, t->dlen) <= 0)
208             return 0;
209     }
210     return 1;
211 }
212
213 static int dane_mtype_set(struct dane_ctx_st *dctx,
214                           const EVP_MD *md, uint8_t mtype, uint8_t ord)
215 {
216     int i;
217
218     if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
219         SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
220         return 0;
221     }
222
223     if (mtype > dctx->mdmax) {
224         const EVP_MD **mdevp;
225         uint8_t *mdord;
226         int n = ((int)mtype) + 1;
227
228         mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
229         if (mdevp == NULL) {
230             SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
231             return -1;
232         }
233         dctx->mdevp = mdevp;
234
235         mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
236         if (mdord == NULL) {
237             SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
238             return -1;
239         }
240         dctx->mdord = mdord;
241
242         /* Zero-fill any gaps */
243         for (i = dctx->mdmax + 1; i < mtype; ++i) {
244             mdevp[i] = NULL;
245             mdord[i] = 0;
246         }
247
248         dctx->mdmax = mtype;
249     }
250
251     dctx->mdevp[mtype] = md;
252     /* Coerce ordinal of disabled matching types to 0 */
253     dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
254
255     return 1;
256 }
257
258 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
259 {
260     if (mtype > dane->dctx->mdmax)
261         return NULL;
262     return dane->dctx->mdevp[mtype];
263 }
264
265 static int dane_tlsa_add(SSL_DANE *dane,
266                          uint8_t usage,
267                          uint8_t selector,
268                          uint8_t mtype, unsigned char *data, size_t dlen)
269 {
270     danetls_record *t;
271     const EVP_MD *md = NULL;
272     int ilen = (int)dlen;
273     int i;
274     int num;
275
276     if (dane->trecs == NULL) {
277         SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
278         return -1;
279     }
280
281     if (ilen < 0 || dlen != (size_t)ilen) {
282         SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
283         return 0;
284     }
285
286     if (usage > DANETLS_USAGE_LAST) {
287         SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
288         return 0;
289     }
290
291     if (selector > DANETLS_SELECTOR_LAST) {
292         SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
293         return 0;
294     }
295
296     if (mtype != DANETLS_MATCHING_FULL) {
297         md = tlsa_md_get(dane, mtype);
298         if (md == NULL) {
299             SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
300             return 0;
301         }
302     }
303
304     if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
305         SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
306         return 0;
307     }
308     if (!data) {
309         SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
310         return 0;
311     }
312
313     if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
314         SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
315         return -1;
316     }
317
318     t->usage = usage;
319     t->selector = selector;
320     t->mtype = mtype;
321     t->data = OPENSSL_malloc(dlen);
322     if (t->data == NULL) {
323         tlsa_free(t);
324         SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
325         return -1;
326     }
327     memcpy(t->data, data, dlen);
328     t->dlen = dlen;
329
330     /* Validate and cache full certificate or public key */
331     if (mtype == DANETLS_MATCHING_FULL) {
332         const unsigned char *p = data;
333         X509 *cert = NULL;
334         EVP_PKEY *pkey = NULL;
335
336         switch (selector) {
337         case DANETLS_SELECTOR_CERT:
338             if (!d2i_X509(&cert, &p, ilen) || p < data ||
339                 dlen != (size_t)(p - data)) {
340                 tlsa_free(t);
341                 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
342                 return 0;
343             }
344             if (X509_get0_pubkey(cert) == NULL) {
345                 tlsa_free(t);
346                 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
347                 return 0;
348             }
349
350             if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
351                 X509_free(cert);
352                 break;
353             }
354
355             /*
356              * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
357              * records that contain full certificates of trust-anchors that are
358              * not present in the wire chain.  For usage PKIX-TA(0), we augment
359              * the chain with untrusted Full(0) certificates from DNS, in case
360              * they are missing from the chain.
361              */
362             if ((dane->certs == NULL &&
363                  (dane->certs = sk_X509_new_null()) == NULL) ||
364                 !sk_X509_push(dane->certs, cert)) {
365                 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
366                 X509_free(cert);
367                 tlsa_free(t);
368                 return -1;
369             }
370             break;
371
372         case DANETLS_SELECTOR_SPKI:
373             if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
374                 dlen != (size_t)(p - data)) {
375                 tlsa_free(t);
376                 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
377                 return 0;
378             }
379
380             /*
381              * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
382              * records that contain full bare keys of trust-anchors that are
383              * not present in the wire chain.
384              */
385             if (usage == DANETLS_USAGE_DANE_TA)
386                 t->spki = pkey;
387             else
388                 EVP_PKEY_free(pkey);
389             break;
390         }
391     }
392
393     /*-
394      * Find the right insertion point for the new record.
395      *
396      * See crypto/x509/x509_vfy.c.  We sort DANE-EE(3) records first, so that
397      * they can be processed first, as they require no chain building, and no
398      * expiration or hostname checks.  Because DANE-EE(3) is numerically
399      * largest, this is accomplished via descending sort by "usage".
400      *
401      * We also sort in descending order by matching ordinal to simplify
402      * the implementation of digest agility in the verification code.
403      *
404      * The choice of order for the selector is not significant, so we
405      * use the same descending order for consistency.
406      */
407     num = sk_danetls_record_num(dane->trecs);
408     for (i = 0; i < num; ++i) {
409         danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
410
411         if (rec->usage > usage)
412             continue;
413         if (rec->usage < usage)
414             break;
415         if (rec->selector > selector)
416             continue;
417         if (rec->selector < selector)
418             break;
419         if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
420             continue;
421         break;
422     }
423
424     if (!sk_danetls_record_insert(dane->trecs, t, i)) {
425         tlsa_free(t);
426         SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
427         return -1;
428     }
429     dane->umask |= DANETLS_USAGE_BIT(usage);
430
431     return 1;
432 }
433
434 static void clear_ciphers(SSL *s)
435 {
436     /* clear the current cipher */
437     ssl_clear_cipher_ctx(s);
438     ssl_clear_hash_ctx(&s->read_hash);
439     ssl_clear_hash_ctx(&s->write_hash);
440 }
441
442 int SSL_clear(SSL *s)
443 {
444     if (s->method == NULL) {
445         SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
446         return (0);
447     }
448
449     if (ssl_clear_bad_session(s)) {
450         SSL_SESSION_free(s->session);
451         s->session = NULL;
452     }
453
454     s->error = 0;
455     s->hit = 0;
456     s->shutdown = 0;
457
458     if (s->renegotiate) {
459         SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
460         return 0;
461     }
462
463     ossl_statem_clear(s);
464
465     s->version = s->method->version;
466     s->client_version = s->version;
467     s->rwstate = SSL_NOTHING;
468
469     BUF_MEM_free(s->init_buf);
470     s->init_buf = NULL;
471     clear_ciphers(s);
472     s->first_packet = 0;
473
474     s->key_update = SSL_KEY_UPDATE_NONE;
475
476     /* Reset DANE verification result state */
477     s->dane.mdpth = -1;
478     s->dane.pdpth = -1;
479     X509_free(s->dane.mcert);
480     s->dane.mcert = NULL;
481     s->dane.mtlsa = NULL;
482
483     /* Clear the verification result peername */
484     X509_VERIFY_PARAM_move_peername(s->param, NULL);
485
486     /*
487      * Check to see if we were changed into a different method, if so, revert
488      * back if we are not doing session-id reuse.
489      */
490     if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
491         && (s->method != s->ctx->method)) {
492         s->method->ssl_free(s);
493         s->method = s->ctx->method;
494         if (!s->method->ssl_new(s))
495             return (0);
496     } else
497         s->method->ssl_clear(s);
498
499     RECORD_LAYER_clear(&s->rlayer);
500
501     return (1);
502 }
503
504 /** Used to change an SSL_CTXs default SSL method type */
505 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
506 {
507     STACK_OF(SSL_CIPHER) *sk;
508
509     ctx->method = meth;
510
511     sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
512                                 &(ctx->cipher_list_by_id),
513                                 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
514     if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
515         SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
516         return (0);
517     }
518     return (1);
519 }
520
521 SSL *SSL_new(SSL_CTX *ctx)
522 {
523     SSL *s;
524
525     if (ctx == NULL) {
526         SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
527         return (NULL);
528     }
529     if (ctx->method == NULL) {
530         SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
531         return (NULL);
532     }
533
534     s = OPENSSL_zalloc(sizeof(*s));
535     if (s == NULL)
536         goto err;
537
538     s->lock = CRYPTO_THREAD_lock_new();
539     if (s->lock == NULL) {
540         SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
541         OPENSSL_free(s);
542         return NULL;
543     }
544
545     RECORD_LAYER_init(&s->rlayer, s);
546
547     s->options = ctx->options;
548     s->dane.flags = ctx->dane.flags;
549     s->min_proto_version = ctx->min_proto_version;
550     s->max_proto_version = ctx->max_proto_version;
551     s->mode = ctx->mode;
552     s->max_cert_list = ctx->max_cert_list;
553     s->references = 1;
554
555     /*
556      * Earlier library versions used to copy the pointer to the CERT, not
557      * its contents; only when setting new parameters for the per-SSL
558      * copy, ssl_cert_new would be called (and the direct reference to
559      * the per-SSL_CTX settings would be lost, but those still were
560      * indirectly accessed for various purposes, and for that reason they
561      * used to be known as s->ctx->default_cert). Now we don't look at the
562      * SSL_CTX's CERT after having duplicated it once.
563      */
564     s->cert = ssl_cert_dup(ctx->cert);
565     if (s->cert == NULL)
566         goto err;
567
568     RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
569     s->msg_callback = ctx->msg_callback;
570     s->msg_callback_arg = ctx->msg_callback_arg;
571     s->verify_mode = ctx->verify_mode;
572     s->not_resumable_session_cb = ctx->not_resumable_session_cb;
573     s->sid_ctx_length = ctx->sid_ctx_length;
574     OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
575     memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
576     s->verify_callback = ctx->default_verify_callback;
577     s->generate_session_id = ctx->generate_session_id;
578
579     s->param = X509_VERIFY_PARAM_new();
580     if (s->param == NULL)
581         goto err;
582     X509_VERIFY_PARAM_inherit(s->param, ctx->param);
583     s->quiet_shutdown = ctx->quiet_shutdown;
584     s->max_send_fragment = ctx->max_send_fragment;
585     s->split_send_fragment = ctx->split_send_fragment;
586     s->max_pipelines = ctx->max_pipelines;
587     if (s->max_pipelines > 1)
588         RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
589     if (ctx->default_read_buf_len > 0)
590         SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
591
592     SSL_CTX_up_ref(ctx);
593     s->ctx = ctx;
594     s->ext.debug_cb = 0;
595     s->ext.debug_arg = NULL;
596     s->ext.ticket_expected = 0;
597     s->ext.status_type = ctx->ext.status_type;
598     s->ext.status_expected = 0;
599     s->ext.ocsp.ids = NULL;
600     s->ext.ocsp.exts = NULL;
601     s->ext.ocsp.resp = NULL;
602     s->ext.ocsp.resp_len = 0;
603     SSL_CTX_up_ref(ctx);
604     s->session_ctx = ctx;
605 #ifndef OPENSSL_NO_EC
606     if (ctx->ext.ecpointformats) {
607         s->ext.ecpointformats =
608             OPENSSL_memdup(ctx->ext.ecpointformats,
609                            ctx->ext.ecpointformats_len);
610         if (!s->ext.ecpointformats)
611             goto err;
612         s->ext.ecpointformats_len =
613             ctx->ext.ecpointformats_len;
614     }
615     if (ctx->ext.supportedgroups) {
616         s->ext.supportedgroups =
617             OPENSSL_memdup(ctx->ext.supportedgroups,
618                            ctx->ext.supportedgroups_len);
619         if (!s->ext.supportedgroups)
620             goto err;
621         s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
622     }
623 #endif
624 #ifndef OPENSSL_NO_NEXTPROTONEG
625     s->ext.npn = NULL;
626 #endif
627
628     if (s->ctx->ext.alpn) {
629         s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
630         if (s->ext.alpn == NULL)
631             goto err;
632         memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
633         s->ext.alpn_len = s->ctx->ext.alpn_len;
634     }
635
636     s->verified_chain = NULL;
637     s->verify_result = X509_V_OK;
638
639     s->default_passwd_callback = ctx->default_passwd_callback;
640     s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
641
642     s->method = ctx->method;
643
644     s->key_update = SSL_KEY_UPDATE_NONE;
645
646     if (!s->method->ssl_new(s))
647         goto err;
648
649     s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
650
651     if (!SSL_clear(s))
652         goto err;
653
654     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
655         goto err;
656
657 #ifndef OPENSSL_NO_PSK
658     s->psk_client_callback = ctx->psk_client_callback;
659     s->psk_server_callback = ctx->psk_server_callback;
660 #endif
661
662     s->job = NULL;
663
664 #ifndef OPENSSL_NO_CT
665     if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
666                                         ctx->ct_validation_callback_arg))
667         goto err;
668 #endif
669
670     return s;
671  err:
672     SSL_free(s);
673     SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
674     return NULL;
675 }
676
677 int SSL_is_dtls(const SSL *s)
678 {
679     return SSL_IS_DTLS(s) ? 1 : 0;
680 }
681
682 int SSL_up_ref(SSL *s)
683 {
684     int i;
685
686     if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
687         return 0;
688
689     REF_PRINT_COUNT("SSL", s);
690     REF_ASSERT_ISNT(i < 2);
691     return ((i > 1) ? 1 : 0);
692 }
693
694 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
695                                    unsigned int sid_ctx_len)
696 {
697     if (sid_ctx_len > sizeof ctx->sid_ctx) {
698         SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
699                SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
700         return 0;
701     }
702     ctx->sid_ctx_length = sid_ctx_len;
703     memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
704
705     return 1;
706 }
707
708 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
709                                unsigned int sid_ctx_len)
710 {
711     if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
712         SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
713                SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
714         return 0;
715     }
716     ssl->sid_ctx_length = sid_ctx_len;
717     memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
718
719     return 1;
720 }
721
722 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
723 {
724     CRYPTO_THREAD_write_lock(ctx->lock);
725     ctx->generate_session_id = cb;
726     CRYPTO_THREAD_unlock(ctx->lock);
727     return 1;
728 }
729
730 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
731 {
732     CRYPTO_THREAD_write_lock(ssl->lock);
733     ssl->generate_session_id = cb;
734     CRYPTO_THREAD_unlock(ssl->lock);
735     return 1;
736 }
737
738 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
739                                 unsigned int id_len)
740 {
741     /*
742      * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
743      * we can "construct" a session to give us the desired check - ie. to
744      * find if there's a session in the hash table that would conflict with
745      * any new session built out of this id/id_len and the ssl_version in use
746      * by this SSL.
747      */
748     SSL_SESSION r, *p;
749
750     if (id_len > sizeof r.session_id)
751         return 0;
752
753     r.ssl_version = ssl->version;
754     r.session_id_length = id_len;
755     memcpy(r.session_id, id, id_len);
756
757     CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
758     p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
759     CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
760     return (p != NULL);
761 }
762
763 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
764 {
765     return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
766 }
767
768 int SSL_set_purpose(SSL *s, int purpose)
769 {
770     return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
771 }
772
773 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
774 {
775     return X509_VERIFY_PARAM_set_trust(s->param, trust);
776 }
777
778 int SSL_set_trust(SSL *s, int trust)
779 {
780     return X509_VERIFY_PARAM_set_trust(s->param, trust);
781 }
782
783 int SSL_set1_host(SSL *s, const char *hostname)
784 {
785     return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
786 }
787
788 int SSL_add1_host(SSL *s, const char *hostname)
789 {
790     return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
791 }
792
793 void SSL_set_hostflags(SSL *s, unsigned int flags)
794 {
795     X509_VERIFY_PARAM_set_hostflags(s->param, flags);
796 }
797
798 const char *SSL_get0_peername(SSL *s)
799 {
800     return X509_VERIFY_PARAM_get0_peername(s->param);
801 }
802
803 int SSL_CTX_dane_enable(SSL_CTX *ctx)
804 {
805     return dane_ctx_enable(&ctx->dane);
806 }
807
808 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
809 {
810     unsigned long orig = ctx->dane.flags;
811
812     ctx->dane.flags |= flags;
813     return orig;
814 }
815
816 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
817 {
818     unsigned long orig = ctx->dane.flags;
819
820     ctx->dane.flags &= ~flags;
821     return orig;
822 }
823
824 int SSL_dane_enable(SSL *s, const char *basedomain)
825 {
826     SSL_DANE *dane = &s->dane;
827
828     if (s->ctx->dane.mdmax == 0) {
829         SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
830         return 0;
831     }
832     if (dane->trecs != NULL) {
833         SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
834         return 0;
835     }
836
837     /*
838      * Default SNI name.  This rejects empty names, while set1_host below
839      * accepts them and disables host name checks.  To avoid side-effects with
840      * invalid input, set the SNI name first.
841      */
842     if (s->ext.hostname == NULL) {
843         if (!SSL_set_tlsext_host_name(s, basedomain)) {
844             SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
845             return -1;
846         }
847     }
848
849     /* Primary RFC6125 reference identifier */
850     if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
851         SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
852         return -1;
853     }
854
855     dane->mdpth = -1;
856     dane->pdpth = -1;
857     dane->dctx = &s->ctx->dane;
858     dane->trecs = sk_danetls_record_new_null();
859
860     if (dane->trecs == NULL) {
861         SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
862         return -1;
863     }
864     return 1;
865 }
866
867 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
868 {
869     unsigned long orig = ssl->dane.flags;
870
871     ssl->dane.flags |= flags;
872     return orig;
873 }
874
875 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
876 {
877     unsigned long orig = ssl->dane.flags;
878
879     ssl->dane.flags &= ~flags;
880     return orig;
881 }
882
883 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
884 {
885     SSL_DANE *dane = &s->dane;
886
887     if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
888         return -1;
889     if (dane->mtlsa) {
890         if (mcert)
891             *mcert = dane->mcert;
892         if (mspki)
893             *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
894     }
895     return dane->mdpth;
896 }
897
898 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
899                        uint8_t *mtype, unsigned const char **data, size_t *dlen)
900 {
901     SSL_DANE *dane = &s->dane;
902
903     if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
904         return -1;
905     if (dane->mtlsa) {
906         if (usage)
907             *usage = dane->mtlsa->usage;
908         if (selector)
909             *selector = dane->mtlsa->selector;
910         if (mtype)
911             *mtype = dane->mtlsa->mtype;
912         if (data)
913             *data = dane->mtlsa->data;
914         if (dlen)
915             *dlen = dane->mtlsa->dlen;
916     }
917     return dane->mdpth;
918 }
919
920 SSL_DANE *SSL_get0_dane(SSL *s)
921 {
922     return &s->dane;
923 }
924
925 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
926                       uint8_t mtype, unsigned char *data, size_t dlen)
927 {
928     return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
929 }
930
931 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
932                            uint8_t ord)
933 {
934     return dane_mtype_set(&ctx->dane, md, mtype, ord);
935 }
936
937 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
938 {
939     return X509_VERIFY_PARAM_set1(ctx->param, vpm);
940 }
941
942 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
943 {
944     return X509_VERIFY_PARAM_set1(ssl->param, vpm);
945 }
946
947 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
948 {
949     return ctx->param;
950 }
951
952 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
953 {
954     return ssl->param;
955 }
956
957 void SSL_certs_clear(SSL *s)
958 {
959     ssl_cert_clear_certs(s->cert);
960 }
961
962 void SSL_free(SSL *s)
963 {
964     int i;
965
966     if (s == NULL)
967         return;
968
969     CRYPTO_DOWN_REF(&s->references, &i, s->lock);
970     REF_PRINT_COUNT("SSL", s);
971     if (i > 0)
972         return;
973     REF_ASSERT_ISNT(i < 0);
974
975     X509_VERIFY_PARAM_free(s->param);
976     dane_final(&s->dane);
977     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
978
979     ssl_free_wbio_buffer(s);
980
981     BIO_free_all(s->wbio);
982     BIO_free_all(s->rbio);
983
984     BUF_MEM_free(s->init_buf);
985
986     /* add extra stuff */
987     sk_SSL_CIPHER_free(s->cipher_list);
988     sk_SSL_CIPHER_free(s->cipher_list_by_id);
989
990     /* Make the next call work :-) */
991     if (s->session != NULL) {
992         ssl_clear_bad_session(s);
993         SSL_SESSION_free(s->session);
994     }
995
996     clear_ciphers(s);
997
998     ssl_cert_free(s->cert);
999     /* Free up if allocated */
1000
1001     OPENSSL_free(s->ext.hostname);
1002     SSL_CTX_free(s->session_ctx);
1003 #ifndef OPENSSL_NO_EC
1004     OPENSSL_free(s->ext.ecpointformats);
1005     OPENSSL_free(s->ext.supportedgroups);
1006 #endif                          /* OPENSSL_NO_EC */
1007     sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1008 #ifndef OPENSSL_NO_OCSP
1009     sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1010 #endif
1011 #ifndef OPENSSL_NO_CT
1012     SCT_LIST_free(s->scts);
1013     OPENSSL_free(s->ext.scts);
1014 #endif
1015     OPENSSL_free(s->ext.ocsp.resp);
1016     OPENSSL_free(s->ext.alpn);
1017
1018     sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1019
1020     sk_X509_pop_free(s->verified_chain, X509_free);
1021
1022     if (s->method != NULL)
1023         s->method->ssl_free(s);
1024
1025     RECORD_LAYER_release(&s->rlayer);
1026
1027     SSL_CTX_free(s->ctx);
1028
1029     ASYNC_WAIT_CTX_free(s->waitctx);
1030
1031 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1032     OPENSSL_free(s->ext.npn);
1033 #endif
1034
1035 #ifndef OPENSSL_NO_SRTP
1036     sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1037 #endif
1038
1039     CRYPTO_THREAD_lock_free(s->lock);
1040
1041     OPENSSL_free(s);
1042 }
1043
1044 void SSL_set0_rbio(SSL *s, BIO *rbio)
1045 {
1046     BIO_free_all(s->rbio);
1047     s->rbio = rbio;
1048 }
1049
1050 void SSL_set0_wbio(SSL *s, BIO *wbio)
1051 {
1052     /*
1053      * If the output buffering BIO is still in place, remove it
1054      */
1055     if (s->bbio != NULL)
1056         s->wbio = BIO_pop(s->wbio);
1057
1058     BIO_free_all(s->wbio);
1059     s->wbio = wbio;
1060
1061     /* Re-attach |bbio| to the new |wbio|. */
1062     if (s->bbio != NULL)
1063         s->wbio = BIO_push(s->bbio, s->wbio);
1064 }
1065
1066 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1067 {
1068     /*
1069      * For historical reasons, this function has many different cases in
1070      * ownership handling.
1071      */
1072
1073     /* If nothing has changed, do nothing */
1074     if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1075         return;
1076
1077     /*
1078      * If the two arguments are equal then one fewer reference is granted by the
1079      * caller than we want to take
1080      */
1081     if (rbio != NULL && rbio == wbio)
1082         BIO_up_ref(rbio);
1083
1084     /*
1085      * If only the wbio is changed only adopt one reference.
1086      */
1087     if (rbio == SSL_get_rbio(s)) {
1088         SSL_set0_wbio(s, wbio);
1089         return;
1090     }
1091     /*
1092      * There is an asymmetry here for historical reasons. If only the rbio is
1093      * changed AND the rbio and wbio were originally different, then we only
1094      * adopt one reference.
1095      */
1096     if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1097         SSL_set0_rbio(s, rbio);
1098         return;
1099     }
1100
1101     /* Otherwise, adopt both references. */
1102     SSL_set0_rbio(s, rbio);
1103     SSL_set0_wbio(s, wbio);
1104 }
1105
1106 BIO *SSL_get_rbio(const SSL *s)
1107 {
1108     return s->rbio;
1109 }
1110
1111 BIO *SSL_get_wbio(const SSL *s)
1112 {
1113     if (s->bbio != NULL) {
1114         /*
1115          * If |bbio| is active, the true caller-configured BIO is its
1116          * |next_bio|.
1117          */
1118         return BIO_next(s->bbio);
1119     }
1120     return s->wbio;
1121 }
1122
1123 int SSL_get_fd(const SSL *s)
1124 {
1125     return SSL_get_rfd(s);
1126 }
1127
1128 int SSL_get_rfd(const SSL *s)
1129 {
1130     int ret = -1;
1131     BIO *b, *r;
1132
1133     b = SSL_get_rbio(s);
1134     r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1135     if (r != NULL)
1136         BIO_get_fd(r, &ret);
1137     return (ret);
1138 }
1139
1140 int SSL_get_wfd(const SSL *s)
1141 {
1142     int ret = -1;
1143     BIO *b, *r;
1144
1145     b = SSL_get_wbio(s);
1146     r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1147     if (r != NULL)
1148         BIO_get_fd(r, &ret);
1149     return (ret);
1150 }
1151
1152 #ifndef OPENSSL_NO_SOCK
1153 int SSL_set_fd(SSL *s, int fd)
1154 {
1155     int ret = 0;
1156     BIO *bio = NULL;
1157
1158     bio = BIO_new(BIO_s_socket());
1159
1160     if (bio == NULL) {
1161         SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1162         goto err;
1163     }
1164     BIO_set_fd(bio, fd, BIO_NOCLOSE);
1165     SSL_set_bio(s, bio, bio);
1166     ret = 1;
1167  err:
1168     return (ret);
1169 }
1170
1171 int SSL_set_wfd(SSL *s, int fd)
1172 {
1173     BIO *rbio = SSL_get_rbio(s);
1174
1175     if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1176         || (int)BIO_get_fd(rbio, NULL) != fd) {
1177         BIO *bio = BIO_new(BIO_s_socket());
1178
1179         if (bio == NULL) {
1180             SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1181             return 0;
1182         }
1183         BIO_set_fd(bio, fd, BIO_NOCLOSE);
1184         SSL_set0_wbio(s, bio);
1185     } else {
1186         BIO_up_ref(rbio);
1187         SSL_set0_wbio(s, rbio);
1188     }
1189     return 1;
1190 }
1191
1192 int SSL_set_rfd(SSL *s, int fd)
1193 {
1194     BIO *wbio = SSL_get_wbio(s);
1195
1196     if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1197         || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1198         BIO *bio = BIO_new(BIO_s_socket());
1199
1200         if (bio == NULL) {
1201             SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1202             return 0;
1203         }
1204         BIO_set_fd(bio, fd, BIO_NOCLOSE);
1205         SSL_set0_rbio(s, bio);
1206     } else {
1207         BIO_up_ref(wbio);
1208         SSL_set0_rbio(s, wbio);
1209     }
1210
1211     return 1;
1212 }
1213 #endif
1214
1215 /* return length of latest Finished message we sent, copy to 'buf' */
1216 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1217 {
1218     size_t ret = 0;
1219
1220     if (s->s3 != NULL) {
1221         ret = s->s3->tmp.finish_md_len;
1222         if (count > ret)
1223             count = ret;
1224         memcpy(buf, s->s3->tmp.finish_md, count);
1225     }
1226     return ret;
1227 }
1228
1229 /* return length of latest Finished message we expected, copy to 'buf' */
1230 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1231 {
1232     size_t ret = 0;
1233
1234     if (s->s3 != NULL) {
1235         ret = s->s3->tmp.peer_finish_md_len;
1236         if (count > ret)
1237             count = ret;
1238         memcpy(buf, s->s3->tmp.peer_finish_md, count);
1239     }
1240     return ret;
1241 }
1242
1243 int SSL_get_verify_mode(const SSL *s)
1244 {
1245     return (s->verify_mode);
1246 }
1247
1248 int SSL_get_verify_depth(const SSL *s)
1249 {
1250     return X509_VERIFY_PARAM_get_depth(s->param);
1251 }
1252
1253 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1254     return (s->verify_callback);
1255 }
1256
1257 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1258 {
1259     return (ctx->verify_mode);
1260 }
1261
1262 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1263 {
1264     return X509_VERIFY_PARAM_get_depth(ctx->param);
1265 }
1266
1267 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1268     return (ctx->default_verify_callback);
1269 }
1270
1271 void SSL_set_verify(SSL *s, int mode,
1272                     int (*callback) (int ok, X509_STORE_CTX *ctx))
1273 {
1274     s->verify_mode = mode;
1275     if (callback != NULL)
1276         s->verify_callback = callback;
1277 }
1278
1279 void SSL_set_verify_depth(SSL *s, int depth)
1280 {
1281     X509_VERIFY_PARAM_set_depth(s->param, depth);
1282 }
1283
1284 void SSL_set_read_ahead(SSL *s, int yes)
1285 {
1286     RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1287 }
1288
1289 int SSL_get_read_ahead(const SSL *s)
1290 {
1291     return RECORD_LAYER_get_read_ahead(&s->rlayer);
1292 }
1293
1294 int SSL_pending(const SSL *s)
1295 {
1296     size_t pending = s->method->ssl_pending(s);
1297
1298     /*
1299      * SSL_pending cannot work properly if read-ahead is enabled
1300      * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1301      * impossible to fix since SSL_pending cannot report errors that may be
1302      * observed while scanning the new data. (Note that SSL_pending() is
1303      * often used as a boolean value, so we'd better not return -1.)
1304      *
1305      * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1306      * we just return INT_MAX.
1307      */
1308     return pending < INT_MAX ? (int)pending : INT_MAX;
1309 }
1310
1311 int SSL_has_pending(const SSL *s)
1312 {
1313     /*
1314      * Similar to SSL_pending() but returns a 1 to indicate that we have
1315      * unprocessed data available or 0 otherwise (as opposed to the number of
1316      * bytes available). Unlike SSL_pending() this will take into account
1317      * read_ahead data. A 1 return simply indicates that we have unprocessed
1318      * data. That data may not result in any application data, or we may fail
1319      * to parse the records for some reason.
1320      */
1321     if (SSL_pending(s))
1322         return 1;
1323
1324     return RECORD_LAYER_read_pending(&s->rlayer);
1325 }
1326
1327 X509 *SSL_get_peer_certificate(const SSL *s)
1328 {
1329     X509 *r;
1330
1331     if ((s == NULL) || (s->session == NULL))
1332         r = NULL;
1333     else
1334         r = s->session->peer;
1335
1336     if (r == NULL)
1337         return (r);
1338
1339     X509_up_ref(r);
1340
1341     return (r);
1342 }
1343
1344 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1345 {
1346     STACK_OF(X509) *r;
1347
1348     if ((s == NULL) || (s->session == NULL))
1349         r = NULL;
1350     else
1351         r = s->session->peer_chain;
1352
1353     /*
1354      * If we are a client, cert_chain includes the peer's own certificate; if
1355      * we are a server, it does not.
1356      */
1357
1358     return (r);
1359 }
1360
1361 /*
1362  * Now in theory, since the calling process own 't' it should be safe to
1363  * modify.  We need to be able to read f without being hassled
1364  */
1365 int SSL_copy_session_id(SSL *t, const SSL *f)
1366 {
1367     int i;
1368     /* Do we need to to SSL locking? */
1369     if (!SSL_set_session(t, SSL_get_session(f))) {
1370         return 0;
1371     }
1372
1373     /*
1374      * what if we are setup for one protocol version but want to talk another
1375      */
1376     if (t->method != f->method) {
1377         t->method->ssl_free(t);
1378         t->method = f->method;
1379         if (t->method->ssl_new(t) == 0)
1380             return 0;
1381     }
1382
1383     CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1384     ssl_cert_free(t->cert);
1385     t->cert = f->cert;
1386     if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1387         return 0;
1388     }
1389
1390     return 1;
1391 }
1392
1393 /* Fix this so it checks all the valid key/cert options */
1394 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1395 {
1396     if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1397         SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1398         return (0);
1399     }
1400     if (ctx->cert->key->privatekey == NULL) {
1401         SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1402         return (0);
1403     }
1404     return (X509_check_private_key
1405             (ctx->cert->key->x509, ctx->cert->key->privatekey));
1406 }
1407
1408 /* Fix this function so that it takes an optional type parameter */
1409 int SSL_check_private_key(const SSL *ssl)
1410 {
1411     if (ssl == NULL) {
1412         SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1413         return (0);
1414     }
1415     if (ssl->cert->key->x509 == NULL) {
1416         SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1417         return (0);
1418     }
1419     if (ssl->cert->key->privatekey == NULL) {
1420         SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1421         return (0);
1422     }
1423     return (X509_check_private_key(ssl->cert->key->x509,
1424                                    ssl->cert->key->privatekey));
1425 }
1426
1427 int SSL_waiting_for_async(SSL *s)
1428 {
1429     if (s->job)
1430         return 1;
1431
1432     return 0;
1433 }
1434
1435 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1436 {
1437     ASYNC_WAIT_CTX *ctx = s->waitctx;
1438
1439     if (ctx == NULL)
1440         return 0;
1441     return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1442 }
1443
1444 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1445                               OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1446 {
1447     ASYNC_WAIT_CTX *ctx = s->waitctx;
1448
1449     if (ctx == NULL)
1450         return 0;
1451     return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1452                                           numdelfds);
1453 }
1454
1455 int SSL_accept(SSL *s)
1456 {
1457     if (s->handshake_func == NULL) {
1458         /* Not properly initialized yet */
1459         SSL_set_accept_state(s);
1460     }
1461
1462     return SSL_do_handshake(s);
1463 }
1464
1465 int SSL_connect(SSL *s)
1466 {
1467     if (s->handshake_func == NULL) {
1468         /* Not properly initialized yet */
1469         SSL_set_connect_state(s);
1470     }
1471
1472     return SSL_do_handshake(s);
1473 }
1474
1475 long SSL_get_default_timeout(const SSL *s)
1476 {
1477     return (s->method->get_timeout());
1478 }
1479
1480 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1481                                int (*func) (void *))
1482 {
1483     int ret;
1484     if (s->waitctx == NULL) {
1485         s->waitctx = ASYNC_WAIT_CTX_new();
1486         if (s->waitctx == NULL)
1487             return -1;
1488     }
1489     switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1490                             sizeof(struct ssl_async_args))) {
1491     case ASYNC_ERR:
1492         s->rwstate = SSL_NOTHING;
1493         SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1494         return -1;
1495     case ASYNC_PAUSE:
1496         s->rwstate = SSL_ASYNC_PAUSED;
1497         return -1;
1498     case ASYNC_NO_JOBS:
1499         s->rwstate = SSL_ASYNC_NO_JOBS;
1500         return -1;
1501     case ASYNC_FINISH:
1502         s->job = NULL;
1503         return ret;
1504     default:
1505         s->rwstate = SSL_NOTHING;
1506         SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1507         /* Shouldn't happen */
1508         return -1;
1509     }
1510 }
1511
1512 static int ssl_io_intern(void *vargs)
1513 {
1514     struct ssl_async_args *args;
1515     SSL *s;
1516     void *buf;
1517     size_t num;
1518
1519     args = (struct ssl_async_args *)vargs;
1520     s = args->s;
1521     buf = args->buf;
1522     num = args->num;
1523     switch (args->type) {
1524     case READFUNC:
1525         return args->f.func_read(s, buf, num, &s->asyncrw);
1526     case WRITEFUNC:
1527         return args->f.func_write(s, buf, num, &s->asyncrw);
1528     case OTHERFUNC:
1529         return args->f.func_other(s);
1530     }
1531     return -1;
1532 }
1533
1534 int SSL_read(SSL *s, void *buf, int num)
1535 {
1536     int ret;
1537     size_t readbytes;
1538
1539     if (num < 0) {
1540         SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1541         return -1;
1542     }
1543
1544     ret = SSL_read_ex(s, buf, (size_t)num, &readbytes);
1545
1546     /*
1547      * The cast is safe here because ret should be <= INT_MAX because num is
1548      * <= INT_MAX
1549      */
1550     if (ret > 0)
1551         ret = (int)readbytes;
1552
1553     return ret;
1554 }
1555
1556 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1557 {
1558     if (s->handshake_func == NULL) {
1559         SSLerr(SSL_F_SSL_READ_EX, SSL_R_UNINITIALIZED);
1560         return -1;
1561     }
1562
1563     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1564         s->rwstate = SSL_NOTHING;
1565         return (0);
1566     }
1567
1568     if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1569         struct ssl_async_args args;
1570         int ret;
1571
1572         args.s = s;
1573         args.buf = buf;
1574         args.num = num;
1575         args.type = READFUNC;
1576         args.f.func_read = s->method->ssl_read;
1577
1578         ret = ssl_start_async_job(s, &args, ssl_io_intern);
1579         *readbytes = s->asyncrw;
1580         return ret;
1581     } else {
1582         return s->method->ssl_read(s, buf, num, readbytes);
1583     }
1584 }
1585
1586 int SSL_peek(SSL *s, void *buf, int num)
1587 {
1588     int ret;
1589     size_t readbytes;
1590
1591     if (num < 0) {
1592         SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1593         return -1;
1594     }
1595
1596     ret = SSL_peek_ex(s, buf, (size_t)num, &readbytes);
1597
1598     /*
1599      * The cast is safe here because ret should be <= INT_MAX because num is
1600      * <= INT_MAX
1601      */
1602     if (ret > 0)
1603         ret = (int)readbytes;
1604
1605     return ret;
1606 }
1607
1608 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1609 {
1610     if (s->handshake_func == NULL) {
1611         SSLerr(SSL_F_SSL_PEEK_EX, SSL_R_UNINITIALIZED);
1612         return -1;
1613     }
1614
1615     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1616         return (0);
1617     }
1618     if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1619         struct ssl_async_args args;
1620         int ret;
1621
1622         args.s = s;
1623         args.buf = buf;
1624         args.num = num;
1625         args.type = READFUNC;
1626         args.f.func_read = s->method->ssl_peek;
1627
1628         ret = ssl_start_async_job(s, &args, ssl_io_intern);
1629         *readbytes = s->asyncrw;
1630         return ret;
1631     } else {
1632         return s->method->ssl_peek(s, buf, num, readbytes);
1633     }
1634 }
1635
1636 int SSL_write(SSL *s, const void *buf, int num)
1637 {
1638     int ret;
1639     size_t written;
1640
1641     if (num < 0) {
1642         SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1643         return -1;
1644     }
1645
1646     ret = SSL_write_ex(s, buf, (size_t)num, &written);
1647
1648     /*
1649      * The cast is safe here because ret should be <= INT_MAX because num is
1650      * <= INT_MAX
1651      */
1652     if (ret > 0)
1653         ret = (int)written;
1654
1655     return ret;
1656 }
1657
1658 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1659 {
1660     if (s->handshake_func == NULL) {
1661         SSLerr(SSL_F_SSL_WRITE_EX, SSL_R_UNINITIALIZED);
1662         return -1;
1663     }
1664
1665     if (s->shutdown & SSL_SENT_SHUTDOWN) {
1666         s->rwstate = SSL_NOTHING;
1667         SSLerr(SSL_F_SSL_WRITE_EX, SSL_R_PROTOCOL_IS_SHUTDOWN);
1668         return (-1);
1669     }
1670
1671     if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1672         int ret;
1673         struct ssl_async_args args;
1674
1675         args.s = s;
1676         args.buf = (void *)buf;
1677         args.num = num;
1678         args.type = WRITEFUNC;
1679         args.f.func_write = s->method->ssl_write;
1680
1681         ret = ssl_start_async_job(s, &args, ssl_io_intern);
1682         *written = s->asyncrw;
1683         return ret;
1684     } else {
1685         return s->method->ssl_write(s, buf, num, written);
1686     }
1687 }
1688
1689 int SSL_shutdown(SSL *s)
1690 {
1691     /*
1692      * Note that this function behaves differently from what one might
1693      * expect.  Return values are 0 for no success (yet), 1 for success; but
1694      * calling it once is usually not enough, even if blocking I/O is used
1695      * (see ssl3_shutdown).
1696      */
1697
1698     if (s->handshake_func == NULL) {
1699         SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1700         return -1;
1701     }
1702
1703     if (!SSL_in_init(s)) {
1704         if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1705             struct ssl_async_args args;
1706
1707             args.s = s;
1708             args.type = OTHERFUNC;
1709             args.f.func_other = s->method->ssl_shutdown;
1710
1711             return ssl_start_async_job(s, &args, ssl_io_intern);
1712         } else {
1713             return s->method->ssl_shutdown(s);
1714         }
1715     } else {
1716         SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1717         return -1;
1718     }
1719 }
1720
1721 int SSL_key_update(SSL *s, SSL_KEY_UPDATE updatetype)
1722 {
1723     if (!SSL_IS_TLS13(s)) {
1724         SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1725         return 0;
1726     }
1727
1728     if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1729             && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1730         SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1731         return 0;
1732     }
1733
1734     if (!SSL_is_init_finished(s)) {
1735         SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1736         return 0;
1737     }
1738
1739     ossl_statem_set_in_init(s, 1);
1740
1741     s->key_update = updatetype;
1742
1743     return 1;
1744 }
1745
1746 int SSL_renegotiate(SSL *s)
1747 {
1748     if (SSL_IS_TLS13(s)) {
1749         SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1750         return 0;
1751     }
1752
1753     if (s->renegotiate == 0)
1754         s->renegotiate = 1;
1755
1756     s->new_session = 1;
1757
1758     return (s->method->ssl_renegotiate(s));
1759 }
1760
1761 int SSL_renegotiate_abbreviated(SSL *s)
1762 {
1763     if (SSL_IS_TLS13(s))
1764         return 0;
1765
1766     if (s->renegotiate == 0)
1767         s->renegotiate = 1;
1768
1769     s->new_session = 0;
1770
1771     return (s->method->ssl_renegotiate(s));
1772 }
1773
1774 int SSL_renegotiate_pending(SSL *s)
1775 {
1776     /*
1777      * becomes true when negotiation is requested; false again once a
1778      * handshake has finished
1779      */
1780     return (s->renegotiate != 0);
1781 }
1782
1783 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1784 {
1785     long l;
1786
1787     switch (cmd) {
1788     case SSL_CTRL_GET_READ_AHEAD:
1789         return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1790     case SSL_CTRL_SET_READ_AHEAD:
1791         l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1792         RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1793         return (l);
1794
1795     case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1796         s->msg_callback_arg = parg;
1797         return 1;
1798
1799     case SSL_CTRL_MODE:
1800         return (s->mode |= larg);
1801     case SSL_CTRL_CLEAR_MODE:
1802         return (s->mode &= ~larg);
1803     case SSL_CTRL_GET_MAX_CERT_LIST:
1804         return (long)(s->max_cert_list);
1805     case SSL_CTRL_SET_MAX_CERT_LIST:
1806         if (larg < 0)
1807             return 0;
1808         l = (long)s->max_cert_list;
1809         s->max_cert_list = (size_t)larg;
1810         return l;
1811     case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1812         if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1813             return 0;
1814         s->max_send_fragment = larg;
1815         if (s->max_send_fragment < s->split_send_fragment)
1816             s->split_send_fragment = s->max_send_fragment;
1817         return 1;
1818     case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1819         if ((size_t)larg > s->max_send_fragment || larg == 0)
1820             return 0;
1821         s->split_send_fragment = larg;
1822         return 1;
1823     case SSL_CTRL_SET_MAX_PIPELINES:
1824         if (larg < 1 || larg > SSL_MAX_PIPELINES)
1825             return 0;
1826         s->max_pipelines = larg;
1827         if (larg > 1)
1828             RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1829         return 1;
1830     case SSL_CTRL_GET_RI_SUPPORT:
1831         if (s->s3)
1832             return s->s3->send_connection_binding;
1833         else
1834             return 0;
1835     case SSL_CTRL_CERT_FLAGS:
1836         return (s->cert->cert_flags |= larg);
1837     case SSL_CTRL_CLEAR_CERT_FLAGS:
1838         return (s->cert->cert_flags &= ~larg);
1839
1840     case SSL_CTRL_GET_RAW_CIPHERLIST:
1841         if (parg) {
1842             if (s->s3->tmp.ciphers_raw == NULL)
1843                 return 0;
1844             *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1845             return (int)s->s3->tmp.ciphers_rawlen;
1846         } else {
1847             return TLS_CIPHER_LEN;
1848         }
1849     case SSL_CTRL_GET_EXTMS_SUPPORT:
1850         if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1851             return -1;
1852         if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1853             return 1;
1854         else
1855             return 0;
1856     case SSL_CTRL_SET_MIN_PROTO_VERSION:
1857         return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1858                                      &s->min_proto_version);
1859     case SSL_CTRL_SET_MAX_PROTO_VERSION:
1860         return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1861                                      &s->max_proto_version);
1862     default:
1863         return (s->method->ssl_ctrl(s, cmd, larg, parg));
1864     }
1865 }
1866
1867 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1868 {
1869     switch (cmd) {
1870     case SSL_CTRL_SET_MSG_CALLBACK:
1871         s->msg_callback = (void (*)
1872                            (int write_p, int version, int content_type,
1873                             const void *buf, size_t len, SSL *ssl,
1874                             void *arg))(fp);
1875         return 1;
1876
1877     default:
1878         return (s->method->ssl_callback_ctrl(s, cmd, fp));
1879     }
1880 }
1881
1882 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1883 {
1884     return ctx->sessions;
1885 }
1886
1887 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1888 {
1889     long l;
1890     /* For some cases with ctx == NULL perform syntax checks */
1891     if (ctx == NULL) {
1892         switch (cmd) {
1893 #ifndef OPENSSL_NO_EC
1894         case SSL_CTRL_SET_GROUPS_LIST:
1895             return tls1_set_groups_list(NULL, NULL, parg);
1896 #endif
1897         case SSL_CTRL_SET_SIGALGS_LIST:
1898         case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1899             return tls1_set_sigalgs_list(NULL, parg, 0);
1900         default:
1901             return 0;
1902         }
1903     }
1904
1905     switch (cmd) {
1906     case SSL_CTRL_GET_READ_AHEAD:
1907         return (ctx->read_ahead);
1908     case SSL_CTRL_SET_READ_AHEAD:
1909         l = ctx->read_ahead;
1910         ctx->read_ahead = larg;
1911         return (l);
1912
1913     case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1914         ctx->msg_callback_arg = parg;
1915         return 1;
1916
1917     case SSL_CTRL_GET_MAX_CERT_LIST:
1918         return (long)(ctx->max_cert_list);
1919     case SSL_CTRL_SET_MAX_CERT_LIST:
1920         if (larg < 0)
1921             return 0;
1922         l = (long)ctx->max_cert_list;
1923         ctx->max_cert_list = (size_t)larg;
1924         return l;
1925
1926     case SSL_CTRL_SET_SESS_CACHE_SIZE:
1927         if (larg < 0)
1928             return 0;
1929         l = (long)ctx->session_cache_size;
1930         ctx->session_cache_size = (size_t)larg;
1931         return l;
1932     case SSL_CTRL_GET_SESS_CACHE_SIZE:
1933         return (long)(ctx->session_cache_size);
1934     case SSL_CTRL_SET_SESS_CACHE_MODE:
1935         l = ctx->session_cache_mode;
1936         ctx->session_cache_mode = larg;
1937         return (l);
1938     case SSL_CTRL_GET_SESS_CACHE_MODE:
1939         return (ctx->session_cache_mode);
1940
1941     case SSL_CTRL_SESS_NUMBER:
1942         return (lh_SSL_SESSION_num_items(ctx->sessions));
1943     case SSL_CTRL_SESS_CONNECT:
1944         return (ctx->stats.sess_connect);
1945     case SSL_CTRL_SESS_CONNECT_GOOD:
1946         return (ctx->stats.sess_connect_good);
1947     case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1948         return (ctx->stats.sess_connect_renegotiate);
1949     case SSL_CTRL_SESS_ACCEPT:
1950         return (ctx->stats.sess_accept);
1951     case SSL_CTRL_SESS_ACCEPT_GOOD:
1952         return (ctx->stats.sess_accept_good);
1953     case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1954         return (ctx->stats.sess_accept_renegotiate);
1955     case SSL_CTRL_SESS_HIT:
1956         return (ctx->stats.sess_hit);
1957     case SSL_CTRL_SESS_CB_HIT:
1958         return (ctx->stats.sess_cb_hit);
1959     case SSL_CTRL_SESS_MISSES:
1960         return (ctx->stats.sess_miss);
1961     case SSL_CTRL_SESS_TIMEOUTS:
1962         return (ctx->stats.sess_timeout);
1963     case SSL_CTRL_SESS_CACHE_FULL:
1964         return (ctx->stats.sess_cache_full);
1965     case SSL_CTRL_MODE:
1966         return (ctx->mode |= larg);
1967     case SSL_CTRL_CLEAR_MODE:
1968         return (ctx->mode &= ~larg);
1969     case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1970         if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1971             return 0;
1972         ctx->max_send_fragment = larg;
1973         if (ctx->max_send_fragment < ctx->split_send_fragment)
1974             ctx->split_send_fragment = ctx->max_send_fragment;
1975         return 1;
1976     case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1977         if ((size_t)larg > ctx->max_send_fragment || larg == 0)
1978             return 0;
1979         ctx->split_send_fragment = larg;
1980         return 1;
1981     case SSL_CTRL_SET_MAX_PIPELINES:
1982         if (larg < 1 || larg > SSL_MAX_PIPELINES)
1983             return 0;
1984         ctx->max_pipelines = larg;
1985         return 1;
1986     case SSL_CTRL_CERT_FLAGS:
1987         return (ctx->cert->cert_flags |= larg);
1988     case SSL_CTRL_CLEAR_CERT_FLAGS:
1989         return (ctx->cert->cert_flags &= ~larg);
1990     case SSL_CTRL_SET_MIN_PROTO_VERSION:
1991         return ssl_set_version_bound(ctx->method->version, (int)larg,
1992                                      &ctx->min_proto_version);
1993     case SSL_CTRL_SET_MAX_PROTO_VERSION:
1994         return ssl_set_version_bound(ctx->method->version, (int)larg,
1995                                      &ctx->max_proto_version);
1996     default:
1997         return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
1998     }
1999 }
2000
2001 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2002 {
2003     switch (cmd) {
2004     case SSL_CTRL_SET_MSG_CALLBACK:
2005         ctx->msg_callback = (void (*)
2006                              (int write_p, int version, int content_type,
2007                               const void *buf, size_t len, SSL *ssl,
2008                               void *arg))(fp);
2009         return 1;
2010
2011     default:
2012         return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2013     }
2014 }
2015
2016 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2017 {
2018     if (a->id > b->id)
2019         return 1;
2020     if (a->id < b->id)
2021         return -1;
2022     return 0;
2023 }
2024
2025 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2026                           const SSL_CIPHER *const *bp)
2027 {
2028     if ((*ap)->id > (*bp)->id)
2029         return 1;
2030     if ((*ap)->id < (*bp)->id)
2031         return -1;
2032     return 0;
2033 }
2034
2035 /** return a STACK of the ciphers available for the SSL and in order of
2036  * preference */
2037 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2038 {
2039     if (s != NULL) {
2040         if (s->cipher_list != NULL) {
2041             return (s->cipher_list);
2042         } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2043             return (s->ctx->cipher_list);
2044         }
2045     }
2046     return (NULL);
2047 }
2048
2049 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2050 {
2051     if ((s == NULL) || (s->session == NULL) || !s->server)
2052         return NULL;
2053     return s->session->ciphers;
2054 }
2055
2056 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2057 {
2058     STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2059     int i;
2060     ciphers = SSL_get_ciphers(s);
2061     if (!ciphers)
2062         return NULL;
2063     ssl_set_client_disabled(s);
2064     for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2065         const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2066         if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2067             if (!sk)
2068                 sk = sk_SSL_CIPHER_new_null();
2069             if (!sk)
2070                 return NULL;
2071             if (!sk_SSL_CIPHER_push(sk, c)) {
2072                 sk_SSL_CIPHER_free(sk);
2073                 return NULL;
2074             }
2075         }
2076     }
2077     return sk;
2078 }
2079
2080 /** return a STACK of the ciphers available for the SSL and in order of
2081  * algorithm id */
2082 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2083 {
2084     if (s != NULL) {
2085         if (s->cipher_list_by_id != NULL) {
2086             return (s->cipher_list_by_id);
2087         } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2088             return (s->ctx->cipher_list_by_id);
2089         }
2090     }
2091     return (NULL);
2092 }
2093
2094 /** The old interface to get the same thing as SSL_get_ciphers() */
2095 const char *SSL_get_cipher_list(const SSL *s, int n)
2096 {
2097     const SSL_CIPHER *c;
2098     STACK_OF(SSL_CIPHER) *sk;
2099
2100     if (s == NULL)
2101         return (NULL);
2102     sk = SSL_get_ciphers(s);
2103     if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2104         return (NULL);
2105     c = sk_SSL_CIPHER_value(sk, n);
2106     if (c == NULL)
2107         return (NULL);
2108     return (c->name);
2109 }
2110
2111 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2112  * preference */
2113 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2114 {
2115     if (ctx != NULL)
2116         return ctx->cipher_list;
2117     return NULL;
2118 }
2119
2120 /** specify the ciphers to be used by default by the SSL_CTX */
2121 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2122 {
2123     STACK_OF(SSL_CIPHER) *sk;
2124
2125     sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2126                                 &ctx->cipher_list_by_id, str, ctx->cert);
2127     /*
2128      * ssl_create_cipher_list may return an empty stack if it was unable to
2129      * find a cipher matching the given rule string (for example if the rule
2130      * string specifies a cipher which has been disabled). This is not an
2131      * error as far as ssl_create_cipher_list is concerned, and hence
2132      * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2133      */
2134     if (sk == NULL)
2135         return 0;
2136     else if (sk_SSL_CIPHER_num(sk) == 0) {
2137         SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2138         return 0;
2139     }
2140     return 1;
2141 }
2142
2143 /** specify the ciphers to be used by the SSL */
2144 int SSL_set_cipher_list(SSL *s, const char *str)
2145 {
2146     STACK_OF(SSL_CIPHER) *sk;
2147
2148     sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2149                                 &s->cipher_list_by_id, str, s->cert);
2150     /* see comment in SSL_CTX_set_cipher_list */
2151     if (sk == NULL)
2152         return 0;
2153     else if (sk_SSL_CIPHER_num(sk) == 0) {
2154         SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2155         return 0;
2156     }
2157     return 1;
2158 }
2159
2160 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2161 {
2162     char *p;
2163     STACK_OF(SSL_CIPHER) *sk;
2164     const SSL_CIPHER *c;
2165     int i;
2166
2167     if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2168         return (NULL);
2169
2170     p = buf;
2171     sk = s->session->ciphers;
2172
2173     if (sk_SSL_CIPHER_num(sk) == 0)
2174         return NULL;
2175
2176     for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2177         int n;
2178
2179         c = sk_SSL_CIPHER_value(sk, i);
2180         n = strlen(c->name);
2181         if (n + 1 > len) {
2182             if (p != buf)
2183                 --p;
2184             *p = '\0';
2185             return buf;
2186         }
2187         memcpy(p, c->name, n + 1);
2188         p += n;
2189         *(p++) = ':';
2190         len -= n + 1;
2191     }
2192     p[-1] = '\0';
2193     return (buf);
2194 }
2195
2196 /** return a servername extension value if provided in Client Hello, or NULL.
2197  * So far, only host_name types are defined (RFC 3546).
2198  */
2199
2200 const char *SSL_get_servername(const SSL *s, const int type)
2201 {
2202     if (type != TLSEXT_NAMETYPE_host_name)
2203         return NULL;
2204
2205     return s->session && !s->ext.hostname ?
2206         s->session->ext.hostname : s->ext.hostname;
2207 }
2208
2209 int SSL_get_servername_type(const SSL *s)
2210 {
2211     if (s->session
2212         && (!s->ext.hostname ? s->session->
2213             ext.hostname : s->ext.hostname))
2214         return TLSEXT_NAMETYPE_host_name;
2215     return -1;
2216 }
2217
2218 /*
2219  * SSL_select_next_proto implements the standard protocol selection. It is
2220  * expected that this function is called from the callback set by
2221  * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2222  * vector of 8-bit, length prefixed byte strings. The length byte itself is
2223  * not included in the length. A byte string of length 0 is invalid. No byte
2224  * string may be truncated. The current, but experimental algorithm for
2225  * selecting the protocol is: 1) If the server doesn't support NPN then this
2226  * is indicated to the callback. In this case, the client application has to
2227  * abort the connection or have a default application level protocol. 2) If
2228  * the server supports NPN, but advertises an empty list then the client
2229  * selects the first protocol in its list, but indicates via the API that this
2230  * fallback case was enacted. 3) Otherwise, the client finds the first
2231  * protocol in the server's list that it supports and selects this protocol.
2232  * This is because it's assumed that the server has better information about
2233  * which protocol a client should use. 4) If the client doesn't support any
2234  * of the server's advertised protocols, then this is treated the same as
2235  * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2236  * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2237  */
2238 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2239                           const unsigned char *server,
2240                           unsigned int server_len,
2241                           const unsigned char *client, unsigned int client_len)
2242 {
2243     unsigned int i, j;
2244     const unsigned char *result;
2245     int status = OPENSSL_NPN_UNSUPPORTED;
2246
2247     /*
2248      * For each protocol in server preference order, see if we support it.
2249      */
2250     for (i = 0; i < server_len;) {
2251         for (j = 0; j < client_len;) {
2252             if (server[i] == client[j] &&
2253                 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2254                 /* We found a match */
2255                 result = &server[i];
2256                 status = OPENSSL_NPN_NEGOTIATED;
2257                 goto found;
2258             }
2259             j += client[j];
2260             j++;
2261         }
2262         i += server[i];
2263         i++;
2264     }
2265
2266     /* There's no overlap between our protocols and the server's list. */
2267     result = client;
2268     status = OPENSSL_NPN_NO_OVERLAP;
2269
2270  found:
2271     *out = (unsigned char *)result + 1;
2272     *outlen = result[0];
2273     return status;
2274 }
2275
2276 #ifndef OPENSSL_NO_NEXTPROTONEG
2277 /*
2278  * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2279  * client's requested protocol for this connection and returns 0. If the
2280  * client didn't request any protocol, then *data is set to NULL. Note that
2281  * the client can request any protocol it chooses. The value returned from
2282  * this function need not be a member of the list of supported protocols
2283  * provided by the callback.
2284  */
2285 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2286                                     unsigned *len)
2287 {
2288     *data = s->ext.npn;
2289     if (!*data) {
2290         *len = 0;
2291     } else {
2292         *len = (unsigned int)s->ext.npn_len;
2293     }
2294 }
2295
2296 /*
2297  * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2298  * a TLS server needs a list of supported protocols for Next Protocol
2299  * Negotiation. The returned list must be in wire format.  The list is
2300  * returned by setting |out| to point to it and |outlen| to its length. This
2301  * memory will not be modified, but one should assume that the SSL* keeps a
2302  * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2303  * wishes to advertise. Otherwise, no such extension will be included in the
2304  * ServerHello.
2305  */
2306 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2307                                    SSL_CTX_npn_advertised_cb_func cb,
2308                                    void *arg)
2309 {
2310     ctx->ext.npn_advertised_cb = cb;
2311     ctx->ext.npn_advertised_cb_arg = arg;
2312 }
2313
2314 /*
2315  * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2316  * client needs to select a protocol from the server's provided list. |out|
2317  * must be set to point to the selected protocol (which may be within |in|).
2318  * The length of the protocol name must be written into |outlen|. The
2319  * server's advertised protocols are provided in |in| and |inlen|. The
2320  * callback can assume that |in| is syntactically valid. The client must
2321  * select a protocol. It is fatal to the connection if this callback returns
2322  * a value other than SSL_TLSEXT_ERR_OK.
2323  */
2324 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2325                                SSL_CTX_npn_select_cb_func cb,
2326                                void *arg)
2327 {
2328     ctx->ext.npn_select_cb = cb;
2329     ctx->ext.npn_select_cb_arg = arg;
2330 }
2331 #endif
2332
2333 /*
2334  * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2335  * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2336  * length-prefixed strings). Returns 0 on success.
2337  */
2338 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2339                             unsigned int protos_len)
2340 {
2341     OPENSSL_free(ctx->ext.alpn);
2342     ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2343     if (ctx->ext.alpn == NULL) {
2344         SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2345         return 1;
2346     }
2347     ctx->ext.alpn_len = protos_len;
2348
2349     return 0;
2350 }
2351
2352 /*
2353  * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2354  * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2355  * length-prefixed strings). Returns 0 on success.
2356  */
2357 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2358                         unsigned int protos_len)
2359 {
2360     OPENSSL_free(ssl->ext.alpn);
2361     ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2362     if (ssl->ext.alpn == NULL) {
2363         SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2364         return 1;
2365     }
2366     ssl->ext.alpn_len = protos_len;
2367
2368     return 0;
2369 }
2370
2371 /*
2372  * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2373  * called during ClientHello processing in order to select an ALPN protocol
2374  * from the client's list of offered protocols.
2375  */
2376 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2377                                 SSL_CTX_alpn_select_cb_func cb,
2378                                 void *arg)
2379 {
2380     ctx->ext.alpn_select_cb = cb;
2381     ctx->ext.alpn_select_cb_arg = arg;
2382 }
2383
2384 /*
2385  * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2386  * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2387  * (not including the leading length-prefix byte). If the server didn't
2388  * respond with a negotiated protocol then |*len| will be zero.
2389  */
2390 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2391                             unsigned int *len)
2392 {
2393     *data = NULL;
2394     if (ssl->s3)
2395         *data = ssl->s3->alpn_selected;
2396     if (*data == NULL)
2397         *len = 0;
2398     else
2399         *len = (unsigned int)ssl->s3->alpn_selected_len;
2400 }
2401
2402 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2403                                const char *label, size_t llen,
2404                                const unsigned char *p, size_t plen,
2405                                int use_context)
2406 {
2407     if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2408         return -1;
2409
2410     return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2411                                                        llen, p, plen,
2412                                                        use_context);
2413 }
2414
2415 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2416 {
2417     const unsigned char *session_id = a->session_id;
2418     unsigned long l;
2419     unsigned char tmp_storage[4];
2420
2421     if (a->session_id_length < sizeof(tmp_storage)) {
2422         memset(tmp_storage, 0, sizeof(tmp_storage));
2423         memcpy(tmp_storage, a->session_id, a->session_id_length);
2424         session_id = tmp_storage;
2425     }
2426
2427     l = (unsigned long)
2428         ((unsigned long)session_id[0]) |
2429         ((unsigned long)session_id[1] << 8L) |
2430         ((unsigned long)session_id[2] << 16L) |
2431         ((unsigned long)session_id[3] << 24L);
2432     return (l);
2433 }
2434
2435 /*
2436  * NB: If this function (or indeed the hash function which uses a sort of
2437  * coarser function than this one) is changed, ensure
2438  * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2439  * being able to construct an SSL_SESSION that will collide with any existing
2440  * session with a matching session ID.
2441  */
2442 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2443 {
2444     if (a->ssl_version != b->ssl_version)
2445         return (1);
2446     if (a->session_id_length != b->session_id_length)
2447         return (1);
2448     return (memcmp(a->session_id, b->session_id, a->session_id_length));
2449 }
2450
2451 /*
2452  * These wrapper functions should remain rather than redeclaring
2453  * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2454  * variable. The reason is that the functions aren't static, they're exposed
2455  * via ssl.h.
2456  */
2457
2458 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2459 {
2460     SSL_CTX *ret = NULL;
2461
2462     if (meth == NULL) {
2463         SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2464         return (NULL);
2465     }
2466
2467     if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2468         return NULL;
2469
2470     if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2471         SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2472         return NULL;
2473     }
2474
2475     if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2476         SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2477         goto err;
2478     }
2479     ret = OPENSSL_zalloc(sizeof(*ret));
2480     if (ret == NULL)
2481         goto err;
2482
2483     ret->method = meth;
2484     ret->min_proto_version = 0;
2485     ret->max_proto_version = 0;
2486     ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2487     ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2488     /* We take the system default. */
2489     ret->session_timeout = meth->get_timeout();
2490     ret->references = 1;
2491     ret->lock = CRYPTO_THREAD_lock_new();
2492     if (ret->lock == NULL) {
2493         SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2494         OPENSSL_free(ret);
2495         return NULL;
2496     }
2497     ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2498     ret->verify_mode = SSL_VERIFY_NONE;
2499     if ((ret->cert = ssl_cert_new()) == NULL)
2500         goto err;
2501
2502     ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2503     if (ret->sessions == NULL)
2504         goto err;
2505     ret->cert_store = X509_STORE_new();
2506     if (ret->cert_store == NULL)
2507         goto err;
2508 #ifndef OPENSSL_NO_CT
2509     ret->ctlog_store = CTLOG_STORE_new();
2510     if (ret->ctlog_store == NULL)
2511         goto err;
2512 #endif
2513     if (!ssl_create_cipher_list(ret->method,
2514                                 &ret->cipher_list, &ret->cipher_list_by_id,
2515                                 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2516         || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2517         SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2518         goto err2;
2519     }
2520
2521     ret->param = X509_VERIFY_PARAM_new();
2522     if (ret->param == NULL)
2523         goto err;
2524
2525     if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2526         SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2527         goto err2;
2528     }
2529     if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2530         SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2531         goto err2;
2532     }
2533
2534     if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2535         goto err;
2536
2537     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2538         goto err;
2539
2540     /* No compression for DTLS */
2541     if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2542         ret->comp_methods = SSL_COMP_get_compression_methods();
2543
2544     ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2545     ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2546
2547     /* Setup RFC5077 ticket keys */
2548     if ((RAND_bytes(ret->ext.tick_key_name,
2549                     sizeof(ret->ext.tick_key_name)) <= 0)
2550         || (RAND_bytes(ret->ext.tick_hmac_key,
2551                        sizeof(ret->ext.tick_hmac_key)) <= 0)
2552         || (RAND_bytes(ret->ext.tick_aes_key,
2553                        sizeof(ret->ext.tick_aes_key)) <= 0))
2554         ret->options |= SSL_OP_NO_TICKET;
2555
2556 #ifndef OPENSSL_NO_SRP
2557     if (!SSL_CTX_SRP_CTX_init(ret))
2558         goto err;
2559 #endif
2560 #ifndef OPENSSL_NO_ENGINE
2561 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2562 #  define eng_strx(x)     #x
2563 #  define eng_str(x)      eng_strx(x)
2564     /* Use specific client engine automatically... ignore errors */
2565     {
2566         ENGINE *eng;
2567         eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2568         if (!eng) {
2569             ERR_clear_error();
2570             ENGINE_load_builtin_engines();
2571             eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2572         }
2573         if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2574             ERR_clear_error();
2575     }
2576 # endif
2577 #endif
2578     /*
2579      * Default is to connect to non-RI servers. When RI is more widely
2580      * deployed might change this.
2581      */
2582     ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2583     /*
2584      * Disable compression by default to prevent CRIME. Applications can
2585      * re-enable compression by configuring
2586      * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2587      * or by using the SSL_CONF library.
2588      */
2589     ret->options |= SSL_OP_NO_COMPRESSION;
2590
2591     ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2592
2593     return ret;
2594  err:
2595     SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2596  err2:
2597     SSL_CTX_free(ret);
2598     return NULL;
2599 }
2600
2601 int SSL_CTX_up_ref(SSL_CTX *ctx)
2602 {
2603     int i;
2604
2605     if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2606         return 0;
2607
2608     REF_PRINT_COUNT("SSL_CTX", ctx);
2609     REF_ASSERT_ISNT(i < 2);
2610     return ((i > 1) ? 1 : 0);
2611 }
2612
2613 void SSL_CTX_free(SSL_CTX *a)
2614 {
2615     int i;
2616
2617     if (a == NULL)
2618         return;
2619
2620     CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2621     REF_PRINT_COUNT("SSL_CTX", a);
2622     if (i > 0)
2623         return;
2624     REF_ASSERT_ISNT(i < 0);
2625
2626     X509_VERIFY_PARAM_free(a->param);
2627     dane_ctx_final(&a->dane);
2628
2629     /*
2630      * Free internal session cache. However: the remove_cb() may reference
2631      * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2632      * after the sessions were flushed.
2633      * As the ex_data handling routines might also touch the session cache,
2634      * the most secure solution seems to be: empty (flush) the cache, then
2635      * free ex_data, then finally free the cache.
2636      * (See ticket [openssl.org #212].)
2637      */
2638     if (a->sessions != NULL)
2639         SSL_CTX_flush_sessions(a, 0);
2640
2641     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2642     lh_SSL_SESSION_free(a->sessions);
2643     X509_STORE_free(a->cert_store);
2644 #ifndef OPENSSL_NO_CT
2645     CTLOG_STORE_free(a->ctlog_store);
2646 #endif
2647     sk_SSL_CIPHER_free(a->cipher_list);
2648     sk_SSL_CIPHER_free(a->cipher_list_by_id);
2649     ssl_cert_free(a->cert);
2650     sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2651     sk_X509_pop_free(a->extra_certs, X509_free);
2652     a->comp_methods = NULL;
2653 #ifndef OPENSSL_NO_SRTP
2654     sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2655 #endif
2656 #ifndef OPENSSL_NO_SRP
2657     SSL_CTX_SRP_CTX_free(a);
2658 #endif
2659 #ifndef OPENSSL_NO_ENGINE
2660     ENGINE_finish(a->client_cert_engine);
2661 #endif
2662
2663 #ifndef OPENSSL_NO_EC
2664     OPENSSL_free(a->ext.ecpointformats);
2665     OPENSSL_free(a->ext.supportedgroups);
2666 #endif
2667     OPENSSL_free(a->ext.alpn);
2668
2669     CRYPTO_THREAD_lock_free(a->lock);
2670
2671     OPENSSL_free(a);
2672 }
2673
2674 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2675 {
2676     ctx->default_passwd_callback = cb;
2677 }
2678
2679 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2680 {
2681     ctx->default_passwd_callback_userdata = u;
2682 }
2683
2684 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2685 {
2686     return ctx->default_passwd_callback;
2687 }
2688
2689 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2690 {
2691     return ctx->default_passwd_callback_userdata;
2692 }
2693
2694 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2695 {
2696     s->default_passwd_callback = cb;
2697 }
2698
2699 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2700 {
2701     s->default_passwd_callback_userdata = u;
2702 }
2703
2704 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2705 {
2706     return s->default_passwd_callback;
2707 }
2708
2709 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2710 {
2711     return s->default_passwd_callback_userdata;
2712 }
2713
2714 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2715                                       int (*cb) (X509_STORE_CTX *, void *),
2716                                       void *arg)
2717 {
2718     ctx->app_verify_callback = cb;
2719     ctx->app_verify_arg = arg;
2720 }
2721
2722 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2723                         int (*cb) (int, X509_STORE_CTX *))
2724 {
2725     ctx->verify_mode = mode;
2726     ctx->default_verify_callback = cb;
2727 }
2728
2729 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2730 {
2731     X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2732 }
2733
2734 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2735 {
2736     ssl_cert_set_cert_cb(c->cert, cb, arg);
2737 }
2738
2739 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2740 {
2741     ssl_cert_set_cert_cb(s->cert, cb, arg);
2742 }
2743
2744 void ssl_set_masks(SSL *s)
2745 {
2746     CERT *c = s->cert;
2747     uint32_t *pvalid = s->s3->tmp.valid_flags;
2748     int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2749     unsigned long mask_k, mask_a;
2750 #ifndef OPENSSL_NO_EC
2751     int have_ecc_cert, ecdsa_ok;
2752 #endif
2753     if (c == NULL)
2754         return;
2755
2756 #ifndef OPENSSL_NO_DH
2757     dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2758 #else
2759     dh_tmp = 0;
2760 #endif
2761
2762     rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2763     rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_SIGN;
2764     dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2765 #ifndef OPENSSL_NO_EC
2766     have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2767 #endif
2768     mask_k = 0;
2769     mask_a = 0;
2770
2771 #ifdef CIPHER_DEBUG
2772     fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2773             dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2774 #endif
2775
2776 #ifndef OPENSSL_NO_GOST
2777     if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2778         mask_k |= SSL_kGOST;
2779         mask_a |= SSL_aGOST12;
2780     }
2781     if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2782         mask_k |= SSL_kGOST;
2783         mask_a |= SSL_aGOST12;
2784     }
2785     if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2786         mask_k |= SSL_kGOST;
2787         mask_a |= SSL_aGOST01;
2788     }
2789 #endif
2790
2791     if (rsa_enc)
2792         mask_k |= SSL_kRSA;
2793
2794     if (dh_tmp)
2795         mask_k |= SSL_kDHE;
2796
2797     if (rsa_enc || rsa_sign) {
2798         mask_a |= SSL_aRSA;
2799     }
2800
2801     if (dsa_sign) {
2802         mask_a |= SSL_aDSS;
2803     }
2804
2805     mask_a |= SSL_aNULL;
2806
2807     /*
2808      * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2809      * depending on the key usage extension.
2810      */
2811 #ifndef OPENSSL_NO_EC
2812     if (have_ecc_cert) {
2813         uint32_t ex_kusage;
2814         ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2815         ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2816         if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2817             ecdsa_ok = 0;
2818         if (ecdsa_ok)
2819             mask_a |= SSL_aECDSA;
2820     }
2821 #endif
2822
2823 #ifndef OPENSSL_NO_EC
2824     mask_k |= SSL_kECDHE;
2825 #endif
2826
2827 #ifndef OPENSSL_NO_PSK
2828     mask_k |= SSL_kPSK;
2829     mask_a |= SSL_aPSK;
2830     if (mask_k & SSL_kRSA)
2831         mask_k |= SSL_kRSAPSK;
2832     if (mask_k & SSL_kDHE)
2833         mask_k |= SSL_kDHEPSK;
2834     if (mask_k & SSL_kECDHE)
2835         mask_k |= SSL_kECDHEPSK;
2836 #endif
2837
2838     s->s3->tmp.mask_k = mask_k;
2839     s->s3->tmp.mask_a = mask_a;
2840 }
2841
2842 #ifndef OPENSSL_NO_EC
2843
2844 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2845 {
2846     if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2847         /* key usage, if present, must allow signing */
2848         if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2849             SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2850                    SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2851             return 0;
2852         }
2853     }
2854     return 1;                   /* all checks are ok */
2855 }
2856
2857 #endif
2858
2859 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2860                                    size_t *serverinfo_length)
2861 {
2862     CERT_PKEY *cpk = s->s3->tmp.cert;
2863     *serverinfo_length = 0;
2864
2865     if (cpk == NULL || cpk->serverinfo == NULL)
2866         return 0;
2867
2868     *serverinfo = cpk->serverinfo;
2869     *serverinfo_length = cpk->serverinfo_length;
2870     return 1;
2871 }
2872
2873 void ssl_update_cache(SSL *s, int mode)
2874 {
2875     int i;
2876
2877     /*
2878      * If the session_id_length is 0, we are not supposed to cache it, and it
2879      * would be rather hard to do anyway :-)
2880      */
2881     if (s->session->session_id_length == 0)
2882         return;
2883
2884     i = s->session_ctx->session_cache_mode;
2885     if ((i & mode) && (!s->hit)
2886         && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2887             || SSL_CTX_add_session(s->session_ctx, s->session))
2888         && (s->session_ctx->new_session_cb != NULL)) {
2889         SSL_SESSION_up_ref(s->session);
2890         if (!s->session_ctx->new_session_cb(s, s->session))
2891             SSL_SESSION_free(s->session);
2892     }
2893
2894     /* auto flush every 255 connections */
2895     if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2896         if ((((mode & SSL_SESS_CACHE_CLIENT)
2897               ? s->session_ctx->stats.sess_connect_good
2898               : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2899             SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2900         }
2901     }
2902 }
2903
2904 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2905 {
2906     return ctx->method;
2907 }
2908
2909 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2910 {
2911     return (s->method);
2912 }
2913
2914 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2915 {
2916     int ret = 1;
2917
2918     if (s->method != meth) {
2919         const SSL_METHOD *sm = s->method;
2920         int (*hf) (SSL *) = s->handshake_func;
2921
2922         if (sm->version == meth->version)
2923             s->method = meth;
2924         else {
2925             sm->ssl_free(s);
2926             s->method = meth;
2927             ret = s->method->ssl_new(s);
2928         }
2929
2930         if (hf == sm->ssl_connect)
2931             s->handshake_func = meth->ssl_connect;
2932         else if (hf == sm->ssl_accept)
2933             s->handshake_func = meth->ssl_accept;
2934     }
2935     return (ret);
2936 }
2937
2938 int SSL_get_error(const SSL *s, int i)
2939 {
2940     int reason;
2941     unsigned long l;
2942     BIO *bio;
2943
2944     if (i > 0)
2945         return (SSL_ERROR_NONE);
2946
2947     /*
2948      * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2949      * where we do encode the error
2950      */
2951     if ((l = ERR_peek_error()) != 0) {
2952         if (ERR_GET_LIB(l) == ERR_LIB_SYS)
2953             return (SSL_ERROR_SYSCALL);
2954         else
2955             return (SSL_ERROR_SSL);
2956     }
2957
2958     if (SSL_want_read(s)) {
2959         bio = SSL_get_rbio(s);
2960         if (BIO_should_read(bio))
2961             return (SSL_ERROR_WANT_READ);
2962         else if (BIO_should_write(bio))
2963             /*
2964              * This one doesn't make too much sense ... We never try to write
2965              * to the rbio, and an application program where rbio and wbio
2966              * are separate couldn't even know what it should wait for.
2967              * However if we ever set s->rwstate incorrectly (so that we have
2968              * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
2969              * wbio *are* the same, this test works around that bug; so it
2970              * might be safer to keep it.
2971              */
2972             return (SSL_ERROR_WANT_WRITE);
2973         else if (BIO_should_io_special(bio)) {
2974             reason = BIO_get_retry_reason(bio);
2975             if (reason == BIO_RR_CONNECT)
2976                 return (SSL_ERROR_WANT_CONNECT);
2977             else if (reason == BIO_RR_ACCEPT)
2978                 return (SSL_ERROR_WANT_ACCEPT);
2979             else
2980                 return (SSL_ERROR_SYSCALL); /* unknown */
2981         }
2982     }
2983
2984     if (SSL_want_write(s)) {
2985         /*
2986          * Access wbio directly - in order to use the buffered bio if
2987          * present
2988          */
2989         bio = s->wbio;
2990         if (BIO_should_write(bio))
2991             return (SSL_ERROR_WANT_WRITE);
2992         else if (BIO_should_read(bio))
2993             /*
2994              * See above (SSL_want_read(s) with BIO_should_write(bio))
2995              */
2996             return (SSL_ERROR_WANT_READ);
2997         else if (BIO_should_io_special(bio)) {
2998             reason = BIO_get_retry_reason(bio);
2999             if (reason == BIO_RR_CONNECT)
3000                 return (SSL_ERROR_WANT_CONNECT);
3001             else if (reason == BIO_RR_ACCEPT)
3002                 return (SSL_ERROR_WANT_ACCEPT);
3003             else
3004                 return (SSL_ERROR_SYSCALL);
3005         }
3006     }
3007     if (SSL_want_x509_lookup(s)) {
3008         return (SSL_ERROR_WANT_X509_LOOKUP);
3009     }
3010     if (SSL_want_async(s)) {
3011         return SSL_ERROR_WANT_ASYNC;
3012     }
3013     if (SSL_want_async_job(s)) {
3014         return SSL_ERROR_WANT_ASYNC_JOB;
3015     }
3016
3017     if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3018         (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3019         return (SSL_ERROR_ZERO_RETURN);
3020
3021     return (SSL_ERROR_SYSCALL);
3022 }
3023
3024 static int ssl_do_handshake_intern(void *vargs)
3025 {
3026     struct ssl_async_args *args;
3027     SSL *s;
3028
3029     args = (struct ssl_async_args *)vargs;
3030     s = args->s;
3031
3032     return s->handshake_func(s);
3033 }
3034
3035 int SSL_do_handshake(SSL *s)
3036 {
3037     int ret = 1;
3038
3039     if (s->handshake_func == NULL) {
3040         SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3041         return -1;
3042     }
3043
3044     s->method->ssl_renegotiate_check(s, 0);
3045
3046     if (SSL_in_init(s) || SSL_in_before(s)) {
3047         if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3048             struct ssl_async_args args;
3049
3050             args.s = s;
3051
3052             ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3053         } else {
3054             ret = s->handshake_func(s);
3055         }
3056     }
3057     return ret;
3058 }
3059
3060 void SSL_set_accept_state(SSL *s)
3061 {
3062     s->server = 1;
3063     s->shutdown = 0;
3064     ossl_statem_clear(s);
3065     s->handshake_func = s->method->ssl_accept;
3066     clear_ciphers(s);
3067 }
3068
3069 void SSL_set_connect_state(SSL *s)
3070 {
3071     s->server = 0;
3072     s->shutdown = 0;
3073     ossl_statem_clear(s);
3074     s->handshake_func = s->method->ssl_connect;
3075     clear_ciphers(s);
3076 }
3077
3078 int ssl_undefined_function(SSL *s)
3079 {
3080     SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3081     return (0);
3082 }
3083
3084 int ssl_undefined_void_function(void)
3085 {
3086     SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3087            ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3088     return (0);
3089 }
3090
3091 int ssl_undefined_const_function(const SSL *s)
3092 {
3093     return (0);
3094 }
3095
3096 const SSL_METHOD *ssl_bad_method(int ver)
3097 {
3098     SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3099     return (NULL);
3100 }
3101
3102 const char *ssl_protocol_to_string(int version)
3103 {
3104     switch(version)
3105     {
3106     case TLS1_3_VERSION:
3107         return "TLSv1.3";
3108
3109     case TLS1_2_VERSION:
3110         return "TLSv1.2";
3111
3112     case TLS1_1_VERSION:
3113         return "TLSv1.1";
3114
3115     case TLS1_VERSION:
3116         return "TLSv1";
3117
3118     case SSL3_VERSION:
3119         return "SSLv3";
3120
3121     case DTLS1_BAD_VER:
3122         return "DTLSv0.9";
3123
3124     case DTLS1_VERSION:
3125         return "DTLSv1";
3126
3127     case DTLS1_2_VERSION:
3128         return "DTLSv1.2";
3129
3130     default:
3131         return "unknown";
3132     }
3133 }
3134
3135 const char *SSL_get_version(const SSL *s)
3136 {
3137     return ssl_protocol_to_string(s->version);
3138 }
3139
3140 SSL *SSL_dup(SSL *s)
3141 {
3142     STACK_OF(X509_NAME) *sk;
3143     X509_NAME *xn;
3144     SSL *ret;
3145     int i;
3146
3147     /* If we're not quiescent, just up_ref! */
3148     if (!SSL_in_init(s) || !SSL_in_before(s)) {
3149         CRYPTO_UP_REF(&s->references, &i, s->lock);
3150         return s;
3151     }
3152
3153     /*
3154      * Otherwise, copy configuration state, and session if set.
3155      */
3156     if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3157         return (NULL);
3158
3159     if (s->session != NULL) {
3160         /*
3161          * Arranges to share the same session via up_ref.  This "copies"
3162          * session-id, SSL_METHOD, sid_ctx, and 'cert'
3163          */
3164         if (!SSL_copy_session_id(ret, s))
3165             goto err;
3166     } else {
3167         /*
3168          * No session has been established yet, so we have to expect that
3169          * s->cert or ret->cert will be changed later -- they should not both
3170          * point to the same object, and thus we can't use
3171          * SSL_copy_session_id.
3172          */
3173         if (!SSL_set_ssl_method(ret, s->method))
3174             goto err;
3175
3176         if (s->cert != NULL) {
3177             ssl_cert_free(ret->cert);
3178             ret->cert = ssl_cert_dup(s->cert);
3179             if (ret->cert == NULL)
3180                 goto err;
3181         }
3182
3183         if (!SSL_set_session_id_context(ret, s->sid_ctx,
3184                                         (int)s->sid_ctx_length))
3185             goto err;
3186     }
3187
3188     if (!ssl_dane_dup(ret, s))
3189         goto err;
3190     ret->version = s->version;
3191     ret->options = s->options;
3192     ret->mode = s->mode;
3193     SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3194     SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3195     ret->msg_callback = s->msg_callback;
3196     ret->msg_callback_arg = s->msg_callback_arg;
3197     SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3198     SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3199     ret->generate_session_id = s->generate_session_id;
3200
3201     SSL_set_info_callback(ret, SSL_get_info_callback(s));
3202
3203     /* copy app data, a little dangerous perhaps */
3204     if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3205         goto err;
3206
3207     /* setup rbio, and wbio */
3208     if (s->rbio != NULL) {
3209         if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3210             goto err;
3211     }
3212     if (s->wbio != NULL) {
3213         if (s->wbio != s->rbio) {
3214             if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3215                 goto err;
3216         } else {
3217             BIO_up_ref(ret->rbio);
3218             ret->wbio = ret->rbio;
3219         }
3220     }
3221
3222     ret->server = s->server;
3223     if (s->handshake_func) {
3224         if (s->server)
3225             SSL_set_accept_state(ret);
3226         else
3227             SSL_set_connect_state(ret);
3228     }
3229     ret->shutdown = s->shutdown;
3230     ret->hit = s->hit;
3231
3232     ret->default_passwd_callback = s->default_passwd_callback;
3233     ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3234
3235     X509_VERIFY_PARAM_inherit(ret->param, s->param);
3236
3237     /* dup the cipher_list and cipher_list_by_id stacks */
3238     if (s->cipher_list != NULL) {
3239         if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3240             goto err;
3241     }
3242     if (s->cipher_list_by_id != NULL)
3243         if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3244             == NULL)
3245             goto err;
3246
3247     /* Dup the client_CA list */
3248     if (s->client_CA != NULL) {
3249         if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3250             goto err;
3251         ret->client_CA = sk;
3252         for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3253             xn = sk_X509_NAME_value(sk, i);
3254             if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3255                 X509_NAME_free(xn);
3256                 goto err;
3257             }
3258         }
3259     }
3260     return ret;
3261
3262  err:
3263     SSL_free(ret);
3264     return NULL;
3265 }
3266
3267 void ssl_clear_cipher_ctx(SSL *s)
3268 {
3269     if (s->enc_read_ctx != NULL) {
3270         EVP_CIPHER_CTX_free(s->enc_read_ctx);
3271         s->enc_read_ctx = NULL;
3272     }
3273     if (s->enc_write_ctx != NULL) {
3274         EVP_CIPHER_CTX_free(s->enc_write_ctx);
3275         s->enc_write_ctx = NULL;
3276     }
3277 #ifndef OPENSSL_NO_COMP
3278     COMP_CTX_free(s->expand);
3279     s->expand = NULL;
3280     COMP_CTX_free(s->compress);
3281     s->compress = NULL;
3282 #endif
3283 }
3284
3285 X509 *SSL_get_certificate(const SSL *s)
3286 {
3287     if (s->cert != NULL)
3288         return (s->cert->key->x509);
3289     else
3290         return (NULL);
3291 }
3292
3293 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3294 {
3295     if (s->cert != NULL)
3296         return (s->cert->key->privatekey);
3297     else
3298         return (NULL);
3299 }
3300
3301 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3302 {
3303     if (ctx->cert != NULL)
3304         return ctx->cert->key->x509;
3305     else
3306         return NULL;
3307 }
3308
3309 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3310 {
3311     if (ctx->cert != NULL)
3312         return ctx->cert->key->privatekey;
3313     else
3314         return NULL;
3315 }
3316
3317 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3318 {
3319     if ((s->session != NULL) && (s->session->cipher != NULL))
3320         return (s->session->cipher);
3321     return (NULL);
3322 }
3323
3324 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3325 {
3326 #ifndef OPENSSL_NO_COMP
3327     return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3328 #else
3329     return NULL;
3330 #endif
3331 }
3332
3333 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3334 {
3335 #ifndef OPENSSL_NO_COMP
3336     return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3337 #else
3338     return NULL;
3339 #endif
3340 }
3341
3342 int ssl_init_wbio_buffer(SSL *s)
3343 {
3344     BIO *bbio;
3345
3346     if (s->bbio != NULL) {
3347         /* Already buffered. */
3348         return 1;
3349     }
3350
3351     bbio = BIO_new(BIO_f_buffer());
3352     if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3353         BIO_free(bbio);
3354         SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3355         return 0;
3356     }
3357     s->bbio = bbio;
3358     s->wbio = BIO_push(bbio, s->wbio);
3359
3360     return 1;
3361 }
3362
3363 void ssl_free_wbio_buffer(SSL *s)
3364 {
3365     /* callers ensure s is never null */
3366     if (s->bbio == NULL)
3367         return;
3368
3369     s->wbio = BIO_pop(s->wbio);
3370     assert(s->wbio != NULL);
3371     BIO_free(s->bbio);
3372     s->bbio = NULL;
3373 }
3374
3375 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3376 {
3377     ctx->quiet_shutdown = mode;
3378 }
3379
3380 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3381 {
3382     return (ctx->quiet_shutdown);
3383 }
3384
3385 void SSL_set_quiet_shutdown(SSL *s, int mode)
3386 {
3387     s->quiet_shutdown = mode;
3388 }
3389
3390 int SSL_get_quiet_shutdown(const SSL *s)
3391 {
3392     return (s->quiet_shutdown);
3393 }
3394
3395 void SSL_set_shutdown(SSL *s, int mode)
3396 {
3397     s->shutdown = mode;
3398 }
3399
3400 int SSL_get_shutdown(const SSL *s)
3401 {
3402     return s->shutdown;
3403 }
3404
3405 int SSL_version(const SSL *s)
3406 {
3407     return s->version;
3408 }
3409
3410 int SSL_client_version(const SSL *s)
3411 {
3412     return s->client_version;
3413 }
3414
3415 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3416 {
3417     return ssl->ctx;
3418 }
3419
3420 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3421 {
3422     CERT *new_cert;
3423     if (ssl->ctx == ctx)
3424         return ssl->ctx;
3425     if (ctx == NULL)
3426         ctx = ssl->session_ctx;
3427     new_cert = ssl_cert_dup(ctx->cert);
3428     if (new_cert == NULL) {
3429         return NULL;
3430     }
3431     ssl_cert_free(ssl->cert);
3432     ssl->cert = new_cert;
3433
3434     /*
3435      * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3436      * so setter APIs must prevent invalid lengths from entering the system.
3437      */
3438     OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3439
3440     /*
3441      * If the session ID context matches that of the parent SSL_CTX,
3442      * inherit it from the new SSL_CTX as well. If however the context does
3443      * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3444      * leave it unchanged.
3445      */
3446     if ((ssl->ctx != NULL) &&
3447         (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3448         (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3449         ssl->sid_ctx_length = ctx->sid_ctx_length;
3450         memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3451     }
3452
3453     SSL_CTX_up_ref(ctx);
3454     SSL_CTX_free(ssl->ctx);     /* decrement reference count */
3455     ssl->ctx = ctx;
3456
3457     return ssl->ctx;
3458 }
3459
3460 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3461 {
3462     return (X509_STORE_set_default_paths(ctx->cert_store));
3463 }
3464
3465 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3466 {
3467     X509_LOOKUP *lookup;
3468
3469     lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3470     if (lookup == NULL)
3471         return 0;
3472     X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3473
3474     /* Clear any errors if the default directory does not exist */
3475     ERR_clear_error();
3476
3477     return 1;
3478 }
3479
3480 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3481 {
3482     X509_LOOKUP *lookup;
3483
3484     lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3485     if (lookup == NULL)
3486         return 0;
3487
3488     X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3489
3490     /* Clear any errors if the default file does not exist */
3491     ERR_clear_error();
3492
3493     return 1;
3494 }
3495
3496 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3497                                   const char *CApath)
3498 {
3499     return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3500 }
3501
3502 void SSL_set_info_callback(SSL *ssl,
3503                            void (*cb) (const SSL *ssl, int type, int val))
3504 {
3505     ssl->info_callback = cb;
3506 }
3507
3508 /*
3509  * One compiler (Diab DCC) doesn't like argument names in returned function
3510  * pointer.
3511  */
3512 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3513                                                int /* type */ ,
3514                                                int /* val */ ) {
3515     return ssl->info_callback;
3516 }
3517
3518 void SSL_set_verify_result(SSL *ssl, long arg)
3519 {
3520     ssl->verify_result = arg;
3521 }
3522
3523 long SSL_get_verify_result(const SSL *ssl)
3524 {
3525     return (ssl->verify_result);
3526 }
3527
3528 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3529 {
3530     if (outlen == 0)
3531         return sizeof(ssl->s3->client_random);
3532     if (outlen > sizeof(ssl->s3->client_random))
3533         outlen = sizeof(ssl->s3->client_random);
3534     memcpy(out, ssl->s3->client_random, outlen);
3535     return outlen;
3536 }
3537
3538 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3539 {
3540     if (outlen == 0)
3541         return sizeof(ssl->s3->server_random);
3542     if (outlen > sizeof(ssl->s3->server_random))
3543         outlen = sizeof(ssl->s3->server_random);
3544     memcpy(out, ssl->s3->server_random, outlen);
3545     return outlen;
3546 }
3547
3548 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3549                                   unsigned char *out, size_t outlen)
3550 {
3551     if (outlen == 0)
3552         return session->master_key_length;
3553     if (outlen > session->master_key_length)
3554         outlen = session->master_key_length;
3555     memcpy(out, session->master_key, outlen);
3556     return outlen;
3557 }
3558
3559 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3560 {
3561     return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3562 }
3563
3564 void *SSL_get_ex_data(const SSL *s, int idx)
3565 {
3566     return (CRYPTO_get_ex_data(&s->ex_data, idx));
3567 }
3568
3569 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3570 {
3571     return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3572 }
3573
3574 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3575 {
3576     return (CRYPTO_get_ex_data(&s->ex_data, idx));
3577 }
3578
3579 int ssl_ok(SSL *s)
3580 {
3581     return (1);
3582 }
3583
3584 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3585 {
3586     return (ctx->cert_store);
3587 }
3588
3589 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3590 {
3591     X509_STORE_free(ctx->cert_store);
3592     ctx->cert_store = store;
3593 }
3594
3595 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3596 {
3597     if (store != NULL)
3598         X509_STORE_up_ref(store);
3599     SSL_CTX_set_cert_store(ctx, store);
3600 }
3601
3602 int SSL_want(const SSL *s)
3603 {
3604     return (s->rwstate);
3605 }
3606
3607 /**
3608  * \brief Set the callback for generating temporary DH keys.
3609  * \param ctx the SSL context.
3610  * \param dh the callback
3611  */
3612
3613 #ifndef OPENSSL_NO_DH
3614 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3615                                  DH *(*dh) (SSL *ssl, int is_export,
3616                                             int keylength))
3617 {
3618     SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3619 }
3620
3621 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3622                                                   int keylength))
3623 {
3624     SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3625 }
3626 #endif
3627
3628 #ifndef OPENSSL_NO_PSK
3629 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3630 {
3631     if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3632         SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3633         return 0;
3634     }
3635     OPENSSL_free(ctx->cert->psk_identity_hint);
3636     if (identity_hint != NULL) {
3637         ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3638         if (ctx->cert->psk_identity_hint == NULL)
3639             return 0;
3640     } else
3641         ctx->cert->psk_identity_hint = NULL;
3642     return 1;
3643 }
3644
3645 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3646 {
3647     if (s == NULL)
3648         return 0;
3649
3650     if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3651         SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3652         return 0;
3653     }
3654     OPENSSL_free(s->cert->psk_identity_hint);
3655     if (identity_hint != NULL) {
3656         s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3657         if (s->cert->psk_identity_hint == NULL)
3658             return 0;
3659     } else
3660         s->cert->psk_identity_hint = NULL;
3661     return 1;
3662 }
3663
3664 const char *SSL_get_psk_identity_hint(const SSL *s)
3665 {
3666     if (s == NULL || s->session == NULL)
3667         return NULL;
3668     return (s->session->psk_identity_hint);
3669 }
3670
3671 const char *SSL_get_psk_identity(const SSL *s)
3672 {
3673     if (s == NULL || s->session == NULL)
3674         return NULL;
3675     return (s->session->psk_identity);
3676 }
3677
3678 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3679 {
3680     s->psk_client_callback = cb;
3681 }
3682
3683 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3684 {
3685     ctx->psk_client_callback = cb;
3686 }
3687
3688 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3689 {
3690     s->psk_server_callback = cb;
3691 }
3692
3693 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3694 {
3695     ctx->psk_server_callback = cb;
3696 }
3697 #endif
3698
3699 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3700                               void (*cb) (int write_p, int version,
3701                                           int content_type, const void *buf,
3702                                           size_t len, SSL *ssl, void *arg))
3703 {
3704     SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3705 }
3706
3707 void SSL_set_msg_callback(SSL *ssl,
3708                           void (*cb) (int write_p, int version,
3709                                       int content_type, const void *buf,
3710                                       size_t len, SSL *ssl, void *arg))
3711 {
3712     SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3713 }
3714
3715 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3716                                                 int (*cb) (SSL *ssl,
3717                                                            int
3718                                                            is_forward_secure))
3719 {
3720     SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3721                           (void (*)(void))cb);
3722 }
3723
3724 void SSL_set_not_resumable_session_callback(SSL *ssl,
3725                                             int (*cb) (SSL *ssl,
3726                                                        int is_forward_secure))
3727 {
3728     SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3729                       (void (*)(void))cb);
3730 }
3731
3732 /*
3733  * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3734  * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3735  * If EVP_MD pointer is passed, initializes ctx with this md.
3736  * Returns the newly allocated ctx;
3737  */
3738
3739 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3740 {
3741     ssl_clear_hash_ctx(hash);
3742     *hash = EVP_MD_CTX_new();
3743     if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3744         EVP_MD_CTX_free(*hash);
3745         *hash = NULL;
3746         return NULL;
3747     }
3748     return *hash;
3749 }
3750
3751 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3752 {
3753
3754     EVP_MD_CTX_free(*hash);
3755     *hash = NULL;
3756 }
3757
3758 /* Retrieve handshake hashes */
3759 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3760                        size_t *hashlen)
3761 {
3762     EVP_MD_CTX *ctx = NULL;
3763     EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3764     int hashleni = EVP_MD_CTX_size(hdgst);
3765     int ret = 0;
3766
3767     if (hashleni < 0 || (size_t)hashleni > outlen)
3768         goto err;
3769
3770     ctx = EVP_MD_CTX_new();
3771     if (ctx == NULL)
3772         goto err;
3773
3774     if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3775         || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3776         goto err;
3777
3778     *hashlen = hashleni;
3779
3780     ret = 1;
3781  err:
3782     EVP_MD_CTX_free(ctx);
3783     return ret;
3784 }
3785
3786 int SSL_session_reused(SSL *s)
3787 {
3788     return s->hit;
3789 }
3790
3791 int SSL_is_server(SSL *s)
3792 {
3793     return s->server;
3794 }
3795
3796 #if OPENSSL_API_COMPAT < 0x10100000L
3797 void SSL_set_debug(SSL *s, int debug)
3798 {
3799     /* Old function was do-nothing anyway... */
3800     (void)s;
3801     (void)debug;
3802 }
3803 #endif
3804
3805 void SSL_set_security_level(SSL *s, int level)
3806 {
3807     s->cert->sec_level = level;
3808 }
3809
3810 int SSL_get_security_level(const SSL *s)
3811 {
3812     return s->cert->sec_level;
3813 }
3814
3815 void SSL_set_security_callback(SSL *s,
3816                                int (*cb) (const SSL *s, const SSL_CTX *ctx,
3817                                           int op, int bits, int nid,
3818                                           void *other, void *ex))
3819 {
3820     s->cert->sec_cb = cb;
3821 }
3822
3823 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3824                                                 const SSL_CTX *ctx, int op,
3825                                                 int bits, int nid, void *other,
3826                                                 void *ex) {
3827     return s->cert->sec_cb;
3828 }
3829
3830 void SSL_set0_security_ex_data(SSL *s, void *ex)
3831 {
3832     s->cert->sec_ex = ex;
3833 }
3834
3835 void *SSL_get0_security_ex_data(const SSL *s)
3836 {
3837     return s->cert->sec_ex;
3838 }
3839
3840 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3841 {
3842     ctx->cert->sec_level = level;
3843 }
3844
3845 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3846 {
3847     return ctx->cert->sec_level;
3848 }
3849
3850 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3851                                    int (*cb) (const SSL *s, const SSL_CTX *ctx,
3852                                               int op, int bits, int nid,
3853                                               void *other, void *ex))
3854 {
3855     ctx->cert->sec_cb = cb;
3856 }
3857
3858 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3859                                                           const SSL_CTX *ctx,
3860                                                           int op, int bits,
3861                                                           int nid,
3862                                                           void *other,
3863                                                           void *ex) {
3864     return ctx->cert->sec_cb;
3865 }
3866
3867 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3868 {
3869     ctx->cert->sec_ex = ex;
3870 }
3871
3872 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3873 {
3874     return ctx->cert->sec_ex;
3875 }
3876
3877 /*
3878  * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3879  * can return unsigned long, instead of the generic long return value from the
3880  * control interface.
3881  */
3882 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3883 {
3884     return ctx->options;
3885 }
3886
3887 unsigned long SSL_get_options(const SSL *s)
3888 {
3889     return s->options;
3890 }
3891
3892 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3893 {
3894     return ctx->options |= op;
3895 }
3896
3897 unsigned long SSL_set_options(SSL *s, unsigned long op)
3898 {
3899     return s->options |= op;
3900 }
3901
3902 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3903 {
3904     return ctx->options &= ~op;
3905 }
3906
3907 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3908 {
3909     return s->options &= ~op;
3910 }
3911
3912 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3913 {
3914     return s->verified_chain;
3915 }
3916
3917 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3918
3919 #ifndef OPENSSL_NO_CT
3920
3921 /*
3922  * Moves SCTs from the |src| stack to the |dst| stack.
3923  * The source of each SCT will be set to |origin|.
3924  * If |dst| points to a NULL pointer, a new stack will be created and owned by
3925  * the caller.
3926  * Returns the number of SCTs moved, or a negative integer if an error occurs.
3927  */
3928 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
3929                         sct_source_t origin)
3930 {
3931     int scts_moved = 0;
3932     SCT *sct = NULL;
3933
3934     if (*dst == NULL) {
3935         *dst = sk_SCT_new_null();
3936         if (*dst == NULL) {
3937             SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3938             goto err;
3939         }
3940     }
3941
3942     while ((sct = sk_SCT_pop(src)) != NULL) {
3943         if (SCT_set_source(sct, origin) != 1)
3944             goto err;
3945
3946         if (sk_SCT_push(*dst, sct) <= 0)
3947             goto err;
3948         scts_moved += 1;
3949     }
3950
3951     return scts_moved;
3952  err:
3953     if (sct != NULL)
3954         sk_SCT_push(src, sct);  /* Put the SCT back */
3955     return -1;
3956 }
3957
3958 /*
3959  * Look for data collected during ServerHello and parse if found.
3960  * Returns the number of SCTs extracted.
3961  */
3962 static int ct_extract_tls_extension_scts(SSL *s)
3963 {
3964     int scts_extracted = 0;
3965
3966     if (s->ext.scts != NULL) {
3967         const unsigned char *p = s->ext.scts;
3968         STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
3969
3970         scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
3971
3972         SCT_LIST_free(scts);
3973     }
3974
3975     return scts_extracted;
3976 }
3977
3978 /*
3979  * Checks for an OCSP response and then attempts to extract any SCTs found if it
3980  * contains an SCT X509 extension. They will be stored in |s->scts|.
3981  * Returns:
3982  * - The number of SCTs extracted, assuming an OCSP response exists.
3983  * - 0 if no OCSP response exists or it contains no SCTs.
3984  * - A negative integer if an error occurs.
3985  */
3986 static int ct_extract_ocsp_response_scts(SSL *s)
3987 {
3988 # ifndef OPENSSL_NO_OCSP
3989     int scts_extracted = 0;
3990     const unsigned char *p;
3991     OCSP_BASICRESP *br = NULL;
3992     OCSP_RESPONSE *rsp = NULL;
3993     STACK_OF(SCT) *scts = NULL;
3994     int i;
3995
3996     if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
3997         goto err;
3998
3999     p = s->ext.ocsp.resp;
4000     rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4001     if (rsp == NULL)
4002         goto err;
4003
4004     br = OCSP_response_get1_basic(rsp);
4005     if (br == NULL)
4006         goto err;
4007
4008     for (i = 0; i < OCSP_resp_count(br); ++i) {
4009         OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4010
4011         if (single == NULL)
4012             continue;
4013
4014         scts =
4015             OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4016         scts_extracted =
4017             ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4018         if (scts_extracted < 0)
4019             goto err;
4020     }
4021  err:
4022     SCT_LIST_free(scts);
4023     OCSP_BASICRESP_free(br);
4024     OCSP_RESPONSE_free(rsp);
4025     return scts_extracted;
4026 # else
4027     /* Behave as if no OCSP response exists */
4028     return 0;
4029 # endif
4030 }
4031
4032 /*
4033  * Attempts to extract SCTs from the peer certificate.
4034  * Return the number of SCTs extracted, or a negative integer if an error
4035  * occurs.
4036  */
4037 static int ct_extract_x509v3_extension_scts(SSL *s)
4038 {
4039     int scts_extracted = 0;
4040     X509 *cert = s->session != NULL ? s->session->peer : NULL;
4041
4042     if (cert != NULL) {
4043         STACK_OF(SCT) *scts =
4044             X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4045
4046         scts_extracted =
4047             ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4048
4049         SCT_LIST_free(scts);
4050     }
4051
4052     return scts_extracted;
4053 }
4054
4055 /*
4056  * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4057  * response (if it exists) and X509v3 extensions in the certificate.
4058  * Returns NULL if an error occurs.
4059  */
4060 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4061 {
4062     if (!s->scts_parsed) {
4063         if (ct_extract_tls_extension_scts(s) < 0 ||
4064             ct_extract_ocsp_response_scts(s) < 0 ||
4065             ct_extract_x509v3_extension_scts(s) < 0)
4066             goto err;
4067
4068         s->scts_parsed = 1;
4069     }
4070     return s->scts;
4071  err:
4072     return NULL;
4073 }
4074
4075 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4076                          const STACK_OF(SCT) *scts, void *unused_arg)
4077 {
4078     return 1;
4079 }
4080
4081 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4082                      const STACK_OF(SCT) *scts, void *unused_arg)
4083 {
4084     int count = scts != NULL ? sk_SCT_num(scts) : 0;
4085     int i;
4086
4087     for (i = 0; i < count; ++i) {
4088         SCT *sct = sk_SCT_value(scts, i);
4089         int status = SCT_get_validation_status(sct);
4090
4091         if (status == SCT_VALIDATION_STATUS_VALID)
4092             return 1;
4093     }
4094     SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4095     return 0;
4096 }
4097
4098 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4099                                    void *arg)
4100 {
4101     /*
4102      * Since code exists that uses the custom extension handler for CT, look
4103      * for this and throw an error if they have already registered to use CT.
4104      */
4105     if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4106                                                           TLSEXT_TYPE_signed_certificate_timestamp))
4107     {
4108         SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4109                SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4110         return 0;
4111     }
4112
4113     if (callback != NULL) {
4114         /*
4115          * If we are validating CT, then we MUST accept SCTs served via OCSP
4116          */
4117         if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4118             return 0;
4119     }
4120
4121     s->ct_validation_callback = callback;
4122     s->ct_validation_callback_arg = arg;
4123
4124     return 1;
4125 }
4126
4127 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4128                                        ssl_ct_validation_cb callback, void *arg)
4129 {
4130     /*
4131      * Since code exists that uses the custom extension handler for CT, look for
4132      * this and throw an error if they have already registered to use CT.
4133      */
4134     if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4135                                                           TLSEXT_TYPE_signed_certificate_timestamp))
4136     {
4137         SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4138                SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4139         return 0;
4140     }
4141
4142     ctx->ct_validation_callback = callback;
4143     ctx->ct_validation_callback_arg = arg;
4144     return 1;
4145 }
4146
4147 int SSL_ct_is_enabled(const SSL *s)
4148 {
4149     return s->ct_validation_callback != NULL;
4150 }
4151
4152 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4153 {
4154     return ctx->ct_validation_callback != NULL;
4155 }
4156
4157 int ssl_validate_ct(SSL *s)
4158 {
4159     int ret = 0;
4160     X509 *cert = s->session != NULL ? s->session->peer : NULL;
4161     X509 *issuer;
4162     SSL_DANE *dane = &s->dane;
4163     CT_POLICY_EVAL_CTX *ctx = NULL;
4164     const STACK_OF(SCT) *scts;
4165
4166     /*
4167      * If no callback is set, the peer is anonymous, or its chain is invalid,
4168      * skip SCT validation - just return success.  Applications that continue
4169      * handshakes without certificates, with unverified chains, or pinned leaf
4170      * certificates are outside the scope of the WebPKI and CT.
4171      *
4172      * The above exclusions notwithstanding the vast majority of peers will
4173      * have rather ordinary certificate chains validated by typical
4174      * applications that perform certificate verification and therefore will
4175      * process SCTs when enabled.
4176      */
4177     if (s->ct_validation_callback == NULL || cert == NULL ||
4178         s->verify_result != X509_V_OK ||
4179         s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4180         return 1;
4181
4182     /*
4183      * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4184      * trust-anchors.  See https://tools.ietf.org/html/rfc7671#section-4.2
4185      */
4186     if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4187         switch (dane->mtlsa->usage) {
4188         case DANETLS_USAGE_DANE_TA:
4189         case DANETLS_USAGE_DANE_EE:
4190             return 1;
4191         }
4192     }
4193
4194     ctx = CT_POLICY_EVAL_CTX_new();
4195     if (ctx == NULL) {
4196         SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4197         goto end;
4198     }
4199
4200     issuer = sk_X509_value(s->verified_chain, 1);
4201     CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4202     CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4203     CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4204     CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4205
4206     scts = SSL_get0_peer_scts(s);
4207
4208     /*
4209      * This function returns success (> 0) only when all the SCTs are valid, 0
4210      * when some are invalid, and < 0 on various internal errors (out of
4211      * memory, etc.).  Having some, or even all, invalid SCTs is not sufficient
4212      * reason to abort the handshake, that decision is up to the callback.
4213      * Therefore, we error out only in the unexpected case that the return
4214      * value is negative.
4215      *
4216      * XXX: One might well argue that the return value of this function is an
4217      * unfortunate design choice.  Its job is only to determine the validation
4218      * status of each of the provided SCTs.  So long as it correctly separates
4219      * the wheat from the chaff it should return success.  Failure in this case
4220      * ought to correspond to an inability to carry out its duties.
4221      */
4222     if (SCT_LIST_validate(scts, ctx) < 0) {
4223         SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4224         goto end;
4225     }
4226
4227     ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4228     if (ret < 0)
4229         ret = 0;                /* This function returns 0 on failure */
4230
4231  end:
4232     CT_POLICY_EVAL_CTX_free(ctx);
4233     /*
4234      * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4235      * failure return code here.  Also the application may wish the complete
4236      * the handshake, and then disconnect cleanly at a higher layer, after
4237      * checking the verification status of the completed connection.
4238      *
4239      * We therefore force a certificate verification failure which will be
4240      * visible via SSL_get_verify_result() and cached as part of any resumed
4241      * session.
4242      *
4243      * Note: the permissive callback is for information gathering only, always
4244      * returns success, and does not affect verification status.  Only the
4245      * strict callback or a custom application-specified callback can trigger
4246      * connection failure or record a verification error.
4247      */
4248     if (ret <= 0)
4249         s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4250     return ret;
4251 }
4252
4253 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4254 {
4255     switch (validation_mode) {
4256     default:
4257         SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4258         return 0;
4259     case SSL_CT_VALIDATION_PERMISSIVE:
4260         return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4261     case SSL_CT_VALIDATION_STRICT:
4262         return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4263     }
4264 }
4265
4266 int SSL_enable_ct(SSL *s, int validation_mode)
4267 {
4268     switch (validation_mode) {
4269     default:
4270         SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4271         return 0;
4272     case SSL_CT_VALIDATION_PERMISSIVE:
4273         return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4274     case SSL_CT_VALIDATION_STRICT:
4275         return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4276     }
4277 }
4278
4279 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4280 {
4281     return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4282 }
4283
4284 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4285 {
4286     return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4287 }
4288
4289 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4290 {
4291     CTLOG_STORE_free(ctx->ctlog_store);
4292     ctx->ctlog_store = logs;
4293 }
4294
4295 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4296 {
4297     return ctx->ctlog_store;
4298 }
4299
4300 #endif
4301
4302 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4303 {
4304     ctx->keylog_callback = cb;
4305 }
4306
4307 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4308 {
4309     return ctx->keylog_callback;
4310 }
4311
4312 static int nss_keylog_int(const char *prefix,
4313                           SSL *ssl,
4314                           const uint8_t *parameter_1,
4315                           size_t parameter_1_len,
4316                           const uint8_t *parameter_2,
4317                           size_t parameter_2_len)
4318 {
4319     char *out = NULL;
4320     char *cursor = NULL;
4321     size_t out_len = 0;
4322     size_t i;
4323     size_t prefix_len;
4324
4325     if (ssl->ctx->keylog_callback == NULL) return 1;
4326
4327     /*
4328      * Our output buffer will contain the following strings, rendered with
4329      * space characters in between, terminated by a NULL character: first the
4330      * prefix, then the first parameter, then the second parameter. The
4331      * meaning of each parameter depends on the specific key material being
4332      * logged. Note that the first and second parameters are encoded in
4333      * hexadecimal, so we need a buffer that is twice their lengths.
4334      */
4335     prefix_len = strlen(prefix);
4336     out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4337     if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4338         SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4339         return 0;
4340     }
4341
4342     strcpy(cursor, prefix);
4343     cursor += prefix_len;
4344     *cursor++ = ' ';
4345
4346     for (i = 0; i < parameter_1_len; i++) {
4347         sprintf(cursor, "%02x", parameter_1[i]);
4348         cursor += 2;
4349     }
4350     *cursor++ = ' ';
4351
4352     for (i = 0; i < parameter_2_len; i++) {
4353         sprintf(cursor, "%02x", parameter_2[i]);
4354         cursor += 2;
4355     }
4356     *cursor = '\0';
4357
4358     ssl->ctx->keylog_callback(ssl, (const char *)out);
4359     OPENSSL_free(out);
4360     return 1;
4361
4362 }
4363
4364 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4365                                     const uint8_t *encrypted_premaster,
4366                                     size_t encrypted_premaster_len,
4367                                     const uint8_t *premaster,
4368                                     size_t premaster_len)
4369 {
4370     if (encrypted_premaster_len < 8) {
4371         SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4372         return 0;
4373     }
4374
4375     /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4376     return nss_keylog_int("RSA",
4377                           ssl,
4378                           encrypted_premaster,
4379                           8,
4380                           premaster,
4381                           premaster_len);
4382 }
4383
4384 int ssl_log_secret(SSL *ssl,
4385                    const char *label,
4386                    const uint8_t *secret,
4387                    size_t secret_len)
4388 {
4389     return nss_keylog_int(label,
4390                           ssl,
4391                           ssl->s3->client_random,
4392                           SSL3_RANDOM_SIZE,
4393                           secret,
4394                           secret_len);
4395 }
4396