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"
28 #include "gnutls/gnutls.h"
32 /* hold persistent tls data */
34 gnutls_certificate_credentials x509_cred;
35 gnutls_dh_params dh_params;
39 /* hold per connection tls data */
41 struct socket_context *socket;
43 gnutls_session session;
49 const char *plain_chars;
51 gnutls_certificate_credentials xcred;
55 #define TLSCHECK(call) do { \
58 DEBUG(0,("TLS %s - %s\n", #call, gnutls_strerror(ret))); \
66 callback for reading from a socket
68 static ssize_t tls_pull(gnutls_transport_ptr ptr, void *buf, size_t size)
70 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
74 if (tls->have_first_byte) {
75 *(uint8_t *)buf = tls->first_byte;
76 tls->have_first_byte = False;
80 status = socket_recv(tls->socket, buf, size, &nread, 0);
81 if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
84 if (NT_STATUS_IS_ERR(status)) {
85 EVENT_FD_NOT_READABLE(tls->fde);
86 EVENT_FD_NOT_WRITEABLE(tls->fde);
90 if (!NT_STATUS_IS_OK(status)) {
91 EVENT_FD_READABLE(tls->fde);
95 if (tls->output_pending) {
96 EVENT_FD_WRITEABLE(tls->fde);
99 EVENT_FD_READABLE(tls->fde);
105 callback for writing to a socket
107 static ssize_t tls_push(gnutls_transport_ptr ptr, const void *buf, size_t size)
109 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
114 if (!tls->tls_enabled) {
118 b.data = discard_const(buf);
121 status = socket_send(tls->socket, &b, &nwritten, 0);
122 if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
126 if (!NT_STATUS_IS_OK(status)) {
127 EVENT_FD_WRITEABLE(tls->fde);
130 if (size != nwritten) {
131 EVENT_FD_WRITEABLE(tls->fde);
137 destroy a tls session
139 static int tls_destructor(void *ptr)
141 struct tls_context *tls = talloc_get_type(ptr, struct tls_context);
143 ret = gnutls_bye(tls->session, GNUTLS_SHUT_WR);
145 DEBUG(0,("TLS gnutls_bye failed - %s\n", gnutls_strerror(ret)));
152 possibly continue the handshake process
154 static NTSTATUS tls_handshake(struct tls_context *tls)
158 if (tls->done_handshake) {
162 ret = gnutls_handshake(tls->session);
163 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
164 if (gnutls_record_get_direction(tls->session) == 1) {
165 EVENT_FD_WRITEABLE(tls->fde);
167 return STATUS_MORE_ENTRIES;
170 DEBUG(0,("TLS gnutls_handshake failed - %s\n", gnutls_strerror(ret)));
171 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
173 tls->done_handshake = True;
178 possibly continue an interrupted operation
180 static NTSTATUS tls_interrupted(struct tls_context *tls)
184 if (!tls->interrupted) {
187 if (gnutls_record_get_direction(tls->session) == 1) {
188 ret = gnutls_record_send(tls->session, NULL, 0);
190 ret = gnutls_record_recv(tls->session, NULL, 0);
192 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
193 return STATUS_MORE_ENTRIES;
195 tls->interrupted = False;
200 see how many bytes are pending on the connection
202 NTSTATUS tls_socket_pending(struct tls_context *tls, size_t *npending)
204 if (!tls->tls_enabled || tls->tls_detect) {
205 return socket_pending(tls->socket, npending);
207 *npending = gnutls_record_check_pending(tls->session);
208 if (*npending == 0) {
209 NTSTATUS status = socket_pending(tls->socket, npending);
210 if (*npending == 0) {
211 /* seems to be a gnutls bug */
220 receive data either by tls or normal socket_recv
222 NTSTATUS tls_socket_recv(struct tls_context *tls, void *buf, size_t wantlen,
227 if (tls->tls_enabled && tls->tls_detect) {
228 status = socket_recv(tls->socket, &tls->first_byte, 1, nread, 0);
229 NT_STATUS_NOT_OK_RETURN(status);
230 if (*nread == 0) return NT_STATUS_OK;
231 tls->tls_detect = False;
232 /* look for the first byte of a valid HTTP operation */
233 if (strchr(tls->plain_chars, tls->first_byte)) {
235 tls->tls_enabled = False;
236 *(uint8_t *)buf = tls->first_byte;
239 tls->have_first_byte = True;
242 if (!tls->tls_enabled) {
243 return socket_recv(tls->socket, buf, wantlen, nread, 0);
246 status = tls_handshake(tls);
247 NT_STATUS_NOT_OK_RETURN(status);
249 status = tls_interrupted(tls);
250 NT_STATUS_NOT_OK_RETURN(status);
252 ret = gnutls_record_recv(tls->session, buf, wantlen);
253 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
254 if (gnutls_record_get_direction(tls->session) == 1) {
255 EVENT_FD_WRITEABLE(tls->fde);
257 tls->interrupted = True;
258 return STATUS_MORE_ENTRIES;
261 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
269 send data either by tls or normal socket_recv
271 NTSTATUS tls_socket_send(struct tls_context *tls, const DATA_BLOB *blob, size_t *sendlen)
276 if (!tls->tls_enabled) {
277 return socket_send(tls->socket, blob, sendlen, 0);
280 status = tls_handshake(tls);
281 NT_STATUS_NOT_OK_RETURN(status);
283 status = tls_interrupted(tls);
284 NT_STATUS_NOT_OK_RETURN(status);
286 ret = gnutls_record_send(tls->session, blob->data, blob->length);
287 if (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN) {
288 if (gnutls_record_get_direction(tls->session) == 1) {
289 EVENT_FD_WRITEABLE(tls->fde);
291 tls->interrupted = True;
292 return STATUS_MORE_ENTRIES;
295 DEBUG(0,("gnutls_record_send of %d failed - %s\n", blob->length, gnutls_strerror(ret)));
296 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
299 tls->output_pending = (ret < blob->length);
305 initialise global tls state
307 struct tls_params *tls_initialise(TALLOC_CTX *mem_ctx)
309 struct tls_params *params;
311 TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
312 const char *keyfile = private_path(tmp_ctx, lp_tls_keyfile());
313 const char *certfile = private_path(tmp_ctx, lp_tls_certfile());
314 const char *cafile = private_path(tmp_ctx, lp_tls_cafile());
315 const char *crlfile = private_path(tmp_ctx, lp_tls_crlfile());
316 void tls_cert_generate(TALLOC_CTX *, const char *, const char *, const char *);
318 params = talloc(mem_ctx, struct tls_params);
319 if (params == NULL) {
320 talloc_free(tmp_ctx);
324 if (!lp_tls_enabled() || keyfile == NULL || *keyfile == 0) {
325 params->tls_enabled = False;
326 talloc_free(tmp_ctx);
330 if (!file_exist(cafile)) {
331 tls_cert_generate(params, keyfile, certfile, cafile);
334 ret = gnutls_global_init();
335 if (ret < 0) goto init_failed;
337 gnutls_certificate_allocate_credentials(¶ms->x509_cred);
338 if (ret < 0) goto init_failed;
340 if (cafile && *cafile) {
341 ret = gnutls_certificate_set_x509_trust_file(params->x509_cred, cafile,
342 GNUTLS_X509_FMT_PEM);
344 DEBUG(0,("TLS failed to initialise cafile %s\n", cafile));
349 if (crlfile && *crlfile) {
350 ret = gnutls_certificate_set_x509_crl_file(params->x509_cred,
352 GNUTLS_X509_FMT_PEM);
354 DEBUG(0,("TLS failed to initialise crlfile %s\n", crlfile));
359 ret = gnutls_certificate_set_x509_key_file(params->x509_cred,
361 GNUTLS_X509_FMT_PEM);
363 DEBUG(0,("TLS failed to initialise certfile %s and keyfile %s\n",
368 ret = gnutls_dh_params_init(¶ms->dh_params);
369 if (ret < 0) goto init_failed;
371 ret = gnutls_dh_params_generate2(params->dh_params, DH_BITS);
372 if (ret < 0) goto init_failed;
374 gnutls_certificate_set_dh_params(params->x509_cred, params->dh_params);
376 params->tls_enabled = True;
378 talloc_free(tmp_ctx);
382 DEBUG(0,("GNUTLS failed to initialise - %s\n", gnutls_strerror(ret)));
383 params->tls_enabled = False;
384 talloc_free(tmp_ctx);
390 setup for a new connection
392 struct tls_context *tls_init_server(struct tls_params *params,
393 struct socket_context *socket,
394 struct fd_event *fde,
395 const char *plain_chars,
398 struct tls_context *tls;
401 tls = talloc(socket, struct tls_context);
402 if (tls == NULL) return NULL;
404 tls->socket = socket;
407 if (!params->tls_enabled || !tls_enable) {
408 tls->tls_enabled = False;
412 TLSCHECK(gnutls_init(&tls->session, GNUTLS_SERVER));
414 talloc_set_destructor(tls, tls_destructor);
416 TLSCHECK(gnutls_set_default_priority(tls->session));
417 TLSCHECK(gnutls_credentials_set(tls->session, GNUTLS_CRD_CERTIFICATE,
419 gnutls_certificate_server_set_request(tls->session, GNUTLS_CERT_REQUEST);
420 gnutls_dh_set_prime_bits(tls->session, DH_BITS);
421 gnutls_transport_set_ptr(tls->session, (gnutls_transport_ptr)tls);
422 gnutls_transport_set_pull_function(tls->session, (gnutls_pull_func)tls_pull);
423 gnutls_transport_set_push_function(tls->session, (gnutls_push_func)tls_push);
424 gnutls_transport_set_lowat(tls->session, 0);
426 tls->plain_chars = plain_chars;
428 tls->tls_detect = True;
430 tls->tls_detect = False;
433 tls->output_pending = False;
434 tls->done_handshake = False;
435 tls->have_first_byte = False;
436 tls->tls_enabled = True;
437 tls->interrupted = False;
442 DEBUG(0,("TLS init connection failed - %s\n", gnutls_strerror(ret)));
443 tls->tls_enabled = False;
444 params->tls_enabled = False;
450 setup for a new client connection
452 struct tls_context *tls_init_client(struct socket_context *socket,
453 struct fd_event *fde,
456 struct tls_context *tls;
458 const int cert_type_priority[] = { GNUTLS_CRT_X509, GNUTLS_CRT_OPENPGP, 0 };
461 tls = talloc(socket, struct tls_context);
462 if (tls == NULL) return NULL;
464 tls->socket = socket;
466 tls->tls_enabled = tls_enable;
468 if (!tls->tls_enabled) {
472 cafile = private_path(tls, lp_tls_cafile());
473 if (!cafile || !*cafile) {
477 gnutls_global_init();
479 gnutls_certificate_allocate_credentials(&tls->xcred);
480 gnutls_certificate_set_x509_trust_file(tls->xcred, cafile, GNUTLS_X509_FMT_PEM);
482 TLSCHECK(gnutls_init(&tls->session, GNUTLS_CLIENT));
483 TLSCHECK(gnutls_set_default_priority(tls->session));
484 gnutls_certificate_type_set_priority(tls->session, cert_type_priority);
485 TLSCHECK(gnutls_credentials_set(tls->session, GNUTLS_CRD_CERTIFICATE, tls->xcred));
487 talloc_set_destructor(tls, tls_destructor);
489 gnutls_transport_set_ptr(tls->session, (gnutls_transport_ptr)tls);
490 gnutls_transport_set_pull_function(tls->session, (gnutls_pull_func)tls_pull);
491 gnutls_transport_set_push_function(tls->session, (gnutls_push_func)tls_push);
492 gnutls_transport_set_lowat(tls->session, 0);
493 tls->tls_detect = False;
495 tls->output_pending = False;
496 tls->done_handshake = False;
497 tls->have_first_byte = False;
498 tls->tls_enabled = True;
499 tls->interrupted = False;
504 DEBUG(0,("TLS init connection failed - %s\n", gnutls_strerror(ret)));
505 tls->tls_enabled = False;
509 BOOL tls_enabled(struct tls_context *tls)
511 return tls->tls_enabled;
514 BOOL tls_support(struct tls_params *params)
516 return params->tls_enabled;
521 /* for systems without tls we just map the tls socket calls to the
522 normal socket calls */
524 struct tls_params *tls_initialise(TALLOC_CTX *mem_ctx)
526 return talloc_new(mem_ctx);
529 struct tls_context *tls_init_server(struct tls_params *params,
530 struct socket_context *sock,
531 struct fd_event *fde,
532 const char *plain_chars,
535 if (tls_enable && plain_chars == NULL) return NULL;
536 return (struct tls_context *)sock;
539 struct tls_context *tls_init_client(struct socket_context *sock,
540 struct fd_event *fde,
543 return (struct tls_context *)sock;
547 NTSTATUS tls_socket_recv(struct tls_context *tls, void *buf, size_t wantlen,
550 return socket_recv((struct socket_context *)tls, buf, wantlen, nread, 0);
553 NTSTATUS tls_socket_send(struct tls_context *tls, const DATA_BLOB *blob, size_t *sendlen)
555 return socket_send((struct socket_context *)tls, blob, sendlen, 0);
558 BOOL tls_enabled(struct tls_context *tls)
563 BOOL tls_support(struct tls_params *params)
568 NTSTATUS tls_socket_pending(struct tls_context *tls, size_t *npending)
570 return socket_pending((struct socket_context *)tls, npending);