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 2 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, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include "lib/events/events.h"
25 #include "lib/socket/socket.h"
26 #include "lib/tls/tls.h"
29 #include "gnutls/gnutls.h"
33 /* hold persistent tls data */
35 gnutls_certificate_credentials x509_cred;
36 gnutls_dh_params dh_params;
40 /* hold per connection tls data */
42 struct socket_context *socket;
44 gnutls_session session;
50 const char *plain_chars;
52 gnutls_certificate_credentials xcred;
56 #define TLSCHECK(call) do { \
59 DEBUG(0,("TLS %s - %s\n", #call, gnutls_strerror(ret))); \
67 callback for reading from a socket
69 static ssize_t tls_pull(gnutls_transport_ptr ptr, void *buf, size_t size)
71 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
75 if (tls->have_first_byte) {
76 *(uint8_t *)buf = tls->first_byte;
77 tls->have_first_byte = False;
81 status = socket_recv(tls->socket, buf, size, &nread, 0);
82 if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
85 if (NT_STATUS_IS_ERR(status)) {
86 EVENT_FD_NOT_READABLE(tls->fde);
87 EVENT_FD_NOT_WRITEABLE(tls->fde);
91 if (!NT_STATUS_IS_OK(status)) {
92 EVENT_FD_READABLE(tls->fde);
96 if (tls->output_pending) {
97 EVENT_FD_WRITEABLE(tls->fde);
100 EVENT_FD_READABLE(tls->fde);
106 callback for writing to a socket
108 static ssize_t tls_push(gnutls_transport_ptr ptr, const void *buf, size_t size)
110 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
115 if (!tls->tls_enabled) {
119 b.data = discard_const(buf);
122 status = socket_send(tls->socket, &b, &nwritten, 0);
123 if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
127 if (!NT_STATUS_IS_OK(status)) {
128 EVENT_FD_WRITEABLE(tls->fde);
131 if (size != nwritten) {
132 EVENT_FD_WRITEABLE(tls->fde);
138 destroy a tls session
140 static int tls_destructor(void *ptr)
142 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
144 ret = gnutls_bye(tls->session, GNUTLS_SHUT_WR);
146 DEBUG(0,("TLS gnutls_bye failed - %s\n", gnutls_strerror(ret)));
153 possibly continue the handshake process
155 static NTSTATUS tls_handshake(struct tls_context *tls)
159 if (tls->done_handshake) {
163 ret = gnutls_handshake(tls->session);
164 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
165 if (gnutls_record_get_direction(tls->session) == 1) {
166 EVENT_FD_WRITEABLE(tls->fde);
168 return STATUS_MORE_ENTRIES;
171 DEBUG(0,("TLS gnutls_handshake failed - %s\n", gnutls_strerror(ret)));
172 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
174 tls->done_handshake = True;
179 possibly continue an interrupted operation
181 static NTSTATUS tls_interrupted(struct tls_context *tls)
185 if (!tls->interrupted) {
188 if (gnutls_record_get_direction(tls->session) == 1) {
189 ret = gnutls_record_send(tls->session, NULL, 0);
191 ret = gnutls_record_recv(tls->session, NULL, 0);
193 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
194 return STATUS_MORE_ENTRIES;
196 tls->interrupted = False;
201 see how many bytes are pending on the connection
203 NTSTATUS tls_socket_pending(struct tls_context *tls, size_t *npending)
205 if (!tls->tls_enabled || tls->tls_detect) {
206 return socket_pending(tls->socket, npending);
208 *npending = gnutls_record_check_pending(tls->session);
209 if (*npending == 0) {
210 NTSTATUS status = socket_pending(tls->socket, npending);
211 if (*npending == 0) {
212 /* seems to be a gnutls bug */
221 receive data either by tls or normal socket_recv
223 NTSTATUS tls_socket_recv(struct tls_context *tls, void *buf, size_t wantlen,
228 if (tls->tls_enabled && tls->tls_detect) {
229 status = socket_recv(tls->socket, &tls->first_byte, 1, nread, 0);
230 NT_STATUS_NOT_OK_RETURN(status);
231 if (*nread == 0) return NT_STATUS_OK;
232 tls->tls_detect = False;
233 /* look for the first byte of a valid HTTP operation */
234 if (strchr(tls->plain_chars, tls->first_byte)) {
236 tls->tls_enabled = False;
237 *(uint8_t *)buf = tls->first_byte;
240 tls->have_first_byte = True;
243 if (!tls->tls_enabled) {
244 return socket_recv(tls->socket, buf, wantlen, nread, 0);
247 status = tls_handshake(tls);
248 NT_STATUS_NOT_OK_RETURN(status);
250 status = tls_interrupted(tls);
251 NT_STATUS_NOT_OK_RETURN(status);
253 ret = gnutls_record_recv(tls->session, buf, wantlen);
254 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
255 if (gnutls_record_get_direction(tls->session) == 1) {
256 EVENT_FD_WRITEABLE(tls->fde);
258 tls->interrupted = True;
259 return STATUS_MORE_ENTRIES;
262 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
270 send data either by tls or normal socket_recv
272 NTSTATUS tls_socket_send(struct tls_context *tls, const DATA_BLOB *blob, size_t *sendlen)
277 if (!tls->tls_enabled) {
278 return socket_send(tls->socket, blob, sendlen, 0);
281 status = tls_handshake(tls);
282 NT_STATUS_NOT_OK_RETURN(status);
284 status = tls_interrupted(tls);
285 NT_STATUS_NOT_OK_RETURN(status);
287 ret = gnutls_record_send(tls->session, blob->data, blob->length);
288 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
289 if (gnutls_record_get_direction(tls->session) == 1) {
290 EVENT_FD_WRITEABLE(tls->fde);
292 tls->interrupted = True;
293 return STATUS_MORE_ENTRIES;
296 DEBUG(0,("gnutls_record_send of %d failed - %s\n", blob->length, gnutls_strerror(ret)));
297 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
300 tls->output_pending = (ret < blob->length);
306 initialise global tls state
308 struct tls_params *tls_initialise(TALLOC_CTX *mem_ctx)
310 struct tls_params *params;
312 TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
313 const char *keyfile = private_path(tmp_ctx, lp_tls_keyfile());
314 const char *certfile = private_path(tmp_ctx, lp_tls_certfile());
315 const char *cafile = private_path(tmp_ctx, lp_tls_cafile());
316 const char *crlfile = private_path(tmp_ctx, lp_tls_crlfile());
317 void tls_cert_generate(TALLOC_CTX *, const char *, const char *, const char *);
319 params = talloc(mem_ctx, struct tls_params);
320 if (params == NULL) {
321 talloc_free(tmp_ctx);
325 if (!lp_tls_enabled() || keyfile == NULL || *keyfile == 0) {
326 params->tls_enabled = False;
327 talloc_free(tmp_ctx);
331 if (!file_exist(cafile)) {
332 tls_cert_generate(params, keyfile, certfile, cafile);
335 ret = gnutls_global_init();
336 if (ret < 0) goto init_failed;
338 gnutls_certificate_allocate_credentials(¶ms->x509_cred);
339 if (ret < 0) goto init_failed;
341 if (cafile && *cafile) {
342 ret = gnutls_certificate_set_x509_trust_file(params->x509_cred, cafile,
343 GNUTLS_X509_FMT_PEM);
345 DEBUG(0,("TLS failed to initialise cafile %s\n", cafile));
350 if (crlfile && *crlfile) {
351 ret = gnutls_certificate_set_x509_crl_file(params->x509_cred,
353 GNUTLS_X509_FMT_PEM);
355 DEBUG(0,("TLS failed to initialise crlfile %s\n", crlfile));
360 ret = gnutls_certificate_set_x509_key_file(params->x509_cred,
362 GNUTLS_X509_FMT_PEM);
364 DEBUG(0,("TLS failed to initialise certfile %s and keyfile %s\n",
369 ret = gnutls_dh_params_init(¶ms->dh_params);
370 if (ret < 0) goto init_failed;
372 ret = gnutls_dh_params_generate2(params->dh_params, DH_BITS);
373 if (ret < 0) goto init_failed;
375 gnutls_certificate_set_dh_params(params->x509_cred, params->dh_params);
377 params->tls_enabled = True;
379 talloc_free(tmp_ctx);
383 DEBUG(0,("GNUTLS failed to initialise - %s\n", gnutls_strerror(ret)));
384 params->tls_enabled = False;
385 talloc_free(tmp_ctx);
391 setup for a new connection
393 struct tls_context *tls_init_server(struct tls_params *params,
394 struct socket_context *socket,
395 struct fd_event *fde,
396 const char *plain_chars,
399 struct tls_context *tls;
402 tls = talloc(socket, struct tls_context);
403 if (tls == NULL) return NULL;
405 tls->socket = socket;
408 if (!params->tls_enabled || !tls_enable) {
409 tls->tls_enabled = False;
413 TLSCHECK(gnutls_init(&tls->session, GNUTLS_SERVER));
415 talloc_set_destructor(tls, tls_destructor);
417 TLSCHECK(gnutls_set_default_priority(tls->session));
418 TLSCHECK(gnutls_credentials_set(tls->session, GNUTLS_CRD_CERTIFICATE,
420 gnutls_certificate_server_set_request(tls->session, GNUTLS_CERT_REQUEST);
421 gnutls_dh_set_prime_bits(tls->session, DH_BITS);
422 gnutls_transport_set_ptr(tls->session, (gnutls_transport_ptr)tls);
423 gnutls_transport_set_pull_function(tls->session, (gnutls_pull_func)tls_pull);
424 gnutls_transport_set_push_function(tls->session, (gnutls_push_func)tls_push);
425 gnutls_transport_set_lowat(tls->session, 0);
427 tls->plain_chars = plain_chars;
429 tls->tls_detect = True;
431 tls->tls_detect = False;
434 tls->output_pending = False;
435 tls->done_handshake = False;
436 tls->have_first_byte = False;
437 tls->tls_enabled = True;
438 tls->interrupted = False;
443 DEBUG(0,("TLS init connection failed - %s\n", gnutls_strerror(ret)));
444 tls->tls_enabled = False;
445 params->tls_enabled = False;
451 setup for a new client connection
453 struct tls_context *tls_init_client(struct socket_context *socket,
454 struct fd_event *fde,
457 struct tls_context *tls;
459 const int cert_type_priority[] = { GNUTLS_CRT_X509, GNUTLS_CRT_OPENPGP, 0 };
462 tls = talloc(socket, struct tls_context);
463 if (tls == NULL) return NULL;
465 tls->socket = socket;
467 tls->tls_enabled = tls_enable;
469 if (!tls->tls_enabled) {
473 cafile = private_path(tls, lp_tls_cafile());
474 if (!cafile || !*cafile) {
478 gnutls_global_init();
480 gnutls_certificate_allocate_credentials(&tls->xcred);
481 gnutls_certificate_set_x509_trust_file(tls->xcred, cafile, GNUTLS_X509_FMT_PEM);
483 TLSCHECK(gnutls_init(&tls->session, GNUTLS_CLIENT));
484 TLSCHECK(gnutls_set_default_priority(tls->session));
485 gnutls_certificate_type_set_priority(tls->session, cert_type_priority);
486 TLSCHECK(gnutls_credentials_set(tls->session, GNUTLS_CRD_CERTIFICATE, tls->xcred));
488 talloc_set_destructor(tls, tls_destructor);
490 gnutls_transport_set_ptr(tls->session, (gnutls_transport_ptr)tls);
491 gnutls_transport_set_pull_function(tls->session, (gnutls_pull_func)tls_pull);
492 gnutls_transport_set_push_function(tls->session, (gnutls_push_func)tls_push);
493 gnutls_transport_set_lowat(tls->session, 0);
494 tls->tls_detect = False;
496 tls->output_pending = False;
497 tls->done_handshake = False;
498 tls->have_first_byte = False;
499 tls->tls_enabled = True;
500 tls->interrupted = False;
505 DEBUG(0,("TLS init connection failed - %s\n", gnutls_strerror(ret)));
506 tls->tls_enabled = False;
510 BOOL tls_enabled(struct tls_context *tls)
512 return tls->tls_enabled;
515 BOOL tls_support(struct tls_params *params)
517 return params->tls_enabled;
522 /* for systems without tls we just map the tls socket calls to the
523 normal socket calls */
525 struct tls_params *tls_initialise(TALLOC_CTX *mem_ctx)
527 return talloc_new(mem_ctx);
530 struct tls_context *tls_init_server(struct tls_params *params,
531 struct socket_context *sock,
532 struct fd_event *fde,
533 const char *plain_chars,
536 if (tls_enable && plain_chars == NULL) return NULL;
537 return (struct tls_context *)sock;
540 struct tls_context *tls_init_client(struct socket_context *sock,
541 struct fd_event *fde,
544 return (struct tls_context *)sock;
548 NTSTATUS tls_socket_recv(struct tls_context *tls, void *buf, size_t wantlen,
551 return socket_recv((struct socket_context *)tls, buf, wantlen, nread, 0);
554 NTSTATUS tls_socket_send(struct tls_context *tls, const DATA_BLOB *blob, size_t *sendlen)
556 return socket_send((struct socket_context *)tls, blob, sendlen, 0);
559 BOOL tls_enabled(struct tls_context *tls)
564 BOOL tls_support(struct tls_params *params)
569 NTSTATUS tls_socket_pending(struct tls_context *tls, size_t *npending)
571 return socket_pending((struct socket_context *)tls, npending);