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-2012 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>
45 #define READ_PASSWORD_FROM_STDIN
46 #define READ_PASSWORD_FROM_FILE
48 #ifdef READ_PASSWORD_FROM_STDIN
49 #include <termios.h> /* for echo on/off */
52 #include <nspr/nspr.h>
53 #include <nspr/private/pprio.h>
56 #include <nss/sslerr.h>
57 #include <nss/sslproto.h>
58 #include <nss/pk11pub.h>
59 #include <nss/secerr.h>
60 #include <nss/keyhi.h>
61 #include <nss/secmod.h>
64 #undef NSS_VERSION_INT
65 #define NSS_VERSION_INT ((NSS_VMAJOR << 24) | (NSS_VMINOR << 16) | \
66 (NSS_VPATCH << 8) | NSS_VBUILD)
68 /* NSS 3.12.5 and later have NSS_InitContext */
69 #if NSS_VERSION_INT >= 0x030c0500
70 #define HAVE_NSS_INITCONTEXT 1
73 /* NSS 3.12.9 and later have SECMOD_RestartModules */
74 #if NSS_VERSION_INT >= 0x030c0900
75 #define HAVE_SECMOD_RESTARTMODULES 1
78 /* InitContext does not currently work in server mode */
79 /* #define INITCONTEXT_HACK 1 */
81 typedef struct tlsm_ctx {
84 int tc_unique; /* unique number associated with this ctx */
85 PRBool tc_verify_cert;
86 CERTCertDBHandle *tc_certdb;
87 PK11SlotInfo *tc_certdb_slot;
88 CERTCertificate *tc_certificate;
89 SECKEYPrivateKey *tc_private_key;
91 struct ldaptls *tc_config;
94 PRCallOnceType tc_callonce;
96 #ifdef HAVE_NSS_INITCONTEXT
97 NSSInitContext *tc_initctx; /* the NSS context */
99 PK11GenericObject **tc_pem_objs; /* array of objects to free */
100 int tc_n_pem_objs; /* number of objects */
101 PRBool tc_warn_only; /* only warn of errors in validation */
102 #ifdef LDAP_R_COMPILE
103 ldap_pvt_thread_mutex_t tc_refmutex;
107 typedef PRFileDesc tlsm_session;
109 static int tlsm_ctx_count;
110 #define TLSM_CERTDB_DESC_FMT "ldap(%d)"
112 static PRDescIdentity tlsm_layer_id;
114 static const PRIOMethods tlsm_PR_methods;
116 #define CERTDB_NONE NULL
117 #define PREFIX_NONE NULL
119 #define PEM_LIBRARY "nsspem"
120 #define PEM_MODULE "PEM"
121 /* hash files for use with cacertdir have this file name suffix */
122 #define PEM_CA_HASH_FILE_SUFFIX ".0"
123 #define PEM_CA_HASH_FILE_SUFFIX_LEN 2
125 static SECMODModule *pem_module;
127 #define DEFAULT_TOKEN_NAME "default"
128 #define TLSM_PEM_SLOT_CACERTS "PEM Token #0"
129 #define TLSM_PEM_SLOT_CERTS "PEM Token #1"
131 #define PK11_SETATTRS(x,id,v,l) (x).type = (id); \
132 (x).pValue=(v); (x).ulValueLen = (l);
134 /* forward declaration */
135 static int tlsm_init( void );
137 #ifdef LDAP_R_COMPILE
139 /* it doesn't seem guaranteed that a client will call
140 tlsm_thr_init in a non-threaded context - so we have
141 to wrap the mutex creation in a prcallonce
143 static ldap_pvt_thread_mutex_t tlsm_ctx_count_mutex;
144 static ldap_pvt_thread_mutex_t tlsm_init_mutex;
145 static ldap_pvt_thread_mutex_t tlsm_pem_mutex;
146 static PRCallOnceType tlsm_init_mutex_callonce = {0,0};
148 static PRStatus PR_CALLBACK
149 tlsm_thr_init_callonce( void )
151 if ( ldap_pvt_thread_mutex_init( &tlsm_ctx_count_mutex ) ) {
152 Debug( LDAP_DEBUG_ANY,
153 "TLS: could not create mutex for context counter: %d\n", errno, 0, 0 );
157 if ( ldap_pvt_thread_mutex_init( &tlsm_init_mutex ) ) {
158 Debug( LDAP_DEBUG_ANY,
159 "TLS: could not create mutex for moznss initialization: %d\n", errno, 0, 0 );
163 if ( ldap_pvt_thread_mutex_init( &tlsm_pem_mutex ) ) {
164 Debug( LDAP_DEBUG_ANY,
165 "TLS: could not create mutex for PEM module: %d\n", errno, 0, 0 );
173 tlsm_thr_init( void )
175 ( void )PR_CallOnce( &tlsm_init_mutex_callonce, tlsm_thr_init_callonce );
178 #endif /* LDAP_R_COMPILE */
181 tlsm_dump_cipher_info(PRFileDesc *fd)
185 for (ii = 0; ii < SSL_NumImplementedCiphers; ++ii) {
186 PRInt32 cipher = (PRInt32)SSL_ImplementedCiphers[ii];
187 PRBool enabled = PR_FALSE;
189 SSLCipherSuiteInfo info;
192 SSL_CipherPrefGet(fd, cipher, &enabled);
194 SSL_CipherPrefGetDefault(cipher, &enabled);
196 SSL_CipherPolicyGet(cipher, &policy);
197 SSL_GetCipherSuiteInfo(cipher, &info, (PRUintn)sizeof(info));
198 Debug( LDAP_DEBUG_TRACE,
199 "TLS: cipher: %d - %s, enabled: %d, ",
200 info.cipherSuite, info.cipherSuiteName, enabled );
201 Debug( LDAP_DEBUG_TRACE,
202 "policy: %d\n", policy, 0, 0 );
208 /* Cipher definitions */
210 char *ossl_name; /* The OpenSSL cipher name */
211 int num; /* The cipher id */
212 int attr; /* cipher attributes: algorithms, etc */
213 int version; /* protocol version valid for this cipher */
214 int bits; /* bits of strength */
215 int alg_bits; /* bits of the algorithm */
216 int strength; /* LOW, MEDIUM, HIGH */
217 int enabled; /* Enabled by default? */
220 /* cipher attributes */
221 #define SSL_kRSA 0x00000001L
222 #define SSL_aRSA 0x00000002L
223 #define SSL_aDSS 0x00000004L
224 #define SSL_DSS SSL_aDSS
225 #define SSL_eNULL 0x00000008L
226 #define SSL_DES 0x00000010L
227 #define SSL_3DES 0x00000020L
228 #define SSL_RC4 0x00000040L
229 #define SSL_RC2 0x00000080L
230 #define SSL_AES 0x00000100L
231 #define SSL_MD5 0x00000200L
232 #define SSL_SHA1 0x00000400L
233 #define SSL_SHA SSL_SHA1
234 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
236 /* cipher strength */
237 #define SSL_NULL 0x00000001L
238 #define SSL_EXPORT40 0x00000002L
239 #define SSL_EXPORT56 0x00000004L
240 #define SSL_LOW 0x00000008L
241 #define SSL_MEDIUM 0x00000010L
242 #define SSL_HIGH 0x00000020L
244 #define SSL2 0x00000001L
245 #define SSL3 0x00000002L
246 /* OpenSSL treats SSL3 and TLSv1 the same */
249 /* Cipher translation */
250 static cipher_properties ciphers_def[] = {
252 {"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},
253 {"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},
254 {"RC4-MD5", SSL_EN_RC4_128_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL2, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
255 {"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},
256 {"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},
257 {"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},
260 {"RC4-MD5", SSL_RSA_WITH_RC4_128_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
261 {"RC4-SHA", SSL_RSA_WITH_RC4_128_SHA, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_SHA1, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
262 {"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},
263 {"DES-CBC-SHA", SSL_RSA_WITH_DES_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_DES|SSL_SHA1, SSL3, 56, 56, SSL_LOW, SSL_ALLOWED},
264 {"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},
265 {"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},
266 {"NULL-MD5", SSL_RSA_WITH_NULL_MD5, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_MD5, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
267 {"NULL-SHA", SSL_RSA_WITH_NULL_SHA, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_SHA1, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
270 {"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},
271 {"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},
272 {"AES128-SHA", TLS_RSA_WITH_AES_128_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 128, 128, SSL_HIGH, SSL_ALLOWED},
273 {"AES256-SHA", TLS_RSA_WITH_AES_256_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 256, 256, SSL_HIGH, SSL_ALLOWED},
276 #define ciphernum (sizeof(ciphers_def)/sizeof(cipher_properties))
278 /* given err which is the current errno, calls PR_SetError with
279 the corresponding NSPR error code */
281 tlsm_map_error(int err)
287 prError = PR_NO_ACCESS_RIGHTS_ERROR;
290 prError = PR_ADDRESS_IN_USE_ERROR;
293 prError = PR_ADDRESS_NOT_AVAILABLE_ERROR;
296 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
299 prError = PR_WOULD_BLOCK_ERROR;
302 * On QNX and Neutrino, EALREADY is defined as EBUSY.
304 #if EALREADY != EBUSY
306 prError = PR_ALREADY_INITIATED_ERROR;
310 prError = PR_BAD_DESCRIPTOR_ERROR;
314 prError = PR_IO_ERROR;
318 prError = PR_FILESYSTEM_MOUNTED_ERROR;
321 prError = PR_CONNECT_ABORTED_ERROR;
324 prError = PR_CONNECT_REFUSED_ERROR;
327 prError = PR_CONNECT_RESET_ERROR;
330 prError = PR_DEADLOCK_ERROR;
334 prError = PR_DIRECTORY_CORRUPTED_ERROR;
339 prError = PR_NO_DEVICE_SPACE_ERROR;
343 prError = PR_FILE_EXISTS_ERROR;
346 prError = PR_ACCESS_FAULT_ERROR;
349 prError = PR_FILE_TOO_BIG_ERROR;
352 prError = PR_HOST_UNREACHABLE_ERROR;
355 prError = PR_IN_PROGRESS_ERROR;
358 prError = PR_PENDING_INTERRUPT_ERROR;
361 prError = PR_INVALID_ARGUMENT_ERROR;
364 prError = PR_IO_ERROR;
367 prError = PR_IS_CONNECTED_ERROR;
370 prError = PR_IS_DIRECTORY_ERROR;
373 prError = PR_LOOP_ERROR;
376 prError = PR_PROC_DESC_TABLE_FULL_ERROR;
379 prError = PR_MAX_DIRECTORY_ENTRIES_ERROR;
382 prError = PR_INVALID_ARGUMENT_ERROR;
386 prError = PR_REMOTE_FILE_ERROR;
390 prError = PR_NAME_TOO_LONG_ERROR;
393 prError = PR_NETWORK_UNREACHABLE_ERROR;
396 prError = PR_SYS_DESC_TABLE_FULL_ERROR;
399 * On SCO OpenServer 5, ENOBUFS is defined as ENOSR.
401 #if defined(ENOBUFS) && (ENOBUFS != ENOSR)
403 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
407 prError = PR_FILE_NOT_FOUND_ERROR;
410 prError = PR_FILE_NOT_FOUND_ERROR;
413 prError = PR_FILE_IS_LOCKED_ERROR;
417 prError = PR_REMOTE_FILE_ERROR;
421 prError = PR_OUT_OF_MEMORY_ERROR;
424 prError = PR_INVALID_ARGUMENT_ERROR;
427 prError = PR_NO_DEVICE_SPACE_ERROR;
431 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
435 prError = PR_NOT_CONNECTED_ERROR;
438 prError = PR_NOT_DIRECTORY_ERROR;
441 prError = PR_NOT_SOCKET_ERROR;
444 prError = PR_FILE_NOT_FOUND_ERROR;
447 prError = PR_NOT_TCP_SOCKET_ERROR;
451 prError = PR_BUFFER_OVERFLOW_ERROR;
455 prError = PR_NO_ACCESS_RIGHTS_ERROR;
458 prError = PR_CONNECT_RESET_ERROR;
462 prError = PR_IO_ERROR;
465 case EPROTONOSUPPORT:
466 prError = PR_PROTOCOL_NOT_SUPPORTED_ERROR;
469 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
472 prError = PR_INVALID_METHOD_ERROR;
475 prError = PR_READ_ONLY_FILESYSTEM_ERROR;
478 prError = PR_INVALID_METHOD_ERROR;
481 prError = PR_IO_TIMEOUT_ERROR;
483 #if EWOULDBLOCK != EAGAIN
485 prError = PR_WOULD_BLOCK_ERROR;
489 prError = PR_NOT_SAME_DEVICE_ERROR;
492 prError = PR_UNKNOWN_ERROR;
495 PR_SetError( prError, err );
499 * cipher_list is an integer array with the following values:
500 * -1: never enable this cipher
505 nss_parse_ciphers(const char *cipherstr, int cipher_list[ciphernum])
514 /* All disabled to start */
515 for (i=0; i<ciphernum; i++)
518 ciphertip = strdup(cipherstr);
519 cipher = ciphers = ciphertip;
521 while (ciphers && (strlen(ciphers))) {
522 while ((*cipher) && (isspace(*cipher)))
527 case '+': /* Add something */
531 case '-': /* Subtract something */
535 case '!': /* Disable something */
544 if ((ciphers = strchr(cipher, ':'))) {
548 /* Do the easy one first */
549 if (!strcmp(cipher, "ALL")) {
550 for (i=0; i<ciphernum; i++) {
551 if (!(ciphers_def[i].attr & SSL_eNULL))
552 cipher_list[i] = action;
554 } else if (!strcmp(cipher, "COMPLEMENTOFALL")) {
555 for (i=0; i<ciphernum; i++) {
556 if ((ciphers_def[i].attr & SSL_eNULL))
557 cipher_list[i] = action;
559 } else if (!strcmp(cipher, "DEFAULT")) {
560 for (i=0; i<ciphernum; i++) {
561 cipher_list[i] = ciphers_def[i].enabled == SSL_ALLOWED ? 1 : 0;
570 while (c && (strlen(c))) {
572 if ((c = strchr(cipher, '+'))) {
576 if (!strcmp(cipher, "RSA")) {
578 } else if ((!strcmp(cipher, "NULL")) || (!strcmp(cipher, "eNULL"))) {
580 } else if (!strcmp(cipher, "AES")) {
582 } else if (!strcmp(cipher, "3DES")) {
584 } else if (!strcmp(cipher, "DES")) {
586 } else if (!strcmp(cipher, "RC4")) {
588 } else if (!strcmp(cipher, "RC2")) {
590 } else if (!strcmp(cipher, "MD5")) {
592 } else if ((!strcmp(cipher, "SHA")) || (!strcmp(cipher, "SHA1"))) {
594 } else if (!strcmp(cipher, "SSLv2")) {
596 } else if (!strcmp(cipher, "SSLv3")) {
598 } else if (!strcmp(cipher, "TLSv1")) {
600 } else if (!strcmp(cipher, "HIGH")) {
601 strength |= SSL_HIGH;
602 } else if (!strcmp(cipher, "MEDIUM")) {
603 strength |= SSL_MEDIUM;
604 } else if (!strcmp(cipher, "LOW")) {
606 } else if ((!strcmp(cipher, "EXPORT")) || (!strcmp(cipher, "EXP"))) {
607 strength |= SSL_EXPORT40|SSL_EXPORT56;
608 } else if (!strcmp(cipher, "EXPORT40")) {
609 strength |= SSL_EXPORT40;
610 } else if (!strcmp(cipher, "EXPORT56")) {
611 strength |= SSL_EXPORT56;
619 /* If we have a mask, apply it. If not then perhaps they provided
620 * a specific cipher to enable.
622 if (mask || strength || protocol) {
623 for (i=0; i<ciphernum; i++) {
624 if (((ciphers_def[i].attr & mask) ||
625 (ciphers_def[i].strength & strength) ||
626 (ciphers_def[i].version & protocol)) &&
627 (cipher_list[i] != -1)) {
628 /* Enable the NULL ciphers only if explicity
630 if (ciphers_def[i].attr & SSL_eNULL) {
631 if (mask & SSL_eNULL)
632 cipher_list[i] = action;
634 cipher_list[i] = action;
638 for (i=0; i<ciphernum; i++) {
639 if (!strcmp(ciphers_def[i].ossl_name, cipher) &&
640 cipher_list[i] != -1)
641 cipher_list[i] = action;
650 /* See if any ciphers were enabled */
652 for (i=0; i<ciphernum; i++) {
653 if (cipher_list[i] == 1)
663 tlsm_parse_ciphers(tlsm_ctx *ctx, const char *str)
665 int cipher_state[ciphernum];
671 rv = nss_parse_ciphers(str, cipher_state);
674 /* First disable everything */
675 for (i = 0; i < SSL_NumImplementedCiphers; i++)
676 SSL_CipherPrefSet(ctx->tc_model, SSL_ImplementedCiphers[i], SSL_NOT_ALLOWED);
678 /* Now enable what was requested */
679 for (i=0; i<ciphernum; i++) {
680 SSLCipherSuiteInfo suite;
683 if (SSL_GetCipherSuiteInfo(ciphers_def[i].num, &suite, sizeof suite)
685 enabled = cipher_state[i] < 0 ? 0 : cipher_state[i];
686 if (enabled == SSL_ALLOWED) {
687 if (PK11_IsFIPS() && !suite.isFIPS)
688 enabled = SSL_NOT_ALLOWED;
690 SSL_CipherPrefSet(ctx->tc_model, ciphers_def[i].num, enabled);
695 return rv == 1 ? 0 : -1;
699 tlsm_bad_cert_handler(void *arg, PRFileDesc *ssl)
701 SECStatus success = SECSuccess;
703 tlsm_ctx *ctx = (tlsm_ctx *)arg;
709 err = PORT_GetError();
712 case SEC_ERROR_UNTRUSTED_ISSUER:
713 case SEC_ERROR_UNKNOWN_ISSUER:
714 case SEC_ERROR_EXPIRED_CERTIFICATE:
715 case SEC_ERROR_EXPIRED_ISSUER_CERTIFICATE:
716 if (ctx->tc_verify_cert) {
717 success = SECFailure;
720 /* we bypass NSS's hostname checks and do our own */
721 case SSL_ERROR_BAD_CERT_DOMAIN:
724 success = SECFailure;
732 tlsm_dump_security_status(PRFileDesc *fd)
734 char * cp; /* bulk cipher name */
735 char * ip; /* cert issuer DN */
736 char * sp; /* cert subject DN */
737 int op; /* High, Low, Off */
738 int kp0; /* total key bits */
739 int kp1; /* secret key bits */
740 SSL3Statistics * ssl3stats = SSL_GetStatistics();
742 SSL_SecurityStatus( fd, &op, &cp, &kp0, &kp1, &ip, &sp );
743 Debug( LDAP_DEBUG_TRACE,
744 "TLS certificate verification: subject: %s, issuer: %s, cipher: %s, ",
745 sp ? sp : "-unknown-", ip ? ip : "-unknown-", cp ? cp : "-unknown-" );
749 Debug( LDAP_DEBUG_TRACE,
750 "security level: %s, secret key bits: %d, total key bits: %d, ",
751 ((op == SSL_SECURITY_STATUS_ON_HIGH) ? "high" :
752 ((op == SSL_SECURITY_STATUS_ON_LOW) ? "low" : "off")),
755 Debug( LDAP_DEBUG_TRACE,
756 "cache hits: %ld, cache misses: %ld, cache not reusable: %ld\n",
757 ssl3stats->hch_sid_cache_hits, ssl3stats->hch_sid_cache_misses,
758 ssl3stats->hch_sid_cache_not_ok );
764 tlsm_handshake_complete_cb( PRFileDesc *fd, void *client_data )
766 tlsm_dump_security_status( fd );
769 #ifdef READ_PASSWORD_FROM_FILE
771 tlsm_get_pin_from_file(const char *token_name, tlsm_ctx *ctx)
774 char *contents = NULL;
777 char *candidate = NULL;
778 PRFileInfo file_info;
779 PRFileDesc *pwd_fileptr = PR_Open( ctx->tc_pin_file, PR_RDONLY, 00400 );
781 /* open the password file */
782 if ( !pwd_fileptr ) {
783 PRErrorCode errcode = PR_GetError();
784 Debug( LDAP_DEBUG_ANY,
785 "TLS: could not open security pin file %s - error %d:%s.\n",
786 ctx->tc_pin_file, errcode,
787 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
791 /* get the file size */
792 if ( PR_SUCCESS != PR_GetFileInfo( ctx->tc_pin_file, &file_info ) ) {
793 PRErrorCode errcode = PR_GetError();
794 Debug( LDAP_DEBUG_ANY,
795 "TLS: could not get file info from pin file %s - error %d:%s.\n",
796 ctx->tc_pin_file, errcode,
797 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
801 /* create a buffer to hold the file contents */
802 if ( !( contents = PR_CALLOC( file_info.size + 1 ) ) ) {
803 PRErrorCode errcode = PR_GetError();
804 Debug( LDAP_DEBUG_ANY,
805 "TLS: could not alloc a buffer for contents of pin file %s - error %d:%s.\n",
806 ctx->tc_pin_file, errcode,
807 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
811 /* read file into the buffer */
812 if( PR_Read( pwd_fileptr, contents, file_info.size ) <= 0 ) {
813 PRErrorCode errcode = PR_GetError();
814 Debug( LDAP_DEBUG_ANY,
815 "TLS: could not read the file contents from pin file %s - error %d:%s.\n",
816 ctx->tc_pin_file, errcode,
817 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
821 /* format is [tokenname:]password EOL [tokenname:]password EOL ... */
822 /* if you want to use a password containing a colon character, use
823 the special tokenname "default" */
824 for ( line = PL_strtok_r( contents, "\r\n", &lasts ); line;
825 line = PL_strtok_r( NULL, "\r\n", &lasts ) ) {
829 continue; /* skip blank lines */
831 colon = PL_strchr( line, ':' );
833 if ( *(colon + 1) && token_name &&
834 !PL_strncmp( token_name, line, colon-line ) ) {
835 candidate = colon + 1; /* found a definite match */
837 } else if ( !PL_strncmp( DEFAULT_TOKEN_NAME, line, colon-line ) ) {
838 candidate = colon + 1; /* found possible match */
840 } else { /* no token name */
846 PR_Close( pwd_fileptr );
849 pwdstr = PL_strdup( candidate );
851 PL_strfree( contents );
855 #endif /* READ_PASSWORD_FROM_FILE */
857 #ifdef READ_PASSWORD_FROM_STDIN
859 * Turn the echoing off on a tty.
864 if ( isatty( fd ) ) {
866 tcgetattr( fd, &tio );
867 tio.c_lflag &= ~ECHO;
868 tcsetattr( fd, TCSAFLUSH, &tio );
873 * Turn the echoing on on a tty.
878 if ( isatty( fd ) ) {
880 tcgetattr( fd, &tio );
882 tcsetattr( fd, TCSAFLUSH, &tio );
883 tcsetattr( fd, TCSAFLUSH, &tio );
886 #endif /* READ_PASSWORD_FROM_STDIN */
889 * This does the actual work of reading the pin/password/pass phrase
892 tlsm_get_pin(PK11SlotInfo *slot, PRBool retry, tlsm_ctx *ctx)
894 char *token_name = NULL;
897 token_name = PK11_GetTokenName( slot );
898 #ifdef READ_PASSWORD_FROM_FILE
899 /* Try to get the passwords from the password file if it exists.
900 * THIS IS UNSAFE and is provided for convenience only. Without this
901 * capability the server would have to be started in foreground mode
902 * if using an encrypted key.
904 if ( ctx && ctx->tc_pin_file ) {
905 pwdstr = tlsm_get_pin_from_file( token_name, ctx );
906 if ( retry && pwdstr != NULL )
909 #endif /* RETRIEVE_PASSWORD_FROM_FILE */
910 #ifdef READ_PASSWORD_FROM_STDIN
912 int infd = PR_FileDesc2NativeHandle( PR_STDIN );
913 int isTTY = isatty( infd );
914 unsigned char phrase[200];
915 /* Prompt for password */
918 "Please enter pin, password, or pass phrase for security token '%s': ",
919 token_name ? token_name : DEFAULT_TOKEN_NAME );
922 fgets( (char*)phrase, sizeof(phrase), stdin );
924 fprintf( stdout, "\n" );
927 /* stomp on newline */
928 phrase[strlen((char*)phrase)-1] = 0;
930 pwdstr = PL_strdup( (char*)phrase );
933 #endif /* READ_PASSWORD_FROM_STDIN */
938 * PKCS11 devices (including the internal softokn cert/key database)
939 * may be protected by a pin or password or even pass phrase
940 * MozNSS needs a way for the user to provide that
943 tlsm_pin_prompt(PK11SlotInfo *slot, PRBool retry, void *arg)
945 tlsm_ctx *ctx = (tlsm_ctx *)arg;
947 return tlsm_get_pin( slot, retry, ctx );
951 tlsm_ctx_subject_name(tlsm_ctx *ctx)
953 if ( !ctx || !ctx->tc_certificate )
956 return ctx->tc_certificate->subjectName;
960 tlsm_get_basic_constraint_extension( CERTCertificate *cert,
961 CERTBasicConstraints *cbcval )
963 SECItem encodedVal = { 0, NULL };
966 rc = CERT_FindCertExtension( cert, SEC_OID_X509_BASIC_CONSTRAINTS,
968 if ( rc != SECSuccess ) {
972 rc = CERT_DecodeBasicConstraintValue( cbcval, &encodedVal );
974 /* free the raw extension data */
975 PORT_Free( encodedVal.data );
981 tlsm_cert_is_self_issued( CERTCertificate *cert )
983 /* A cert is self-issued if its subject and issuer are equal and
984 * both are of non-zero length.
986 PRBool is_self_issued = cert &&
987 (PRBool)SECITEM_ItemsAreEqual( &cert->derIssuer,
988 &cert->derSubject ) &&
989 cert->derSubject.len > 0;
990 return is_self_issued;
994 * The private key for used certificate can be already unlocked by other
995 * thread or library. Find the unlocked key if possible.
997 static SECKEYPrivateKey *
998 tlsm_find_unlocked_key( tlsm_ctx *ctx, void *pin_arg )
1000 SECKEYPrivateKey *result = NULL;
1002 PK11SlotList *slots = PK11_GetAllSlotsForCert( ctx->tc_certificate, NULL );
1004 PRErrorCode errcode = PR_GetError();
1005 Debug( LDAP_DEBUG_ANY,
1006 "TLS: cannot get all slots for certificate '%s' (error %d: %s)",
1007 tlsm_ctx_subject_name( ctx ), errcode,
1008 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1012 PK11SlotListElement *le;
1013 for ( le = slots->head; le; le = le->next ) {
1014 PK11SlotInfo *slot = le->slot;
1015 if ( PK11_IsLoggedIn( slot, NULL ) ) {
1016 result = PK11_FindKeyByDERCert( slot, ctx->tc_certificate, pin_arg );
1021 PK11_FreeSlotList( slots );
1026 tlsm_verify_cert(CERTCertDBHandle *handle, CERTCertificate *cert, void *pinarg,
1027 PRBool checksig, SECCertificateUsage certUsage, PRBool warn_only,
1028 PRBool ignore_issuer )
1030 CERTVerifyLog verifylog;
1031 SECStatus ret = SECSuccess;
1033 int debug_level = LDAP_DEBUG_ANY;
1036 debug_level = LDAP_DEBUG_TRACE;
1039 /* the log captures information about every cert in the chain, so we can tell
1040 which cert caused the problem and what the problem was */
1041 memset( &verifylog, 0, sizeof( verifylog ) );
1042 verifylog.arena = PORT_NewArena( DER_DEFAULT_CHUNKSIZE );
1043 if ( verifylog.arena == NULL ) {
1044 Debug( LDAP_DEBUG_ANY,
1045 "TLS certificate verification: Out of memory for certificate verification logger\n",
1049 ret = CERT_VerifyCertificate( handle, cert, checksig, certUsage, PR_Now(), pinarg, &verifylog,
1051 if ( ( name = cert->subjectName ) == NULL ) {
1052 name = cert->nickname;
1054 if ( verifylog.head == NULL ) {
1055 /* it is possible for CERT_VerifyCertificate return with an error with no logging */
1056 if ( ret != SECSuccess ) {
1057 PRErrorCode errcode = PR_GetError();
1059 "TLS: certificate [%s] is not valid - error %d:%s.\n",
1060 name ? name : "(unknown)",
1061 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1065 CERTVerifyLogNode *node;
1067 ret = SECSuccess; /* reset */
1068 node = verifylog.head;
1070 if ( ( name = node->cert->subjectName ) == NULL ) {
1071 name = node->cert->nickname;
1073 if ( node->error ) {
1074 /* NSS does not like CA certs that have the basic constraints extension
1075 with the CA flag set to FALSE - openssl doesn't check if the cert
1077 if ( ( node->error == SEC_ERROR_CA_CERT_INVALID ) &&
1078 tlsm_cert_is_self_issued( node->cert ) ) {
1080 PRErrorCode orig_error = PR_GetError();
1081 PRInt32 orig_oserror = PR_GetOSError();
1083 CERTBasicConstraints basicConstraint;
1084 SECStatus rv = tlsm_get_basic_constraint_extension( node->cert, &basicConstraint );
1085 if ( ( rv == SECSuccess ) && ( basicConstraint.isCA == PR_FALSE ) ) {
1086 Debug( LDAP_DEBUG_TRACE,
1087 "TLS: certificate [%s] is not correct because it is a CA cert and the "
1088 "BasicConstraint CA flag is set to FALSE - allowing for now, but "
1089 "please fix your certs if possible\n", name, 0, 0 );
1090 } else { /* does not have basicconstraint, or some other error */
1093 "TLS: certificate [%s] is not valid - CA cert is not valid\n",
1097 PR_SetError( orig_error, orig_oserror );
1099 } else if ( warn_only || ( ignore_issuer && (
1100 node->error == SEC_ERROR_UNKNOWN_ISSUER ||
1101 node->error == SEC_ERROR_UNTRUSTED_ISSUER )
1105 "TLS: Warning: ignoring error for certificate [%s] - error %ld:%s.\n",
1106 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1110 "TLS: certificate [%s] is not valid - error %ld:%s.\n",
1111 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1114 CERT_DestroyCertificate( node->cert );
1119 PORT_FreeArena( verifylog.arena, PR_FALSE );
1121 if ( ret == SECSuccess ) {
1122 Debug( LDAP_DEBUG_TRACE,
1123 "TLS: certificate [%s] is valid\n", name, 0, 0 );
1130 tlsm_auth_cert_handler(void *arg, PRFileDesc *fd,
1131 PRBool checksig, PRBool isServer)
1133 SECCertificateUsage certUsage = isServer ? certificateUsageSSLClient : certificateUsageSSLServer;
1134 SECStatus ret = SECSuccess;
1135 CERTCertificate *peercert = SSL_PeerCertificate( fd );
1136 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1138 ret = tlsm_verify_cert( ctx->tc_certdb, peercert,
1139 SSL_RevealPinArg( fd ),
1140 checksig, certUsage, ctx->tc_warn_only, PR_FALSE );
1141 CERT_DestroyCertificate( peercert );
1147 tlsm_nss_shutdown_cb( void *appData, void *nssData )
1149 SECStatus rc = SECSuccess;
1151 SSL_ShutdownServerSessionIDCache();
1154 SECMOD_UnloadUserModule( pem_module );
1155 SECMOD_DestroyModule( pem_module );
1161 static PRCallOnceType tlsm_register_shutdown_callonce = {0,0};
1162 static PRStatus PR_CALLBACK
1163 tlsm_register_nss_shutdown_cb( void )
1165 if ( SECSuccess == NSS_RegisterShutdown( tlsm_nss_shutdown_cb,
1173 tlsm_register_nss_shutdown( void )
1175 return PR_CallOnce( &tlsm_register_shutdown_callonce,
1176 tlsm_register_nss_shutdown_cb );
1180 tlsm_init_pem_module( void )
1183 char *fullname = NULL;
1184 char *configstring = NULL;
1190 /* not loaded - load it */
1191 /* get the system dependent library name */
1192 fullname = PR_GetLibraryName( NULL, PEM_LIBRARY );
1193 /* Load our PKCS#11 module */
1194 configstring = PR_smprintf( "library=%s name=" PEM_MODULE " parameters=\"\"", fullname );
1195 PL_strfree( fullname );
1197 pem_module = SECMOD_LoadUserModule( configstring, NULL, PR_FALSE );
1198 PR_smprintf_free( configstring );
1200 if ( !pem_module || !pem_module->loaded ) {
1202 SECMOD_DestroyModule( pem_module );
1212 tlsm_add_pem_obj( tlsm_ctx *ctx, PK11GenericObject *obj )
1214 int idx = ctx->tc_n_pem_objs;
1215 ctx->tc_n_pem_objs++;
1216 ctx->tc_pem_objs = (PK11GenericObject **)
1217 PORT_Realloc( ctx->tc_pem_objs, ctx->tc_n_pem_objs * sizeof( PK11GenericObject * ) );
1218 ctx->tc_pem_objs[idx] = obj;
1222 tlsm_free_pem_objs( tlsm_ctx *ctx )
1224 /* free in reverse order of allocation */
1225 while ( ctx->tc_n_pem_objs-- ) {
1226 PK11_DestroyGenericObject( ctx->tc_pem_objs[ctx->tc_n_pem_objs] );
1227 ctx->tc_pem_objs[ctx->tc_n_pem_objs] = NULL;
1229 PORT_Free(ctx->tc_pem_objs);
1230 ctx->tc_pem_objs = NULL;
1231 ctx->tc_n_pem_objs = 0;
1235 tlsm_add_cert_from_file( tlsm_ctx *ctx, const char *filename, PRBool isca )
1238 PK11GenericObject *cert;
1239 CK_ATTRIBUTE attrs[4];
1240 CK_BBOOL cktrue = CK_TRUE;
1241 CK_BBOOL ckfalse = CK_FALSE;
1242 CK_OBJECT_CLASS objClass = CKO_CERTIFICATE;
1246 SECItem certDER = { 0, NULL, 0 };
1248 memset( &fi, 0, sizeof(fi) );
1249 status = PR_GetFileInfo( filename, &fi );
1250 if ( PR_SUCCESS != status) {
1251 PRErrorCode errcode = PR_GetError();
1252 Debug( LDAP_DEBUG_ANY,
1253 "TLS: could not read certificate file %s - error %d:%s.\n",
1255 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1259 if ( fi.type != PR_FILE_FILE ) {
1260 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1261 Debug( LDAP_DEBUG_ANY,
1262 "TLS: error: the certificate file %s is not a file.\n",
1267 slotname = isca ? TLSM_PEM_SLOT_CACERTS : TLSM_PEM_SLOT_CERTS;
1268 slot = PK11_FindSlotByName( slotname );
1271 PRErrorCode errcode = PR_GetError();
1272 Debug( LDAP_DEBUG_ANY,
1273 "TLS: could not find the slot for the certificate '%s' - error %d:%s.\n",
1274 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1278 PK11_SETATTRS( attrs[0], CKA_CLASS, &objClass, sizeof( objClass ) );
1279 PK11_SETATTRS( attrs[1], CKA_TOKEN, &cktrue, sizeof( CK_BBOOL ) );
1280 PK11_SETATTRS( attrs[2], CKA_LABEL, (unsigned char *) filename, strlen( filename ) + 1 );
1281 PK11_SETATTRS( attrs[3], CKA_TRUST, isca ? &cktrue : &ckfalse, sizeof( CK_BBOOL ) );
1283 cert = PK11_CreateGenericObject( slot, attrs, 4, PR_FALSE /* isPerm */ );
1286 PRErrorCode errcode = PR_GetError();
1287 Debug( LDAP_DEBUG_ANY,
1288 "TLS: could not add the certificate '%s' - error %d:%s.\n",
1289 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1290 PK11_FreeSlot( slot );
1294 /* if not CA, we store the certificate in ctx->tc_certificate */
1296 if ( PK11_ReadRawAttribute( PK11_TypeGeneric, cert, CKA_VALUE, &certDER ) != SECSuccess ) {
1297 PRErrorCode errcode = PR_GetError();
1298 Debug( LDAP_DEBUG_ANY,
1299 "TLS: could not get DER of the '%s' certificate - error %d:%s.\n",
1300 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1301 PK11_DestroyGenericObject( cert );
1302 PK11_FreeSlot( slot );
1306 ctx->tc_certificate = PK11_FindCertFromDERCertItem( slot, &certDER, NULL );
1307 SECITEM_FreeItem( &certDER, PR_FALSE );
1309 if ( !ctx->tc_certificate ) {
1310 PRErrorCode errcode = PR_GetError();
1311 Debug( LDAP_DEBUG_ANY,
1312 "TLS: could not get certificate '%s' using DER - error %d:%s.\n",
1313 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1314 PK11_DestroyGenericObject( cert );
1315 PK11_FreeSlot( slot );
1320 tlsm_add_pem_obj( ctx, cert );
1322 PK11_FreeSlot( slot );
1328 tlsm_ctx_load_private_key( tlsm_ctx *ctx )
1330 if ( !ctx->tc_certificate )
1333 if ( ctx->tc_private_key )
1336 void *pin_arg = SSL_RevealPinArg( ctx->tc_model );
1338 SECKEYPrivateKey *unlocked_key = tlsm_find_unlocked_key( ctx, pin_arg );
1339 Debug( LDAP_DEBUG_ANY,
1340 "TLS: %s unlocked certificate for certificate '%s'.\n",
1341 unlocked_key ? "found" : "no", tlsm_ctx_subject_name( ctx ), 0 );
1343 /* prefer unlocked key, then key from opened certdb, then any other */
1345 ctx->tc_private_key = unlocked_key;
1346 else if ( ctx->tc_certdb_slot )
1347 ctx->tc_private_key = PK11_FindKeyByDERCert( ctx->tc_certdb_slot, ctx->tc_certificate, pin_arg );
1349 ctx->tc_private_key = PK11_FindKeyByAnyCert( ctx->tc_certificate, pin_arg );
1351 if ( !ctx->tc_private_key ) {
1352 PRErrorCode errcode = PR_GetError();
1353 Debug(LDAP_DEBUG_ANY,
1354 "TLS: cannot find private key for certificate '%s' (error %d: %s)",
1355 tlsm_ctx_subject_name( ctx ), errcode,
1356 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1364 tlsm_add_key_from_file( tlsm_ctx *ctx, const char *filename )
1366 PK11SlotInfo * slot = NULL;
1367 PK11GenericObject *key;
1368 CK_ATTRIBUTE attrs[3];
1369 CK_BBOOL cktrue = CK_TRUE;
1370 CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1375 memset( &fi, 0, sizeof(fi) );
1376 status = PR_GetFileInfo( filename, &fi );
1377 if ( PR_SUCCESS != status) {
1378 PRErrorCode errcode = PR_GetError();
1379 Debug( LDAP_DEBUG_ANY,
1380 "TLS: could not read key file %s - error %d:%s.\n",
1382 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1386 if ( fi.type != PR_FILE_FILE ) {
1387 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1388 Debug( LDAP_DEBUG_ANY,
1389 "TLS: error: the key file %s is not a file.\n",
1394 slot = PK11_FindSlotByName( TLSM_PEM_SLOT_CERTS );
1397 PRErrorCode errcode = PR_GetError();
1398 Debug( LDAP_DEBUG_ANY,
1399 "TLS: could not find the slot for the private key '%s' - error %d:%s.\n",
1400 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1404 PK11_SETATTRS( attrs[0], CKA_CLASS, &objClass, sizeof( objClass ) );
1405 PK11_SETATTRS( attrs[1], CKA_TOKEN, &cktrue, sizeof( CK_BBOOL ) );
1406 PK11_SETATTRS( attrs[2], CKA_LABEL, (unsigned char *)filename, strlen( filename ) + 1 );
1408 key = PK11_CreateGenericObject( slot, attrs, 3, PR_FALSE /* isPerm */ );
1411 PRErrorCode errcode = PR_GetError();
1412 Debug( LDAP_DEBUG_ANY,
1413 "TLS: could not add the private key '%s' - error %d:%s.\n",
1414 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1417 tlsm_add_pem_obj( ctx, key );
1420 /* When adding an encrypted key the PKCS#11 will be set as removed */
1421 /* This will force the token to be seen as re-inserted */
1422 SECMOD_WaitForAnyTokenEvent( pem_module, 0, 0 );
1423 PK11_IsPresent( slot );
1426 PK11_FreeSlot( slot );
1432 tlsm_init_ca_certs( tlsm_ctx *ctx, const char *cacertfile, const char *cacertdir )
1434 PRBool isca = PR_TRUE;
1435 PRStatus status = PR_SUCCESS;
1436 PRErrorCode errcode = PR_SUCCESS;
1438 if ( !cacertfile && !cacertdir ) {
1439 /* no checking - not good, but allowed */
1444 int rc = tlsm_add_cert_from_file( ctx, cacertfile, isca );
1446 errcode = PR_GetError();
1447 Debug( LDAP_DEBUG_ANY,
1448 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1449 cacertfile, errcode,
1450 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1451 /* failure with cacertfile is a hard failure even if cacertdir is
1452 also specified and contains valid CA cert files */
1453 status = PR_FAILURE;
1455 Debug( LDAP_DEBUG_TRACE,
1456 "TLS: loaded CA certificate file %s.\n",
1461 /* if cacertfile above failed, we will return failure, even
1462 if there is a valid CA cert in cacertdir - but we still
1463 process cacertdir in case the user has enabled trace level
1464 debugging so they can see the processing for cacertdir too */
1465 /* any cacertdir failures are "soft" failures - if the user specifies
1466 no cert checking, then we allow the tls/ssl to continue, no matter
1467 what was specified for cacertdir, or the contents of the directory
1468 - this is different behavior than that of cacertfile */
1473 PRStatus fistatus = PR_FAILURE;
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 ) );
1504 entry = PR_ReadDir( dir, PR_SKIP_BOTH | PR_SKIP_HIDDEN );
1505 if ( ( NULL != entry ) && ( NULL != entry->name ) ) {
1506 char *fullpath = NULL;
1509 ptr = PL_strrstr( entry->name, PEM_CA_HASH_FILE_SUFFIX );
1510 if ( ( ptr == NULL ) || ( *(ptr + PEM_CA_HASH_FILE_SUFFIX_LEN) != '\0' ) ) {
1511 Debug( LDAP_DEBUG_TRACE,
1512 "TLS: file %s does not end in [%s] - does not appear to be a CA certificate "
1513 "directory file with a properly hashed file name - skipping.\n",
1514 entry->name, PEM_CA_HASH_FILE_SUFFIX, 0 );
1517 fullpath = PR_smprintf( "%s/%s", cacertdir, entry->name );
1518 if ( !tlsm_add_cert_from_file( ctx, fullpath, isca ) ) {
1519 Debug( LDAP_DEBUG_TRACE,
1520 "TLS: loaded CA certificate file %s from CA certificate directory %s.\n",
1521 fullpath, cacertdir, 0 );
1523 errcode = PR_GetError();
1524 Debug( LDAP_DEBUG_TRACE,
1525 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1527 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1529 PR_smprintf_free( fullpath );
1531 } while ( NULL != entry );
1535 if ( status != PR_SUCCESS ) {
1543 * NSS supports having multiple cert/key databases in the same
1544 * directory, each one having a unique string prefix e.g.
1545 * slapd-01-cert8.db - the prefix here is "slapd-01-"
1546 * this function examines the given certdir - if it looks like
1547 * /path/to/directory/prefix it will return the
1548 * /path/to/directory part in realcertdir, and the prefix in prefix
1551 tlsm_get_certdb_prefix( const char *certdir, char **realcertdir, char **prefix )
1553 char sep = PR_GetDirectorySeparator();
1555 struct PRFileInfo prfi;
1558 *realcertdir = (char *)certdir; /* default is the one passed in */
1560 /* if certdir is not given, just return */
1565 prc = PR_GetFileInfo( certdir, &prfi );
1566 /* if certdir exists (file or directory) then it cannot specify a prefix */
1567 if ( prc == PR_SUCCESS ) {
1571 /* if certdir was given, and there is a '/' in certdir, see if there
1572 is anything after the last '/' - if so, assume it is the prefix */
1573 if ( ( ( ptr = strrchr( certdir, sep ) ) ) && *(ptr+1) ) {
1574 *realcertdir = PL_strndup( certdir, ptr-certdir );
1575 *prefix = PL_strdup( ptr+1 );
1582 * Currently mutiple MozNSS contexts share one certificate storage. When the
1583 * certdb is being opened, only new certificates are added to the storage.
1584 * When different databases are used, conflicting nicknames make the
1585 * certificate lookup by the nickname impossible. In addition a token
1586 * description might be prepended in certain conditions.
1588 * In order to make the certificate lookup by nickname possible, we explicitly
1589 * open each database using SECMOD_OpenUserDB and assign it the token
1590 * description. The token description is generated using ctx->tc_unique value,
1591 * which is unique for each context.
1593 static PK11SlotInfo *
1594 tlsm_init_open_certdb( tlsm_ctx *ctx, const char *dbdir, const char *prefix )
1596 PK11SlotInfo *slot = NULL;
1597 char *token_desc = NULL;
1598 char *config = NULL;
1600 token_desc = PR_smprintf( TLSM_CERTDB_DESC_FMT, ctx->tc_unique );
1601 config = PR_smprintf( "configDir='%s' tokenDescription='%s' certPrefix='%s' keyPrefix='%s' flags=readOnly",
1602 dbdir, token_desc, prefix, prefix );
1603 Debug( LDAP_DEBUG_TRACE, "TLS: certdb config: %s\n", config, 0, 0 );
1605 slot = SECMOD_OpenUserDB( config );
1607 PRErrorCode errcode = PR_GetError();
1608 Debug( LDAP_DEBUG_TRACE, "TLS: cannot open certdb '%s', error %d:%s\n", dbdir, errcode,
1609 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1613 PR_smprintf_free( token_desc );
1615 PR_smprintf_free( config );
1621 * This is the part of the init we defer until we get the
1622 * actual security configuration information. This is
1623 * only called once, protected by a PRCallOnce
1624 * NOTE: This must be done before the first call to SSL_ImportFD,
1625 * especially the setting of the policy
1626 * NOTE: This must be called after fork()
1629 tlsm_deferred_init( void *arg )
1631 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1632 struct ldaptls *lt = ctx->tc_config;
1633 const char *securitydirs[3];
1636 PRErrorCode errcode = 1;
1637 #ifdef HAVE_NSS_INITCONTEXT
1638 NSSInitParameters initParams;
1639 NSSInitContext *initctx = NULL;
1640 PK11SlotInfo *certdb_slot = NULL;
1645 #ifdef HAVE_SECMOD_RESTARTMODULES
1646 /* NSS enforces the pkcs11 requirement that modules should be unloaded after
1647 a fork() - since there is no portable way to determine if NSS has been
1648 already initialized in a parent process, we just call SECMOD_RestartModules
1649 with force == FALSE - if the module has been unloaded due to a fork, it will
1650 be reloaded, otherwise, it is a no-op */
1651 if ( SECFailure == ( rc = SECMOD_RestartModules(PR_FALSE /* do not force */) ) ) {
1652 errcode = PORT_GetError();
1653 if ( errcode != SEC_ERROR_NOT_INITIALIZED ) {
1654 Debug( LDAP_DEBUG_TRACE,
1655 "TLS: could not restart the security modules: %d:%s\n",
1656 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1663 #ifdef HAVE_NSS_INITCONTEXT
1664 memset( &initParams, 0, sizeof( initParams ) );
1665 initParams.length = sizeof( initParams );
1666 #endif /* HAVE_NSS_INITCONTEXT */
1668 #ifdef LDAP_R_COMPILE
1669 if ( PR_CallOnce( &tlsm_init_mutex_callonce, tlsm_thr_init_callonce ) ) {
1672 #endif /* LDAP_R_COMPILE */
1674 #ifndef HAVE_NSS_INITCONTEXT
1675 if ( !NSS_IsInitialized() ) {
1676 #endif /* HAVE_NSS_INITCONTEXT */
1678 MOZNSS_DIR will override everything else - you can
1679 always set MOZNSS_DIR to force the use of this
1681 If using MOZNSS, specify the location of the moznss db dir
1682 in the cacertdir directive of the OpenLDAP configuration.
1683 DEFAULT_MOZNSS_DIR will only be used if the code cannot
1684 find a security dir to use based on the current
1688 securitydirs[nn++] = PR_GetEnv( "MOZNSS_DIR" );
1689 securitydirs[nn++] = lt->lt_cacertdir;
1690 securitydirs[nn++] = PR_GetEnv( "DEFAULT_MOZNSS_DIR" );
1691 for ( ii = 0; !done && ( ii < nn ); ++ii ) {
1692 char *realcertdir = NULL;
1693 const char *defprefix = "";
1694 char *prefix = (char *)defprefix;
1695 const char *securitydir = securitydirs[ii];
1696 if ( NULL == securitydir ) {
1700 tlsm_get_certdb_prefix( securitydir, &realcertdir, &prefix );
1702 /* initialize only moddb; certdb will be initialized explicitly */
1703 #ifdef HAVE_NSS_INITCONTEXT
1704 #ifdef INITCONTEXT_HACK
1705 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1706 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1708 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1709 &initParams, NSS_INIT_READONLY|NSS_INIT_NOCERTDB );
1712 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1713 &initParams, NSS_INIT_READONLY|NSS_INIT_NOCERTDB );
1717 if ( initctx != NULL ) {
1718 certdb_slot = tlsm_init_open_certdb( ctx, realcertdir, prefix );
1719 if ( certdb_slot ) {
1721 ctx->tc_initctx = initctx;
1722 ctx->tc_certdb_slot = certdb_slot;
1724 NSS_ShutdownContext( initctx );
1729 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1732 if ( rc != SECSuccess ) {
1733 errcode = PORT_GetError();
1734 if ( securitydirs[ii] != lt->lt_cacertdir) {
1735 Debug( LDAP_DEBUG_TRACE,
1736 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1737 realcertdir, prefix, errcode );
1741 Debug( LDAP_DEBUG_TRACE, "TLS: using moznss security dir %s prefix %s.\n",
1742 realcertdir, prefix, 0 );
1746 if ( realcertdir != securitydir ) {
1747 PL_strfree( realcertdir );
1749 if ( prefix != defprefix ) {
1750 PL_strfree( prefix );
1754 if ( errcode ) { /* no moznss db found, or not using moznss db */
1755 #ifdef HAVE_NSS_INITCONTEXT
1756 int flags = NSS_INIT_READONLY|NSS_INIT_NOCERTDB|NSS_INIT_NOMODDB;
1757 #ifdef INITCONTEXT_HACK
1758 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1759 rc = NSS_NoDB_Init( NULL );
1761 initctx = NSS_InitContext( CERTDB_NONE, PREFIX_NONE, PREFIX_NONE, SECMOD_DB,
1762 &initParams, flags );
1763 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1766 initctx = NSS_InitContext( CERTDB_NONE, PREFIX_NONE, PREFIX_NONE, SECMOD_DB,
1767 &initParams, flags );
1769 ctx->tc_initctx = initctx;
1776 rc = NSS_NoDB_Init( NULL );
1778 if ( rc != SECSuccess ) {
1779 errcode = PORT_GetError();
1780 Debug( LDAP_DEBUG_ANY,
1781 "TLS: could not initialize moznss - error %d:%s.\n",
1782 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1787 if ( errcode || lt->lt_cacertfile ) {
1788 /* initialize the PEM module */
1789 if ( tlsm_init_pem_module() ) {
1790 int pem_errcode = PORT_GetError();
1791 Debug( LDAP_DEBUG_ANY,
1792 "TLS: could not initialize moznss PEM module - error %d:%s.\n",
1793 pem_errcode, PR_ErrorToString( pem_errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1795 if ( errcode ) /* PEM is required */
1798 } else if ( !errcode ) {
1799 tlsm_init_ca_certs( ctx, lt->lt_cacertfile, NULL );
1804 if ( tlsm_init_ca_certs( ctx, lt->lt_cacertfile, lt->lt_cacertdir ) ) {
1805 /* if we tried to use lt->lt_cacertdir as an NSS key/cert db, errcode
1806 will be a value other than 1 - print an error message so that the
1807 user will know that failed too */
1808 if ( ( errcode != 1 ) && ( lt->lt_cacertdir ) ) {
1809 char *realcertdir = NULL;
1810 char *prefix = NULL;
1811 tlsm_get_certdb_prefix( lt->lt_cacertdir, &realcertdir, &prefix );
1812 Debug( LDAP_DEBUG_TRACE,
1813 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1814 realcertdir, prefix ? prefix : "", errcode );
1815 if ( realcertdir != lt->lt_cacertdir ) {
1816 PL_strfree( realcertdir );
1818 PL_strfree( prefix );
1823 ctx->tc_using_pem = PR_TRUE;
1826 NSS_SetDomesticPolicy();
1828 PK11_SetPasswordFunc( tlsm_pin_prompt );
1830 /* register cleanup function */
1831 if ( tlsm_register_nss_shutdown() ) {
1832 errcode = PORT_GetError();
1833 Debug( LDAP_DEBUG_ANY,
1834 "TLS: could not register NSS shutdown function: %d:%s\n",
1835 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1839 if ( ctx->tc_is_server ) {
1840 /* 0 means use the defaults here */
1841 SSL_ConfigServerSessionIDCache( 0, 0, 0, NULL );
1844 #ifndef HAVE_NSS_INITCONTEXT
1846 #endif /* HAVE_NSS_INITCONTEXT */
1852 * Find and verify the certificate.
1853 * The key is loaded and stored in ctx->tc_private_key
1856 tlsm_find_and_verify_cert_key( tlsm_ctx *ctx )
1858 SECCertificateUsage certUsage;
1863 if ( tlsm_ctx_load_private_key( ctx ) )
1866 pin_arg = SSL_RevealPinArg( ctx->tc_model );
1867 certUsage = ctx->tc_is_server ? certificateUsageSSLServer : certificateUsageSSLClient;
1868 checkSig = ctx->tc_verify_cert ? PR_TRUE : PR_FALSE;
1870 status = tlsm_verify_cert( ctx->tc_certdb, ctx->tc_certificate, pin_arg,
1871 checkSig, certUsage, ctx->tc_warn_only, PR_TRUE );
1873 return status == SECSuccess ? 0 : -1;
1877 tlsm_get_client_auth_data( void *arg, PRFileDesc *fd,
1878 CERTDistNames *caNames, CERTCertificate **pRetCert,
1879 SECKEYPrivateKey **pRetKey )
1881 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1884 *pRetCert = CERT_DupCertificate( ctx->tc_certificate );
1887 *pRetKey = SECKEY_CopyPrivateKey( ctx->tc_private_key );
1893 * ctx must have a tc_model that is valid
1896 tlsm_clientauth_init( tlsm_ctx *ctx )
1898 SECStatus status = SECFailure;
1902 saveval = ctx->tc_warn_only;
1903 ctx->tc_warn_only = PR_TRUE;
1904 rc = tlsm_find_and_verify_cert_key(ctx);
1905 ctx->tc_warn_only = saveval;
1907 Debug( LDAP_DEBUG_ANY,
1908 "TLS: error: unable to set up client certificate authentication for "
1909 "certificate named %s\n", tlsm_ctx_subject_name(ctx), 0, 0 );
1913 status = SSL_GetClientAuthDataHook( ctx->tc_model,
1914 tlsm_get_client_auth_data,
1917 return ( status == SECSuccess ? 0 : -1 );
1921 * Tear down the TLS subsystem. Should only be called once.
1924 tlsm_destroy( void )
1926 #ifdef LDAP_R_COMPILE
1927 ldap_pvt_thread_mutex_destroy( &tlsm_ctx_count_mutex );
1928 ldap_pvt_thread_mutex_destroy( &tlsm_init_mutex );
1929 ldap_pvt_thread_mutex_destroy( &tlsm_pem_mutex );
1933 static struct ldaptls *
1934 tlsm_copy_config ( const struct ldaptls *config )
1936 struct ldaptls *copy;
1940 copy = LDAP_MALLOC( sizeof( *copy ) );
1944 memset( copy, 0, sizeof( *copy ) );
1946 if ( config->lt_certfile )
1947 copy->lt_certfile = LDAP_STRDUP( config->lt_certfile );
1948 if ( config->lt_keyfile )
1949 copy->lt_keyfile = LDAP_STRDUP( config->lt_keyfile );
1950 if ( config->lt_dhfile )
1951 copy->lt_dhfile = LDAP_STRDUP( config->lt_dhfile );
1952 if ( config->lt_cacertfile )
1953 copy->lt_cacertfile = LDAP_STRDUP( config->lt_cacertfile );
1954 if ( config->lt_cacertdir )
1955 copy->lt_cacertdir = LDAP_STRDUP( config->lt_cacertdir );
1956 if ( config->lt_ciphersuite )
1957 copy->lt_ciphersuite = LDAP_STRDUP( config->lt_ciphersuite );
1958 if ( config->lt_crlfile )
1959 copy->lt_crlfile = LDAP_STRDUP( config->lt_crlfile );
1960 if ( config->lt_randfile )
1961 copy->lt_randfile = LDAP_STRDUP( config->lt_randfile );
1963 copy->lt_protocol_min = config->lt_protocol_min;
1969 tlsm_free_config ( struct ldaptls *config )
1973 if ( config->lt_certfile )
1974 LDAP_FREE( config->lt_certfile );
1975 if ( config->lt_keyfile )
1976 LDAP_FREE( config->lt_keyfile );
1977 if ( config->lt_dhfile )
1978 LDAP_FREE( config->lt_dhfile );
1979 if ( config->lt_cacertfile )
1980 LDAP_FREE( config->lt_cacertfile );
1981 if ( config->lt_cacertdir )
1982 LDAP_FREE( config->lt_cacertdir );
1983 if ( config->lt_ciphersuite )
1984 LDAP_FREE( config->lt_ciphersuite );
1985 if ( config->lt_crlfile )
1986 LDAP_FREE( config->lt_crlfile );
1987 if ( config->lt_randfile )
1988 LDAP_FREE( config->lt_randfile );
1990 LDAP_FREE( config );
1994 tlsm_ctx_new ( struct ldapoptions *lo )
1998 ctx = LDAP_MALLOC( sizeof (*ctx) );
2001 #ifdef LDAP_R_COMPILE
2002 ldap_pvt_thread_mutex_init( &ctx->tc_refmutex );
2004 LDAP_MUTEX_LOCK( &tlsm_ctx_count_mutex );
2005 ctx->tc_unique = tlsm_ctx_count++;
2006 LDAP_MUTEX_UNLOCK( &tlsm_ctx_count_mutex );
2007 ctx->tc_config = NULL; /* populated later by tlsm_ctx_init */
2008 ctx->tc_certdb = NULL;
2009 ctx->tc_certdb_slot = NULL;
2010 ctx->tc_certificate = NULL;
2011 ctx->tc_private_key = NULL;
2012 ctx->tc_pin_file = NULL;
2013 ctx->tc_model = NULL;
2014 memset(&ctx->tc_callonce, 0, sizeof(ctx->tc_callonce));
2015 ctx->tc_require_cert = lo->ldo_tls_require_cert;
2016 ctx->tc_verify_cert = PR_FALSE;
2017 ctx->tc_using_pem = PR_FALSE;
2018 #ifdef HAVE_NSS_INITCONTEXT
2019 ctx->tc_initctx = NULL;
2020 #endif /* HAVE_NSS_INITCONTEXT */
2021 ctx->tc_pem_objs = NULL;
2022 ctx->tc_n_pem_objs = 0;
2023 ctx->tc_warn_only = PR_FALSE;
2025 return (tls_ctx *)ctx;
2029 tlsm_ctx_ref( tls_ctx *ctx )
2031 tlsm_ctx *c = (tlsm_ctx *)ctx;
2032 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2034 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2038 tlsm_ctx_free ( tls_ctx *ctx )
2040 tlsm_ctx *c = (tlsm_ctx *)ctx;
2045 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2046 refcount = --c->tc_refcnt;
2047 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2051 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
2053 PR_Close( c->tc_model );
2054 if ( c->tc_certificate )
2055 CERT_DestroyCertificate( c->tc_certificate );
2056 if ( c->tc_private_key )
2057 SECKEY_DestroyPrivateKey( c->tc_private_key );
2058 c->tc_certdb = NULL; /* if not the default, may have to clean up */
2059 if ( c->tc_certdb_slot ) {
2060 if ( SECMOD_CloseUserDB( c->tc_certdb_slot ) ) {
2061 PRErrorCode errcode = PR_GetError();
2062 Debug( LDAP_DEBUG_ANY,
2063 "TLS: could not close certdb slot - error %d:%s.\n",
2064 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
2067 PL_strfree( c->tc_pin_file );
2068 c->tc_pin_file = NULL;
2069 tlsm_free_pem_objs( c );
2070 #ifdef HAVE_NSS_INITCONTEXT
2071 if ( c->tc_initctx ) {
2072 if ( NSS_ShutdownContext( c->tc_initctx ) ) {
2073 PRErrorCode errcode = PR_GetError();
2074 Debug( LDAP_DEBUG_ANY,
2075 "TLS: could not shutdown NSS - error %d:%s.\n",
2076 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
2079 c->tc_initctx = NULL;
2080 #endif /* HAVE_NSS_INITCONTEXT */
2081 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
2082 #ifdef LDAP_R_COMPILE
2083 ldap_pvt_thread_mutex_destroy( &c->tc_refmutex );
2087 tlsm_free_config( c->tc_config );
2093 * initialize a new TLS context
2096 tlsm_ctx_init( struct ldapoptions *lo, struct ldaptls *lt, int is_server )
2098 tlsm_ctx *ctx = (tlsm_ctx *)lo->ldo_tls_ctx;
2099 ctx->tc_config = tlsm_copy_config( lt );
2100 ctx->tc_is_server = is_server;
2105 /* returns true if the given string looks like
2106 "tokenname" ":" "certnickname"
2107 This is true if there is a ':' colon character
2108 in the string and the colon is not the first
2109 or the last character in the string
2112 tlsm_is_tokenname_certnick( const char *certfile )
2115 const char *ptr = PL_strchr( certfile, ':' );
2116 return ptr && (ptr != certfile) && (*(ptr+1));
2122 tlsm_deferred_ctx_init( void *arg )
2124 tlsm_ctx *ctx = (tlsm_ctx *)arg;
2125 PRBool sslv2 = PR_FALSE;
2126 PRBool sslv3 = PR_TRUE;
2127 PRBool tlsv1 = PR_TRUE;
2128 PRBool request_cert = PR_FALSE;
2129 PRInt32 require_cert = PR_FALSE;
2133 if ( tlsm_deferred_init( ctx ) ) {
2134 Debug( LDAP_DEBUG_ANY,
2135 "TLS: could not perform TLS system initialization.\n",
2140 ctx->tc_certdb = CERT_GetDefaultCertDB(); /* If there is ever a per-context db, change this */
2142 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2144 ctx->tc_model = SSL_ImportFD( NULL, fd );
2147 if ( !ctx->tc_model ) {
2148 PRErrorCode err = PR_GetError();
2149 Debug( LDAP_DEBUG_ANY,
2150 "TLS: could perform TLS socket I/O layer initialization - error %d:%s.\n",
2151 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2159 if ( SSL_SetPKCS11PinArg(ctx->tc_model, ctx) ) {
2160 Debug( LDAP_DEBUG_ANY,
2161 "TLS: could not set pin prompt argument\n", 0, 0, 0);
2165 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_SECURITY, PR_TRUE ) ) {
2166 Debug( LDAP_DEBUG_ANY,
2167 "TLS: could not set secure mode on.\n",
2172 lt = ctx->tc_config;
2174 /* default is sslv3 and tlsv1 */
2175 if ( lt->lt_protocol_min ) {
2176 if ( lt->lt_protocol_min > LDAP_OPT_X_TLS_PROTOCOL_SSL3 ) {
2178 } else if ( lt->lt_protocol_min <= LDAP_OPT_X_TLS_PROTOCOL_SSL2 ) {
2180 Debug( LDAP_DEBUG_ANY,
2181 "TLS: warning: minimum TLS protocol level set to "
2182 "include SSLv2 - SSLv2 is insecure - do not use\n", 0, 0, 0 );
2185 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL2, sslv2 ) ) {
2186 Debug( LDAP_DEBUG_ANY,
2187 "TLS: could not set SSLv2 mode on.\n",
2191 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL3, sslv3 ) ) {
2192 Debug( LDAP_DEBUG_ANY,
2193 "TLS: could not set SSLv3 mode on.\n",
2197 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_TLS, tlsv1 ) ) {
2198 Debug( LDAP_DEBUG_ANY,
2199 "TLS: could not set TLSv1 mode on.\n",
2204 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_CLIENT, !ctx->tc_is_server ) ) {
2205 Debug( LDAP_DEBUG_ANY,
2206 "TLS: could not set handshake as client.\n",
2210 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_SERVER, ctx->tc_is_server ) ) {
2211 Debug( LDAP_DEBUG_ANY,
2212 "TLS: could not set handshake as server.\n",
2217 if ( lt->lt_ciphersuite ) {
2218 if ( tlsm_parse_ciphers( ctx, lt->lt_ciphersuite ) ) {
2219 Debug( LDAP_DEBUG_ANY,
2220 "TLS: could not set cipher list %s.\n",
2221 lt->lt_ciphersuite, 0, 0 );
2224 } else if ( tlsm_parse_ciphers( ctx, "DEFAULT" ) ) {
2225 Debug( LDAP_DEBUG_ANY,
2226 "TLS: could not set cipher list DEFAULT.\n",
2231 if ( !ctx->tc_require_cert ) {
2232 ctx->tc_verify_cert = PR_FALSE;
2233 } else if ( !ctx->tc_is_server ) {
2234 request_cert = PR_TRUE;
2235 require_cert = SSL_REQUIRE_NO_ERROR;
2236 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
2237 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
2238 require_cert = SSL_REQUIRE_ALWAYS;
2240 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW )
2241 ctx->tc_verify_cert = PR_TRUE;
2242 } else { /* server */
2243 /* server does not request certs by default */
2244 /* if allow - client may send cert, server will ignore if errors */
2245 /* if try - client may send cert, server will error if bad cert */
2246 /* if hard or demand - client must send cert, server will error if bad cert */
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;
2256 ctx->tc_warn_only = PR_TRUE;
2260 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUEST_CERTIFICATE, request_cert ) ) {
2261 Debug( LDAP_DEBUG_ANY,
2262 "TLS: could not set request certificate mode.\n",
2267 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUIRE_CERTIFICATE, require_cert ) ) {
2268 Debug( LDAP_DEBUG_ANY,
2269 "TLS: could not set require certificate mode.\n",
2274 /* set up our cert and key, if any */
2275 if ( lt->lt_certfile ) {
2276 /* if using the PEM module, load the PEM file specified by lt_certfile */
2277 /* otherwise, assume this is the name of a cert already in the db */
2278 if ( ctx->tc_using_pem ) {
2279 /* this sets ctx->tc_certificate to the correct value */
2280 int rc = tlsm_add_cert_from_file( ctx, lt->lt_certfile, PR_FALSE );
2287 if ( tlsm_is_tokenname_certnick( lt->lt_certfile )) {
2288 /* assume already in form tokenname:certnickname */
2289 tmp_certname = PL_strdup( lt->lt_certfile );
2290 } else if ( ctx->tc_certdb_slot ) {
2291 tmp_certname = PR_smprintf( TLSM_CERTDB_DESC_FMT ":%s", ctx->tc_unique, lt->lt_certfile );
2293 tmp_certname = PR_smprintf( "%s", lt->lt_certfile );
2296 ctx->tc_certificate = PK11_FindCertFromNickname( tmp_certname, SSL_RevealPinArg( ctx->tc_model ) );
2297 PR_smprintf_free( tmp_certname );
2299 if ( !ctx->tc_certificate ) {
2300 PRErrorCode errcode = PR_GetError();
2301 Debug( LDAP_DEBUG_ANY,
2302 "TLS: error: the certificate '%s' could not be found in the database - error %d:%s.\n",
2303 lt->lt_certfile, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
2309 if ( lt->lt_keyfile ) {
2310 /* if using the PEM module, load the PEM file specified by lt_keyfile */
2311 /* otherwise, assume this is the pininfo for the key */
2312 if ( ctx->tc_using_pem ) {
2313 int rc = tlsm_add_key_from_file( ctx, lt->lt_keyfile );
2318 PL_strfree( ctx->tc_pin_file );
2319 ctx->tc_pin_file = PL_strdup( lt->lt_keyfile );
2323 /* Set up callbacks for use by clients */
2324 if ( !ctx->tc_is_server ) {
2325 if ( SSL_OptionSet( ctx->tc_model, SSL_NO_CACHE, PR_TRUE ) != SECSuccess ) {
2326 PRErrorCode err = PR_GetError();
2327 Debug( LDAP_DEBUG_ANY,
2328 "TLS: error: could not set nocache option for moznss - error %d:%s\n",
2329 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2333 if ( SSL_BadCertHook( ctx->tc_model, tlsm_bad_cert_handler, ctx ) != SECSuccess ) {
2334 PRErrorCode err = PR_GetError();
2335 Debug( LDAP_DEBUG_ANY,
2336 "TLS: error: could not set bad cert handler for moznss - error %d:%s\n",
2337 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2342 since a cert has been specified, assume the client wants to do cert auth
2344 if ( ctx->tc_certificate ) {
2345 if ( tlsm_clientauth_init( ctx ) ) {
2346 Debug( LDAP_DEBUG_ANY,
2347 "TLS: error: unable to set up client certificate authentication using '%s'\n",
2348 tlsm_ctx_subject_name(ctx), 0, 0 );
2352 } else { /* set up secure server */
2356 /* must have a certificate for the server to use */
2357 if ( !ctx->tc_certificate ) {
2358 Debug( LDAP_DEBUG_ANY,
2359 "TLS: error: no server certificate: must specify a certificate for the server to use\n",
2364 if ( tlsm_find_and_verify_cert_key( ctx ) ) {
2365 Debug( LDAP_DEBUG_ANY,
2366 "TLS: error: unable to find and verify server's cert and key for certificate %s\n",
2367 tlsm_ctx_subject_name(ctx), 0, 0 );
2371 /* configure the socket to be a secure server socket */
2372 certKEA = NSS_FindCertKEAType( ctx->tc_certificate );
2373 status = SSL_ConfigSecureServer( ctx->tc_model, ctx->tc_certificate, ctx->tc_private_key, certKEA );
2375 if ( SECSuccess != status ) {
2376 PRErrorCode err = PR_GetError();
2377 Debug( LDAP_DEBUG_ANY,
2378 "TLS: error: unable to configure secure server using certificate '%s' - error %d:%s\n",
2379 tlsm_ctx_subject_name(ctx), err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) );
2384 /* Callback for authenticating certificate */
2385 if ( SSL_AuthCertificateHook( ctx->tc_model, tlsm_auth_cert_handler,
2386 ctx ) != SECSuccess ) {
2387 PRErrorCode err = PR_GetError();
2388 Debug( LDAP_DEBUG_ANY,
2389 "TLS: error: could not set auth cert handler for moznss - error %d:%s\n",
2390 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2394 if ( SSL_HandshakeCallback( ctx->tc_model, tlsm_handshake_complete_cb, ctx ) ) {
2395 PRErrorCode err = PR_GetError();
2396 Debug( LDAP_DEBUG_ANY,
2397 "TLS: error: could not set handshake callback for moznss - error %d:%s\n",
2398 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2402 tlsm_free_config( ctx->tc_config );
2403 ctx->tc_config = NULL;
2409 tlsm_session *session;
2410 Sockbuf_IO_Desc *sbiod;
2411 /* there seems to be no portable way to determine if the
2412 sockbuf sd has been set to nonblocking mode - the
2413 call to ber_pvt_socket_set_nonblock() takes place
2414 before the tls socket is set up, so we cannot
2415 intercept that call either.
2416 On systems where fcntl is available, we can just
2417 F_GETFL and test for O_NONBLOCK. On other systems,
2418 we will just see if the IO op returns EAGAIN or EWOULDBLOCK,
2419 and just set this flag */
2422 * NSS tries hard to be backwards compatible with SSLv2 clients, or
2423 * clients that send an SSLv2 client hello. This message is not
2424 * tagged in any way, so NSS has no way to know if the incoming
2425 * message is a valid SSLv2 client hello or just some bogus data
2426 * (or cleartext LDAP). We store the first byte read from the
2427 * client here. The most common case will be a client sending
2428 * LDAP data instead of SSL encrypted LDAP data. This can happen,
2429 * for example, if using ldapsearch -Z - if the starttls fails,
2430 * the client will fallback to plain cleartext LDAP. So if we
2431 * see that the firstbyte is a valid LDAP tag, we can be
2432 * pretty sure this is happening.
2436 * NSS doesn't return SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE, etc.
2437 * when it is blocked, so we have to set a flag in the wrapped send
2438 * and recv calls that tells us what operation NSS was last blocked
2442 #define TLSM_WRITE 2
2446 static struct tls_data *
2447 tlsm_get_pvt_tls_data( PRFileDesc *fd )
2456 myfd = PR_GetIdentitiesLayer( fd, tlsm_layer_id );
2462 p = (struct tls_data *)myfd->secret;
2468 tlsm_is_non_ssl_message( PRFileDesc *fd, ber_tag_t *thebyte )
2473 *thebyte = LBER_DEFAULT;
2476 p = tlsm_get_pvt_tls_data( fd );
2477 if ( p == NULL || p->sbiod == NULL ) {
2481 if ( p->firsttag == LBER_SEQUENCE ) {
2483 *thebyte = p->firsttag;
2491 static tls_session *
2492 tlsm_session_new ( tls_ctx * ctx, int is_server )
2494 tlsm_ctx *c = (tlsm_ctx *)ctx;
2495 tlsm_session *session;
2500 c->tc_is_server = is_server;
2501 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
2502 status = PR_CallOnceWithArg( &c->tc_callonce, tlsm_deferred_ctx_init, c );
2503 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
2504 if ( PR_SUCCESS != status ) {
2505 PRErrorCode err = PR_GetError();
2506 Debug( LDAP_DEBUG_ANY,
2507 "TLS: error: could not initialize moznss security context - error %d:%s\n",
2508 err, PR_ErrorToString(err, PR_LANGUAGE_I_DEFAULT), NULL );
2512 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2517 session = SSL_ImportFD( c->tc_model, fd );
2523 rc = SSL_ResetHandshake( session, is_server );
2525 PRErrorCode err = PR_GetError();
2526 Debug( LDAP_DEBUG_TRACE,
2527 "TLS: error: new session - reset handshake failure %d - error %d:%s\n",
2529 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2531 PR_Close( session );
2535 return (tls_session *)session;
2539 tlsm_session_accept_or_connect( tls_session *session, int is_accept )
2541 tlsm_session *s = (tlsm_session *)session;
2543 const char *op = is_accept ? "accept" : "connect";
2546 LDAP_MUTEX_LOCK( &tlsm_pem_mutex );
2548 rc = SSL_ForceHandshake( s );
2550 LDAP_MUTEX_UNLOCK( &tlsm_pem_mutex );
2553 PRErrorCode err = PR_GetError();
2555 if ( err == PR_WOULD_BLOCK_ERROR ) {
2556 ber_tag_t thetag = LBER_DEFAULT;
2557 /* see if we are blocked because of a bogus packet */
2558 if ( tlsm_is_non_ssl_message( s, &thetag ) ) { /* see if we received a non-SSL message */
2559 Debug( LDAP_DEBUG_ANY,
2560 "TLS: error: %s - error - received non-SSL message [0x%x]\n",
2561 op, (unsigned int)thetag, 0 );
2562 /* reset error to something more descriptive */
2563 PR_SetError( SSL_ERROR_RX_MALFORMED_HELLO_REQUEST, EPROTO );
2566 Debug( LDAP_DEBUG_ANY,
2567 "TLS: error: %s - force handshake failure: errno %d - moznss error %d\n",
2575 tlsm_session_accept( tls_session *session )
2577 return tlsm_session_accept_or_connect( session, 1 );
2581 tlsm_session_connect( LDAP *ld, tls_session *session )
2583 return tlsm_session_accept_or_connect( session, 0 );
2587 tlsm_session_upflags( Sockbuf *sb, tls_session *session, int rc )
2589 int prerror = PR_GetError();
2591 if ( ( prerror == PR_PENDING_INTERRUPT_ERROR ) || ( prerror == PR_WOULD_BLOCK_ERROR ) ) {
2592 tlsm_session *s = (tlsm_session *)session;
2593 struct tls_data *p = tlsm_get_pvt_tls_data( s );
2595 if ( p && ( p->io_flag == TLSM_READ ) ) {
2596 sb->sb_trans_needs_read = 1;
2598 } else if ( p && ( p->io_flag == TLSM_WRITE ) ) {
2599 sb->sb_trans_needs_write = 1;
2608 tlsm_session_errmsg( tls_session *sess, int rc, char *buf, size_t len )
2611 int prerror = PR_GetError();
2613 i = PR_GetErrorTextLength();
2615 char *msg = LDAP_MALLOC( i+1 );
2616 PR_GetErrorText( msg );
2617 memcpy( buf, msg, len );
2620 PR_GetErrorText( buf );
2621 } else if ( prerror ) {
2622 i = PR_snprintf( buf, len, "TLS error %d:%s",
2623 prerror, PR_ErrorToString( prerror, PR_LANGUAGE_I_DEFAULT ) );
2626 return ( i > 0 ) ? buf : NULL;
2630 tlsm_session_my_dn( tls_session *session, struct berval *der_dn )
2632 tlsm_session *s = (tlsm_session *)session;
2633 CERTCertificate *cert;
2635 cert = SSL_LocalCertificate( s );
2636 if (!cert) return LDAP_INVALID_CREDENTIALS;
2638 der_dn->bv_val = (char *)cert->derSubject.data;
2639 der_dn->bv_len = cert->derSubject.len;
2640 CERT_DestroyCertificate( cert );
2645 tlsm_session_peer_dn( tls_session *session, struct berval *der_dn )
2647 tlsm_session *s = (tlsm_session *)session;
2648 CERTCertificate *cert;
2650 cert = SSL_PeerCertificate( s );
2651 if (!cert) return LDAP_INVALID_CREDENTIALS;
2653 der_dn->bv_val = (char *)cert->derSubject.data;
2654 der_dn->bv_len = cert->derSubject.len;
2655 CERT_DestroyCertificate( cert );
2659 /* what kind of hostname were we given? */
2665 tlsm_session_chkhost( LDAP *ld, tls_session *session, const char *name_in )
2667 tlsm_session *s = (tlsm_session *)session;
2668 CERTCertificate *cert;
2669 const char *name, *domain = NULL, *ptr;
2670 int ret, ntype = IS_DNS, nlen, dlen;
2671 #ifdef LDAP_PF_INET6
2672 struct in6_addr addr;
2674 struct in_addr addr;
2679 if( ldap_int_hostname &&
2680 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
2682 name = ldap_int_hostname;
2686 nlen = strlen( name );
2688 cert = SSL_PeerCertificate( s );
2690 Debug( LDAP_DEBUG_ANY,
2691 "TLS: unable to get peer certificate.\n",
2693 /* if this was a fatal condition, things would have
2694 * aborted long before now.
2696 return LDAP_SUCCESS;
2699 #ifdef LDAP_PF_INET6
2700 if (inet_pton(AF_INET6, name, &addr)) {
2704 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
2705 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
2707 if (ntype == IS_DNS ) {
2708 domain = strchr( name, '.' );
2710 dlen = nlen - ( domain - name );
2713 ret = LDAP_LOCAL_ERROR;
2715 rv = CERT_FindCertExtension( cert, SEC_OID_X509_SUBJECT_ALT_NAME,
2717 if ( rv == SECSuccess && altname.data ) {
2719 CERTGeneralName *names, *cur;
2721 arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
2723 ret = LDAP_NO_MEMORY;
2727 names = cur = CERT_DecodeAltNameExtension(arena, &altname);
2736 if ( !cur->name.other.len ) continue;
2738 host = (char *)cur->name.other.data;
2739 hlen = cur->name.other.len;
2741 if ( cur->type == certDNSName ) {
2742 if ( ntype != IS_DNS ) continue;
2744 /* is this an exact match? */
2745 if ( nlen == hlen && !strncasecmp( name, host, nlen )) {
2750 /* is this a wildcard match? */
2751 if ( domain && host[0] == '*' && host[1] == '.' &&
2752 dlen == hlen-1 && !strncasecmp( domain, host+1, dlen )) {
2756 } else if ( cur->type == certIPAddress ) {
2757 if ( ntype == IS_DNS ) continue;
2759 #ifdef LDAP_PF_INET6
2760 if (ntype == IS_IP6 && hlen != sizeof(struct in6_addr)) {
2764 if (ntype == IS_IP4 && hlen != sizeof(struct in_addr)) {
2767 if (!memcmp(host, &addr, hlen)) {
2772 } while (( cur = CERT_GetNextGeneralName( cur )) != names );
2774 PORT_FreeArena( arena, PR_FALSE );
2775 SECITEM_FreeItem( &altname, PR_FALSE );
2777 /* no altnames matched, try the CN */
2778 if ( ret != LDAP_SUCCESS ) {
2779 /* find the last CN */
2780 CERTRDN *rdn, **rdns;
2781 CERTAVA *lastava = NULL;
2785 rdns = cert->subject.rdns;
2786 while ( rdns && ( rdn = *rdns++ )) {
2787 CERTAVA *ava, **avas = rdn->avas;
2788 while ( avas && ( ava = *avas++ )) {
2789 if ( CERT_GetAVATag( ava ) == SEC_OID_AVA_COMMON_NAME )
2794 SECItem *av = CERT_DecodeAVAValue( &lastava->value );
2796 if ( av->len == nlen && !strncasecmp( name, (char *)av->data, nlen )) {
2798 } else if ( av->data[0] == '*' && av->data[1] == '.' &&
2799 domain && dlen == av->len - 1 && !strncasecmp( domain,
2800 (char *)(av->data+1), dlen )) {
2804 if ( len >= sizeof(buf) )
2805 len = sizeof(buf)-1;
2806 memcpy( buf, av->data, len );
2809 SECITEM_FreeItem( av, PR_TRUE );
2812 if ( ret != LDAP_SUCCESS ) {
2813 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
2814 "common name in certificate (%s).\n",
2816 ret = LDAP_CONNECT_ERROR;
2817 if ( ld->ld_error ) {
2818 LDAP_FREE( ld->ld_error );
2820 ld->ld_error = LDAP_STRDUP(
2821 _("TLS: hostname does not match CN in peer certificate"));
2826 CERT_DestroyCertificate( cert );
2831 tlsm_session_strength( tls_session *session )
2833 tlsm_session *s = (tlsm_session *)session;
2836 rc = SSL_SecurityStatus( s, NULL, NULL, NULL, &keySize,
2838 return rc ? 0 : keySize;
2842 * TLS support for LBER Sockbufs
2845 static PRStatus PR_CALLBACK
2846 tlsm_PR_Close(PRFileDesc *fd)
2848 int rc = PR_SUCCESS;
2850 /* we don't need to actually close anything here, just
2851 pop our io layer off the stack */
2852 fd->secret = NULL; /* must have been freed before calling PR_Close */
2854 fd = PR_PopIOLayer( fd, tlsm_layer_id );
2855 /* if we are not the last layer, pass the close along */
2860 rc = fd->methods->close( fd );
2863 /* we are the last layer - just call our dtor */
2870 static PRStatus PR_CALLBACK
2871 tlsm_PR_Shutdown(PRFileDesc *fd, PRShutdownHow how)
2873 int rc = PR_SUCCESS;
2876 rc = PR_Shutdown( fd->lower, how );
2882 static int PR_CALLBACK
2883 tlsm_PR_Recv(PRFileDesc *fd, void *buf, PRInt32 len, PRIntn flags,
2884 PRIntervalTime timeout)
2889 if ( buf == NULL || len <= 0 ) return 0;
2891 p = tlsm_get_pvt_tls_data( fd );
2893 if ( p == NULL || p->sbiod == NULL ) {
2897 rc = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
2899 tlsm_map_error( errno );
2900 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2901 p->nonblock = PR_TRUE; /* fd is using non-blocking io */
2902 } else if ( errno ) { /* real error */
2903 Debug( LDAP_DEBUG_TRACE,
2904 "TLS: error: tlsm_PR_Recv returned %d - error %d:%s\n",
2905 rc, errno, STRERROR(errno) );
2907 } else if ( ( rc > 0 ) && ( len > 0 ) && ( p->firsttag == LBER_DEFAULT ) ) {
2908 p->firsttag = (ber_tag_t)*((char *)buf);
2910 p->io_flag = TLSM_READ;
2915 static int PR_CALLBACK
2916 tlsm_PR_Send(PRFileDesc *fd, const void *buf, PRInt32 len, PRIntn flags,
2917 PRIntervalTime timeout)
2922 if ( buf == NULL || len <= 0 ) return 0;
2924 p = tlsm_get_pvt_tls_data( fd );
2926 if ( p == NULL || p->sbiod == NULL ) {
2930 rc = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
2932 tlsm_map_error( errno );
2933 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2934 p->nonblock = PR_TRUE;
2935 } else if ( errno ) { /* real error */
2936 Debug( LDAP_DEBUG_TRACE,
2937 "TLS: error: tlsm_PR_Send returned %d - error %d:%s\n",
2938 rc, errno, STRERROR(errno) );
2941 p->io_flag = TLSM_WRITE;
2946 static int PR_CALLBACK
2947 tlsm_PR_Read(PRFileDesc *fd, void *buf, PRInt32 len)
2949 return tlsm_PR_Recv( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2952 static int PR_CALLBACK
2953 tlsm_PR_Write(PRFileDesc *fd, const void *buf, PRInt32 len)
2955 return tlsm_PR_Send( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2958 static PRStatus PR_CALLBACK
2959 tlsm_PR_GetPeerName(PRFileDesc *fd, PRNetAddr *addr)
2964 p = tlsm_get_pvt_tls_data( fd );
2966 if ( p == NULL || p->sbiod == NULL ) {
2969 len = sizeof(PRNetAddr);
2970 return getpeername( p->sbiod->sbiod_sb->sb_fd, (struct sockaddr *)addr, &len );
2973 static PRStatus PR_CALLBACK
2974 tlsm_PR_GetSocketOption(PRFileDesc *fd, PRSocketOptionData *data)
2977 p = tlsm_get_pvt_tls_data( fd );
2979 if ( p == NULL || data == NULL ) {
2983 /* only the nonblocking option is supported at this time
2984 MozNSS SSL code needs it */
2985 if ( data->option != PR_SockOpt_Nonblocking ) {
2986 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2990 int flags = fcntl( p->sbiod->sbiod_sb->sb_fd, F_GETFL );
2991 data->value.non_blocking = (flags & O_NONBLOCK) ? PR_TRUE : PR_FALSE;
2993 data->value.non_blocking = p->nonblock;
2998 static PRStatus PR_CALLBACK
3001 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3005 static PRFileDesc * PR_CALLBACK
3008 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3012 static PRInt16 PR_CALLBACK
3015 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3019 static PRInt32 PR_CALLBACK
3022 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3026 static PRInt64 PR_CALLBACK
3031 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3036 static const PRIOMethods tlsm_PR_methods = {
3038 tlsm_PR_Close, /* close */
3039 tlsm_PR_Read, /* read */
3040 tlsm_PR_Write, /* write */
3041 tlsm_PR_i32_unimp, /* available */
3042 tlsm_PR_i64_unimp, /* available64 */
3043 tlsm_PR_prs_unimp, /* fsync */
3044 tlsm_PR_i32_unimp, /* seek */
3045 tlsm_PR_i64_unimp, /* seek64 */
3046 tlsm_PR_prs_unimp, /* fileInfo */
3047 tlsm_PR_prs_unimp, /* fileInfo64 */
3048 tlsm_PR_i32_unimp, /* writev */
3049 tlsm_PR_prs_unimp, /* connect */
3050 tlsm_PR_pfd_unimp, /* accept */
3051 tlsm_PR_prs_unimp, /* bind */
3052 tlsm_PR_prs_unimp, /* listen */
3053 (PRShutdownFN)tlsm_PR_Shutdown, /* shutdown */
3054 tlsm_PR_Recv, /* recv */
3055 tlsm_PR_Send, /* send */
3056 tlsm_PR_i32_unimp, /* recvfrom */
3057 tlsm_PR_i32_unimp, /* sendto */
3058 (PRPollFN)tlsm_PR_i16_unimp, /* poll */
3059 tlsm_PR_i32_unimp, /* acceptread */
3060 tlsm_PR_i32_unimp, /* transmitfile */
3061 tlsm_PR_prs_unimp, /* getsockname */
3062 tlsm_PR_GetPeerName, /* getpeername */
3063 tlsm_PR_i32_unimp, /* getsockopt OBSOLETE */
3064 tlsm_PR_i32_unimp, /* setsockopt OBSOLETE */
3065 tlsm_PR_GetSocketOption, /* getsocketoption */
3066 tlsm_PR_i32_unimp, /* setsocketoption */
3067 tlsm_PR_i32_unimp, /* Send a (partial) file with header/trailer*/
3068 (PRConnectcontinueFN)tlsm_PR_prs_unimp, /* connectcontinue */
3069 tlsm_PR_i32_unimp, /* reserved for future use */
3070 tlsm_PR_i32_unimp, /* reserved for future use */
3071 tlsm_PR_i32_unimp, /* reserved for future use */
3072 tlsm_PR_i32_unimp /* reserved for future use */
3076 * Initialize TLS subsystem. Should be called only once.
3077 * See tlsm_deferred_init for the bulk of the init process
3082 char *nofork = PR_GetEnv( "NSS_STRICT_NOFORK" );
3086 tlsm_layer_id = PR_GetUniqueIdentity( "OpenLDAP" );
3089 * There are some applications that acquire a crypto context in the parent process
3090 * and expect that crypto context to work after a fork(). This does not work
3091 * with NSS using strict PKCS11 compliance mode. We set this environment
3092 * variable here to tell the software encryption module/token to allow crypto
3093 * contexts to persist across a fork(). However, if you are using some other
3094 * module or encryption device that supports and expects full PKCS11 semantics,
3095 * the only recourse is to rewrite the application with atfork() handlers to save
3096 * the crypto context in the parent and restore (and SECMOD_RestartModules) the
3097 * context in the child.
3100 /* will leak one time */
3101 char *noforkenvvar = PL_strdup( "NSS_STRICT_NOFORK=DISABLED" );
3102 PR_SetEnv( noforkenvvar );
3109 tlsm_sb_setup( Sockbuf_IO_Desc *sbiod, void *arg )
3112 tlsm_session *session = arg;
3115 assert( sbiod != NULL );
3117 p = LBER_MALLOC( sizeof( *p ) );
3122 fd = PR_GetIdentitiesLayer( session, tlsm_layer_id );
3128 fd->secret = (PRFilePrivate *)p;
3129 p->session = session;
3131 p->firsttag = LBER_DEFAULT;
3132 sbiod->sbiod_pvt = p;
3137 tlsm_sb_remove( Sockbuf_IO_Desc *sbiod )
3141 assert( sbiod != NULL );
3142 assert( sbiod->sbiod_pvt != NULL );
3144 p = (struct tls_data *)sbiod->sbiod_pvt;
3145 PR_Close( p->session );
3146 LBER_FREE( sbiod->sbiod_pvt );
3147 sbiod->sbiod_pvt = NULL;
3152 tlsm_sb_close( Sockbuf_IO_Desc *sbiod )
3156 assert( sbiod != NULL );
3157 assert( sbiod->sbiod_pvt != NULL );
3159 p = (struct tls_data *)sbiod->sbiod_pvt;
3160 PR_Shutdown( p->session, PR_SHUTDOWN_BOTH );
3165 tlsm_sb_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
3169 assert( sbiod != NULL );
3170 assert( sbiod->sbiod_pvt != NULL );
3172 p = (struct tls_data *)sbiod->sbiod_pvt;
3174 if ( opt == LBER_SB_OPT_GET_SSL ) {
3175 *((tlsm_session **)arg) = p->session;
3178 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
3179 if ( p && ( SSL_DataPending( p->session ) > 0 ) ) {
3185 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
3189 tlsm_sb_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3195 assert( sbiod != NULL );
3196 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3198 p = (struct tls_data *)sbiod->sbiod_pvt;
3200 ret = PR_Recv( p->session, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3202 err = PR_GetError();
3203 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3204 sbiod->sbiod_sb->sb_trans_needs_read = 1;
3205 sock_errset(EWOULDBLOCK);
3208 sbiod->sbiod_sb->sb_trans_needs_read = 0;
3214 tlsm_sb_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3220 assert( sbiod != NULL );
3221 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3223 p = (struct tls_data *)sbiod->sbiod_pvt;
3225 ret = PR_Send( p->session, (char *)buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3227 err = PR_GetError();
3228 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3229 sbiod->sbiod_sb->sb_trans_needs_write = 1;
3230 sock_errset(EWOULDBLOCK);
3234 sbiod->sbiod_sb->sb_trans_needs_write = 0;
3239 static Sockbuf_IO tlsm_sbio =
3241 tlsm_sb_setup, /* sbi_setup */
3242 tlsm_sb_remove, /* sbi_remove */
3243 tlsm_sb_ctrl, /* sbi_ctrl */
3244 tlsm_sb_read, /* sbi_read */
3245 tlsm_sb_write, /* sbi_write */
3246 tlsm_sb_close /* sbi_close */
3249 tls_impl ldap_int_tls_impl = {
3261 tlsm_session_connect,
3262 tlsm_session_accept,
3263 tlsm_session_upflags,
3264 tlsm_session_errmsg,
3266 tlsm_session_peer_dn,
3267 tlsm_session_chkhost,
3268 tlsm_session_strength,
3272 #ifdef LDAP_R_COMPILE
3281 #endif /* HAVE_MOZNSS */