2 Unix SMB/CIFS implementation.
4 transport layer security handling code
6 Copyright (C) Andrew Tridgell 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "lib/socket/socket.h"
27 struct loadparm_context;
30 call tls_initialise() once per task to startup the tls subsystem
32 struct tls_params *tls_initialise(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx);
35 call tls_init_server() on each new server connection
37 the 'plain_chars' parameter is a list of chars that when they occur
38 as the first character from the client on the connection tell the
39 tls code that this is a non-tls connection. This can be used to have
40 tls and non-tls servers on the same port. If this is NULL then only
41 tls connections will be allowed
43 struct socket_context *tls_init_server(struct tls_params *parms,
44 struct socket_context *sock,
45 struct tevent_fd *fde,
46 const char *plain_chars);
49 call tls_init_client() on each new client connection
51 struct socket_context *tls_init_client(struct socket_context *sock,
52 struct tevent_fd *fde,
56 return True if a connection used tls
58 bool tls_enabled(struct socket_context *tls);
62 true if tls support is compiled in
64 bool tls_support(struct tls_params *parms);
66 const struct socket_ops *socket_tls_ops(enum socket_type type);
68 struct tstream_context;
69 struct tstream_tls_params;
72 * @brief Initiate a TLS tunnel on top of a given tstream
77 * @param[in] plain_stream The plain tstream which is used as transport.
78 * It's important that the caller keeps the "plain"
79 * tstream_context arround during the whole life
80 * time of the "tls" tstream_context!
81 * Note: tstream_disconnect_send()/recv() doesn't
82 * disconnect the "plain" tstream_context.
84 * @param[in] tls_params ...
88 * @see tstream_tls_connect_recv
91 struct tevent_req *tstream_tls_connect_send(TALLOC_CTX *mem_ctx,
92 struct tevent_context *ev,
93 struct tstream_context *plain_stream,
94 struct tstream_tls_params *tls_params);
96 struct tevent_req *_tstream_tls_connect_send(TALLOC_CTX *mem_ctx,
97 struct tevent_context *ev,
98 struct tstream_context *plain_stream,
99 struct tstream_tls_params *tls_params,
100 const char *location);
101 #define tstream_tls_connect_send(mem_ctx, ev, plain_stream, tls_params); \
102 _tstream_tls_connect_send(mem_ctx, ev, plain_stream, tls_params, __location__)
106 * @brief Receives the async result of tevent_tls_connect_send
114 * @param[out] tls_stream
118 * @see tstream_tls_connect_send
120 int tstream_tls_connect_recv(struct tevent_req *req,
123 struct tstream_context **tls_stream);
126 * @brief Accept a TLS tunnel on top of a given tstream
131 * @param[in] plain_stream The plain tstream which is used as transport.
132 * It's important that the caller keeps the "plain"
133 * tstream_context arround during the whole life
134 * time of the "tls" tstream_context!
135 * Note: tstream_disconnect_send()/recv() doesn't
136 * disconnect the "plain" tstream_context.
138 * @param[in] tls_params ...
142 * @see tstream_tls_accept_recv
145 struct tevent_req *tstream_tls_accept_send(TALLOC_CTX *mem_ctx,
146 struct tevent_context *ev,
147 struct tstream_context *plain_stream,
148 struct tstream_tls_params *tls_params);
150 struct tevent_req *_tstream_tls_accept_send(TALLOC_CTX *mem_ctx,
151 struct tevent_context *ev,
152 struct tstream_context *plain_stream,
153 struct tstream_tls_params *tls_params,
154 const char *location);
155 #define tstream_tls_accept_send(mem_ctx, ev, plain_stream, tls_params); \
156 _tstream_tls_accept_send(mem_ctx, ev, plain_stream, tls_params, __location__)
160 * @brief Receives the async result of tevent_tls_accept_send
168 * @param[out] tls_stream
172 * @see tstream_tls_accept_send
174 int tstream_tls_accept_recv(struct tevent_req *req,
177 struct tstream_context **tls_stream);