src/common/tortls.h

   1 /* Copyright 2003 Roger Dingledine
   2  * Copyright 2004-2006 Roger Dingledine, Nick Mathewson */
   3 /* See LICENSE for licensing information */
   4 /* $Id$ */
   5
   6 #ifndef _TORTLS_H
   7 #define _TORTLS_H
   8 #define TORTLS_H_ID "$Id$"
   9
  10 /**
  11  * \file tortls.h
  12  * \brief Headers for tortls.c
  13  **/
  14
  15 #include "../common/crypto.h"
  16 #include "../common/compat.h"
  17
  18 /* Opaque structure to hold a TLS connection. */
  19 typedef struct tor_tls_t tor_tls_t;
  20
  21 /* Possible return values for most tor_tls_* functions. */
  22 #define _MIN_TOR_TLS_ERROR_VAL     -9
  23 #define TOR_TLS_ERROR_MISC         -9
  24 #define TOR_TLS_ERROR_IO           -8
  25 #define TOR_TLS_ERROR_CONNREFUSED  -7
  26 #define TOR_TLS_ERROR_CONNRESET    -6
  27 #define TOR_TLS_ERROR_NO_ROUTE     -5
  28 #define TOR_TLS_ERROR_TIMEOUT      -4
  29 #define TOR_TLS_CLOSE              -3
  30 #define TOR_TLS_WANTREAD           -2
  31 #define TOR_TLS_WANTWRITE          -1
  32 #define TOR_TLS_DONE                0
  33
  34 /* Use this macro in a switch statement to catch _any_ TLS error.  That way,
  35  * if more errors are added, your switches will still work. */
  36 #define CASE_TOR_TLS_ERROR_ANY                  \
  37   case TOR_TLS_ERROR_MISC:                      \
  38   case TOR_TLS_ERROR_IO:                        \
  39   case TOR_TLS_ERROR_CONNREFUSED:               \
  40   case TOR_TLS_ERROR_CONNRESET:                 \
  41   case TOR_TLS_ERROR_NO_ROUTE:                  \
  42   case TOR_TLS_ERROR_TIMEOUT
  43
  44 #define TOR_TLS_IS_ERROR(rv) ((rv) < TOR_TLS_CLOSE)
  45
  46 void tor_tls_free_all(void);
  47 int tor_tls_context_new(crypto_pk_env_t *rsa,
  48                         const char *nickname, unsigned int key_lifetime);
  49 tor_tls_t *tor_tls_new(int sock, int is_server);
  50 int tor_tls_is_server(tor_tls_t *tls);
  51 void tor_tls_free(tor_tls_t *tls);
  52 int tor_tls_peer_has_cert(tor_tls_t *tls);
  53 int tor_tls_get_peer_cert_nickname(int severity, tor_tls_t *tls,
  54                                    char *buf, size_t buflen);
  55 int tor_tls_verify(int severity, tor_tls_t *tls, crypto_pk_env_t **identity);
  56 int tor_tls_check_lifetime(tor_tls_t *tls, int tolerance);
  57 int tor_tls_read(tor_tls_t *tls, char *cp, size_t len);
  58 int tor_tls_write(tor_tls_t *tls, const char *cp, size_t n);
  59 int tor_tls_handshake(tor_tls_t *tls);
  60 int tor_tls_shutdown(tor_tls_t *tls);
  61 int tor_tls_get_pending_bytes(tor_tls_t *tls);
  62 size_t tor_tls_get_forced_write_size(tor_tls_t *tls);
  63
  64 void tor_tls_get_n_raw_bytes(tor_tls_t *tls,
  65                              size_t *n_read, size_t *n_written);
  66
  67 /* Log and abort if there are unhandled TLS errors in OpenSSL's error stack.
  68  */
  69 #define check_no_tls_errors() _check_no_tls_errors(__FILE__,__LINE__)
  70
  71 void _check_no_tls_errors(const char *fname, int line);
  72
  73 #endif
  74