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