One Level Up Top Level

src/event/ngx_event_openssl.h - nginx-1.7.10

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. #include <openssl/ssl.h>
  16. #include <openssl/err.h>
  17. #include <openssl/bn.h>
  18. #include <openssl/conf.h>
  19. #include <openssl/crypto.h>
  20. #include <openssl/dh.h>
  21. #ifndef OPENSSL_NO_ENGINE
  22. #include <openssl/engine.h>
  23. #endif
  24. #include <openssl/evp.h>
  25. #ifndef OPENSSL_NO_OCSP
  26. #include <openssl/ocsp.h>
  27. #endif
  28. #include <openssl/rand.h>
  29. #include <openssl/rsa.h>
  30. #include <openssl/x509.h>
  31. #include <openssl/x509v3.h>

  33. ‌#define NGX_SSL_NAME     "OpenSSL"


  36. ‌#define ngx_ssl_session_t       SSL_SESSION
  37. ‌#define ngx_ssl_conn_t          SSL


  40. typedef struct {
  41.     SSL_CTX                    *ctx;
  42.     ngx_log_t                  *log;
  43.     size_t                      buffer_size;
  44. ‌} ngx_ssl_t;


  47. typedef struct {
  48.     ngx_ssl_conn_t             *connection;

  50.     ngx_int_t                   last;
  51.     ngx_buf_t                  *buf;
  52.     size_t                      buffer_size;

  54.     ngx_connection_handler_pt   handler;

  56.     ngx_event_handler_pt        saved_read_handler;
  57.     ngx_event_handler_pt        saved_write_handler;

  59.     unsigned                    handshaked:1;
  60.     unsigned                    renegotiation:1;
  61.     unsigned                    buffer:1;
  62.     unsigned                    no_wait_shutdown:1;
  63.     unsigned                    no_send_shutdown:1;
  64.     unsigned                    handshake_buffer_set:1;
  65. ‌} ngx_ssl_connection_t;


  68. ‌#define NGX_SSL_NO_SCACHE            -2
  69. ‌#define NGX_SSL_NONE_SCACHE          -3
  70. ‌#define NGX_SSL_NO_BUILTIN_SCACHE    -4
  71. ‌#define NGX_SSL_DFLT_BUILTIN_SCACHE  -5


  74. ‌#define NGX_SSL_MAX_SESSION_SIZE  4096

  76. ‌typedef struct ngx_ssl_sess_id_s  ngx_ssl_sess_id_t;

  78. ‌struct ngx_ssl_sess_id_s {
  79.     ngx_rbtree_node_t           node;
  80.     u_char                     *id;
  81.     size_t                      len;
  82.     u_char                     *session;
  83.     ngx_queue_t                 queue;
  84.     time_t                      expire;
  85. #if (NGX_PTR_SIZE == 8)
  86.     void                       *stub;
  87.     u_char                      sess_id[32];
  88. #endif
  89. };


  92. typedef struct {
  93.     ngx_rbtree_t                session_rbtree;
  94.     ngx_rbtree_node_t           sentinel;
  95.     ngx_queue_t                 expire_queue;
  96. ‌} ngx_ssl_session_cache_t;


  99. #ifdef SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB

  101. typedef struct {
  102.     u_char                      name[16];
  103.     u_char                      aes_key[16];
  104.     u_char                      hmac_key[16];
  105. ‌} ngx_ssl_session_ticket_key_t;

  107. #endif


  110. ‌#define NGX_SSL_SSLv2    0x0002
  111. ‌#define NGX_SSL_SSLv3    0x0004
  112. ‌#define NGX_SSL_TLSv1    0x0008
  113. ‌#define NGX_SSL_TLSv1_1  0x0010
  114. ‌#define NGX_SSL_TLSv1_2  0x0020


  117. ‌#define NGX_SSL_BUFFER   1
  118. ‌#define NGX_SSL_CLIENT   2

  120. ‌#define NGX_SSL_BUFSIZE  16384


  123. ngx_int_t ngx_ssl_init(ngx_log_t *log);
  124. ngx_int_t ngx_ssl_create(ngx_ssl_t *ssl, ngx_uint_t protocols, void *data);
  125. ngx_int_t ngx_ssl_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
  126.     ngx_str_t *cert, ngx_str_t *key, ngx_array_t *passwords);
  127. ngx_int_t ngx_ssl_client_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
  128.     ngx_str_t *cert, ngx_int_t depth);
  129. ngx_int_t ngx_ssl_trusted_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
  130.     ngx_str_t *cert, ngx_int_t depth);
  131. ngx_int_t ngx_ssl_crl(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *crl);
  132. ngx_int_t ngx_ssl_stapling(ngx_conf_t *cf, ngx_ssl_t *ssl,
  133.     ngx_str_t *file, ngx_str_t *responder, ngx_uint_t verify);
  134. ngx_int_t ngx_ssl_stapling_resolver(ngx_conf_t *cf, ngx_ssl_t *ssl,
  135.     ngx_resolver_t *resolver, ngx_msec_t resolver_timeout);
  136. RSA *ngx_ssl_rsa512_key_callback(ngx_ssl_conn_t *ssl_conn, int is_export,
  137.     int key_length);
  138. ngx_array_t *ngx_ssl_read_password_file(ngx_conf_t *cf, ngx_str_t *file);
  139. ngx_int_t ngx_ssl_dhparam(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *file);
  140. ngx_int_t ngx_ssl_ecdh_curve(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *name);
  141. ngx_int_t ngx_ssl_session_cache(ngx_ssl_t *ssl, ngx_str_t *sess_ctx,
  142.     ssize_t builtin_session_cache, ngx_shm_zone_t *shm_zone, time_t timeout);
  143. ngx_int_t ngx_ssl_session_ticket_keys(ngx_conf_t *cf, ngx_ssl_t *ssl,
  144.     ngx_array_t *paths);
  145. ngx_int_t ngx_ssl_session_cache_init(ngx_shm_zone_t *shm_zone, void *data);
  146. ngx_int_t ngx_ssl_create_connection(ngx_ssl_t *ssl, ngx_connection_t *c,
  147.     ngx_uint_t flags);

  149. void ngx_ssl_remove_cached_session(SSL_CTX *ssl, ngx_ssl_session_t *sess);
  150. ngx_int_t ngx_ssl_set_session(ngx_connection_t *c, ngx_ssl_session_t *session);
  151. ‌#define ngx_ssl_get_session(c)      SSL_get1_session(c->ssl->connection)
  152. ‌#define ngx_ssl_free_session        SSL_SESSION_free
  153. ‌#define ngx_ssl_get_connection(ssl_conn)                                      \
  154.     SSL_get_ex_data(ssl_conn, ngx_ssl_connection_index)
  155. ‌#define ngx_ssl_get_server_conf(ssl_ctx)                                      \
  156.     SSL_CTX_get_ex_data(ssl_ctx, ngx_ssl_server_conf_index)

  158. ‌#define ngx_ssl_verify_error_optional(n)                                      \
  159.     (n == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT                              \
  160.      || n == X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN                             \
  161.      || n == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY                     \
  162.      || n == X509_V_ERR_CERT_UNTRUSTED                                        \
  163.      || n == X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE)

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


  168. ngx_int_t ngx_ssl_get_protocol(ngx_connection_t *c, ngx_pool_t *pool,
  169.     ngx_str_t *s);
  170. ngx_int_t ngx_ssl_get_cipher_name(ngx_connection_t *c, ngx_pool_t *pool,
  171.     ngx_str_t *s);
  172. ngx_int_t ngx_ssl_get_session_id(ngx_connection_t *c, ngx_pool_t *pool,
  173.     ngx_str_t *s);
  174. ngx_int_t ngx_ssl_get_session_reused(ngx_connection_t *c, ngx_pool_t *pool,
  175.     ngx_str_t *s);
  176. ngx_int_t ngx_ssl_get_server_name(ngx_connection_t *c, ngx_pool_t *pool,
  177.     ngx_str_t *s);
  178. ngx_int_t ngx_ssl_get_raw_certificate(ngx_connection_t *c, ngx_pool_t *pool,
  179.     ngx_str_t *s);
  180. ngx_int_t ngx_ssl_get_certificate(ngx_connection_t *c, ngx_pool_t *pool,
  181.     ngx_str_t *s);
  182. ngx_int_t ngx_ssl_get_subject_dn(ngx_connection_t *c, ngx_pool_t *pool,
  183.     ngx_str_t *s);
  184. ngx_int_t ngx_ssl_get_issuer_dn(ngx_connection_t *c, ngx_pool_t *pool,
  185.     ngx_str_t *s);
  186. ngx_int_t ngx_ssl_get_serial_number(ngx_connection_t *c, ngx_pool_t *pool,
  187.     ngx_str_t *s);
  188. ngx_int_t ngx_ssl_get_fingerprint(ngx_connection_t *c, ngx_pool_t *pool,
  189.     ngx_str_t *s);
  190. ngx_int_t ngx_ssl_get_client_verify(ngx_connection_t *c, ngx_pool_t *pool,
  191.     ngx_str_t *s);


  194. ngx_int_t ngx_ssl_handshake(ngx_connection_t *c);
  195. ssize_t ngx_ssl_recv(ngx_connection_t *c, u_char *buf, size_t size);
  196. ssize_t ngx_ssl_write(ngx_connection_t *c, u_char *data, size_t size);
  197. ssize_t ngx_ssl_recv_chain(ngx_connection_t *c, ngx_chain_t *cl, off_t limit);
  198. ngx_chain_t *ngx_ssl_send_chain(ngx_connection_t *c, ngx_chain_t *in,
  199.     off_t limit);
  200. void ngx_ssl_free_buffer(ngx_connection_t *c);
  201. ngx_int_t ngx_ssl_shutdown(ngx_connection_t *c);
  202. void ngx_cdecl ngx_ssl_error(ngx_uint_t level, ngx_log_t *log, ngx_err_t err,
  203.     char *fmt, ...);
  204. void ngx_ssl_cleanup_ctx(void *data);


  207. extern int  ngx_ssl_connection_index;
  208. extern int  ngx_ssl_server_conf_index;
  209. extern int  ngx_ssl_session_cache_index;
  210. extern int  ngx_ssl_session_ticket_keys_index;
  211. extern int  ngx_ssl_certificate_index;
  212. extern int  ngx_ssl_stapling_index;


  215. #endif /* _NGX_EVENT_OPENSSL_H_INCLUDED_ */

One Level Up Top Level