src/libtls/tls_server.h

   1 /*
   2  * Copyright (C) 2010 Martin Willi
   3  * Copyright (C) 2010 revosec AG
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /**
  17  * @defgroup tls_server tls_server
  18  * @{ @ingroup libtls
  19  */
  20
  21 #ifndef TLS_SERVER_H_
  22 #define TLS_SERVER_H_
  23
  24 typedef struct tls_server_t tls_server_t;
  25
  26 #include "tls_handshake.h"
  27 #include "tls_crypto.h"
  28
  29 #include <library.h>
  30
  31 /**
  32  * TLS handshake protocol handler as peer.
  33  */
  34 struct tls_server_t {
  35
  36         /**
  37          * Implements the TLS handshake protocol handler.
  38          */
  39         tls_handshake_t handshake;
  40 };
  41
  42 /**
  43  * Create a tls_server instance.
  44  *
  45  * If a peer identity is given, the client must authenticate with a valid
  46  * certificate for this identity, or the connection fails. If peer is NULL,
  47  * but the client authenticates nonetheless, the authenticated identity
  48  * gets returned by tls_handshake_t.get_peer_id().
  49  *
  50  * @param tls           TLS stack
  51  * @param crypto        TLS crypto helper
  52  * @param alert         TLS alert handler
  53  * @param server        server identity
  54  * @param peer          peer identity, or NULL
  55  */
  56 tls_server_t *tls_server_create(tls_t *tls,
  57                                                 tls_crypto_t *crypto, tls_alert_t *alert,
  58                                                 identification_t *server, identification_t *peer);
  59
  60 #endif /** TLS_SERVER_H_ @}*/