One Level Up Top Level

src/event/ngx_event_openssl.h - nginx-1.31.9 nginx/ @ 2a3a19c6f

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 >= 0x30000000L && !defined SSL_get_peer_certificate)
  72. ‌#define SSL_get_peer_certificate(s)  SSL_get1_peer_certificate(s)
  73. #endif


  76. #if (OPENSSL_VERSION_NUMBER < 0x30000000L && !defined ERR_peek_error_data)
  77. ‌#define ERR_peek_error_data(d, f)    ERR_peek_error_line_data(NULL, NULL, d, f)
  78. #endif


  81. #ifdef OPENSSL_NO_DEPRECATED_3_4
  82. ‌#define SSL_SESSION_get_time(s)      SSL_SESSION_get_time_ex(s)
  83. ‌#define SSL_SESSION_set_time(s, t)   SSL_SESSION_set_time_ex(s, t)
  84. #endif


  87. #ifdef OPENSSL_NO_DEPRECATED_3_0
  88. ‌#define EVP_CIPHER_CTX_cipher(c)     EVP_CIPHER_CTX_get0_cipher(c)
  89. #endif


  92. #if (OPENSSL_VERSION_NUMBER < 0x30000000L)
  93. ‌#define SSL_group_to_name(s, nid)    NULL
  94. #endif


  97. ‌typedef struct ngx_ssl_ocsp_s   ngx_ssl_ocsp_t;


  100. ‌struct ngx_ssl_s {
  101.     SSL_CTX                    *ctx;
  102.     ngx_log_t                  *log;
  103.     size_t                      buffer_size;

  105.     ngx_array_t                 certs;

  107.     ngx_rbtree_t                staple_rbtree;
  108.     ngx_rbtree_node_t           staple_sentinel;
  109. };


  112. ‌struct ngx_ssl_connection_s {
  113.     ngx_ssl_conn_t             *connection;
  114.     SSL_CTX                    *session_ctx;

  116.     ngx_int_t                   last;
  117.     ngx_buf_t                  *buf;
  118.     size_t                      buffer_size;

  120.     ngx_connection_handler_pt   handler;

  122.     ngx_ssl_session_t          *session;
  123.     ngx_connection_handler_pt   save_session;

  125.     ngx_event_handler_pt        saved_read_handler;
  126.     ngx_event_handler_pt        saved_write_handler;

  128.     ngx_ssl_ocsp_t             *ocsp;

  130.     u_char                      early_buf;

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


  151. ‌#define NGX_SSL_NO_SCACHE            -2
  152. ‌#define NGX_SSL_NONE_SCACHE          -3
  153. ‌#define NGX_SSL_NO_BUILTIN_SCACHE    -4
  154. ‌#define NGX_SSL_DFLT_BUILTIN_SCACHE  -5


  157. ‌#define NGX_SSL_MAX_SESSION_SIZE  8192

  159. ‌typedef struct ngx_ssl_sess_id_s  ngx_ssl_sess_id_t;

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


  175. ‌typedef struct {
  176.     u_char                      name[16];
  177.     u_char                      hmac_key[32];
  178.     u_char                      aes_key[32];
  179.     time_t                      expire;
  180.     unsigned                    size:8;
  181.     unsigned                    shared:1;
  182. ‌} ngx_ssl_ticket_key_t;


  185. ‌typedef struct {
  186.     ngx_rbtree_t                session_rbtree;
  187.     ngx_rbtree_node_t           sentinel;
  188.     ngx_queue_t                 expire_queue;
  189.     ngx_ssl_ticket_key_t        ticket_keys[3];
  190.     time_t                      fail_time;
  191. ‌} ngx_ssl_session_cache_t;


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

  196. ‌typedef struct {
  197.     ngx_ssl_servername_pt       servername;
  198. ‌} ngx_ssl_client_hello_arg;


  201. ‌#define NGX_SSL_SSLv2    0x0002
  202. ‌#define NGX_SSL_SSLv3    0x0004
  203. ‌#define NGX_SSL_TLSv1    0x0008
  204. ‌#define NGX_SSL_TLSv1_1  0x0010
  205. ‌#define NGX_SSL_TLSv1_2  0x0020
  206. ‌#define NGX_SSL_TLSv1_3  0x0040


  209. #if (defined SSL_OP_NO_TLSv1_2 || defined SSL_OP_NO_TLSv1_3)
  210. ‌#define NGX_SSL_DEFAULT_PROTOCOLS  (NGX_SSL_TLSv1_2|NGX_SSL_TLSv1_3)
  211. #else
  212. ‌#define NGX_SSL_DEFAULT_PROTOCOLS  (NGX_SSL_TLSv1|NGX_SSL_TLSv1_1)
  213. #endif


  216. ‌#define NGX_SSL_BUFFER   1
  217. ‌#define NGX_SSL_CLIENT   2

  219. ‌#define NGX_SSL_BUFSIZE  16384


  222. ‌#define NGX_SSL_CACHE_CERT  0
  223. ‌#define NGX_SSL_CACHE_PKEY  1
  224. ‌#define NGX_SSL_CACHE_CRL   2
  225. ‌#define NGX_SSL_CACHE_CA    3

  227. ‌#define NGX_SSL_CACHE_INVALIDATE  0x80000000


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

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

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

  259. ngx_int_t ngx_ssl_ocsp_validate(ngx_connection_t *c);
  260. ngx_int_t ngx_ssl_ocsp_get_status(ngx_connection_t *c, const char **s);
  261. void ngx_ssl_ocsp_cleanup(ngx_connection_t *c);
  262. ngx_int_t ngx_ssl_ocsp_cache_init(ngx_shm_zone_t *shm_zone, void *data);

  264. ngx_ssl_cache_t *ngx_ssl_cache_init(ngx_pool_t *pool, ngx_uint_t max,
  265.     time_t valid, time_t inactive);
  266. void *ngx_ssl_cache_fetch(ngx_conf_t *cf, ngx_uint_t index, char **err,
  267.     ngx_str_t *path, void *data);
  268. void *ngx_ssl_cache_connection_fetch(ngx_ssl_cache_t *cache, ngx_pool_t *pool,
  269.     ngx_uint_t index, char **err, ngx_str_t *path, void *data);

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

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

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

  301. ngx_int_t ngx_ssl_create_connection(ngx_ssl_t *ssl, ngx_connection_t *c,
  302.     ngx_uint_t flags);

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

  314. ‌#define ngx_ssl_verify_error_optional(n)                                      \
  315.     (n == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT                              \
  316.      || n == X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN                             \
  317.      || n == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY                     \
  318.      || n == X509_V_ERR_CERT_UNTRUSTED                                        \
  319.      || n == X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE)

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


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


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


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


  411. extern u_char  ngx_ssl_session_buffer[NGX_SSL_MAX_SESSION_SIZE];


  414. #endif /* _NGX_EVENT_OPENSSL_H_INCLUDED_ */

One Level Up Top Level