1 /* tls_m.c - Handle tls/ssl using Mozilla NSS. */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2008-2017 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* ACKNOWLEDGEMENTS: Initial version written by Howard Chu.
17 * Additional support by Rich Megginson.
24 #include "ldap_config.h"
28 #if defined( HAVE_FCNTL_H )
32 #include <ac/stdlib.h>
34 #include <ac/socket.h>
35 #include <ac/string.h>
38 #include <ac/unistd.h>
40 #include <ac/dirent.h>
46 #define READ_PASSWORD_FROM_STDIN
47 #define READ_PASSWORD_FROM_FILE
49 #ifdef READ_PASSWORD_FROM_STDIN
50 #include <termios.h> /* for echo on/off */
53 #include <nspr/nspr.h>
54 #include <nspr/private/pprio.h>
57 #include <nss/sslerr.h>
58 #include <nss/sslproto.h>
59 #include <nss/pk11pub.h>
60 #include <nss/secerr.h>
61 #include <nss/keyhi.h>
62 #include <nss/secmod.h>
65 #undef NSS_VERSION_INT
66 #define NSS_VERSION_INT ((NSS_VMAJOR << 24) | (NSS_VMINOR << 16) | \
67 (NSS_VPATCH << 8) | NSS_VBUILD)
69 /* NSS 3.12.5 and later have NSS_InitContext */
70 #if NSS_VERSION_INT >= 0x030c0500
71 #define HAVE_NSS_INITCONTEXT 1
74 /* NSS 3.12.9 and later have SECMOD_RestartModules */
75 #if NSS_VERSION_INT >= 0x030c0900
76 #define HAVE_SECMOD_RESTARTMODULES 1
79 /* InitContext does not currently work in server mode */
80 /* #define INITCONTEXT_HACK 1 */
82 typedef struct tlsm_ctx {
85 int tc_unique; /* unique number associated with this ctx */
86 PRBool tc_verify_cert;
87 CERTCertDBHandle *tc_certdb;
88 PK11SlotInfo *tc_certdb_slot;
89 CERTCertificate *tc_certificate;
90 SECKEYPrivateKey *tc_private_key;
92 struct ldaptls *tc_config;
95 PRCallOnceType tc_callonce;
97 #ifdef HAVE_NSS_INITCONTEXT
98 NSSInitContext *tc_initctx; /* the NSS context */
100 PK11GenericObject **tc_pem_objs; /* array of objects to free */
101 int tc_n_pem_objs; /* number of objects */
102 PRBool tc_warn_only; /* only warn of errors in validation */
103 #ifdef LDAP_R_COMPILE
104 ldap_pvt_thread_mutex_t tc_refmutex;
108 typedef PRFileDesc tlsm_session;
110 static int tlsm_ctx_count;
111 #define TLSM_CERTDB_DESC_FMT "ldap(%d)"
113 static PRDescIdentity tlsm_layer_id;
115 static const PRIOMethods tlsm_PR_methods;
117 #define CERTDB_NONE NULL
118 #define PREFIX_NONE NULL
120 #define PEM_LIBRARY "nsspem"
121 #define PEM_MODULE "PEM"
122 #define PEM_CA_HASH_FILE_REGEX "^[0-9a-f]{8}\\.[0-9]+$"
124 static SECMODModule *pem_module;
126 #define DEFAULT_TOKEN_NAME "default"
127 #define TLSM_PEM_SLOT_CACERTS "PEM Token #0"
128 #define TLSM_PEM_SLOT_CERTS "PEM Token #1"
130 #define PK11_SETATTRS(x,id,v,l) (x).type = (id); \
131 (x).pValue=(v); (x).ulValueLen = (l);
133 /* forward declaration */
134 static int tlsm_init( void );
136 #ifdef LDAP_R_COMPILE
138 /* it doesn't seem guaranteed that a client will call
139 tlsm_thr_init in a non-threaded context - so we have
140 to wrap the mutex creation in a prcallonce
142 static ldap_pvt_thread_mutex_t tlsm_ctx_count_mutex;
143 static ldap_pvt_thread_mutex_t tlsm_init_mutex;
144 static ldap_pvt_thread_mutex_t tlsm_pem_mutex;
145 static PRCallOnceType tlsm_init_mutex_callonce = {0,0};
147 static PRStatus PR_CALLBACK
148 tlsm_thr_init_callonce( void )
150 if ( ldap_pvt_thread_mutex_init( &tlsm_ctx_count_mutex ) ) {
151 Debug( LDAP_DEBUG_ANY,
152 "TLS: could not create mutex for context counter: %d\n", errno, 0, 0 );
156 if ( ldap_pvt_thread_mutex_init( &tlsm_init_mutex ) ) {
157 Debug( LDAP_DEBUG_ANY,
158 "TLS: could not create mutex for moznss initialization: %d\n", errno, 0, 0 );
162 if ( ldap_pvt_thread_mutex_init( &tlsm_pem_mutex ) ) {
163 Debug( LDAP_DEBUG_ANY,
164 "TLS: could not create mutex for PEM module: %d\n", errno, 0, 0 );
172 tlsm_thr_init( void )
174 ( void )PR_CallOnce( &tlsm_init_mutex_callonce, tlsm_thr_init_callonce );
177 #endif /* LDAP_R_COMPILE */
180 tlsm_dump_cipher_info(PRFileDesc *fd)
184 for (ii = 0; ii < SSL_NumImplementedCiphers; ++ii) {
185 PRInt32 cipher = (PRInt32)SSL_ImplementedCiphers[ii];
186 PRBool enabled = PR_FALSE;
188 SSLCipherSuiteInfo info;
191 SSL_CipherPrefGet(fd, cipher, &enabled);
193 SSL_CipherPrefGetDefault(cipher, &enabled);
195 SSL_CipherPolicyGet(cipher, &policy);
196 SSL_GetCipherSuiteInfo(cipher, &info, (PRUintn)sizeof(info));
197 Debug( LDAP_DEBUG_TRACE,
198 "TLS: cipher: %d - %s, enabled: %d, ",
199 info.cipherSuite, info.cipherSuiteName, enabled );
200 Debug( LDAP_DEBUG_TRACE,
201 "policy: %d\n", policy, 0, 0 );
207 /* Cipher definitions */
209 char *ossl_name; /* The OpenSSL cipher name */
210 int num; /* The cipher id */
211 int attr; /* cipher attributes: algorithms, etc */
212 int version; /* protocol version valid for this cipher */
213 int bits; /* bits of strength */
214 int alg_bits; /* bits of the algorithm */
215 int strength; /* LOW, MEDIUM, HIGH */
216 int enabled; /* Enabled by default? */
219 /* cipher attributes */
220 #define SSL_kRSA 0x00000001L
221 #define SSL_aRSA 0x00000002L
222 #define SSL_aDSS 0x00000004L
223 #define SSL_DSS SSL_aDSS
224 #define SSL_eNULL 0x00000008L
225 #define SSL_DES 0x00000010L
226 #define SSL_3DES 0x00000020L
227 #define SSL_RC4 0x00000040L
228 #define SSL_RC2 0x00000080L
229 #define SSL_AES 0x00000100L
230 #define SSL_MD5 0x00000200L
231 #define SSL_SHA1 0x00000400L
232 #define SSL_SHA SSL_SHA1
233 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
235 /* cipher strength */
236 #define SSL_NULL 0x00000001L
237 #define SSL_EXPORT40 0x00000002L
238 #define SSL_EXPORT56 0x00000004L
239 #define SSL_LOW 0x00000008L
240 #define SSL_MEDIUM 0x00000010L
241 #define SSL_HIGH 0x00000020L
243 #define SSL2 0x00000001L
244 #define SSL3 0x00000002L
245 /* OpenSSL treats SSL3 and TLSv1 the same */
248 /* Cipher translation */
249 static cipher_properties ciphers_def[] = {
251 {"DES-CBC3-MD5", SSL_EN_DES_192_EDE3_CBC_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_3DES|SSL_MD5, SSL2, 168, 168, SSL_HIGH, SSL_ALLOWED},
252 {"RC2-CBC-MD5", SSL_EN_RC2_128_CBC_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC2|SSL_MD5, SSL2, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
253 {"RC4-MD5", SSL_EN_RC4_128_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL2, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
254 {"DES-CBC-MD5", SSL_EN_DES_64_CBC_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_DES|SSL_MD5, SSL2, 56, 56, SSL_LOW, SSL_ALLOWED},
255 {"EXP-RC2-CBC-MD5", SSL_EN_RC2_128_CBC_EXPORT40_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC2|SSL_MD5, SSL2, 40, 128, SSL_EXPORT40, SSL_ALLOWED},
256 {"EXP-RC4-MD5", SSL_EN_RC4_128_EXPORT40_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL2, 40, 128, SSL_EXPORT40, SSL_ALLOWED},
259 {"RC4-MD5", SSL_RSA_WITH_RC4_128_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
260 {"RC4-SHA", SSL_RSA_WITH_RC4_128_SHA, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_SHA1, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
261 {"DES-CBC3-SHA", SSL_RSA_WITH_3DES_EDE_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_3DES|SSL_SHA1, SSL3, 168, 168, SSL_HIGH, SSL_ALLOWED},
262 {"DES-CBC-SHA", SSL_RSA_WITH_DES_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_DES|SSL_SHA1, SSL3, 56, 56, SSL_LOW, SSL_ALLOWED},
263 {"EXP-RC4-MD5", SSL_RSA_EXPORT_WITH_RC4_40_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL3, 40, 128, SSL_EXPORT40, SSL_ALLOWED},
264 {"EXP-RC2-CBC-MD5", SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5, SSL_kRSA|SSL_aRSA|SSL_RC2|SSL_MD5, SSL3, 0, 0, SSL_EXPORT40, SSL_ALLOWED},
265 {"NULL-MD5", SSL_RSA_WITH_NULL_MD5, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_MD5, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
266 {"NULL-SHA", SSL_RSA_WITH_NULL_SHA, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_SHA1, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
269 {"EXP1024-DES-CBC-SHA", TLS_RSA_EXPORT1024_WITH_DES_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_DES|SSL_SHA, TLS1, 56, 56, SSL_EXPORT56, SSL_ALLOWED},
270 {"EXP1024-RC4-SHA", TLS_RSA_EXPORT1024_WITH_RC4_56_SHA, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_SHA, TLS1, 56, 56, SSL_EXPORT56, SSL_ALLOWED},
271 {"AES128-SHA", TLS_RSA_WITH_AES_128_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 128, 128, SSL_HIGH, SSL_ALLOWED},
272 {"AES256-SHA", TLS_RSA_WITH_AES_256_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 256, 256, SSL_HIGH, SSL_ALLOWED},
275 #define ciphernum (sizeof(ciphers_def)/sizeof(cipher_properties))
277 /* given err which is the current errno, calls PR_SetError with
278 the corresponding NSPR error code */
280 tlsm_map_error(int err)
286 prError = PR_NO_ACCESS_RIGHTS_ERROR;
289 prError = PR_ADDRESS_IN_USE_ERROR;
292 prError = PR_ADDRESS_NOT_AVAILABLE_ERROR;
295 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
298 prError = PR_WOULD_BLOCK_ERROR;
301 * On QNX and Neutrino, EALREADY is defined as EBUSY.
303 #if EALREADY != EBUSY
305 prError = PR_ALREADY_INITIATED_ERROR;
309 prError = PR_BAD_DESCRIPTOR_ERROR;
313 prError = PR_IO_ERROR;
317 prError = PR_FILESYSTEM_MOUNTED_ERROR;
320 prError = PR_CONNECT_ABORTED_ERROR;
323 prError = PR_CONNECT_REFUSED_ERROR;
326 prError = PR_CONNECT_RESET_ERROR;
329 prError = PR_DEADLOCK_ERROR;
333 prError = PR_DIRECTORY_CORRUPTED_ERROR;
338 prError = PR_NO_DEVICE_SPACE_ERROR;
342 prError = PR_FILE_EXISTS_ERROR;
345 prError = PR_ACCESS_FAULT_ERROR;
348 prError = PR_FILE_TOO_BIG_ERROR;
351 prError = PR_HOST_UNREACHABLE_ERROR;
354 prError = PR_IN_PROGRESS_ERROR;
357 prError = PR_PENDING_INTERRUPT_ERROR;
360 prError = PR_INVALID_ARGUMENT_ERROR;
363 prError = PR_IO_ERROR;
366 prError = PR_IS_CONNECTED_ERROR;
369 prError = PR_IS_DIRECTORY_ERROR;
372 prError = PR_LOOP_ERROR;
375 prError = PR_PROC_DESC_TABLE_FULL_ERROR;
378 prError = PR_MAX_DIRECTORY_ENTRIES_ERROR;
381 prError = PR_INVALID_ARGUMENT_ERROR;
385 prError = PR_REMOTE_FILE_ERROR;
389 prError = PR_NAME_TOO_LONG_ERROR;
392 prError = PR_NETWORK_UNREACHABLE_ERROR;
395 prError = PR_SYS_DESC_TABLE_FULL_ERROR;
398 * On SCO OpenServer 5, ENOBUFS is defined as ENOSR.
400 #if defined(ENOBUFS) && (ENOBUFS != ENOSR)
402 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
406 prError = PR_FILE_NOT_FOUND_ERROR;
409 prError = PR_FILE_NOT_FOUND_ERROR;
412 prError = PR_FILE_IS_LOCKED_ERROR;
416 prError = PR_REMOTE_FILE_ERROR;
420 prError = PR_OUT_OF_MEMORY_ERROR;
423 prError = PR_INVALID_ARGUMENT_ERROR;
426 prError = PR_NO_DEVICE_SPACE_ERROR;
430 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
434 prError = PR_NOT_CONNECTED_ERROR;
437 prError = PR_NOT_DIRECTORY_ERROR;
440 prError = PR_NOT_SOCKET_ERROR;
443 prError = PR_FILE_NOT_FOUND_ERROR;
446 prError = PR_NOT_TCP_SOCKET_ERROR;
450 prError = PR_BUFFER_OVERFLOW_ERROR;
454 prError = PR_NO_ACCESS_RIGHTS_ERROR;
457 prError = PR_CONNECT_RESET_ERROR;
461 prError = PR_IO_ERROR;
464 case EPROTONOSUPPORT:
465 prError = PR_PROTOCOL_NOT_SUPPORTED_ERROR;
468 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
471 prError = PR_INVALID_METHOD_ERROR;
474 prError = PR_READ_ONLY_FILESYSTEM_ERROR;
477 prError = PR_INVALID_METHOD_ERROR;
480 prError = PR_IO_TIMEOUT_ERROR;
482 #if EWOULDBLOCK != EAGAIN
484 prError = PR_WOULD_BLOCK_ERROR;
488 prError = PR_NOT_SAME_DEVICE_ERROR;
491 prError = PR_UNKNOWN_ERROR;
494 PR_SetError( prError, err );
498 * cipher_list is an integer array with the following values:
499 * -1: never enable this cipher
504 nss_parse_ciphers(const char *cipherstr, int cipher_list[ciphernum])
513 /* All disabled to start */
514 for (i=0; i<ciphernum; i++)
517 ciphertip = strdup(cipherstr);
518 cipher = ciphers = ciphertip;
520 while (ciphers && (strlen(ciphers))) {
521 while ((*cipher) && (isspace(*cipher)))
526 case '+': /* Add something */
530 case '-': /* Subtract something */
534 case '!': /* Disable something */
543 if ((ciphers = strchr(cipher, ':'))) {
547 /* Do the easy one first */
548 if (!strcmp(cipher, "ALL")) {
549 for (i=0; i<ciphernum; i++) {
550 if (!(ciphers_def[i].attr & SSL_eNULL))
551 cipher_list[i] = action;
553 } else if (!strcmp(cipher, "COMPLEMENTOFALL")) {
554 for (i=0; i<ciphernum; i++) {
555 if ((ciphers_def[i].attr & SSL_eNULL))
556 cipher_list[i] = action;
558 } else if (!strcmp(cipher, "DEFAULT")) {
559 for (i=0; i<ciphernum; i++) {
560 cipher_list[i] = ciphers_def[i].enabled == SSL_ALLOWED ? 1 : 0;
569 while (c && (strlen(c))) {
571 if ((c = strchr(cipher, '+'))) {
575 if (!strcmp(cipher, "RSA")) {
577 } else if ((!strcmp(cipher, "NULL")) || (!strcmp(cipher, "eNULL"))) {
579 } else if (!strcmp(cipher, "AES")) {
581 } else if (!strcmp(cipher, "3DES")) {
583 } else if (!strcmp(cipher, "DES")) {
585 } else if (!strcmp(cipher, "RC4")) {
587 } else if (!strcmp(cipher, "RC2")) {
589 } else if (!strcmp(cipher, "MD5")) {
591 } else if ((!strcmp(cipher, "SHA")) || (!strcmp(cipher, "SHA1"))) {
593 } else if (!strcmp(cipher, "SSLv2")) {
595 } else if (!strcmp(cipher, "SSLv3")) {
597 } else if (!strcmp(cipher, "TLSv1")) {
599 } else if (!strcmp(cipher, "HIGH")) {
600 strength |= SSL_HIGH;
601 } else if (!strcmp(cipher, "MEDIUM")) {
602 strength |= SSL_MEDIUM;
603 } else if (!strcmp(cipher, "LOW")) {
605 } else if ((!strcmp(cipher, "EXPORT")) || (!strcmp(cipher, "EXP"))) {
606 strength |= SSL_EXPORT40|SSL_EXPORT56;
607 } else if (!strcmp(cipher, "EXPORT40")) {
608 strength |= SSL_EXPORT40;
609 } else if (!strcmp(cipher, "EXPORT56")) {
610 strength |= SSL_EXPORT56;
618 /* If we have a mask, apply it. If not then perhaps they provided
619 * a specific cipher to enable.
621 if (mask || strength || protocol) {
622 for (i=0; i<ciphernum; i++) {
623 if (((ciphers_def[i].attr & mask) ||
624 (ciphers_def[i].strength & strength) ||
625 (ciphers_def[i].version & protocol)) &&
626 (cipher_list[i] != -1)) {
627 /* Enable the NULL ciphers only if explicity
629 if (ciphers_def[i].attr & SSL_eNULL) {
630 if (mask & SSL_eNULL)
631 cipher_list[i] = action;
633 cipher_list[i] = action;
637 for (i=0; i<ciphernum; i++) {
638 if (!strcmp(ciphers_def[i].ossl_name, cipher) &&
639 cipher_list[i] != -1)
640 cipher_list[i] = action;
649 /* See if any ciphers were enabled */
651 for (i=0; i<ciphernum; i++) {
652 if (cipher_list[i] == 1)
662 tlsm_parse_ciphers(tlsm_ctx *ctx, const char *str)
664 int cipher_state[ciphernum];
670 rv = nss_parse_ciphers(str, cipher_state);
673 /* First disable everything */
674 for (i = 0; i < SSL_NumImplementedCiphers; i++)
675 SSL_CipherPrefSet(ctx->tc_model, SSL_ImplementedCiphers[i], SSL_NOT_ALLOWED);
677 /* Now enable what was requested */
678 for (i=0; i<ciphernum; i++) {
679 SSLCipherSuiteInfo suite;
682 if (SSL_GetCipherSuiteInfo(ciphers_def[i].num, &suite, sizeof suite)
684 enabled = cipher_state[i] < 0 ? 0 : cipher_state[i];
685 if (enabled == SSL_ALLOWED) {
686 if (PK11_IsFIPS() && !suite.isFIPS)
687 enabled = SSL_NOT_ALLOWED;
689 SSL_CipherPrefSet(ctx->tc_model, ciphers_def[i].num, enabled);
694 return rv == 1 ? 0 : -1;
698 tlsm_bad_cert_handler(void *arg, PRFileDesc *ssl)
700 SECStatus success = SECSuccess;
702 tlsm_ctx *ctx = (tlsm_ctx *)arg;
708 err = PORT_GetError();
711 case SEC_ERROR_UNTRUSTED_ISSUER:
712 case SEC_ERROR_UNKNOWN_ISSUER:
713 case SEC_ERROR_EXPIRED_CERTIFICATE:
714 case SEC_ERROR_EXPIRED_ISSUER_CERTIFICATE:
715 if (ctx->tc_verify_cert) {
716 success = SECFailure;
719 /* we bypass NSS's hostname checks and do our own */
720 case SSL_ERROR_BAD_CERT_DOMAIN:
723 success = SECFailure;
731 tlsm_dump_security_status(PRFileDesc *fd)
733 char * cp; /* bulk cipher name */
734 char * ip; /* cert issuer DN */
735 char * sp; /* cert subject DN */
736 int op; /* High, Low, Off */
737 int kp0; /* total key bits */
738 int kp1; /* secret key bits */
739 SSL3Statistics * ssl3stats = SSL_GetStatistics();
741 SSL_SecurityStatus( fd, &op, &cp, &kp0, &kp1, &ip, &sp );
742 Debug( LDAP_DEBUG_TRACE,
743 "TLS certificate verification: subject: %s, issuer: %s, cipher: %s, ",
744 sp ? sp : "-unknown-", ip ? ip : "-unknown-", cp ? cp : "-unknown-" );
748 Debug( LDAP_DEBUG_TRACE,
749 "security level: %s, secret key bits: %d, total key bits: %d, ",
750 ((op == SSL_SECURITY_STATUS_ON_HIGH) ? "high" :
751 ((op == SSL_SECURITY_STATUS_ON_LOW) ? "low" : "off")),
754 Debug( LDAP_DEBUG_TRACE,
755 "cache hits: %ld, cache misses: %ld, cache not reusable: %ld\n",
756 ssl3stats->hch_sid_cache_hits, ssl3stats->hch_sid_cache_misses,
757 ssl3stats->hch_sid_cache_not_ok );
763 tlsm_handshake_complete_cb( PRFileDesc *fd, void *client_data )
765 tlsm_dump_security_status( fd );
768 #ifdef READ_PASSWORD_FROM_FILE
770 tlsm_get_pin_from_file(const char *token_name, tlsm_ctx *ctx)
773 char *contents = NULL;
776 char *candidate = NULL;
777 PRFileInfo file_info;
778 PRFileDesc *pwd_fileptr = PR_Open( ctx->tc_pin_file, PR_RDONLY, 00400 );
780 /* open the password file */
781 if ( !pwd_fileptr ) {
782 PRErrorCode errcode = PR_GetError();
783 Debug( LDAP_DEBUG_ANY,
784 "TLS: could not open security pin file %s - error %d:%s.\n",
785 ctx->tc_pin_file, errcode,
786 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
790 /* get the file size */
791 if ( PR_SUCCESS != PR_GetFileInfo( ctx->tc_pin_file, &file_info ) ) {
792 PRErrorCode errcode = PR_GetError();
793 Debug( LDAP_DEBUG_ANY,
794 "TLS: could not get file info from pin file %s - error %d:%s.\n",
795 ctx->tc_pin_file, errcode,
796 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
800 /* create a buffer to hold the file contents */
801 if ( !( contents = PR_CALLOC( file_info.size + 1 ) ) ) {
802 PRErrorCode errcode = PR_GetError();
803 Debug( LDAP_DEBUG_ANY,
804 "TLS: could not alloc a buffer for contents of pin file %s - error %d:%s.\n",
805 ctx->tc_pin_file, errcode,
806 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
810 /* read file into the buffer */
811 if( PR_Read( pwd_fileptr, contents, file_info.size ) <= 0 ) {
812 PRErrorCode errcode = PR_GetError();
813 Debug( LDAP_DEBUG_ANY,
814 "TLS: could not read the file contents from pin file %s - error %d:%s.\n",
815 ctx->tc_pin_file, errcode,
816 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
820 /* format is [tokenname:]password EOL [tokenname:]password EOL ... */
821 /* if you want to use a password containing a colon character, use
822 the special tokenname "default" */
823 for ( line = PL_strtok_r( contents, "\r\n", &lasts ); line;
824 line = PL_strtok_r( NULL, "\r\n", &lasts ) ) {
828 continue; /* skip blank lines */
830 colon = PL_strchr( line, ':' );
832 if ( *(colon + 1) && token_name &&
833 !PL_strncmp( token_name, line, colon-line ) ) {
834 candidate = colon + 1; /* found a definite match */
836 } else if ( !PL_strncmp( DEFAULT_TOKEN_NAME, line, colon-line ) ) {
837 candidate = colon + 1; /* found possible match */
839 } else { /* no token name */
845 PR_Close( pwd_fileptr );
848 pwdstr = PL_strdup( candidate );
850 PL_strfree( contents );
854 #endif /* READ_PASSWORD_FROM_FILE */
856 #ifdef READ_PASSWORD_FROM_STDIN
858 * Turn the echoing off on a tty.
863 if ( isatty( fd ) ) {
865 tcgetattr( fd, &tio );
866 tio.c_lflag &= ~ECHO;
867 tcsetattr( fd, TCSAFLUSH, &tio );
872 * Turn the echoing on on a tty.
877 if ( isatty( fd ) ) {
879 tcgetattr( fd, &tio );
881 tcsetattr( fd, TCSAFLUSH, &tio );
882 tcsetattr( fd, TCSAFLUSH, &tio );
885 #endif /* READ_PASSWORD_FROM_STDIN */
888 * This does the actual work of reading the pin/password/pass phrase
891 tlsm_get_pin(PK11SlotInfo *slot, PRBool retry, tlsm_ctx *ctx)
893 char *token_name = NULL;
896 token_name = PK11_GetTokenName( slot );
897 #ifdef READ_PASSWORD_FROM_FILE
898 /* Try to get the passwords from the password file if it exists.
899 * THIS IS UNSAFE and is provided for convenience only. Without this
900 * capability the server would have to be started in foreground mode
901 * if using an encrypted key.
903 if ( ctx && ctx->tc_pin_file ) {
904 pwdstr = tlsm_get_pin_from_file( token_name, ctx );
905 if ( retry && pwdstr != NULL )
908 #endif /* RETRIEVE_PASSWORD_FROM_FILE */
909 #ifdef READ_PASSWORD_FROM_STDIN
911 int infd = PR_FileDesc2NativeHandle( PR_STDIN );
912 int isTTY = isatty( infd );
913 unsigned char phrase[200];
914 /* Prompt for password */
917 "Please enter pin, password, or pass phrase for security token '%s': ",
918 token_name ? token_name : DEFAULT_TOKEN_NAME );
921 fgets( (char*)phrase, sizeof(phrase), stdin );
923 fprintf( stdout, "\n" );
926 /* stomp on newline */
927 phrase[strlen((char*)phrase)-1] = 0;
929 pwdstr = PL_strdup( (char*)phrase );
932 #endif /* READ_PASSWORD_FROM_STDIN */
937 * PKCS11 devices (including the internal softokn cert/key database)
938 * may be protected by a pin or password or even pass phrase
939 * MozNSS needs a way for the user to provide that
942 tlsm_pin_prompt(PK11SlotInfo *slot, PRBool retry, void *arg)
944 tlsm_ctx *ctx = (tlsm_ctx *)arg;
946 return tlsm_get_pin( slot, retry, ctx );
950 tlsm_ctx_subject_name(tlsm_ctx *ctx)
952 if ( !ctx || !ctx->tc_certificate )
955 return ctx->tc_certificate->subjectName;
959 tlsm_get_basic_constraint_extension( CERTCertificate *cert,
960 CERTBasicConstraints *cbcval )
962 SECItem encodedVal = { 0, NULL };
965 rc = CERT_FindCertExtension( cert, SEC_OID_X509_BASIC_CONSTRAINTS,
967 if ( rc != SECSuccess ) {
971 rc = CERT_DecodeBasicConstraintValue( cbcval, &encodedVal );
973 /* free the raw extension data */
974 PORT_Free( encodedVal.data );
980 tlsm_cert_is_self_issued( CERTCertificate *cert )
982 /* A cert is self-issued if its subject and issuer are equal and
983 * both are of non-zero length.
985 PRBool is_self_issued = cert &&
986 (PRBool)SECITEM_ItemsAreEqual( &cert->derIssuer,
987 &cert->derSubject ) &&
988 cert->derSubject.len > 0;
989 return is_self_issued;
993 * The private key for used certificate can be already unlocked by other
994 * thread or library. Find the unlocked key if possible.
996 static SECKEYPrivateKey *
997 tlsm_find_unlocked_key( tlsm_ctx *ctx, void *pin_arg )
999 SECKEYPrivateKey *result = NULL;
1001 PK11SlotList *slots = PK11_GetAllSlotsForCert( ctx->tc_certificate, NULL );
1003 PRErrorCode errcode = PR_GetError();
1004 Debug( LDAP_DEBUG_ANY,
1005 "TLS: cannot get all slots for certificate '%s' (error %d: %s)",
1006 tlsm_ctx_subject_name( ctx ), errcode,
1007 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1011 PK11SlotListElement *le;
1012 for ( le = slots->head; le; le = le->next ) {
1013 PK11SlotInfo *slot = le->slot;
1014 if ( PK11_IsLoggedIn( slot, NULL ) ) {
1015 result = PK11_FindKeyByDERCert( slot, ctx->tc_certificate, pin_arg );
1020 PK11_FreeSlotList( slots );
1025 tlsm_verify_cert(CERTCertDBHandle *handle, CERTCertificate *cert, void *pinarg,
1026 PRBool checksig, SECCertificateUsage certUsage, PRBool warn_only,
1027 PRBool ignore_issuer )
1029 CERTVerifyLog verifylog;
1030 SECStatus ret = SECSuccess;
1032 int debug_level = LDAP_DEBUG_ANY;
1035 debug_level = LDAP_DEBUG_TRACE;
1038 /* the log captures information about every cert in the chain, so we can tell
1039 which cert caused the problem and what the problem was */
1040 memset( &verifylog, 0, sizeof( verifylog ) );
1041 verifylog.arena = PORT_NewArena( DER_DEFAULT_CHUNKSIZE );
1042 if ( verifylog.arena == NULL ) {
1043 Debug( LDAP_DEBUG_ANY,
1044 "TLS certificate verification: Out of memory for certificate verification logger\n",
1048 ret = CERT_VerifyCertificate( handle, cert, checksig, certUsage, PR_Now(), pinarg, &verifylog,
1050 if ( ( name = cert->subjectName ) == NULL ) {
1051 name = cert->nickname;
1053 if ( verifylog.head == NULL ) {
1054 /* it is possible for CERT_VerifyCertificate return with an error with no logging */
1055 if ( ret != SECSuccess ) {
1056 PRErrorCode errcode = PR_GetError();
1058 "TLS: certificate [%s] is not valid - error %d:%s.\n",
1059 name ? name : "(unknown)",
1060 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1064 CERTVerifyLogNode *node;
1066 ret = SECSuccess; /* reset */
1067 node = verifylog.head;
1069 if ( ( name = node->cert->subjectName ) == NULL ) {
1070 name = node->cert->nickname;
1072 if ( node->error ) {
1073 /* NSS does not like CA certs that have the basic constraints extension
1074 with the CA flag set to FALSE - openssl doesn't check if the cert
1076 if ( ( node->error == SEC_ERROR_CA_CERT_INVALID ) &&
1077 tlsm_cert_is_self_issued( node->cert ) ) {
1079 PRErrorCode orig_error = PR_GetError();
1080 PRInt32 orig_oserror = PR_GetOSError();
1082 CERTBasicConstraints basicConstraint;
1083 SECStatus rv = tlsm_get_basic_constraint_extension( node->cert, &basicConstraint );
1084 if ( ( rv == SECSuccess ) && ( basicConstraint.isCA == PR_FALSE ) ) {
1085 Debug( LDAP_DEBUG_TRACE,
1086 "TLS: certificate [%s] is not correct because it is a CA cert and the "
1087 "BasicConstraint CA flag is set to FALSE - allowing for now, but "
1088 "please fix your certs if possible\n", name, 0, 0 );
1089 } else { /* does not have basicconstraint, or some other error */
1092 "TLS: certificate [%s] is not valid - CA cert is not valid\n",
1096 PR_SetError( orig_error, orig_oserror );
1098 } else if ( warn_only || ( ignore_issuer && (
1099 node->error == SEC_ERROR_UNKNOWN_ISSUER ||
1100 node->error == SEC_ERROR_UNTRUSTED_ISSUER )
1104 "TLS: Warning: ignoring error for certificate [%s] - error %ld:%s.\n",
1105 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1109 "TLS: certificate [%s] is not valid - error %ld:%s.\n",
1110 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1113 CERT_DestroyCertificate( node->cert );
1118 PORT_FreeArena( verifylog.arena, PR_FALSE );
1120 if ( ret == SECSuccess ) {
1121 Debug( LDAP_DEBUG_TRACE,
1122 "TLS: certificate [%s] is valid\n", name, 0, 0 );
1129 tlsm_auth_cert_handler(void *arg, PRFileDesc *fd,
1130 PRBool checksig, PRBool isServer)
1132 SECCertificateUsage certUsage = isServer ? certificateUsageSSLClient : certificateUsageSSLServer;
1133 SECStatus ret = SECSuccess;
1134 CERTCertificate *peercert = SSL_PeerCertificate( fd );
1135 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1137 ret = tlsm_verify_cert( ctx->tc_certdb, peercert,
1138 SSL_RevealPinArg( fd ),
1139 checksig, certUsage, ctx->tc_warn_only, PR_FALSE );
1140 CERT_DestroyCertificate( peercert );
1146 tlsm_nss_shutdown_cb( void *appData, void *nssData )
1148 SECStatus rc = SECSuccess;
1150 SSL_ShutdownServerSessionIDCache();
1153 SECMOD_UnloadUserModule( pem_module );
1154 SECMOD_DestroyModule( pem_module );
1160 static PRCallOnceType tlsm_register_shutdown_callonce = {0,0};
1161 static PRStatus PR_CALLBACK
1162 tlsm_register_nss_shutdown_cb( void )
1164 if ( SECSuccess == NSS_RegisterShutdown( tlsm_nss_shutdown_cb,
1172 tlsm_register_nss_shutdown( void )
1174 return PR_CallOnce( &tlsm_register_shutdown_callonce,
1175 tlsm_register_nss_shutdown_cb );
1179 tlsm_init_pem_module( void )
1182 char *fullname = NULL;
1183 char *configstring = NULL;
1189 /* not loaded - load it */
1190 /* get the system dependent library name */
1191 fullname = PR_GetLibraryName( NULL, PEM_LIBRARY );
1192 /* Load our PKCS#11 module */
1193 configstring = PR_smprintf( "library=%s name=" PEM_MODULE " parameters=\"\"", fullname );
1194 PL_strfree( fullname );
1196 pem_module = SECMOD_LoadUserModule( configstring, NULL, PR_FALSE );
1197 PR_smprintf_free( configstring );
1199 if ( !pem_module || !pem_module->loaded ) {
1201 SECMOD_DestroyModule( pem_module );
1211 tlsm_add_pem_obj( tlsm_ctx *ctx, PK11GenericObject *obj )
1213 int idx = ctx->tc_n_pem_objs;
1214 ctx->tc_n_pem_objs++;
1215 ctx->tc_pem_objs = (PK11GenericObject **)
1216 PORT_Realloc( ctx->tc_pem_objs, ctx->tc_n_pem_objs * sizeof( PK11GenericObject * ) );
1217 ctx->tc_pem_objs[idx] = obj;
1221 tlsm_free_pem_objs( tlsm_ctx *ctx )
1223 /* free in reverse order of allocation */
1224 while ( ctx->tc_n_pem_objs-- ) {
1225 PK11_DestroyGenericObject( ctx->tc_pem_objs[ctx->tc_n_pem_objs] );
1226 ctx->tc_pem_objs[ctx->tc_n_pem_objs] = NULL;
1228 PORT_Free(ctx->tc_pem_objs);
1229 ctx->tc_pem_objs = NULL;
1230 ctx->tc_n_pem_objs = 0;
1234 tlsm_add_cert_from_file( tlsm_ctx *ctx, const char *filename, PRBool isca )
1237 PK11GenericObject *cert;
1238 CK_ATTRIBUTE attrs[4];
1239 CK_BBOOL cktrue = CK_TRUE;
1240 CK_BBOOL ckfalse = CK_FALSE;
1241 CK_OBJECT_CLASS objClass = CKO_CERTIFICATE;
1245 SECItem certDER = { 0, NULL, 0 };
1247 memset( &fi, 0, sizeof(fi) );
1248 status = PR_GetFileInfo( filename, &fi );
1249 if ( PR_SUCCESS != status) {
1250 PRErrorCode errcode = PR_GetError();
1251 Debug( LDAP_DEBUG_ANY,
1252 "TLS: could not read certificate file %s - error %d:%s.\n",
1254 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1258 if ( fi.type != PR_FILE_FILE ) {
1259 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1260 Debug( LDAP_DEBUG_ANY,
1261 "TLS: error: the certificate file %s is not a file.\n",
1266 slotname = isca ? TLSM_PEM_SLOT_CACERTS : TLSM_PEM_SLOT_CERTS;
1267 slot = PK11_FindSlotByName( slotname );
1270 PRErrorCode errcode = PR_GetError();
1271 Debug( LDAP_DEBUG_ANY,
1272 "TLS: could not find the slot for the certificate '%s' - error %d:%s.\n",
1273 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1277 PK11_SETATTRS( attrs[0], CKA_CLASS, &objClass, sizeof( objClass ) );
1278 PK11_SETATTRS( attrs[1], CKA_TOKEN, &cktrue, sizeof( CK_BBOOL ) );
1279 PK11_SETATTRS( attrs[2], CKA_LABEL, (unsigned char *) filename, strlen( filename ) + 1 );
1280 PK11_SETATTRS( attrs[3], CKA_TRUST, isca ? &cktrue : &ckfalse, sizeof( CK_BBOOL ) );
1282 cert = PK11_CreateGenericObject( slot, attrs, 4, PR_FALSE /* isPerm */ );
1285 PRErrorCode errcode = PR_GetError();
1286 Debug( LDAP_DEBUG_ANY,
1287 "TLS: could not add the certificate '%s' - error %d:%s.\n",
1288 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1289 PK11_FreeSlot( slot );
1293 /* if not CA, we store the certificate in ctx->tc_certificate */
1295 if ( PK11_ReadRawAttribute( PK11_TypeGeneric, cert, CKA_VALUE, &certDER ) != SECSuccess ) {
1296 PRErrorCode errcode = PR_GetError();
1297 Debug( LDAP_DEBUG_ANY,
1298 "TLS: could not get DER of the '%s' certificate - error %d:%s.\n",
1299 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1300 PK11_DestroyGenericObject( cert );
1301 PK11_FreeSlot( slot );
1305 ctx->tc_certificate = PK11_FindCertFromDERCertItem( slot, &certDER, NULL );
1306 SECITEM_FreeItem( &certDER, PR_FALSE );
1308 if ( !ctx->tc_certificate ) {
1309 PRErrorCode errcode = PR_GetError();
1310 Debug( LDAP_DEBUG_ANY,
1311 "TLS: could not get certificate '%s' using DER - error %d:%s.\n",
1312 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1313 PK11_DestroyGenericObject( cert );
1314 PK11_FreeSlot( slot );
1319 tlsm_add_pem_obj( ctx, cert );
1321 PK11_FreeSlot( slot );
1327 tlsm_ctx_load_private_key( tlsm_ctx *ctx )
1329 if ( !ctx->tc_certificate )
1332 if ( ctx->tc_private_key )
1335 void *pin_arg = SSL_RevealPinArg( ctx->tc_model );
1337 SECKEYPrivateKey *unlocked_key = tlsm_find_unlocked_key( ctx, pin_arg );
1338 Debug( LDAP_DEBUG_ANY,
1339 "TLS: %s unlocked certificate for certificate '%s'.\n",
1340 unlocked_key ? "found" : "no", tlsm_ctx_subject_name( ctx ), 0 );
1342 /* prefer unlocked key, then key from opened certdb, then any other */
1344 ctx->tc_private_key = unlocked_key;
1345 else if ( ctx->tc_certdb_slot )
1346 ctx->tc_private_key = PK11_FindKeyByDERCert( ctx->tc_certdb_slot, ctx->tc_certificate, pin_arg );
1348 ctx->tc_private_key = PK11_FindKeyByAnyCert( ctx->tc_certificate, pin_arg );
1350 if ( !ctx->tc_private_key ) {
1351 PRErrorCode errcode = PR_GetError();
1352 Debug(LDAP_DEBUG_ANY,
1353 "TLS: cannot find private key for certificate '%s' (error %d: %s)",
1354 tlsm_ctx_subject_name( ctx ), errcode,
1355 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1363 tlsm_add_key_from_file( tlsm_ctx *ctx, const char *filename )
1365 PK11SlotInfo * slot = NULL;
1366 PK11GenericObject *key;
1367 CK_ATTRIBUTE attrs[3];
1368 CK_BBOOL cktrue = CK_TRUE;
1369 CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1374 memset( &fi, 0, sizeof(fi) );
1375 status = PR_GetFileInfo( filename, &fi );
1376 if ( PR_SUCCESS != status) {
1377 PRErrorCode errcode = PR_GetError();
1378 Debug( LDAP_DEBUG_ANY,
1379 "TLS: could not read key file %s - error %d:%s.\n",
1381 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1385 if ( fi.type != PR_FILE_FILE ) {
1386 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1387 Debug( LDAP_DEBUG_ANY,
1388 "TLS: error: the key file %s is not a file.\n",
1393 slot = PK11_FindSlotByName( TLSM_PEM_SLOT_CERTS );
1396 PRErrorCode errcode = PR_GetError();
1397 Debug( LDAP_DEBUG_ANY,
1398 "TLS: could not find the slot for the private key '%s' - error %d:%s.\n",
1399 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1403 PK11_SETATTRS( attrs[0], CKA_CLASS, &objClass, sizeof( objClass ) );
1404 PK11_SETATTRS( attrs[1], CKA_TOKEN, &cktrue, sizeof( CK_BBOOL ) );
1405 PK11_SETATTRS( attrs[2], CKA_LABEL, (unsigned char *)filename, strlen( filename ) + 1 );
1407 key = PK11_CreateGenericObject( slot, attrs, 3, PR_FALSE /* isPerm */ );
1410 PRErrorCode errcode = PR_GetError();
1411 Debug( LDAP_DEBUG_ANY,
1412 "TLS: could not add the private key '%s' - error %d:%s.\n",
1413 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1416 tlsm_add_pem_obj( ctx, key );
1419 /* When adding an encrypted key the PKCS#11 will be set as removed */
1420 /* This will force the token to be seen as re-inserted */
1421 SECMOD_WaitForAnyTokenEvent( pem_module, 0, 0 );
1422 PK11_IsPresent( slot );
1425 PK11_FreeSlot( slot );
1431 tlsm_init_ca_certs( tlsm_ctx *ctx, const char *cacertfile, const char *cacertdir )
1433 PRBool isca = PR_TRUE;
1434 PRStatus status = PR_SUCCESS;
1435 PRErrorCode errcode = PR_SUCCESS;
1437 if ( !cacertfile && !cacertdir ) {
1438 /* no checking - not good, but allowed */
1443 int rc = tlsm_add_cert_from_file( ctx, cacertfile, isca );
1445 errcode = PR_GetError();
1446 Debug( LDAP_DEBUG_ANY,
1447 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1448 cacertfile, errcode,
1449 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1450 /* failure with cacertfile is a hard failure even if cacertdir is
1451 also specified and contains valid CA cert files */
1452 status = PR_FAILURE;
1454 Debug( LDAP_DEBUG_TRACE,
1455 "TLS: loaded CA certificate file %s.\n",
1460 /* if cacertfile above failed, we will return failure, even
1461 if there is a valid CA cert in cacertdir - but we still
1462 process cacertdir in case the user has enabled trace level
1463 debugging so they can see the processing for cacertdir too */
1464 /* any cacertdir failures are "soft" failures - if the user specifies
1465 no cert checking, then we allow the tls/ssl to continue, no matter
1466 what was specified for cacertdir, or the contents of the directory
1467 - this is different behavior than that of cacertfile */
1472 PRStatus fistatus = PR_FAILURE;
1473 regex_t hashfile_re;
1475 memset( &fi, 0, sizeof(fi) );
1476 fistatus = PR_GetFileInfo( cacertdir, &fi );
1477 if ( PR_SUCCESS != fistatus) {
1478 errcode = PR_GetError();
1479 Debug( LDAP_DEBUG_ANY,
1480 "TLS: could not get info about the CA certificate directory %s - error %d:%s.\n",
1482 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1486 if ( fi.type != PR_FILE_DIRECTORY ) {
1487 Debug( LDAP_DEBUG_ANY,
1488 "TLS: error: the CA certificate directory %s is not a directory.\n",
1493 dir = PR_OpenDir( cacertdir );
1494 if ( NULL == dir ) {
1495 errcode = PR_GetError();
1496 Debug( LDAP_DEBUG_ANY,
1497 "TLS: could not open the CA certificate directory %s - error %d:%s.\n",
1499 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1503 if ( regcomp( &hashfile_re, PEM_CA_HASH_FILE_REGEX, REG_NOSUB|REG_EXTENDED ) != 0 ) {
1504 Debug( LDAP_DEBUG_ANY, "TLS: cannot compile regex for CA hash files matching\n", 0, 0, 0 );
1509 entry = PR_ReadDir( dir, PR_SKIP_BOTH | PR_SKIP_HIDDEN );
1510 if ( ( NULL != entry ) && ( NULL != entry->name ) ) {
1511 char *fullpath = NULL;
1514 match = regexec( &hashfile_re, entry->name, 0, NULL, 0 );
1515 if ( match == REG_NOMATCH ) {
1516 Debug( LDAP_DEBUG_TRACE,
1517 "TLS: skipping '%s' - filename does not have expected format "
1518 "(certificate hash with numeric suffix)\n", entry->name, 0, 0 );
1520 } else if ( match != 0 ) {
1521 Debug( LDAP_DEBUG_ANY,
1522 "TLS: cannot execute regex for CA hash file matching (%d).\n",
1527 fullpath = PR_smprintf( "%s/%s", cacertdir, entry->name );
1528 if ( !tlsm_add_cert_from_file( ctx, fullpath, isca ) ) {
1529 Debug( LDAP_DEBUG_TRACE,
1530 "TLS: loaded CA certificate file %s from CA certificate directory %s.\n",
1531 fullpath, cacertdir, 0 );
1533 errcode = PR_GetError();
1534 Debug( LDAP_DEBUG_TRACE,
1535 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1537 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1539 PR_smprintf_free( fullpath );
1541 } while ( NULL != entry );
1542 regfree ( &hashfile_re );
1546 if ( status != PR_SUCCESS ) {
1554 * NSS supports having multiple cert/key databases in the same
1555 * directory, each one having a unique string prefix e.g.
1556 * slapd-01-cert8.db - the prefix here is "slapd-01-"
1557 * this function examines the given certdir - if it looks like
1558 * /path/to/directory/prefix it will return the
1559 * /path/to/directory part in realcertdir, and the prefix in prefix
1562 tlsm_get_certdb_prefix( const char *certdir, char **realcertdir, char **prefix )
1564 char sep = PR_GetDirectorySeparator();
1566 struct PRFileInfo prfi;
1569 *realcertdir = (char *)certdir; /* default is the one passed in */
1571 /* if certdir is not given, just return */
1576 prc = PR_GetFileInfo( certdir, &prfi );
1577 /* if certdir exists (file or directory) then it cannot specify a prefix */
1578 if ( prc == PR_SUCCESS ) {
1582 /* if certdir was given, and there is a '/' in certdir, see if there
1583 is anything after the last '/' - if so, assume it is the prefix */
1584 if ( ( ( ptr = strrchr( certdir, sep ) ) ) && *(ptr+1) ) {
1585 *realcertdir = PL_strndup( certdir, ptr-certdir );
1586 *prefix = PL_strdup( ptr+1 );
1593 * Currently mutiple MozNSS contexts share one certificate storage. When the
1594 * certdb is being opened, only new certificates are added to the storage.
1595 * When different databases are used, conflicting nicknames make the
1596 * certificate lookup by the nickname impossible. In addition a token
1597 * description might be prepended in certain conditions.
1599 * In order to make the certificate lookup by nickname possible, we explicitly
1600 * open each database using SECMOD_OpenUserDB and assign it the token
1601 * description. The token description is generated using ctx->tc_unique value,
1602 * which is unique for each context.
1604 static PK11SlotInfo *
1605 tlsm_init_open_certdb( tlsm_ctx *ctx, const char *dbdir, const char *prefix )
1607 PK11SlotInfo *slot = NULL;
1608 char *token_desc = NULL;
1609 char *config = NULL;
1611 token_desc = PR_smprintf( TLSM_CERTDB_DESC_FMT, ctx->tc_unique );
1612 config = PR_smprintf( "configDir='%s' tokenDescription='%s' certPrefix='%s' keyPrefix='%s' flags=readOnly",
1613 dbdir, token_desc, prefix, prefix );
1614 Debug( LDAP_DEBUG_TRACE, "TLS: certdb config: %s\n", config, 0, 0 );
1616 slot = SECMOD_OpenUserDB( config );
1618 PRErrorCode errcode = PR_GetError();
1619 Debug( LDAP_DEBUG_TRACE, "TLS: cannot open certdb '%s', error %d:%s\n", dbdir, errcode,
1620 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1624 PR_smprintf_free( token_desc );
1626 PR_smprintf_free( config );
1632 * This is the part of the init we defer until we get the
1633 * actual security configuration information. This is
1634 * only called once, protected by a PRCallOnce
1635 * NOTE: This must be done before the first call to SSL_ImportFD,
1636 * especially the setting of the policy
1637 * NOTE: This must be called after fork()
1640 tlsm_deferred_init( void *arg )
1642 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1643 struct ldaptls *lt = ctx->tc_config;
1644 const char *securitydirs[3];
1647 PRErrorCode errcode = 1;
1648 #ifdef HAVE_NSS_INITCONTEXT
1649 NSSInitParameters initParams;
1650 NSSInitContext *initctx = NULL;
1651 PK11SlotInfo *certdb_slot = NULL;
1656 #ifdef HAVE_SECMOD_RESTARTMODULES
1657 /* NSS enforces the pkcs11 requirement that modules should be unloaded after
1658 a fork() - since there is no portable way to determine if NSS has been
1659 already initialized in a parent process, we just call SECMOD_RestartModules
1660 with force == FALSE - if the module has been unloaded due to a fork, it will
1661 be reloaded, otherwise, it is a no-op */
1662 if ( SECFailure == ( rc = SECMOD_RestartModules(PR_FALSE /* do not force */) ) ) {
1663 errcode = PORT_GetError();
1664 if ( errcode != SEC_ERROR_NOT_INITIALIZED ) {
1665 Debug( LDAP_DEBUG_TRACE,
1666 "TLS: could not restart the security modules: %d:%s\n",
1667 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1674 #ifdef HAVE_NSS_INITCONTEXT
1675 memset( &initParams, 0, sizeof( initParams ) );
1676 initParams.length = sizeof( initParams );
1677 #endif /* HAVE_NSS_INITCONTEXT */
1679 #ifdef LDAP_R_COMPILE
1680 if ( PR_CallOnce( &tlsm_init_mutex_callonce, tlsm_thr_init_callonce ) ) {
1683 #endif /* LDAP_R_COMPILE */
1685 #ifndef HAVE_NSS_INITCONTEXT
1686 if ( !NSS_IsInitialized() ) {
1687 #endif /* HAVE_NSS_INITCONTEXT */
1689 MOZNSS_DIR will override everything else - you can
1690 always set MOZNSS_DIR to force the use of this
1692 If using MOZNSS, specify the location of the moznss db dir
1693 in the cacertdir directive of the OpenLDAP configuration.
1694 DEFAULT_MOZNSS_DIR will only be used if the code cannot
1695 find a security dir to use based on the current
1699 securitydirs[nn++] = PR_GetEnv( "MOZNSS_DIR" );
1700 securitydirs[nn++] = lt->lt_cacertdir;
1701 securitydirs[nn++] = PR_GetEnv( "DEFAULT_MOZNSS_DIR" );
1702 for ( ii = 0; !done && ( ii < nn ); ++ii ) {
1703 char *realcertdir = NULL;
1704 const char *defprefix = "";
1705 char *prefix = (char *)defprefix;
1706 const char *securitydir = securitydirs[ii];
1707 if ( NULL == securitydir ) {
1711 tlsm_get_certdb_prefix( securitydir, &realcertdir, &prefix );
1713 /* initialize only moddb; certdb will be initialized explicitly */
1714 #ifdef HAVE_NSS_INITCONTEXT
1715 #ifdef INITCONTEXT_HACK
1716 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1717 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1719 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1720 &initParams, NSS_INIT_READONLY|NSS_INIT_NOCERTDB );
1723 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1724 &initParams, NSS_INIT_READONLY|NSS_INIT_NOCERTDB );
1728 if ( initctx != NULL ) {
1729 certdb_slot = tlsm_init_open_certdb( ctx, realcertdir, prefix );
1730 if ( certdb_slot ) {
1732 ctx->tc_initctx = initctx;
1733 ctx->tc_certdb_slot = certdb_slot;
1735 NSS_ShutdownContext( initctx );
1740 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1743 if ( rc != SECSuccess ) {
1744 errcode = PORT_GetError();
1745 if ( securitydirs[ii] != lt->lt_cacertdir) {
1746 Debug( LDAP_DEBUG_TRACE,
1747 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1748 realcertdir, prefix, errcode );
1752 Debug( LDAP_DEBUG_TRACE, "TLS: using moznss security dir %s prefix %s.\n",
1753 realcertdir, prefix, 0 );
1757 if ( realcertdir != securitydir ) {
1758 PL_strfree( realcertdir );
1760 if ( prefix != defprefix ) {
1761 PL_strfree( prefix );
1765 if ( errcode ) { /* no moznss db found, or not using moznss db */
1766 #ifdef HAVE_NSS_INITCONTEXT
1767 int flags = NSS_INIT_READONLY|NSS_INIT_NOCERTDB|NSS_INIT_NOMODDB;
1768 #ifdef INITCONTEXT_HACK
1769 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1770 rc = NSS_NoDB_Init( NULL );
1772 initctx = NSS_InitContext( CERTDB_NONE, PREFIX_NONE, PREFIX_NONE, SECMOD_DB,
1773 &initParams, flags );
1774 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1777 initctx = NSS_InitContext( CERTDB_NONE, PREFIX_NONE, PREFIX_NONE, SECMOD_DB,
1778 &initParams, flags );
1780 ctx->tc_initctx = initctx;
1787 rc = NSS_NoDB_Init( NULL );
1789 if ( rc != SECSuccess ) {
1790 errcode = PORT_GetError();
1791 Debug( LDAP_DEBUG_ANY,
1792 "TLS: could not initialize moznss - error %d:%s.\n",
1793 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1798 if ( errcode || lt->lt_cacertfile ) {
1799 /* initialize the PEM module */
1800 if ( tlsm_init_pem_module() ) {
1801 int pem_errcode = PORT_GetError();
1802 Debug( LDAP_DEBUG_ANY,
1803 "TLS: could not initialize moznss PEM module - error %d:%s.\n",
1804 pem_errcode, PR_ErrorToString( pem_errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1806 if ( errcode ) /* PEM is required */
1809 } else if ( !errcode ) {
1810 tlsm_init_ca_certs( ctx, lt->lt_cacertfile, NULL );
1815 if ( tlsm_init_ca_certs( ctx, lt->lt_cacertfile, lt->lt_cacertdir ) ) {
1816 /* if we tried to use lt->lt_cacertdir as an NSS key/cert db, errcode
1817 will be a value other than 1 - print an error message so that the
1818 user will know that failed too */
1819 if ( ( errcode != 1 ) && ( lt->lt_cacertdir ) ) {
1820 char *realcertdir = NULL;
1821 char *prefix = NULL;
1822 tlsm_get_certdb_prefix( lt->lt_cacertdir, &realcertdir, &prefix );
1823 Debug( LDAP_DEBUG_TRACE,
1824 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1825 realcertdir, prefix ? prefix : "", errcode );
1826 if ( realcertdir != lt->lt_cacertdir ) {
1827 PL_strfree( realcertdir );
1829 PL_strfree( prefix );
1834 ctx->tc_using_pem = PR_TRUE;
1837 NSS_SetDomesticPolicy();
1839 PK11_SetPasswordFunc( tlsm_pin_prompt );
1841 /* register cleanup function */
1842 if ( tlsm_register_nss_shutdown() ) {
1843 errcode = PORT_GetError();
1844 Debug( LDAP_DEBUG_ANY,
1845 "TLS: could not register NSS shutdown function: %d:%s\n",
1846 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1850 if ( ctx->tc_is_server ) {
1851 /* 0 means use the defaults here */
1852 SSL_ConfigServerSessionIDCache( 0, 0, 0, NULL );
1855 #ifndef HAVE_NSS_INITCONTEXT
1857 #endif /* HAVE_NSS_INITCONTEXT */
1863 * Find and verify the certificate.
1864 * The key is loaded and stored in ctx->tc_private_key
1867 tlsm_find_and_verify_cert_key( tlsm_ctx *ctx )
1869 SECCertificateUsage certUsage;
1874 if ( tlsm_ctx_load_private_key( ctx ) )
1877 pin_arg = SSL_RevealPinArg( ctx->tc_model );
1878 certUsage = ctx->tc_is_server ? certificateUsageSSLServer : certificateUsageSSLClient;
1879 checkSig = ctx->tc_verify_cert ? PR_TRUE : PR_FALSE;
1881 status = tlsm_verify_cert( ctx->tc_certdb, ctx->tc_certificate, pin_arg,
1882 checkSig, certUsage, ctx->tc_warn_only, PR_TRUE );
1884 return status == SECSuccess ? 0 : -1;
1888 tlsm_get_client_auth_data( void *arg, PRFileDesc *fd,
1889 CERTDistNames *caNames, CERTCertificate **pRetCert,
1890 SECKEYPrivateKey **pRetKey )
1892 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1895 *pRetCert = CERT_DupCertificate( ctx->tc_certificate );
1898 *pRetKey = SECKEY_CopyPrivateKey( ctx->tc_private_key );
1904 * ctx must have a tc_model that is valid
1907 tlsm_clientauth_init( tlsm_ctx *ctx )
1909 SECStatus status = SECFailure;
1913 saveval = ctx->tc_warn_only;
1914 ctx->tc_warn_only = PR_TRUE;
1915 rc = tlsm_find_and_verify_cert_key(ctx);
1916 ctx->tc_warn_only = saveval;
1918 Debug( LDAP_DEBUG_ANY,
1919 "TLS: error: unable to set up client certificate authentication for "
1920 "certificate named %s\n", tlsm_ctx_subject_name(ctx), 0, 0 );
1924 status = SSL_GetClientAuthDataHook( ctx->tc_model,
1925 tlsm_get_client_auth_data,
1928 return ( status == SECSuccess ? 0 : -1 );
1932 * Tear down the TLS subsystem. Should only be called once.
1935 tlsm_destroy( void )
1937 #ifdef LDAP_R_COMPILE
1938 ldap_pvt_thread_mutex_destroy( &tlsm_ctx_count_mutex );
1939 ldap_pvt_thread_mutex_destroy( &tlsm_init_mutex );
1940 ldap_pvt_thread_mutex_destroy( &tlsm_pem_mutex );
1944 static struct ldaptls *
1945 tlsm_copy_config ( const struct ldaptls *config )
1947 struct ldaptls *copy;
1951 copy = LDAP_MALLOC( sizeof( *copy ) );
1955 memset( copy, 0, sizeof( *copy ) );
1957 if ( config->lt_certfile )
1958 copy->lt_certfile = LDAP_STRDUP( config->lt_certfile );
1959 if ( config->lt_keyfile )
1960 copy->lt_keyfile = LDAP_STRDUP( config->lt_keyfile );
1961 if ( config->lt_dhfile )
1962 copy->lt_dhfile = LDAP_STRDUP( config->lt_dhfile );
1963 if ( config->lt_cacertfile )
1964 copy->lt_cacertfile = LDAP_STRDUP( config->lt_cacertfile );
1965 if ( config->lt_cacertdir )
1966 copy->lt_cacertdir = LDAP_STRDUP( config->lt_cacertdir );
1967 if ( config->lt_ciphersuite )
1968 copy->lt_ciphersuite = LDAP_STRDUP( config->lt_ciphersuite );
1969 if ( config->lt_crlfile )
1970 copy->lt_crlfile = LDAP_STRDUP( config->lt_crlfile );
1971 if ( config->lt_randfile )
1972 copy->lt_randfile = LDAP_STRDUP( config->lt_randfile );
1974 copy->lt_protocol_min = config->lt_protocol_min;
1980 tlsm_free_config ( struct ldaptls *config )
1984 if ( config->lt_certfile )
1985 LDAP_FREE( config->lt_certfile );
1986 if ( config->lt_keyfile )
1987 LDAP_FREE( config->lt_keyfile );
1988 if ( config->lt_dhfile )
1989 LDAP_FREE( config->lt_dhfile );
1990 if ( config->lt_cacertfile )
1991 LDAP_FREE( config->lt_cacertfile );
1992 if ( config->lt_cacertdir )
1993 LDAP_FREE( config->lt_cacertdir );
1994 if ( config->lt_ciphersuite )
1995 LDAP_FREE( config->lt_ciphersuite );
1996 if ( config->lt_crlfile )
1997 LDAP_FREE( config->lt_crlfile );
1998 if ( config->lt_randfile )
1999 LDAP_FREE( config->lt_randfile );
2001 LDAP_FREE( config );
2005 tlsm_ctx_new ( struct ldapoptions *lo )
2009 ctx = LDAP_MALLOC( sizeof (*ctx) );
2012 #ifdef LDAP_R_COMPILE
2013 ldap_pvt_thread_mutex_init( &ctx->tc_refmutex );
2015 LDAP_MUTEX_LOCK( &tlsm_ctx_count_mutex );
2016 ctx->tc_unique = tlsm_ctx_count++;
2017 LDAP_MUTEX_UNLOCK( &tlsm_ctx_count_mutex );
2018 ctx->tc_config = NULL; /* populated later by tlsm_ctx_init */
2019 ctx->tc_certdb = NULL;
2020 ctx->tc_certdb_slot = NULL;
2021 ctx->tc_certificate = NULL;
2022 ctx->tc_private_key = NULL;
2023 ctx->tc_pin_file = NULL;
2024 ctx->tc_model = NULL;
2025 memset(&ctx->tc_callonce, 0, sizeof(ctx->tc_callonce));
2026 ctx->tc_require_cert = lo->ldo_tls_require_cert;
2027 ctx->tc_verify_cert = PR_FALSE;
2028 ctx->tc_using_pem = PR_FALSE;
2029 #ifdef HAVE_NSS_INITCONTEXT
2030 ctx->tc_initctx = NULL;
2031 #endif /* HAVE_NSS_INITCONTEXT */
2032 ctx->tc_pem_objs = NULL;
2033 ctx->tc_n_pem_objs = 0;
2034 ctx->tc_warn_only = PR_FALSE;
2036 return (tls_ctx *)ctx;
2040 tlsm_ctx_ref( tls_ctx *ctx )
2042 tlsm_ctx *c = (tlsm_ctx *)ctx;
2043 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2045 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2049 tlsm_ctx_free ( tls_ctx *ctx )
2051 tlsm_ctx *c = (tlsm_ctx *)ctx;
2056 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2057 refcount = --c->tc_refcnt;
2058 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2062 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
2064 PR_Close( c->tc_model );
2065 if ( c->tc_certificate )
2066 CERT_DestroyCertificate( c->tc_certificate );
2067 if ( c->tc_private_key )
2068 SECKEY_DestroyPrivateKey( c->tc_private_key );
2069 c->tc_certdb = NULL; /* if not the default, may have to clean up */
2070 if ( c->tc_certdb_slot ) {
2071 if ( SECMOD_CloseUserDB( c->tc_certdb_slot ) ) {
2072 PRErrorCode errcode = PR_GetError();
2073 Debug( LDAP_DEBUG_ANY,
2074 "TLS: could not close certdb slot - error %d:%s.\n",
2075 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
2078 if ( c->tc_pin_file ) {
2079 PL_strfree( c->tc_pin_file );
2080 c->tc_pin_file = NULL;
2082 tlsm_free_pem_objs( c );
2083 #ifdef HAVE_NSS_INITCONTEXT
2084 if ( c->tc_initctx ) {
2085 if ( NSS_ShutdownContext( c->tc_initctx ) ) {
2086 PRErrorCode errcode = PR_GetError();
2087 Debug( LDAP_DEBUG_ANY,
2088 "TLS: could not shutdown NSS - error %d:%s.\n",
2089 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
2092 c->tc_initctx = NULL;
2093 #endif /* HAVE_NSS_INITCONTEXT */
2094 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
2095 #ifdef LDAP_R_COMPILE
2096 ldap_pvt_thread_mutex_destroy( &c->tc_refmutex );
2100 tlsm_free_config( c->tc_config );
2106 * initialize a new TLS context
2109 tlsm_ctx_init( struct ldapoptions *lo, struct ldaptls *lt, int is_server )
2111 tlsm_ctx *ctx = (tlsm_ctx *)lo->ldo_tls_ctx;
2112 ctx->tc_config = tlsm_copy_config( lt );
2113 ctx->tc_is_server = is_server;
2118 /* returns true if the given string looks like
2119 "tokenname" ":" "certnickname"
2120 This is true if there is a ':' colon character
2121 in the string and the colon is not the first
2122 or the last character in the string
2125 tlsm_is_tokenname_certnick( const char *certfile )
2128 const char *ptr = PL_strchr( certfile, ':' );
2129 return ptr && (ptr != certfile) && (*(ptr+1));
2135 tlsm_deferred_ctx_init( void *arg )
2137 tlsm_ctx *ctx = (tlsm_ctx *)arg;
2138 PRBool sslv2 = PR_FALSE;
2139 PRBool sslv3 = PR_TRUE;
2140 PRBool tlsv1 = PR_TRUE;
2141 PRBool request_cert = PR_FALSE;
2142 PRInt32 require_cert = PR_FALSE;
2146 if ( tlsm_deferred_init( ctx ) ) {
2147 Debug( LDAP_DEBUG_ANY,
2148 "TLS: could not perform TLS system initialization.\n",
2153 ctx->tc_certdb = CERT_GetDefaultCertDB(); /* If there is ever a per-context db, change this */
2155 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2157 ctx->tc_model = SSL_ImportFD( NULL, fd );
2160 if ( !ctx->tc_model ) {
2161 PRErrorCode err = PR_GetError();
2162 Debug( LDAP_DEBUG_ANY,
2163 "TLS: could perform TLS socket I/O layer initialization - error %d:%s.\n",
2164 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2172 if ( SSL_SetPKCS11PinArg(ctx->tc_model, ctx) ) {
2173 Debug( LDAP_DEBUG_ANY,
2174 "TLS: could not set pin prompt argument\n", 0, 0, 0);
2178 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_SECURITY, PR_TRUE ) ) {
2179 Debug( LDAP_DEBUG_ANY,
2180 "TLS: could not set secure mode on.\n",
2185 lt = ctx->tc_config;
2187 /* default is sslv3 and tlsv1 */
2188 if ( lt->lt_protocol_min ) {
2189 if ( lt->lt_protocol_min > LDAP_OPT_X_TLS_PROTOCOL_SSL3 ) {
2191 } else if ( lt->lt_protocol_min <= LDAP_OPT_X_TLS_PROTOCOL_SSL2 ) {
2193 Debug( LDAP_DEBUG_ANY,
2194 "TLS: warning: minimum TLS protocol level set to "
2195 "include SSLv2 - SSLv2 is insecure - do not use\n", 0, 0, 0 );
2198 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL2, sslv2 ) ) {
2199 Debug( LDAP_DEBUG_ANY,
2200 "TLS: could not set SSLv2 mode on.\n",
2204 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL3, sslv3 ) ) {
2205 Debug( LDAP_DEBUG_ANY,
2206 "TLS: could not set SSLv3 mode on.\n",
2210 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_TLS, tlsv1 ) ) {
2211 Debug( LDAP_DEBUG_ANY,
2212 "TLS: could not set TLSv1 mode on.\n",
2217 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_CLIENT, !ctx->tc_is_server ) ) {
2218 Debug( LDAP_DEBUG_ANY,
2219 "TLS: could not set handshake as client.\n",
2223 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_SERVER, ctx->tc_is_server ) ) {
2224 Debug( LDAP_DEBUG_ANY,
2225 "TLS: could not set handshake as server.\n",
2230 if ( lt->lt_ciphersuite ) {
2231 if ( tlsm_parse_ciphers( ctx, lt->lt_ciphersuite ) ) {
2232 Debug( LDAP_DEBUG_ANY,
2233 "TLS: could not set cipher list %s.\n",
2234 lt->lt_ciphersuite, 0, 0 );
2237 } else if ( tlsm_parse_ciphers( ctx, "DEFAULT" ) ) {
2238 Debug( LDAP_DEBUG_ANY,
2239 "TLS: could not set cipher list DEFAULT.\n",
2244 if ( !ctx->tc_require_cert ) {
2245 ctx->tc_verify_cert = PR_FALSE;
2246 } else if ( !ctx->tc_is_server ) {
2247 request_cert = PR_TRUE;
2248 require_cert = SSL_REQUIRE_NO_ERROR;
2249 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
2250 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
2251 require_cert = SSL_REQUIRE_ALWAYS;
2253 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW )
2254 ctx->tc_verify_cert = PR_TRUE;
2255 } else { /* server */
2256 /* server does not request certs by default */
2257 /* if allow - client may send cert, server will ignore if errors */
2258 /* if try - client may send cert, server will error if bad cert */
2259 /* if hard or demand - client must send cert, server will error if bad cert */
2260 request_cert = PR_TRUE;
2261 require_cert = SSL_REQUIRE_NO_ERROR;
2262 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
2263 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
2264 require_cert = SSL_REQUIRE_ALWAYS;
2266 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW ) {
2267 ctx->tc_verify_cert = PR_TRUE;
2269 ctx->tc_warn_only = PR_TRUE;
2273 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUEST_CERTIFICATE, request_cert ) ) {
2274 Debug( LDAP_DEBUG_ANY,
2275 "TLS: could not set request certificate mode.\n",
2280 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUIRE_CERTIFICATE, require_cert ) ) {
2281 Debug( LDAP_DEBUG_ANY,
2282 "TLS: could not set require certificate mode.\n",
2287 /* set up our cert and key, if any */
2288 if ( lt->lt_certfile ) {
2289 /* if using the PEM module, load the PEM file specified by lt_certfile */
2290 /* otherwise, assume this is the name of a cert already in the db */
2291 if ( ctx->tc_using_pem ) {
2292 /* this sets ctx->tc_certificate to the correct value */
2293 int rc = tlsm_add_cert_from_file( ctx, lt->lt_certfile, PR_FALSE );
2300 if ( tlsm_is_tokenname_certnick( lt->lt_certfile )) {
2301 /* assume already in form tokenname:certnickname */
2302 tmp_certname = PL_strdup( lt->lt_certfile );
2303 } else if ( ctx->tc_certdb_slot ) {
2304 tmp_certname = PR_smprintf( TLSM_CERTDB_DESC_FMT ":%s", ctx->tc_unique, lt->lt_certfile );
2306 tmp_certname = PR_smprintf( "%s", lt->lt_certfile );
2309 ctx->tc_certificate = PK11_FindCertFromNickname( tmp_certname, SSL_RevealPinArg( ctx->tc_model ) );
2310 PR_smprintf_free( tmp_certname );
2312 if ( !ctx->tc_certificate ) {
2313 PRErrorCode errcode = PR_GetError();
2314 Debug( LDAP_DEBUG_ANY,
2315 "TLS: error: the certificate '%s' could not be found in the database - error %d:%s.\n",
2316 lt->lt_certfile, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
2322 if ( lt->lt_keyfile ) {
2323 /* if using the PEM module, load the PEM file specified by lt_keyfile */
2324 /* otherwise, assume this is the pininfo for the key */
2325 if ( ctx->tc_using_pem ) {
2326 int rc = tlsm_add_key_from_file( ctx, lt->lt_keyfile );
2331 if ( ctx->tc_pin_file )
2332 PL_strfree( ctx->tc_pin_file );
2333 ctx->tc_pin_file = PL_strdup( lt->lt_keyfile );
2337 /* Set up callbacks for use by clients */
2338 if ( !ctx->tc_is_server ) {
2339 if ( SSL_OptionSet( ctx->tc_model, SSL_NO_CACHE, PR_TRUE ) != SECSuccess ) {
2340 PRErrorCode err = PR_GetError();
2341 Debug( LDAP_DEBUG_ANY,
2342 "TLS: error: could not set nocache option for moznss - error %d:%s\n",
2343 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2347 if ( SSL_BadCertHook( ctx->tc_model, tlsm_bad_cert_handler, ctx ) != SECSuccess ) {
2348 PRErrorCode err = PR_GetError();
2349 Debug( LDAP_DEBUG_ANY,
2350 "TLS: error: could not set bad cert handler for moznss - error %d:%s\n",
2351 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2356 since a cert has been specified, assume the client wants to do cert auth
2358 if ( ctx->tc_certificate ) {
2359 if ( tlsm_clientauth_init( ctx ) ) {
2360 Debug( LDAP_DEBUG_ANY,
2361 "TLS: error: unable to set up client certificate authentication using '%s'\n",
2362 tlsm_ctx_subject_name(ctx), 0, 0 );
2366 } else { /* set up secure server */
2370 /* must have a certificate for the server to use */
2371 if ( !ctx->tc_certificate ) {
2372 Debug( LDAP_DEBUG_ANY,
2373 "TLS: error: no server certificate: must specify a certificate for the server to use\n",
2378 if ( tlsm_find_and_verify_cert_key( ctx ) ) {
2379 Debug( LDAP_DEBUG_ANY,
2380 "TLS: error: unable to find and verify server's cert and key for certificate %s\n",
2381 tlsm_ctx_subject_name(ctx), 0, 0 );
2385 /* configure the socket to be a secure server socket */
2386 certKEA = NSS_FindCertKEAType( ctx->tc_certificate );
2387 status = SSL_ConfigSecureServer( ctx->tc_model, ctx->tc_certificate, ctx->tc_private_key, certKEA );
2389 if ( SECSuccess != status ) {
2390 PRErrorCode err = PR_GetError();
2391 Debug( LDAP_DEBUG_ANY,
2392 "TLS: error: unable to configure secure server using certificate '%s' - error %d:%s\n",
2393 tlsm_ctx_subject_name(ctx), err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) );
2398 /* Callback for authenticating certificate */
2399 if ( SSL_AuthCertificateHook( ctx->tc_model, tlsm_auth_cert_handler,
2400 ctx ) != SECSuccess ) {
2401 PRErrorCode err = PR_GetError();
2402 Debug( LDAP_DEBUG_ANY,
2403 "TLS: error: could not set auth cert handler for moznss - error %d:%s\n",
2404 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2408 if ( SSL_HandshakeCallback( ctx->tc_model, tlsm_handshake_complete_cb, ctx ) ) {
2409 PRErrorCode err = PR_GetError();
2410 Debug( LDAP_DEBUG_ANY,
2411 "TLS: error: could not set handshake callback for moznss - error %d:%s\n",
2412 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2416 tlsm_free_config( ctx->tc_config );
2417 ctx->tc_config = NULL;
2423 tlsm_session *session;
2424 Sockbuf_IO_Desc *sbiod;
2425 /* there seems to be no portable way to determine if the
2426 sockbuf sd has been set to nonblocking mode - the
2427 call to ber_pvt_socket_set_nonblock() takes place
2428 before the tls socket is set up, so we cannot
2429 intercept that call either.
2430 On systems where fcntl is available, we can just
2431 F_GETFL and test for O_NONBLOCK. On other systems,
2432 we will just see if the IO op returns EAGAIN or EWOULDBLOCK,
2433 and just set this flag */
2436 * NSS tries hard to be backwards compatible with SSLv2 clients, or
2437 * clients that send an SSLv2 client hello. This message is not
2438 * tagged in any way, so NSS has no way to know if the incoming
2439 * message is a valid SSLv2 client hello or just some bogus data
2440 * (or cleartext LDAP). We store the first byte read from the
2441 * client here. The most common case will be a client sending
2442 * LDAP data instead of SSL encrypted LDAP data. This can happen,
2443 * for example, if using ldapsearch -Z - if the starttls fails,
2444 * the client will fallback to plain cleartext LDAP. So if we
2445 * see that the firstbyte is a valid LDAP tag, we can be
2446 * pretty sure this is happening.
2450 * NSS doesn't return SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE, etc.
2451 * when it is blocked, so we have to set a flag in the wrapped send
2452 * and recv calls that tells us what operation NSS was last blocked
2456 #define TLSM_WRITE 2
2460 static struct tls_data *
2461 tlsm_get_pvt_tls_data( PRFileDesc *fd )
2470 myfd = PR_GetIdentitiesLayer( fd, tlsm_layer_id );
2476 p = (struct tls_data *)myfd->secret;
2482 tlsm_is_non_ssl_message( PRFileDesc *fd, ber_tag_t *thebyte )
2487 *thebyte = LBER_DEFAULT;
2490 p = tlsm_get_pvt_tls_data( fd );
2491 if ( p == NULL || p->sbiod == NULL ) {
2495 if ( p->firsttag == LBER_SEQUENCE ) {
2497 *thebyte = p->firsttag;
2505 static tls_session *
2506 tlsm_session_new ( tls_ctx * ctx, int is_server )
2508 tlsm_ctx *c = (tlsm_ctx *)ctx;
2509 tlsm_session *session;
2514 c->tc_is_server = is_server;
2515 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
2516 status = PR_CallOnceWithArg( &c->tc_callonce, tlsm_deferred_ctx_init, c );
2517 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
2518 if ( PR_SUCCESS != status ) {
2519 PRErrorCode err = PR_GetError();
2520 Debug( LDAP_DEBUG_ANY,
2521 "TLS: error: could not initialize moznss security context - error %d:%s\n",
2522 err, PR_ErrorToString(err, PR_LANGUAGE_I_DEFAULT), NULL );
2526 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2531 session = SSL_ImportFD( c->tc_model, fd );
2537 rc = SSL_ResetHandshake( session, is_server );
2539 PRErrorCode err = PR_GetError();
2540 Debug( LDAP_DEBUG_TRACE,
2541 "TLS: error: new session - reset handshake failure %d - error %d:%s\n",
2543 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2545 PR_Close( session );
2549 return (tls_session *)session;
2553 tlsm_session_accept_or_connect( tls_session *session, int is_accept )
2555 tlsm_session *s = (tlsm_session *)session;
2557 const char *op = is_accept ? "accept" : "connect";
2560 LDAP_MUTEX_LOCK( &tlsm_pem_mutex );
2562 rc = SSL_ForceHandshake( s );
2564 LDAP_MUTEX_UNLOCK( &tlsm_pem_mutex );
2567 PRErrorCode err = PR_GetError();
2569 if ( err == PR_WOULD_BLOCK_ERROR ) {
2570 ber_tag_t thetag = LBER_DEFAULT;
2571 /* see if we are blocked because of a bogus packet */
2572 if ( tlsm_is_non_ssl_message( s, &thetag ) ) { /* see if we received a non-SSL message */
2573 Debug( LDAP_DEBUG_ANY,
2574 "TLS: error: %s - error - received non-SSL message [0x%x]\n",
2575 op, (unsigned int)thetag, 0 );
2576 /* reset error to something more descriptive */
2577 PR_SetError( SSL_ERROR_RX_MALFORMED_HELLO_REQUEST, EPROTO );
2580 Debug( LDAP_DEBUG_ANY,
2581 "TLS: error: %s - force handshake failure: errno %d - moznss error %d\n",
2589 tlsm_session_accept( tls_session *session )
2591 return tlsm_session_accept_or_connect( session, 1 );
2595 tlsm_session_connect( LDAP *ld, tls_session *session )
2597 return tlsm_session_accept_or_connect( session, 0 );
2601 tlsm_session_upflags( Sockbuf *sb, tls_session *session, int rc )
2603 int prerror = PR_GetError();
2605 if ( ( prerror == PR_PENDING_INTERRUPT_ERROR ) || ( prerror == PR_WOULD_BLOCK_ERROR ) ) {
2606 tlsm_session *s = (tlsm_session *)session;
2607 struct tls_data *p = tlsm_get_pvt_tls_data( s );
2609 if ( p && ( p->io_flag == TLSM_READ ) ) {
2610 sb->sb_trans_needs_read = 1;
2612 } else if ( p && ( p->io_flag == TLSM_WRITE ) ) {
2613 sb->sb_trans_needs_write = 1;
2622 tlsm_session_errmsg( tls_session *sess, int rc, char *buf, size_t len )
2625 int prerror = PR_GetError();
2627 i = PR_GetErrorTextLength();
2629 char *msg = LDAP_MALLOC( i+1 );
2630 PR_GetErrorText( msg );
2631 memcpy( buf, msg, len );
2634 PR_GetErrorText( buf );
2635 } else if ( prerror ) {
2636 i = PR_snprintf( buf, len, "TLS error %d:%s",
2637 prerror, PR_ErrorToString( prerror, PR_LANGUAGE_I_DEFAULT ) );
2640 return ( i > 0 ) ? buf : NULL;
2644 tlsm_session_my_dn( tls_session *session, struct berval *der_dn )
2646 tlsm_session *s = (tlsm_session *)session;
2647 CERTCertificate *cert;
2649 cert = SSL_LocalCertificate( s );
2650 if (!cert) return LDAP_INVALID_CREDENTIALS;
2652 der_dn->bv_val = (char *)cert->derSubject.data;
2653 der_dn->bv_len = cert->derSubject.len;
2654 CERT_DestroyCertificate( cert );
2659 tlsm_session_peer_dn( tls_session *session, struct berval *der_dn )
2661 tlsm_session *s = (tlsm_session *)session;
2662 CERTCertificate *cert;
2664 cert = SSL_PeerCertificate( s );
2665 if (!cert) return LDAP_INVALID_CREDENTIALS;
2667 der_dn->bv_val = (char *)cert->derSubject.data;
2668 der_dn->bv_len = cert->derSubject.len;
2669 CERT_DestroyCertificate( cert );
2673 /* what kind of hostname were we given? */
2679 tlsm_session_chkhost( LDAP *ld, tls_session *session, const char *name_in )
2681 tlsm_session *s = (tlsm_session *)session;
2682 CERTCertificate *cert;
2683 const char *name, *domain = NULL, *ptr;
2684 int ret, ntype = IS_DNS, nlen, dlen;
2685 #ifdef LDAP_PF_INET6
2686 struct in6_addr addr;
2688 struct in_addr addr;
2693 if( ldap_int_hostname &&
2694 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
2696 name = ldap_int_hostname;
2700 nlen = strlen( name );
2702 cert = SSL_PeerCertificate( s );
2704 Debug( LDAP_DEBUG_ANY,
2705 "TLS: unable to get peer certificate.\n",
2707 /* if this was a fatal condition, things would have
2708 * aborted long before now.
2710 return LDAP_SUCCESS;
2713 #ifdef LDAP_PF_INET6
2714 if (inet_pton(AF_INET6, name, &addr)) {
2718 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
2719 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
2721 if (ntype == IS_DNS ) {
2722 domain = strchr( name, '.' );
2724 dlen = nlen - ( domain - name );
2727 ret = LDAP_LOCAL_ERROR;
2729 rv = CERT_FindCertExtension( cert, SEC_OID_X509_SUBJECT_ALT_NAME,
2731 if ( rv == SECSuccess && altname.data ) {
2733 CERTGeneralName *names, *cur;
2735 arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
2737 ret = LDAP_NO_MEMORY;
2741 names = cur = CERT_DecodeAltNameExtension(arena, &altname);
2750 if ( !cur->name.other.len ) continue;
2752 host = (char *)cur->name.other.data;
2753 hlen = cur->name.other.len;
2755 if ( cur->type == certDNSName ) {
2756 if ( ntype != IS_DNS ) continue;
2758 /* is this an exact match? */
2759 if ( nlen == hlen && !strncasecmp( name, host, nlen )) {
2764 /* is this a wildcard match? */
2765 if ( domain && host[0] == '*' && host[1] == '.' &&
2766 dlen == hlen-1 && !strncasecmp( domain, host+1, dlen )) {
2770 } else if ( cur->type == certIPAddress ) {
2771 if ( ntype == IS_DNS ) continue;
2773 #ifdef LDAP_PF_INET6
2774 if (ntype == IS_IP6 && hlen != sizeof(struct in6_addr)) {
2778 if (ntype == IS_IP4 && hlen != sizeof(struct in_addr)) {
2781 if (!memcmp(host, &addr, hlen)) {
2786 } while (( cur = CERT_GetNextGeneralName( cur )) != names );
2788 PORT_FreeArena( arena, PR_FALSE );
2789 SECITEM_FreeItem( &altname, PR_FALSE );
2791 /* no altnames matched, try the CN */
2792 if ( ret != LDAP_SUCCESS ) {
2793 /* find the last CN */
2794 CERTRDN *rdn, **rdns;
2795 CERTAVA *lastava = NULL;
2799 rdns = cert->subject.rdns;
2800 while ( rdns && ( rdn = *rdns++ )) {
2801 CERTAVA *ava, **avas = rdn->avas;
2802 while ( avas && ( ava = *avas++ )) {
2803 if ( CERT_GetAVATag( ava ) == SEC_OID_AVA_COMMON_NAME )
2808 SECItem *av = CERT_DecodeAVAValue( &lastava->value );
2810 if ( av->len == nlen && !strncasecmp( name, (char *)av->data, nlen )) {
2812 } else if ( av->data[0] == '*' && av->data[1] == '.' &&
2813 domain && dlen == av->len - 1 && !strncasecmp( domain,
2814 (char *)(av->data+1), dlen )) {
2818 if ( len >= sizeof(buf) )
2819 len = sizeof(buf)-1;
2820 memcpy( buf, av->data, len );
2823 SECITEM_FreeItem( av, PR_TRUE );
2826 if ( ret != LDAP_SUCCESS ) {
2827 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
2828 "common name in certificate (%s).\n",
2830 ret = LDAP_CONNECT_ERROR;
2831 if ( ld->ld_error ) {
2832 LDAP_FREE( ld->ld_error );
2834 ld->ld_error = LDAP_STRDUP(
2835 _("TLS: hostname does not match CN in peer certificate"));
2840 CERT_DestroyCertificate( cert );
2845 tlsm_session_strength( tls_session *session )
2847 tlsm_session *s = (tlsm_session *)session;
2850 rc = SSL_SecurityStatus( s, NULL, NULL, NULL, &keySize,
2852 return rc ? 0 : keySize;
2856 * TLS support for LBER Sockbufs
2859 static PRStatus PR_CALLBACK
2860 tlsm_PR_Close(PRFileDesc *fd)
2862 int rc = PR_SUCCESS;
2864 /* we don't need to actually close anything here, just
2865 pop our io layer off the stack */
2866 fd->secret = NULL; /* must have been freed before calling PR_Close */
2868 fd = PR_PopIOLayer( fd, tlsm_layer_id );
2869 /* if we are not the last layer, pass the close along */
2874 rc = fd->methods->close( fd );
2877 /* we are the last layer - just call our dtor */
2884 static PRStatus PR_CALLBACK
2885 tlsm_PR_Shutdown(PRFileDesc *fd, PRShutdownHow how)
2887 int rc = PR_SUCCESS;
2890 rc = PR_Shutdown( fd->lower, how );
2896 static int PR_CALLBACK
2897 tlsm_PR_Recv(PRFileDesc *fd, void *buf, PRInt32 len, PRIntn flags,
2898 PRIntervalTime timeout)
2903 if ( buf == NULL || len <= 0 ) return 0;
2905 p = tlsm_get_pvt_tls_data( fd );
2907 if ( p == NULL || p->sbiod == NULL ) {
2911 rc = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
2913 tlsm_map_error( errno );
2914 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2915 p->nonblock = PR_TRUE; /* fd is using non-blocking io */
2916 } else if ( errno ) { /* real error */
2917 Debug( LDAP_DEBUG_TRACE,
2918 "TLS: error: tlsm_PR_Recv returned %d - error %d:%s\n",
2919 rc, errno, STRERROR(errno) );
2921 } else if ( ( rc > 0 ) && ( len > 0 ) && ( p->firsttag == LBER_DEFAULT ) ) {
2922 p->firsttag = (ber_tag_t)*((char *)buf);
2924 p->io_flag = TLSM_READ;
2929 static int PR_CALLBACK
2930 tlsm_PR_Send(PRFileDesc *fd, const void *buf, PRInt32 len, PRIntn flags,
2931 PRIntervalTime timeout)
2936 if ( buf == NULL || len <= 0 ) return 0;
2938 p = tlsm_get_pvt_tls_data( fd );
2940 if ( p == NULL || p->sbiod == NULL ) {
2944 rc = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
2946 tlsm_map_error( errno );
2947 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2948 p->nonblock = PR_TRUE;
2949 } else if ( errno ) { /* real error */
2950 Debug( LDAP_DEBUG_TRACE,
2951 "TLS: error: tlsm_PR_Send returned %d - error %d:%s\n",
2952 rc, errno, STRERROR(errno) );
2955 p->io_flag = TLSM_WRITE;
2960 static int PR_CALLBACK
2961 tlsm_PR_Read(PRFileDesc *fd, void *buf, PRInt32 len)
2963 return tlsm_PR_Recv( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2966 static int PR_CALLBACK
2967 tlsm_PR_Write(PRFileDesc *fd, const void *buf, PRInt32 len)
2969 return tlsm_PR_Send( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2972 static PRStatus PR_CALLBACK
2973 tlsm_PR_GetPeerName(PRFileDesc *fd, PRNetAddr *addr)
2978 p = tlsm_get_pvt_tls_data( fd );
2980 if ( p == NULL || p->sbiod == NULL ) {
2983 len = sizeof(PRNetAddr);
2984 return getpeername( p->sbiod->sbiod_sb->sb_fd, (struct sockaddr *)addr, &len );
2987 static PRStatus PR_CALLBACK
2988 tlsm_PR_GetSocketOption(PRFileDesc *fd, PRSocketOptionData *data)
2991 p = tlsm_get_pvt_tls_data( fd );
2993 if ( p == NULL || data == NULL ) {
2997 /* only the nonblocking option is supported at this time
2998 MozNSS SSL code needs it */
2999 if ( data->option != PR_SockOpt_Nonblocking ) {
3000 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3004 int flags = fcntl( p->sbiod->sbiod_sb->sb_fd, F_GETFL );
3005 data->value.non_blocking = (flags & O_NONBLOCK) ? PR_TRUE : PR_FALSE;
3007 data->value.non_blocking = p->nonblock;
3012 static PRStatus PR_CALLBACK
3015 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3019 static PRFileDesc * PR_CALLBACK
3022 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3026 static PRInt16 PR_CALLBACK
3029 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3033 static PRInt32 PR_CALLBACK
3036 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3040 static PRInt64 PR_CALLBACK
3045 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3050 static const PRIOMethods tlsm_PR_methods = {
3052 tlsm_PR_Close, /* close */
3053 tlsm_PR_Read, /* read */
3054 tlsm_PR_Write, /* write */
3055 tlsm_PR_i32_unimp, /* available */
3056 tlsm_PR_i64_unimp, /* available64 */
3057 tlsm_PR_prs_unimp, /* fsync */
3058 tlsm_PR_i32_unimp, /* seek */
3059 tlsm_PR_i64_unimp, /* seek64 */
3060 tlsm_PR_prs_unimp, /* fileInfo */
3061 tlsm_PR_prs_unimp, /* fileInfo64 */
3062 tlsm_PR_i32_unimp, /* writev */
3063 tlsm_PR_prs_unimp, /* connect */
3064 tlsm_PR_pfd_unimp, /* accept */
3065 tlsm_PR_prs_unimp, /* bind */
3066 tlsm_PR_prs_unimp, /* listen */
3067 (PRShutdownFN)tlsm_PR_Shutdown, /* shutdown */
3068 tlsm_PR_Recv, /* recv */
3069 tlsm_PR_Send, /* send */
3070 tlsm_PR_i32_unimp, /* recvfrom */
3071 tlsm_PR_i32_unimp, /* sendto */
3072 (PRPollFN)tlsm_PR_i16_unimp, /* poll */
3073 tlsm_PR_i32_unimp, /* acceptread */
3074 tlsm_PR_i32_unimp, /* transmitfile */
3075 tlsm_PR_prs_unimp, /* getsockname */
3076 tlsm_PR_GetPeerName, /* getpeername */
3077 tlsm_PR_i32_unimp, /* getsockopt OBSOLETE */
3078 tlsm_PR_i32_unimp, /* setsockopt OBSOLETE */
3079 tlsm_PR_GetSocketOption, /* getsocketoption */
3080 tlsm_PR_i32_unimp, /* setsocketoption */
3081 tlsm_PR_i32_unimp, /* Send a (partial) file with header/trailer*/
3082 (PRConnectcontinueFN)tlsm_PR_prs_unimp, /* connectcontinue */
3083 tlsm_PR_i32_unimp, /* reserved for future use */
3084 tlsm_PR_i32_unimp, /* reserved for future use */
3085 tlsm_PR_i32_unimp, /* reserved for future use */
3086 tlsm_PR_i32_unimp /* reserved for future use */
3090 * Initialize TLS subsystem. Should be called only once.
3091 * See tlsm_deferred_init for the bulk of the init process
3096 char *nofork = PR_GetEnv( "NSS_STRICT_NOFORK" );
3100 tlsm_layer_id = PR_GetUniqueIdentity( "OpenLDAP" );
3103 * There are some applications that acquire a crypto context in the parent process
3104 * and expect that crypto context to work after a fork(). This does not work
3105 * with NSS using strict PKCS11 compliance mode. We set this environment
3106 * variable here to tell the software encryption module/token to allow crypto
3107 * contexts to persist across a fork(). However, if you are using some other
3108 * module or encryption device that supports and expects full PKCS11 semantics,
3109 * the only recourse is to rewrite the application with atfork() handlers to save
3110 * the crypto context in the parent and restore (and SECMOD_RestartModules) the
3111 * context in the child.
3114 /* will leak one time */
3115 char *noforkenvvar = PL_strdup( "NSS_STRICT_NOFORK=DISABLED" );
3116 PR_SetEnv( noforkenvvar );
3123 tlsm_sb_setup( Sockbuf_IO_Desc *sbiod, void *arg )
3126 tlsm_session *session = arg;
3129 assert( sbiod != NULL );
3131 p = LBER_MALLOC( sizeof( *p ) );
3136 fd = PR_GetIdentitiesLayer( session, tlsm_layer_id );
3142 fd->secret = (PRFilePrivate *)p;
3143 p->session = session;
3145 p->firsttag = LBER_DEFAULT;
3146 sbiod->sbiod_pvt = p;
3151 tlsm_sb_remove( Sockbuf_IO_Desc *sbiod )
3155 assert( sbiod != NULL );
3156 assert( sbiod->sbiod_pvt != NULL );
3158 p = (struct tls_data *)sbiod->sbiod_pvt;
3159 PR_Close( p->session );
3160 LBER_FREE( sbiod->sbiod_pvt );
3161 sbiod->sbiod_pvt = NULL;
3166 tlsm_sb_close( Sockbuf_IO_Desc *sbiod )
3170 assert( sbiod != NULL );
3171 assert( sbiod->sbiod_pvt != NULL );
3173 p = (struct tls_data *)sbiod->sbiod_pvt;
3174 PR_Shutdown( p->session, PR_SHUTDOWN_BOTH );
3179 tlsm_sb_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
3183 assert( sbiod != NULL );
3184 assert( sbiod->sbiod_pvt != NULL );
3186 p = (struct tls_data *)sbiod->sbiod_pvt;
3188 if ( opt == LBER_SB_OPT_GET_SSL ) {
3189 *((tlsm_session **)arg) = p->session;
3192 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
3193 if ( p && ( SSL_DataPending( p->session ) > 0 ) ) {
3199 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
3203 tlsm_sb_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3209 assert( sbiod != NULL );
3210 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3212 p = (struct tls_data *)sbiod->sbiod_pvt;
3214 ret = PR_Recv( p->session, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3216 err = PR_GetError();
3217 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3218 sbiod->sbiod_sb->sb_trans_needs_read = 1;
3219 sock_errset(EWOULDBLOCK);
3222 sbiod->sbiod_sb->sb_trans_needs_read = 0;
3228 tlsm_sb_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3234 assert( sbiod != NULL );
3235 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3237 p = (struct tls_data *)sbiod->sbiod_pvt;
3239 ret = PR_Send( p->session, (char *)buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3241 err = PR_GetError();
3242 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3243 sbiod->sbiod_sb->sb_trans_needs_write = 1;
3244 sock_errset(EWOULDBLOCK);
3248 sbiod->sbiod_sb->sb_trans_needs_write = 0;
3253 static Sockbuf_IO tlsm_sbio =
3255 tlsm_sb_setup, /* sbi_setup */
3256 tlsm_sb_remove, /* sbi_remove */
3257 tlsm_sb_ctrl, /* sbi_ctrl */
3258 tlsm_sb_read, /* sbi_read */
3259 tlsm_sb_write, /* sbi_write */
3260 tlsm_sb_close /* sbi_close */
3263 tls_impl ldap_int_tls_impl = {
3275 tlsm_session_connect,
3276 tlsm_session_accept,
3277 tlsm_session_upflags,
3278 tlsm_session_errmsg,
3280 tlsm_session_peer_dn,
3281 tlsm_session_chkhost,
3282 tlsm_session_strength,
3286 #ifdef LDAP_R_COMPILE
3295 #endif /* HAVE_MOZNSS */