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"
109 static SECMODModule *pem_module;
111 #define DEFAULT_TOKEN_NAME "default"
112 /* sprintf format used to create token name */
113 #define TLSM_PEM_TOKEN_FMT "PEM Token #%ld"
115 static int tlsm_slot_count;
117 #define PK11_SETATTRS(x,id,v,l) (x)->type = (id); \
118 (x)->pValue=(v); (x)->ulValueLen = (l);
120 /* forward declaration */
121 static int tlsm_init( void );
123 #ifdef LDAP_R_COMPILE
126 tlsm_thr_init( void )
130 #endif /* LDAP_R_COMPILE */
133 tlsm_dump_cipher_info(PRFileDesc *fd)
137 for (ii = 0; ii < SSL_NumImplementedCiphers; ++ii) {
138 PRInt32 cipher = (PRInt32)SSL_ImplementedCiphers[ii];
139 PRBool enabled = PR_FALSE;
141 SSLCipherSuiteInfo info;
144 SSL_CipherPrefGet(fd, cipher, &enabled);
146 SSL_CipherPrefGetDefault(cipher, &enabled);
148 SSL_CipherPolicyGet(cipher, &policy);
149 SSL_GetCipherSuiteInfo(cipher, &info, (PRUintn)sizeof(info));
150 Debug( LDAP_DEBUG_TRACE,
151 "TLS: cipher: %d - %s, enabled: %d, ",
152 info.cipherSuite, info.cipherSuiteName, enabled );
153 Debug( LDAP_DEBUG_TRACE,
154 "policy: %d\n", policy, 0, 0 );
160 /* Cipher definitions */
162 char *ossl_name; /* The OpenSSL cipher name */
163 int num; /* The cipher id */
164 int attr; /* cipher attributes: algorithms, etc */
165 int version; /* protocol version valid for this cipher */
166 int bits; /* bits of strength */
167 int alg_bits; /* bits of the algorithm */
168 int strength; /* LOW, MEDIUM, HIGH */
169 int enabled; /* Enabled by default? */
172 /* cipher attributes */
173 #define SSL_kRSA 0x00000001L
174 #define SSL_aRSA 0x00000002L
175 #define SSL_aDSS 0x00000004L
176 #define SSL_DSS SSL_aDSS
177 #define SSL_eNULL 0x00000008L
178 #define SSL_DES 0x00000010L
179 #define SSL_3DES 0x00000020L
180 #define SSL_RC4 0x00000040L
181 #define SSL_RC2 0x00000080L
182 #define SSL_AES 0x00000100L
183 #define SSL_MD5 0x00000200L
184 #define SSL_SHA1 0x00000400L
185 #define SSL_SHA SSL_SHA1
186 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
188 /* cipher strength */
189 #define SSL_NULL 0x00000001L
190 #define SSL_EXPORT40 0x00000002L
191 #define SSL_EXPORT56 0x00000004L
192 #define SSL_LOW 0x00000008L
193 #define SSL_MEDIUM 0x00000010L
194 #define SSL_HIGH 0x00000020L
196 #define SSL2 0x00000001L
197 #define SSL3 0x00000002L
198 /* OpenSSL treats SSL3 and TLSv1 the same */
201 /* Cipher translation */
202 static cipher_properties ciphers_def[] = {
204 {"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},
205 {"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},
206 {"RC4-MD5", SSL_EN_RC4_128_WITH_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL2, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
207 {"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},
208 {"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},
209 {"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},
212 {"RC4-MD5", SSL_RSA_WITH_RC4_128_MD5, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5, SSL3, 128, 128, SSL_MEDIUM, SSL_ALLOWED},
213 {"RC4-SHA", SSL_RSA_WITH_RC4_128_SHA, SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_SHA1, SSL3, 128, 128, SSL_MEDIUM, SSL_NOT_ALLOWED},
214 {"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},
215 {"DES-CBC-SHA", SSL_RSA_WITH_DES_CBC_SHA, SSL_kRSA|SSL_aRSA|SSL_DES|SSL_SHA1, SSL3, 56, 56, SSL_LOW, SSL_ALLOWED},
216 {"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},
217 {"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},
218 {"NULL-MD5", SSL_RSA_WITH_NULL_MD5, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_MD5, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
219 {"NULL-SHA", SSL_RSA_WITH_NULL_SHA, SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_SHA1, SSL3, 0, 0, SSL_NULL, SSL_NOT_ALLOWED},
222 {"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},
223 {"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},
224 {"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},
225 {"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},
228 #define ciphernum (sizeof(ciphers_def)/sizeof(cipher_properties))
230 /* given err which is the current errno, calls PR_SetError with
231 the corresponding NSPR error code */
233 tlsm_map_error(int err)
239 prError = PR_NO_ACCESS_RIGHTS_ERROR;
242 prError = PR_ADDRESS_IN_USE_ERROR;
245 prError = PR_ADDRESS_NOT_AVAILABLE_ERROR;
248 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
251 prError = PR_WOULD_BLOCK_ERROR;
254 * On QNX and Neutrino, EALREADY is defined as EBUSY.
256 #if EALREADY != EBUSY
258 prError = PR_ALREADY_INITIATED_ERROR;
262 prError = PR_BAD_DESCRIPTOR_ERROR;
266 prError = PR_IO_ERROR;
270 prError = PR_FILESYSTEM_MOUNTED_ERROR;
273 prError = PR_CONNECT_ABORTED_ERROR;
276 prError = PR_CONNECT_REFUSED_ERROR;
279 prError = PR_CONNECT_RESET_ERROR;
282 prError = PR_DEADLOCK_ERROR;
286 prError = PR_DIRECTORY_CORRUPTED_ERROR;
291 prError = PR_NO_DEVICE_SPACE_ERROR;
295 prError = PR_FILE_EXISTS_ERROR;
298 prError = PR_ACCESS_FAULT_ERROR;
301 prError = PR_FILE_TOO_BIG_ERROR;
304 prError = PR_HOST_UNREACHABLE_ERROR;
307 prError = PR_IN_PROGRESS_ERROR;
310 prError = PR_PENDING_INTERRUPT_ERROR;
313 prError = PR_INVALID_ARGUMENT_ERROR;
316 prError = PR_IO_ERROR;
319 prError = PR_IS_CONNECTED_ERROR;
322 prError = PR_IS_DIRECTORY_ERROR;
325 prError = PR_LOOP_ERROR;
328 prError = PR_PROC_DESC_TABLE_FULL_ERROR;
331 prError = PR_MAX_DIRECTORY_ENTRIES_ERROR;
334 prError = PR_INVALID_ARGUMENT_ERROR;
338 prError = PR_REMOTE_FILE_ERROR;
342 prError = PR_NAME_TOO_LONG_ERROR;
345 prError = PR_NETWORK_UNREACHABLE_ERROR;
348 prError = PR_SYS_DESC_TABLE_FULL_ERROR;
351 * On SCO OpenServer 5, ENOBUFS is defined as ENOSR.
353 #if defined(ENOBUFS) && (ENOBUFS != ENOSR)
355 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
359 prError = PR_FILE_NOT_FOUND_ERROR;
362 prError = PR_FILE_NOT_FOUND_ERROR;
365 prError = PR_FILE_IS_LOCKED_ERROR;
369 prError = PR_REMOTE_FILE_ERROR;
373 prError = PR_OUT_OF_MEMORY_ERROR;
376 prError = PR_INVALID_ARGUMENT_ERROR;
379 prError = PR_NO_DEVICE_SPACE_ERROR;
383 prError = PR_INSUFFICIENT_RESOURCES_ERROR;
387 prError = PR_NOT_CONNECTED_ERROR;
390 prError = PR_NOT_DIRECTORY_ERROR;
393 prError = PR_NOT_SOCKET_ERROR;
396 prError = PR_FILE_NOT_FOUND_ERROR;
399 prError = PR_NOT_TCP_SOCKET_ERROR;
403 prError = PR_BUFFER_OVERFLOW_ERROR;
407 prError = PR_NO_ACCESS_RIGHTS_ERROR;
410 prError = PR_CONNECT_RESET_ERROR;
414 prError = PR_IO_ERROR;
417 case EPROTONOSUPPORT:
418 prError = PR_PROTOCOL_NOT_SUPPORTED_ERROR;
421 prError = PR_ADDRESS_NOT_SUPPORTED_ERROR;
424 prError = PR_INVALID_METHOD_ERROR;
427 prError = PR_READ_ONLY_FILESYSTEM_ERROR;
430 prError = PR_INVALID_METHOD_ERROR;
433 prError = PR_IO_TIMEOUT_ERROR;
435 #if EWOULDBLOCK != EAGAIN
437 prError = PR_WOULD_BLOCK_ERROR;
441 prError = PR_NOT_SAME_DEVICE_ERROR;
444 prError = PR_UNKNOWN_ERROR;
447 PR_SetError( prError, err );
451 * cipher_list is an integer array with the following values:
452 * -1: never enable this cipher
457 nss_parse_ciphers(const char *cipherstr, int cipher_list[ciphernum])
466 /* All disabled to start */
467 for (i=0; i<ciphernum; i++)
470 ciphertip = strdup(cipherstr);
471 cipher = ciphers = ciphertip;
473 while (ciphers && (strlen(ciphers))) {
474 while ((*cipher) && (isspace(*cipher)))
479 case '+': /* Add something */
483 case '-': /* Subtract something */
487 case '!': /* Disable something */
496 if ((ciphers = strchr(cipher, ':'))) {
500 /* Do the easy one first */
501 if (!strcmp(cipher, "ALL")) {
502 for (i=0; i<ciphernum; i++) {
503 if (!(ciphers_def[i].attr & SSL_eNULL))
504 cipher_list[i] = action;
506 } else if (!strcmp(cipher, "COMPLEMENTOFALL")) {
507 for (i=0; i<ciphernum; i++) {
508 if ((ciphers_def[i].attr & SSL_eNULL))
509 cipher_list[i] = action;
511 } else if (!strcmp(cipher, "DEFAULT")) {
512 for (i=0; i<ciphernum; i++) {
513 cipher_list[i] = ciphers_def[i].enabled == SSL_ALLOWED ? 1 : 0;
522 while (c && (strlen(c))) {
524 if ((c = strchr(cipher, '+'))) {
528 if (!strcmp(cipher, "RSA")) {
530 } else if ((!strcmp(cipher, "NULL")) || (!strcmp(cipher, "eNULL"))) {
532 } else if (!strcmp(cipher, "AES")) {
534 } else if (!strcmp(cipher, "3DES")) {
536 } else if (!strcmp(cipher, "DES")) {
538 } else if (!strcmp(cipher, "RC4")) {
540 } else if (!strcmp(cipher, "RC2")) {
542 } else if (!strcmp(cipher, "MD5")) {
544 } else if ((!strcmp(cipher, "SHA")) || (!strcmp(cipher, "SHA1"))) {
546 } else if (!strcmp(cipher, "SSLv2")) {
548 } else if (!strcmp(cipher, "SSLv3")) {
550 } else if (!strcmp(cipher, "TLSv1")) {
552 } else if (!strcmp(cipher, "HIGH")) {
553 strength |= SSL_HIGH;
554 } else if (!strcmp(cipher, "MEDIUM")) {
555 strength |= SSL_MEDIUM;
556 } else if (!strcmp(cipher, "LOW")) {
558 } else if ((!strcmp(cipher, "EXPORT")) || (!strcmp(cipher, "EXP"))) {
559 strength |= SSL_EXPORT40|SSL_EXPORT56;
560 } else if (!strcmp(cipher, "EXPORT40")) {
561 strength |= SSL_EXPORT40;
562 } else if (!strcmp(cipher, "EXPORT56")) {
563 strength |= SSL_EXPORT56;
571 /* If we have a mask, apply it. If not then perhaps they provided
572 * a specific cipher to enable.
574 if (mask || strength || protocol) {
575 for (i=0; i<ciphernum; i++) {
576 if (((ciphers_def[i].attr & mask) ||
577 (ciphers_def[i].strength & strength) ||
578 (ciphers_def[i].version & protocol)) &&
579 (cipher_list[i] != -1)) {
580 /* Enable the NULL ciphers only if explicity
582 if (ciphers_def[i].attr & SSL_eNULL) {
583 if (mask & SSL_eNULL)
584 cipher_list[i] = action;
586 cipher_list[i] = action;
590 for (i=0; i<ciphernum; i++) {
591 if (!strcmp(ciphers_def[i].ossl_name, cipher) &&
592 cipher_list[1] != -1)
593 cipher_list[i] = action;
602 /* See if any ciphers were enabled */
604 for (i=0; i<ciphernum; i++) {
605 if (cipher_list[i] == 1)
615 tlsm_parse_ciphers(tlsm_ctx *ctx, const char *str)
617 int cipher_state[ciphernum];
623 rv = nss_parse_ciphers(str, cipher_state);
626 /* First disable everything */
627 for (i = 0; i < SSL_NumImplementedCiphers; i++)
628 SSL_CipherPrefSet(ctx->tc_model, SSL_ImplementedCiphers[i], SSL_NOT_ALLOWED);
630 /* Now enable what was requested */
631 for (i=0; i<ciphernum; i++) {
632 SSLCipherSuiteInfo suite;
635 if (SSL_GetCipherSuiteInfo(ciphers_def[i].num, &suite, sizeof suite)
637 enabled = cipher_state[i] < 0 ? 0 : cipher_state[i];
638 if (enabled == SSL_ALLOWED) {
639 if (PK11_IsFIPS() && !suite.isFIPS)
640 enabled = SSL_NOT_ALLOWED;
642 SSL_CipherPrefSet(ctx->tc_model, ciphers_def[i].num, enabled);
647 return rv == 1 ? 0 : -1;
651 tlsm_bad_cert_handler(void *arg, PRFileDesc *ssl)
653 SECStatus success = SECSuccess;
655 tlsm_ctx *ctx = (tlsm_ctx *)arg;
661 err = PORT_GetError();
664 case SEC_ERROR_UNTRUSTED_ISSUER:
665 case SEC_ERROR_UNKNOWN_ISSUER:
666 case SEC_ERROR_EXPIRED_CERTIFICATE:
667 if (ctx->tc_verify_cert) {
668 success = SECFailure;
671 /* we bypass NSS's hostname checks and do our own */
672 case SSL_ERROR_BAD_CERT_DOMAIN:
675 success = SECFailure;
683 tlsm_dump_security_status(PRFileDesc *fd)
685 char * cp; /* bulk cipher name */
686 char * ip; /* cert issuer DN */
687 char * sp; /* cert subject DN */
688 int op; /* High, Low, Off */
689 int kp0; /* total key bits */
690 int kp1; /* secret key bits */
691 SSL3Statistics * ssl3stats = SSL_GetStatistics();
693 SSL_SecurityStatus( fd, &op, &cp, &kp0, &kp1, &ip, &sp );
694 Debug( LDAP_DEBUG_TRACE,
695 "TLS certificate verification: subject: %s, issuer: %s, cipher: %s, ",
696 sp ? sp : "-unknown-", ip ? ip : "-unknown-", cp ? cp : "-unknown-" );
700 Debug( LDAP_DEBUG_TRACE,
701 "security level: %s, secret key bits: %d, total key bits: %d, ",
702 ((op == SSL_SECURITY_STATUS_ON_HIGH) ? "high" :
703 ((op == SSL_SECURITY_STATUS_ON_LOW) ? "low" : "off")),
706 Debug( LDAP_DEBUG_TRACE,
707 "cache hits: %ld, cache misses: %ld, cache not reusable: %ld\n",
708 ssl3stats->hch_sid_cache_hits, ssl3stats->hch_sid_cache_misses,
709 ssl3stats->hch_sid_cache_not_ok );
714 #ifdef READ_PASSWORD_FROM_FILE
716 tlsm_get_pin_from_file(const char *token_name, tlsm_ctx *ctx)
719 char *contents = NULL;
722 char *candidate = NULL;
723 PRFileInfo file_info;
724 PRFileDesc *pwd_fileptr = PR_Open( ctx->tc_pin_file, PR_RDONLY, 00400 );
726 /* open the password file */
727 if ( !pwd_fileptr ) {
728 PRErrorCode errcode = PR_GetError();
729 Debug( LDAP_DEBUG_ANY,
730 "TLS: could not open security pin file %s - error %d:%s.\n",
731 ctx->tc_pin_file, errcode,
732 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
736 /* get the file size */
737 if ( PR_SUCCESS != PR_GetFileInfo( ctx->tc_pin_file, &file_info ) ) {
738 PRErrorCode errcode = PR_GetError();
739 Debug( LDAP_DEBUG_ANY,
740 "TLS: could not get file info from pin file %s - error %d:%s.\n",
741 ctx->tc_pin_file, errcode,
742 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
746 /* create a buffer to hold the file contents */
747 if ( !( contents = PR_MALLOC( file_info.size + 1 ) ) ) {
748 PRErrorCode errcode = PR_GetError();
749 Debug( LDAP_DEBUG_ANY,
750 "TLS: could not alloc a buffer for contents of pin file %s - error %d:%s.\n",
751 ctx->tc_pin_file, errcode,
752 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
756 /* read file into the buffer */
757 if( PR_Read( pwd_fileptr, contents, file_info.size ) <= 0 ) {
758 PRErrorCode errcode = PR_GetError();
759 Debug( LDAP_DEBUG_ANY,
760 "TLS: could not read the file contents from pin file %s - error %d:%s.\n",
761 ctx->tc_pin_file, errcode,
762 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
766 /* format is [tokenname:]password EOL [tokenname:]password EOL ... */
767 /* if you want to use a password containing a colon character, use
768 the special tokenname "default" */
769 for ( line = PL_strtok_r( contents, "\r\n", &lasts ); line;
770 line = PL_strtok_r( NULL, "\r\n", &lasts ) ) {
774 continue; /* skip blank lines */
776 colon = PL_strchr( line, ':' );
778 if ( *(colon + 1) && token_name &&
779 !PL_strncmp( token_name, line, colon-line ) ) {
780 candidate = colon + 1; /* found a definite match */
782 } else if ( !PL_strncmp( DEFAULT_TOKEN_NAME, line, colon-line ) ) {
783 candidate = colon + 1; /* found possible match */
785 } else { /* no token name */
791 PR_Close( pwd_fileptr );
794 pwdstr = PL_strdup( candidate );
796 PL_strfree( contents );
800 #endif /* READ_PASSWORD_FROM_FILE */
802 #ifdef READ_PASSWORD_FROM_STDIN
804 * Turn the echoing off on a tty.
809 if ( isatty( fd ) ) {
811 tcgetattr( fd, &tio );
812 tio.c_lflag &= ~ECHO;
813 tcsetattr( fd, TCSAFLUSH, &tio );
818 * Turn the echoing on on a tty.
823 if ( isatty( fd ) ) {
825 tcgetattr( fd, &tio );
827 tcsetattr( fd, TCSAFLUSH, &tio );
828 tcsetattr( fd, TCSAFLUSH, &tio );
831 #endif /* READ_PASSWORD_FROM_STDIN */
834 * This does the actual work of reading the pin/password/pass phrase
837 tlsm_get_pin(PK11SlotInfo *slot, PRBool retry, tlsm_ctx *ctx)
839 char *token_name = NULL;
842 token_name = PK11_GetTokenName( slot );
843 #ifdef READ_PASSWORD_FROM_FILE
844 /* Try to get the passwords from the password file if it exists.
845 * THIS IS UNSAFE and is provided for convenience only. Without this
846 * capability the server would have to be started in foreground mode
847 * if using an encrypted key.
849 if ( ctx->tc_pin_file ) {
850 pwdstr = tlsm_get_pin_from_file( token_name, ctx );
852 #endif /* RETRIEVE_PASSWORD_FROM_FILE */
853 #ifdef READ_PASSWORD_FROM_STDIN
855 int infd = PR_FileDesc2NativeHandle( PR_STDIN );
856 int isTTY = isatty( infd );
857 unsigned char phrase[200];
858 /* Prompt for password */
861 "Please enter pin, password, or pass phrase for security token '%s': ",
862 token_name ? token_name : DEFAULT_TOKEN_NAME );
865 fgets( (char*)phrase, sizeof(phrase), stdin );
867 fprintf( stdout, "\n" );
870 /* stomp on newline */
871 phrase[strlen((char*)phrase)-1] = 0;
873 pwdstr = PL_strdup( (char*)phrase );
876 #endif /* READ_PASSWORD_FROM_STDIN */
881 * PKCS11 devices (including the internal softokn cert/key database)
882 * may be protected by a pin or password or even pass phrase
883 * MozNSS needs a way for the user to provide that
886 tlsm_pin_prompt(PK11SlotInfo *slot, PRBool retry, void *arg)
888 tlsm_ctx *ctx = (tlsm_ctx *)arg;
890 return tlsm_get_pin( slot, retry, ctx );
894 tlsm_auth_cert_handler(void *arg, PRFileDesc *fd,
895 PRBool checksig, PRBool isServer)
897 SECStatus ret = SSL_AuthCertificate(arg, fd, checksig, isServer);
899 tlsm_dump_security_status( fd );
900 Debug( LDAP_DEBUG_TRACE,
901 "TLS certificate verification: %s\n",
902 ret == SECSuccess ? "ok" : "bad", 0, 0 );
904 if ( ret != SECSuccess ) {
905 PRErrorCode errcode = PORT_GetError();
906 Debug( LDAP_DEBUG_ANY,
907 "TLS certificate verification: Error, %d: %s\n",
908 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 ) ;
915 tlsm_authenticate_to_slot( tlsm_ctx *ctx, PK11SlotInfo *slot )
919 if ( SECSuccess != PK11_Authenticate( slot, PR_FALSE, ctx ) ) {
920 char *token_name = PK11_GetTokenName( slot );
921 PRErrorCode errcode = PR_GetError();
922 Debug( LDAP_DEBUG_ANY,
923 "TLS: could not authenticate to the security token %s - error %d:%s.\n",
924 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
925 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
927 rc = 0; /* success */
934 tlsm_init_tokens( tlsm_ctx *ctx )
936 PK11SlotList *slotList;
937 PK11SlotListElement *listEntry;
940 slotList = PK11_GetAllTokens( CKM_INVALID_MECHANISM, PR_FALSE, PR_TRUE, NULL );
942 for ( listEntry = PK11_GetFirstSafe( slotList ); !rc && listEntry;
943 listEntry = PK11_GetNextSafe( slotList, listEntry, PR_FALSE ) ) {
944 PK11SlotInfo *slot = listEntry->slot;
945 rc = tlsm_authenticate_to_slot( ctx, slot );
948 PK11_FreeSlotList( slotList );
954 tlsm_nss_shutdown_cb( void *appData, void *nssData )
956 SECStatus rc = SECSuccess;
958 SSL_ShutdownServerSessionIDCache();
959 SSL_ClearSessionCache();
962 SECMOD_UnloadUserModule( pem_module );
963 SECMOD_DestroyModule( pem_module );
970 tlsm_init_pem_module( void )
973 char *fullname = NULL;
974 char *configstring = NULL;
980 /* not loaded - load it */
981 /* get the system dependent library name */
982 fullname = PR_GetLibraryName( NULL, PEM_LIBRARY );
983 /* Load our PKCS#11 module */
984 configstring = PR_smprintf( "library=%s name=" PEM_MODULE " parameters=\"\"", fullname );
985 PL_strfree( fullname );
987 pem_module = SECMOD_LoadUserModule( configstring, NULL, PR_FALSE );
988 PR_smprintf_free( configstring );
990 if ( !pem_module || !pem_module->loaded ) {
992 SECMOD_DestroyModule( pem_module );
1002 tlsm_add_pem_obj( tlsm_ctx *ctx, PK11GenericObject *obj )
1004 int idx = ctx->tc_n_pem_objs;
1005 ctx->tc_n_pem_objs++;
1006 ctx->tc_pem_objs = (PK11GenericObject **)
1007 PORT_Realloc( ctx->tc_pem_objs, ctx->tc_n_pem_objs * sizeof( PK11GenericObject * ) );
1008 ctx->tc_pem_objs[idx] = obj;
1012 tlsm_free_pem_objs( tlsm_ctx *ctx )
1014 /* free in reverse order of allocation */
1015 while ( ctx->tc_n_pem_objs-- ) {
1016 PK11_DestroyGenericObject( ctx->tc_pem_objs[ctx->tc_n_pem_objs] );
1017 ctx->tc_pem_objs[ctx->tc_n_pem_objs] = NULL;
1019 PORT_Free(ctx->tc_pem_objs);
1020 ctx->tc_pem_objs = NULL;
1021 ctx->tc_n_pem_objs = 0;
1025 tlsm_add_cert_from_file( tlsm_ctx *ctx, const char *filename, PRBool isca )
1028 PK11SlotInfo *slot = NULL;
1029 PK11GenericObject *rv;
1030 CK_ATTRIBUTE *attrs;
1031 CK_ATTRIBUTE theTemplate[20];
1032 CK_BBOOL cktrue = CK_TRUE;
1033 CK_BBOOL ckfalse = CK_FALSE;
1034 CK_OBJECT_CLASS objClass = CKO_CERTIFICATE;
1035 char tmpslotname[64];
1036 char *slotname = NULL;
1037 const char *ptr = NULL;
1038 char sep = PR_GetDirectorySeparator();
1040 attrs = theTemplate;
1043 slotID = 0; /* CA and trust objects use slot 0 */
1044 PR_snprintf( tmpslotname, sizeof(tmpslotname), TLSM_PEM_TOKEN_FMT, slotID );
1045 slotname = tmpslotname;
1047 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1048 slotID = ++tlsm_slot_count;
1049 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1051 slotname = ctx->tc_slotname;
1053 if ( ( ptr = PL_strrchr( filename, sep ) ) ) {
1054 PL_strfree( ctx->tc_certname );
1056 ctx->tc_certname = PR_smprintf( "%s:%s", slotname, ptr );
1060 slot = PK11_FindSlotByName( slotname );
1063 PRErrorCode errcode = PR_GetError();
1064 Debug( LDAP_DEBUG_ANY,
1065 "TLS: could not find the slot for certificate %s - error %d:%s.\n",
1066 ctx->tc_certname, errcode,
1067 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1071 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1072 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1073 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1075 PK11_SETATTRS( attrs, CKA_TRUST, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1077 PK11_SETATTRS( attrs, CKA_TRUST, &ckfalse, sizeof(CK_BBOOL) ); attrs++;
1079 /* This loads the certificate in our PEM module into the appropriate
1082 rv = PK11_CreateGenericObject( slot, theTemplate, 4, PR_FALSE /* isPerm */ );
1084 PK11_FreeSlot( slot );
1087 PRErrorCode errcode = PR_GetError();
1088 Debug( LDAP_DEBUG_ANY,
1089 "TLS: could not add the certificate %s - error %d:%s.\n",
1090 ctx->tc_certname, errcode,
1091 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1095 tlsm_add_pem_obj( ctx, rv );
1101 tlsm_add_key_from_file( tlsm_ctx *ctx, const char *filename )
1104 PK11SlotInfo * slot = NULL;
1105 PK11GenericObject *rv;
1106 CK_ATTRIBUTE *attrs;
1107 CK_ATTRIBUTE theTemplate[20];
1108 CK_BBOOL cktrue = CK_TRUE;
1109 CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1112 attrs = theTemplate;
1114 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1115 slotID = ++tlsm_slot_count;
1116 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1118 slot = PK11_FindSlotByName( ctx->tc_slotname );
1121 PRErrorCode errcode = PR_GetError();
1122 Debug( LDAP_DEBUG_ANY,
1123 "TLS: could not find the slot %s for the private key - error %d:%s.\n",
1124 ctx->tc_slotname, errcode,
1125 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1129 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1130 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1131 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1132 rv = PK11_CreateGenericObject( slot, theTemplate, 3, PR_FALSE /* isPerm */ );
1135 PRErrorCode errcode = PR_GetError();
1136 Debug( LDAP_DEBUG_ANY,
1137 "TLS: could not add the certificate %s - error %d:%s.\n",
1138 ctx->tc_certname, errcode,
1139 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1142 /* When adding an encrypted key the PKCS#11 will be set as removed */
1143 /* This will force the token to be seen as re-inserted */
1144 SECMOD_WaitForAnyTokenEvent( pem_module, 0, 0 );
1145 PK11_IsPresent( slot );
1149 PK11_FreeSlot( slot );
1152 tlsm_add_pem_obj( ctx, rv );
1158 tlsm_init_ca_certs( tlsm_ctx *ctx, const char *cacertfile, const char *cacertdir )
1160 PRBool isca = PR_TRUE;
1163 int rc = tlsm_add_cert_from_file( ctx, cacertfile, isca );
1175 memset( &fi, 0, sizeof(fi) );
1176 status = PR_GetFileInfo( cacertdir, &fi );
1177 if ( PR_SUCCESS != status) {
1178 PRErrorCode errcode = PR_GetError();
1179 Debug( LDAP_DEBUG_ANY,
1180 "TLS: could not get info about the CA certificate directory %s - error %d:%s.\n",
1182 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1186 if ( fi.type != PR_FILE_DIRECTORY ) {
1187 Debug( LDAP_DEBUG_ANY,
1188 "TLS: error: the CA certificate directory %s is not a directory.\n",
1193 dir = PR_OpenDir( cacertdir );
1194 if ( NULL == dir ) {
1195 PRErrorCode errcode = PR_GetError();
1196 Debug( LDAP_DEBUG_ANY,
1197 "TLS: could not open the CA certificate directory %s - error %d:%s.\n",
1199 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1205 entry = PR_ReadDir( dir, PR_SKIP_BOTH | PR_SKIP_HIDDEN );
1206 if ( NULL != entry ) {
1207 char *fullpath = PR_smprintf( "%s/%s", cacertdir, entry->name );
1208 if ( !tlsm_add_cert_from_file( ctx, fullpath, isca ) ) {
1209 status = 0; /* found at least 1 valid CA file in the dir */
1211 PR_smprintf_free( fullpath );
1213 } while ( NULL != entry );
1217 PRErrorCode errcode = PR_GetError();
1218 Debug( LDAP_DEBUG_ANY,
1219 "TLS: did not find any valid CA certificate files in the CA certificate directory %s - error %d:%s.\n",
1221 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1230 * This is the part of the init we defer until we get the
1231 * actual security configuration information. This is
1232 * only called once, protected by a PRCallOnce
1233 * NOTE: This must be done before the first call to SSL_ImportFD,
1234 * especially the setting of the policy
1235 * NOTE: This must be called after fork()
1238 tlsm_deferred_init( void *arg )
1240 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1241 struct ldaptls *lt = ctx->tc_config;
1242 const char *securitydirs[3];
1245 PRErrorCode errcode = 1;
1246 #ifdef HAVE_NSS_INITCONTEXT
1247 NSSInitParameters initParams;
1248 NSSInitContext *initctx = NULL;
1252 #ifdef HAVE_NSS_INITCONTEXT
1253 memset( &initParams, 0, sizeof( initParams ) );
1254 initParams.length = sizeof( initParams );
1255 #endif /* HAVE_NSS_INITCONTEXT */
1257 #ifndef HAVE_NSS_INITCONTEXT
1258 if ( !NSS_IsInitialized() ) {
1259 #endif /* HAVE_NSS_INITCONTEXT */
1261 MOZNSS_DIR will override everything else - you can
1262 always set MOZNSS_DIR to force the use of this
1264 If using MOZNSS, specify the location of the moznss db dir
1265 in the cacertdir directive of the OpenLDAP configuration.
1266 DEFAULT_MOZNSS_DIR will only be used if the code cannot
1267 find a security dir to use based on the current
1271 securitydirs[nn++] = PR_GetEnv( "MOZNSS_DIR" );
1272 securitydirs[nn++] = lt->lt_cacertdir;
1273 securitydirs[nn++] = PR_GetEnv( "DEFAULT_MOZNSS_DIR" );
1274 for ( ii = 0; ii < nn; ++ii ) {
1275 const char *securitydir = securitydirs[ii];
1276 if ( NULL == securitydir ) {
1279 #ifdef HAVE_NSS_INITCONTEXT
1280 #ifdef INITCONTEXT_HACK
1281 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1282 rc = NSS_Initialize( securitydir, "", "", SECMOD_DB, NSS_INIT_READONLY );
1284 initctx = NSS_InitContext( securitydir, "", "", SECMOD_DB,
1285 &initParams, NSS_INIT_READONLY );
1286 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1289 initctx = NSS_InitContext( securitydir, "", "", SECMOD_DB,
1290 &initParams, NSS_INIT_READONLY );
1291 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1294 rc = NSS_Initialize( securitydir, "", "", SECMOD_DB, NSS_INIT_READONLY );
1297 if ( rc != SECSuccess ) {
1298 errcode = PORT_GetError();
1299 Debug( LDAP_DEBUG_TRACE,
1300 "TLS: could not initialize moznss using security dir %s - error %d:%s.\n",
1301 securitydir, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1304 Debug( LDAP_DEBUG_TRACE, "TLS: using moznss security dir %s.\n",
1305 securitydir, 0, 0 );
1311 if ( errcode ) { /* no moznss db found, or not using moznss db */
1312 #ifdef HAVE_NSS_INITCONTEXT
1313 int flags = NSS_INIT_READONLY|NSS_INIT_NOCERTDB|NSS_INIT_NOMODDB;
1314 #ifdef INITCONTEXT_HACK
1315 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1316 rc = NSS_NoDB_Init( NULL );
1318 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1319 &initParams, flags );
1320 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1323 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1324 &initParams, flags );
1325 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1328 rc = NSS_NoDB_Init( NULL );
1330 if ( rc != SECSuccess ) {
1331 errcode = PORT_GetError();
1332 Debug( LDAP_DEBUG_ANY,
1333 "TLS: could not initialize moznss - error %d:%s.\n",
1334 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1338 #ifdef HAVE_NSS_INITCONTEXT
1339 ctx->tc_initctx = initctx;
1342 /* initialize the PEM module */
1343 if ( tlsm_init_pem_module() ) {
1344 errcode = PORT_GetError();
1345 Debug( LDAP_DEBUG_ANY,
1346 "TLS: could not initialize moznss PEM module - error %d:%s.\n",
1347 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1351 if ( tlsm_init_ca_certs( ctx, lt->lt_cacertfile, lt->lt_cacertdir ) ) {
1355 ctx->tc_using_pem = PR_TRUE;
1358 #ifdef HAVE_NSS_INITCONTEXT
1359 if ( !ctx->tc_initctx ) {
1360 ctx->tc_initctx = initctx;
1364 NSS_SetDomesticPolicy();
1366 PK11_SetPasswordFunc( tlsm_pin_prompt );
1368 if ( tlsm_init_tokens( ctx ) ) {
1372 /* register cleanup function */
1373 /* delete the old one, if any */
1374 NSS_UnregisterShutdown( tlsm_nss_shutdown_cb, NULL );
1375 NSS_RegisterShutdown( tlsm_nss_shutdown_cb, NULL );
1377 #ifndef HAVE_NSS_INITCONTEXT
1379 #endif /* HAVE_NSS_INITCONTEXT */
1385 tlsm_authenticate( tlsm_ctx *ctx, const char *certname, const char *pininfo )
1387 const char *colon = NULL;
1388 char *token_name = NULL;
1389 PK11SlotInfo *slot = NULL;
1392 if ( !certname || !*certname ) {
1396 if ( ( colon = PL_strchr( certname, ':' ) ) ) {
1397 token_name = PL_strndup( certname, colon-certname );
1401 slot = PK11_FindSlotByName( token_name );
1403 slot = PK11_GetInternalKeySlot();
1407 PRErrorCode errcode = PR_GetError();
1408 Debug( LDAP_DEBUG_ANY,
1409 "TLS: could not find the slot for security token %s - error %d:%s.\n",
1410 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
1411 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1415 rc = tlsm_authenticate_to_slot( ctx, slot );
1418 PL_strfree( token_name );
1420 PK11_FreeSlot( slot );
1427 * Find and verify the certificate.
1428 * Either fd is given, in which case the cert will be taken from it via SSL_PeerCertificate
1429 * or certname is given, and it will be searched for by name
1432 tlsm_find_and_verify_cert_key(tlsm_ctx *ctx, PRFileDesc *fd, const char *certname, int isServer, CERTCertificate **pRetCert, SECKEYPrivateKey **pRetKey)
1434 CERTCertificate *cert = NULL;
1436 void *pin_arg = NULL;
1437 SECKEYPrivateKey *key = NULL;
1439 pin_arg = SSL_RevealPinArg( fd );
1441 cert = PK11_FindCertFromNickname( certname, pin_arg );
1443 PRErrorCode errcode = PR_GetError();
1444 Debug( LDAP_DEBUG_ANY,
1445 "TLS: error: the certificate %s could not be found in the database - error %d:%s\n",
1446 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1450 /* we are verifying the peer cert
1451 we also need to swap the isServer meaning */
1452 cert = SSL_PeerCertificate( fd );
1454 PRErrorCode errcode = PR_GetError();
1455 Debug( LDAP_DEBUG_ANY,
1456 "TLS: error: could not get the certificate from the peer connection - error %d:%s\n",
1457 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), NULL );
1460 isServer = !isServer; /* verify the peer's cert instead */
1463 if ( ctx->tc_slotname ) {
1464 PK11SlotInfo *slot = PK11_FindSlotByName( ctx->tc_slotname );
1465 key = PK11_FindPrivateKeyFromCert( slot, cert, NULL );
1466 PK11_FreeSlot( slot );
1468 key = PK11_FindKeyByAnyCert( cert, pin_arg );
1472 SECCertificateUsage certUsage;
1473 PRBool checkSig = PR_TRUE;
1477 *pRetKey = key; /* caller will deal with this */
1479 SECKEY_DestroyPrivateKey( key );
1482 certUsage = certificateUsageSSLServer;
1484 certUsage = certificateUsageSSLClient;
1486 if ( ctx->tc_verify_cert ) {
1489 checkSig = PR_FALSE;
1491 status = CERT_VerifyCertificateNow( ctx->tc_certdb, cert,
1492 checkSig, certUsage,
1494 if (status != SECSuccess) {
1495 PRErrorCode errcode = PR_GetError();
1496 Debug( LDAP_DEBUG_ANY,
1497 "TLS: error: the certificate %s is not valid - error %d:%s\n",
1498 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1500 rc = 0; /* success */
1503 PRErrorCode errcode = PR_GetError();
1504 Debug( LDAP_DEBUG_ANY,
1505 "TLS: error: could not find the private key for certificate %s - error %d:%s\n",
1506 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1510 *pRetCert = cert; /* caller will deal with this */
1512 CERT_DestroyCertificate( cert );
1519 tlsm_get_client_auth_data( void *arg, PRFileDesc *fd,
1520 CERTDistNames *caNames, CERTCertificate **pRetCert,
1521 SECKEYPrivateKey **pRetKey )
1523 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1526 /* don't need caNames - this function will call CERT_VerifyCertificateNow
1527 which will verify the cert against the known CAs */
1528 rc = tlsm_find_and_verify_cert_key( ctx, fd, ctx->tc_certname, 0, pRetCert, pRetKey );
1530 Debug( LDAP_DEBUG_ANY,
1531 "TLS: error: unable to perform client certificate authentication for "
1532 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1540 * ctx must have a tc_model that is valid
1541 * certname is in the form [<tokenname>:]<certnickname>
1542 * where <tokenname> is the name of the PKCS11 token
1543 * and <certnickname> is the nickname of the cert/key in
1547 tlsm_clientauth_init( tlsm_ctx *ctx )
1549 SECStatus status = SECFailure;
1552 rc = tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, 0, NULL, NULL );
1554 Debug( LDAP_DEBUG_ANY,
1555 "TLS: error: unable to set up client certificate authentication for "
1556 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1560 status = SSL_GetClientAuthDataHook( ctx->tc_model,
1561 tlsm_get_client_auth_data,
1564 return ( status == SECSuccess ? 0 : -1 );
1568 * Tear down the TLS subsystem. Should only be called once.
1571 tlsm_destroy( void )
1576 tlsm_ctx_new ( struct ldapoptions *lo )
1580 ctx = LDAP_MALLOC( sizeof (*ctx) );
1583 #ifdef LDAP_R_COMPILE
1584 ldap_pvt_thread_mutex_init( &ctx->tc_refmutex );
1586 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 */
1587 ctx->tc_certdb = NULL;
1588 ctx->tc_certname = NULL;
1589 ctx->tc_pin_file = NULL;
1590 ctx->tc_model = NULL;
1591 memset(&ctx->tc_callonce, 0, sizeof(ctx->tc_callonce));
1592 ctx->tc_require_cert = lo->ldo_tls_require_cert;
1593 ctx->tc_verify_cert = PR_FALSE;
1594 ctx->tc_using_pem = PR_FALSE;
1595 ctx->tc_slotname = NULL;
1596 #ifdef HAVE_NSS_INITCONTEXT
1597 ctx->tc_initctx = NULL;
1598 #endif /* HAVE_NSS_INITCONTEXT */
1599 ctx->tc_pem_objs = NULL;
1600 ctx->tc_n_pem_objs = 0;
1602 return (tls_ctx *)ctx;
1606 tlsm_ctx_ref( tls_ctx *ctx )
1608 tlsm_ctx *c = (tlsm_ctx *)ctx;
1609 #ifdef LDAP_R_COMPILE
1610 ldap_pvt_thread_mutex_lock( &c->tc_refmutex );
1613 #ifdef LDAP_R_COMPILE
1614 ldap_pvt_thread_mutex_unlock( &c->tc_refmutex );
1619 tlsm_ctx_free ( tls_ctx *ctx )
1621 tlsm_ctx *c = (tlsm_ctx *)ctx;
1626 #ifdef LDAP_R_COMPILE
1627 ldap_pvt_thread_mutex_lock( &c->tc_refmutex );
1629 refcount = --c->tc_refcnt;
1630 #ifdef LDAP_R_COMPILE
1631 ldap_pvt_thread_mutex_unlock( &c->tc_refmutex );
1636 PR_Close( c->tc_model );
1637 c->tc_certdb = NULL; /* if not the default, may have to clean up */
1638 PL_strfree( c->tc_certname );
1639 c->tc_certname = NULL;
1640 PL_strfree( c->tc_pin_file );
1641 c->tc_pin_file = NULL;
1642 PL_strfree( c->tc_slotname );
1643 tlsm_free_pem_objs( c );
1644 #ifdef HAVE_NSS_INITCONTEXT
1646 NSS_ShutdownContext( c->tc_initctx );
1647 c->tc_initctx = NULL;
1648 #endif /* HAVE_NSS_INITCONTEXT */
1649 #ifdef LDAP_R_COMPILE
1650 ldap_pvt_thread_mutex_destroy( &c->tc_refmutex );
1656 * initialize a new TLS context
1659 tlsm_ctx_init( struct ldapoptions *lo, struct ldaptls *lt, int is_server )
1661 tlsm_ctx *ctx = (tlsm_ctx *)lo->ldo_tls_ctx;
1662 ctx->tc_is_server = is_server;
1668 tlsm_deferred_ctx_init( void *arg )
1670 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1671 PRBool sslv2 = PR_FALSE;
1672 PRBool sslv3 = PR_TRUE;
1673 PRBool tlsv1 = PR_TRUE;
1674 PRBool request_cert = PR_FALSE;
1675 PRInt32 require_cert = PR_FALSE;
1679 if ( tlsm_deferred_init( ctx ) ) {
1680 Debug( LDAP_DEBUG_ANY,
1681 "TLS: could perform TLS system initialization.\n",
1686 ctx->tc_certdb = CERT_GetDefaultCertDB(); /* If there is ever a per-context db, change this */
1688 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
1690 ctx->tc_model = SSL_ImportFD( NULL, fd );
1693 if ( !ctx->tc_model ) {
1694 PRErrorCode err = PR_GetError();
1695 Debug( LDAP_DEBUG_ANY,
1696 "TLS: could perform TLS socket I/O layer initialization - error %d:%s.\n",
1697 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1705 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_SECURITY, PR_TRUE ) ) {
1706 Debug( LDAP_DEBUG_ANY,
1707 "TLS: could not set secure mode on.\n",
1712 lt = ctx->tc_config;
1714 /* default is sslv3 and tlsv1 */
1715 if ( lt->lt_protocol_min ) {
1716 if ( lt->lt_protocol_min > LDAP_OPT_X_TLS_PROTOCOL_SSL3 ) {
1718 } else if ( lt->lt_protocol_min <= LDAP_OPT_X_TLS_PROTOCOL_SSL2 ) {
1720 Debug( LDAP_DEBUG_ANY,
1721 "TLS: warning: minimum TLS protocol level set to "
1722 "include SSLv2 - SSLv2 is insecure - do not use\n", 0, 0, 0 );
1725 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL2, sslv2 ) ) {
1726 Debug( LDAP_DEBUG_ANY,
1727 "TLS: could not set SSLv2 mode on.\n",
1731 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL3, sslv3 ) ) {
1732 Debug( LDAP_DEBUG_ANY,
1733 "TLS: could not set SSLv3 mode on.\n",
1737 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_TLS, tlsv1 ) ) {
1738 Debug( LDAP_DEBUG_ANY,
1739 "TLS: could not set TLSv1 mode on.\n",
1744 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_CLIENT, !ctx->tc_is_server ) ) {
1745 Debug( LDAP_DEBUG_ANY,
1746 "TLS: could not set handshake as client.\n",
1750 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_SERVER, ctx->tc_is_server ) ) {
1751 Debug( LDAP_DEBUG_ANY,
1752 "TLS: could not set handshake as server.\n",
1757 if ( lt->lt_ciphersuite &&
1758 tlsm_parse_ciphers( ctx, lt->lt_ciphersuite )) {
1759 Debug( LDAP_DEBUG_ANY,
1760 "TLS: could not set cipher list %s.\n",
1761 lt->lt_ciphersuite, 0, 0 );
1765 if ( ctx->tc_require_cert ) {
1766 request_cert = PR_TRUE;
1767 require_cert = SSL_REQUIRE_NO_ERROR;
1768 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
1769 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
1770 require_cert = SSL_REQUIRE_ALWAYS;
1772 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW )
1773 ctx->tc_verify_cert = PR_TRUE;
1775 ctx->tc_verify_cert = PR_FALSE;
1778 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUEST_CERTIFICATE, request_cert ) ) {
1779 Debug( LDAP_DEBUG_ANY,
1780 "TLS: could not set request certificate mode.\n",
1785 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUIRE_CERTIFICATE, require_cert ) ) {
1786 Debug( LDAP_DEBUG_ANY,
1787 "TLS: could not set require certificate mode.\n",
1792 /* set up our cert and key, if any */
1793 if ( lt->lt_certfile ) {
1794 /* if using the PEM module, load the PEM file specified by lt_certfile */
1795 /* otherwise, assume this is the name of a cert already in the db */
1796 if ( ctx->tc_using_pem ) {
1797 /* this sets ctx->tc_certname to the correct value */
1798 int rc = tlsm_add_cert_from_file( ctx, lt->lt_certfile, PR_FALSE /* not a ca */ );
1803 PL_strfree( ctx->tc_certname );
1804 ctx->tc_certname = PL_strdup( lt->lt_certfile );
1808 if ( lt->lt_keyfile ) {
1809 /* if using the PEM module, load the PEM file specified by lt_keyfile */
1810 /* otherwise, assume this is the pininfo for the key */
1811 if ( ctx->tc_using_pem ) {
1812 /* this sets ctx->tc_certname to the correct value */
1813 int rc = tlsm_add_key_from_file( ctx, lt->lt_keyfile );
1818 PL_strfree( ctx->tc_pin_file );
1819 ctx->tc_pin_file = PL_strdup( lt->lt_keyfile );
1823 /* Set up callbacks for use by clients */
1824 if ( !ctx->tc_is_server ) {
1825 if ( SSL_OptionSet( ctx->tc_model, SSL_NO_CACHE, PR_TRUE ) != SECSuccess ) {
1826 PRErrorCode err = PR_GetError();
1827 Debug( LDAP_DEBUG_ANY,
1828 "TLS: error: could not set nocache option for moznss - error %d:%s\n",
1829 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1833 if ( SSL_BadCertHook( ctx->tc_model, tlsm_bad_cert_handler, ctx ) != SECSuccess ) {
1834 PRErrorCode err = PR_GetError();
1835 Debug( LDAP_DEBUG_ANY,
1836 "TLS: error: could not set bad cert handler for moznss - error %d:%s\n",
1837 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1842 since a cert has been specified, assume the client wants to do cert auth
1844 if ( ctx->tc_certname ) {
1845 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
1846 Debug( LDAP_DEBUG_ANY,
1847 "TLS: error: unable to authenticate to the security device for certificate %s\n",
1848 ctx->tc_certname, 0, 0 );
1851 if ( tlsm_clientauth_init( ctx ) ) {
1852 Debug( LDAP_DEBUG_ANY,
1853 "TLS: error: unable to set up client certificate authentication using %s\n",
1854 ctx->tc_certname, 0, 0 );
1858 } else { /* set up secure server */
1860 CERTCertificate *serverCert;
1861 SECKEYPrivateKey *serverKey;
1864 /* must have a certificate for the server to use */
1865 if ( !ctx->tc_certname ) {
1866 Debug( LDAP_DEBUG_ANY,
1867 "TLS: error: no server certificate: must specify a certificate for the server to use\n",
1872 /* authenticate to the server's token - this will do nothing
1873 if the key/cert db is not password protected */
1874 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
1875 Debug( LDAP_DEBUG_ANY,
1876 "TLS: error: unable to authenticate to the security device for certificate %s\n",
1877 ctx->tc_certname, 0, 0 );
1881 /* get the server's key and cert */
1882 if ( tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, ctx->tc_is_server,
1883 &serverCert, &serverKey ) ) {
1884 Debug( LDAP_DEBUG_ANY,
1885 "TLS: error: unable to find and verify server's cert and key for certificate %s\n",
1886 ctx->tc_certname, 0, 0 );
1890 certKEA = NSS_FindCertKEAType( serverCert );
1891 /* configure the socket to be a secure server socket */
1892 status = SSL_ConfigSecureServer( ctx->tc_model, serverCert, serverKey, certKEA );
1893 /* SSL_ConfigSecureServer copies these */
1894 CERT_DestroyCertificate( serverCert );
1895 SECKEY_DestroyPrivateKey( serverKey );
1897 if ( SECSuccess != status ) {
1898 PRErrorCode err = PR_GetError();
1899 Debug( LDAP_DEBUG_ANY,
1900 "TLS: error: unable to configure secure server using certificate %s - error %d:%s\n",
1901 ctx->tc_certname, err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) );
1906 /* Callback for authenticating certificate */
1907 if ( SSL_AuthCertificateHook( ctx->tc_model, tlsm_auth_cert_handler,
1908 ctx->tc_certdb ) != SECSuccess ) {
1909 PRErrorCode err = PR_GetError();
1910 Debug( LDAP_DEBUG_ANY,
1911 "TLS: error: could not set auth cert handler for moznss - error %d:%s\n",
1912 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1920 tlsm_session *session;
1921 Sockbuf_IO_Desc *sbiod;
1922 /* there seems to be no portable way to determine if the
1923 sockbuf sd has been set to nonblocking mode - the
1924 call to ber_pvt_socket_set_nonblock() takes place
1925 before the tls socket is set up, so we cannot
1926 intercept that call either.
1927 On systems where fcntl is available, we can just
1928 F_GETFL and test for O_NONBLOCK. On other systems,
1929 we will just see if the IO op returns EAGAIN or EWOULDBLOCK,
1930 and just set this flag */
1935 tlsm_is_io_ready( PRFileDesc *fd, PRInt16 in_flags, PRInt16 *out_flags )
1938 PRFileDesc *pollfd = NULL;
1940 PRPollDesc polldesc;
1943 myfd = PR_GetIdentitiesLayer( fd, tlsm_layer_id );
1949 p = (struct tls_data *)myfd->secret;
1951 if ( p == NULL || p->sbiod == NULL ) {
1955 /* wrap the sockbuf fd with a NSPR FD created especially
1956 for use with polling, and only with polling */
1957 pollfd = PR_CreateSocketPollFd( p->sbiod->sbiod_sb->sb_fd );
1958 polldesc.fd = pollfd;
1959 polldesc.in_flags = in_flags;
1960 polldesc.out_flags = 0;
1962 /* do the poll - no waiting, no blocking */
1963 rc = PR_Poll( &polldesc, 1, PR_INTERVAL_NO_WAIT );
1965 /* unwrap the socket */
1966 PR_DestroySocketPollFd( pollfd );
1968 /* rc will be either 1 if IO is ready, 0 if IO is not
1969 ready, or -1 if there was some error (and the caller
1970 should use PR_GetError() to figure out what */
1972 *out_flags = polldesc.out_flags;
1977 static tls_session *
1978 tlsm_session_new ( tls_ctx * ctx, int is_server )
1980 tlsm_ctx *c = (tlsm_ctx *)ctx;
1981 tlsm_session *session;
1985 c->tc_is_server = is_server;
1986 status = PR_CallOnceWithArg( &c->tc_callonce, tlsm_deferred_ctx_init, c );
1987 if ( PR_SUCCESS != status ) {
1988 PRErrorCode err = PR_GetError();
1989 Debug( LDAP_DEBUG_ANY,
1990 "TLS: error: could not initialize moznss security context - error %d:%s\n",
1991 err, PR_ErrorToString(err, PR_LANGUAGE_I_DEFAULT), NULL );
1995 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2000 session = SSL_ImportFD( c->tc_model, fd );
2007 /* 0 means use the defaults here */
2008 SSL_ConfigServerSessionIDCache( 0, 0, 0, NULL );
2011 return (tls_session *)session;
2015 tlsm_session_accept( tls_session *session )
2017 tlsm_session *s = (tlsm_session *)session;
2020 int waitcounter = 0;
2022 rc = SSL_ResetHandshake( s, PR_TRUE /* server */ );
2024 err = PR_GetError();
2025 Debug( LDAP_DEBUG_TRACE,
2026 "TLS: error: accept - reset handshake failure %d - error %d:%s\n",
2028 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2037 rc = SSL_ForceHandshake( s );
2038 if (rc == SECSuccess) {
2042 err = PR_GetError();
2043 Debug( LDAP_DEBUG_TRACE,
2044 "TLS: error: accept - force handshake failure %d - error %d waitcounter %d\n",
2045 errno, err, waitcounter );
2046 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2048 in_flags = PR_POLL_READ | PR_POLL_EXCEPT;
2051 filesReady = tlsm_is_io_ready( s, in_flags, &out_flags );
2052 if ( filesReady < 0 ) {
2053 err = PR_GetError();
2054 Debug( LDAP_DEBUG_ANY,
2055 "TLS: error: accept - error waiting for socket to be ready: %d - error %d:%s\n",
2057 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2059 break; /* hard error */
2060 } else if ( out_flags & PR_POLL_NVAL ) {
2061 PR_SetError(PR_BAD_DESCRIPTOR_ERROR, 0);
2062 Debug( LDAP_DEBUG_ANY,
2063 "TLS: error: accept failure - invalid socket\n",
2067 } else if ( out_flags & PR_POLL_EXCEPT ) {
2068 err = PR_GetError();
2069 Debug( LDAP_DEBUG_ANY,
2070 "TLS: error: accept - error waiting for socket to be ready: %d - error %d:%s\n",
2072 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2074 break; /* hard error */
2076 } else { /* hard error */
2077 err = PR_GetError();
2078 Debug( LDAP_DEBUG_ANY,
2079 "TLS: error: accept - force handshake failure: %d - error %d:%s\n",
2081 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2083 break; /* hard error */
2085 } while (rc == SECFailure);
2087 Debug( LDAP_DEBUG_TRACE,
2088 "TLS: accept completed after %d waits\n", waitcounter, NULL, NULL );
2094 tlsm_session_connect( LDAP *ld, tls_session *session )
2096 tlsm_session *s = (tlsm_session *)session;
2100 rc = SSL_ResetHandshake( s, PR_FALSE /* server */ );
2102 err = PR_GetError();
2103 Debug( LDAP_DEBUG_TRACE,
2104 "TLS: error: connect - reset handshake failure %d - error %d:%s\n",
2106 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2109 rc = SSL_ForceHandshake( s );
2111 err = PR_GetError();
2112 Debug( LDAP_DEBUG_TRACE,
2113 "TLS: error: connect - force handshake failure %d - error %d:%s\n",
2115 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2122 tlsm_session_upflags( Sockbuf *sb, tls_session *session, int rc )
2124 /* Should never happen */
2127 if ( rc != PR_PENDING_INTERRUPT_ERROR && rc != PR_WOULD_BLOCK_ERROR )
2133 tlsm_session_errmsg( tls_session *sess, int rc, char *buf, size_t len )
2138 i = PR_GetErrorTextLength();
2140 char *msg = LDAP_MALLOC( i+1 );
2141 PR_GetErrorText( msg );
2142 memcpy( buf, msg, len );
2145 PR_GetErrorText( buf );
2148 return i ? buf : NULL;
2152 tlsm_session_my_dn( tls_session *session, struct berval *der_dn )
2154 tlsm_session *s = (tlsm_session *)session;
2155 CERTCertificate *cert;
2157 cert = SSL_LocalCertificate( s );
2158 if (!cert) return LDAP_INVALID_CREDENTIALS;
2160 der_dn->bv_val = cert->derSubject.data;
2161 der_dn->bv_len = cert->derSubject.len;
2162 CERT_DestroyCertificate( cert );
2167 tlsm_session_peer_dn( tls_session *session, struct berval *der_dn )
2169 tlsm_session *s = (tlsm_session *)session;
2170 CERTCertificate *cert;
2172 cert = SSL_PeerCertificate( s );
2173 if (!cert) return LDAP_INVALID_CREDENTIALS;
2175 der_dn->bv_val = cert->derSubject.data;
2176 der_dn->bv_len = cert->derSubject.len;
2177 CERT_DestroyCertificate( cert );
2181 /* what kind of hostname were we given? */
2187 tlsm_session_chkhost( LDAP *ld, tls_session *session, const char *name_in )
2189 tlsm_session *s = (tlsm_session *)session;
2190 CERTCertificate *cert;
2191 const char *name, *domain = NULL, *ptr;
2192 int i, ret, ntype = IS_DNS, nlen, dlen;
2193 #ifdef LDAP_PF_INET6
2194 struct in6_addr addr;
2196 struct in_addr addr;
2201 if( ldap_int_hostname &&
2202 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
2204 name = ldap_int_hostname;
2208 nlen = strlen( name );
2210 cert = SSL_PeerCertificate( s );
2212 Debug( LDAP_DEBUG_ANY,
2213 "TLS: unable to get peer certificate.\n",
2215 /* if this was a fatal condition, things would have
2216 * aborted long before now.
2218 return LDAP_SUCCESS;
2221 #ifdef LDAP_PF_INET6
2222 if (name[0] == '[' && strchr(name, ']')) {
2223 char *n2 = ldap_strdup(name+1);
2224 *strchr(n2, ']') = 0;
2225 if (inet_pton(AF_INET6, n2, &addr))
2230 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
2231 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
2233 if (ntype == IS_DNS ) {
2234 domain = strchr( name, '.' );
2236 dlen = nlen - ( domain - name );
2239 ret = LDAP_LOCAL_ERROR;
2241 rv = CERT_FindCertExtension( cert, SEC_OID_X509_SUBJECT_ALT_NAME,
2243 if ( rv == SECSuccess && altname.data ) {
2245 CERTGeneralName *names, *cur;
2247 arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
2249 ret = LDAP_NO_MEMORY;
2253 names = cur = CERT_DecodeAltNameExtension(arena, &altname);
2262 if ( !cur->name.other.len ) continue;
2264 host = cur->name.other.data;
2265 hlen = cur->name.other.len;
2267 if ( cur->type == certDNSName ) {
2268 if ( ntype != IS_DNS ) continue;
2270 /* is this an exact match? */
2271 if ( nlen == hlen && !strncasecmp( name, host, nlen )) {
2276 /* is this a wildcard match? */
2277 if ( domain && host[0] == '*' && host[1] == '.' &&
2278 dlen == hlen-1 && !strncasecmp( domain, host+1, dlen )) {
2282 } else if ( cur->type == certIPAddress ) {
2283 if ( ntype == IS_DNS ) continue;
2285 #ifdef LDAP_PF_INET6
2286 if (ntype == IS_IP6 && hlen != sizeof(struct in6_addr)) {
2290 if (ntype == IS_IP4 && hlen != sizeof(struct in_addr)) {
2293 if (!memcmp(host, &addr, hlen)) {
2298 } while (( cur = CERT_GetNextGeneralName( cur )) != names );
2300 PORT_FreeArena( arena, PR_FALSE );
2301 SECITEM_FreeItem( &altname, PR_FALSE );
2303 /* no altnames matched, try the CN */
2304 if ( ret != LDAP_SUCCESS ) {
2305 /* find the last CN */
2306 CERTRDN *rdn, **rdns;
2307 CERTAVA *lastava = NULL;
2311 rdns = cert->subject.rdns;
2312 while ( rdns && ( rdn = *rdns++ )) {
2313 CERTAVA *ava, **avas = rdn->avas;
2314 while ( avas && ( ava = *avas++ )) {
2315 if ( CERT_GetAVATag( ava ) == SEC_OID_AVA_COMMON_NAME )
2320 SECItem *av = CERT_DecodeAVAValue( &lastava->value );
2322 if ( av->len == nlen && !strncasecmp( name, av->data, nlen )) {
2324 } else if ( av->data[0] == '*' && av->data[1] == '.' &&
2325 domain && dlen == av->len - 1 && !strncasecmp( name,
2326 av->data+1, dlen )) {
2330 if ( len >= sizeof(buf) )
2331 len = sizeof(buf)-1;
2332 memcpy( buf, av->data, len );
2335 SECITEM_FreeItem( av, PR_TRUE );
2338 if ( ret != LDAP_SUCCESS ) {
2339 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
2340 "common name in certificate (%s).\n",
2342 ret = LDAP_CONNECT_ERROR;
2343 if ( ld->ld_error ) {
2344 LDAP_FREE( ld->ld_error );
2346 ld->ld_error = LDAP_STRDUP(
2347 _("TLS: hostname does not match CN in peer certificate"));
2352 CERT_DestroyCertificate( cert );
2357 tlsm_session_strength( tls_session *session )
2359 tlsm_session *s = (tlsm_session *)session;
2362 rc = SSL_SecurityStatus( s, NULL, NULL, NULL, &keySize,
2364 return rc ? 0 : keySize;
2368 * TLS support for LBER Sockbufs
2371 static PRStatus PR_CALLBACK
2372 tlsm_PR_Close(PRFileDesc *fd)
2374 int rc = PR_SUCCESS;
2376 /* we don't need to actually close anything here, just
2377 pop our io layer off the stack */
2378 fd->secret = NULL; /* must have been freed before calling PR_Close */
2380 fd = PR_PopIOLayer( fd, tlsm_layer_id );
2381 /* if we are not the last layer, pass the close along */
2386 rc = fd->methods->close( fd );
2389 /* we are the last layer - just call our dtor */
2396 static PRStatus PR_CALLBACK
2397 tlsm_PR_Shutdown(PRFileDesc *fd, PRShutdownHow how)
2399 int rc = PR_SUCCESS;
2402 rc = PR_Shutdown( fd->lower, how );
2408 static int PR_CALLBACK
2409 tlsm_PR_Recv(PRFileDesc *fd, void *buf, PRInt32 len, PRIntn flags,
2410 PRIntervalTime timeout)
2415 if ( buf == NULL || len <= 0 ) return 0;
2417 p = (struct tls_data *)fd->secret;
2419 if ( p == NULL || p->sbiod == NULL ) {
2423 rc = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
2425 tlsm_map_error( errno );
2426 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2427 p->nonblock = PR_TRUE; /* fd is using non-blocking io */
2428 } else if ( errno ) { /* real error */
2429 Debug( LDAP_DEBUG_TRACE,
2430 "TLS: error: tlsm_PR_Recv returned %d - error %d:%s\n",
2431 rc, errno, STRERROR(errno) );
2438 static int PR_CALLBACK
2439 tlsm_PR_Send(PRFileDesc *fd, const void *buf, PRInt32 len, PRIntn flags,
2440 PRIntervalTime timeout)
2445 if ( buf == NULL || len <= 0 ) return 0;
2447 p = (struct tls_data *)fd->secret;
2449 if ( p == NULL || p->sbiod == NULL ) {
2453 rc = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
2455 tlsm_map_error( errno );
2456 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2457 p->nonblock = PR_TRUE;
2458 } else if ( errno ) { /* real error */
2459 Debug( LDAP_DEBUG_TRACE,
2460 "TLS: error: tlsm_PR_Send returned %d - error %d:%s\n",
2461 rc, errno, STRERROR(errno) );
2468 static int PR_CALLBACK
2469 tlsm_PR_Read(PRFileDesc *fd, void *buf, PRInt32 len)
2471 return tlsm_PR_Recv( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2474 static int PR_CALLBACK
2475 tlsm_PR_Write(PRFileDesc *fd, const void *buf, PRInt32 len)
2477 return tlsm_PR_Send( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2480 static PRStatus PR_CALLBACK
2481 tlsm_PR_GetPeerName(PRFileDesc *fd, PRNetAddr *addr)
2487 p = (struct tls_data *)fd->secret;
2489 if ( p == NULL || p->sbiod == NULL ) {
2492 len = sizeof(PRNetAddr);
2493 return getpeername( p->sbiod->sbiod_sb->sb_fd, (struct sockaddr *)addr, &len );
2496 static PRStatus PR_CALLBACK
2497 tlsm_PR_GetSocketOption(PRFileDesc *fd, PRSocketOptionData *data)
2500 p = (struct tls_data *)fd->secret;
2506 /* only the nonblocking option is supported at this time
2507 MozNSS SSL code needs it */
2508 if ( data->option != PR_SockOpt_Nonblocking ) {
2509 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2513 int flags = fcntl( p->sbiod->sbiod_sb->sb_fd, F_GETFL );
2514 data->value.non_blocking = (flags & O_NONBLOCK) ? PR_TRUE : PR_FALSE;
2516 data->value.non_blocking = p->nonblock;
2521 static PRStatus PR_CALLBACK
2524 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2528 static PRFileDesc * PR_CALLBACK
2531 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2535 static PRInt16 PR_CALLBACK
2538 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2542 static PRInt32 PR_CALLBACK
2545 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2549 static PRInt64 PR_CALLBACK
2554 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2559 static const PRIOMethods tlsm_PR_methods = {
2561 tlsm_PR_Close, /* close */
2562 tlsm_PR_Read, /* read */
2563 tlsm_PR_Write, /* write */
2564 tlsm_PR_i32_unimp, /* available */
2565 tlsm_PR_i64_unimp, /* available64 */
2566 tlsm_PR_prs_unimp, /* fsync */
2567 tlsm_PR_i32_unimp, /* seek */
2568 tlsm_PR_i64_unimp, /* seek64 */
2569 tlsm_PR_prs_unimp, /* fileInfo */
2570 tlsm_PR_prs_unimp, /* fileInfo64 */
2571 tlsm_PR_i32_unimp, /* writev */
2572 tlsm_PR_prs_unimp, /* connect */
2573 tlsm_PR_pfd_unimp, /* accept */
2574 tlsm_PR_prs_unimp, /* bind */
2575 tlsm_PR_prs_unimp, /* listen */
2576 (PRShutdownFN)tlsm_PR_Shutdown, /* shutdown */
2577 tlsm_PR_Recv, /* recv */
2578 tlsm_PR_Send, /* send */
2579 tlsm_PR_i32_unimp, /* recvfrom */
2580 tlsm_PR_i32_unimp, /* sendto */
2581 (PRPollFN)tlsm_PR_i16_unimp, /* poll */
2582 tlsm_PR_i32_unimp, /* acceptread */
2583 tlsm_PR_i32_unimp, /* transmitfile */
2584 tlsm_PR_prs_unimp, /* getsockname */
2585 tlsm_PR_GetPeerName, /* getpeername */
2586 tlsm_PR_i32_unimp, /* getsockopt OBSOLETE */
2587 tlsm_PR_i32_unimp, /* setsockopt OBSOLETE */
2588 tlsm_PR_GetSocketOption, /* getsocketoption */
2589 tlsm_PR_i32_unimp, /* setsocketoption */
2590 tlsm_PR_i32_unimp, /* Send a (partial) file with header/trailer*/
2591 (PRConnectcontinueFN)tlsm_PR_prs_unimp, /* connectcontinue */
2592 tlsm_PR_i32_unimp, /* reserved for future use */
2593 tlsm_PR_i32_unimp, /* reserved for future use */
2594 tlsm_PR_i32_unimp, /* reserved for future use */
2595 tlsm_PR_i32_unimp /* reserved for future use */
2599 * Initialize TLS subsystem. Should be called only once.
2600 * See tlsm_deferred_init for the bulk of the init process
2607 tlsm_layer_id = PR_GetUniqueIdentity( "OpenLDAP" );
2613 tlsm_sb_setup( Sockbuf_IO_Desc *sbiod, void *arg )
2616 tlsm_session *session = arg;
2619 assert( sbiod != NULL );
2621 p = LBER_MALLOC( sizeof( *p ) );
2626 fd = PR_GetIdentitiesLayer( session, tlsm_layer_id );
2632 fd->secret = (PRFilePrivate *)p;
2633 p->session = session;
2635 sbiod->sbiod_pvt = p;
2640 tlsm_sb_remove( Sockbuf_IO_Desc *sbiod )
2644 assert( sbiod != NULL );
2645 assert( sbiod->sbiod_pvt != NULL );
2647 p = (struct tls_data *)sbiod->sbiod_pvt;
2648 PR_Close( p->session );
2649 LBER_FREE( sbiod->sbiod_pvt );
2650 sbiod->sbiod_pvt = NULL;
2655 tlsm_sb_close( Sockbuf_IO_Desc *sbiod )
2659 assert( sbiod != NULL );
2660 assert( sbiod->sbiod_pvt != NULL );
2662 p = (struct tls_data *)sbiod->sbiod_pvt;
2663 PR_Shutdown( p->session, PR_SHUTDOWN_BOTH );
2668 tlsm_sb_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
2672 assert( sbiod != NULL );
2673 assert( sbiod->sbiod_pvt != NULL );
2675 p = (struct tls_data *)sbiod->sbiod_pvt;
2677 if ( opt == LBER_SB_OPT_GET_SSL ) {
2678 *((tlsm_session **)arg) = p->session;
2681 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
2682 if ( tlsm_is_io_ready( p->session, PR_POLL_READ, NULL ) > 0 ) {
2688 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
2692 tlsm_sb_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
2698 assert( sbiod != NULL );
2699 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
2701 p = (struct tls_data *)sbiod->sbiod_pvt;
2703 ret = PR_Recv( p->session, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2705 err = PR_GetError();
2706 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
2707 sbiod->sbiod_sb->sb_trans_needs_read = 1;
2708 sock_errset(EWOULDBLOCK);
2711 sbiod->sbiod_sb->sb_trans_needs_read = 0;
2717 tlsm_sb_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
2723 assert( sbiod != NULL );
2724 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
2726 p = (struct tls_data *)sbiod->sbiod_pvt;
2728 ret = PR_Send( p->session, (char *)buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2730 err = PR_GetError();
2731 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
2732 sbiod->sbiod_sb->sb_trans_needs_write = 1;
2733 sock_errset(EWOULDBLOCK);
2737 sbiod->sbiod_sb->sb_trans_needs_write = 0;
2742 static Sockbuf_IO tlsm_sbio =
2744 tlsm_sb_setup, /* sbi_setup */
2745 tlsm_sb_remove, /* sbi_remove */
2746 tlsm_sb_ctrl, /* sbi_ctrl */
2747 tlsm_sb_read, /* sbi_read */
2748 tlsm_sb_write, /* sbi_write */
2749 tlsm_sb_close /* sbi_close */
2752 tls_impl ldap_int_tls_impl = {
2764 tlsm_session_connect,
2765 tlsm_session_accept,
2766 tlsm_session_upflags,
2767 tlsm_session_errmsg,
2769 tlsm_session_peer_dn,
2770 tlsm_session_chkhost,
2771 tlsm_session_strength,
2775 #ifdef LDAP_R_COMPILE
2784 #endif /* HAVE_MOZNSS */