One Level Up Top Level

src/event/ngx_event_openssl.h - nginx-1.31.4 nginx/ @ 8d9666701

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. ‌#define X509_get_signature_nid(x)    OBJ_obj2nid((x)->sig_alg->algorithm)
  68. #endif


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


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


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


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


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


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


  102. ‌typedef struct ngx_ssl_ocsp_s   ngx_ssl_ocsp_t;


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

  110.     ngx_array_t                 certs;

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


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

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

  125.     ngx_connection_handler_pt   handler;

  127.     ngx_ssl_session_t          *session;
  128.     ngx_connection_handler_pt   save_session;

  130.     ngx_event_handler_pt        saved_read_handler;
  131.     ngx_event_handler_pt        saved_write_handler;

  133.     ngx_ssl_ocsp_t             *ocsp;

  135.     u_char                      early_buf;

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


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


  162. ‌#define NGX_SSL_MAX_SESSION_SIZE  8192

  164. ‌typedef struct ngx_ssl_sess_id_s  ngx_ssl_sess_id_t;

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


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


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


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

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


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


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


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

  224. ‌#define NGX_SSL_BUFSIZE  16384


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

  232. ‌#define NGX_SSL_CACHE_INVALIDATE  0x80000000


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

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

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

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

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

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

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

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

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

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

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

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


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


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


  405. extern int  ngx_ssl_connection_index;
  406. extern int  ngx_ssl_server_conf_index;
  407. extern int  ngx_ssl_session_cache_index;
  408. extern int  ngx_ssl_ticket_keys_index;
  409. extern int  ngx_ssl_ocsp_index;
  410. extern int  ngx_ssl_index;
  411. extern int  ngx_ssl_certificate_name_index;
  412. extern int  ngx_ssl_certificate_comp_index;
  413. extern int  ngx_ssl_client_hello_arg_index;


  416. extern u_char  ngx_ssl_session_buffer[NGX_SSL_MAX_SESSION_SIZE];


  419. #endif /* _NGX_EVENT_OPENSSL_H_INCLUDED_ */

One Level Up Top Level