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 PRBool tc_verify_cert;
85 CERTCertDBHandle *tc_certdb;
88 struct ldaptls *tc_config;
91 PRCallOnceType tc_callonce;
93 char *tc_slotname; /* if using pem */
94 #ifdef HAVE_NSS_INITCONTEXT
95 NSSInitContext *tc_initctx; /* the NSS context */
97 PK11GenericObject **tc_pem_objs; /* array of objects to free */
98 int tc_n_pem_objs; /* number of objects */
99 PRBool tc_warn_only; /* only warn of errors in validation */
100 #ifdef LDAP_R_COMPILE
101 ldap_pvt_thread_mutex_t tc_refmutex;
105 typedef PRFileDesc tlsm_session;
107 static PRDescIdentity tlsm_layer_id;
109 static const PRIOMethods tlsm_PR_methods;
111 #define PEM_LIBRARY "nsspem"
112 #define PEM_MODULE "PEM"
113 /* hash files for use with cacertdir have this file name suffix */
114 #define PEM_CA_HASH_FILE_SUFFIX ".0"
115 #define PEM_CA_HASH_FILE_SUFFIX_LEN 2
117 static SECMODModule *pem_module;
119 #define DEFAULT_TOKEN_NAME "default"
120 /* sprintf format used to create token name */
121 #define TLSM_PEM_TOKEN_FMT "PEM Token #%ld"
123 static int tlsm_slot_count;
125 #define PK11_SETATTRS(x,id,v,l) (x)->type = (id); \
126 (x)->pValue=(v); (x)->ulValueLen = (l);
128 /* forward declaration */
129 static int tlsm_init( void );
131 #ifdef LDAP_R_COMPILE
133 /* it doesn't seem guaranteed that a client will call
134 tlsm_thr_init in a non-threaded context - so we have
135 to wrap the mutex creation in a prcallonce
137 static ldap_pvt_thread_mutex_t tlsm_init_mutex;
138 static ldap_pvt_thread_mutex_t tlsm_pem_mutex;
139 static PRCallOnceType tlsm_init_mutex_callonce = {0,0};
141 static PRStatus PR_CALLBACK
142 tlsm_thr_init_callonce( void )
144 if ( ldap_pvt_thread_mutex_init( &tlsm_init_mutex ) ) {
145 Debug( LDAP_DEBUG_ANY,
146 "TLS: could not create mutex for moznss initialization: %d\n", errno, 0, 0 );
150 if ( ldap_pvt_thread_mutex_init( &tlsm_pem_mutex ) ) {
151 Debug( LDAP_DEBUG_ANY,
152 "TLS: could not create mutex for PEM module: %d\n", errno, 0, 0 );
160 tlsm_thr_init( void )
162 ( void )PR_CallOnce( &tlsm_init_mutex_callonce, tlsm_thr_init_callonce );
165 #endif /* LDAP_R_COMPILE */
168 tlsm_dump_cipher_info(PRFileDesc *fd)
172 for (ii = 0; ii < SSL_NumImplementedCiphers; ++ii) {
173 PRInt32 cipher = (PRInt32)SSL_ImplementedCiphers[ii];
174 PRBool enabled = PR_FALSE;
176 SSLCipherSuiteInfo info;
179 SSL_CipherPrefGet(fd, cipher, &enabled);
181 SSL_CipherPrefGetDefault(cipher, &enabled);
183 SSL_CipherPolicyGet(cipher, &policy);
184 SSL_GetCipherSuiteInfo(cipher, &info, (PRUintn)sizeof(info));
185 Debug( LDAP_DEBUG_TRACE,
186 "TLS: cipher: %d - %s, enabled: %d, ",
187 info.cipherSuite, info.cipherSuiteName, enabled );
188 Debug( LDAP_DEBUG_TRACE,
189 "policy: %d\n", policy, 0, 0 );
195 /* Cipher definitions */
197 char *ossl_name; /* The OpenSSL cipher name */
198 int num; /* The cipher id */
199 int attr; /* cipher attributes: algorithms, etc */
200 int version; /* protocol version valid for this cipher */
201 int bits; /* bits of strength */
202 int alg_bits; /* bits of the algorithm */
203 int strength; /* LOW, MEDIUM, HIGH */
204 int enabled; /* Enabled by default? */
207 /* cipher attributes */
208 #define SSL_kRSA 0x00000001L
209 #define SSL_aRSA 0x00000002L
210 #define SSL_aDSS 0x00000004L
211 #define SSL_DSS SSL_aDSS
212 #define SSL_eNULL 0x00000008L
213 #define SSL_DES 0x00000010L
214 #define SSL_3DES 0x00000020L
215 #define SSL_RC4 0x00000040L
216 #define SSL_RC2 0x00000080L
217 #define SSL_AES 0x00000100L
218 #define SSL_MD5 0x00000200L
219 #define SSL_SHA1 0x00000400L
220 #define SSL_SHA SSL_SHA1
221 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
223 /* cipher strength */
224 #define SSL_NULL 0x00000001L
225 #define SSL_EXPORT40 0x00000002L
226 #define SSL_EXPORT56 0x00000004L
227 #define SSL_LOW 0x00000008L
228 #define SSL_MEDIUM 0x00000010L
229 #define SSL_HIGH 0x00000020L
231 #define SSL2 0x00000001L
232 #define SSL3 0x00000002L
233 /* OpenSSL treats SSL3 and TLSv1 the same */
236 /* Cipher translation */
237 static cipher_properties ciphers_def[] = {
239 {"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},
240 {"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},
241 {"RC4-MD5", SSL_EN_RC4_128_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL2, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
242 {"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},
243 {"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},
244 {"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},
247 {"RC4-MD5", SSL_RSA_WITH_RC4_128_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
248 {"RC4-SHA", SSL_RSA_WITH_RC4_128_SHA, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_SHA1, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
249 {"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},
250 {"DES-CBC-SHA", SSL_RSA_WITH_DES_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_DES|SSL_SHA1, SSL3, 56, 56, SSL_LOW, SSL_ALLOWED},
251 {"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},
252 {"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},
253 {"NULL-MD5", SSL_RSA_WITH_NULL_MD5, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_MD5, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
254 {"NULL-SHA", SSL_RSA_WITH_NULL_SHA, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_SHA1, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
257 {"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},
258 {"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},
259 {"AES128-SHA", TLS_RSA_WITH_AES_128_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 128, 128, SSL_HIGH, SSL_ALLOWED},
260 {"AES256-SHA", TLS_RSA_WITH_AES_256_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 256, 256, SSL_HIGH, SSL_ALLOWED},
263 #define ciphernum (sizeof(ciphers_def)/sizeof(cipher_properties))
265 /* given err which is the current errno, calls PR_SetError with
266 the corresponding NSPR error code */
268 tlsm_map_error(int err)
274 prError = PR_NO_ACCESS_RIGHTS_ERROR;
277 prError = PR_ADDRESS_IN_USE_ERROR;
280 prError = PR_ADDRESS_NOT_AVAILABLE_ERROR;
283 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
286 prError = PR_WOULD_BLOCK_ERROR;
289 * On QNX and Neutrino, EALREADY is defined as EBUSY.
291 #if EALREADY != EBUSY
293 prError = PR_ALREADY_INITIATED_ERROR;
297 prError = PR_BAD_DESCRIPTOR_ERROR;
301 prError = PR_IO_ERROR;
305 prError = PR_FILESYSTEM_MOUNTED_ERROR;
308 prError = PR_CONNECT_ABORTED_ERROR;
311 prError = PR_CONNECT_REFUSED_ERROR;
314 prError = PR_CONNECT_RESET_ERROR;
317 prError = PR_DEADLOCK_ERROR;
321 prError = PR_DIRECTORY_CORRUPTED_ERROR;
326 prError = PR_NO_DEVICE_SPACE_ERROR;
330 prError = PR_FILE_EXISTS_ERROR;
333 prError = PR_ACCESS_FAULT_ERROR;
336 prError = PR_FILE_TOO_BIG_ERROR;
339 prError = PR_HOST_UNREACHABLE_ERROR;
342 prError = PR_IN_PROGRESS_ERROR;
345 prError = PR_PENDING_INTERRUPT_ERROR;
348 prError = PR_INVALID_ARGUMENT_ERROR;
351 prError = PR_IO_ERROR;
354 prError = PR_IS_CONNECTED_ERROR;
357 prError = PR_IS_DIRECTORY_ERROR;
360 prError = PR_LOOP_ERROR;
363 prError = PR_PROC_DESC_TABLE_FULL_ERROR;
366 prError = PR_MAX_DIRECTORY_ENTRIES_ERROR;
369 prError = PR_INVALID_ARGUMENT_ERROR;
373 prError = PR_REMOTE_FILE_ERROR;
377 prError = PR_NAME_TOO_LONG_ERROR;
380 prError = PR_NETWORK_UNREACHABLE_ERROR;
383 prError = PR_SYS_DESC_TABLE_FULL_ERROR;
386 * On SCO OpenServer 5, ENOBUFS is defined as ENOSR.
388 #if defined(ENOBUFS) && (ENOBUFS != ENOSR)
390 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
394 prError = PR_FILE_NOT_FOUND_ERROR;
397 prError = PR_FILE_NOT_FOUND_ERROR;
400 prError = PR_FILE_IS_LOCKED_ERROR;
404 prError = PR_REMOTE_FILE_ERROR;
408 prError = PR_OUT_OF_MEMORY_ERROR;
411 prError = PR_INVALID_ARGUMENT_ERROR;
414 prError = PR_NO_DEVICE_SPACE_ERROR;
418 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
422 prError = PR_NOT_CONNECTED_ERROR;
425 prError = PR_NOT_DIRECTORY_ERROR;
428 prError = PR_NOT_SOCKET_ERROR;
431 prError = PR_FILE_NOT_FOUND_ERROR;
434 prError = PR_NOT_TCP_SOCKET_ERROR;
438 prError = PR_BUFFER_OVERFLOW_ERROR;
442 prError = PR_NO_ACCESS_RIGHTS_ERROR;
445 prError = PR_CONNECT_RESET_ERROR;
449 prError = PR_IO_ERROR;
452 case EPROTONOSUPPORT:
453 prError = PR_PROTOCOL_NOT_SUPPORTED_ERROR;
456 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
459 prError = PR_INVALID_METHOD_ERROR;
462 prError = PR_READ_ONLY_FILESYSTEM_ERROR;
465 prError = PR_INVALID_METHOD_ERROR;
468 prError = PR_IO_TIMEOUT_ERROR;
470 #if EWOULDBLOCK != EAGAIN
472 prError = PR_WOULD_BLOCK_ERROR;
476 prError = PR_NOT_SAME_DEVICE_ERROR;
479 prError = PR_UNKNOWN_ERROR;
482 PR_SetError( prError, err );
486 * cipher_list is an integer array with the following values:
487 * -1: never enable this cipher
492 nss_parse_ciphers(const char *cipherstr, int cipher_list[ciphernum])
501 /* All disabled to start */
502 for (i=0; i<ciphernum; i++)
505 ciphertip = strdup(cipherstr);
506 cipher = ciphers = ciphertip;
508 while (ciphers && (strlen(ciphers))) {
509 while ((*cipher) && (isspace(*cipher)))
514 case '+': /* Add something */
518 case '-': /* Subtract something */
522 case '!': /* Disable something */
531 if ((ciphers = strchr(cipher, ':'))) {
535 /* Do the easy one first */
536 if (!strcmp(cipher, "ALL")) {
537 for (i=0; i<ciphernum; i++) {
538 if (!(ciphers_def[i].attr & SSL_eNULL))
539 cipher_list[i] = action;
541 } else if (!strcmp(cipher, "COMPLEMENTOFALL")) {
542 for (i=0; i<ciphernum; i++) {
543 if ((ciphers_def[i].attr & SSL_eNULL))
544 cipher_list[i] = action;
546 } else if (!strcmp(cipher, "DEFAULT")) {
547 for (i=0; i<ciphernum; i++) {
548 cipher_list[i] = ciphers_def[i].enabled == SSL_ALLOWED ? 1 : 0;
557 while (c && (strlen(c))) {
559 if ((c = strchr(cipher, '+'))) {
563 if (!strcmp(cipher, "RSA")) {
565 } else if ((!strcmp(cipher, "NULL")) || (!strcmp(cipher, "eNULL"))) {
567 } else if (!strcmp(cipher, "AES")) {
569 } else if (!strcmp(cipher, "3DES")) {
571 } else if (!strcmp(cipher, "DES")) {
573 } else if (!strcmp(cipher, "RC4")) {
575 } else if (!strcmp(cipher, "RC2")) {
577 } else if (!strcmp(cipher, "MD5")) {
579 } else if ((!strcmp(cipher, "SHA")) || (!strcmp(cipher, "SHA1"))) {
581 } else if (!strcmp(cipher, "SSLv2")) {
583 } else if (!strcmp(cipher, "SSLv3")) {
585 } else if (!strcmp(cipher, "TLSv1")) {
587 } else if (!strcmp(cipher, "HIGH")) {
588 strength |= SSL_HIGH;
589 } else if (!strcmp(cipher, "MEDIUM")) {
590 strength |= SSL_MEDIUM;
591 } else if (!strcmp(cipher, "LOW")) {
593 } else if ((!strcmp(cipher, "EXPORT")) || (!strcmp(cipher, "EXP"))) {
594 strength |= SSL_EXPORT40|SSL_EXPORT56;
595 } else if (!strcmp(cipher, "EXPORT40")) {
596 strength |= SSL_EXPORT40;
597 } else if (!strcmp(cipher, "EXPORT56")) {
598 strength |= SSL_EXPORT56;
606 /* If we have a mask, apply it. If not then perhaps they provided
607 * a specific cipher to enable.
609 if (mask || strength || protocol) {
610 for (i=0; i<ciphernum; i++) {
611 if (((ciphers_def[i].attr & mask) ||
612 (ciphers_def[i].strength & strength) ||
613 (ciphers_def[i].version & protocol)) &&
614 (cipher_list[i] != -1)) {
615 /* Enable the NULL ciphers only if explicity
617 if (ciphers_def[i].attr & SSL_eNULL) {
618 if (mask & SSL_eNULL)
619 cipher_list[i] = action;
621 cipher_list[i] = action;
625 for (i=0; i<ciphernum; i++) {
626 if (!strcmp(ciphers_def[i].ossl_name, cipher) &&
627 cipher_list[1] != -1)
628 cipher_list[i] = action;
637 /* See if any ciphers were enabled */
639 for (i=0; i<ciphernum; i++) {
640 if (cipher_list[i] == 1)
650 tlsm_parse_ciphers(tlsm_ctx *ctx, const char *str)
652 int cipher_state[ciphernum];
658 rv = nss_parse_ciphers(str, cipher_state);
661 /* First disable everything */
662 for (i = 0; i < SSL_NumImplementedCiphers; i++)
663 SSL_CipherPrefSet(ctx->tc_model, SSL_ImplementedCiphers[i], SSL_NOT_ALLOWED);
665 /* Now enable what was requested */
666 for (i=0; i<ciphernum; i++) {
667 SSLCipherSuiteInfo suite;
670 if (SSL_GetCipherSuiteInfo(ciphers_def[i].num, &suite, sizeof suite)
672 enabled = cipher_state[i] < 0 ? 0 : cipher_state[i];
673 if (enabled == SSL_ALLOWED) {
674 if (PK11_IsFIPS() && !suite.isFIPS)
675 enabled = SSL_NOT_ALLOWED;
677 SSL_CipherPrefSet(ctx->tc_model, ciphers_def[i].num, enabled);
682 return rv == 1 ? 0 : -1;
686 tlsm_bad_cert_handler(void *arg, PRFileDesc *ssl)
688 SECStatus success = SECSuccess;
690 tlsm_ctx *ctx = (tlsm_ctx *)arg;
696 err = PORT_GetError();
699 case SEC_ERROR_UNTRUSTED_ISSUER:
700 case SEC_ERROR_UNKNOWN_ISSUER:
701 case SEC_ERROR_EXPIRED_CERTIFICATE:
702 case SEC_ERROR_EXPIRED_ISSUER_CERTIFICATE:
703 if (ctx->tc_verify_cert) {
704 success = SECFailure;
707 /* we bypass NSS's hostname checks and do our own */
708 case SSL_ERROR_BAD_CERT_DOMAIN:
711 success = SECFailure;
719 tlsm_dump_security_status(PRFileDesc *fd)
721 char * cp; /* bulk cipher name */
722 char * ip; /* cert issuer DN */
723 char * sp; /* cert subject DN */
724 int op; /* High, Low, Off */
725 int kp0; /* total key bits */
726 int kp1; /* secret key bits */
727 SSL3Statistics * ssl3stats = SSL_GetStatistics();
729 SSL_SecurityStatus( fd, &op, &cp, &kp0, &kp1, &ip, &sp );
730 Debug( LDAP_DEBUG_TRACE,
731 "TLS certificate verification: subject: %s, issuer: %s, cipher: %s, ",
732 sp ? sp : "-unknown-", ip ? ip : "-unknown-", cp ? cp : "-unknown-" );
736 Debug( LDAP_DEBUG_TRACE,
737 "security level: %s, secret key bits: %d, total key bits: %d, ",
738 ((op == SSL_SECURITY_STATUS_ON_HIGH) ? "high" :
739 ((op == SSL_SECURITY_STATUS_ON_LOW) ? "low" : "off")),
742 Debug( LDAP_DEBUG_TRACE,
743 "cache hits: %ld, cache misses: %ld, cache not reusable: %ld\n",
744 ssl3stats->hch_sid_cache_hits, ssl3stats->hch_sid_cache_misses,
745 ssl3stats->hch_sid_cache_not_ok );
751 tlsm_handshake_complete_cb( PRFileDesc *fd, void *client_data )
753 tlsm_dump_security_status( fd );
756 #ifdef READ_PASSWORD_FROM_FILE
758 tlsm_get_pin_from_file(const char *token_name, tlsm_ctx *ctx)
761 char *contents = NULL;
764 char *candidate = NULL;
765 PRFileInfo file_info;
766 PRFileDesc *pwd_fileptr = PR_Open( ctx->tc_pin_file, PR_RDONLY, 00400 );
768 /* open the password file */
769 if ( !pwd_fileptr ) {
770 PRErrorCode errcode = PR_GetError();
771 Debug( LDAP_DEBUG_ANY,
772 "TLS: could not open security pin file %s - error %d:%s.\n",
773 ctx->tc_pin_file, errcode,
774 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
778 /* get the file size */
779 if ( PR_SUCCESS != PR_GetFileInfo( ctx->tc_pin_file, &file_info ) ) {
780 PRErrorCode errcode = PR_GetError();
781 Debug( LDAP_DEBUG_ANY,
782 "TLS: could not get file info from pin file %s - error %d:%s.\n",
783 ctx->tc_pin_file, errcode,
784 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
788 /* create a buffer to hold the file contents */
789 if ( !( contents = PR_MALLOC( file_info.size + 1 ) ) ) {
790 PRErrorCode errcode = PR_GetError();
791 Debug( LDAP_DEBUG_ANY,
792 "TLS: could not alloc a buffer for contents of pin file %s - error %d:%s.\n",
793 ctx->tc_pin_file, errcode,
794 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
798 /* read file into the buffer */
799 if( PR_Read( pwd_fileptr, contents, file_info.size ) <= 0 ) {
800 PRErrorCode errcode = PR_GetError();
801 Debug( LDAP_DEBUG_ANY,
802 "TLS: could not read the file contents from pin file %s - error %d:%s.\n",
803 ctx->tc_pin_file, errcode,
804 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
808 /* format is [tokenname:]password EOL [tokenname:]password EOL ... */
809 /* if you want to use a password containing a colon character, use
810 the special tokenname "default" */
811 for ( line = PL_strtok_r( contents, "\r\n", &lasts ); line;
812 line = PL_strtok_r( NULL, "\r\n", &lasts ) ) {
816 continue; /* skip blank lines */
818 colon = PL_strchr( line, ':' );
820 if ( *(colon + 1) && token_name &&
821 !PL_strncmp( token_name, line, colon-line ) ) {
822 candidate = colon + 1; /* found a definite match */
824 } else if ( !PL_strncmp( DEFAULT_TOKEN_NAME, line, colon-line ) ) {
825 candidate = colon + 1; /* found possible match */
827 } else { /* no token name */
833 PR_Close( pwd_fileptr );
836 pwdstr = PL_strdup( candidate );
838 PL_strfree( contents );
842 #endif /* READ_PASSWORD_FROM_FILE */
844 #ifdef READ_PASSWORD_FROM_STDIN
846 * Turn the echoing off on a tty.
851 if ( isatty( fd ) ) {
853 tcgetattr( fd, &tio );
854 tio.c_lflag &= ~ECHO;
855 tcsetattr( fd, TCSAFLUSH, &tio );
860 * Turn the echoing on on a tty.
865 if ( isatty( fd ) ) {
867 tcgetattr( fd, &tio );
869 tcsetattr( fd, TCSAFLUSH, &tio );
870 tcsetattr( fd, TCSAFLUSH, &tio );
873 #endif /* READ_PASSWORD_FROM_STDIN */
876 * This does the actual work of reading the pin/password/pass phrase
879 tlsm_get_pin(PK11SlotInfo *slot, PRBool retry, tlsm_ctx *ctx)
881 char *token_name = NULL;
884 token_name = PK11_GetTokenName( slot );
885 #ifdef READ_PASSWORD_FROM_FILE
886 /* Try to get the passwords from the password file if it exists.
887 * THIS IS UNSAFE and is provided for convenience only. Without this
888 * capability the server would have to be started in foreground mode
889 * if using an encrypted key.
891 if ( ctx->tc_pin_file ) {
892 pwdstr = tlsm_get_pin_from_file( token_name, ctx );
894 #endif /* RETRIEVE_PASSWORD_FROM_FILE */
895 #ifdef READ_PASSWORD_FROM_STDIN
897 int infd = PR_FileDesc2NativeHandle( PR_STDIN );
898 int isTTY = isatty( infd );
899 unsigned char phrase[200];
900 /* Prompt for password */
903 "Please enter pin, password, or pass phrase for security token '%s': ",
904 token_name ? token_name : DEFAULT_TOKEN_NAME );
907 fgets( (char*)phrase, sizeof(phrase), stdin );
909 fprintf( stdout, "\n" );
912 /* stomp on newline */
913 phrase[strlen((char*)phrase)-1] = 0;
915 pwdstr = PL_strdup( (char*)phrase );
918 #endif /* READ_PASSWORD_FROM_STDIN */
923 * PKCS11 devices (including the internal softokn cert/key database)
924 * may be protected by a pin or password or even pass phrase
925 * MozNSS needs a way for the user to provide that
928 tlsm_pin_prompt(PK11SlotInfo *slot, PRBool retry, void *arg)
930 tlsm_ctx *ctx = (tlsm_ctx *)arg;
932 return tlsm_get_pin( slot, retry, ctx );
936 tlsm_get_basic_constraint_extension( CERTCertificate *cert,
937 CERTBasicConstraints *cbcval )
939 SECItem encodedVal = { 0, NULL };
942 rc = CERT_FindCertExtension( cert, SEC_OID_X509_BASIC_CONSTRAINTS,
944 if ( rc != SECSuccess ) {
948 rc = CERT_DecodeBasicConstraintValue( cbcval, &encodedVal );
950 /* free the raw extension data */
951 PORT_Free( encodedVal.data );
957 tlsm_cert_is_self_issued( CERTCertificate *cert )
959 /* A cert is self-issued if its subject and issuer are equal and
960 * both are of non-zero length.
962 PRBool is_self_issued = cert &&
963 (PRBool)SECITEM_ItemsAreEqual( &cert->derIssuer,
964 &cert->derSubject ) &&
965 cert->derSubject.len > 0;
966 return is_self_issued;
970 tlsm_verify_cert(CERTCertDBHandle *handle, CERTCertificate *cert, void *pinarg,
971 PRBool checksig, SECCertificateUsage certUsage, int errorToIgnore )
973 CERTVerifyLog verifylog;
974 SECStatus ret = SECSuccess;
976 int debug_level = LDAP_DEBUG_ANY;
978 if ( errorToIgnore == -1 ) {
979 debug_level = LDAP_DEBUG_TRACE;
982 /* the log captures information about every cert in the chain, so we can tell
983 which cert caused the problem and what the problem was */
984 memset( &verifylog, 0, sizeof( verifylog ) );
985 verifylog.arena = PORT_NewArena( DER_DEFAULT_CHUNKSIZE );
986 if ( verifylog.arena == NULL ) {
987 Debug( LDAP_DEBUG_ANY,
988 "TLS certificate verification: Out of memory for certificate verification logger\n",
992 ret = CERT_VerifyCertificate( handle, cert, checksig, certUsage, PR_Now(), pinarg, &verifylog,
994 if ( ( name = cert->subjectName ) == NULL ) {
995 name = cert->nickname;
997 if ( verifylog.head == NULL ) {
998 /* it is possible for CERT_VerifyCertificate return with an error with no logging */
999 if ( ret != SECSuccess ) {
1000 PRErrorCode errcode = PR_GetError();
1002 "TLS: certificate [%s] is not valid - error %d:%s.\n",
1003 name ? name : "(unknown)",
1004 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1008 CERTVerifyLogNode *node;
1010 ret = SECSuccess; /* reset */
1011 node = verifylog.head;
1013 if ( ( name = node->cert->subjectName ) == NULL ) {
1014 name = node->cert->nickname;
1016 if ( node->error ) {
1017 /* NSS does not like CA certs that have the basic constraints extension
1018 with the CA flag set to FALSE - openssl doesn't check if the cert
1020 if ( ( node->error == SEC_ERROR_CA_CERT_INVALID ) &&
1021 tlsm_cert_is_self_issued( node->cert ) ) {
1023 PRErrorCode orig_error = PR_GetError();
1024 PRInt32 orig_oserror = PR_GetOSError();
1026 CERTBasicConstraints basicConstraint;
1027 SECStatus rv = tlsm_get_basic_constraint_extension( node->cert, &basicConstraint );
1028 if ( ( rv == SECSuccess ) && ( basicConstraint.isCA == PR_FALSE ) ) {
1029 Debug( LDAP_DEBUG_TRACE,
1030 "TLS: certificate [%s] is not correct because it is a CA cert and the "
1031 "BasicConstraint CA flag is set to FALSE - allowing for now, but "
1032 "please fix your certs if possible\n", name, 0, 0 );
1033 } else { /* does not have basicconstraint, or some other error */
1036 "TLS: certificate [%s] is not valid - CA cert is not valid\n",
1040 PR_SetError(orig_error, orig_oserror);
1042 } else if ( errorToIgnore && ( node->error == errorToIgnore ) ) {
1044 "TLS: Warning: ignoring error for certificate [%s] - error %ld:%s.\n",
1045 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1049 "TLS: certificate [%s] is not valid - error %ld:%s.\n",
1050 name, node->error, PR_ErrorToString( node->error, PR_LANGUAGE_I_DEFAULT ) );
1053 CERT_DestroyCertificate( node->cert );
1058 PORT_FreeArena( verifylog.arena, PR_FALSE );
1060 if ( ret == SECSuccess ) {
1061 Debug( LDAP_DEBUG_TRACE,
1062 "TLS: certificate [%s] is valid\n", name, 0, 0 );
1063 } else if ( errorToIgnore == -1 ) {
1071 tlsm_auth_cert_handler(void *arg, PRFileDesc *fd,
1072 PRBool checksig, PRBool isServer)
1074 SECCertificateUsage certUsage = isServer ? certificateUsageSSLClient : certificateUsageSSLServer;
1075 SECStatus ret = SECSuccess;
1076 CERTCertificate *peercert = SSL_PeerCertificate( fd );
1077 int errorToIgnore = 0;
1078 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1080 if (ctx && ctx->tc_warn_only )
1083 ret = tlsm_verify_cert( ctx->tc_certdb, peercert,
1084 SSL_RevealPinArg( fd ),
1085 checksig, certUsage, errorToIgnore );
1086 CERT_DestroyCertificate( peercert );
1092 tlsm_authenticate_to_slot( tlsm_ctx *ctx, PK11SlotInfo *slot )
1096 if ( SECSuccess != PK11_Authenticate( slot, PR_FALSE, ctx ) ) {
1097 char *token_name = PK11_GetTokenName( slot );
1098 PRErrorCode errcode = PR_GetError();
1099 Debug( LDAP_DEBUG_ANY,
1100 "TLS: could not authenticate to the security token %s - error %d:%s.\n",
1101 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
1102 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1104 rc = 0; /* success */
1111 tlsm_nss_shutdown_cb( void *appData, void *nssData )
1113 SECStatus rc = SECSuccess;
1115 SSL_ShutdownServerSessionIDCache();
1118 SECMOD_UnloadUserModule( pem_module );
1119 SECMOD_DestroyModule( pem_module );
1125 static PRCallOnceType tlsm_register_shutdown_callonce = {0,0};
1126 static PRStatus PR_CALLBACK
1127 tlsm_register_nss_shutdown_cb( void )
1129 if ( SECSuccess == NSS_RegisterShutdown( tlsm_nss_shutdown_cb,
1137 tlsm_register_nss_shutdown( void )
1139 return PR_CallOnce( &tlsm_register_shutdown_callonce,
1140 tlsm_register_nss_shutdown_cb );
1144 tlsm_init_pem_module( void )
1147 char *fullname = NULL;
1148 char *configstring = NULL;
1154 /* not loaded - load it */
1155 /* get the system dependent library name */
1156 fullname = PR_GetLibraryName( NULL, PEM_LIBRARY );
1157 /* Load our PKCS#11 module */
1158 configstring = PR_smprintf( "library=%s name=" PEM_MODULE " parameters=\"\"", fullname );
1159 PL_strfree( fullname );
1161 pem_module = SECMOD_LoadUserModule( configstring, NULL, PR_FALSE );
1162 PR_smprintf_free( configstring );
1164 if ( !pem_module || !pem_module->loaded ) {
1166 SECMOD_DestroyModule( pem_module );
1176 tlsm_add_pem_obj( tlsm_ctx *ctx, PK11GenericObject *obj )
1178 int idx = ctx->tc_n_pem_objs;
1179 ctx->tc_n_pem_objs++;
1180 ctx->tc_pem_objs = (PK11GenericObject **)
1181 PORT_Realloc( ctx->tc_pem_objs, ctx->tc_n_pem_objs * sizeof( PK11GenericObject * ) );
1182 ctx->tc_pem_objs[idx] = obj;
1186 tlsm_free_pem_objs( tlsm_ctx *ctx )
1188 /* free in reverse order of allocation */
1189 while ( ctx->tc_n_pem_objs-- ) {
1190 PK11_DestroyGenericObject( ctx->tc_pem_objs[ctx->tc_n_pem_objs] );
1191 ctx->tc_pem_objs[ctx->tc_n_pem_objs] = NULL;
1193 PORT_Free(ctx->tc_pem_objs);
1194 ctx->tc_pem_objs = NULL;
1195 ctx->tc_n_pem_objs = 0;
1199 tlsm_add_cert_from_file( tlsm_ctx *ctx, const char *filename, PRBool isca, PRBool istrusted )
1202 PK11SlotInfo *slot = NULL;
1203 PK11GenericObject *rv;
1204 CK_ATTRIBUTE *attrs;
1205 CK_ATTRIBUTE theTemplate[20];
1206 CK_BBOOL cktrue = CK_TRUE;
1207 CK_BBOOL ckfalse = CK_FALSE;
1208 CK_OBJECT_CLASS objClass = CKO_CERTIFICATE;
1209 char tmpslotname[64];
1210 char *slotname = NULL;
1211 const char *ptr = NULL;
1212 char sep = PR_GetDirectorySeparator();
1216 memset( &fi, 0, sizeof(fi) );
1217 status = PR_GetFileInfo( filename, &fi );
1218 if ( PR_SUCCESS != status) {
1219 PRErrorCode errcode = PR_GetError();
1220 Debug( LDAP_DEBUG_ANY,
1221 "TLS: could not read certificate file %s - error %d:%s.\n",
1223 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1227 if ( fi.type != PR_FILE_FILE ) {
1228 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1229 Debug( LDAP_DEBUG_ANY,
1230 "TLS: error: the certificate file %s is not a file.\n",
1235 attrs = theTemplate;
1238 slotID = 0; /* CA and trust objects use slot 0 */
1239 PR_snprintf( tmpslotname, sizeof(tmpslotname), TLSM_PEM_TOKEN_FMT, slotID );
1240 slotname = tmpslotname;
1241 istrusted = PR_TRUE;
1243 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1247 slotID = ++tlsm_slot_count;
1249 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1251 slotname = ctx->tc_slotname;
1253 if ( ( ptr = PL_strrchr( filename, sep ) ) ) {
1254 PL_strfree( ctx->tc_certname );
1257 /* pemnss conflates trusted certs with CA certs - since there can
1258 be more than one CA cert in a file (e.g. ca-bundle.crt) pemnss
1259 numbers each trusted cert - in the case of a server cert, there will be
1260 only one, so it will be number 0 */
1261 ctx->tc_certname = PR_smprintf( "%s:%s - 0", slotname, ptr );
1263 ctx->tc_certname = PR_smprintf( "%s:%s", slotname, ptr );
1268 slot = PK11_FindSlotByName( slotname );
1271 PRErrorCode errcode = PR_GetError();
1272 Debug( LDAP_DEBUG_ANY,
1273 "TLS: could not find the slot for certificate %s - error %d:%s.\n",
1274 ctx->tc_certname, errcode,
1275 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1279 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1280 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1281 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1283 PK11_SETATTRS( attrs, CKA_TRUST, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1285 PK11_SETATTRS( attrs, CKA_TRUST, &ckfalse, sizeof(CK_BBOOL) ); attrs++;
1287 /* This loads the certificate in our PEM module into the appropriate
1290 rv = PK11_CreateGenericObject( slot, theTemplate, 4, PR_FALSE /* isPerm */ );
1292 PK11_FreeSlot( slot );
1295 PRErrorCode errcode = PR_GetError();
1296 Debug( LDAP_DEBUG_ANY,
1297 "TLS: could not add the certificate %s - error %d:%s.\n",
1298 ctx->tc_certname, errcode,
1299 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1303 tlsm_add_pem_obj( ctx, rv );
1309 tlsm_add_key_from_file( tlsm_ctx *ctx, const char *filename )
1312 PK11SlotInfo * slot = NULL;
1313 PK11GenericObject *rv;
1314 CK_ATTRIBUTE *attrs;
1315 CK_ATTRIBUTE theTemplate[20];
1316 CK_BBOOL cktrue = CK_TRUE;
1317 CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1322 memset( &fi, 0, sizeof(fi) );
1323 status = PR_GetFileInfo( filename, &fi );
1324 if ( PR_SUCCESS != status) {
1325 PRErrorCode errcode = PR_GetError();
1326 Debug( LDAP_DEBUG_ANY,
1327 "TLS: could not read key file %s - error %d:%s.\n",
1329 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1333 if ( fi.type != PR_FILE_FILE ) {
1334 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1335 Debug( LDAP_DEBUG_ANY,
1336 "TLS: error: the key file %s is not a file.\n",
1341 attrs = theTemplate;
1343 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1344 slotID = ++tlsm_slot_count;
1345 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1347 slot = PK11_FindSlotByName( ctx->tc_slotname );
1350 PRErrorCode errcode = PR_GetError();
1351 Debug( LDAP_DEBUG_ANY,
1352 "TLS: could not find the slot %s for the private key - error %d:%s.\n",
1353 ctx->tc_slotname, errcode,
1354 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1358 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1359 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1360 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1361 rv = PK11_CreateGenericObject( slot, theTemplate, 3, PR_FALSE /* isPerm */ );
1364 PRErrorCode errcode = PR_GetError();
1365 Debug( LDAP_DEBUG_ANY,
1366 "TLS: could not add the certificate %s - error %d:%s.\n",
1367 ctx->tc_certname, errcode,
1368 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1371 /* When adding an encrypted key the PKCS#11 will be set as removed */
1372 /* This will force the token to be seen as re-inserted */
1373 SECMOD_WaitForAnyTokenEvent( pem_module, 0, 0 );
1374 PK11_IsPresent( slot );
1378 PK11_FreeSlot( slot );
1381 tlsm_add_pem_obj( ctx, rv );
1387 tlsm_init_ca_certs( tlsm_ctx *ctx, const char *cacertfile, const char *cacertdir )
1389 PRBool isca = PR_TRUE;
1390 PRStatus status = PR_SUCCESS;
1391 PRErrorCode errcode = PR_SUCCESS;
1393 if ( !cacertfile && !cacertdir ) {
1394 /* no checking - not good, but allowed */
1399 int rc = tlsm_add_cert_from_file( ctx, cacertfile, isca, PR_TRUE );
1401 errcode = PR_GetError();
1402 Debug( LDAP_DEBUG_ANY,
1403 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1404 cacertfile, errcode,
1405 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1406 /* failure with cacertfile is a hard failure even if cacertdir is
1407 also specified and contains valid CA cert files */
1408 status = PR_FAILURE;
1410 Debug( LDAP_DEBUG_TRACE,
1411 "TLS: loaded CA certificate file %s.\n",
1416 /* if cacertfile above failed, we will return failure, even
1417 if there is a valid CA cert in cacertdir - but we still
1418 process cacertdir in case the user has enabled trace level
1419 debugging so they can see the processing for cacertdir too */
1420 /* any cacertdir failures are "soft" failures - if the user specifies
1421 no cert checking, then we allow the tls/ssl to continue, no matter
1422 what was specified for cacertdir, or the contents of the directory
1423 - this is different behavior than that of cacertfile */
1428 PRStatus fistatus = PR_FAILURE;
1430 memset( &fi, 0, sizeof(fi) );
1431 fistatus = PR_GetFileInfo( cacertdir, &fi );
1432 if ( PR_SUCCESS != fistatus) {
1433 errcode = PR_GetError();
1434 Debug( LDAP_DEBUG_ANY,
1435 "TLS: could not get info about the CA certificate directory %s - error %d:%s.\n",
1437 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1441 if ( fi.type != PR_FILE_DIRECTORY ) {
1442 Debug( LDAP_DEBUG_ANY,
1443 "TLS: error: the CA certificate directory %s is not a directory.\n",
1448 dir = PR_OpenDir( cacertdir );
1449 if ( NULL == dir ) {
1450 errcode = PR_GetError();
1451 Debug( LDAP_DEBUG_ANY,
1452 "TLS: could not open the CA certificate directory %s - error %d:%s.\n",
1454 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1459 entry = PR_ReadDir( dir, PR_SKIP_BOTH | PR_SKIP_HIDDEN );
1460 if ( ( NULL != entry ) && ( NULL != entry->name ) ) {
1461 char *fullpath = NULL;
1464 ptr = PL_strrstr( entry->name, PEM_CA_HASH_FILE_SUFFIX );
1465 if ( ( ptr == NULL ) || ( *(ptr + PEM_CA_HASH_FILE_SUFFIX_LEN) != '\0' ) ) {
1466 Debug( LDAP_DEBUG_TRACE,
1467 "TLS: file %s does not end in [%s] - does not appear to be a CA certificate "
1468 "directory file with a properly hashed file name - skipping.\n",
1469 entry->name, PEM_CA_HASH_FILE_SUFFIX, 0 );
1472 fullpath = PR_smprintf( "%s/%s", cacertdir, entry->name );
1473 if ( !tlsm_add_cert_from_file( ctx, fullpath, isca, PR_TRUE ) ) {
1474 Debug( LDAP_DEBUG_TRACE,
1475 "TLS: loaded CA certificate file %s from CA certificate directory %s.\n",
1476 fullpath, cacertdir, 0 );
1478 errcode = PR_GetError();
1479 Debug( LDAP_DEBUG_TRACE,
1480 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1482 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1484 PR_smprintf_free( fullpath );
1486 } while ( NULL != entry );
1490 if ( status != PR_SUCCESS ) {
1498 * NSS supports having multiple cert/key databases in the same
1499 * directory, each one having a unique string prefix e.g.
1500 * slapd-01-cert8.db - the prefix here is "slapd-01-"
1501 * this function examines the given certdir - if it looks like
1502 * /path/to/directory/prefix it will return the
1503 * /path/to/directory part in realcertdir, and the prefix in prefix
1506 tlsm_get_certdb_prefix( const char *certdir, char **realcertdir, char **prefix )
1508 char sep = PR_GetDirectorySeparator();
1510 struct PRFileInfo prfi;
1513 *realcertdir = (char *)certdir; /* default is the one passed in */
1515 /* if certdir is not given, just return */
1520 prc = PR_GetFileInfo( certdir, &prfi );
1521 /* if certdir exists (file or directory) then it cannot specify a prefix */
1522 if ( prc == PR_SUCCESS ) {
1526 /* if certdir was given, and there is a '/' in certdir, see if there
1527 is anything after the last '/' - if so, assume it is the prefix */
1528 if ( ( ( ptr = strrchr( certdir, sep ) ) ) && *(ptr+1) ) {
1529 *realcertdir = PL_strndup( certdir, ptr-certdir );
1530 *prefix = PL_strdup( ptr+1 );
1537 * This is the part of the init we defer until we get the
1538 * actual security configuration information. This is
1539 * only called once, protected by a PRCallOnce
1540 * NOTE: This must be done before the first call to SSL_ImportFD,
1541 * especially the setting of the policy
1542 * NOTE: This must be called after fork()
1545 tlsm_deferred_init( void *arg )
1547 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1548 struct ldaptls *lt = ctx->tc_config;
1549 const char *securitydirs[3];
1552 PRErrorCode errcode = 1;
1553 #ifdef HAVE_NSS_INITCONTEXT
1554 NSSInitParameters initParams;
1555 NSSInitContext *initctx = NULL;
1560 #ifdef HAVE_SECMOD_RESTARTMODULES
1561 /* NSS enforces the pkcs11 requirement that modules should be unloaded after
1562 a fork() - since there is no portable way to determine if NSS has been
1563 already initialized in a parent process, we just call SECMOD_RestartModules
1564 with force == FALSE - if the module has been unloaded due to a fork, it will
1565 be reloaded, otherwise, it is a no-op */
1566 if ( SECFailure == ( rc = SECMOD_RestartModules(PR_FALSE /* do not force */) ) ) {
1567 errcode = PORT_GetError();
1568 if ( errcode != SEC_ERROR_NOT_INITIALIZED ) {
1569 Debug( LDAP_DEBUG_TRACE,
1570 "TLS: could not restart the security modules: %d:%s\n",
1571 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1578 #ifdef HAVE_NSS_INITCONTEXT
1579 memset( &initParams, 0, sizeof( initParams ) );
1580 initParams.length = sizeof( initParams );
1581 #endif /* HAVE_NSS_INITCONTEXT */
1583 #ifdef LDAP_R_COMPILE
1584 if ( PR_CallOnce( &tlsm_init_mutex_callonce, tlsm_thr_init_callonce ) ) {
1587 #endif /* LDAP_R_COMPILE */
1589 #ifndef HAVE_NSS_INITCONTEXT
1590 if ( !NSS_IsInitialized() ) {
1591 #endif /* HAVE_NSS_INITCONTEXT */
1593 MOZNSS_DIR will override everything else - you can
1594 always set MOZNSS_DIR to force the use of this
1596 If using MOZNSS, specify the location of the moznss db dir
1597 in the cacertdir directive of the OpenLDAP configuration.
1598 DEFAULT_MOZNSS_DIR will only be used if the code cannot
1599 find a security dir to use based on the current
1603 securitydirs[nn++] = PR_GetEnv( "MOZNSS_DIR" );
1604 securitydirs[nn++] = lt->lt_cacertdir;
1605 securitydirs[nn++] = PR_GetEnv( "DEFAULT_MOZNSS_DIR" );
1606 for ( ii = 0; !done && ( ii < nn ); ++ii ) {
1607 char *realcertdir = NULL;
1608 const char *defprefix = "";
1609 char *prefix = (char *)defprefix;
1610 const char *securitydir = securitydirs[ii];
1611 if ( NULL == securitydir ) {
1615 tlsm_get_certdb_prefix( securitydir, &realcertdir, &prefix );
1616 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
1618 #ifdef HAVE_NSS_INITCONTEXT
1619 #ifdef INITCONTEXT_HACK
1620 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1621 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1623 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1624 &initParams, NSS_INIT_READONLY );
1625 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1628 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1629 &initParams, NSS_INIT_READONLY );
1630 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1633 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1636 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
1638 if ( rc != SECSuccess ) {
1639 errcode = PORT_GetError();
1640 if ( securitydirs[ii] != lt->lt_cacertdir) {
1641 Debug( LDAP_DEBUG_TRACE,
1642 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1643 realcertdir, prefix, errcode );
1647 Debug( LDAP_DEBUG_TRACE, "TLS: using moznss security dir %s prefix %s.\n",
1648 realcertdir, prefix, 0 );
1652 if ( realcertdir != securitydir ) {
1653 PL_strfree( realcertdir );
1655 if ( prefix != defprefix ) {
1656 PL_strfree( prefix );
1660 if ( errcode ) { /* no moznss db found, or not using moznss db */
1661 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
1662 #ifdef HAVE_NSS_INITCONTEXT
1663 int flags = NSS_INIT_READONLY|NSS_INIT_NOCERTDB|NSS_INIT_NOMODDB;
1664 #ifdef INITCONTEXT_HACK
1665 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1666 rc = NSS_NoDB_Init( NULL );
1668 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1669 &initParams, flags );
1670 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1673 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1674 &initParams, flags );
1675 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1678 rc = NSS_NoDB_Init( NULL );
1680 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
1681 if ( rc != SECSuccess ) {
1682 errcode = PORT_GetError();
1683 Debug( LDAP_DEBUG_ANY,
1684 "TLS: could not initialize moznss - error %d:%s.\n",
1685 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1689 #ifdef HAVE_NSS_INITCONTEXT
1690 ctx->tc_initctx = initctx;
1695 if ( errcode || lt->lt_cacertfile ) {
1696 /* initialize the PEM module */
1697 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
1698 if ( tlsm_init_pem_module() ) {
1699 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
1700 int pem_errcode = PORT_GetError();
1701 Debug( LDAP_DEBUG_ANY,
1702 "TLS: could not initialize moznss PEM module - error %d:%s.\n",
1703 pem_errcode, PR_ErrorToString( pem_errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1705 if ( errcode ) /* PEM is required */
1708 } else if ( !errcode ) {
1709 tlsm_init_ca_certs( ctx, lt->lt_cacertfile, NULL );
1711 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
1715 if ( tlsm_init_ca_certs( ctx, lt->lt_cacertfile, lt->lt_cacertdir ) ) {
1716 /* if we tried to use lt->lt_cacertdir as an NSS key/cert db, errcode
1717 will be a value other than 1 - print an error message so that the
1718 user will know that failed too */
1719 if ( ( errcode != 1 ) && ( lt->lt_cacertdir ) ) {
1720 char *realcertdir = NULL;
1721 char *prefix = NULL;
1722 tlsm_get_certdb_prefix( lt->lt_cacertdir, &realcertdir, &prefix );
1723 Debug( LDAP_DEBUG_TRACE,
1724 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1725 realcertdir, prefix ? prefix : "", errcode );
1726 if ( realcertdir != lt->lt_cacertdir ) {
1727 PL_strfree( realcertdir );
1729 PL_strfree( prefix );
1734 ctx->tc_using_pem = PR_TRUE;
1737 #ifdef HAVE_NSS_INITCONTEXT
1738 if ( !ctx->tc_initctx ) {
1739 ctx->tc_initctx = initctx;
1743 NSS_SetDomesticPolicy();
1745 PK11_SetPasswordFunc( tlsm_pin_prompt );
1747 /* register cleanup function */
1748 if ( tlsm_register_nss_shutdown() ) {
1749 errcode = PORT_GetError();
1750 Debug( LDAP_DEBUG_ANY,
1751 "TLS: could not register NSS shutdown function: %d:%s\n",
1752 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1756 if ( ctx->tc_is_server ) {
1757 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
1758 /* 0 means use the defaults here */
1759 SSL_ConfigServerSessionIDCache( 0, 0, 0, NULL );
1760 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
1763 #ifndef HAVE_NSS_INITCONTEXT
1765 #endif /* HAVE_NSS_INITCONTEXT */
1771 tlsm_authenticate( tlsm_ctx *ctx, const char *certname, const char *pininfo )
1773 const char *colon = NULL;
1774 char *token_name = NULL;
1775 PK11SlotInfo *slot = NULL;
1778 if ( !certname || !*certname ) {
1782 if ( ( colon = PL_strchr( certname, ':' ) ) ) {
1783 token_name = PL_strndup( certname, colon-certname );
1787 slot = PK11_FindSlotByName( token_name );
1789 slot = PK11_GetInternalKeySlot();
1793 PRErrorCode errcode = PR_GetError();
1794 Debug( LDAP_DEBUG_ANY,
1795 "TLS: could not find the slot for security token %s - error %d:%s.\n",
1796 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
1797 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1801 rc = tlsm_authenticate_to_slot( ctx, slot );
1804 PL_strfree( token_name );
1806 PK11_FreeSlot( slot );
1813 * Find and verify the certificate.
1814 * Either fd is given, in which case the cert will be taken from it via SSL_PeerCertificate
1815 * or certname is given, and it will be searched for by name
1818 tlsm_find_and_verify_cert_key(tlsm_ctx *ctx, PRFileDesc *fd, const char *certname, int isServer, CERTCertificate **pRetCert, SECKEYPrivateKey **pRetKey)
1820 CERTCertificate *cert = NULL;
1822 void *pin_arg = NULL;
1823 SECKEYPrivateKey *key = NULL;
1825 pin_arg = SSL_RevealPinArg( fd );
1827 cert = PK11_FindCertFromNickname( certname, pin_arg );
1829 PRErrorCode errcode = PR_GetError();
1830 Debug( LDAP_DEBUG_ANY,
1831 "TLS: error: the certificate %s could not be found in the database - error %d:%s\n",
1832 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1836 /* we are verifying the peer cert
1837 we also need to swap the isServer meaning */
1838 cert = SSL_PeerCertificate( fd );
1840 PRErrorCode errcode = PR_GetError();
1841 Debug( LDAP_DEBUG_ANY,
1842 "TLS: error: could not get the certificate from the peer connection - error %d:%s\n",
1843 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), NULL );
1846 isServer = !isServer; /* verify the peer's cert instead */
1849 if ( ctx->tc_slotname ) {
1850 PK11SlotInfo *slot = PK11_FindSlotByName( ctx->tc_slotname );
1851 key = PK11_FindPrivateKeyFromCert( slot, cert, NULL );
1852 PK11_FreeSlot( slot );
1854 key = PK11_FindKeyByAnyCert( cert, pin_arg );
1858 SECCertificateUsage certUsage;
1859 PRBool checkSig = PR_TRUE;
1861 /* may not have a CA cert - ok - ignore SEC_ERROR_UNKNOWN_ISSUER */
1862 int errorToIgnore = SEC_ERROR_UNKNOWN_ISSUER;
1865 *pRetKey = key; /* caller will deal with this */
1867 SECKEY_DestroyPrivateKey( key );
1870 certUsage = certificateUsageSSLServer;
1872 certUsage = certificateUsageSSLClient;
1874 if ( ctx->tc_verify_cert ) {
1877 checkSig = PR_FALSE;
1879 if ( ctx->tc_warn_only ) {
1882 status = tlsm_verify_cert( ctx->tc_certdb, cert, pin_arg,
1883 checkSig, certUsage, errorToIgnore );
1884 if ( status == SECSuccess ) {
1888 PRErrorCode errcode = PR_GetError();
1889 Debug( LDAP_DEBUG_ANY,
1890 "TLS: error: could not find the private key for certificate %s - error %d:%s\n",
1891 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1895 *pRetCert = cert; /* caller will deal with this */
1897 CERT_DestroyCertificate( cert );
1904 tlsm_get_client_auth_data( void *arg, PRFileDesc *fd,
1905 CERTDistNames *caNames, CERTCertificate **pRetCert,
1906 SECKEYPrivateKey **pRetKey )
1908 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1912 /* don't need caNames - this function will call CERT_VerifyCertificateNow
1913 which will verify the cert against the known CAs */
1914 saveval = ctx->tc_warn_only;
1915 ctx->tc_warn_only = PR_TRUE;
1916 rc = tlsm_find_and_verify_cert_key( ctx, fd, ctx->tc_certname, 0, pRetCert, pRetKey );
1917 ctx->tc_warn_only = saveval;
1919 Debug( LDAP_DEBUG_ANY,
1920 "TLS: error: unable to perform client certificate authentication for "
1921 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1922 if ( pRetKey && *pRetKey ) {
1923 SECKEY_DestroyPrivateKey( *pRetKey );
1926 if ( pRetCert && *pRetCert ) {
1927 CERT_DestroyCertificate( *pRetCert );
1937 * ctx must have a tc_model that is valid
1938 * certname is in the form [<tokenname>:]<certnickname>
1939 * where <tokenname> is the name of the PKCS11 token
1940 * and <certnickname> is the nickname of the cert/key in
1944 tlsm_clientauth_init( tlsm_ctx *ctx )
1946 SECStatus status = SECFailure;
1950 saveval = ctx->tc_warn_only;
1951 ctx->tc_warn_only = PR_TRUE;
1952 rc = tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, 0, NULL, NULL );
1953 ctx->tc_warn_only = saveval;
1955 Debug( LDAP_DEBUG_ANY,
1956 "TLS: error: unable to set up client certificate authentication for "
1957 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1961 status = SSL_GetClientAuthDataHook( ctx->tc_model,
1962 tlsm_get_client_auth_data,
1965 return ( status == SECSuccess ? 0 : -1 );
1969 * Tear down the TLS subsystem. Should only be called once.
1972 tlsm_destroy( void )
1974 #ifdef LDAP_R_COMPILE
1975 ldap_pvt_thread_mutex_destroy( &tlsm_init_mutex );
1976 ldap_pvt_thread_mutex_destroy( &tlsm_pem_mutex );
1980 static struct ldaptls *
1981 tlsm_copy_config ( const struct ldaptls *config )
1983 struct ldaptls *copy;
1987 copy = LDAP_MALLOC(sizeof(*copy));
1991 memset(copy, 0, sizeof(*copy));
1993 if (config->lt_certfile)
1994 copy->lt_certfile = LDAP_STRDUP(config->lt_certfile);
1995 if (config->lt_keyfile)
1996 copy->lt_keyfile = LDAP_STRDUP(config->lt_keyfile);
1997 if (config->lt_dhfile)
1998 copy->lt_dhfile = LDAP_STRDUP(config->lt_dhfile);
1999 if (config->lt_cacertfile)
2000 copy->lt_cacertfile = LDAP_STRDUP(config->lt_cacertfile);
2001 if (config->lt_cacertdir)
2002 copy->lt_cacertdir = LDAP_STRDUP(config->lt_cacertdir);
2003 if (config->lt_ciphersuite)
2004 copy->lt_ciphersuite = LDAP_STRDUP(config->lt_ciphersuite);
2005 if (config->lt_crlfile)
2006 copy->lt_crlfile = LDAP_STRDUP(config->lt_crlfile);
2007 if (config->lt_randfile)
2008 copy->lt_randfile = LDAP_STRDUP(config->lt_randfile);
2010 copy->lt_protocol_min = config->lt_protocol_min;
2016 tlsm_free_config ( struct ldaptls *config )
2020 if (config->lt_certfile)
2021 LDAP_FREE(config->lt_certfile);
2022 if (config->lt_keyfile)
2023 LDAP_FREE(config->lt_keyfile);
2024 if (config->lt_dhfile)
2025 LDAP_FREE(config->lt_dhfile);
2026 if (config->lt_cacertfile)
2027 LDAP_FREE(config->lt_cacertfile);
2028 if (config->lt_cacertdir)
2029 LDAP_FREE(config->lt_cacertdir);
2030 if (config->lt_ciphersuite)
2031 LDAP_FREE(config->lt_ciphersuite);
2032 if (config->lt_crlfile)
2033 LDAP_FREE(config->lt_crlfile);
2034 if (config->lt_randfile)
2035 LDAP_FREE(config->lt_randfile);
2041 tlsm_ctx_new ( struct ldapoptions *lo )
2045 ctx = LDAP_MALLOC( sizeof (*ctx) );
2048 #ifdef LDAP_R_COMPILE
2049 ldap_pvt_thread_mutex_init( &ctx->tc_refmutex );
2051 ctx->tc_config = NULL; /* populated later by tlsm_ctx_init */
2052 ctx->tc_certdb = NULL;
2053 ctx->tc_certname = NULL;
2054 ctx->tc_pin_file = NULL;
2055 ctx->tc_model = NULL;
2056 memset(&ctx->tc_callonce, 0, sizeof(ctx->tc_callonce));
2057 ctx->tc_require_cert = lo->ldo_tls_require_cert;
2058 ctx->tc_verify_cert = PR_FALSE;
2059 ctx->tc_using_pem = PR_FALSE;
2060 ctx->tc_slotname = NULL;
2061 #ifdef HAVE_NSS_INITCONTEXT
2062 ctx->tc_initctx = NULL;
2063 #endif /* HAVE_NSS_INITCONTEXT */
2064 ctx->tc_pem_objs = NULL;
2065 ctx->tc_n_pem_objs = 0;
2066 ctx->tc_warn_only = PR_FALSE;
2068 return (tls_ctx *)ctx;
2072 tlsm_ctx_ref( tls_ctx *ctx )
2074 tlsm_ctx *c = (tlsm_ctx *)ctx;
2075 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2077 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2081 tlsm_ctx_free ( tls_ctx *ctx )
2083 tlsm_ctx *c = (tlsm_ctx *)ctx;
2088 LDAP_MUTEX_LOCK( &c->tc_refmutex );
2089 refcount = --c->tc_refcnt;
2090 LDAP_MUTEX_UNLOCK( &c->tc_refmutex );
2094 PR_Close( c->tc_model );
2095 c->tc_certdb = NULL; /* if not the default, may have to clean up */
2096 PL_strfree( c->tc_certname );
2097 c->tc_certname = NULL;
2098 PL_strfree( c->tc_pin_file );
2099 c->tc_pin_file = NULL;
2100 PL_strfree( c->tc_slotname );
2101 tlsm_free_pem_objs( c );
2102 #ifdef HAVE_NSS_INITCONTEXT
2103 if ( c->tc_initctx ) {
2104 LDAP_MUTEX_LOCK( &tlsm_init_mutex );
2105 if ( NSS_ShutdownContext( c->tc_initctx ) ) {
2106 PRErrorCode errcode = PR_GetError();
2107 Debug( LDAP_DEBUG_ANY,
2108 "TLS: could not shutdown NSS - error %d:%s.\n",
2109 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
2111 LDAP_MUTEX_UNLOCK( &tlsm_init_mutex );
2113 c->tc_initctx = NULL;
2114 #endif /* HAVE_NSS_INITCONTEXT */
2115 #ifdef LDAP_R_COMPILE
2116 ldap_pvt_thread_mutex_destroy( &c->tc_refmutex );
2120 tlsm_free_config( c->tc_config );
2126 * initialize a new TLS context
2129 tlsm_ctx_init( struct ldapoptions *lo, struct ldaptls *lt, int is_server )
2131 tlsm_ctx *ctx = (tlsm_ctx *)lo->ldo_tls_ctx;
2132 ctx->tc_config = tlsm_copy_config(lt);
2133 ctx->tc_is_server = is_server;
2139 tlsm_deferred_ctx_init( void *arg )
2141 tlsm_ctx *ctx = (tlsm_ctx *)arg;
2142 PRBool sslv2 = PR_FALSE;
2143 PRBool sslv3 = PR_TRUE;
2144 PRBool tlsv1 = PR_TRUE;
2145 PRBool request_cert = PR_FALSE;
2146 PRInt32 require_cert = PR_FALSE;
2150 if ( tlsm_deferred_init( ctx ) ) {
2151 Debug( LDAP_DEBUG_ANY,
2152 "TLS: could not perform TLS system initialization.\n",
2157 ctx->tc_certdb = CERT_GetDefaultCertDB(); /* If there is ever a per-context db, change this */
2159 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2161 ctx->tc_model = SSL_ImportFD( NULL, fd );
2164 if ( !ctx->tc_model ) {
2165 PRErrorCode err = PR_GetError();
2166 Debug( LDAP_DEBUG_ANY,
2167 "TLS: could perform TLS socket I/O layer initialization - error %d:%s.\n",
2168 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2176 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_SECURITY, PR_TRUE ) ) {
2177 Debug( LDAP_DEBUG_ANY,
2178 "TLS: could not set secure mode on.\n",
2183 lt = ctx->tc_config;
2185 /* default is sslv3 and tlsv1 */
2186 if ( lt->lt_protocol_min ) {
2187 if ( lt->lt_protocol_min > LDAP_OPT_X_TLS_PROTOCOL_SSL3 ) {
2189 } else if ( lt->lt_protocol_min <= LDAP_OPT_X_TLS_PROTOCOL_SSL2 ) {
2191 Debug( LDAP_DEBUG_ANY,
2192 "TLS: warning: minimum TLS protocol level set to "
2193 "include SSLv2 - SSLv2 is insecure - do not use\n", 0, 0, 0 );
2196 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL2, sslv2 ) ) {
2197 Debug( LDAP_DEBUG_ANY,
2198 "TLS: could not set SSLv2 mode on.\n",
2202 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL3, sslv3 ) ) {
2203 Debug( LDAP_DEBUG_ANY,
2204 "TLS: could not set SSLv3 mode on.\n",
2208 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_TLS, tlsv1 ) ) {
2209 Debug( LDAP_DEBUG_ANY,
2210 "TLS: could not set TLSv1 mode on.\n",
2215 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_CLIENT, !ctx->tc_is_server ) ) {
2216 Debug( LDAP_DEBUG_ANY,
2217 "TLS: could not set handshake as client.\n",
2221 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_SERVER, ctx->tc_is_server ) ) {
2222 Debug( LDAP_DEBUG_ANY,
2223 "TLS: could not set handshake as server.\n",
2228 if ( lt->lt_ciphersuite ) {
2229 if ( tlsm_parse_ciphers( ctx, lt->lt_ciphersuite ) ) {
2230 Debug( LDAP_DEBUG_ANY,
2231 "TLS: could not set cipher list %s.\n",
2232 lt->lt_ciphersuite, 0, 0 );
2235 } else if ( tlsm_parse_ciphers( ctx, "DEFAULT" ) ) {
2236 Debug( LDAP_DEBUG_ANY,
2237 "TLS: could not set cipher list DEFAULT.\n",
2242 if ( !ctx->tc_require_cert ) {
2243 ctx->tc_verify_cert = PR_FALSE;
2244 } else if ( !ctx->tc_is_server ) {
2245 request_cert = PR_TRUE;
2246 require_cert = SSL_REQUIRE_NO_ERROR;
2247 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
2248 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
2249 require_cert = SSL_REQUIRE_ALWAYS;
2251 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW )
2252 ctx->tc_verify_cert = PR_TRUE;
2253 } else { /* server */
2254 /* server does not request certs by default */
2255 /* if allow - client may send cert, server will ignore if errors */
2256 /* if try - client may send cert, server will error if bad cert */
2257 /* if hard or demand - client must send cert, server will error if bad cert */
2258 request_cert = PR_TRUE;
2259 require_cert = SSL_REQUIRE_NO_ERROR;
2260 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
2261 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
2262 require_cert = SSL_REQUIRE_ALWAYS;
2264 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW ) {
2265 ctx->tc_verify_cert = PR_TRUE;
2267 ctx->tc_warn_only = PR_TRUE;
2271 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUEST_CERTIFICATE, request_cert ) ) {
2272 Debug( LDAP_DEBUG_ANY,
2273 "TLS: could not set request certificate mode.\n",
2278 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUIRE_CERTIFICATE, require_cert ) ) {
2279 Debug( LDAP_DEBUG_ANY,
2280 "TLS: could not set require certificate mode.\n",
2285 /* set up our cert and key, if any */
2286 if ( lt->lt_certfile ) {
2287 /* if using the PEM module, load the PEM file specified by lt_certfile */
2288 /* otherwise, assume this is the name of a cert already in the db */
2289 if ( ctx->tc_using_pem ) {
2290 /* this sets ctx->tc_certname to the correct value */
2291 int rc = tlsm_add_cert_from_file( ctx, lt->lt_certfile, PR_FALSE, PR_TRUE );
2296 PL_strfree( ctx->tc_certname );
2297 ctx->tc_certname = PL_strdup( lt->lt_certfile );
2301 if ( lt->lt_keyfile ) {
2302 /* if using the PEM module, load the PEM file specified by lt_keyfile */
2303 /* otherwise, assume this is the pininfo for the key */
2304 if ( ctx->tc_using_pem ) {
2305 /* this sets ctx->tc_certname to the correct value */
2306 int rc = tlsm_add_key_from_file( ctx, lt->lt_keyfile );
2311 PL_strfree( ctx->tc_pin_file );
2312 ctx->tc_pin_file = PL_strdup( lt->lt_keyfile );
2316 /* Set up callbacks for use by clients */
2317 if ( !ctx->tc_is_server ) {
2318 if ( SSL_OptionSet( ctx->tc_model, SSL_NO_CACHE, PR_TRUE ) != SECSuccess ) {
2319 PRErrorCode err = PR_GetError();
2320 Debug( LDAP_DEBUG_ANY,
2321 "TLS: error: could not set nocache option for moznss - error %d:%s\n",
2322 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2326 if ( SSL_BadCertHook( ctx->tc_model, tlsm_bad_cert_handler, ctx ) != SECSuccess ) {
2327 PRErrorCode err = PR_GetError();
2328 Debug( LDAP_DEBUG_ANY,
2329 "TLS: error: could not set bad cert handler for moznss - error %d:%s\n",
2330 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2335 since a cert has been specified, assume the client wants to do cert auth
2337 if ( ctx->tc_certname ) {
2338 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
2339 Debug( LDAP_DEBUG_ANY,
2340 "TLS: error: unable to authenticate to the security device for certificate %s\n",
2341 ctx->tc_certname, 0, 0 );
2344 if ( tlsm_clientauth_init( ctx ) ) {
2345 Debug( LDAP_DEBUG_ANY,
2346 "TLS: error: unable to set up client certificate authentication using %s\n",
2347 ctx->tc_certname, 0, 0 );
2351 } else { /* set up secure server */
2353 CERTCertificate *serverCert = NULL;
2354 SECKEYPrivateKey *serverKey = NULL;
2357 /* must have a certificate for the server to use */
2358 if ( !ctx->tc_certname ) {
2359 Debug( LDAP_DEBUG_ANY,
2360 "TLS: error: no server certificate: must specify a certificate for the server to use\n",
2365 /* authenticate to the server's token - this will do nothing
2366 if the key/cert db is not password protected */
2367 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
2368 Debug( LDAP_DEBUG_ANY,
2369 "TLS: error: unable to authenticate to the security device for certificate %s\n",
2370 ctx->tc_certname, 0, 0 );
2374 /* get the server's key and cert */
2375 if ( tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, ctx->tc_is_server,
2376 &serverCert, &serverKey ) ) {
2377 Debug( LDAP_DEBUG_ANY,
2378 "TLS: error: unable to find and verify server's cert and key for certificate %s\n",
2379 ctx->tc_certname, 0, 0 );
2380 CERT_DestroyCertificate( serverCert );
2381 SECKEY_DestroyPrivateKey( serverKey );
2385 certKEA = NSS_FindCertKEAType( serverCert );
2386 /* configure the socket to be a secure server socket */
2387 status = SSL_ConfigSecureServer( ctx->tc_model, serverCert, serverKey, certKEA );
2388 /* SSL_ConfigSecureServer copies these */
2389 CERT_DestroyCertificate( serverCert );
2390 SECKEY_DestroyPrivateKey( serverKey );
2392 if ( SECSuccess != status ) {
2393 PRErrorCode err = PR_GetError();
2394 Debug( LDAP_DEBUG_ANY,
2395 "TLS: error: unable to configure secure server using certificate %s - error %d:%s\n",
2396 ctx->tc_certname, err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) );
2401 /* Callback for authenticating certificate */
2402 if ( SSL_AuthCertificateHook( ctx->tc_model, tlsm_auth_cert_handler,
2403 ctx ) != SECSuccess ) {
2404 PRErrorCode err = PR_GetError();
2405 Debug( LDAP_DEBUG_ANY,
2406 "TLS: error: could not set auth cert handler for moznss - error %d:%s\n",
2407 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2411 if ( SSL_HandshakeCallback( ctx->tc_model, tlsm_handshake_complete_cb, ctx ) ) {
2412 PRErrorCode err = PR_GetError();
2413 Debug( LDAP_DEBUG_ANY,
2414 "TLS: error: could not set handshake callback for moznss - error %d:%s\n",
2415 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2419 tlsm_free_config( ctx->tc_config );
2420 ctx->tc_config = NULL;
2426 tlsm_session *session;
2427 Sockbuf_IO_Desc *sbiod;
2428 /* there seems to be no portable way to determine if the
2429 sockbuf sd has been set to nonblocking mode - the
2430 call to ber_pvt_socket_set_nonblock() takes place
2431 before the tls socket is set up, so we cannot
2432 intercept that call either.
2433 On systems where fcntl is available, we can just
2434 F_GETFL and test for O_NONBLOCK. On other systems,
2435 we will just see if the IO op returns EAGAIN or EWOULDBLOCK,
2436 and just set this flag */
2439 * NSS tries hard to be backwards compatible with SSLv2 clients, or
2440 * clients that send an SSLv2 client hello. This message is not
2441 * tagged in any way, so NSS has no way to know if the incoming
2442 * message is a valid SSLv2 client hello or just some bogus data
2443 * (or cleartext LDAP). We store the first byte read from the
2444 * client here. The most common case will be a client sending
2445 * LDAP data instead of SSL encrypted LDAP data. This can happen,
2446 * for example, if using ldapsearch -Z - if the starttls fails,
2447 * the client will fallback to plain cleartext LDAP. So if we
2448 * see that the firstbyte is a valid LDAP tag, we can be
2449 * pretty sure this is happening.
2453 * NSS doesn't return SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE, etc.
2454 * when it is blocked, so we have to set a flag in the wrapped send
2455 * and recv calls that tells us what operation NSS was last blocked
2459 #define TLSM_WRITE 2
2463 static struct tls_data *
2464 tlsm_get_pvt_tls_data( PRFileDesc *fd )
2473 myfd = PR_GetIdentitiesLayer( fd, tlsm_layer_id );
2479 p = (struct tls_data *)myfd->secret;
2485 tlsm_is_non_ssl_message( PRFileDesc *fd, ber_tag_t *thebyte )
2490 *thebyte = LBER_DEFAULT;
2493 p = tlsm_get_pvt_tls_data( fd );
2494 if ( p == NULL || p->sbiod == NULL ) {
2498 if ( p->firsttag == LBER_SEQUENCE ) {
2500 *thebyte = p->firsttag;
2508 static tls_session *
2509 tlsm_session_new ( tls_ctx * ctx, int is_server )
2511 tlsm_ctx *c = (tlsm_ctx *)ctx;
2512 tlsm_session *session;
2517 c->tc_is_server = is_server;
2518 status = PR_CallOnceWithArg( &c->tc_callonce, tlsm_deferred_ctx_init, c );
2519 if ( PR_SUCCESS != status ) {
2520 PRErrorCode err = PR_GetError();
2521 Debug( LDAP_DEBUG_ANY,
2522 "TLS: error: could not initialize moznss security context - error %d:%s\n",
2523 err, PR_ErrorToString(err, PR_LANGUAGE_I_DEFAULT), NULL );
2527 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2532 session = SSL_ImportFD( c->tc_model, fd );
2538 rc = SSL_ResetHandshake( session, is_server );
2540 PRErrorCode err = PR_GetError();
2541 Debug( LDAP_DEBUG_TRACE,
2542 "TLS: error: new session - reset handshake failure %d - error %d:%s\n",
2544 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2546 PR_Close( session );
2550 return (tls_session *)session;
2554 tlsm_session_accept_or_connect( tls_session *session, int is_accept )
2556 tlsm_session *s = (tlsm_session *)session;
2558 const char *op = is_accept ? "accept" : "connect";
2561 LDAP_MUTEX_LOCK( &tlsm_pem_mutex );
2563 rc = SSL_ForceHandshake( s );
2565 LDAP_MUTEX_UNLOCK( &tlsm_pem_mutex );
2568 PRErrorCode err = PR_GetError();
2570 if ( err == PR_WOULD_BLOCK_ERROR ) {
2571 ber_tag_t thetag = LBER_DEFAULT;
2572 /* see if we are blocked because of a bogus packet */
2573 if ( tlsm_is_non_ssl_message( s, &thetag ) ) { /* see if we received a non-SSL message */
2574 Debug( LDAP_DEBUG_ANY,
2575 "TLS: error: %s - error - received non-SSL message [0x%x]\n",
2576 op, (unsigned int)thetag, 0 );
2577 /* reset error to something more descriptive */
2578 PR_SetError( SSL_ERROR_RX_MALFORMED_HELLO_REQUEST, EPROTO );
2581 Debug( LDAP_DEBUG_ANY,
2582 "TLS: error: %s - force handshake failure: errno %d - moznss error %d\n",
2590 tlsm_session_accept( tls_session *session )
2592 return tlsm_session_accept_or_connect( session, 1 );
2596 tlsm_session_connect( LDAP *ld, tls_session *session )
2598 return tlsm_session_accept_or_connect( session, 0 );
2602 tlsm_session_upflags( Sockbuf *sb, tls_session *session, int rc )
2604 int prerror = PR_GetError();
2606 if ( ( prerror == PR_PENDING_INTERRUPT_ERROR ) || ( prerror == PR_WOULD_BLOCK_ERROR ) ) {
2607 tlsm_session *s = (tlsm_session *)session;
2608 struct tls_data *p = tlsm_get_pvt_tls_data( s );
2610 if ( p && ( p->io_flag == TLSM_READ ) ) {
2611 sb->sb_trans_needs_read = 1;
2613 } else if ( p && ( p->io_flag == TLSM_WRITE ) ) {
2614 sb->sb_trans_needs_write = 1;
2623 tlsm_session_errmsg( tls_session *sess, int rc, char *buf, size_t len )
2626 int prerror = PR_GetError();
2628 i = PR_GetErrorTextLength();
2630 char *msg = LDAP_MALLOC( i+1 );
2631 PR_GetErrorText( msg );
2632 memcpy( buf, msg, len );
2635 PR_GetErrorText( buf );
2636 } else if ( prerror ) {
2637 i = PR_snprintf( buf, len, "TLS error %d:%s",
2638 prerror, PR_ErrorToString( prerror, PR_LANGUAGE_I_DEFAULT ) );
2641 return ( i > 0 ) ? buf : NULL;
2645 tlsm_session_my_dn( tls_session *session, struct berval *der_dn )
2647 tlsm_session *s = (tlsm_session *)session;
2648 CERTCertificate *cert;
2650 cert = SSL_LocalCertificate( 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 );
2660 tlsm_session_peer_dn( tls_session *session, struct berval *der_dn )
2662 tlsm_session *s = (tlsm_session *)session;
2663 CERTCertificate *cert;
2665 cert = SSL_PeerCertificate( s );
2666 if (!cert) return LDAP_INVALID_CREDENTIALS;
2668 der_dn->bv_val = (char *)cert->derSubject.data;
2669 der_dn->bv_len = cert->derSubject.len;
2670 CERT_DestroyCertificate( cert );
2674 /* what kind of hostname were we given? */
2680 tlsm_session_chkhost( LDAP *ld, tls_session *session, const char *name_in )
2682 tlsm_session *s = (tlsm_session *)session;
2683 CERTCertificate *cert;
2684 const char *name, *domain = NULL, *ptr;
2685 int ret, ntype = IS_DNS, nlen, dlen;
2686 #ifdef LDAP_PF_INET6
2687 struct in6_addr addr;
2689 struct in_addr addr;
2694 if( ldap_int_hostname &&
2695 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
2697 name = ldap_int_hostname;
2701 nlen = strlen( name );
2703 cert = SSL_PeerCertificate( s );
2705 Debug( LDAP_DEBUG_ANY,
2706 "TLS: unable to get peer certificate.\n",
2708 /* if this was a fatal condition, things would have
2709 * aborted long before now.
2711 return LDAP_SUCCESS;
2714 #ifdef LDAP_PF_INET6
2715 if (inet_pton(AF_INET6, name, &addr)) {
2719 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
2720 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
2722 if (ntype == IS_DNS ) {
2723 domain = strchr( name, '.' );
2725 dlen = nlen - ( domain - name );
2728 ret = LDAP_LOCAL_ERROR;
2730 rv = CERT_FindCertExtension( cert, SEC_OID_X509_SUBJECT_ALT_NAME,
2732 if ( rv == SECSuccess && altname.data ) {
2734 CERTGeneralName *names, *cur;
2736 arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
2738 ret = LDAP_NO_MEMORY;
2742 names = cur = CERT_DecodeAltNameExtension(arena, &altname);
2751 if ( !cur->name.other.len ) continue;
2753 host = (char *)cur->name.other.data;
2754 hlen = cur->name.other.len;
2756 if ( cur->type == certDNSName ) {
2757 if ( ntype != IS_DNS ) continue;
2759 /* is this an exact match? */
2760 if ( nlen == hlen && !strncasecmp( name, host, nlen )) {
2765 /* is this a wildcard match? */
2766 if ( domain && host[0] == '*' && host[1] == '.' &&
2767 dlen == hlen-1 && !strncasecmp( domain, host+1, dlen )) {
2771 } else if ( cur->type == certIPAddress ) {
2772 if ( ntype == IS_DNS ) continue;
2774 #ifdef LDAP_PF_INET6
2775 if (ntype == IS_IP6 && hlen != sizeof(struct in6_addr)) {
2779 if (ntype == IS_IP4 && hlen != sizeof(struct in_addr)) {
2782 if (!memcmp(host, &addr, hlen)) {
2787 } while (( cur = CERT_GetNextGeneralName( cur )) != names );
2789 PORT_FreeArena( arena, PR_FALSE );
2790 SECITEM_FreeItem( &altname, PR_FALSE );
2792 /* no altnames matched, try the CN */
2793 if ( ret != LDAP_SUCCESS ) {
2794 /* find the last CN */
2795 CERTRDN *rdn, **rdns;
2796 CERTAVA *lastava = NULL;
2800 rdns = cert->subject.rdns;
2801 while ( rdns && ( rdn = *rdns++ )) {
2802 CERTAVA *ava, **avas = rdn->avas;
2803 while ( avas && ( ava = *avas++ )) {
2804 if ( CERT_GetAVATag( ava ) == SEC_OID_AVA_COMMON_NAME )
2809 SECItem *av = CERT_DecodeAVAValue( &lastava->value );
2811 if ( av->len == nlen && !strncasecmp( name, (char *)av->data, nlen )) {
2813 } else if ( av->data[0] == '*' && av->data[1] == '.' &&
2814 domain && dlen == av->len - 1 && !strncasecmp( domain,
2815 (char *)(av->data+1), dlen )) {
2819 if ( len >= sizeof(buf) )
2820 len = sizeof(buf)-1;
2821 memcpy( buf, av->data, len );
2824 SECITEM_FreeItem( av, PR_TRUE );
2827 if ( ret != LDAP_SUCCESS ) {
2828 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
2829 "common name in certificate (%s).\n",
2831 ret = LDAP_CONNECT_ERROR;
2832 if ( ld->ld_error ) {
2833 LDAP_FREE( ld->ld_error );
2835 ld->ld_error = LDAP_STRDUP(
2836 _("TLS: hostname does not match CN in peer certificate"));
2841 CERT_DestroyCertificate( cert );
2846 tlsm_session_strength( tls_session *session )
2848 tlsm_session *s = (tlsm_session *)session;
2851 rc = SSL_SecurityStatus( s, NULL, NULL, NULL, &keySize,
2853 return rc ? 0 : keySize;
2857 * TLS support for LBER Sockbufs
2860 static PRStatus PR_CALLBACK
2861 tlsm_PR_Close(PRFileDesc *fd)
2863 int rc = PR_SUCCESS;
2865 /* we don't need to actually close anything here, just
2866 pop our io layer off the stack */
2867 fd->secret = NULL; /* must have been freed before calling PR_Close */
2869 fd = PR_PopIOLayer( fd, tlsm_layer_id );
2870 /* if we are not the last layer, pass the close along */
2875 rc = fd->methods->close( fd );
2878 /* we are the last layer - just call our dtor */
2885 static PRStatus PR_CALLBACK
2886 tlsm_PR_Shutdown(PRFileDesc *fd, PRShutdownHow how)
2888 int rc = PR_SUCCESS;
2891 rc = PR_Shutdown( fd->lower, how );
2897 static int PR_CALLBACK
2898 tlsm_PR_Recv(PRFileDesc *fd, void *buf, PRInt32 len, PRIntn flags,
2899 PRIntervalTime timeout)
2904 if ( buf == NULL || len <= 0 ) return 0;
2906 p = tlsm_get_pvt_tls_data( fd );
2908 if ( p == NULL || p->sbiod == NULL ) {
2912 rc = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
2914 tlsm_map_error( errno );
2915 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2916 p->nonblock = PR_TRUE; /* fd is using non-blocking io */
2917 } else if ( errno ) { /* real error */
2918 Debug( LDAP_DEBUG_TRACE,
2919 "TLS: error: tlsm_PR_Recv returned %d - error %d:%s\n",
2920 rc, errno, STRERROR(errno) );
2922 } else if ( ( rc > 0 ) && ( len > 0 ) && ( p->firsttag == LBER_DEFAULT ) ) {
2923 p->firsttag = (ber_tag_t)*((char *)buf);
2925 p->io_flag = TLSM_READ;
2930 static int PR_CALLBACK
2931 tlsm_PR_Send(PRFileDesc *fd, const void *buf, PRInt32 len, PRIntn flags,
2932 PRIntervalTime timeout)
2937 if ( buf == NULL || len <= 0 ) return 0;
2939 p = tlsm_get_pvt_tls_data( fd );
2941 if ( p == NULL || p->sbiod == NULL ) {
2945 rc = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
2947 tlsm_map_error( errno );
2948 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2949 p->nonblock = PR_TRUE;
2950 } else if ( errno ) { /* real error */
2951 Debug( LDAP_DEBUG_TRACE,
2952 "TLS: error: tlsm_PR_Send returned %d - error %d:%s\n",
2953 rc, errno, STRERROR(errno) );
2956 p->io_flag = TLSM_WRITE;
2961 static int PR_CALLBACK
2962 tlsm_PR_Read(PRFileDesc *fd, void *buf, PRInt32 len)
2964 return tlsm_PR_Recv( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2967 static int PR_CALLBACK
2968 tlsm_PR_Write(PRFileDesc *fd, const void *buf, PRInt32 len)
2970 return tlsm_PR_Send( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2973 static PRStatus PR_CALLBACK
2974 tlsm_PR_GetPeerName(PRFileDesc *fd, PRNetAddr *addr)
2979 p = tlsm_get_pvt_tls_data( fd );
2981 if ( p == NULL || p->sbiod == NULL ) {
2984 len = sizeof(PRNetAddr);
2985 return getpeername( p->sbiod->sbiod_sb->sb_fd, (struct sockaddr *)addr, &len );
2988 static PRStatus PR_CALLBACK
2989 tlsm_PR_GetSocketOption(PRFileDesc *fd, PRSocketOptionData *data)
2992 p = tlsm_get_pvt_tls_data( fd );
2994 if ( p == NULL || data == NULL ) {
2998 /* only the nonblocking option is supported at this time
2999 MozNSS SSL code needs it */
3000 if ( data->option != PR_SockOpt_Nonblocking ) {
3001 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3005 int flags = fcntl( p->sbiod->sbiod_sb->sb_fd, F_GETFL );
3006 data->value.non_blocking = (flags & O_NONBLOCK) ? PR_TRUE : PR_FALSE;
3008 data->value.non_blocking = p->nonblock;
3013 static PRStatus PR_CALLBACK
3016 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3020 static PRFileDesc * PR_CALLBACK
3023 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3027 static PRInt16 PR_CALLBACK
3030 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3034 static PRInt32 PR_CALLBACK
3037 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3041 static PRInt64 PR_CALLBACK
3046 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
3051 static const PRIOMethods tlsm_PR_methods = {
3053 tlsm_PR_Close, /* close */
3054 tlsm_PR_Read, /* read */
3055 tlsm_PR_Write, /* write */
3056 tlsm_PR_i32_unimp, /* available */
3057 tlsm_PR_i64_unimp, /* available64 */
3058 tlsm_PR_prs_unimp, /* fsync */
3059 tlsm_PR_i32_unimp, /* seek */
3060 tlsm_PR_i64_unimp, /* seek64 */
3061 tlsm_PR_prs_unimp, /* fileInfo */
3062 tlsm_PR_prs_unimp, /* fileInfo64 */
3063 tlsm_PR_i32_unimp, /* writev */
3064 tlsm_PR_prs_unimp, /* connect */
3065 tlsm_PR_pfd_unimp, /* accept */
3066 tlsm_PR_prs_unimp, /* bind */
3067 tlsm_PR_prs_unimp, /* listen */
3068 (PRShutdownFN)tlsm_PR_Shutdown, /* shutdown */
3069 tlsm_PR_Recv, /* recv */
3070 tlsm_PR_Send, /* send */
3071 tlsm_PR_i32_unimp, /* recvfrom */
3072 tlsm_PR_i32_unimp, /* sendto */
3073 (PRPollFN)tlsm_PR_i16_unimp, /* poll */
3074 tlsm_PR_i32_unimp, /* acceptread */
3075 tlsm_PR_i32_unimp, /* transmitfile */
3076 tlsm_PR_prs_unimp, /* getsockname */
3077 tlsm_PR_GetPeerName, /* getpeername */
3078 tlsm_PR_i32_unimp, /* getsockopt OBSOLETE */
3079 tlsm_PR_i32_unimp, /* setsockopt OBSOLETE */
3080 tlsm_PR_GetSocketOption, /* getsocketoption */
3081 tlsm_PR_i32_unimp, /* setsocketoption */
3082 tlsm_PR_i32_unimp, /* Send a (partial) file with header/trailer*/
3083 (PRConnectcontinueFN)tlsm_PR_prs_unimp, /* connectcontinue */
3084 tlsm_PR_i32_unimp, /* reserved for future use */
3085 tlsm_PR_i32_unimp, /* reserved for future use */
3086 tlsm_PR_i32_unimp, /* reserved for future use */
3087 tlsm_PR_i32_unimp /* reserved for future use */
3091 * Initialize TLS subsystem. Should be called only once.
3092 * See tlsm_deferred_init for the bulk of the init process
3097 char *nofork = PR_GetEnv( "NSS_STRICT_NOFORK" );
3101 tlsm_layer_id = PR_GetUniqueIdentity( "OpenLDAP" );
3104 * There are some applications that acquire a crypto context in the parent process
3105 * and expect that crypto context to work after a fork(). This does not work
3106 * with NSS using strict PKCS11 compliance mode. We set this environment
3107 * variable here to tell the software encryption module/token to allow crypto
3108 * contexts to persist across a fork(). However, if you are using some other
3109 * module or encryption device that supports and expects full PKCS11 semantics,
3110 * the only recourse is to rewrite the application with atfork() handlers to save
3111 * the crypto context in the parent and restore (and SECMOD_RestartModules) the
3112 * context in the child.
3115 /* will leak one time */
3116 char *noforkenvvar = PL_strdup( "NSS_STRICT_NOFORK=DISABLED" );
3117 PR_SetEnv( noforkenvvar );
3124 tlsm_sb_setup( Sockbuf_IO_Desc *sbiod, void *arg )
3127 tlsm_session *session = arg;
3130 assert( sbiod != NULL );
3132 p = LBER_MALLOC( sizeof( *p ) );
3137 fd = PR_GetIdentitiesLayer( session, tlsm_layer_id );
3143 fd->secret = (PRFilePrivate *)p;
3144 p->session = session;
3146 p->firsttag = LBER_DEFAULT;
3147 sbiod->sbiod_pvt = p;
3152 tlsm_sb_remove( Sockbuf_IO_Desc *sbiod )
3156 assert( sbiod != NULL );
3157 assert( sbiod->sbiod_pvt != NULL );
3159 p = (struct tls_data *)sbiod->sbiod_pvt;
3160 PR_Close( p->session );
3161 LBER_FREE( sbiod->sbiod_pvt );
3162 sbiod->sbiod_pvt = NULL;
3167 tlsm_sb_close( Sockbuf_IO_Desc *sbiod )
3171 assert( sbiod != NULL );
3172 assert( sbiod->sbiod_pvt != NULL );
3174 p = (struct tls_data *)sbiod->sbiod_pvt;
3175 PR_Shutdown( p->session, PR_SHUTDOWN_BOTH );
3180 tlsm_sb_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
3184 assert( sbiod != NULL );
3185 assert( sbiod->sbiod_pvt != NULL );
3187 p = (struct tls_data *)sbiod->sbiod_pvt;
3189 if ( opt == LBER_SB_OPT_GET_SSL ) {
3190 *((tlsm_session **)arg) = p->session;
3193 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
3194 if ( p && ( SSL_DataPending( p->session ) > 0 ) ) {
3200 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
3204 tlsm_sb_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3210 assert( sbiod != NULL );
3211 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3213 p = (struct tls_data *)sbiod->sbiod_pvt;
3215 ret = PR_Recv( p->session, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3217 err = PR_GetError();
3218 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3219 sbiod->sbiod_sb->sb_trans_needs_read = 1;
3220 sock_errset(EWOULDBLOCK);
3223 sbiod->sbiod_sb->sb_trans_needs_read = 0;
3229 tlsm_sb_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
3235 assert( sbiod != NULL );
3236 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
3238 p = (struct tls_data *)sbiod->sbiod_pvt;
3240 ret = PR_Send( p->session, (char *)buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
3242 err = PR_GetError();
3243 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
3244 sbiod->sbiod_sb->sb_trans_needs_write = 1;
3245 sock_errset(EWOULDBLOCK);
3249 sbiod->sbiod_sb->sb_trans_needs_write = 0;
3254 static Sockbuf_IO tlsm_sbio =
3256 tlsm_sb_setup, /* sbi_setup */
3257 tlsm_sb_remove, /* sbi_remove */
3258 tlsm_sb_ctrl, /* sbi_ctrl */
3259 tlsm_sb_read, /* sbi_read */
3260 tlsm_sb_write, /* sbi_write */
3261 tlsm_sb_close /* sbi_close */
3264 tls_impl ldap_int_tls_impl = {
3276 tlsm_session_connect,
3277 tlsm_session_accept,
3278 tlsm_session_upflags,
3279 tlsm_session_errmsg,
3281 tlsm_session_peer_dn,
3282 tlsm_session_chkhost,
3283 tlsm_session_strength,
3287 #ifdef LDAP_R_COMPILE
3296 #endif /* HAVE_MOZNSS */