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 TOR_TLS_ERROR       -4
  23 #define TOR_TLS_CLOSE       -3
  24 #define TOR_TLS_WANTREAD    -2
  25 #define TOR_TLS_WANTWRITE   -1
  26 #define TOR_TLS_DONE         0
  27
  28 void tor_tls_free_all(void);
  29 int tor_tls_context_new(crypto_pk_env_t *rsa,
  30                         const char *nickname, unsigned int key_lifetime);
  31 tor_tls_t *tor_tls_new(int sock, int is_server);
  32 int tor_tls_is_server(tor_tls_t *tls);
  33 void tor_tls_free(tor_tls_t *tls);
  34 int tor_tls_peer_has_cert(tor_tls_t *tls);
  35 int tor_tls_get_peer_cert_nickname(int severity, tor_tls_t *tls,
  36                                    char *buf, size_t buflen);
  37 int tor_tls_verify(int severity, tor_tls_t *tls, crypto_pk_env_t **identity);
  38 int tor_tls_check_lifetime(tor_tls_t *tls, int tolerance);
  39 int tor_tls_read(tor_tls_t *tls, char *cp, size_t len);
  40 int tor_tls_write(tor_tls_t *tls, char *cp, size_t n);
  41 int tor_tls_handshake(tor_tls_t *tls);
  42 int tor_tls_shutdown(tor_tls_t *tls);
  43 int tor_tls_get_pending_bytes(tor_tls_t *tls);
  44 size_t tor_tls_get_forced_write_size(tor_tls_t *tls);
  45
  46 unsigned long tor_tls_get_n_bytes_read(tor_tls_t *tls);
  47 unsigned long tor_tls_get_n_bytes_written(tor_tls_t *tls);
  48
  49 /* Log and abort if there are unhandled TLS errors in OpenSSL's error stack.
  50  */
  51 #define check_no_tls_errors() _check_no_tls_errors(__FILE__,__LINE__)
  52
  53 void _check_no_tls_errors(const char *fname, int line);
  54
  55 #endif
  56