One Level Up Top Level

src/event/ngx_event_openssl.h - nginx

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_EVENT_OPENSSL_H_INCLUDED_
  9. ‌#define _NGX_EVENT_OPENSSL_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>

  15. ‌#define OPENSSL_SUPPRESS_DEPRECATED

  17. #include <openssl/ssl.h>
  18. #include <openssl/err.h>
  19. #include <openssl/bn.h>
  20. #include <openssl/conf.h>
  21. #include <openssl/crypto.h>
  22. #ifndef OPENSSL_NO_DH
  23. #include <openssl/dh.h>
  24. #endif
  25. #ifndef OPENSSL_NO_ENGINE
  26. #include <openssl/engine.h>
  27. #endif
  28. #include <openssl/evp.h>
  29. #include <openssl/hmac.h>
  30. #ifndef OPENSSL_NO_OCSP
  31. #include <openssl/ocsp.h>
  32. #endif
  33. #include <openssl/rand.h>
  34. #include <openssl/x509.h>
  35. #include <openssl/x509v3.h>

  37. ‌#define NGX_SSL_NAME     "OpenSSL"


  40. #if (defined LIBRESSL_VERSION_NUMBER && OPENSSL_VERSION_NUMBER == 0x20000000L)
  41. #undef OPENSSL_VERSION_NUMBER
  42. #if (LIBRESSL_VERSION_NUMBER >= 0x3050000fL)
  43. ‌#define OPENSSL_VERSION_NUMBER  0x1010000fL
  44. #else
  45. ‌#define OPENSSL_VERSION_NUMBER  0x1000107fL
  46. #endif
  47. #endif


  50. #if (OPENSSL_VERSION_NUMBER >= 0x10100001L)

  52. ‌#define ngx_ssl_version()       OpenSSL_version(OPENSSL_VERSION)

  54. #else

  56. ‌#define ngx_ssl_version()       SSLeay_version(SSLEAY_VERSION)

  58. #endif


  61. ‌#define ngx_ssl_session_t       SSL_SESSION
  62. ‌#define ngx_ssl_conn_t          SSL


  65. #if (OPENSSL_VERSION_NUMBER < 0x10002000L)
  66. ‌#define SSL_is_server(s)        (s)->server
  67. #endif


  70. #if (OPENSSL_VERSION_NUMBER < 0x1010000fL)
  71. ‌#define ASN1_STRING_get0_data(x)     (x)->data
  72. #endif


  75. #if (OPENSSL_VERSION_NUMBER >= 0x30000000L && !defined SSL_get_peer_certificate)
  76. ‌#define SSL_get_peer_certificate(s)  SSL_get1_peer_certificate(s)
  77. #endif


  80. #if (OPENSSL_VERSION_NUMBER < 0x30000000L && !defined ERR_peek_error_data)
  81. ‌#define ERR_peek_error_data(d, f)    ERR_peek_error_line_data(NULL, NULL, d, f)
  82. #endif


  85. #ifdef OPENSSL_NO_DEPRECATED_3_4
  86. ‌#define SSL_SESSION_get_time(s)      SSL_SESSION_get_time_ex(s)
  87. ‌#define SSL_SESSION_set_time(s, t)   SSL_SESSION_set_time_ex(s, t)
  88. #endif


  91. #ifdef OPENSSL_NO_DEPRECATED_3_0
  92. ‌#define EVP_CIPHER_CTX_cipher(c)     EVP_CIPHER_CTX_get0_cipher(c)
  93. #endif


  96. #if (OPENSSL_VERSION_NUMBER < 0x30000000L)
  97. ‌#define SSL_group_to_name(s, nid)    NULL
  98. #endif


  101. ‌typedef struct ngx_ssl_ocsp_s   ngx_ssl_ocsp_t;


  104. ‌struct ngx_ssl_s {
  105.     SSL_CTX                    *ctx;
  106.     ngx_log_t                  *log;
  107.     size_t                      buffer_size;

  109.     ngx_array_t                 certs;

  111.     ngx_rbtree_t                staple_rbtree;
  112.     ngx_rbtree_node_t           staple_sentinel;
  113. };


  116. ‌struct ngx_ssl_connection_s {
  117.     ngx_ssl_conn_t             *connection;
  118.     SSL_CTX                    *session_ctx;

  120.     ngx_int_t                   last;
  121.     ngx_buf_t                  *buf;
  122.     size_t                      buffer_size;

  124.     ngx_connection_handler_pt   handler;

  126.     ngx_ssl_session_t          *session;
  127.     ngx_connection_handler_pt   save_session;

  129.     ngx_event_handler_pt        saved_read_handler;
  130.     ngx_event_handler_pt        saved_write_handler;

  132.     ngx_ssl_ocsp_t             *ocsp;

  134.     u_char                      early_buf;

  136.     unsigned                    handshaked:1;
  137.     unsigned                    handshake_rejected:1;
  138.     unsigned                    renegotiation:1;
  139.     unsigned                    buffer:1;
  140.     unsigned                    sendfile:1;
  141.     unsigned                    no_wait_shutdown:1;
  142.     unsigned                    no_send_shutdown:1;
  143.     unsigned                    shutdown_without_free:1;
  144.     unsigned                    handshake_buffer_set:1;
  145.     unsigned                    session_timeout_set:1;
  146.     unsigned                    try_early_data:1;
  147.     unsigned                    in_early:1;
  148.     unsigned                    in_ocsp:1;
  149.     unsigned                    early_preread:1;
  150.     unsigned                    write_blocked:1;
  151.     unsigned                    sni_accepted:1;
  152. };


  155. ‌#define NGX_SSL_NO_SCACHE            -2
  156. ‌#define NGX_SSL_NONE_SCACHE          -3
  157. ‌#define NGX_SSL_NO_BUILTIN_SCACHE    -4
  158. ‌#define NGX_SSL_DFLT_BUILTIN_SCACHE  -5


  161. ‌#define NGX_SSL_MAX_SESSION_SIZE  8192

  163. ‌typedef struct ngx_ssl_sess_id_s  ngx_ssl_sess_id_t;

  165. ‌struct ngx_ssl_sess_id_s {
  166.     ngx_rbtree_node_t           node;
  167.     size_t                      len;
  168.     ngx_queue_t                 queue;
  169.     time_t                      expire;
  170.     u_char                      id[32];
  171. #if (NGX_PTR_SIZE == 8)
  172.     u_char                     *session;
  173. #else
  174.     u_char                      session[1];
  175. #endif
  176. };


  179. ‌typedef struct {
  180.     u_char                      name[16];
  181.     u_char                      hmac_key[32];
  182.     u_char                      aes_key[32];
  183.     time_t                      expire;
  184.     unsigned                    size:8;
  185.     unsigned                    shared:1;
  186. ‌} ngx_ssl_ticket_key_t;


  189. ‌typedef struct {
  190.     ngx_rbtree_t                session_rbtree;
  191.     ngx_rbtree_node_t           sentinel;
  192.     ngx_queue_t                 expire_queue;
  193.     ngx_ssl_ticket_key_t        ticket_keys[3];
  194.     time_t                      fail_time;
  195. ‌} ngx_ssl_session_cache_t;


  198. ‌typedef int (*ngx_ssl_servername_pt)(ngx_ssl_conn_t *, int *, void *);

  200. ‌typedef struct {
  201.     ngx_ssl_servername_pt       servername;
  202. ‌} ngx_ssl_client_hello_arg;


  205. ‌#define NGX_SSL_SSLv2    0x0002
  206. ‌#define NGX_SSL_SSLv3    0x0004
  207. ‌#define NGX_SSL_TLSv1    0x0008
  208. ‌#define NGX_SSL_TLSv1_1  0x0010
  209. ‌#define NGX_SSL_TLSv1_2  0x0020
  210. ‌#define NGX_SSL_TLSv1_3  0x0040


  213. #if (defined SSL_OP_NO_TLSv1_2 || defined SSL_OP_NO_TLSv1_3)
  214. ‌#define NGX_SSL_DEFAULT_PROTOCOLS  (NGX_SSL_TLSv1_2|NGX_SSL_TLSv1_3)
  215. #else
  216. ‌#define NGX_SSL_DEFAULT_PROTOCOLS  (NGX_SSL_TLSv1|NGX_SSL_TLSv1_1)
  217. #endif


  220. ‌#define NGX_SSL_BUFFER   1
  221. ‌#define NGX_SSL_CLIENT   2

  223. ‌#define NGX_SSL_BUFSIZE  16384


  226. ‌#define NGX_SSL_CACHE_CERT  0
  227. ‌#define NGX_SSL_CACHE_PKEY  1
  228. ‌#define NGX_SSL_CACHE_CRL   2
  229. ‌#define NGX_SSL_CACHE_CA    3

  231. ‌#define NGX_SSL_CACHE_INVALIDATE  0x80000000


  234. ngx_int_t ngx_ssl_init(ngx_log_t *log);
  235. ngx_int_t ngx_ssl_create(ngx_ssl_t *ssl, ngx_uint_t protocols, void *data);

  237. ngx_int_t ngx_ssl_certificates(ngx_conf_t *cf, ngx_ssl_t *ssl,
  238.     ngx_array_t *certs, ngx_array_t *keys, ngx_array_t *passwords);
  239. ngx_int_t ngx_ssl_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
  240.     ngx_str_t *cert, ngx_str_t *key, ngx_array_t *passwords);
  241. ngx_int_t ngx_ssl_connection_certificate(ngx_connection_t *c, ngx_pool_t *pool,
  242.     ngx_str_t *cert, ngx_str_t *key, ngx_ssl_cache_t *cache,
  243.     ngx_array_t *passwords);
  244. ngx_int_t ngx_ssl_certificate_compression(ngx_conf_t *cf, ngx_ssl_t *ssl,
  245.     ngx_uint_t enable);

  247. ngx_int_t ngx_ssl_ciphers(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *ciphers,
  248.     ngx_uint_t prefer_server_ciphers);
  249. ngx_int_t ngx_ssl_client_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
  250.     ngx_str_t *cert, ngx_int_t depth);
  251. ngx_int_t ngx_ssl_trusted_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
  252.     ngx_str_t *cert, ngx_int_t depth);
  253. ngx_int_t ngx_ssl_crl(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *crl);
  254. ngx_int_t ngx_ssl_stapling(ngx_conf_t *cf, ngx_ssl_t *ssl,
  255.     ngx_str_t *file, ngx_str_t *responder, ngx_uint_t verify);
  256. ngx_int_t ngx_ssl_stapling_resolver(ngx_conf_t *cf, ngx_ssl_t *ssl,
  257.     ngx_resolver_t *resolver, ngx_msec_t resolver_timeout);
  258. ngx_int_t ngx_ssl_ocsp(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *responder,
  259.     ngx_uint_t depth, ngx_shm_zone_t *shm_zone);
  260. ngx_int_t ngx_ssl_ocsp_resolver(ngx_conf_t *cf, ngx_ssl_t *ssl,
  261.     ngx_resolver_t *resolver, ngx_msec_t resolver_timeout);

  263. ngx_int_t ngx_ssl_ocsp_validate(ngx_connection_t *c);
  264. ngx_int_t ngx_ssl_ocsp_get_status(ngx_connection_t *c, const char **s);
  265. void ngx_ssl_ocsp_cleanup(ngx_connection_t *c);
  266. ngx_int_t ngx_ssl_ocsp_cache_init(ngx_shm_zone_t *shm_zone, void *data);

  268. ngx_ssl_cache_t *ngx_ssl_cache_init(ngx_pool_t *pool, ngx_uint_t max,
  269.     time_t valid, time_t inactive);
  270. void *ngx_ssl_cache_fetch(ngx_conf_t *cf, ngx_uint_t index, char **err,
  271.     ngx_str_t *path, void *data);
  272. void *ngx_ssl_cache_connection_fetch(ngx_ssl_cache_t *cache, ngx_pool_t *pool,
  273.     ngx_uint_t index, char **err, ngx_str_t *path, void *data);

  275. ngx_array_t *ngx_ssl_read_password_file(ngx_conf_t *cf, ngx_str_t *file);
  276. ngx_array_t *ngx_ssl_preserve_passwords(ngx_conf_t *cf,
  277.     ngx_array_t *passwords);
  278. ngx_int_t ngx_ssl_dhparam(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *file);
  279. ngx_int_t ngx_ssl_ech_files(ngx_conf_t *cf, ngx_ssl_t *ssl,
  280.     ngx_array_t *filename);
  281. ngx_int_t ngx_ssl_ecdh_curve(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *name);
  282. ngx_int_t ngx_ssl_early_data(ngx_conf_t *cf, ngx_ssl_t *ssl,
  283.     ngx_uint_t enable);
  284. ngx_int_t ngx_ssl_conf_commands(ngx_conf_t *cf, ngx_ssl_t *ssl,
  285.     ngx_array_t *commands);

  287. ngx_int_t ngx_ssl_client_session_cache(ngx_conf_t *cf, ngx_ssl_t *ssl,
  288.     ngx_uint_t enable);
  289. ngx_int_t ngx_ssl_session_cache(ngx_ssl_t *ssl, ngx_str_t *sess_ctx,
  290.     ngx_array_t *certificates, ssize_t builtin_session_cache,
  291.     ngx_shm_zone_t *shm_zone, time_t timeout);
  292. ngx_int_t ngx_ssl_session_ticket_keys(ngx_conf_t *cf, ngx_ssl_t *ssl,
  293.     ngx_array_t *paths);
  294. ngx_int_t ngx_ssl_session_cache_init(ngx_shm_zone_t *shm_zone, void *data);

  296. ngx_int_t ngx_ssl_set_client_hello_callback(ngx_ssl_t *ssl,
  297.     ngx_ssl_client_hello_arg *cb);
  298. #ifdef SSL_CLIENT_HELLO_SUCCESS
  299. int ngx_ssl_client_hello_callback(ngx_ssl_conn_t *ssl_conn, int *ad, void *arg);
  300. #elif defined OPENSSL_IS_BORINGSSL
  301. enum ssl_select_cert_result_t ngx_ssl_select_certificate(
  302.     const SSL_CLIENT_HELLO *client_hello);
  303. #endif

  305. ngx_int_t ngx_ssl_create_connection(ngx_ssl_t *ssl, ngx_connection_t *c,
  306.     ngx_uint_t flags);

  308. void ngx_ssl_remove_cached_session(SSL_CTX *ssl, ngx_ssl_session_t *sess);
  309. ngx_int_t ngx_ssl_set_session(ngx_connection_t *c, ngx_ssl_session_t *session);
  310. ngx_ssl_session_t *ngx_ssl_get_session(ngx_connection_t *c);
  311. ngx_ssl_session_t *ngx_ssl_get0_session(ngx_connection_t *c);
  312. ‌#define ngx_ssl_free_session        SSL_SESSION_free
  313. ‌#define ngx_ssl_get_connection(ssl_conn)                                      \
  314.     SSL_get_ex_data(ssl_conn, ngx_ssl_connection_index)
  315. ‌#define ngx_ssl_get_server_conf(ssl_ctx)                                      \
  316.     SSL_CTX_get_ex_data(ssl_ctx, ngx_ssl_server_conf_index)

  318. ‌#define ngx_ssl_verify_error_optional(n)                                      \
  319.     (n == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT                              \
  320.      || n == X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN                             \
  321.      || n == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY                     \
  322.      || n == X509_V_ERR_CERT_UNTRUSTED                                        \
  323.      || n == X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE)

  325. ngx_int_t ngx_ssl_check_host(ngx_connection_t *c, ngx_str_t *name);


  328. ngx_int_t ngx_ssl_get_protocol(ngx_connection_t *c, ngx_pool_t *pool,
  329.     ngx_str_t *s);
  330. ngx_int_t ngx_ssl_get_cipher_name(ngx_connection_t *c, ngx_pool_t *pool,
  331.     ngx_str_t *s);
  332. ngx_int_t ngx_ssl_get_ciphers(ngx_connection_t *c, ngx_pool_t *pool,
  333.     ngx_str_t *s);
  334. ngx_int_t ngx_ssl_get_curve(ngx_connection_t *c, ngx_pool_t *pool,
  335.     ngx_str_t *s);
  336. ngx_int_t ngx_ssl_get_curves(ngx_connection_t *c, ngx_pool_t *pool,
  337.     ngx_str_t *s);
  338. ngx_int_t ngx_ssl_get_sigalg(ngx_connection_t *c, ngx_pool_t *pool,
  339.     ngx_str_t *s);
  340. ngx_int_t ngx_ssl_get_session_id(ngx_connection_t *c, ngx_pool_t *pool,
  341.     ngx_str_t *s);
  342. ngx_int_t ngx_ssl_get_session_reused(ngx_connection_t *c, ngx_pool_t *pool,
  343.     ngx_str_t *s);
  344. ngx_int_t ngx_ssl_get_early_data(ngx_connection_t *c, ngx_pool_t *pool,
  345.     ngx_str_t *s);
  346. ngx_int_t ngx_ssl_get_server_name(ngx_connection_t *c, ngx_pool_t *pool,
  347.     ngx_str_t *s);
  348. ngx_int_t ngx_ssl_get_ech_status(ngx_connection_t *c, ngx_pool_t *pool,
  349.     ngx_str_t *s);
  350. ngx_int_t ngx_ssl_get_ech_outer_server_name(ngx_connection_t *c,
  351.     ngx_pool_t *pool, ngx_str_t *s);
  352. ngx_int_t ngx_ssl_get_alpn_protocol(ngx_connection_t *c, ngx_pool_t *pool,
  353.     ngx_str_t *s);
  354. ngx_int_t ngx_ssl_get_raw_certificate(ngx_connection_t *c, ngx_pool_t *pool,
  355.     ngx_str_t *s);
  356. ngx_int_t ngx_ssl_get_certificate(ngx_connection_t *c, ngx_pool_t *pool,
  357.     ngx_str_t *s);
  358. ngx_int_t ngx_ssl_get_escaped_certificate(ngx_connection_t *c, ngx_pool_t *pool,
  359.     ngx_str_t *s);
  360. ngx_int_t ngx_ssl_get_subject_dn(ngx_connection_t *c, ngx_pool_t *pool,
  361.     ngx_str_t *s);
  362. ngx_int_t ngx_ssl_get_issuer_dn(ngx_connection_t *c, ngx_pool_t *pool,
  363.     ngx_str_t *s);
  364. ngx_int_t ngx_ssl_get_subject_dn_legacy(ngx_connection_t *c, ngx_pool_t *pool,
  365.     ngx_str_t *s);
  366. ngx_int_t ngx_ssl_get_issuer_dn_legacy(ngx_connection_t *c, ngx_pool_t *pool,
  367.     ngx_str_t *s);
  368. ngx_int_t ngx_ssl_get_serial_number(ngx_connection_t *c, ngx_pool_t *pool,
  369.     ngx_str_t *s);
  370. ngx_int_t ngx_ssl_get_fingerprint(ngx_connection_t *c, ngx_pool_t *pool,
  371.     ngx_str_t *s);
  372. ngx_int_t ngx_ssl_get_client_verify(ngx_connection_t *c, ngx_pool_t *pool,
  373.     ngx_str_t *s);
  374. ngx_int_t ngx_ssl_get_client_v_start(ngx_connection_t *c, ngx_pool_t *pool,
  375.     ngx_str_t *s);
  376. ngx_int_t ngx_ssl_get_client_v_end(ngx_connection_t *c, ngx_pool_t *pool,
  377.     ngx_str_t *s);
  378. ngx_int_t ngx_ssl_get_client_v_remain(ngx_connection_t *c, ngx_pool_t *pool,
  379.     ngx_str_t *s);
  380. ngx_int_t ngx_ssl_get_client_sigalg(ngx_connection_t *c, ngx_pool_t *pool,
  381.     ngx_str_t *s);


  384. ngx_int_t ngx_ssl_handshake(ngx_connection_t *c);
  385. #if (NGX_DEBUG)
  386. void ngx_ssl_handshake_log(ngx_connection_t *c);
  387. #endif
  388. ssize_t ngx_ssl_recv(ngx_connection_t *c, u_char *buf, size_t size);
  389. ssize_t ngx_ssl_write(ngx_connection_t *c, u_char *data, size_t size);
  390. ssize_t ngx_ssl_recv_chain(ngx_connection_t *c, ngx_chain_t *cl, off_t limit);
  391. ngx_chain_t *ngx_ssl_send_chain(ngx_connection_t *c, ngx_chain_t *in,
  392.     off_t limit);
  393. void ngx_ssl_free_buffer(ngx_connection_t *c);
  394. ngx_int_t ngx_ssl_shutdown(ngx_connection_t *c);
  395. void ngx_ssl_connection_error(ngx_connection_t *c, int sslerr, ngx_err_t err,
  396.     char *text);
  397. void ngx_cdecl ngx_ssl_error(ngx_uint_t level, ngx_log_t *log, ngx_err_t err,
  398.     char *fmt, ...);
  399. void ngx_ssl_cleanup_ctx(void *data);


  402. extern int  ngx_ssl_connection_index;
  403. extern int  ngx_ssl_server_conf_index;
  404. extern int  ngx_ssl_session_cache_index;
  405. extern int  ngx_ssl_ticket_keys_index;
  406. extern int  ngx_ssl_ocsp_index;
  407. extern int  ngx_ssl_index;
  408. extern int  ngx_ssl_certificate_name_index;
  409. extern int  ngx_ssl_certificate_comp_index;
  410. extern int  ngx_ssl_client_hello_arg_index;


  413. extern u_char  ngx_ssl_session_buffer[NGX_SSL_MAX_SESSION_SIZE];


  416. #endif /* _NGX_EVENT_OPENSSL_H_INCLUDED_ */

One Level Up Top Level