libevent/include/event2/bufferevent_ssl.h

   1 /*
   2  * Copyright (c) 2009-2012 Niels Provos and Nick Mathewson
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  * 3. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26 #ifndef _EVENT2_BUFFEREVENT_SSL_H_
  27 #define _EVENT2_BUFFEREVENT_SSL_H_
  28
  29 /** @file event2/bufferevent_ssl.h
  30
  31     OpenSSL support for bufferevents.
  32  */
  33
  34 #include <event2/event-config.h>
  35 #include <event2/bufferevent.h>
  36 #include <event2/util.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /* This is what openssl's SSL objects are underneath. */
  43 struct ssl_st;
  44
  45 /**
  46    The state of an SSL object to be used when creating a new
  47    SSL bufferevent.
  48  */
  49 enum bufferevent_ssl_state {
  50         BUFFEREVENT_SSL_OPEN = 0,
  51         BUFFEREVENT_SSL_CONNECTING = 1,
  52         BUFFEREVENT_SSL_ACCEPTING = 2
  53 };
  54
  55 #if defined(_EVENT_HAVE_OPENSSL) || defined(_EVENT_IN_DOXYGEN)
  56 /**
  57    Create a new SSL bufferevent to send its data over another bufferevent.
  58
  59    @param base An event_base to use to detect reading and writing.  It
  60       must also be the base for the underlying bufferevent.
  61    @param underlying A socket to use for this SSL
  62    @param ssl A SSL* object from openssl.
  63    @param state The current state of the SSL connection
  64    @param options One or more bufferevent_options
  65    @return A new bufferevent on success, or NULL on failure
  66 */
  67 struct bufferevent *
  68 bufferevent_openssl_filter_new(struct event_base *base,
  69     struct bufferevent *underlying,
  70     struct ssl_st *ssl,
  71     enum bufferevent_ssl_state state,
  72     int options);
  73
  74 /**
  75    Create a new SSL bufferevent to send its data over an SSL * on a socket.
  76
  77    @param base An event_base to use to detect reading and writing
  78    @param fd A socket to use for this SSL
  79    @param ssl A SSL* object from openssl.
  80    @param state The current state of the SSL connection
  81    @param options One or more bufferevent_options
  82    @return A new bufferevent on success, or NULL on failure.
  83 */
  84 struct bufferevent *
  85 bufferevent_openssl_socket_new(struct event_base *base,
  86     evutil_socket_t fd,
  87     struct ssl_st *ssl,
  88     enum bufferevent_ssl_state state,
  89     int options);
  90
  91 /** Return the underlying openssl SSL * object for an SSL bufferevent. */
  92 struct ssl_st *
  93 bufferevent_openssl_get_ssl(struct bufferevent *bufev);
  94
  95 /** Tells a bufferevent to begin SSL renegotiation. */
  96 int bufferevent_ssl_renegotiate(struct bufferevent *bev);
  97
  98 /** Return the most recent OpenSSL error reported on an SSL bufferevent. */
  99 unsigned long bufferevent_get_openssl_error(struct bufferevent *bev);
 100
 101 #endif
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* _EVENT2_BUFFEREVENT_SSL_H_ */