bufferevent_ssl.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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. /** @file event2/bufferevent_ssl.h
  29. OpenSSL support for bufferevents.
  30. */
  31. #include <event2/event-config.h>
  32. #include <event2/bufferevent.h>
  33. #include <event2/util.h>
  34. #ifdef __cplusplus
  35. extern "C" {
  36. #endif
  37. /* This is what openssl's SSL objects are underneath. */
  38. struct ssl_st;
  39. /**
  40. The state of an SSL object to be used when creating a new
  41. SSL bufferevent.
  42. */
  43. enum bufferevent_ssl_state {
  44. BUFFEREVENT_SSL_OPEN = 0,
  45. BUFFEREVENT_SSL_CONNECTING = 1,
  46. BUFFEREVENT_SSL_ACCEPTING = 2
  47. };
  48. #if defined(_EVENT_HAVE_OPENSSL) || defined(_EVENT_IN_DOXYGEN)
  49. /**
  50. Create a new SSL bufferevent to send its data over another bufferevent.
  51. @param base An event_base to use to detect reading and writing. It
  52. must also be the base for the underlying bufferevent.
  53. @param underlying A socket to use for this SSL
  54. @param ssl A SSL* object from openssl.
  55. @param state The current state of the SSL connection
  56. @param options One or more bufferevent_options
  57. @return A new bufferevent on success, or NULL on failure
  58. */
  59. struct bufferevent *
  60. bufferevent_openssl_filter_new(struct event_base *base,
  61. struct bufferevent *underlying,
  62. struct ssl_st *ssl,
  63. enum bufferevent_ssl_state state,
  64. int options);
  65. /**
  66. Create a new SSL bufferevent to send its data over an SSL * on a socket.
  67. @param base An event_base to use to detect reading and writing
  68. @param fd A socket to use for this SSL
  69. @param ssl A SSL* object from openssl.
  70. @param state The current state of the SSL connection
  71. @param options One or more bufferevent_options
  72. @return A new bufferevent on success, or NULL on failure.
  73. */
  74. struct bufferevent *
  75. bufferevent_openssl_socket_new(struct event_base *base,
  76. evutil_socket_t fd,
  77. struct ssl_st *ssl,
  78. enum bufferevent_ssl_state state,
  79. int options);
  80. /** Return the underlying openssl SSL * object for an SSL bufferevent. */
  81. struct ssl_st *
  82. bufferevent_openssl_get_ssl(struct bufferevent *bufev);
  83. /** Tells a bufferevent to begin SSL renegotiation. */
  84. int bufferevent_ssl_renegotiate(struct bufferevent *bev);
  85. /** Return the most recent OpenSSL error reported on an SSL bufferevent. */
  86. unsigned long bufferevent_get_openssl_error(struct bufferevent *bev);
  87. #endif
  88. #ifdef __cplusplus
  89. }
  90. #endif
  91. #endif /* _EVENT2_BUFFEREVENT_SSL_H_ */