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-2013 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];
916 /* Prompt for password */
919 "Please enter pin, password, or pass phrase for security token '%s': ",
920 token_name ? token_name : DEFAULT_TOKEN_NAME );
923 dummy = fgets( (char*)phrase, sizeof(phrase), stdin );
926 fprintf( stdout, "\n" );
929 /* stomp on newline */
930 phrase[strlen((char*)phrase)-1] = 0;
932 pwdstr = PL_strdup( (char*)phrase );
935 #endif /* READ_PASSWORD_FROM_STDIN */
940 * PKCS11 devices (including the internal softokn cert/key database)
941 * may be protected by a pin or password or even pass phrase
942 * MozNSS needs a way for the user to provide that
945 tlsm_pin_prompt(PK11SlotInfo *slot, PRBool retry, void *arg)
947 tlsm_ctx *ctx = (tlsm_ctx *)arg;
949 return tlsm_get_pin( slot, retry, ctx );
953 tlsm_ctx_subject_name(tlsm_ctx *ctx)
955 if ( !ctx || !ctx->tc_certificate )
958 return ctx->tc_certificate->subjectName;
962 tlsm_get_basic_constraint_extension( CERTCertificate *cert,
963 CERTBasicConstraints *cbcval )
965 SECItem encodedVal = { 0, NULL };
968 rc = CERT_FindCertExtension( cert, SEC_OID_X509_BASIC_CONSTRAINTS,
970 if ( rc != SECSuccess ) {
974 rc = CERT_DecodeBasicConstraintValue( cbcval, &encodedVal );
976 /* free the raw extension data */
977 PORT_Free( encodedVal.data );
983 tlsm_cert_is_self_issued( CERTCertificate *cert )
985 /* A cert is self-issued if its subject and issuer are equal and
986 * both are of non-zero length.
988 PRBool is_self_issued = cert &&
989 (PRBool)SECITEM_ItemsAreEqual( &cert->derIssuer,
990 &cert->derSubject ) &&
991 cert->derSubject.len > 0;
992 return is_self_issued;
996 * The private key for used certificate can be already unlocked by other
997 * thread or library. Find the unlocked key if possible.
999 static SECKEYPrivateKey *
1000 tlsm_find_unlocked_key( tlsm_ctx *ctx, void *pin_arg )
1002 SECKEYPrivateKey *result = NULL;
1004 PK11SlotList *slots = PK11_GetAllSlotsForCert( ctx->tc_certificate, NULL );
1006 PRErrorCode errcode = PR_GetError();
1007 Debug( LDAP_DEBUG_ANY,
1008 "TLS: cannot get all slots for certificate '%s' (error %d: %s)",
1009 tlsm_ctx_subject_name( ctx ), errcode,
1010 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1014 PK11SlotListElement *le;
1015 for ( le = slots->head; le; le = le->next ) {
1016 PK11SlotInfo *slot = le->slot;
1017 if ( PK11_IsLoggedIn( slot, NULL ) ) {
1018 result = PK11_FindKeyByDERCert( slot, ctx->tc_certificate, pin_arg );
1023 PK11_FreeSlotList( slots );
1028 tlsm_verify_cert(CERTCertDBHandle *handle, CERTCertificate *cert, void *pinarg,
1029 PRBool checksig, SECCertificateUsage certUsage, PRBool warn_only,
1030 PRBool ignore_issuer )
1032 CERTVerifyLog verifylog;
1033 SECStatus ret = SECSuccess;
1035 int debug_level = LDAP_DEBUG_ANY;
1038 debug_level = LDAP_DEBUG_TRACE;
1041 /* the log captures information about every cert in the chain, so we can tell
1042 which cert caused the problem and what the problem was */
1043 memset( &verifylog, 0, sizeof( verifylog ) );
1044 verifylog.arena = PORT_NewArena( DER_DEFAULT_CHUNKSIZE );
1045 if ( verifylog.arena == NULL ) {
1046 Debug( LDAP_DEBUG_ANY,
1047 "TLS certificate verification: Out of memory for certificate verification logger\n",
1051 ret = CERT_VerifyCertificate( handle, cert, checksig, certUsage, PR_Now(), pinarg, &verifylog,
1053 if ( ( name = cert->subjectName ) == NULL ) {
1054 name = cert->nickname;
1056 if ( verifylog.head == NULL ) {
1057 /* it is possible for CERT_VerifyCertificate return with an error with no logging */
1058 if ( ret != SECSuccess ) {
1059 PRErrorCode errcode = PR_GetError();
1061 "TLS: certificate [%s] is not valid - error %d:%s.\n",
1062 name ? name : "(unknown)",
1063 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1067 CERTVerifyLogNode *node;
1069 ret = SECSuccess; /* reset */
1070 node = verifylog.head;
1072 if ( ( name = node->cert->subjectName ) == NULL ) {
1073 name = node->cert->nickname;
1075 if ( node->error ) {
1076 /* NSS does not like CA certs that have the basic constraints extension
1077 with the CA flag set to FALSE - openssl doesn't check if the cert
1079 if ( ( node->error == SEC_ERROR_CA_CERT_INVALID ) &&
1080 tlsm_cert_is_self_issued( node->cert ) ) {
1082 PRErrorCode orig_error = PR_GetError();
1083 PRInt32 orig_oserror = PR_GetOSError();
1085 CERTBasicConstraints basicConstraint;
1086 SECStatus rv = tlsm_get_basic_constraint_extension( node->cert, &basicConstraint );
1087 if ( ( rv == SECSuccess ) && ( basicConstraint.isCA == PR_FALSE ) ) {
1088 Debug( LDAP_DEBUG_TRACE,
1089 "TLS: certificate [%s] is not correct because it is a CA cert and the "
1090 "BasicConstraint CA flag is set to FALSE - allowing for now, but "
1091 "please fix your certs if possible\n", name, 0, 0 );
1092 } else { /* does not have basicconstraint, or some other error */
1095 "TLS: certificate [%s] is not valid - CA cert is not valid\n",
1099 PR_SetError( orig_error, orig_oserror );
1101 } else if ( warn_only || ( ignore_issuer && (
1102 node->error == SEC_ERROR_UNKNOWN_ISSUER ||
1103 node->error == SEC_ERROR_UNTRUSTED_ISSUER )
1107 "TLS: Warning: ignoring error for certificate [%s] - error %ld:%s.\n",
1108 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1112 "TLS: certificate [%s] is not valid - error %ld:%s.\n",
1113 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1116 CERT_DestroyCertificate( node->cert );
1121 PORT_FreeArena( verifylog.arena, PR_FALSE );
1123 if ( ret == SECSuccess ) {
1124 Debug( LDAP_DEBUG_TRACE,
1125 "TLS: certificate [%s] is valid\n", name, 0, 0 );
1132 tlsm_auth_cert_handler(void *arg, PRFileDesc *fd,
1133 PRBool checksig, PRBool isServer)
1135 SECCertificateUsage certUsage = isServer ? certificateUsageSSLClient : certificateUsageSSLServer;
1136 SECStatus ret = SECSuccess;
1137 CERTCertificate *peercert = SSL_PeerCertificate( fd );
1138 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1140 ret = tlsm_verify_cert( ctx->tc_certdb, peercert,
1141 SSL_RevealPinArg( fd ),
1142 checksig, certUsage, ctx->tc_warn_only, PR_FALSE );
1143 CERT_DestroyCertificate( peercert );
1149 tlsm_nss_shutdown_cb( void *appData, void *nssData )
1151 SECStatus rc = SECSuccess;
1153 SSL_ShutdownServerSessionIDCache();
1156 SECMOD_UnloadUserModule( pem_module );
1157 SECMOD_DestroyModule( pem_module );
1163 static PRCallOnceType tlsm_register_shutdown_callonce = {0,0};
1164 static PRStatus PR_CALLBACK
1165 tlsm_register_nss_shutdown_cb( void )
1167 if ( SECSuccess == NSS_RegisterShutdown( tlsm_nss_shutdown_cb,
1175 tlsm_register_nss_shutdown( void )
1177 return PR_CallOnce( &tlsm_register_shutdown_callonce,
1178 tlsm_register_nss_shutdown_cb );
1182 tlsm_init_pem_module( void )
1185 char *fullname = NULL;
1186 char *configstring = NULL;
1192 /* not loaded - load it */
1193 /* get the system dependent library name */
1194 fullname = PR_GetLibraryName( NULL, PEM_LIBRARY );
1195 /* Load our PKCS#11 module */
1196 configstring = PR_smprintf( "library=%s name=" PEM_MODULE " parameters=\"\"", fullname );
1197 PL_strfree( fullname );
1199 pem_module = SECMOD_LoadUserModule( configstring, NULL, PR_FALSE );
1200 PR_smprintf_free( configstring );
1202 if ( !pem_module || !pem_module->loaded ) {
1204 SECMOD_DestroyModule( pem_module );
1214 tlsm_add_pem_obj( tlsm_ctx *ctx, PK11GenericObject *obj )
1216 int idx = ctx->tc_n_pem_objs;
1217 ctx->tc_n_pem_objs++;
1218 ctx->tc_pem_objs = (PK11GenericObject **)
1219 PORT_Realloc( ctx->tc_pem_objs, ctx->tc_n_pem_objs * sizeof( PK11GenericObject * ) );
1220 ctx->tc_pem_objs[idx] = obj;
1224 tlsm_free_pem_objs( tlsm_ctx *ctx )
1226 /* free in reverse order of allocation */
1227 while ( ctx->tc_n_pem_objs-- ) {
1228 PK11_DestroyGenericObject( ctx->tc_pem_objs[ctx->tc_n_pem_objs] );
1229 ctx->tc_pem_objs[ctx->tc_n_pem_objs] = NULL;
1231 PORT_Free(ctx->tc_pem_objs);
1232 ctx->tc_pem_objs = NULL;
1233 ctx->tc_n_pem_objs = 0;
1237 tlsm_add_cert_from_file( tlsm_ctx *ctx, const char *filename, PRBool isca )
1240 PK11GenericObject *cert;
1241 CK_ATTRIBUTE attrs[4];
1242 CK_BBOOL cktrue = CK_TRUE;
1243 CK_BBOOL ckfalse = CK_FALSE;
1244 CK_OBJECT_CLASS objClass = CKO_CERTIFICATE;
1248 SECItem certDER = { 0, NULL, 0 };
1250 memset( &fi, 0, sizeof(fi) );
1251 status = PR_GetFileInfo( filename, &fi );
1252 if ( PR_SUCCESS != status) {
1253 PRErrorCode errcode = PR_GetError();
1254 Debug( LDAP_DEBUG_ANY,
1255 "TLS: could not read certificate file %s - error %d:%s.\n",
1257 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1261 if ( fi.type != PR_FILE_FILE ) {
1262 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1263 Debug( LDAP_DEBUG_ANY,
1264 "TLS: error: the certificate file %s is not a file.\n",
1269 slotname = isca ? TLSM_PEM_SLOT_CACERTS : TLSM_PEM_SLOT_CERTS;
1270 slot = PK11_FindSlotByName( slotname );
1273 PRErrorCode errcode = PR_GetError();
1274 Debug( LDAP_DEBUG_ANY,
1275 "TLS: could not find the slot for the certificate '%s' - error %d:%s.\n",
1276 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1280 PK11_SETATTRS( attrs[0], CKA_CLASS, &objClass, sizeof( objClass ) );
1281 PK11_SETATTRS( attrs[1], CKA_TOKEN, &cktrue, sizeof( CK_BBOOL ) );
1282 PK11_SETATTRS( attrs[2], CKA_LABEL, (unsigned char *) filename, strlen( filename ) + 1 );
1283 PK11_SETATTRS( attrs[3], CKA_TRUST, isca ? &cktrue : &ckfalse, sizeof( CK_BBOOL ) );
1285 cert = PK11_CreateGenericObject( slot, attrs, 4, PR_FALSE /* isPerm */ );
1288 PRErrorCode errcode = PR_GetError();
1289 Debug( LDAP_DEBUG_ANY,
1290 "TLS: could not add the certificate '%s' - error %d:%s.\n",
1291 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1292 PK11_FreeSlot( slot );
1296 /* if not CA, we store the certificate in ctx->tc_certificate */
1298 if ( PK11_ReadRawAttribute( PK11_TypeGeneric, cert, CKA_VALUE, &certDER ) != SECSuccess ) {
1299 PRErrorCode errcode = PR_GetError();
1300 Debug( LDAP_DEBUG_ANY,
1301 "TLS: could not get DER of the '%s' certificate - error %d:%s.\n",
1302 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1303 PK11_DestroyGenericObject( cert );
1304 PK11_FreeSlot( slot );
1308 ctx->tc_certificate = PK11_FindCertFromDERCertItem( slot, &certDER, NULL );
1309 SECITEM_FreeItem( &certDER, PR_FALSE );
1311 if ( !ctx->tc_certificate ) {
1312 PRErrorCode errcode = PR_GetError();
1313 Debug( LDAP_DEBUG_ANY,
1314 "TLS: could not get certificate '%s' using DER - error %d:%s.\n",
1315 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1316 PK11_DestroyGenericObject( cert );
1317 PK11_FreeSlot( slot );
1322 tlsm_add_pem_obj( ctx, cert );
1324 PK11_FreeSlot( slot );
1330 tlsm_ctx_load_private_key( tlsm_ctx *ctx )
1332 if ( !ctx->tc_certificate )
1335 if ( ctx->tc_private_key )
1338 void *pin_arg = SSL_RevealPinArg( ctx->tc_model );
1340 SECKEYPrivateKey *unlocked_key = tlsm_find_unlocked_key( ctx, pin_arg );
1341 Debug( LDAP_DEBUG_ANY,
1342 "TLS: %s unlocked certificate for certificate '%s'.\n",
1343 unlocked_key ? "found" : "no", tlsm_ctx_subject_name( ctx ), 0 );
1345 /* prefer unlocked key, then key from opened certdb, then any other */
1347 ctx->tc_private_key = unlocked_key;
1348 else if ( ctx->tc_certdb_slot )
1349 ctx->tc_private_key = PK11_FindKeyByDERCert( ctx->tc_certdb_slot, ctx->tc_certificate, pin_arg );
1351 ctx->tc_private_key = PK11_FindKeyByAnyCert( ctx->tc_certificate, pin_arg );
1353 if ( !ctx->tc_private_key ) {
1354 PRErrorCode errcode = PR_GetError();
1355 Debug(LDAP_DEBUG_ANY,
1356 "TLS: cannot find private key for certificate '%s' (error %d: %s)",
1357 tlsm_ctx_subject_name( ctx ), errcode,
1358 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1366 tlsm_add_key_from_file( tlsm_ctx *ctx, const char *filename )
1368 PK11SlotInfo * slot = NULL;
1369 PK11GenericObject *key;
1370 CK_ATTRIBUTE attrs[3];
1371 CK_BBOOL cktrue = CK_TRUE;
1372 CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1377 memset( &fi, 0, sizeof(fi) );
1378 status = PR_GetFileInfo( filename, &fi );
1379 if ( PR_SUCCESS != status) {
1380 PRErrorCode errcode = PR_GetError();
1381 Debug( LDAP_DEBUG_ANY,
1382 "TLS: could not read key file %s - error %d:%s.\n",
1384 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1388 if ( fi.type != PR_FILE_FILE ) {
1389 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1390 Debug( LDAP_DEBUG_ANY,
1391 "TLS: error: the key file %s is not a file.\n",
1396 slot = PK11_FindSlotByName( TLSM_PEM_SLOT_CERTS );
1399 PRErrorCode errcode = PR_GetError();
1400 Debug( LDAP_DEBUG_ANY,
1401 "TLS: could not find the slot for the private key '%s' - error %d:%s.\n",
1402 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1406 PK11_SETATTRS( attrs[0], CKA_CLASS, &objClass, sizeof( objClass ) );
1407 PK11_SETATTRS( attrs[1], CKA_TOKEN, &cktrue, sizeof( CK_BBOOL ) );
1408 PK11_SETATTRS( attrs[2], CKA_LABEL, (unsigned char *)filename, strlen( filename ) + 1 );
1410 key = PK11_CreateGenericObject( slot, attrs, 3, PR_FALSE /* isPerm */ );
1413 PRErrorCode errcode = PR_GetError();
1414 Debug( LDAP_DEBUG_ANY,
1415 "TLS: could not add the private key '%s' - error %d:%s.\n",
1416 filename, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1419 tlsm_add_pem_obj( ctx, key );
1422 /* When adding an encrypted key the PKCS#11 will be set as removed */
1423 /* This will force the token to be seen as re-inserted */
1424 SECMOD_WaitForAnyTokenEvent( pem_module, 0, 0 );
1425 PK11_IsPresent( slot );
1428 PK11_FreeSlot( slot );
1434 tlsm_init_ca_certs( tlsm_ctx *ctx, const char *cacertfile, const char *cacertdir )
1436 PRBool isca = PR_TRUE;
1437 PRStatus status = PR_SUCCESS;
1438 PRErrorCode errcode = PR_SUCCESS;
1440 if ( !cacertfile && !cacertdir ) {
1441 /* no checking - not good, but allowed */
1446 int rc = tlsm_add_cert_from_file( ctx, cacertfile, isca );
1448 errcode = PR_GetError();
1449 Debug( LDAP_DEBUG_ANY,
1450 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1451 cacertfile, errcode,
1452 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1453 /* failure with cacertfile is a hard failure even if cacertdir is
1454 also specified and contains valid CA cert files */
1455 status = PR_FAILURE;
1457 Debug( LDAP_DEBUG_TRACE,
1458 "TLS: loaded CA certificate file %s.\n",
1463 /* if cacertfile above failed, we will return failure, even
1464 if there is a valid CA cert in cacertdir - but we still
1465 process cacertdir in case the user has enabled trace level
1466 debugging so they can see the processing for cacertdir too */
1467 /* any cacertdir failures are "soft" failures - if the user specifies
1468 no cert checking, then we allow the tls/ssl to continue, no matter
1469 what was specified for cacertdir, or the contents of the directory
1470 - this is different behavior than that of cacertfile */
1475 PRStatus fistatus = PR_FAILURE;
1477 memset( &fi, 0, sizeof(fi) );
1478 fistatus = PR_GetFileInfo( cacertdir, &fi );
1479 if ( PR_SUCCESS != fistatus) {
1480 errcode = PR_GetError();
1481 Debug( LDAP_DEBUG_ANY,
1482 "TLS: could not get info about the CA certificate directory %s - error %d:%s.\n",
1484 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1488 if ( fi.type != PR_FILE_DIRECTORY ) {
1489 Debug( LDAP_DEBUG_ANY,
1490 "TLS: error: the CA certificate directory %s is not a directory.\n",
1495 dir = PR_OpenDir( cacertdir );
1496 if ( NULL == dir ) {
1497 errcode = PR_GetError();
1498 Debug( LDAP_DEBUG_ANY,
1499 "TLS: could not open the CA certificate directory %s - error %d:%s.\n",
1501 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1506 entry = PR_ReadDir( dir, PR_SKIP_BOTH | PR_SKIP_HIDDEN );
1507 if ( ( NULL != entry ) && ( NULL != entry->name ) ) {
1508 char *fullpath = NULL;
1511 ptr = PL_strrstr( entry->name, PEM_CA_HASH_FILE_SUFFIX );
1512 if ( ( ptr == NULL ) || ( *(ptr + PEM_CA_HASH_FILE_SUFFIX_LEN) != '\0' ) ) {
1513 Debug( LDAP_DEBUG_TRACE,
1514 "TLS: file %s does not end in [%s] - does not appear to be a CA certificate "
1515 "directory file with a properly hashed file name - skipping.\n",
1516 entry->name, PEM_CA_HASH_FILE_SUFFIX, 0 );
1519 fullpath = PR_smprintf( "%s/%s", cacertdir, entry->name );
1520 if ( !tlsm_add_cert_from_file( ctx, fullpath, isca ) ) {
1521 Debug( LDAP_DEBUG_TRACE,
1522 "TLS: loaded CA certificate file %s from CA certificate directory %s.\n",
1523 fullpath, cacertdir, 0 );
1525 errcode = PR_GetError();
1526 Debug( LDAP_DEBUG_TRACE,
1527 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1529 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1531 PR_smprintf_free( fullpath );
1533 } while ( NULL != entry );
1537 if ( status != PR_SUCCESS ) {
1545 * NSS supports having multiple cert/key databases in the same
1546 * directory, each one having a unique string prefix e.g.
1547 * slapd-01-cert8.db - the prefix here is "slapd-01-"
1548 * this function examines the given certdir - if it looks like
1549 * /path/to/directory/prefix it will return the
1550 * /path/to/directory part in realcertdir, and the prefix in prefix
1553 tlsm_get_certdb_prefix( const char *certdir, char **realcertdir, char **prefix )
1555 char sep = PR_GetDirectorySeparator();
1557 struct PRFileInfo prfi;
1560 *realcertdir = (char *)certdir; /* default is the one passed in */
1562 /* if certdir is not given, just return */
1567 prc = PR_GetFileInfo( certdir, &prfi );
1568 /* if certdir exists (file or directory) then it cannot specify a prefix */
1569 if ( prc == PR_SUCCESS ) {
1573 /* if certdir was given, and there is a '/' in certdir, see if there
1574 is anything after the last '/' - if so, assume it is the prefix */
1575 if ( ( ( ptr = strrchr( certdir, sep ) ) ) && *(ptr+1) ) {
1576 *realcertdir = PL_strndup( certdir, ptr-certdir );
1577 *prefix = PL_strdup( ptr+1 );
1584 * Currently mutiple MozNSS contexts share one certificate storage. When the
1585 * certdb is being opened, only new certificates are added to the storage.
1586 * When different databases are used, conflicting nicknames make the
1587 * certificate lookup by the nickname impossible. In addition a token
1588 * description might be prepended in certain conditions.
1590 * In order to make the certificate lookup by nickname possible, we explicitly
1591 * open each database using SECMOD_OpenUserDB and assign it the token
1592 * description. The token description is generated using ctx->tc_unique value,
1593 * which is unique for each context.
1595 static PK11SlotInfo *
1596 tlsm_init_open_certdb( tlsm_ctx *ctx, const char *dbdir, const char *prefix )
1598 PK11SlotInfo *slot = NULL;
1599 char *token_desc = NULL;
1600 char *config = NULL;
1602 token_desc = PR_smprintf( TLSM_CERTDB_DESC_FMT, ctx->tc_unique );
1603 config = PR_smprintf( "configDir='%s' tokenDescription='%s' certPrefix='%s' keyPrefix='%s' flags=readOnly",
1604 dbdir, token_desc, prefix, prefix );
1605 Debug( LDAP_DEBUG_TRACE, "TLS: certdb config: %s\n", config, 0, 0 );
1607 slot = SECMOD_OpenUserDB( config );
1609 PRErrorCode errcode = PR_GetError();
1610 Debug( LDAP_DEBUG_TRACE, "TLS: cannot open certdb '%s', error %d:%s\n", dbdir, errcode,
1611 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1615 PR_smprintf_free( token_desc );
1617 PR_smprintf_free( config );
1623 * This is the part of the init we defer until we get the
1624 * actual security configuration information. This is
1625 * only called once, protected by a PRCallOnce
1626 * NOTE: This must be done before the first call to SSL_ImportFD,
1627 * especially the setting of the policy
1628 * NOTE: This must be called after fork()
1631 tlsm_deferred_init( void *arg )
1633 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1634 struct ldaptls *lt = ctx->tc_config;
1635 const char *securitydirs[3];
1638 PRErrorCode errcode = 1;
1639 #ifdef HAVE_NSS_INITCONTEXT
1640 NSSInitParameters initParams;
1641 NSSInitContext *initctx = NULL;
1642 PK11SlotInfo *certdb_slot = NULL;
1647 #ifdef HAVE_SECMOD_RESTARTMODULES
1648 /* NSS enforces the pkcs11 requirement that modules should be unloaded after
1649 a fork() - since there is no portable way to determine if NSS has been
1650 already initialized in a parent process, we just call SECMOD_RestartModules
1651 with force == FALSE - if the module has been unloaded due to a fork, it will
1652 be reloaded, otherwise, it is a no-op */
1653 if ( SECFailure == ( rc = SECMOD_RestartModules(PR_FALSE /* do not force */) ) ) {
1654 errcode = PORT_GetError();
1655 if ( errcode != SEC_ERROR_NOT_INITIALIZED ) {
1656 Debug( LDAP_DEBUG_TRACE,
1657 "TLS: could not restart the security modules: %d:%s\n",
1658 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1665 #ifdef HAVE_NSS_INITCONTEXT
1666 memset( &initParams, 0, sizeof( initParams ) );
1667 initParams.length = sizeof( initParams );
1668 #endif /* HAVE_NSS_INITCONTEXT */
1670 #ifdef LDAP_R_COMPILE
1671 if ( PR_CallOnce( &tlsm_init_mutex_callonce, tlsm_thr_init_callonce ) ) {
1674 #endif /* LDAP_R_COMPILE */
1676 #ifndef HAVE_NSS_INITCONTEXT
1677 if ( !NSS_IsInitialized() ) {
1678 #endif /* HAVE_NSS_INITCONTEXT */
1680 MOZNSS_DIR will override everything else - you can
1681 always set MOZNSS_DIR to force the use of this
1683 If using MOZNSS, specify the location of the moznss db dir
1684 in the cacertdir directive of the OpenLDAP configuration.
1685 DEFAULT_MOZNSS_DIR will only be used if the code cannot
1686 find a security dir to use based on the current
1690 securitydirs[nn++] = PR_GetEnv( "MOZNSS_DIR" );
1691 securitydirs[nn++] = lt->lt_cacertdir;
1692 securitydirs[nn++] = PR_GetEnv( "DEFAULT_MOZNSS_DIR" );
1693 for ( ii = 0; !done && ( ii < nn ); ++ii ) {
1694 char *realcertdir = NULL;
1695 const char *defprefix = "";
1696 char *prefix = (char *)defprefix;
1697 const char *securitydir = securitydirs[ii];
1698 if ( NULL == securitydir ) {
1702 tlsm_get_certdb_prefix( securitydir, &realcertdir, &prefix );
1704 /* initialize only moddb; certdb will be initialized explicitly */
1705 #ifdef HAVE_NSS_INITCONTEXT
1706 #ifdef INITCONTEXT_HACK
1707 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1708 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1710 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1711 &initParams, NSS_INIT_READONLY|NSS_INIT_NOCERTDB );
1714 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1715 &initParams, NSS_INIT_READONLY|NSS_INIT_NOCERTDB );
1719 if ( initctx != NULL ) {
1720 certdb_slot = tlsm_init_open_certdb( ctx, realcertdir, prefix );
1721 if ( certdb_slot ) {
1723 ctx->tc_initctx = initctx;
1724 ctx->tc_certdb_slot = certdb_slot;
1726 NSS_ShutdownContext( initctx );
1731 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1734 if ( rc != SECSuccess ) {
1735 errcode = PORT_GetError();
1736 if ( securitydirs[ii] != lt->lt_cacertdir) {
1737 Debug( LDAP_DEBUG_TRACE,
1738 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1739 realcertdir, prefix, errcode );
1743 Debug( LDAP_DEBUG_TRACE, "TLS: using moznss security dir %s prefix %s.\n",
1744 realcertdir, prefix, 0 );
1748 if ( realcertdir != securitydir ) {
1749 PL_strfree( realcertdir );
1751 if ( prefix != defprefix ) {
1752 PL_strfree( prefix );
1756 if ( errcode ) { /* no moznss db found, or not using moznss db */
1757 #ifdef HAVE_NSS_INITCONTEXT
1758 int flags = NSS_INIT_READONLY|NSS_INIT_NOCERTDB|NSS_INIT_NOMODDB;
1759 #ifdef INITCONTEXT_HACK
1760 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1761 rc = NSS_NoDB_Init( NULL );
1763 initctx = NSS_InitContext( CERTDB_NONE, PREFIX_NONE, PREFIX_NONE, SECMOD_DB,
1764 &initParams, flags );
1765 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1768 initctx = NSS_InitContext( CERTDB_NONE, PREFIX_NONE, PREFIX_NONE, SECMOD_DB,
1769 &initParams, flags );
1771 ctx->tc_initctx = initctx;
1778 rc = NSS_NoDB_Init( NULL );
1780 if ( rc != SECSuccess ) {
1781 errcode = PORT_GetError();
1782 Debug( LDAP_DEBUG_ANY,
1783 "TLS: could not initialize moznss - error %d:%s.\n",
1784 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1789 if ( errcode || lt->lt_cacertfile ) {
1790 /* initialize the PEM module */
1791 if ( tlsm_init_pem_module() ) {
1792 int pem_errcode = PORT_GetError();
1793 Debug( LDAP_DEBUG_ANY,
1794 "TLS: could not initialize moznss PEM module - error %d:%s.\n",
1795 pem_errcode, PR_ErrorToString( pem_errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1797 if ( errcode ) /* PEM is required */
1800 } else if ( !errcode ) {
1801 tlsm_init_ca_certs( ctx, lt->lt_cacertfile, NULL );
1806 if ( tlsm_init_ca_certs( ctx, lt->lt_cacertfile, lt->lt_cacertdir ) ) {
1807 /* if we tried to use lt->lt_cacertdir as an NSS key/cert db, errcode
1808 will be a value other than 1 - print an error message so that the
1809 user will know that failed too */
1810 if ( ( errcode != 1 ) && ( lt->lt_cacertdir ) ) {
1811 char *realcertdir = NULL;
1812 char *prefix = NULL;
1813 tlsm_get_certdb_prefix( lt->lt_cacertdir, &realcertdir, &prefix );
1814 Debug( LDAP_DEBUG_TRACE,
1815 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1816 realcertdir, prefix ? prefix : "", errcode );
1817 if ( realcertdir != lt->lt_cacertdir ) {
1818 PL_strfree( realcertdir );
1820 PL_strfree( prefix );
1825 ctx->tc_using_pem = PR_TRUE;
1828 NSS_SetDomesticPolicy();
1830 PK11_SetPasswordFunc( tlsm_pin_prompt );
1832 /* register cleanup function */
1833 if ( tlsm_register_nss_shutdown() ) {
1834 errcode = PORT_GetError();
1835 Debug( LDAP_DEBUG_ANY,
1836 "TLS: could not register NSS shutdown function: %d:%s\n",
1837 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1841 if ( ctx->tc_is_server ) {
1842 /* 0 means use the defaults here */
1843 SSL_ConfigServerSessionIDCache( 0, 0, 0, NULL );
1846 #ifndef HAVE_NSS_INITCONTEXT
1848 #endif /* HAVE_NSS_INITCONTEXT */
1854 * Find and verify the certificate.
1855 * The key is loaded and stored in ctx->tc_private_key
1858 tlsm_find_and_verify_cert_key( tlsm_ctx *ctx )
1860 SECCertificateUsage certUsage;
1865 if ( tlsm_ctx_load_private_key( ctx ) )
1868 pin_arg = SSL_RevealPinArg( ctx->tc_model );
1869 certUsage = ctx->tc_is_server ? certificateUsageSSLServer : certificateUsageSSLClient;
1870 checkSig = ctx->tc_verify_cert ? PR_TRUE : PR_FALSE;
1872 status = tlsm_verify_cert( ctx->tc_certdb, ctx->tc_certificate, pin_arg,
1873 checkSig, certUsage, ctx->tc_warn_only, PR_TRUE );
1875 return status == SECSuccess ? 0 : -1;
1879 tlsm_get_client_auth_data( void *arg, PRFileDesc *fd,
1880 CERTDistNames *caNames, CERTCertificate **pRetCert,
1881 SECKEYPrivateKey **pRetKey )
1883 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1886 *pRetCert = CERT_DupCertificate( ctx->tc_certificate );
1889 *pRetKey = SECKEY_CopyPrivateKey( ctx->tc_private_key );
1895 * ctx must have a tc_model that is valid
1898 tlsm_clientauth_init( tlsm_ctx *ctx )
1900 SECStatus status = SECFailure;
1904 saveval = ctx->tc_warn_only;
1905 ctx->tc_warn_only = PR_TRUE;
1906 rc = tlsm_find_and_verify_cert_key(ctx);
1907 ctx->tc_warn_only = saveval;
1909 Debug( LDAP_DEBUG_ANY,
1910 "TLS: error: unable to set up client certificate authentication for "
1911 "certificate named %s\n", tlsm_ctx_subject_name(ctx), 0, 0 );
1915 status = SSL_GetClientAuthDataHook( ctx->tc_model,
1916 tlsm_get_client_auth_data,
1919 return ( status == SECSuccess ? 0 : -1 );
1923 * Tear down the TLS subsystem. Should only be called once.
1926 tlsm_destroy( void )
1928 #ifdef LDAP_R_COMPILE
1929 ldap_pvt_thread_mutex_destroy( &tlsm_ctx_count_mutex );
1930 ldap_pvt_thread_mutex_destroy( &tlsm_init_mutex );
1931 ldap_pvt_thread_mutex_destroy( &tlsm_pem_mutex );
1935 static struct ldaptls *
1936 tlsm_copy_config ( const struct ldaptls *config )
1938 struct ldaptls *copy;
1942 copy = LDAP_MALLOC( sizeof( *copy ) );
1946 memset( copy, 0, sizeof( *copy ) );
1948 if ( config->lt_certfile )
1949 copy->lt_certfile = LDAP_STRDUP( config->lt_certfile );
1950 if ( config->lt_keyfile )
1951 copy->lt_keyfile = LDAP_STRDUP( config->lt_keyfile );
1952 if ( config->lt_dhfile )
1953 copy->lt_dhfile = LDAP_STRDUP( config->lt_dhfile );
1954 if ( config->lt_cacertfile )
1955 copy->lt_cacertfile = LDAP_STRDUP( config->lt_cacertfile );
1956 if ( config->lt_cacertdir )
1957 copy->lt_cacertdir = LDAP_STRDUP( config->lt_cacertdir );
1958 if ( config->lt_ciphersuite )
1959 copy->lt_ciphersuite = LDAP_STRDUP( config->lt_ciphersuite );
1960 if ( config->lt_crlfile )
1961 copy->lt_crlfile = LDAP_STRDUP( config->lt_crlfile );
1962 if ( config->lt_randfile )
1963 copy->lt_randfile = LDAP_STRDUP( config->lt_randfile );
1965 copy->lt_protocol_min = config->lt_protocol_min;
1971 tlsm_free_config ( struct ldaptls *config )
1975 if ( config->lt_certfile )
1976 LDAP_FREE( config->lt_certfile );
1977 if ( config->lt_keyfile )
1978 LDAP_FREE( config->lt_keyfile );
1979 if ( config->lt_dhfile )
1980 LDAP_FREE( config->lt_dhfile );
1981 if ( config->lt_cacertfile )
1982 LDAP_FREE( config->lt_cacertfile );
1983 if ( config->lt_cacertdir )
1984 LDAP_FREE( config->lt_cacertdir );
1985 if ( config->lt_ciphersuite )
1986 LDAP_FREE( config->lt_ciphersuite );
1987 if ( config->lt_crlfile )
1988 LDAP_FREE( config->lt_crlfile );
1989 if ( config->lt_randfile )
1990 LDAP_FREE( config->lt_randfile );
1992 LDAP_FREE( config );
1996 tlsm_ctx_new ( struct ldapoptions *lo )
2000 ctx = LDAP_MALLOC( sizeof (*ctx) );
2003 #ifdef LDAP_R_COMPILE
2004 ldap_pvt_thread_mutex_init( &ctx->tc_refmutex );
2006 LDAP_MUTEX_LOCK( &tlsm_ctx_count_mutex );
2007 ctx->tc_unique = tlsm_ctx_count++;
2008 LDAP_MUTEX_UNLOCK( &tlsm_ctx_count_mutex );
2009 ctx->tc_config = NULL; /* populated later by tlsm_ctx_init */
2010 ctx->tc_certdb = NULL;
2011 ctx->tc_certdb_slot = NULL;
2012 ctx->tc_certificate = NULL;
2013 ctx->tc_private_key = NULL;
2014 ctx->tc_pin_file = NULL;
2015 ctx->tc_model = NULL;
2016 memset(&ctx->tc_callonce, 0, sizeof(ctx->tc_callonce));
2017 ctx->tc_require_cert = lo->ldo_tls_require_cert;
2018 ctx->tc_verify_cert = PR_FALSE;
2019 ctx->tc_using_pem = PR_FALSE;
2020 #ifdef HAVE_NSS_INITCONTEXT
2021 ctx->tc_initctx = NULL;
2022 #endif /* HAVE_NSS_INITCONTEXT */
2023 ctx->tc_pem_objs = NULL;
2024 ctx->tc_n_pem_objs = 0;
2025 ctx->tc_warn_only = PR_FALSE;
2027 return (tls_ctx *)ctx;
2031 tlsm_ctx_ref( tls_ctx *ctx )
2033 tlsm_ctx *c = (tlsm_ctx *)ctx;
2034 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2036 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2040 tlsm_ctx_free ( tls_ctx *ctx )
2042 tlsm_ctx *c = (tlsm_ctx *)ctx;
2047 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2048 refcount = --c->tc_refcnt;
2049 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2053 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
2055 PR_Close( c->tc_model );
2056 if ( c->tc_certificate )
2057 CERT_DestroyCertificate( c->tc_certificate );
2058 if ( c->tc_private_key )
2059 SECKEY_DestroyPrivateKey( c->tc_private_key );
2060 c->tc_certdb = NULL; /* if not the default, may have to clean up */
2061 if ( c->tc_certdb_slot ) {
2062 if ( SECMOD_CloseUserDB( c->tc_certdb_slot ) ) {
2063 PRErrorCode errcode = PR_GetError();
2064 Debug( LDAP_DEBUG_ANY,
2065 "TLS: could not close certdb slot - error %d:%s.\n",
2066 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
2069 PL_strfree( c->tc_pin_file );
2070 c->tc_pin_file = NULL;
2071 tlsm_free_pem_objs( c );
2072 #ifdef HAVE_NSS_INITCONTEXT
2073 if ( c->tc_initctx ) {
2074 if ( NSS_ShutdownContext( c->tc_initctx ) ) {
2075 PRErrorCode errcode = PR_GetError();
2076 Debug( LDAP_DEBUG_ANY,
2077 "TLS: could not shutdown NSS - error %d:%s.\n",
2078 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
2081 c->tc_initctx = NULL;
2082 #endif /* HAVE_NSS_INITCONTEXT */
2083 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
2084 #ifdef LDAP_R_COMPILE
2085 ldap_pvt_thread_mutex_destroy( &c->tc_refmutex );
2089 tlsm_free_config( c->tc_config );
2095 * initialize a new TLS context
2098 tlsm_ctx_init( struct ldapoptions *lo, struct ldaptls *lt, int is_server )
2100 tlsm_ctx *ctx = (tlsm_ctx *)lo->ldo_tls_ctx;
2101 ctx->tc_config = tlsm_copy_config( lt );
2102 ctx->tc_is_server = is_server;
2107 /* returns true if the given string looks like
2108 "tokenname" ":" "certnickname"
2109 This is true if there is a ':' colon character
2110 in the string and the colon is not the first
2111 or the last character in the string
2114 tlsm_is_tokenname_certnick( const char *certfile )
2117 const char *ptr = PL_strchr( certfile, ':' );
2118 return ptr && (ptr != certfile) && (*(ptr+1));
2124 tlsm_deferred_ctx_init( void *arg )
2126 tlsm_ctx *ctx = (tlsm_ctx *)arg;
2127 PRBool sslv2 = PR_FALSE;
2128 PRBool sslv3 = PR_TRUE;
2129 PRBool tlsv1 = PR_TRUE;
2130 PRBool request_cert = PR_FALSE;
2131 PRInt32 require_cert = PR_FALSE;
2135 if ( tlsm_deferred_init( ctx ) ) {
2136 Debug( LDAP_DEBUG_ANY,
2137 "TLS: could not perform TLS system initialization.\n",
2142 ctx->tc_certdb = CERT_GetDefaultCertDB(); /* If there is ever a per-context db, change this */
2144 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2146 ctx->tc_model = SSL_ImportFD( NULL, fd );
2149 if ( !ctx->tc_model ) {
2150 PRErrorCode err = PR_GetError();
2151 Debug( LDAP_DEBUG_ANY,
2152 "TLS: could perform TLS socket I/O layer initialization - error %d:%s.\n",
2153 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2161 if ( SSL_SetPKCS11PinArg(ctx->tc_model, ctx) ) {
2162 Debug( LDAP_DEBUG_ANY,
2163 "TLS: could not set pin prompt argument\n", 0, 0, 0);
2167 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_SECURITY, PR_TRUE ) ) {
2168 Debug( LDAP_DEBUG_ANY,
2169 "TLS: could not set secure mode on.\n",
2174 lt = ctx->tc_config;
2176 /* default is sslv3 and tlsv1 */
2177 if ( lt->lt_protocol_min ) {
2178 if ( lt->lt_protocol_min > LDAP_OPT_X_TLS_PROTOCOL_SSL3 ) {
2180 } else if ( lt->lt_protocol_min <= LDAP_OPT_X_TLS_PROTOCOL_SSL2 ) {
2182 Debug( LDAP_DEBUG_ANY,
2183 "TLS: warning: minimum TLS protocol level set to "
2184 "include SSLv2 - SSLv2 is insecure - do not use\n", 0, 0, 0 );
2187 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL2, sslv2 ) ) {
2188 Debug( LDAP_DEBUG_ANY,
2189 "TLS: could not set SSLv2 mode on.\n",
2193 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL3, sslv3 ) ) {
2194 Debug( LDAP_DEBUG_ANY,
2195 "TLS: could not set SSLv3 mode on.\n",
2199 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_TLS, tlsv1 ) ) {
2200 Debug( LDAP_DEBUG_ANY,
2201 "TLS: could not set TLSv1 mode on.\n",
2206 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_CLIENT, !ctx->tc_is_server ) ) {
2207 Debug( LDAP_DEBUG_ANY,
2208 "TLS: could not set handshake as client.\n",
2212 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_SERVER, ctx->tc_is_server ) ) {
2213 Debug( LDAP_DEBUG_ANY,
2214 "TLS: could not set handshake as server.\n",
2219 if ( lt->lt_ciphersuite ) {
2220 if ( tlsm_parse_ciphers( ctx, lt->lt_ciphersuite ) ) {
2221 Debug( LDAP_DEBUG_ANY,
2222 "TLS: could not set cipher list %s.\n",
2223 lt->lt_ciphersuite, 0, 0 );
2226 } else if ( tlsm_parse_ciphers( ctx, "DEFAULT" ) ) {
2227 Debug( LDAP_DEBUG_ANY,
2228 "TLS: could not set cipher list DEFAULT.\n",
2233 if ( !ctx->tc_require_cert ) {
2234 ctx->tc_verify_cert = PR_FALSE;
2235 } else if ( !ctx->tc_is_server ) {
2236 request_cert = PR_TRUE;
2237 require_cert = SSL_REQUIRE_NO_ERROR;
2238 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
2239 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
2240 require_cert = SSL_REQUIRE_ALWAYS;
2242 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW )
2243 ctx->tc_verify_cert = PR_TRUE;
2244 } else { /* server */
2245 /* server does not request certs by default */
2246 /* if allow - client may send cert, server will ignore if errors */
2247 /* if try - client may send cert, server will error if bad cert */
2248 /* if hard or demand - client must send cert, server will error if bad cert */
2249 request_cert = PR_TRUE;
2250 require_cert = SSL_REQUIRE_NO_ERROR;
2251 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
2252 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
2253 require_cert = SSL_REQUIRE_ALWAYS;
2255 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW ) {
2256 ctx->tc_verify_cert = PR_TRUE;
2258 ctx->tc_warn_only = PR_TRUE;
2262 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUEST_CERTIFICATE, request_cert ) ) {
2263 Debug( LDAP_DEBUG_ANY,
2264 "TLS: could not set request certificate mode.\n",
2269 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUIRE_CERTIFICATE, require_cert ) ) {
2270 Debug( LDAP_DEBUG_ANY,
2271 "TLS: could not set require certificate mode.\n",
2276 /* set up our cert and key, if any */
2277 if ( lt->lt_certfile ) {
2278 /* if using the PEM module, load the PEM file specified by lt_certfile */
2279 /* otherwise, assume this is the name of a cert already in the db */
2280 if ( ctx->tc_using_pem ) {
2281 /* this sets ctx->tc_certificate to the correct value */
2282 int rc = tlsm_add_cert_from_file( ctx, lt->lt_certfile, PR_FALSE );
2289 if ( tlsm_is_tokenname_certnick( lt->lt_certfile )) {
2290 /* assume already in form tokenname:certnickname */
2291 tmp_certname = PL_strdup( lt->lt_certfile );
2292 } else if ( ctx->tc_certdb_slot ) {
2293 tmp_certname = PR_smprintf( TLSM_CERTDB_DESC_FMT ":%s", ctx->tc_unique, lt->lt_certfile );
2295 tmp_certname = PR_smprintf( "%s", lt->lt_certfile );
2298 ctx->tc_certificate = PK11_FindCertFromNickname( tmp_certname, SSL_RevealPinArg( ctx->tc_model ) );
2299 PR_smprintf_free( tmp_certname );
2301 if ( !ctx->tc_certificate ) {
2302 PRErrorCode errcode = PR_GetError();
2303 Debug( LDAP_DEBUG_ANY,
2304 "TLS: error: the certificate '%s' could not be found in the database - error %d:%s.\n",
2305 lt->lt_certfile, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
2311 if ( lt->lt_keyfile ) {
2312 /* if using the PEM module, load the PEM file specified by lt_keyfile */
2313 /* otherwise, assume this is the pininfo for the key */
2314 if ( ctx->tc_using_pem ) {
2315 int rc = tlsm_add_key_from_file( ctx, lt->lt_keyfile );
2320 PL_strfree( ctx->tc_pin_file );
2321 ctx->tc_pin_file = PL_strdup( lt->lt_keyfile );
2325 /* Set up callbacks for use by clients */
2326 if ( !ctx->tc_is_server ) {
2327 if ( SSL_OptionSet( ctx->tc_model, SSL_NO_CACHE, PR_TRUE ) != SECSuccess ) {
2328 PRErrorCode err = PR_GetError();
2329 Debug( LDAP_DEBUG_ANY,
2330 "TLS: error: could not set nocache option for moznss - error %d:%s\n",
2331 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2335 if ( SSL_BadCertHook( ctx->tc_model, tlsm_bad_cert_handler, ctx ) != SECSuccess ) {
2336 PRErrorCode err = PR_GetError();
2337 Debug( LDAP_DEBUG_ANY,
2338 "TLS: error: could not set bad cert handler for moznss - error %d:%s\n",
2339 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2344 since a cert has been specified, assume the client wants to do cert auth
2346 if ( ctx->tc_certificate ) {
2347 if ( tlsm_clientauth_init( ctx ) ) {
2348 Debug( LDAP_DEBUG_ANY,
2349 "TLS: error: unable to set up client certificate authentication using '%s'\n",
2350 tlsm_ctx_subject_name(ctx), 0, 0 );
2354 } else { /* set up secure server */
2358 /* must have a certificate for the server to use */
2359 if ( !ctx->tc_certificate ) {
2360 Debug( LDAP_DEBUG_ANY,
2361 "TLS: error: no server certificate: must specify a certificate for the server to use\n",
2366 if ( tlsm_find_and_verify_cert_key( ctx ) ) {
2367 Debug( LDAP_DEBUG_ANY,
2368 "TLS: error: unable to find and verify server's cert and key for certificate %s\n",
2369 tlsm_ctx_subject_name(ctx), 0, 0 );
2373 /* configure the socket to be a secure server socket */
2374 certKEA = NSS_FindCertKEAType( ctx->tc_certificate );
2375 status = SSL_ConfigSecureServer( ctx->tc_model, ctx->tc_certificate, ctx->tc_private_key, certKEA );
2377 if ( SECSuccess != status ) {
2378 PRErrorCode err = PR_GetError();
2379 Debug( LDAP_DEBUG_ANY,
2380 "TLS: error: unable to configure secure server using certificate '%s' - error %d:%s\n",
2381 tlsm_ctx_subject_name(ctx), err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) );
2386 /* Callback for authenticating certificate */
2387 if ( SSL_AuthCertificateHook( ctx->tc_model, tlsm_auth_cert_handler,
2388 ctx ) != SECSuccess ) {
2389 PRErrorCode err = PR_GetError();
2390 Debug( LDAP_DEBUG_ANY,
2391 "TLS: error: could not set auth cert handler for moznss - error %d:%s\n",
2392 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2396 if ( SSL_HandshakeCallback( ctx->tc_model, tlsm_handshake_complete_cb, ctx ) ) {
2397 PRErrorCode err = PR_GetError();
2398 Debug( LDAP_DEBUG_ANY,
2399 "TLS: error: could not set handshake callback for moznss - error %d:%s\n",
2400 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2404 tlsm_free_config( ctx->tc_config );
2405 ctx->tc_config = NULL;
2411 tlsm_session *session;
2412 Sockbuf_IO_Desc *sbiod;
2413 /* there seems to be no portable way to determine if the
2414 sockbuf sd has been set to nonblocking mode - the
2415 call to ber_pvt_socket_set_nonblock() takes place
2416 before the tls socket is set up, so we cannot
2417 intercept that call either.
2418 On systems where fcntl is available, we can just
2419 F_GETFL and test for O_NONBLOCK. On other systems,
2420 we will just see if the IO op returns EAGAIN or EWOULDBLOCK,
2421 and just set this flag */
2424 * NSS tries hard to be backwards compatible with SSLv2 clients, or
2425 * clients that send an SSLv2 client hello. This message is not
2426 * tagged in any way, so NSS has no way to know if the incoming
2427 * message is a valid SSLv2 client hello or just some bogus data
2428 * (or cleartext LDAP). We store the first byte read from the
2429 * client here. The most common case will be a client sending
2430 * LDAP data instead of SSL encrypted LDAP data. This can happen,
2431 * for example, if using ldapsearch -Z - if the starttls fails,
2432 * the client will fallback to plain cleartext LDAP. So if we
2433 * see that the firstbyte is a valid LDAP tag, we can be
2434 * pretty sure this is happening.
2438 * NSS doesn't return SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE, etc.
2439 * when it is blocked, so we have to set a flag in the wrapped send
2440 * and recv calls that tells us what operation NSS was last blocked
2444 #define TLSM_WRITE 2
2448 static struct tls_data *
2449 tlsm_get_pvt_tls_data( PRFileDesc *fd )
2458 myfd = PR_GetIdentitiesLayer( fd, tlsm_layer_id );
2464 p = (struct tls_data *)myfd->secret;
2470 tlsm_is_non_ssl_message( PRFileDesc *fd, ber_tag_t *thebyte )
2475 *thebyte = LBER_DEFAULT;
2478 p = tlsm_get_pvt_tls_data( fd );
2479 if ( p == NULL || p->sbiod == NULL ) {
2483 if ( p->firsttag == LBER_SEQUENCE ) {
2485 *thebyte = p->firsttag;
2493 static tls_session *
2494 tlsm_session_new ( tls_ctx * ctx, int is_server )
2496 tlsm_ctx *c = (tlsm_ctx *)ctx;
2497 tlsm_session *session;
2502 c->tc_is_server = is_server;
2503 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
2504 status = PR_CallOnceWithArg( &c->tc_callonce, tlsm_deferred_ctx_init, c );
2505 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
2506 if ( PR_SUCCESS != status ) {
2507 PRErrorCode err = PR_GetError();
2508 Debug( LDAP_DEBUG_ANY,
2509 "TLS: error: could not initialize moznss security context - error %d:%s\n",
2510 err, PR_ErrorToString(err, PR_LANGUAGE_I_DEFAULT), NULL );
2514 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2519 session = SSL_ImportFD( c->tc_model, fd );
2525 rc = SSL_ResetHandshake( session, is_server );
2527 PRErrorCode err = PR_GetError();
2528 Debug( LDAP_DEBUG_TRACE,
2529 "TLS: error: new session - reset handshake failure %d - error %d:%s\n",
2531 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2533 PR_Close( session );
2537 return (tls_session *)session;
2541 tlsm_session_accept_or_connect( tls_session *session, int is_accept )
2543 tlsm_session *s = (tlsm_session *)session;
2545 const char *op = is_accept ? "accept" : "connect";
2548 LDAP_MUTEX_LOCK( &tlsm_pem_mutex );
2550 rc = SSL_ForceHandshake( s );
2552 LDAP_MUTEX_UNLOCK( &tlsm_pem_mutex );
2555 PRErrorCode err = PR_GetError();
2557 if ( err == PR_WOULD_BLOCK_ERROR ) {
2558 ber_tag_t thetag = LBER_DEFAULT;
2559 /* see if we are blocked because of a bogus packet */
2560 if ( tlsm_is_non_ssl_message( s, &thetag ) ) { /* see if we received a non-SSL message */
2561 Debug( LDAP_DEBUG_ANY,
2562 "TLS: error: %s - error - received non-SSL message [0x%x]\n",
2563 op, (unsigned int)thetag, 0 );
2564 /* reset error to something more descriptive */
2565 PR_SetError( SSL_ERROR_RX_MALFORMED_HELLO_REQUEST, EPROTO );
2568 Debug( LDAP_DEBUG_ANY,
2569 "TLS: error: %s - force handshake failure: errno %d - moznss error %d\n",
2577 tlsm_session_accept( tls_session *session )
2579 return tlsm_session_accept_or_connect( session, 1 );
2583 tlsm_session_connect( LDAP *ld, tls_session *session )
2585 return tlsm_session_accept_or_connect( session, 0 );
2589 tlsm_session_upflags( Sockbuf *sb, tls_session *session, int rc )
2591 int prerror = PR_GetError();
2593 if ( ( prerror == PR_PENDING_INTERRUPT_ERROR ) || ( prerror == PR_WOULD_BLOCK_ERROR ) ) {
2594 tlsm_session *s = (tlsm_session *)session;
2595 struct tls_data *p = tlsm_get_pvt_tls_data( s );
2597 if ( p && ( p->io_flag == TLSM_READ ) ) {
2598 sb->sb_trans_needs_read = 1;
2600 } else if ( p && ( p->io_flag == TLSM_WRITE ) ) {
2601 sb->sb_trans_needs_write = 1;
2610 tlsm_session_errmsg( tls_session *sess, int rc, char *buf, size_t len )
2613 int prerror = PR_GetError();
2615 i = PR_GetErrorTextLength();
2617 char *msg = LDAP_MALLOC( i+1 );
2618 PR_GetErrorText( msg );
2619 memcpy( buf, msg, len );
2622 PR_GetErrorText( buf );
2623 } else if ( prerror ) {
2624 i = PR_snprintf( buf, len, "TLS error %d:%s",
2625 prerror, PR_ErrorToString( prerror, PR_LANGUAGE_I_DEFAULT ) );
2628 return ( i > 0 ) ? buf : NULL;
2632 tlsm_session_my_dn( tls_session *session, struct berval *der_dn )
2634 tlsm_session *s = (tlsm_session *)session;
2635 CERTCertificate *cert;
2637 cert = SSL_LocalCertificate( s );
2638 if (!cert) return LDAP_INVALID_CREDENTIALS;
2640 der_dn->bv_val = (char *)cert->derSubject.data;
2641 der_dn->bv_len = cert->derSubject.len;
2642 CERT_DestroyCertificate( cert );
2647 tlsm_session_peer_dn( tls_session *session, struct berval *der_dn )
2649 tlsm_session *s = (tlsm_session *)session;
2650 CERTCertificate *cert;
2652 cert = SSL_PeerCertificate( s );
2653 if (!cert) return LDAP_INVALID_CREDENTIALS;
2655 der_dn->bv_val = (char *)cert->derSubject.data;
2656 der_dn->bv_len = cert->derSubject.len;
2657 CERT_DestroyCertificate( cert );
2661 /* what kind of hostname were we given? */
2667 tlsm_session_chkhost( LDAP *ld, tls_session *session, const char *name_in )
2669 tlsm_session *s = (tlsm_session *)session;
2670 CERTCertificate *cert;
2671 const char *name, *domain = NULL, *ptr;
2672 int ret, ntype = IS_DNS, nlen, dlen;
2673 #ifdef LDAP_PF_INET6
2674 struct in6_addr addr;
2676 struct in_addr addr;
2681 if( ldap_int_hostname &&
2682 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
2684 name = ldap_int_hostname;
2688 nlen = strlen( name );
2690 cert = SSL_PeerCertificate( s );
2692 Debug( LDAP_DEBUG_ANY,
2693 "TLS: unable to get peer certificate.\n",
2695 /* if this was a fatal condition, things would have
2696 * aborted long before now.
2698 return LDAP_SUCCESS;
2701 #ifdef LDAP_PF_INET6
2702 if (inet_pton(AF_INET6, name, &addr)) {
2706 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
2707 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
2709 if (ntype == IS_DNS ) {
2710 domain = strchr( name, '.' );
2712 dlen = nlen - ( domain - name );
2715 ret = LDAP_LOCAL_ERROR;
2717 rv = CERT_FindCertExtension( cert, SEC_OID_X509_SUBJECT_ALT_NAME,
2719 if ( rv == SECSuccess && altname.data ) {
2721 CERTGeneralName *names, *cur;
2723 arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
2725 ret = LDAP_NO_MEMORY;
2729 names = cur = CERT_DecodeAltNameExtension(arena, &altname);
2738 if ( !cur->name.other.len ) continue;
2740 host = (char *)cur->name.other.data;
2741 hlen = cur->name.other.len;
2743 if ( cur->type == certDNSName ) {
2744 if ( ntype != IS_DNS ) continue;
2746 /* is this an exact match? */
2747 if ( nlen == hlen && !strncasecmp( name, host, nlen )) {
2752 /* is this a wildcard match? */
2753 if ( domain && host[0] == '*' && host[1] == '.' &&
2754 dlen == hlen-1 && !strncasecmp( domain, host+1, dlen )) {
2758 } else if ( cur->type == certIPAddress ) {
2759 if ( ntype == IS_DNS ) continue;
2761 #ifdef LDAP_PF_INET6
2762 if (ntype == IS_IP6 && hlen != sizeof(struct in6_addr)) {
2766 if (ntype == IS_IP4 && hlen != sizeof(struct in_addr)) {
2769 if (!memcmp(host, &addr, hlen)) {
2774 } while (( cur = CERT_GetNextGeneralName( cur )) != names );
2776 PORT_FreeArena( arena, PR_FALSE );
2777 SECITEM_FreeItem( &altname, PR_FALSE );
2779 /* no altnames matched, try the CN */
2780 if ( ret != LDAP_SUCCESS ) {
2781 /* find the last CN */
2782 CERTRDN *rdn, **rdns;
2783 CERTAVA *lastava = NULL;
2787 rdns = cert->subject.rdns;
2788 while ( rdns && ( rdn = *rdns++ )) {
2789 CERTAVA *ava, **avas = rdn->avas;
2790 while ( avas && ( ava = *avas++ )) {
2791 if ( CERT_GetAVATag( ava ) == SEC_OID_AVA_COMMON_NAME )
2796 SECItem *av = CERT_DecodeAVAValue( &lastava->value );
2798 if ( av->len == nlen && !strncasecmp( name, (char *)av->data, nlen )) {
2800 } else if ( av->data[0] == '*' && av->data[1] == '.' &&
2801 domain && dlen == av->len - 1 && !strncasecmp( domain,
2802 (char *)(av->data+1), dlen )) {
2806 if ( len >= sizeof(buf) )
2807 len = sizeof(buf)-1;
2808 memcpy( buf, av->data, len );
2811 SECITEM_FreeItem( av, PR_TRUE );
2814 if ( ret != LDAP_SUCCESS ) {
2815 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
2816 "common name in certificate (%s).\n",
2818 ret = LDAP_CONNECT_ERROR;
2819 if ( ld->ld_error ) {
2820 LDAP_FREE( ld->ld_error );
2822 ld->ld_error = LDAP_STRDUP(
2823 _("TLS: hostname does not match CN in peer certificate"));
2828 CERT_DestroyCertificate( cert );
2833 tlsm_session_strength( tls_session *session )
2835 tlsm_session *s = (tlsm_session *)session;
2838 rc = SSL_SecurityStatus( s, NULL, NULL, NULL, &keySize,
2840 return rc ? 0 : keySize;
2844 tlsm_session_unique( tls_session *sess, struct berval *buf, int is_server)
2846 /* Need upstream support https://bugzilla.mozilla.org/show_bug.cgi?id=563276 */
2850 /* Yet again, we're pasting in glue that MozNSS ought to provide itself. */
2855 { "SSLv2", SSL_LIBRARY_VERSION_2 },
2856 { "SSLv3", SSL_LIBRARY_VERSION_3_0 },
2857 { "TLSv1", SSL_LIBRARY_VERSION_TLS_1_0 },
2858 { "TLSv1.1", SSL_LIBRARY_VERSION_TLS_1_1 },
2863 tlsm_session_version( tls_session *sess )
2865 tlsm_session *s = (tlsm_session *)sess;
2866 SSLChannelInfo info;
2868 rc = SSL_GetChannelInfo( s, &info, sizeof( info ));
2871 for (i=0; pvers[i].name; i++)
2872 if (pvers[i].num == info.protocolVersion)
2873 return pvers[i].name;
2879 tlsm_session_cipher( tls_session *sess )
2881 tlsm_session *s = (tlsm_session *)sess;
2882 SSLChannelInfo info;
2884 rc = SSL_GetChannelInfo( s, &info, sizeof( info ));
2886 SSLCipherSuiteInfo csinfo;
2887 rc = SSL_GetCipherSuiteInfo( info.cipherSuite, &csinfo, sizeof( csinfo ));
2889 return csinfo.cipherSuiteName;
2895 tlsm_session_peercert( tls_session *sess, struct berval *der )
2897 tlsm_session *s = (tlsm_session *)sess;
2898 CERTCertificate *cert;
2899 cert = SSL_PeerCertificate( s );
2902 der->bv_len = cert->derCert.len;
2903 der->bv_val = LDAP_MALLOC( der->bv_len );
2906 memcpy( der->bv_val, cert->derCert.data, der->bv_len );
2911 * TLS support for LBER Sockbufs
2914 static PRStatus PR_CALLBACK
2915 tlsm_PR_Close(PRFileDesc *fd)
2917 int rc = PR_SUCCESS;
2919 /* we don't need to actually close anything here, just
2920 pop our io layer off the stack */
2921 fd->secret = NULL; /* must have been freed before calling PR_Close */
2923 fd = PR_PopIOLayer( fd, tlsm_layer_id );
2924 /* if we are not the last layer, pass the close along */
2929 rc = fd->methods->close( fd );
2932 /* we are the last layer - just call our dtor */
2939 static PRStatus PR_CALLBACK
2940 tlsm_PR_Shutdown(PRFileDesc *fd, PRShutdownHow how)
2942 int rc = PR_SUCCESS;
2945 rc = PR_Shutdown( fd->lower, how );
2951 static int PR_CALLBACK
2952 tlsm_PR_Recv(PRFileDesc *fd, void *buf, PRInt32 len, PRIntn flags,
2953 PRIntervalTime timeout)
2958 if ( buf == NULL || len <= 0 ) return 0;
2960 p = tlsm_get_pvt_tls_data( fd );
2962 if ( p == NULL || p->sbiod == NULL ) {
2966 rc = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
2968 tlsm_map_error( errno );
2969 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2970 p->nonblock = PR_TRUE; /* fd is using non-blocking io */
2971 } else if ( errno ) { /* real error */
2972 Debug( LDAP_DEBUG_TRACE,
2973 "TLS: error: tlsm_PR_Recv returned %d - error %d:%s\n",
2974 rc, errno, STRERROR(errno) );
2976 } else if ( ( rc > 0 ) && ( len > 0 ) && ( p->firsttag == LBER_DEFAULT ) ) {
2977 p->firsttag = (ber_tag_t)*((char *)buf);
2979 p->io_flag = TLSM_READ;
2984 static int PR_CALLBACK
2985 tlsm_PR_Send(PRFileDesc *fd, const void *buf, PRInt32 len, PRIntn flags,
2986 PRIntervalTime timeout)
2991 if ( buf == NULL || len <= 0 ) return 0;
2993 p = tlsm_get_pvt_tls_data( fd );
2995 if ( p == NULL || p->sbiod == NULL ) {
2999 rc = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
3001 tlsm_map_error( errno );
3002 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
3003 p->nonblock = PR_TRUE;
3004 } else if ( errno ) { /* real error */
3005 Debug( LDAP_DEBUG_TRACE,
3006 "TLS: error: tlsm_PR_Send returned %d - error %d:%s\n",
3007 rc, errno, STRERROR(errno) );
3010 p->io_flag = TLSM_WRITE;
3015 static int PR_CALLBACK
3016 tlsm_PR_Read(PRFileDesc *fd, void *buf, PRInt32 len)
3018 return tlsm_PR_Recv( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3021 static int PR_CALLBACK
3022 tlsm_PR_Write(PRFileDesc *fd, const void *buf, PRInt32 len)
3024 return tlsm_PR_Send( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3027 static PRStatus PR_CALLBACK
3028 tlsm_PR_GetPeerName(PRFileDesc *fd, PRNetAddr *addr)
3033 p = tlsm_get_pvt_tls_data( fd );
3035 if ( p == NULL || p->sbiod == NULL ) {
3038 len = sizeof(PRNetAddr);
3039 return getpeername( p->sbiod->sbiod_sb->sb_fd, (struct sockaddr *)addr, &len );
3042 static PRStatus PR_CALLBACK
3043 tlsm_PR_GetSocketOption(PRFileDesc *fd, PRSocketOptionData *data)
3046 p = tlsm_get_pvt_tls_data( fd );
3048 if ( p == NULL || data == NULL ) {
3052 /* only the nonblocking option is supported at this time
3053 MozNSS SSL code needs it */
3054 if ( data->option != PR_SockOpt_Nonblocking ) {
3055 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3059 int flags = fcntl( p->sbiod->sbiod_sb->sb_fd, F_GETFL );
3060 data->value.non_blocking = (flags & O_NONBLOCK) ? PR_TRUE : PR_FALSE;
3062 data->value.non_blocking = p->nonblock;
3067 static PRStatus PR_CALLBACK
3070 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3074 static PRFileDesc * PR_CALLBACK
3077 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3081 static PRInt16 PR_CALLBACK
3084 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3088 static PRInt32 PR_CALLBACK
3091 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3095 static PRInt64 PR_CALLBACK
3100 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3105 static const PRIOMethods tlsm_PR_methods = {
3107 tlsm_PR_Close, /* close */
3108 tlsm_PR_Read, /* read */
3109 tlsm_PR_Write, /* write */
3110 tlsm_PR_i32_unimp, /* available */
3111 tlsm_PR_i64_unimp, /* available64 */
3112 tlsm_PR_prs_unimp, /* fsync */
3113 tlsm_PR_i32_unimp, /* seek */
3114 tlsm_PR_i64_unimp, /* seek64 */
3115 tlsm_PR_prs_unimp, /* fileInfo */
3116 tlsm_PR_prs_unimp, /* fileInfo64 */
3117 tlsm_PR_i32_unimp, /* writev */
3118 tlsm_PR_prs_unimp, /* connect */
3119 tlsm_PR_pfd_unimp, /* accept */
3120 tlsm_PR_prs_unimp, /* bind */
3121 tlsm_PR_prs_unimp, /* listen */
3122 (PRShutdownFN)tlsm_PR_Shutdown, /* shutdown */
3123 tlsm_PR_Recv, /* recv */
3124 tlsm_PR_Send, /* send */
3125 tlsm_PR_i32_unimp, /* recvfrom */
3126 tlsm_PR_i32_unimp, /* sendto */
3127 (PRPollFN)tlsm_PR_i16_unimp, /* poll */
3128 tlsm_PR_i32_unimp, /* acceptread */
3129 tlsm_PR_i32_unimp, /* transmitfile */
3130 tlsm_PR_prs_unimp, /* getsockname */
3131 tlsm_PR_GetPeerName, /* getpeername */
3132 tlsm_PR_i32_unimp, /* getsockopt OBSOLETE */
3133 tlsm_PR_i32_unimp, /* setsockopt OBSOLETE */
3134 tlsm_PR_GetSocketOption, /* getsocketoption */
3135 tlsm_PR_i32_unimp, /* setsocketoption */
3136 tlsm_PR_i32_unimp, /* Send a (partial) file with header/trailer*/
3137 (PRConnectcontinueFN)tlsm_PR_prs_unimp, /* connectcontinue */
3138 tlsm_PR_i32_unimp, /* reserved for future use */
3139 tlsm_PR_i32_unimp, /* reserved for future use */
3140 tlsm_PR_i32_unimp, /* reserved for future use */
3141 tlsm_PR_i32_unimp /* reserved for future use */
3145 * Initialize TLS subsystem. Should be called only once.
3146 * See tlsm_deferred_init for the bulk of the init process
3151 char *nofork = PR_GetEnv( "NSS_STRICT_NOFORK" );
3155 tlsm_layer_id = PR_GetUniqueIdentity( "OpenLDAP" );
3158 * There are some applications that acquire a crypto context in the parent process
3159 * and expect that crypto context to work after a fork(). This does not work
3160 * with NSS using strict PKCS11 compliance mode. We set this environment
3161 * variable here to tell the software encryption module/token to allow crypto
3162 * contexts to persist across a fork(). However, if you are using some other
3163 * module or encryption device that supports and expects full PKCS11 semantics,
3164 * the only recourse is to rewrite the application with atfork() handlers to save
3165 * the crypto context in the parent and restore (and SECMOD_RestartModules) the
3166 * context in the child.
3169 /* will leak one time */
3170 char *noforkenvvar = PL_strdup( "NSS_STRICT_NOFORK=DISABLED" );
3171 PR_SetEnv( noforkenvvar );
3178 tlsm_sb_setup( Sockbuf_IO_Desc *sbiod, void *arg )
3181 tlsm_session *session = arg;
3184 assert( sbiod != NULL );
3186 p = LBER_MALLOC( sizeof( *p ) );
3191 fd = PR_GetIdentitiesLayer( session, tlsm_layer_id );
3197 fd->secret = (PRFilePrivate *)p;
3198 p->session = session;
3200 p->firsttag = LBER_DEFAULT;
3201 sbiod->sbiod_pvt = p;
3206 tlsm_sb_remove( Sockbuf_IO_Desc *sbiod )
3210 assert( sbiod != NULL );
3211 assert( sbiod->sbiod_pvt != NULL );
3213 p = (struct tls_data *)sbiod->sbiod_pvt;
3214 PR_Close( p->session );
3215 LBER_FREE( sbiod->sbiod_pvt );
3216 sbiod->sbiod_pvt = NULL;
3221 tlsm_sb_close( Sockbuf_IO_Desc *sbiod )
3225 assert( sbiod != NULL );
3226 assert( sbiod->sbiod_pvt != NULL );
3228 p = (struct tls_data *)sbiod->sbiod_pvt;
3229 PR_Shutdown( p->session, PR_SHUTDOWN_BOTH );
3234 tlsm_sb_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
3238 assert( sbiod != NULL );
3239 assert( sbiod->sbiod_pvt != NULL );
3241 p = (struct tls_data *)sbiod->sbiod_pvt;
3243 if ( opt == LBER_SB_OPT_GET_SSL ) {
3244 *((tlsm_session **)arg) = p->session;
3247 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
3248 if ( p && ( SSL_DataPending( p->session ) > 0 ) ) {
3254 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
3258 tlsm_sb_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3264 assert( sbiod != NULL );
3265 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3267 p = (struct tls_data *)sbiod->sbiod_pvt;
3269 ret = PR_Recv( p->session, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3271 err = PR_GetError();
3272 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3273 sbiod->sbiod_sb->sb_trans_needs_read = 1;
3274 sock_errset(EWOULDBLOCK);
3277 sbiod->sbiod_sb->sb_trans_needs_read = 0;
3283 tlsm_sb_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3289 assert( sbiod != NULL );
3290 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3292 p = (struct tls_data *)sbiod->sbiod_pvt;
3294 ret = PR_Send( p->session, (char *)buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3296 err = PR_GetError();
3297 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3298 sbiod->sbiod_sb->sb_trans_needs_write = 1;
3299 sock_errset(EWOULDBLOCK);
3303 sbiod->sbiod_sb->sb_trans_needs_write = 0;
3308 static Sockbuf_IO tlsm_sbio =
3310 tlsm_sb_setup, /* sbi_setup */
3311 tlsm_sb_remove, /* sbi_remove */
3312 tlsm_sb_ctrl, /* sbi_ctrl */
3313 tlsm_sb_read, /* sbi_read */
3314 tlsm_sb_write, /* sbi_write */
3315 tlsm_sb_close /* sbi_close */
3318 tls_impl ldap_int_tls_impl = {
3330 tlsm_session_connect,
3331 tlsm_session_accept,
3332 tlsm_session_upflags,
3333 tlsm_session_errmsg,
3335 tlsm_session_peer_dn,
3336 tlsm_session_chkhost,
3337 tlsm_session_strength,
3338 tlsm_session_unique,
3339 tlsm_session_version,
3340 tlsm_session_cipher,
3341 tlsm_session_peercert,
3345 #ifdef LDAP_R_COMPILE
3354 #endif /* HAVE_MOZNSS */