2 Unix SMB/CIFS implementation.
4 transport layer security handling code
6 Copyright (C) Andrew Tridgell 2004-2005
7 Copyright (C) Stefan Metzmacher 2004
8 Copyright (C) Andrew Bartlett 2006
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "lib/events/events.h"
27 #include "lib/socket/socket.h"
30 #include "gnutls/gnutls.h"
34 /* hold persistent tls data */
36 gnutls_certificate_credentials x509_cred;
37 gnutls_dh_params dh_params;
42 /* hold per connection tls data */
44 struct socket_context *socket;
48 gnutls_session session;
53 const char *plain_chars;
55 gnutls_certificate_credentials xcred;
60 BOOL tls_enabled(struct socket_context *sock)
62 struct tls_context *tls;
66 if (strcmp(sock->backend_name, "tls") != 0) {
69 tls = talloc_get_type(sock->private_data, struct tls_context);
73 return tls->tls_enabled;
79 static const struct socket_ops tls_socket_ops;
81 static NTSTATUS tls_socket_init(struct socket_context *sock)
84 case SOCKET_TYPE_STREAM:
87 return NT_STATUS_INVALID_PARAMETER;
90 sock->backend_name = "tls";
95 #define TLSCHECK(call) do { \
98 DEBUG(0,("TLS %s - %s\n", #call, gnutls_strerror(ret))); \
105 callback for reading from a socket
107 static ssize_t tls_pull(gnutls_transport_ptr ptr, void *buf, size_t size)
109 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
113 if (tls->have_first_byte) {
114 *(uint8_t *)buf = tls->first_byte;
115 tls->have_first_byte = False;
119 status = socket_recv(tls->socket, buf, size, &nread);
120 if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
123 if (NT_STATUS_IS_ERR(status)) {
124 EVENT_FD_NOT_READABLE(tls->fde);
125 EVENT_FD_NOT_WRITEABLE(tls->fde);
129 if (!NT_STATUS_IS_OK(status)) {
130 EVENT_FD_READABLE(tls->fde);
134 if (tls->output_pending) {
135 EVENT_FD_WRITEABLE(tls->fde);
138 EVENT_FD_READABLE(tls->fde);
144 callback for writing to a socket
146 static ssize_t tls_push(gnutls_transport_ptr ptr, const void *buf, size_t size)
148 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
153 if (!tls->tls_enabled) {
157 b.data = discard_const(buf);
160 status = socket_send(tls->socket, &b, &nwritten);
161 if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
165 if (!NT_STATUS_IS_OK(status)) {
166 EVENT_FD_WRITEABLE(tls->fde);
169 if (size != nwritten) {
170 EVENT_FD_WRITEABLE(tls->fde);
176 destroy a tls session
178 static int tls_destructor(struct tls_context *tls)
181 ret = gnutls_bye(tls->session, GNUTLS_SHUT_WR);
183 DEBUG(0,("TLS gnutls_bye failed - %s\n", gnutls_strerror(ret)));
190 possibly continue the handshake process
192 static NTSTATUS tls_handshake(struct tls_context *tls)
196 if (tls->done_handshake) {
200 ret = gnutls_handshake(tls->session);
201 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
202 if (gnutls_record_get_direction(tls->session) == 1) {
203 EVENT_FD_WRITEABLE(tls->fde);
205 return STATUS_MORE_ENTRIES;
208 DEBUG(0,("TLS gnutls_handshake failed - %s\n", gnutls_strerror(ret)));
209 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
211 tls->done_handshake = True;
216 possibly continue an interrupted operation
218 static NTSTATUS tls_interrupted(struct tls_context *tls)
222 if (!tls->interrupted) {
225 if (gnutls_record_get_direction(tls->session) == 1) {
226 ret = gnutls_record_send(tls->session, NULL, 0);
228 ret = gnutls_record_recv(tls->session, NULL, 0);
230 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
231 return STATUS_MORE_ENTRIES;
233 tls->interrupted = False;
238 see how many bytes are pending on the connection
240 static NTSTATUS tls_socket_pending(struct socket_context *sock, size_t *npending)
242 struct tls_context *tls = talloc_get_type(sock->private_data, struct tls_context);
243 if (!tls->tls_enabled || tls->tls_detect) {
244 return socket_pending(tls->socket, npending);
246 *npending = gnutls_record_check_pending(tls->session);
247 if (*npending == 0) {
248 NTSTATUS status = socket_pending(tls->socket, npending);
249 if (*npending == 0) {
250 /* seems to be a gnutls bug */
259 receive data either by tls or normal socket_recv
261 static NTSTATUS tls_socket_recv(struct socket_context *sock, void *buf,
262 size_t wantlen, size_t *nread)
266 struct tls_context *tls = talloc_get_type(sock->private_data, struct tls_context);
268 if (tls->tls_enabled && tls->tls_detect) {
269 status = socket_recv(tls->socket, &tls->first_byte, 1, nread);
270 NT_STATUS_NOT_OK_RETURN(status);
271 if (*nread == 0) return NT_STATUS_OK;
272 tls->tls_detect = False;
273 /* look for the first byte of a valid HTTP operation */
274 if (strchr(tls->plain_chars, tls->first_byte)) {
276 tls->tls_enabled = False;
277 *(uint8_t *)buf = tls->first_byte;
280 tls->have_first_byte = True;
283 if (!tls->tls_enabled) {
284 return socket_recv(tls->socket, buf, wantlen, nread);
287 status = tls_handshake(tls);
288 NT_STATUS_NOT_OK_RETURN(status);
290 status = tls_interrupted(tls);
291 NT_STATUS_NOT_OK_RETURN(status);
293 ret = gnutls_record_recv(tls->session, buf, wantlen);
294 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
295 if (gnutls_record_get_direction(tls->session) == 1) {
296 EVENT_FD_WRITEABLE(tls->fde);
298 tls->interrupted = True;
299 return STATUS_MORE_ENTRIES;
302 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
310 send data either by tls or normal socket_recv
312 static NTSTATUS tls_socket_send(struct socket_context *sock,
313 const DATA_BLOB *blob, size_t *sendlen)
317 struct tls_context *tls = talloc_get_type(sock->private_data, struct tls_context);
319 if (!tls->tls_enabled) {
320 return socket_send(tls->socket, blob, sendlen);
323 status = tls_handshake(tls);
324 NT_STATUS_NOT_OK_RETURN(status);
326 status = tls_interrupted(tls);
327 NT_STATUS_NOT_OK_RETURN(status);
329 ret = gnutls_record_send(tls->session, blob->data, blob->length);
330 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
331 if (gnutls_record_get_direction(tls->session) == 1) {
332 EVENT_FD_WRITEABLE(tls->fde);
334 tls->interrupted = True;
335 return STATUS_MORE_ENTRIES;
338 DEBUG(0,("gnutls_record_send of %d failed - %s\n", blob->length, gnutls_strerror(ret)));
339 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
342 tls->output_pending = (ret < blob->length);
348 initialise global tls state
350 struct tls_params *tls_initialise(TALLOC_CTX *mem_ctx)
352 struct tls_params *params;
354 TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
355 const char *keyfile = private_path(tmp_ctx, lp_tls_keyfile());
356 const char *certfile = private_path(tmp_ctx, lp_tls_certfile());
357 const char *cafile = private_path(tmp_ctx, lp_tls_cafile());
358 const char *crlfile = private_path(tmp_ctx, lp_tls_crlfile());
359 void tls_cert_generate(TALLOC_CTX *, const char *, const char *, const char *);
361 params = talloc(mem_ctx, struct tls_params);
362 if (params == NULL) {
363 talloc_free(tmp_ctx);
367 if (!lp_tls_enabled() || keyfile == NULL || *keyfile == 0) {
368 params->tls_enabled = False;
369 talloc_free(tmp_ctx);
373 if (!file_exist(cafile)) {
374 tls_cert_generate(params, keyfile, certfile, cafile);
377 ret = gnutls_global_init();
378 if (ret < 0) goto init_failed;
380 gnutls_certificate_allocate_credentials(¶ms->x509_cred);
381 if (ret < 0) goto init_failed;
383 if (cafile && *cafile) {
384 ret = gnutls_certificate_set_x509_trust_file(params->x509_cred, cafile,
385 GNUTLS_X509_FMT_PEM);
387 DEBUG(0,("TLS failed to initialise cafile %s\n", cafile));
392 if (crlfile && *crlfile) {
393 ret = gnutls_certificate_set_x509_crl_file(params->x509_cred,
395 GNUTLS_X509_FMT_PEM);
397 DEBUG(0,("TLS failed to initialise crlfile %s\n", crlfile));
402 ret = gnutls_certificate_set_x509_key_file(params->x509_cred,
404 GNUTLS_X509_FMT_PEM);
406 DEBUG(0,("TLS failed to initialise certfile %s and keyfile %s\n",
411 ret = gnutls_dh_params_init(¶ms->dh_params);
412 if (ret < 0) goto init_failed;
414 ret = gnutls_dh_params_generate2(params->dh_params, DH_BITS);
415 if (ret < 0) goto init_failed;
417 gnutls_certificate_set_dh_params(params->x509_cred, params->dh_params);
419 params->tls_enabled = True;
421 talloc_free(tmp_ctx);
425 DEBUG(0,("GNUTLS failed to initialise - %s\n", gnutls_strerror(ret)));
426 params->tls_enabled = False;
427 talloc_free(tmp_ctx);
433 setup for a new connection
435 struct socket_context *tls_init_server(struct tls_params *params,
436 struct socket_context *socket,
437 struct fd_event *fde,
438 const char *plain_chars)
440 struct tls_context *tls;
442 struct socket_context *new_sock;
445 nt_status = socket_create_with_ops(socket, &tls_socket_ops, &new_sock,
447 socket->flags | SOCKET_FLAG_ENCRYPT);
448 if (!NT_STATUS_IS_OK(nt_status)) {
452 tls = talloc(new_sock, struct tls_context);
457 tls->socket = socket;
459 if (talloc_reference(tls, fde) == NULL) {
460 talloc_free(new_sock);
463 if (talloc_reference(tls, socket) == NULL) {
464 talloc_free(new_sock);
468 new_sock->private_data = tls;
470 if (!params->tls_enabled) {
471 talloc_free(new_sock);
475 TLSCHECK(gnutls_init(&tls->session, GNUTLS_SERVER));
477 talloc_set_destructor(tls, tls_destructor);
479 TLSCHECK(gnutls_set_default_priority(tls->session));
480 TLSCHECK(gnutls_credentials_set(tls->session, GNUTLS_CRD_CERTIFICATE,
482 gnutls_certificate_server_set_request(tls->session, GNUTLS_CERT_REQUEST);
483 gnutls_dh_set_prime_bits(tls->session, DH_BITS);
484 gnutls_transport_set_ptr(tls->session, (gnutls_transport_ptr)tls);
485 gnutls_transport_set_pull_function(tls->session, (gnutls_pull_func)tls_pull);
486 gnutls_transport_set_push_function(tls->session, (gnutls_push_func)tls_push);
487 gnutls_transport_set_lowat(tls->session, 0);
489 tls->plain_chars = plain_chars;
491 tls->tls_detect = True;
493 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;
502 new_sock->state = SOCKET_STATE_SERVER_CONNECTED;
507 DEBUG(0,("TLS init connection failed - %s\n", gnutls_strerror(ret)));
508 talloc_free(new_sock);
514 setup for a new client connection
516 struct socket_context *tls_init_client(struct socket_context *socket,
517 struct fd_event *fde)
519 struct tls_context *tls;
521 const int cert_type_priority[] = { GNUTLS_CRT_X509, GNUTLS_CRT_OPENPGP, 0 };
523 struct socket_context *new_sock;
526 nt_status = socket_create_with_ops(socket, &tls_socket_ops, &new_sock,
528 socket->flags | SOCKET_FLAG_ENCRYPT);
529 if (!NT_STATUS_IS_OK(nt_status)) {
533 tls = talloc(new_sock, struct tls_context);
534 if (tls == NULL) return NULL;
536 tls->socket = socket;
538 if (talloc_reference(tls, fde) == NULL) {
541 if (talloc_reference(tls, socket) == NULL) {
544 new_sock->private_data = tls;
546 cafile = private_path(tls, lp_tls_cafile());
547 if (!cafile || !*cafile) {
551 gnutls_global_init();
553 gnutls_certificate_allocate_credentials(&tls->xcred);
554 gnutls_certificate_set_x509_trust_file(tls->xcred, cafile, GNUTLS_X509_FMT_PEM);
556 TLSCHECK(gnutls_init(&tls->session, GNUTLS_CLIENT));
557 TLSCHECK(gnutls_set_default_priority(tls->session));
558 gnutls_certificate_type_set_priority(tls->session, cert_type_priority);
559 TLSCHECK(gnutls_credentials_set(tls->session, GNUTLS_CRD_CERTIFICATE, tls->xcred));
561 talloc_set_destructor(tls, tls_destructor);
563 gnutls_transport_set_ptr(tls->session, (gnutls_transport_ptr)tls);
564 gnutls_transport_set_pull_function(tls->session, (gnutls_pull_func)tls_pull);
565 gnutls_transport_set_push_function(tls->session, (gnutls_push_func)tls_push);
566 gnutls_transport_set_lowat(tls->session, 0);
567 tls->tls_detect = False;
569 tls->output_pending = False;
570 tls->done_handshake = False;
571 tls->have_first_byte = False;
572 tls->tls_enabled = True;
573 tls->interrupted = False;
575 new_sock->state = SOCKET_STATE_CLIENT_CONNECTED;
580 DEBUG(0,("TLS init connection failed - %s\n", gnutls_strerror(ret)));
581 tls->tls_enabled = False;
585 static NTSTATUS tls_socket_set_option(struct socket_context *sock, const char *option, const char *val)
587 set_socket_options(socket_get_fd(sock), option);
591 static char *tls_socket_get_peer_name(struct socket_context *sock, TALLOC_CTX *mem_ctx)
593 struct tls_context *tls = talloc_get_type(sock->private_data, struct tls_context);
594 return socket_get_peer_name(tls->socket, mem_ctx);
597 static struct socket_address *tls_socket_get_peer_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx)
599 struct tls_context *tls = talloc_get_type(sock->private_data, struct tls_context);
600 return socket_get_peer_addr(tls->socket, mem_ctx);
603 static struct socket_address *tls_socket_get_my_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx)
605 struct tls_context *tls = talloc_get_type(sock->private_data, struct tls_context);
606 return socket_get_my_addr(tls->socket, mem_ctx);
609 static int tls_socket_get_fd(struct socket_context *sock)
611 struct tls_context *tls = talloc_get_type(sock->private_data, struct tls_context);
612 return socket_get_fd(tls->socket);
615 static const struct socket_ops tls_socket_ops = {
617 .fn_init = tls_socket_init,
618 .fn_recv = tls_socket_recv,
619 .fn_send = tls_socket_send,
620 .fn_pending = tls_socket_pending,
622 .fn_set_option = tls_socket_set_option,
624 .fn_get_peer_name = tls_socket_get_peer_name,
625 .fn_get_peer_addr = tls_socket_get_peer_addr,
626 .fn_get_my_addr = tls_socket_get_my_addr,
627 .fn_get_fd = tls_socket_get_fd
630 BOOL tls_support(struct tls_params *params)
632 return params->tls_enabled;
637 /* for systems without tls we just map the tls socket calls to the
638 normal socket calls */
640 struct tls_params *tls_initialise(TALLOC_CTX *mem_ctx)
642 return talloc_new(mem_ctx);
646 setup for a new connection
648 struct socket_context *tls_init_server(struct tls_params *params,
649 struct socket_context *socket,
650 struct fd_event *fde,
651 const char *plain_chars)
661 setup for a new client connection
663 struct socket_context *tls_init_client(struct socket_context *socket,
664 struct fd_event *fde)
669 BOOL tls_support(struct tls_params *params)