xref: /curl/lib/vtls/openssl.h (revision fa0ccd9f)
1 #ifndef HEADER_CURL_SSLUSE_H
2 #define HEADER_CURL_SSLUSE_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 
27 #include "curl_setup.h"
28 
29 #ifdef USE_OPENSSL
30 /*
31  * This header should only be needed to get included by vtls.c, openssl.c
32  * and ngtcp2.c
33  */
34 #include <openssl/ossl_typ.h>
35 #include <openssl/ssl.h>
36 
37 #include "urldata.h"
38 
39 struct ssl_peer;
40 
41 /* Struct to hold a Curl OpenSSL instance */
42 struct ossl_ctx {
43   /* these ones requires specific SSL-types */
44   SSL_CTX* ssl_ctx;
45   SSL*     ssl;
46   X509*    server_cert;
47   BIO_METHOD *bio_method;
48   CURLcode io_result;       /* result of last BIO cfilter operation */
49 #ifndef HAVE_KEYLOG_CALLBACK
50   /* Set to true once a valid keylog entry has been created to avoid dupes.
51      This is a bool and not a bitfield because it is passed by address. */
52   bool keylog_done;
53 #endif
54   BIT(x509_store_setup);            /* x509 store has been set up */
55   BIT(reused_session);              /* session-ID was reused for this */
56 };
57 
58 size_t Curl_ossl_version(char *buffer, size_t size);
59 
60 typedef CURLcode Curl_ossl_ctx_setup_cb(struct Curl_cfilter *cf,
61                                         struct Curl_easy *data,
62                                         void *user_data);
63 
64 typedef int Curl_ossl_new_session_cb(SSL *ssl, SSL_SESSION *ssl_sessionid);
65 
66 CURLcode Curl_ossl_ctx_init(struct ossl_ctx *octx,
67                             struct Curl_cfilter *cf,
68                             struct Curl_easy *data,
69                             struct ssl_peer *peer,
70                             const unsigned char *alpn, size_t alpn_len,
71                             Curl_ossl_ctx_setup_cb *cb_setup,
72                             void *cb_user_data,
73                             Curl_ossl_new_session_cb *cb_new_session,
74                             void *ssl_user_data);
75 
76 #if (OPENSSL_VERSION_NUMBER < 0x30000000L)
77 #define SSL_get1_peer_certificate SSL_get_peer_certificate
78 #endif
79 
80 extern const struct Curl_ssl Curl_ssl_openssl;
81 
82 /**
83  * Setup the OpenSSL X509_STORE in `ssl_ctx` for the cfilter `cf` and
84  * easy handle `data`. Will allow reuse of a shared cache if suitable
85  * and configured.
86  */
87 CURLcode Curl_ssl_setup_x509_store(struct Curl_cfilter *cf,
88                                    struct Curl_easy *data,
89                                    SSL_CTX *ssl_ctx);
90 
91 CURLcode Curl_ossl_ctx_configure(struct Curl_cfilter *cf,
92                                  struct Curl_easy *data,
93                                  SSL_CTX *ssl_ctx);
94 
95 /*
96  * Add a new session to the cache. Takes ownership of the session.
97  */
98 CURLcode Curl_ossl_add_session(struct Curl_cfilter *cf,
99                                struct Curl_easy *data,
100                                const char *ssl_peer_key,
101                                SSL_SESSION *ssl_sessionid,
102                                int ietf_tls_id,
103                                const char *alpn);
104 
105 /*
106  * Get the server cert, verify it and show it, etc., only call failf() if
107  * ssl config verifypeer or -host is set. Otherwise all this is for
108  * informational purposes only!
109  */
110 CURLcode Curl_oss_check_peer_cert(struct Curl_cfilter *cf,
111                                   struct Curl_easy *data,
112                                   struct ossl_ctx *octx,
113                                   struct ssl_peer *peer);
114 
115 #endif /* USE_OPENSSL */
116 #endif /* HEADER_CURL_SSLUSE_H */
117