nginx/src/event/ngx_event_openssl.h

   1
   2 /*
   3  * Copyright (C) Igor Sysoev
   4  */
   5
   6
   7 #ifndef _NGX_EVENT_OPENSSL_H_INCLUDED_
   8 #define _NGX_EVENT_OPENSSL_H_INCLUDED_
   9
  10
  11 #include <ngx_config.h>
  12 #include <ngx_core.h>
  13
  14 #include <openssl/ssl.h>
  15 #include <openssl/err.h>
  16
  17 #if OPENSSL_VERSION_NUMBER >= 0x00907000
  18 #include <openssl/conf.h>
  19 #include <openssl/engine.h>
  20 #define NGX_SSL_ENGINE   1
  21 #endif
  22
  23 #define NGX_SSL_NAME     "OpenSSL"
  24
  25
  26 #define ngx_ssl_session_t       SSL_SESSION
  27 #define ngx_ssl_conn_t          SSL
  28
  29
  30 typedef struct {
  31     SSL_CTX                    *ctx;
  32     ngx_log_t                  *log;
  33 } ngx_ssl_t;
  34
  35
  36 typedef struct {
  37     ngx_ssl_conn_t             *connection;
  38
  39     ngx_int_t                   last;
  40     ngx_buf_t                  *buf;
  41
  42     ngx_connection_handler_pt   handler;
  43
  44     ngx_event_handler_pt        saved_read_handler;
  45     ngx_event_handler_pt        saved_write_handler;
  46
  47     unsigned                    handshaked:1;
  48     unsigned                    buffer:1;
  49     unsigned                    no_wait_shutdown:1;
  50     unsigned                    no_send_shutdown:1;
  51 } ngx_ssl_connection_t;
  52
  53
  54 #define NGX_SSL_NO_SCACHE            -2
  55 #define NGX_SSL_NONE_SCACHE          -3
  56 #define NGX_SSL_NO_BUILTIN_SCACHE    -4
  57 #define NGX_SSL_DFLT_BUILTIN_SCACHE  -5
  58
  59
  60 #define NGX_SSL_MAX_SESSION_SIZE  4096
  61
  62 typedef struct ngx_ssl_sess_id_s  ngx_ssl_sess_id_t;
  63
  64 struct ngx_ssl_sess_id_s {
  65     ngx_rbtree_node_t           node;
  66     u_char                     *id;
  67     size_t                      len;
  68     u_char                     *session;
  69     ngx_queue_t                 queue;
  70     time_t                      expire;
  71 #if (NGX_PTR_SIZE == 8)
  72     void                       *stub;
  73     u_char                      sess_id[32];
  74 #endif
  75 };
  76
  77
  78 typedef struct {
  79     ngx_rbtree_t                session_rbtree;
  80     ngx_rbtree_node_t           sentinel;
  81     ngx_queue_t                 expire_queue;
  82 } ngx_ssl_session_cache_t;
  83
  84
  85
  86 #define NGX_SSL_SSLv2    2
  87 #define NGX_SSL_SSLv3    4
  88 #define NGX_SSL_TLSv1    8
  89
  90
  91 #define NGX_SSL_BUFFER   1
  92 #define NGX_SSL_CLIENT   2
  93
  94 #define NGX_SSL_BUFSIZE  16384
  95
  96
  97 ngx_int_t ngx_ssl_init(ngx_log_t *log);
  98 ngx_int_t ngx_ssl_create(ngx_ssl_t *ssl, ngx_uint_t protocols, void *data);
  99 ngx_int_t ngx_ssl_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
 100     ngx_str_t *cert, ngx_str_t *key);
 101 ngx_int_t ngx_ssl_client_certificate(ngx_conf_t *cf, ngx_ssl_t *ssl,
 102     ngx_str_t *cert, ngx_int_t depth);
 103 ngx_int_t ngx_ssl_generate_rsa512_key(ngx_ssl_t *ssl);
 104 ngx_int_t ngx_ssl_dhparam(ngx_conf_t *cf, ngx_ssl_t *ssl, ngx_str_t *file);
 105 ngx_int_t ngx_ssl_session_cache(ngx_ssl_t *ssl, ngx_str_t *sess_ctx,
 106     ssize_t builtin_session_cache, ngx_shm_zone_t *shm_zone, time_t timeout);
 107 ngx_int_t ngx_ssl_create_connection(ngx_ssl_t *ssl, ngx_connection_t *c,
 108     ngx_uint_t flags);
 109
 110 void ngx_ssl_remove_cached_session(SSL_CTX *ssl, ngx_ssl_session_t *sess);
 111 ngx_int_t ngx_ssl_set_session(ngx_connection_t *c, ngx_ssl_session_t *session);
 112 #define ngx_ssl_get_session(c)      SSL_get1_session(c->ssl->connection)
 113 #define ngx_ssl_free_session        SSL_SESSION_free
 114 #define ngx_ssl_get_connection(ssl_conn)                                      \
 115     SSL_get_ex_data(ssl_conn, ngx_ssl_connection_index)
 116 #define ngx_ssl_get_server_conf(ssl_ctx)                                      \
 117     SSL_CTX_get_ex_data(ssl_ctx, ngx_ssl_server_conf_index)
 118
 119
 120 ngx_int_t ngx_ssl_get_protocol(ngx_connection_t *c, ngx_pool_t *pool,
 121     ngx_str_t *s);
 122 ngx_int_t ngx_ssl_get_cipher_name(ngx_connection_t *c, ngx_pool_t *pool,
 123     ngx_str_t *s);
 124 ngx_int_t ngx_ssl_get_raw_certificate(ngx_connection_t *c, ngx_pool_t *pool,
 125     ngx_str_t *s);
 126 ngx_int_t ngx_ssl_get_certificate(ngx_connection_t *c, ngx_pool_t *pool,
 127     ngx_str_t *s);
 128 ngx_int_t ngx_ssl_get_subject_dn(ngx_connection_t *c, ngx_pool_t *pool,
 129     ngx_str_t *s);
 130 ngx_int_t ngx_ssl_get_issuer_dn(ngx_connection_t *c, ngx_pool_t *pool,
 131     ngx_str_t *s);
 132 ngx_int_t ngx_ssl_get_serial_number(ngx_connection_t *c, ngx_pool_t *pool,
 133     ngx_str_t *s);
 134
 135
 136 ngx_int_t ngx_ssl_handshake(ngx_connection_t *c);
 137 ssize_t ngx_ssl_recv(ngx_connection_t *c, u_char *buf, size_t size);
 138 ssize_t ngx_ssl_write(ngx_connection_t *c, u_char *data, size_t size);
 139 ssize_t ngx_ssl_recv_chain(ngx_connection_t *c, ngx_chain_t *cl);
 140 ngx_chain_t *ngx_ssl_send_chain(ngx_connection_t *c, ngx_chain_t *in,
 141     off_t limit);
 142 void ngx_ssl_free_buffer(ngx_connection_t *c);
 143 ngx_int_t ngx_ssl_shutdown(ngx_connection_t *c);
 144 void ngx_cdecl ngx_ssl_error(ngx_uint_t level, ngx_log_t *log, ngx_err_t err,
 145     char *fmt, ...);
 146 void ngx_ssl_cleanup_ctx(void *data);
 147
 148
 149 extern int  ngx_ssl_connection_index;
 150 extern int  ngx_ssl_server_conf_index;
 151 extern int  ngx_ssl_session_cache_index;
 152
 153
 154 #endif /* _NGX_EVENT_OPENSSL_H_INCLUDED_ */