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-2010 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* ACKNOWLEDGEMENTS: Initial version written by Howard Chu.
17 * Additional support by Rich Megginson.
24 #include "ldap_config.h"
28 #if defined( HAVE_FCNTL_H )
32 #include <ac/stdlib.h>
34 #include <ac/socket.h>
35 #include <ac/string.h>
38 #include <ac/unistd.h>
40 #include <ac/dirent.h>
46 #include <ldap_pvt_thread.h>
49 #define READ_PASSWORD_FROM_STDIN
50 #define READ_PASSWORD_FROM_FILE
52 #ifdef READ_PASSWORD_FROM_STDIN
53 #include <termios.h> /* for echo on/off */
56 #include <nspr/nspr.h>
57 #include <nspr/private/pprio.h>
60 #include <nss/sslerr.h>
61 #include <nss/sslproto.h>
62 #include <nss/pk11pub.h>
63 #include <nss/secerr.h>
64 #include <nss/keyhi.h>
65 #include <nss/secmod.h>
67 /* NSS 3.12.5 and later have NSS_InitContext */
68 #if NSS_VMAJOR <= 3 && NSS_VMINOR <= 12 && NSS_VPATCH < 5
71 #define HAVE_NSS_INITCONTEXT 1
74 /* InitContext does not currently work in server mode */
75 /* #define INITCONTEXT_HACK 1 */
77 typedef struct tlsm_ctx {
80 PRBool tc_verify_cert;
81 CERTCertDBHandle *tc_certdb;
84 struct ldaptls *tc_config;
87 PRCallOnceType tc_callonce;
89 char *tc_slotname; /* if using pem */
90 #ifdef HAVE_NSS_INITCONTEXT
91 NSSInitContext *tc_initctx; /* the NSS context */
93 PK11GenericObject **tc_pem_objs; /* array of objects to free */
94 int tc_n_pem_objs; /* number of objects */
96 ldap_pvt_thread_mutex_t tc_refmutex;
100 typedef PRFileDesc tlsm_session;
102 static PRDescIdentity tlsm_layer_id;
104 static const PRIOMethods tlsm_PR_methods;
106 #define PEM_LIBRARY "nsspem"
107 #define PEM_MODULE "PEM"
108 /* hash files for use with cacertdir have this file name suffix */
109 #define PEM_CA_HASH_FILE_SUFFIX ".0"
110 #define PEM_CA_HASH_FILE_SUFFIX_LEN 2
112 static SECMODModule *pem_module;
114 #define DEFAULT_TOKEN_NAME "default"
115 /* sprintf format used to create token name */
116 #define TLSM_PEM_TOKEN_FMT "PEM Token #%ld"
118 static int tlsm_slot_count;
120 #define PK11_SETATTRS(x,id,v,l) (x)->type = (id); \
121 (x)->pValue=(v); (x)->ulValueLen = (l);
123 /* forward declaration */
124 static int tlsm_init( void );
126 #ifdef LDAP_R_COMPILE
129 tlsm_thr_init( void )
133 #endif /* LDAP_R_COMPILE */
136 tlsm_dump_cipher_info(PRFileDesc *fd)
140 for (ii = 0; ii < SSL_NumImplementedCiphers; ++ii) {
141 PRInt32 cipher = (PRInt32)SSL_ImplementedCiphers[ii];
142 PRBool enabled = PR_FALSE;
144 SSLCipherSuiteInfo info;
147 SSL_CipherPrefGet(fd, cipher, &enabled);
149 SSL_CipherPrefGetDefault(cipher, &enabled);
151 SSL_CipherPolicyGet(cipher, &policy);
152 SSL_GetCipherSuiteInfo(cipher, &info, (PRUintn)sizeof(info));
153 Debug( LDAP_DEBUG_TRACE,
154 "TLS: cipher: %d - %s, enabled: %d, ",
155 info.cipherSuite, info.cipherSuiteName, enabled );
156 Debug( LDAP_DEBUG_TRACE,
157 "policy: %d\n", policy, 0, 0 );
163 /* Cipher definitions */
165 char *ossl_name; /* The OpenSSL cipher name */
166 int num; /* The cipher id */
167 int attr; /* cipher attributes: algorithms, etc */
168 int version; /* protocol version valid for this cipher */
169 int bits; /* bits of strength */
170 int alg_bits; /* bits of the algorithm */
171 int strength; /* LOW, MEDIUM, HIGH */
172 int enabled; /* Enabled by default? */
175 /* cipher attributes */
176 #define SSL_kRSA 0x00000001L
177 #define SSL_aRSA 0x00000002L
178 #define SSL_aDSS 0x00000004L
179 #define SSL_DSS SSL_aDSS
180 #define SSL_eNULL 0x00000008L
181 #define SSL_DES 0x00000010L
182 #define SSL_3DES 0x00000020L
183 #define SSL_RC4 0x00000040L
184 #define SSL_RC2 0x00000080L
185 #define SSL_AES 0x00000100L
186 #define SSL_MD5 0x00000200L
187 #define SSL_SHA1 0x00000400L
188 #define SSL_SHA SSL_SHA1
189 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
191 /* cipher strength */
192 #define SSL_NULL 0x00000001L
193 #define SSL_EXPORT40 0x00000002L
194 #define SSL_EXPORT56 0x00000004L
195 #define SSL_LOW 0x00000008L
196 #define SSL_MEDIUM 0x00000010L
197 #define SSL_HIGH 0x00000020L
199 #define SSL2 0x00000001L
200 #define SSL3 0x00000002L
201 /* OpenSSL treats SSL3 and TLSv1 the same */
204 /* Cipher translation */
205 static cipher_properties ciphers_def[] = {
207 {"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},
208 {"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},
209 {"RC4-MD5", SSL_EN_RC4_128_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL2, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
210 {"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},
211 {"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},
212 {"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},
215 {"RC4-MD5", SSL_RSA_WITH_RC4_128_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
216 {"RC4-SHA", SSL_RSA_WITH_RC4_128_SHA, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_SHA1, SSL3, 128, 128, SSL_MEDIUM, SSL_NOT_ALLOWED},
217 {"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},
218 {"DES-CBC-SHA", SSL_RSA_WITH_DES_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_DES|SSL_SHA1, SSL3, 56, 56, SSL_LOW, SSL_ALLOWED},
219 {"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},
220 {"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},
221 {"NULL-MD5", SSL_RSA_WITH_NULL_MD5, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_MD5, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
222 {"NULL-SHA", SSL_RSA_WITH_NULL_SHA, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_SHA1, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
225 {"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},
226 {"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},
227 {"AES128-SHA", TLS_RSA_WITH_AES_128_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 128, 128, SSL_HIGH, SSL_NOT_ALLOWED},
228 {"AES256-SHA", TLS_RSA_WITH_AES_256_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_AES|SSL_SHA, TLS1, 256, 256, SSL_HIGH, SSL_NOT_ALLOWED},
231 #define ciphernum (sizeof(ciphers_def)/sizeof(cipher_properties))
233 /* given err which is the current errno, calls PR_SetError with
234 the corresponding NSPR error code */
236 tlsm_map_error(int err)
242 prError = PR_NO_ACCESS_RIGHTS_ERROR;
245 prError = PR_ADDRESS_IN_USE_ERROR;
248 prError = PR_ADDRESS_NOT_AVAILABLE_ERROR;
251 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
254 prError = PR_WOULD_BLOCK_ERROR;
257 * On QNX and Neutrino, EALREADY is defined as EBUSY.
259 #if EALREADY != EBUSY
261 prError = PR_ALREADY_INITIATED_ERROR;
265 prError = PR_BAD_DESCRIPTOR_ERROR;
269 prError = PR_IO_ERROR;
273 prError = PR_FILESYSTEM_MOUNTED_ERROR;
276 prError = PR_CONNECT_ABORTED_ERROR;
279 prError = PR_CONNECT_REFUSED_ERROR;
282 prError = PR_CONNECT_RESET_ERROR;
285 prError = PR_DEADLOCK_ERROR;
289 prError = PR_DIRECTORY_CORRUPTED_ERROR;
294 prError = PR_NO_DEVICE_SPACE_ERROR;
298 prError = PR_FILE_EXISTS_ERROR;
301 prError = PR_ACCESS_FAULT_ERROR;
304 prError = PR_FILE_TOO_BIG_ERROR;
307 prError = PR_HOST_UNREACHABLE_ERROR;
310 prError = PR_IN_PROGRESS_ERROR;
313 prError = PR_PENDING_INTERRUPT_ERROR;
316 prError = PR_INVALID_ARGUMENT_ERROR;
319 prError = PR_IO_ERROR;
322 prError = PR_IS_CONNECTED_ERROR;
325 prError = PR_IS_DIRECTORY_ERROR;
328 prError = PR_LOOP_ERROR;
331 prError = PR_PROC_DESC_TABLE_FULL_ERROR;
334 prError = PR_MAX_DIRECTORY_ENTRIES_ERROR;
337 prError = PR_INVALID_ARGUMENT_ERROR;
341 prError = PR_REMOTE_FILE_ERROR;
345 prError = PR_NAME_TOO_LONG_ERROR;
348 prError = PR_NETWORK_UNREACHABLE_ERROR;
351 prError = PR_SYS_DESC_TABLE_FULL_ERROR;
354 * On SCO OpenServer 5, ENOBUFS is defined as ENOSR.
356 #if defined(ENOBUFS) && (ENOBUFS != ENOSR)
358 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
362 prError = PR_FILE_NOT_FOUND_ERROR;
365 prError = PR_FILE_NOT_FOUND_ERROR;
368 prError = PR_FILE_IS_LOCKED_ERROR;
372 prError = PR_REMOTE_FILE_ERROR;
376 prError = PR_OUT_OF_MEMORY_ERROR;
379 prError = PR_INVALID_ARGUMENT_ERROR;
382 prError = PR_NO_DEVICE_SPACE_ERROR;
386 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
390 prError = PR_NOT_CONNECTED_ERROR;
393 prError = PR_NOT_DIRECTORY_ERROR;
396 prError = PR_NOT_SOCKET_ERROR;
399 prError = PR_FILE_NOT_FOUND_ERROR;
402 prError = PR_NOT_TCP_SOCKET_ERROR;
406 prError = PR_BUFFER_OVERFLOW_ERROR;
410 prError = PR_NO_ACCESS_RIGHTS_ERROR;
413 prError = PR_CONNECT_RESET_ERROR;
417 prError = PR_IO_ERROR;
420 case EPROTONOSUPPORT:
421 prError = PR_PROTOCOL_NOT_SUPPORTED_ERROR;
424 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
427 prError = PR_INVALID_METHOD_ERROR;
430 prError = PR_READ_ONLY_FILESYSTEM_ERROR;
433 prError = PR_INVALID_METHOD_ERROR;
436 prError = PR_IO_TIMEOUT_ERROR;
438 #if EWOULDBLOCK != EAGAIN
440 prError = PR_WOULD_BLOCK_ERROR;
444 prError = PR_NOT_SAME_DEVICE_ERROR;
447 prError = PR_UNKNOWN_ERROR;
450 PR_SetError( prError, err );
454 * cipher_list is an integer array with the following values:
455 * -1: never enable this cipher
460 nss_parse_ciphers(const char *cipherstr, int cipher_list[ciphernum])
469 /* All disabled to start */
470 for (i=0; i<ciphernum; i++)
473 ciphertip = strdup(cipherstr);
474 cipher = ciphers = ciphertip;
476 while (ciphers && (strlen(ciphers))) {
477 while ((*cipher) && (isspace(*cipher)))
482 case '+': /* Add something */
486 case '-': /* Subtract something */
490 case '!': /* Disable something */
499 if ((ciphers = strchr(cipher, ':'))) {
503 /* Do the easy one first */
504 if (!strcmp(cipher, "ALL")) {
505 for (i=0; i<ciphernum; i++) {
506 if (!(ciphers_def[i].attr & SSL_eNULL))
507 cipher_list[i] = action;
509 } else if (!strcmp(cipher, "COMPLEMENTOFALL")) {
510 for (i=0; i<ciphernum; i++) {
511 if ((ciphers_def[i].attr & SSL_eNULL))
512 cipher_list[i] = action;
514 } else if (!strcmp(cipher, "DEFAULT")) {
515 for (i=0; i<ciphernum; i++) {
516 cipher_list[i] = ciphers_def[i].enabled == SSL_ALLOWED ? 1 : 0;
525 while (c && (strlen(c))) {
527 if ((c = strchr(cipher, '+'))) {
531 if (!strcmp(cipher, "RSA")) {
533 } else if ((!strcmp(cipher, "NULL")) || (!strcmp(cipher, "eNULL"))) {
535 } else if (!strcmp(cipher, "AES")) {
537 } else if (!strcmp(cipher, "3DES")) {
539 } else if (!strcmp(cipher, "DES")) {
541 } else if (!strcmp(cipher, "RC4")) {
543 } else if (!strcmp(cipher, "RC2")) {
545 } else if (!strcmp(cipher, "MD5")) {
547 } else if ((!strcmp(cipher, "SHA")) || (!strcmp(cipher, "SHA1"))) {
549 } else if (!strcmp(cipher, "SSLv2")) {
551 } else if (!strcmp(cipher, "SSLv3")) {
553 } else if (!strcmp(cipher, "TLSv1")) {
555 } else if (!strcmp(cipher, "HIGH")) {
556 strength |= SSL_HIGH;
557 } else if (!strcmp(cipher, "MEDIUM")) {
558 strength |= SSL_MEDIUM;
559 } else if (!strcmp(cipher, "LOW")) {
561 } else if ((!strcmp(cipher, "EXPORT")) || (!strcmp(cipher, "EXP"))) {
562 strength |= SSL_EXPORT40|SSL_EXPORT56;
563 } else if (!strcmp(cipher, "EXPORT40")) {
564 strength |= SSL_EXPORT40;
565 } else if (!strcmp(cipher, "EXPORT56")) {
566 strength |= SSL_EXPORT56;
574 /* If we have a mask, apply it. If not then perhaps they provided
575 * a specific cipher to enable.
577 if (mask || strength || protocol) {
578 for (i=0; i<ciphernum; i++) {
579 if (((ciphers_def[i].attr & mask) ||
580 (ciphers_def[i].strength & strength) ||
581 (ciphers_def[i].version & protocol)) &&
582 (cipher_list[i] != -1)) {
583 /* Enable the NULL ciphers only if explicity
585 if (ciphers_def[i].attr & SSL_eNULL) {
586 if (mask & SSL_eNULL)
587 cipher_list[i] = action;
589 cipher_list[i] = action;
593 for (i=0; i<ciphernum; i++) {
594 if (!strcmp(ciphers_def[i].ossl_name, cipher) &&
595 cipher_list[1] != -1)
596 cipher_list[i] = action;
605 /* See if any ciphers were enabled */
607 for (i=0; i<ciphernum; i++) {
608 if (cipher_list[i] == 1)
618 tlsm_parse_ciphers(tlsm_ctx *ctx, const char *str)
620 int cipher_state[ciphernum];
626 rv = nss_parse_ciphers(str, cipher_state);
629 /* First disable everything */
630 for (i = 0; i < SSL_NumImplementedCiphers; i++)
631 SSL_CipherPrefSet(ctx->tc_model, SSL_ImplementedCiphers[i], SSL_NOT_ALLOWED);
633 /* Now enable what was requested */
634 for (i=0; i<ciphernum; i++) {
635 SSLCipherSuiteInfo suite;
638 if (SSL_GetCipherSuiteInfo(ciphers_def[i].num, &suite, sizeof suite)
640 enabled = cipher_state[i] < 0 ? 0 : cipher_state[i];
641 if (enabled == SSL_ALLOWED) {
642 if (PK11_IsFIPS() && !suite.isFIPS)
643 enabled = SSL_NOT_ALLOWED;
645 SSL_CipherPrefSet(ctx->tc_model, ciphers_def[i].num, enabled);
650 return rv == 1 ? 0 : -1;
654 tlsm_bad_cert_handler(void *arg, PRFileDesc *ssl)
656 SECStatus success = SECSuccess;
658 tlsm_ctx *ctx = (tlsm_ctx *)arg;
664 err = PORT_GetError();
667 case SEC_ERROR_UNTRUSTED_ISSUER:
668 case SEC_ERROR_UNKNOWN_ISSUER:
669 case SEC_ERROR_EXPIRED_CERTIFICATE:
670 if (ctx->tc_verify_cert) {
671 success = SECFailure;
674 /* we bypass NSS's hostname checks and do our own */
675 case SSL_ERROR_BAD_CERT_DOMAIN:
678 success = SECFailure;
686 tlsm_dump_security_status(PRFileDesc *fd)
688 char * cp; /* bulk cipher name */
689 char * ip; /* cert issuer DN */
690 char * sp; /* cert subject DN */
691 int op; /* High, Low, Off */
692 int kp0; /* total key bits */
693 int kp1; /* secret key bits */
694 SSL3Statistics * ssl3stats = SSL_GetStatistics();
696 SSL_SecurityStatus( fd, &op, &cp, &kp0, &kp1, &ip, &sp );
697 Debug( LDAP_DEBUG_TRACE,
698 "TLS certificate verification: subject: %s, issuer: %s, cipher: %s, ",
699 sp ? sp : "-unknown-", ip ? ip : "-unknown-", cp ? cp : "-unknown-" );
703 Debug( LDAP_DEBUG_TRACE,
704 "security level: %s, secret key bits: %d, total key bits: %d, ",
705 ((op == SSL_SECURITY_STATUS_ON_HIGH) ? "high" :
706 ((op == SSL_SECURITY_STATUS_ON_LOW) ? "low" : "off")),
709 Debug( LDAP_DEBUG_TRACE,
710 "cache hits: %ld, cache misses: %ld, cache not reusable: %ld\n",
711 ssl3stats->hch_sid_cache_hits, ssl3stats->hch_sid_cache_misses,
712 ssl3stats->hch_sid_cache_not_ok );
718 tlsm_handshake_complete_cb( PRFileDesc *fd, void *client_data )
720 tlsm_dump_security_status( fd );
723 #ifdef READ_PASSWORD_FROM_FILE
725 tlsm_get_pin_from_file(const char *token_name, tlsm_ctx *ctx)
728 char *contents = NULL;
731 char *candidate = NULL;
732 PRFileInfo file_info;
733 PRFileDesc *pwd_fileptr = PR_Open( ctx->tc_pin_file, PR_RDONLY, 00400 );
735 /* open the password file */
736 if ( !pwd_fileptr ) {
737 PRErrorCode errcode = PR_GetError();
738 Debug( LDAP_DEBUG_ANY,
739 "TLS: could not open security pin file %s - error %d:%s.\n",
740 ctx->tc_pin_file, errcode,
741 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
745 /* get the file size */
746 if ( PR_SUCCESS != PR_GetFileInfo( ctx->tc_pin_file, &file_info ) ) {
747 PRErrorCode errcode = PR_GetError();
748 Debug( LDAP_DEBUG_ANY,
749 "TLS: could not get file info from pin file %s - error %d:%s.\n",
750 ctx->tc_pin_file, errcode,
751 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
755 /* create a buffer to hold the file contents */
756 if ( !( contents = PR_MALLOC( file_info.size + 1 ) ) ) {
757 PRErrorCode errcode = PR_GetError();
758 Debug( LDAP_DEBUG_ANY,
759 "TLS: could not alloc a buffer for contents of pin file %s - error %d:%s.\n",
760 ctx->tc_pin_file, errcode,
761 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
765 /* read file into the buffer */
766 if( PR_Read( pwd_fileptr, contents, file_info.size ) <= 0 ) {
767 PRErrorCode errcode = PR_GetError();
768 Debug( LDAP_DEBUG_ANY,
769 "TLS: could not read the file contents from pin file %s - error %d:%s.\n",
770 ctx->tc_pin_file, errcode,
771 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
775 /* format is [tokenname:]password EOL [tokenname:]password EOL ... */
776 /* if you want to use a password containing a colon character, use
777 the special tokenname "default" */
778 for ( line = PL_strtok_r( contents, "\r\n", &lasts ); line;
779 line = PL_strtok_r( NULL, "\r\n", &lasts ) ) {
783 continue; /* skip blank lines */
785 colon = PL_strchr( line, ':' );
787 if ( *(colon + 1) && token_name &&
788 !PL_strncmp( token_name, line, colon-line ) ) {
789 candidate = colon + 1; /* found a definite match */
791 } else if ( !PL_strncmp( DEFAULT_TOKEN_NAME, line, colon-line ) ) {
792 candidate = colon + 1; /* found possible match */
794 } else { /* no token name */
800 PR_Close( pwd_fileptr );
803 pwdstr = PL_strdup( candidate );
805 PL_strfree( contents );
809 #endif /* READ_PASSWORD_FROM_FILE */
811 #ifdef READ_PASSWORD_FROM_STDIN
813 * Turn the echoing off on a tty.
818 if ( isatty( fd ) ) {
820 tcgetattr( fd, &tio );
821 tio.c_lflag &= ~ECHO;
822 tcsetattr( fd, TCSAFLUSH, &tio );
827 * Turn the echoing on on a tty.
832 if ( isatty( fd ) ) {
834 tcgetattr( fd, &tio );
836 tcsetattr( fd, TCSAFLUSH, &tio );
837 tcsetattr( fd, TCSAFLUSH, &tio );
840 #endif /* READ_PASSWORD_FROM_STDIN */
843 * This does the actual work of reading the pin/password/pass phrase
846 tlsm_get_pin(PK11SlotInfo *slot, PRBool retry, tlsm_ctx *ctx)
848 char *token_name = NULL;
851 token_name = PK11_GetTokenName( slot );
852 #ifdef READ_PASSWORD_FROM_FILE
853 /* Try to get the passwords from the password file if it exists.
854 * THIS IS UNSAFE and is provided for convenience only. Without this
855 * capability the server would have to be started in foreground mode
856 * if using an encrypted key.
858 if ( ctx->tc_pin_file ) {
859 pwdstr = tlsm_get_pin_from_file( token_name, ctx );
861 #endif /* RETRIEVE_PASSWORD_FROM_FILE */
862 #ifdef READ_PASSWORD_FROM_STDIN
864 int infd = PR_FileDesc2NativeHandle( PR_STDIN );
865 int isTTY = isatty( infd );
866 unsigned char phrase[200];
867 /* Prompt for password */
870 "Please enter pin, password, or pass phrase for security token '%s': ",
871 token_name ? token_name : DEFAULT_TOKEN_NAME );
874 fgets( (char*)phrase, sizeof(phrase), stdin );
876 fprintf( stdout, "\n" );
879 /* stomp on newline */
880 phrase[strlen((char*)phrase)-1] = 0;
882 pwdstr = PL_strdup( (char*)phrase );
885 #endif /* READ_PASSWORD_FROM_STDIN */
890 * PKCS11 devices (including the internal softokn cert/key database)
891 * may be protected by a pin or password or even pass phrase
892 * MozNSS needs a way for the user to provide that
895 tlsm_pin_prompt(PK11SlotInfo *slot, PRBool retry, void *arg)
897 tlsm_ctx *ctx = (tlsm_ctx *)arg;
899 return tlsm_get_pin( slot, retry, ctx );
903 tlsm_auth_cert_handler(void *arg, PRFileDesc *fd,
904 PRBool checksig, PRBool isServer)
906 SECStatus ret = SSL_AuthCertificate(arg, fd, checksig, isServer);
908 if ( ret != SECSuccess ) {
909 PRErrorCode errcode = PORT_GetError();
910 /* we bypass NSS's hostname checks and do our own - tlsm_session_chkhost will handle it */
911 if ( errcode == SSL_ERROR_BAD_CERT_DOMAIN ) {
912 Debug( LDAP_DEBUG_TRACE,
913 "TLS certificate verification: defer\n",
916 Debug( LDAP_DEBUG_ANY,
917 "TLS certificate verification: Error, %d: %s\n",
918 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 ) ;
921 Debug( LDAP_DEBUG_TRACE,
922 "TLS certificate verification: ok\n",
930 tlsm_authenticate_to_slot( tlsm_ctx *ctx, PK11SlotInfo *slot )
934 if ( SECSuccess != PK11_Authenticate( slot, PR_FALSE, ctx ) ) {
935 char *token_name = PK11_GetTokenName( slot );
936 PRErrorCode errcode = PR_GetError();
937 Debug( LDAP_DEBUG_ANY,
938 "TLS: could not authenticate to the security token %s - error %d:%s.\n",
939 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
940 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
942 rc = 0; /* success */
949 tlsm_nss_shutdown_cb( void *appData, void *nssData )
951 SECStatus rc = SECSuccess;
953 SSL_ShutdownServerSessionIDCache();
954 SSL_ClearSessionCache();
957 SECMOD_UnloadUserModule( pem_module );
958 SECMOD_DestroyModule( pem_module );
965 tlsm_init_pem_module( void )
968 char *fullname = NULL;
969 char *configstring = NULL;
975 /* not loaded - load it */
976 /* get the system dependent library name */
977 fullname = PR_GetLibraryName( NULL, PEM_LIBRARY );
978 /* Load our PKCS#11 module */
979 configstring = PR_smprintf( "library=%s name=" PEM_MODULE " parameters=\"\"", fullname );
980 PL_strfree( fullname );
982 pem_module = SECMOD_LoadUserModule( configstring, NULL, PR_FALSE );
983 PR_smprintf_free( configstring );
985 if ( !pem_module || !pem_module->loaded ) {
987 SECMOD_DestroyModule( pem_module );
997 tlsm_add_pem_obj( tlsm_ctx *ctx, PK11GenericObject *obj )
999 int idx = ctx->tc_n_pem_objs;
1000 ctx->tc_n_pem_objs++;
1001 ctx->tc_pem_objs = (PK11GenericObject **)
1002 PORT_Realloc( ctx->tc_pem_objs, ctx->tc_n_pem_objs * sizeof( PK11GenericObject * ) );
1003 ctx->tc_pem_objs[idx] = obj;
1007 tlsm_free_pem_objs( tlsm_ctx *ctx )
1009 /* free in reverse order of allocation */
1010 while ( ctx->tc_n_pem_objs-- ) {
1011 PK11_DestroyGenericObject( ctx->tc_pem_objs[ctx->tc_n_pem_objs] );
1012 ctx->tc_pem_objs[ctx->tc_n_pem_objs] = NULL;
1014 PORT_Free(ctx->tc_pem_objs);
1015 ctx->tc_pem_objs = NULL;
1016 ctx->tc_n_pem_objs = 0;
1020 tlsm_add_cert_from_file( tlsm_ctx *ctx, const char *filename, PRBool isca )
1023 PK11SlotInfo *slot = NULL;
1024 PK11GenericObject *rv;
1025 CK_ATTRIBUTE *attrs;
1026 CK_ATTRIBUTE theTemplate[20];
1027 CK_BBOOL cktrue = CK_TRUE;
1028 CK_BBOOL ckfalse = CK_FALSE;
1029 CK_OBJECT_CLASS objClass = CKO_CERTIFICATE;
1030 char tmpslotname[64];
1031 char *slotname = NULL;
1032 const char *ptr = NULL;
1033 char sep = PR_GetDirectorySeparator();
1037 memset( &fi, 0, sizeof(fi) );
1038 status = PR_GetFileInfo( filename, &fi );
1039 if ( PR_SUCCESS != status) {
1040 PRErrorCode errcode = PR_GetError();
1041 Debug( LDAP_DEBUG_ANY,
1042 "TLS: could not read certificate file %s - error %d:%s.\n",
1044 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1048 if ( fi.type != PR_FILE_FILE ) {
1049 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1050 Debug( LDAP_DEBUG_ANY,
1051 "TLS: error: the certificate file %s is not a file.\n",
1056 attrs = theTemplate;
1059 slotID = 0; /* CA and trust objects use slot 0 */
1060 PR_snprintf( tmpslotname, sizeof(tmpslotname), TLSM_PEM_TOKEN_FMT, slotID );
1061 slotname = tmpslotname;
1063 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1064 slotID = ++tlsm_slot_count;
1065 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1067 slotname = ctx->tc_slotname;
1069 if ( ( ptr = PL_strrchr( filename, sep ) ) ) {
1070 PL_strfree( ctx->tc_certname );
1072 ctx->tc_certname = PR_smprintf( "%s:%s", slotname, ptr );
1076 slot = PK11_FindSlotByName( slotname );
1079 PRErrorCode errcode = PR_GetError();
1080 Debug( LDAP_DEBUG_ANY,
1081 "TLS: could not find the slot for certificate %s - error %d:%s.\n",
1082 ctx->tc_certname, errcode,
1083 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1087 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1088 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1089 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1091 PK11_SETATTRS( attrs, CKA_TRUST, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1093 PK11_SETATTRS( attrs, CKA_TRUST, &ckfalse, sizeof(CK_BBOOL) ); attrs++;
1095 /* This loads the certificate in our PEM module into the appropriate
1098 rv = PK11_CreateGenericObject( slot, theTemplate, 4, PR_FALSE /* isPerm */ );
1100 PK11_FreeSlot( slot );
1103 PRErrorCode errcode = PR_GetError();
1104 Debug( LDAP_DEBUG_ANY,
1105 "TLS: could not add the certificate %s - error %d:%s.\n",
1106 ctx->tc_certname, errcode,
1107 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1111 tlsm_add_pem_obj( ctx, rv );
1117 tlsm_add_key_from_file( tlsm_ctx *ctx, const char *filename )
1120 PK11SlotInfo * slot = NULL;
1121 PK11GenericObject *rv;
1122 CK_ATTRIBUTE *attrs;
1123 CK_ATTRIBUTE theTemplate[20];
1124 CK_BBOOL cktrue = CK_TRUE;
1125 CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1130 memset( &fi, 0, sizeof(fi) );
1131 status = PR_GetFileInfo( filename, &fi );
1132 if ( PR_SUCCESS != status) {
1133 PRErrorCode errcode = PR_GetError();
1134 Debug( LDAP_DEBUG_ANY,
1135 "TLS: could not read key file %s - error %d:%s.\n",
1137 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1141 if ( fi.type != PR_FILE_FILE ) {
1142 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1143 Debug( LDAP_DEBUG_ANY,
1144 "TLS: error: the key file %s is not a file.\n",
1149 attrs = theTemplate;
1151 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1152 slotID = ++tlsm_slot_count;
1153 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1155 slot = PK11_FindSlotByName( ctx->tc_slotname );
1158 PRErrorCode errcode = PR_GetError();
1159 Debug( LDAP_DEBUG_ANY,
1160 "TLS: could not find the slot %s for the private key - error %d:%s.\n",
1161 ctx->tc_slotname, errcode,
1162 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1166 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1167 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1168 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1169 rv = PK11_CreateGenericObject( slot, theTemplate, 3, PR_FALSE /* isPerm */ );
1172 PRErrorCode errcode = PR_GetError();
1173 Debug( LDAP_DEBUG_ANY,
1174 "TLS: could not add the certificate %s - error %d:%s.\n",
1175 ctx->tc_certname, errcode,
1176 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1179 /* When adding an encrypted key the PKCS#11 will be set as removed */
1180 /* This will force the token to be seen as re-inserted */
1181 SECMOD_WaitForAnyTokenEvent( pem_module, 0, 0 );
1182 PK11_IsPresent( slot );
1186 PK11_FreeSlot( slot );
1189 tlsm_add_pem_obj( ctx, rv );
1195 tlsm_init_ca_certs( tlsm_ctx *ctx, const char *cacertfile, const char *cacertdir )
1197 PRBool isca = PR_TRUE;
1198 PRStatus status = PR_FAILURE;
1199 PRErrorCode errcode = PR_SUCCESS;
1201 if ( !cacertfile && !cacertdir ) {
1202 /* no checking - not good, but allowed */
1207 int rc = tlsm_add_cert_from_file( ctx, cacertfile, isca );
1209 errcode = PR_GetError();
1210 Debug( LDAP_DEBUG_ANY,
1211 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1212 cacertfile, errcode,
1213 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1215 Debug( LDAP_DEBUG_TRACE,
1216 "TLS: loaded CA certificate file %s.\n",
1218 status = PR_SUCCESS; /* have at least one good CA - we can proceed */
1226 PRStatus fistatus = PR_FAILURE;
1228 memset( &fi, 0, sizeof(fi) );
1229 fistatus = PR_GetFileInfo( cacertdir, &fi );
1230 if ( PR_SUCCESS != fistatus) {
1231 errcode = PR_GetError();
1232 Debug( LDAP_DEBUG_ANY,
1233 "TLS: could not get info about the CA certificate directory %s - error %d:%s.\n",
1235 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1239 if ( fi.type != PR_FILE_DIRECTORY ) {
1240 Debug( LDAP_DEBUG_ANY,
1241 "TLS: error: the CA certificate directory %s is not a directory.\n",
1246 dir = PR_OpenDir( cacertdir );
1247 if ( NULL == dir ) {
1248 errcode = PR_GetError();
1249 Debug( LDAP_DEBUG_ANY,
1250 "TLS: could not open the CA certificate directory %s - error %d:%s.\n",
1252 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1257 entry = PR_ReadDir( dir, PR_SKIP_BOTH | PR_SKIP_HIDDEN );
1258 if ( ( NULL != entry ) && ( NULL != entry->name ) ) {
1259 char *fullpath = NULL;
1262 ptr = PL_strrstr( entry->name, PEM_CA_HASH_FILE_SUFFIX );
1263 if ( ( ptr == NULL ) || ( *(ptr + PEM_CA_HASH_FILE_SUFFIX_LEN) != '\0' ) ) {
1264 Debug( LDAP_DEBUG_TRACE,
1265 "TLS: file %s does not end in [%s] - does not appear to be a CA certificate "
1266 "directory file with a properly hashed file name - skipping.\n",
1267 entry->name, PEM_CA_HASH_FILE_SUFFIX, 0 );
1270 fullpath = PR_smprintf( "%s/%s", cacertdir, entry->name );
1271 if ( !tlsm_add_cert_from_file( ctx, fullpath, isca ) ) {
1272 Debug( LDAP_DEBUG_TRACE,
1273 "TLS: loaded CA certificate file %s from CA certificate directory %s.\n",
1274 fullpath, cacertdir, 0 );
1275 status = PR_SUCCESS; /* found at least 1 valid CA file in the dir */
1277 errcode = PR_GetError();
1278 Debug( LDAP_DEBUG_TRACE,
1279 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1281 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1283 PR_smprintf_free( fullpath );
1285 } while ( NULL != entry );
1289 if ( status != PR_SUCCESS ) {
1290 const char *fmtstr = NULL;
1291 if ( cacertfile && cacertdir ) {
1292 fmtstr = "TLS: did not find any valid CA certificates in %s or %s\n";
1294 fmtstr = "TLS: did not find any valid CA certificates in %s%s\n";
1296 Debug( LDAP_DEBUG_ANY, fmtstr, cacertdir ? cacertdir : "",
1297 cacertfile ? cacertfile : "", 0 );
1305 * NSS supports having multiple cert/key databases in the same
1306 * directory, each one having a unique string prefix e.g.
1307 * slapd-01-cert8.db - the prefix here is "slapd-01-"
1308 * this function examines the given certdir - if it looks like
1309 * /path/to/directory/prefix it will return the
1310 * /path/to/directory part in realcertdir, and the prefix in prefix
1313 tlsm_get_certdb_prefix( const char *certdir, char **realcertdir, char **prefix )
1315 char sep = PR_GetDirectorySeparator();
1317 struct PRFileInfo prfi;
1320 *realcertdir = (char *)certdir; /* default is the one passed in */
1322 /* if certdir is not given, just return */
1327 prc = PR_GetFileInfo( certdir, &prfi );
1328 /* if certdir exists (file or directory) then it cannot specify a prefix */
1329 if ( prc == PR_SUCCESS ) {
1333 /* if certdir was given, and there is a '/' in certdir, see if there
1334 is anything after the last '/' - if so, assume it is the prefix */
1335 if ( ( ( ptr = strrchr( certdir, sep ) ) ) && *(ptr+1) ) {
1336 *realcertdir = PL_strndup( certdir, ptr-certdir );
1337 *prefix = PL_strdup( ptr+1 );
1344 * This is the part of the init we defer until we get the
1345 * actual security configuration information. This is
1346 * only called once, protected by a PRCallOnce
1347 * NOTE: This must be done before the first call to SSL_ImportFD,
1348 * especially the setting of the policy
1349 * NOTE: This must be called after fork()
1352 tlsm_deferred_init( void *arg )
1354 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1355 struct ldaptls *lt = ctx->tc_config;
1356 const char *securitydirs[3];
1359 PRErrorCode errcode = 1;
1360 #ifdef HAVE_NSS_INITCONTEXT
1361 NSSInitParameters initParams;
1362 NSSInitContext *initctx = NULL;
1367 #ifdef HAVE_NSS_INITCONTEXT
1368 memset( &initParams, 0, sizeof( initParams ) );
1369 initParams.length = sizeof( initParams );
1370 #endif /* HAVE_NSS_INITCONTEXT */
1372 #ifndef HAVE_NSS_INITCONTEXT
1373 if ( !NSS_IsInitialized() ) {
1374 #endif /* HAVE_NSS_INITCONTEXT */
1376 MOZNSS_DIR will override everything else - you can
1377 always set MOZNSS_DIR to force the use of this
1379 If using MOZNSS, specify the location of the moznss db dir
1380 in the cacertdir directive of the OpenLDAP configuration.
1381 DEFAULT_MOZNSS_DIR will only be used if the code cannot
1382 find a security dir to use based on the current
1386 securitydirs[nn++] = PR_GetEnv( "MOZNSS_DIR" );
1387 securitydirs[nn++] = lt->lt_cacertdir;
1388 securitydirs[nn++] = PR_GetEnv( "DEFAULT_MOZNSS_DIR" );
1389 for ( ii = 0; !done && ( ii < nn ); ++ii ) {
1390 char *realcertdir = NULL;
1391 const char *defprefix = "";
1392 char *prefix = (char *)defprefix;
1393 const char *securitydir = securitydirs[ii];
1394 if ( NULL == securitydir ) {
1398 tlsm_get_certdb_prefix( securitydir, &realcertdir, &prefix );
1399 #ifdef HAVE_NSS_INITCONTEXT
1400 #ifdef INITCONTEXT_HACK
1401 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1402 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1404 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1405 &initParams, NSS_INIT_READONLY );
1406 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1409 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1410 &initParams, NSS_INIT_READONLY );
1411 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1414 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1417 if ( rc != SECSuccess ) {
1418 errcode = PORT_GetError();
1419 if ( securitydirs[ii] != lt->lt_cacertdir) {
1420 Debug( LDAP_DEBUG_TRACE,
1421 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1422 realcertdir, prefix, errcode );
1426 Debug( LDAP_DEBUG_TRACE, "TLS: using moznss security dir %s prefix %s.\n",
1427 realcertdir, prefix, 0 );
1431 if ( realcertdir != securitydir ) {
1432 PL_strfree( realcertdir );
1434 if ( prefix != defprefix ) {
1435 PL_strfree( prefix );
1439 if ( errcode ) { /* no moznss db found, or not using moznss db */
1440 #ifdef HAVE_NSS_INITCONTEXT
1441 int flags = NSS_INIT_READONLY|NSS_INIT_NOCERTDB|NSS_INIT_NOMODDB;
1442 #ifdef INITCONTEXT_HACK
1443 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1444 rc = NSS_NoDB_Init( NULL );
1446 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1447 &initParams, flags );
1448 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1451 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1452 &initParams, flags );
1453 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1456 rc = NSS_NoDB_Init( NULL );
1458 if ( rc != SECSuccess ) {
1459 errcode = PORT_GetError();
1460 Debug( LDAP_DEBUG_ANY,
1461 "TLS: could not initialize moznss - error %d:%s.\n",
1462 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1466 #ifdef HAVE_NSS_INITCONTEXT
1467 ctx->tc_initctx = initctx;
1470 /* initialize the PEM module */
1471 if ( tlsm_init_pem_module() ) {
1472 errcode = PORT_GetError();
1473 Debug( LDAP_DEBUG_ANY,
1474 "TLS: could not initialize moznss PEM module - error %d:%s.\n",
1475 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1479 if ( tlsm_init_ca_certs( ctx, lt->lt_cacertfile, lt->lt_cacertdir ) ) {
1480 /* if we tried to use lt->lt_cacertdir as an NSS key/cert db, errcode
1481 will be a value other than 1 - print an error message so that the
1482 user will know that failed too */
1483 if ( ( errcode != 1 ) && ( lt->lt_cacertdir ) ) {
1484 char *realcertdir = NULL;
1485 char *prefix = NULL;
1486 tlsm_get_certdb_prefix( lt->lt_cacertdir, &realcertdir, &prefix );
1487 Debug( LDAP_DEBUG_TRACE,
1488 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1489 realcertdir, prefix ? prefix : "", errcode );
1490 if ( realcertdir != lt->lt_cacertdir ) {
1491 PL_strfree( realcertdir );
1493 PL_strfree( prefix );
1498 ctx->tc_using_pem = PR_TRUE;
1501 #ifdef HAVE_NSS_INITCONTEXT
1502 if ( !ctx->tc_initctx ) {
1503 ctx->tc_initctx = initctx;
1507 NSS_SetDomesticPolicy();
1509 PK11_SetPasswordFunc( tlsm_pin_prompt );
1511 /* register cleanup function */
1512 /* delete the old one, if any */
1513 NSS_UnregisterShutdown( tlsm_nss_shutdown_cb, NULL );
1514 NSS_RegisterShutdown( tlsm_nss_shutdown_cb, NULL );
1516 #ifndef HAVE_NSS_INITCONTEXT
1518 #endif /* HAVE_NSS_INITCONTEXT */
1524 tlsm_authenticate( tlsm_ctx *ctx, const char *certname, const char *pininfo )
1526 const char *colon = NULL;
1527 char *token_name = NULL;
1528 PK11SlotInfo *slot = NULL;
1531 if ( !certname || !*certname ) {
1535 if ( ( colon = PL_strchr( certname, ':' ) ) ) {
1536 token_name = PL_strndup( certname, colon-certname );
1540 slot = PK11_FindSlotByName( token_name );
1542 slot = PK11_GetInternalKeySlot();
1546 PRErrorCode errcode = PR_GetError();
1547 Debug( LDAP_DEBUG_ANY,
1548 "TLS: could not find the slot for security token %s - error %d:%s.\n",
1549 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
1550 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1554 rc = tlsm_authenticate_to_slot( ctx, slot );
1557 PL_strfree( token_name );
1559 PK11_FreeSlot( slot );
1566 * Find and verify the certificate.
1567 * Either fd is given, in which case the cert will be taken from it via SSL_PeerCertificate
1568 * or certname is given, and it will be searched for by name
1571 tlsm_find_and_verify_cert_key(tlsm_ctx *ctx, PRFileDesc *fd, const char *certname, int isServer, CERTCertificate **pRetCert, SECKEYPrivateKey **pRetKey)
1573 CERTCertificate *cert = NULL;
1575 void *pin_arg = NULL;
1576 SECKEYPrivateKey *key = NULL;
1578 pin_arg = SSL_RevealPinArg( fd );
1580 cert = PK11_FindCertFromNickname( certname, pin_arg );
1582 PRErrorCode errcode = PR_GetError();
1583 Debug( LDAP_DEBUG_ANY,
1584 "TLS: error: the certificate %s could not be found in the database - error %d:%s\n",
1585 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1589 /* we are verifying the peer cert
1590 we also need to swap the isServer meaning */
1591 cert = SSL_PeerCertificate( fd );
1593 PRErrorCode errcode = PR_GetError();
1594 Debug( LDAP_DEBUG_ANY,
1595 "TLS: error: could not get the certificate from the peer connection - error %d:%s\n",
1596 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), NULL );
1599 isServer = !isServer; /* verify the peer's cert instead */
1602 if ( ctx->tc_slotname ) {
1603 PK11SlotInfo *slot = PK11_FindSlotByName( ctx->tc_slotname );
1604 key = PK11_FindPrivateKeyFromCert( slot, cert, NULL );
1605 PK11_FreeSlot( slot );
1607 key = PK11_FindKeyByAnyCert( cert, pin_arg );
1611 SECCertificateUsage certUsage;
1612 PRBool checkSig = PR_TRUE;
1616 *pRetKey = key; /* caller will deal with this */
1618 SECKEY_DestroyPrivateKey( key );
1621 certUsage = certificateUsageSSLServer;
1623 certUsage = certificateUsageSSLClient;
1625 if ( ctx->tc_verify_cert ) {
1628 checkSig = PR_FALSE;
1630 status = CERT_VerifyCertificateNow( ctx->tc_certdb, cert,
1631 checkSig, certUsage,
1633 if ( status != SECSuccess ) {
1634 /* NSS doesn't like self-signed CA certs that are also used for
1635 TLS/SSL server certs (such as generated by openssl req -x509)
1636 CERT_VerifyCertificateNow returns SEC_ERROR_UNTRUSTED_ISSUER in that case
1637 so, see if the cert and issuer are the same cert
1639 PRErrorCode errcode = PR_GetError();
1641 if ( errcode == SEC_ERROR_UNTRUSTED_ISSUER ) {
1642 CERTCertificate *issuer = CERT_FindCertIssuer( cert, PR_Now(), certUsageSSLServer );
1643 if ( NULL == issuer ) {
1644 /* no issuer - fail */
1645 Debug( LDAP_DEBUG_ANY,
1646 "TLS: error: the server certificate %s has no issuer - "
1647 "please check this certificate for validity\n",
1649 } else if ( CERT_CompareCerts( cert, issuer ) ) {
1650 /* self signed - warn and allow */
1651 status = SECSuccess;
1653 Debug( LDAP_DEBUG_ANY,
1654 "TLS: warning: using self-signed server certificate %s\n",
1657 CERT_DestroyCertificate( issuer );
1660 if ( status != SECSuccess ) {
1661 Debug( LDAP_DEBUG_ANY,
1662 "TLS: error: the certificate %s is not valid - error %d:%s\n",
1663 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1666 rc = 0; /* success */
1669 PRErrorCode errcode = PR_GetError();
1670 Debug( LDAP_DEBUG_ANY,
1671 "TLS: error: could not find the private key for certificate %s - error %d:%s\n",
1672 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1676 *pRetCert = cert; /* caller will deal with this */
1678 CERT_DestroyCertificate( cert );
1685 tlsm_get_client_auth_data( void *arg, PRFileDesc *fd,
1686 CERTDistNames *caNames, CERTCertificate **pRetCert,
1687 SECKEYPrivateKey **pRetKey )
1689 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1692 /* don't need caNames - this function will call CERT_VerifyCertificateNow
1693 which will verify the cert against the known CAs */
1694 rc = tlsm_find_and_verify_cert_key( ctx, fd, ctx->tc_certname, 0, pRetCert, pRetKey );
1696 Debug( LDAP_DEBUG_ANY,
1697 "TLS: error: unable to perform client certificate authentication for "
1698 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1706 * ctx must have a tc_model that is valid
1707 * certname is in the form [<tokenname>:]<certnickname>
1708 * where <tokenname> is the name of the PKCS11 token
1709 * and <certnickname> is the nickname of the cert/key in
1713 tlsm_clientauth_init( tlsm_ctx *ctx )
1715 SECStatus status = SECFailure;
1718 rc = tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, 0, NULL, NULL );
1720 Debug( LDAP_DEBUG_ANY,
1721 "TLS: error: unable to set up client certificate authentication for "
1722 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1726 status = SSL_GetClientAuthDataHook( ctx->tc_model,
1727 tlsm_get_client_auth_data,
1730 return ( status == SECSuccess ? 0 : -1 );
1734 * Tear down the TLS subsystem. Should only be called once.
1737 tlsm_destroy( void )
1742 tlsm_ctx_new ( struct ldapoptions *lo )
1746 ctx = LDAP_MALLOC( sizeof (*ctx) );
1749 #ifdef LDAP_R_COMPILE
1750 ldap_pvt_thread_mutex_init( &ctx->tc_refmutex );
1752 ctx->tc_config = &lo->ldo_tls_info; /* pointer into lo structure - must have global scope and must not go away before we can do real init */
1753 ctx->tc_certdb = NULL;
1754 ctx->tc_certname = NULL;
1755 ctx->tc_pin_file = NULL;
1756 ctx->tc_model = NULL;
1757 memset(&ctx->tc_callonce, 0, sizeof(ctx->tc_callonce));
1758 ctx->tc_require_cert = lo->ldo_tls_require_cert;
1759 ctx->tc_verify_cert = PR_FALSE;
1760 ctx->tc_using_pem = PR_FALSE;
1761 ctx->tc_slotname = NULL;
1762 #ifdef HAVE_NSS_INITCONTEXT
1763 ctx->tc_initctx = NULL;
1764 #endif /* HAVE_NSS_INITCONTEXT */
1765 ctx->tc_pem_objs = NULL;
1766 ctx->tc_n_pem_objs = 0;
1768 return (tls_ctx *)ctx;
1772 tlsm_ctx_ref( tls_ctx *ctx )
1774 tlsm_ctx *c = (tlsm_ctx *)ctx;
1775 #ifdef LDAP_R_COMPILE
1776 ldap_pvt_thread_mutex_lock( &c->tc_refmutex );
1779 #ifdef LDAP_R_COMPILE
1780 ldap_pvt_thread_mutex_unlock( &c->tc_refmutex );
1785 tlsm_ctx_free ( tls_ctx *ctx )
1787 tlsm_ctx *c = (tlsm_ctx *)ctx;
1792 #ifdef LDAP_R_COMPILE
1793 ldap_pvt_thread_mutex_lock( &c->tc_refmutex );
1795 refcount = --c->tc_refcnt;
1796 #ifdef LDAP_R_COMPILE
1797 ldap_pvt_thread_mutex_unlock( &c->tc_refmutex );
1802 PR_Close( c->tc_model );
1803 c->tc_certdb = NULL; /* if not the default, may have to clean up */
1804 PL_strfree( c->tc_certname );
1805 c->tc_certname = NULL;
1806 PL_strfree( c->tc_pin_file );
1807 c->tc_pin_file = NULL;
1808 PL_strfree( c->tc_slotname );
1809 tlsm_free_pem_objs( c );
1810 #ifdef HAVE_NSS_INITCONTEXT
1812 NSS_ShutdownContext( c->tc_initctx );
1813 c->tc_initctx = NULL;
1814 #endif /* HAVE_NSS_INITCONTEXT */
1815 #ifdef LDAP_R_COMPILE
1816 ldap_pvt_thread_mutex_destroy( &c->tc_refmutex );
1822 * initialize a new TLS context
1825 tlsm_ctx_init( struct ldapoptions *lo, struct ldaptls *lt, int is_server )
1827 tlsm_ctx *ctx = (tlsm_ctx *)lo->ldo_tls_ctx;
1828 ctx->tc_is_server = is_server;
1834 tlsm_deferred_ctx_init( void *arg )
1836 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1837 PRBool sslv2 = PR_FALSE;
1838 PRBool sslv3 = PR_TRUE;
1839 PRBool tlsv1 = PR_TRUE;
1840 PRBool request_cert = PR_FALSE;
1841 PRInt32 require_cert = PR_FALSE;
1845 if ( tlsm_deferred_init( ctx ) ) {
1846 Debug( LDAP_DEBUG_ANY,
1847 "TLS: could perform TLS system initialization.\n",
1852 ctx->tc_certdb = CERT_GetDefaultCertDB(); /* If there is ever a per-context db, change this */
1854 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
1856 ctx->tc_model = SSL_ImportFD( NULL, fd );
1859 if ( !ctx->tc_model ) {
1860 PRErrorCode err = PR_GetError();
1861 Debug( LDAP_DEBUG_ANY,
1862 "TLS: could perform TLS socket I/O layer initialization - error %d:%s.\n",
1863 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1871 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_SECURITY, PR_TRUE ) ) {
1872 Debug( LDAP_DEBUG_ANY,
1873 "TLS: could not set secure mode on.\n",
1878 lt = ctx->tc_config;
1880 /* default is sslv3 and tlsv1 */
1881 if ( lt->lt_protocol_min ) {
1882 if ( lt->lt_protocol_min > LDAP_OPT_X_TLS_PROTOCOL_SSL3 ) {
1884 } else if ( lt->lt_protocol_min <= LDAP_OPT_X_TLS_PROTOCOL_SSL2 ) {
1886 Debug( LDAP_DEBUG_ANY,
1887 "TLS: warning: minimum TLS protocol level set to "
1888 "include SSLv2 - SSLv2 is insecure - do not use\n", 0, 0, 0 );
1891 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL2, sslv2 ) ) {
1892 Debug( LDAP_DEBUG_ANY,
1893 "TLS: could not set SSLv2 mode on.\n",
1897 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL3, sslv3 ) ) {
1898 Debug( LDAP_DEBUG_ANY,
1899 "TLS: could not set SSLv3 mode on.\n",
1903 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_TLS, tlsv1 ) ) {
1904 Debug( LDAP_DEBUG_ANY,
1905 "TLS: could not set TLSv1 mode on.\n",
1910 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_CLIENT, !ctx->tc_is_server ) ) {
1911 Debug( LDAP_DEBUG_ANY,
1912 "TLS: could not set handshake as client.\n",
1916 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_SERVER, ctx->tc_is_server ) ) {
1917 Debug( LDAP_DEBUG_ANY,
1918 "TLS: could not set handshake as server.\n",
1923 if ( lt->lt_ciphersuite &&
1924 tlsm_parse_ciphers( ctx, lt->lt_ciphersuite )) {
1925 Debug( LDAP_DEBUG_ANY,
1926 "TLS: could not set cipher list %s.\n",
1927 lt->lt_ciphersuite, 0, 0 );
1931 if ( ctx->tc_require_cert ) {
1932 request_cert = PR_TRUE;
1933 require_cert = SSL_REQUIRE_NO_ERROR;
1934 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
1935 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
1936 require_cert = SSL_REQUIRE_ALWAYS;
1938 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW )
1939 ctx->tc_verify_cert = PR_TRUE;
1941 ctx->tc_verify_cert = PR_FALSE;
1944 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUEST_CERTIFICATE, request_cert ) ) {
1945 Debug( LDAP_DEBUG_ANY,
1946 "TLS: could not set request certificate mode.\n",
1951 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUIRE_CERTIFICATE, require_cert ) ) {
1952 Debug( LDAP_DEBUG_ANY,
1953 "TLS: could not set require certificate mode.\n",
1958 /* set up our cert and key, if any */
1959 if ( lt->lt_certfile ) {
1960 /* if using the PEM module, load the PEM file specified by lt_certfile */
1961 /* otherwise, assume this is the name of a cert already in the db */
1962 if ( ctx->tc_using_pem ) {
1963 /* this sets ctx->tc_certname to the correct value */
1964 int rc = tlsm_add_cert_from_file( ctx, lt->lt_certfile, PR_FALSE /* not a ca */ );
1969 PL_strfree( ctx->tc_certname );
1970 ctx->tc_certname = PL_strdup( lt->lt_certfile );
1974 if ( lt->lt_keyfile ) {
1975 /* if using the PEM module, load the PEM file specified by lt_keyfile */
1976 /* otherwise, assume this is the pininfo for the key */
1977 if ( ctx->tc_using_pem ) {
1978 /* this sets ctx->tc_certname to the correct value */
1979 int rc = tlsm_add_key_from_file( ctx, lt->lt_keyfile );
1984 PL_strfree( ctx->tc_pin_file );
1985 ctx->tc_pin_file = PL_strdup( lt->lt_keyfile );
1989 /* Set up callbacks for use by clients */
1990 if ( !ctx->tc_is_server ) {
1991 if ( SSL_OptionSet( ctx->tc_model, SSL_NO_CACHE, PR_TRUE ) != SECSuccess ) {
1992 PRErrorCode err = PR_GetError();
1993 Debug( LDAP_DEBUG_ANY,
1994 "TLS: error: could not set nocache option for moznss - error %d:%s\n",
1995 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1999 if ( SSL_BadCertHook( ctx->tc_model, tlsm_bad_cert_handler, ctx ) != SECSuccess ) {
2000 PRErrorCode err = PR_GetError();
2001 Debug( LDAP_DEBUG_ANY,
2002 "TLS: error: could not set bad cert handler for moznss - error %d:%s\n",
2003 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2008 since a cert has been specified, assume the client wants to do cert auth
2010 if ( ctx->tc_certname ) {
2011 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
2012 Debug( LDAP_DEBUG_ANY,
2013 "TLS: error: unable to authenticate to the security device for certificate %s\n",
2014 ctx->tc_certname, 0, 0 );
2017 if ( tlsm_clientauth_init( ctx ) ) {
2018 Debug( LDAP_DEBUG_ANY,
2019 "TLS: error: unable to set up client certificate authentication using %s\n",
2020 ctx->tc_certname, 0, 0 );
2024 } else { /* set up secure server */
2026 CERTCertificate *serverCert;
2027 SECKEYPrivateKey *serverKey;
2030 /* must have a certificate for the server to use */
2031 if ( !ctx->tc_certname ) {
2032 Debug( LDAP_DEBUG_ANY,
2033 "TLS: error: no server certificate: must specify a certificate for the server to use\n",
2038 /* authenticate to the server's token - this will do nothing
2039 if the key/cert db is not password protected */
2040 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
2041 Debug( LDAP_DEBUG_ANY,
2042 "TLS: error: unable to authenticate to the security device for certificate %s\n",
2043 ctx->tc_certname, 0, 0 );
2047 /* get the server's key and cert */
2048 if ( tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, ctx->tc_is_server,
2049 &serverCert, &serverKey ) ) {
2050 Debug( LDAP_DEBUG_ANY,
2051 "TLS: error: unable to find and verify server's cert and key for certificate %s\n",
2052 ctx->tc_certname, 0, 0 );
2056 certKEA = NSS_FindCertKEAType( serverCert );
2057 /* configure the socket to be a secure server socket */
2058 status = SSL_ConfigSecureServer( ctx->tc_model, serverCert, serverKey, certKEA );
2059 /* SSL_ConfigSecureServer copies these */
2060 CERT_DestroyCertificate( serverCert );
2061 SECKEY_DestroyPrivateKey( serverKey );
2063 if ( SECSuccess != status ) {
2064 PRErrorCode err = PR_GetError();
2065 Debug( LDAP_DEBUG_ANY,
2066 "TLS: error: unable to configure secure server using certificate %s - error %d:%s\n",
2067 ctx->tc_certname, err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) );
2072 /* Callback for authenticating certificate */
2073 if ( SSL_AuthCertificateHook( ctx->tc_model, tlsm_auth_cert_handler,
2074 ctx->tc_certdb ) != SECSuccess ) {
2075 PRErrorCode err = PR_GetError();
2076 Debug( LDAP_DEBUG_ANY,
2077 "TLS: error: could not set auth cert handler for moznss - error %d:%s\n",
2078 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2082 if ( SSL_HandshakeCallback( ctx->tc_model, tlsm_handshake_complete_cb, ctx ) ) {
2083 PRErrorCode err = PR_GetError();
2084 Debug( LDAP_DEBUG_ANY,
2085 "TLS: error: could not set handshake callback for moznss - error %d:%s\n",
2086 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2094 tlsm_session *session;
2095 Sockbuf_IO_Desc *sbiod;
2096 /* there seems to be no portable way to determine if the
2097 sockbuf sd has been set to nonblocking mode - the
2098 call to ber_pvt_socket_set_nonblock() takes place
2099 before the tls socket is set up, so we cannot
2100 intercept that call either.
2101 On systems where fcntl is available, we can just
2102 F_GETFL and test for O_NONBLOCK. On other systems,
2103 we will just see if the IO op returns EAGAIN or EWOULDBLOCK,
2104 and just set this flag */
2109 tlsm_is_io_ready( PRFileDesc *fd, PRInt16 in_flags, PRInt16 *out_flags )
2112 PRFileDesc *pollfd = NULL;
2114 PRPollDesc polldesc;
2117 myfd = PR_GetIdentitiesLayer( fd, tlsm_layer_id );
2123 p = (struct tls_data *)myfd->secret;
2125 if ( p == NULL || p->sbiod == NULL ) {
2129 /* wrap the sockbuf fd with a NSPR FD created especially
2130 for use with polling, and only with polling */
2131 pollfd = PR_CreateSocketPollFd( p->sbiod->sbiod_sb->sb_fd );
2132 polldesc.fd = pollfd;
2133 polldesc.in_flags = in_flags;
2134 polldesc.out_flags = 0;
2136 /* do the poll - no waiting, no blocking */
2137 rc = PR_Poll( &polldesc, 1, PR_INTERVAL_NO_WAIT );
2139 /* unwrap the socket */
2140 PR_DestroySocketPollFd( pollfd );
2142 /* rc will be either 1 if IO is ready, 0 if IO is not
2143 ready, or -1 if there was some error (and the caller
2144 should use PR_GetError() to figure out what */
2146 *out_flags = polldesc.out_flags;
2151 static tls_session *
2152 tlsm_session_new ( tls_ctx * ctx, int is_server )
2154 tlsm_ctx *c = (tlsm_ctx *)ctx;
2155 tlsm_session *session;
2159 c->tc_is_server = is_server;
2160 status = PR_CallOnceWithArg( &c->tc_callonce, tlsm_deferred_ctx_init, c );
2161 if ( PR_SUCCESS != status ) {
2162 PRErrorCode err = PR_GetError();
2163 Debug( LDAP_DEBUG_ANY,
2164 "TLS: error: could not initialize moznss security context - error %d:%s\n",
2165 err, PR_ErrorToString(err, PR_LANGUAGE_I_DEFAULT), NULL );
2169 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2174 session = SSL_ImportFD( c->tc_model, fd );
2181 /* 0 means use the defaults here */
2182 SSL_ConfigServerSessionIDCache( 0, 0, 0, NULL );
2185 return (tls_session *)session;
2189 tlsm_session_accept( tls_session *session )
2191 tlsm_session *s = (tlsm_session *)session;
2194 int waitcounter = 0;
2196 rc = SSL_ResetHandshake( s, PR_TRUE /* server */ );
2198 err = PR_GetError();
2199 Debug( LDAP_DEBUG_TRACE,
2200 "TLS: error: accept - reset handshake failure %d - error %d:%s\n",
2202 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2211 rc = SSL_ForceHandshake( s );
2212 if (rc == SECSuccess) {
2216 err = PR_GetError();
2217 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2219 in_flags = PR_POLL_READ | PR_POLL_EXCEPT;
2222 filesReady = tlsm_is_io_ready( s, in_flags, &out_flags );
2223 if ( filesReady < 0 ) {
2224 err = PR_GetError();
2225 Debug( LDAP_DEBUG_ANY,
2226 "TLS: error: accept - error waiting for socket to be ready: %d - error %d:%s\n",
2228 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2230 break; /* hard error */
2231 } else if ( out_flags & PR_POLL_NVAL ) {
2232 PR_SetError(PR_BAD_DESCRIPTOR_ERROR, 0);
2233 Debug( LDAP_DEBUG_ANY,
2234 "TLS: error: accept failure - invalid socket\n",
2238 } else if ( out_flags & PR_POLL_EXCEPT ) {
2239 err = PR_GetError();
2240 Debug( LDAP_DEBUG_ANY,
2241 "TLS: error: accept - error waiting for socket to be ready: %d - error %d:%s\n",
2243 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2245 break; /* hard error */
2247 } else { /* hard error */
2248 err = PR_GetError();
2249 Debug( LDAP_DEBUG_ANY,
2250 "TLS: error: accept - force handshake failure: %d - error %d:%s\n",
2252 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2254 break; /* hard error */
2256 } while (rc == SECFailure);
2258 Debug( LDAP_DEBUG_TRACE,
2259 "TLS: accept completed after %d waits\n", waitcounter, NULL, NULL );
2265 tlsm_session_connect( LDAP *ld, tls_session *session )
2267 tlsm_session *s = (tlsm_session *)session;
2271 rc = SSL_ResetHandshake( s, PR_FALSE /* server */ );
2273 err = PR_GetError();
2274 Debug( LDAP_DEBUG_TRACE,
2275 "TLS: error: connect - reset handshake failure %d - error %d:%s\n",
2277 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2280 rc = SSL_ForceHandshake( s );
2282 err = PR_GetError();
2283 Debug( LDAP_DEBUG_TRACE,
2284 "TLS: error: connect - force handshake failure %d - error %d:%s\n",
2286 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2293 tlsm_session_upflags( Sockbuf *sb, tls_session *session, int rc )
2295 /* Should never happen */
2298 if ( rc != PR_PENDING_INTERRUPT_ERROR && rc != PR_WOULD_BLOCK_ERROR )
2304 tlsm_session_errmsg( tls_session *sess, int rc, char *buf, size_t len )
2309 i = PR_GetErrorTextLength();
2311 char *msg = LDAP_MALLOC( i+1 );
2312 PR_GetErrorText( msg );
2313 memcpy( buf, msg, len );
2316 PR_GetErrorText( buf );
2319 return i ? buf : NULL;
2323 tlsm_session_my_dn( tls_session *session, struct berval *der_dn )
2325 tlsm_session *s = (tlsm_session *)session;
2326 CERTCertificate *cert;
2328 cert = SSL_LocalCertificate( s );
2329 if (!cert) return LDAP_INVALID_CREDENTIALS;
2331 der_dn->bv_val = (char *)cert->derSubject.data;
2332 der_dn->bv_len = cert->derSubject.len;
2333 CERT_DestroyCertificate( cert );
2338 tlsm_session_peer_dn( tls_session *session, struct berval *der_dn )
2340 tlsm_session *s = (tlsm_session *)session;
2341 CERTCertificate *cert;
2343 cert = SSL_PeerCertificate( s );
2344 if (!cert) return LDAP_INVALID_CREDENTIALS;
2346 der_dn->bv_val = (char *)cert->derSubject.data;
2347 der_dn->bv_len = cert->derSubject.len;
2348 CERT_DestroyCertificate( cert );
2352 /* what kind of hostname were we given? */
2358 tlsm_session_chkhost( LDAP *ld, tls_session *session, const char *name_in )
2360 tlsm_session *s = (tlsm_session *)session;
2361 CERTCertificate *cert;
2362 const char *name, *domain = NULL, *ptr;
2363 int ret, ntype = IS_DNS, nlen, dlen;
2364 #ifdef LDAP_PF_INET6
2365 struct in6_addr addr;
2367 struct in_addr addr;
2372 if( ldap_int_hostname &&
2373 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
2375 name = ldap_int_hostname;
2379 nlen = strlen( name );
2381 cert = SSL_PeerCertificate( s );
2383 Debug( LDAP_DEBUG_ANY,
2384 "TLS: unable to get peer certificate.\n",
2386 /* if this was a fatal condition, things would have
2387 * aborted long before now.
2389 return LDAP_SUCCESS;
2392 #ifdef LDAP_PF_INET6
2393 if (name[0] == '[' && strchr(name, ']')) {
2394 char *n2 = ldap_strdup(name+1);
2395 *strchr(n2, ']') = 0;
2396 if (inet_pton(AF_INET6, n2, &addr))
2401 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
2402 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
2404 if (ntype == IS_DNS ) {
2405 domain = strchr( name, '.' );
2407 dlen = nlen - ( domain - name );
2410 ret = LDAP_LOCAL_ERROR;
2412 rv = CERT_FindCertExtension( cert, SEC_OID_X509_SUBJECT_ALT_NAME,
2414 if ( rv == SECSuccess && altname.data ) {
2416 CERTGeneralName *names, *cur;
2418 arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
2420 ret = LDAP_NO_MEMORY;
2424 names = cur = CERT_DecodeAltNameExtension(arena, &altname);
2433 if ( !cur->name.other.len ) continue;
2435 host = (char *)cur->name.other.data;
2436 hlen = cur->name.other.len;
2438 if ( cur->type == certDNSName ) {
2439 if ( ntype != IS_DNS ) continue;
2441 /* is this an exact match? */
2442 if ( nlen == hlen && !strncasecmp( name, host, nlen )) {
2447 /* is this a wildcard match? */
2448 if ( domain && host[0] == '*' && host[1] == '.' &&
2449 dlen == hlen-1 && !strncasecmp( domain, host+1, dlen )) {
2453 } else if ( cur->type == certIPAddress ) {
2454 if ( ntype == IS_DNS ) continue;
2456 #ifdef LDAP_PF_INET6
2457 if (ntype == IS_IP6 && hlen != sizeof(struct in6_addr)) {
2461 if (ntype == IS_IP4 && hlen != sizeof(struct in_addr)) {
2464 if (!memcmp(host, &addr, hlen)) {
2469 } while (( cur = CERT_GetNextGeneralName( cur )) != names );
2471 PORT_FreeArena( arena, PR_FALSE );
2472 SECITEM_FreeItem( &altname, PR_FALSE );
2474 /* no altnames matched, try the CN */
2475 if ( ret != LDAP_SUCCESS ) {
2476 /* find the last CN */
2477 CERTRDN *rdn, **rdns;
2478 CERTAVA *lastava = NULL;
2482 rdns = cert->subject.rdns;
2483 while ( rdns && ( rdn = *rdns++ )) {
2484 CERTAVA *ava, **avas = rdn->avas;
2485 while ( avas && ( ava = *avas++ )) {
2486 if ( CERT_GetAVATag( ava ) == SEC_OID_AVA_COMMON_NAME )
2491 SECItem *av = CERT_DecodeAVAValue( &lastava->value );
2493 if ( av->len == nlen && !strncasecmp( name, (char *)av->data, nlen )) {
2495 } else if ( av->data[0] == '*' && av->data[1] == '.' &&
2496 domain && dlen == av->len - 1 && !strncasecmp( name,
2497 (char *)(av->data+1), dlen )) {
2501 if ( len >= sizeof(buf) )
2502 len = sizeof(buf)-1;
2503 memcpy( buf, av->data, len );
2506 SECITEM_FreeItem( av, PR_TRUE );
2509 if ( ret != LDAP_SUCCESS ) {
2510 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
2511 "common name in certificate (%s).\n",
2513 ret = LDAP_CONNECT_ERROR;
2514 if ( ld->ld_error ) {
2515 LDAP_FREE( ld->ld_error );
2517 ld->ld_error = LDAP_STRDUP(
2518 _("TLS: hostname does not match CN in peer certificate"));
2523 CERT_DestroyCertificate( cert );
2528 tlsm_session_strength( tls_session *session )
2530 tlsm_session *s = (tlsm_session *)session;
2533 rc = SSL_SecurityStatus( s, NULL, NULL, NULL, &keySize,
2535 return rc ? 0 : keySize;
2539 * TLS support for LBER Sockbufs
2542 static PRStatus PR_CALLBACK
2543 tlsm_PR_Close(PRFileDesc *fd)
2545 int rc = PR_SUCCESS;
2547 /* we don't need to actually close anything here, just
2548 pop our io layer off the stack */
2549 fd->secret = NULL; /* must have been freed before calling PR_Close */
2551 fd = PR_PopIOLayer( fd, tlsm_layer_id );
2552 /* if we are not the last layer, pass the close along */
2557 rc = fd->methods->close( fd );
2560 /* we are the last layer - just call our dtor */
2567 static PRStatus PR_CALLBACK
2568 tlsm_PR_Shutdown(PRFileDesc *fd, PRShutdownHow how)
2570 int rc = PR_SUCCESS;
2573 rc = PR_Shutdown( fd->lower, how );
2579 static int PR_CALLBACK
2580 tlsm_PR_Recv(PRFileDesc *fd, void *buf, PRInt32 len, PRIntn flags,
2581 PRIntervalTime timeout)
2586 if ( buf == NULL || len <= 0 ) return 0;
2588 p = (struct tls_data *)fd->secret;
2590 if ( p == NULL || p->sbiod == NULL ) {
2594 rc = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
2596 tlsm_map_error( errno );
2597 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2598 p->nonblock = PR_TRUE; /* fd is using non-blocking io */
2599 } else if ( errno ) { /* real error */
2600 Debug( LDAP_DEBUG_TRACE,
2601 "TLS: error: tlsm_PR_Recv returned %d - error %d:%s\n",
2602 rc, errno, STRERROR(errno) );
2609 static int PR_CALLBACK
2610 tlsm_PR_Send(PRFileDesc *fd, const void *buf, PRInt32 len, PRIntn flags,
2611 PRIntervalTime timeout)
2616 if ( buf == NULL || len <= 0 ) return 0;
2618 p = (struct tls_data *)fd->secret;
2620 if ( p == NULL || p->sbiod == NULL ) {
2624 rc = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
2626 tlsm_map_error( errno );
2627 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2628 p->nonblock = PR_TRUE;
2629 } else if ( errno ) { /* real error */
2630 Debug( LDAP_DEBUG_TRACE,
2631 "TLS: error: tlsm_PR_Send returned %d - error %d:%s\n",
2632 rc, errno, STRERROR(errno) );
2639 static int PR_CALLBACK
2640 tlsm_PR_Read(PRFileDesc *fd, void *buf, PRInt32 len)
2642 return tlsm_PR_Recv( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2645 static int PR_CALLBACK
2646 tlsm_PR_Write(PRFileDesc *fd, const void *buf, PRInt32 len)
2648 return tlsm_PR_Send( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2651 static PRStatus PR_CALLBACK
2652 tlsm_PR_GetPeerName(PRFileDesc *fd, PRNetAddr *addr)
2657 p = (struct tls_data *)fd->secret;
2659 if ( p == NULL || p->sbiod == NULL ) {
2662 len = sizeof(PRNetAddr);
2663 return getpeername( p->sbiod->sbiod_sb->sb_fd, (struct sockaddr *)addr, &len );
2666 static PRStatus PR_CALLBACK
2667 tlsm_PR_GetSocketOption(PRFileDesc *fd, PRSocketOptionData *data)
2670 p = (struct tls_data *)fd->secret;
2676 /* only the nonblocking option is supported at this time
2677 MozNSS SSL code needs it */
2678 if ( data->option != PR_SockOpt_Nonblocking ) {
2679 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2683 int flags = fcntl( p->sbiod->sbiod_sb->sb_fd, F_GETFL );
2684 data->value.non_blocking = (flags & O_NONBLOCK) ? PR_TRUE : PR_FALSE;
2686 data->value.non_blocking = p->nonblock;
2691 static PRStatus PR_CALLBACK
2694 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2698 static PRFileDesc * PR_CALLBACK
2701 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2705 static PRInt16 PR_CALLBACK
2708 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2712 static PRInt32 PR_CALLBACK
2715 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2719 static PRInt64 PR_CALLBACK
2724 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2729 static const PRIOMethods tlsm_PR_methods = {
2731 tlsm_PR_Close, /* close */
2732 tlsm_PR_Read, /* read */
2733 tlsm_PR_Write, /* write */
2734 tlsm_PR_i32_unimp, /* available */
2735 tlsm_PR_i64_unimp, /* available64 */
2736 tlsm_PR_prs_unimp, /* fsync */
2737 tlsm_PR_i32_unimp, /* seek */
2738 tlsm_PR_i64_unimp, /* seek64 */
2739 tlsm_PR_prs_unimp, /* fileInfo */
2740 tlsm_PR_prs_unimp, /* fileInfo64 */
2741 tlsm_PR_i32_unimp, /* writev */
2742 tlsm_PR_prs_unimp, /* connect */
2743 tlsm_PR_pfd_unimp, /* accept */
2744 tlsm_PR_prs_unimp, /* bind */
2745 tlsm_PR_prs_unimp, /* listen */
2746 (PRShutdownFN)tlsm_PR_Shutdown, /* shutdown */
2747 tlsm_PR_Recv, /* recv */
2748 tlsm_PR_Send, /* send */
2749 tlsm_PR_i32_unimp, /* recvfrom */
2750 tlsm_PR_i32_unimp, /* sendto */
2751 (PRPollFN)tlsm_PR_i16_unimp, /* poll */
2752 tlsm_PR_i32_unimp, /* acceptread */
2753 tlsm_PR_i32_unimp, /* transmitfile */
2754 tlsm_PR_prs_unimp, /* getsockname */
2755 tlsm_PR_GetPeerName, /* getpeername */
2756 tlsm_PR_i32_unimp, /* getsockopt OBSOLETE */
2757 tlsm_PR_i32_unimp, /* setsockopt OBSOLETE */
2758 tlsm_PR_GetSocketOption, /* getsocketoption */
2759 tlsm_PR_i32_unimp, /* setsocketoption */
2760 tlsm_PR_i32_unimp, /* Send a (partial) file with header/trailer*/
2761 (PRConnectcontinueFN)tlsm_PR_prs_unimp, /* connectcontinue */
2762 tlsm_PR_i32_unimp, /* reserved for future use */
2763 tlsm_PR_i32_unimp, /* reserved for future use */
2764 tlsm_PR_i32_unimp, /* reserved for future use */
2765 tlsm_PR_i32_unimp /* reserved for future use */
2769 * Initialize TLS subsystem. Should be called only once.
2770 * See tlsm_deferred_init for the bulk of the init process
2777 tlsm_layer_id = PR_GetUniqueIdentity( "OpenLDAP" );
2783 tlsm_sb_setup( Sockbuf_IO_Desc *sbiod, void *arg )
2786 tlsm_session *session = arg;
2789 assert( sbiod != NULL );
2791 p = LBER_MALLOC( sizeof( *p ) );
2796 fd = PR_GetIdentitiesLayer( session, tlsm_layer_id );
2802 fd->secret = (PRFilePrivate *)p;
2803 p->session = session;
2805 sbiod->sbiod_pvt = p;
2810 tlsm_sb_remove( Sockbuf_IO_Desc *sbiod )
2814 assert( sbiod != NULL );
2815 assert( sbiod->sbiod_pvt != NULL );
2817 p = (struct tls_data *)sbiod->sbiod_pvt;
2818 PR_Close( p->session );
2819 LBER_FREE( sbiod->sbiod_pvt );
2820 sbiod->sbiod_pvt = NULL;
2825 tlsm_sb_close( Sockbuf_IO_Desc *sbiod )
2829 assert( sbiod != NULL );
2830 assert( sbiod->sbiod_pvt != NULL );
2832 p = (struct tls_data *)sbiod->sbiod_pvt;
2833 PR_Shutdown( p->session, PR_SHUTDOWN_BOTH );
2838 tlsm_sb_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
2842 assert( sbiod != NULL );
2843 assert( sbiod->sbiod_pvt != NULL );
2845 p = (struct tls_data *)sbiod->sbiod_pvt;
2847 if ( opt == LBER_SB_OPT_GET_SSL ) {
2848 *((tlsm_session **)arg) = p->session;
2851 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
2852 if ( tlsm_is_io_ready( p->session, PR_POLL_READ, NULL ) > 0 ) {
2858 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
2862 tlsm_sb_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
2868 assert( sbiod != NULL );
2869 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
2871 p = (struct tls_data *)sbiod->sbiod_pvt;
2873 ret = PR_Recv( p->session, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2875 err = PR_GetError();
2876 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
2877 sbiod->sbiod_sb->sb_trans_needs_read = 1;
2878 sock_errset(EWOULDBLOCK);
2881 sbiod->sbiod_sb->sb_trans_needs_read = 0;
2887 tlsm_sb_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
2893 assert( sbiod != NULL );
2894 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
2896 p = (struct tls_data *)sbiod->sbiod_pvt;
2898 ret = PR_Send( p->session, (char *)buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2900 err = PR_GetError();
2901 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
2902 sbiod->sbiod_sb->sb_trans_needs_write = 1;
2903 sock_errset(EWOULDBLOCK);
2907 sbiod->sbiod_sb->sb_trans_needs_write = 0;
2912 static Sockbuf_IO tlsm_sbio =
2914 tlsm_sb_setup, /* sbi_setup */
2915 tlsm_sb_remove, /* sbi_remove */
2916 tlsm_sb_ctrl, /* sbi_ctrl */
2917 tlsm_sb_read, /* sbi_read */
2918 tlsm_sb_write, /* sbi_write */
2919 tlsm_sb_close /* sbi_close */
2922 tls_impl ldap_int_tls_impl = {
2934 tlsm_session_connect,
2935 tlsm_session_accept,
2936 tlsm_session_upflags,
2937 tlsm_session_errmsg,
2939 tlsm_session_peer_dn,
2940 tlsm_session_chkhost,
2941 tlsm_session_strength,
2945 #ifdef LDAP_R_COMPILE
2954 #endif /* HAVE_MOZNSS */