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 );
717 #ifdef READ_PASSWORD_FROM_FILE
719 tlsm_get_pin_from_file(const char *token_name, tlsm_ctx *ctx)
722 char *contents = NULL;
725 char *candidate = NULL;
726 PRFileInfo file_info;
727 PRFileDesc *pwd_fileptr = PR_Open( ctx->tc_pin_file, PR_RDONLY, 00400 );
729 /* open the password file */
730 if ( !pwd_fileptr ) {
731 PRErrorCode errcode = PR_GetError();
732 Debug( LDAP_DEBUG_ANY,
733 "TLS: could not open security pin file %s - error %d:%s.\n",
734 ctx->tc_pin_file, errcode,
735 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
739 /* get the file size */
740 if ( PR_SUCCESS != PR_GetFileInfo( ctx->tc_pin_file, &file_info ) ) {
741 PRErrorCode errcode = PR_GetError();
742 Debug( LDAP_DEBUG_ANY,
743 "TLS: could not get file info from pin file %s - error %d:%s.\n",
744 ctx->tc_pin_file, errcode,
745 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
749 /* create a buffer to hold the file contents */
750 if ( !( contents = PR_MALLOC( file_info.size + 1 ) ) ) {
751 PRErrorCode errcode = PR_GetError();
752 Debug( LDAP_DEBUG_ANY,
753 "TLS: could not alloc a buffer for contents of pin file %s - error %d:%s.\n",
754 ctx->tc_pin_file, errcode,
755 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
759 /* read file into the buffer */
760 if( PR_Read( pwd_fileptr, contents, file_info.size ) <= 0 ) {
761 PRErrorCode errcode = PR_GetError();
762 Debug( LDAP_DEBUG_ANY,
763 "TLS: could not read the file contents from pin file %s - error %d:%s.\n",
764 ctx->tc_pin_file, errcode,
765 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
769 /* format is [tokenname:]password EOL [tokenname:]password EOL ... */
770 /* if you want to use a password containing a colon character, use
771 the special tokenname "default" */
772 for ( line = PL_strtok_r( contents, "\r\n", &lasts ); line;
773 line = PL_strtok_r( NULL, "\r\n", &lasts ) ) {
777 continue; /* skip blank lines */
779 colon = PL_strchr( line, ':' );
781 if ( *(colon + 1) && token_name &&
782 !PL_strncmp( token_name, line, colon-line ) ) {
783 candidate = colon + 1; /* found a definite match */
785 } else if ( !PL_strncmp( DEFAULT_TOKEN_NAME, line, colon-line ) ) {
786 candidate = colon + 1; /* found possible match */
788 } else { /* no token name */
794 PR_Close( pwd_fileptr );
797 pwdstr = PL_strdup( candidate );
799 PL_strfree( contents );
803 #endif /* READ_PASSWORD_FROM_FILE */
805 #ifdef READ_PASSWORD_FROM_STDIN
807 * Turn the echoing off on a tty.
812 if ( isatty( fd ) ) {
814 tcgetattr( fd, &tio );
815 tio.c_lflag &= ~ECHO;
816 tcsetattr( fd, TCSAFLUSH, &tio );
821 * Turn the echoing on on a tty.
826 if ( isatty( fd ) ) {
828 tcgetattr( fd, &tio );
830 tcsetattr( fd, TCSAFLUSH, &tio );
831 tcsetattr( fd, TCSAFLUSH, &tio );
834 #endif /* READ_PASSWORD_FROM_STDIN */
837 * This does the actual work of reading the pin/password/pass phrase
840 tlsm_get_pin(PK11SlotInfo *slot, PRBool retry, tlsm_ctx *ctx)
842 char *token_name = NULL;
845 token_name = PK11_GetTokenName( slot );
846 #ifdef READ_PASSWORD_FROM_FILE
847 /* Try to get the passwords from the password file if it exists.
848 * THIS IS UNSAFE and is provided for convenience only. Without this
849 * capability the server would have to be started in foreground mode
850 * if using an encrypted key.
852 if ( ctx->tc_pin_file ) {
853 pwdstr = tlsm_get_pin_from_file( token_name, ctx );
855 #endif /* RETRIEVE_PASSWORD_FROM_FILE */
856 #ifdef READ_PASSWORD_FROM_STDIN
858 int infd = PR_FileDesc2NativeHandle( PR_STDIN );
859 int isTTY = isatty( infd );
860 unsigned char phrase[200];
861 /* Prompt for password */
864 "Please enter pin, password, or pass phrase for security token '%s': ",
865 token_name ? token_name : DEFAULT_TOKEN_NAME );
868 fgets( (char*)phrase, sizeof(phrase), stdin );
870 fprintf( stdout, "\n" );
873 /* stomp on newline */
874 phrase[strlen((char*)phrase)-1] = 0;
876 pwdstr = PL_strdup( (char*)phrase );
879 #endif /* READ_PASSWORD_FROM_STDIN */
884 * PKCS11 devices (including the internal softokn cert/key database)
885 * may be protected by a pin or password or even pass phrase
886 * MozNSS needs a way for the user to provide that
889 tlsm_pin_prompt(PK11SlotInfo *slot, PRBool retry, void *arg)
891 tlsm_ctx *ctx = (tlsm_ctx *)arg;
893 return tlsm_get_pin( slot, retry, ctx );
897 tlsm_auth_cert_handler(void *arg, PRFileDesc *fd,
898 PRBool checksig, PRBool isServer)
900 SECStatus ret = SSL_AuthCertificate(arg, fd, checksig, isServer);
902 tlsm_dump_security_status( fd );
903 Debug( LDAP_DEBUG_TRACE,
904 "TLS certificate verification: %s\n",
905 ret == SECSuccess ? "ok" : "bad", 0, 0 );
907 if ( ret != SECSuccess ) {
908 PRErrorCode errcode = PORT_GetError();
909 Debug( LDAP_DEBUG_ANY,
910 "TLS certificate verification: Error, %d: %s\n",
911 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 ) ;
918 tlsm_authenticate_to_slot( tlsm_ctx *ctx, PK11SlotInfo *slot )
922 if ( SECSuccess != PK11_Authenticate( slot, PR_FALSE, ctx ) ) {
923 char *token_name = PK11_GetTokenName( slot );
924 PRErrorCode errcode = PR_GetError();
925 Debug( LDAP_DEBUG_ANY,
926 "TLS: could not authenticate to the security token %s - error %d:%s.\n",
927 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
928 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
930 rc = 0; /* success */
937 tlsm_nss_shutdown_cb( void *appData, void *nssData )
939 SECStatus rc = SECSuccess;
941 SSL_ShutdownServerSessionIDCache();
942 SSL_ClearSessionCache();
945 SECMOD_UnloadUserModule( pem_module );
946 SECMOD_DestroyModule( pem_module );
953 tlsm_init_pem_module( void )
956 char *fullname = NULL;
957 char *configstring = NULL;
963 /* not loaded - load it */
964 /* get the system dependent library name */
965 fullname = PR_GetLibraryName( NULL, PEM_LIBRARY );
966 /* Load our PKCS#11 module */
967 configstring = PR_smprintf( "library=%s name=" PEM_MODULE " parameters=\"\"", fullname );
968 PL_strfree( fullname );
970 pem_module = SECMOD_LoadUserModule( configstring, NULL, PR_FALSE );
971 PR_smprintf_free( configstring );
973 if ( !pem_module || !pem_module->loaded ) {
975 SECMOD_DestroyModule( pem_module );
985 tlsm_add_pem_obj( tlsm_ctx *ctx, PK11GenericObject *obj )
987 int idx = ctx->tc_n_pem_objs;
988 ctx->tc_n_pem_objs++;
989 ctx->tc_pem_objs = (PK11GenericObject **)
990 PORT_Realloc( ctx->tc_pem_objs, ctx->tc_n_pem_objs * sizeof( PK11GenericObject * ) );
991 ctx->tc_pem_objs[idx] = obj;
995 tlsm_free_pem_objs( tlsm_ctx *ctx )
997 /* free in reverse order of allocation */
998 while ( ctx->tc_n_pem_objs-- ) {
999 PK11_DestroyGenericObject( ctx->tc_pem_objs[ctx->tc_n_pem_objs] );
1000 ctx->tc_pem_objs[ctx->tc_n_pem_objs] = NULL;
1002 PORT_Free(ctx->tc_pem_objs);
1003 ctx->tc_pem_objs = NULL;
1004 ctx->tc_n_pem_objs = 0;
1008 tlsm_add_cert_from_file( tlsm_ctx *ctx, const char *filename, PRBool isca )
1011 PK11SlotInfo *slot = NULL;
1012 PK11GenericObject *rv;
1013 CK_ATTRIBUTE *attrs;
1014 CK_ATTRIBUTE theTemplate[20];
1015 CK_BBOOL cktrue = CK_TRUE;
1016 CK_BBOOL ckfalse = CK_FALSE;
1017 CK_OBJECT_CLASS objClass = CKO_CERTIFICATE;
1018 char tmpslotname[64];
1019 char *slotname = NULL;
1020 const char *ptr = NULL;
1021 char sep = PR_GetDirectorySeparator();
1025 memset( &fi, 0, sizeof(fi) );
1026 status = PR_GetFileInfo( filename, &fi );
1027 if ( PR_SUCCESS != status) {
1028 PRErrorCode errcode = PR_GetError();
1029 Debug( LDAP_DEBUG_ANY,
1030 "TLS: could not read certificate file %s - error %d:%s.\n",
1032 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1036 if ( fi.type != PR_FILE_FILE ) {
1037 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1038 Debug( LDAP_DEBUG_ANY,
1039 "TLS: error: the certificate file %s is not a file.\n",
1044 attrs = theTemplate;
1047 slotID = 0; /* CA and trust objects use slot 0 */
1048 PR_snprintf( tmpslotname, sizeof(tmpslotname), TLSM_PEM_TOKEN_FMT, slotID );
1049 slotname = tmpslotname;
1051 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1052 slotID = ++tlsm_slot_count;
1053 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1055 slotname = ctx->tc_slotname;
1057 if ( ( ptr = PL_strrchr( filename, sep ) ) ) {
1058 PL_strfree( ctx->tc_certname );
1060 ctx->tc_certname = PR_smprintf( "%s:%s", slotname, ptr );
1064 slot = PK11_FindSlotByName( slotname );
1067 PRErrorCode errcode = PR_GetError();
1068 Debug( LDAP_DEBUG_ANY,
1069 "TLS: could not find the slot for certificate %s - error %d:%s.\n",
1070 ctx->tc_certname, errcode,
1071 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1075 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1076 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1077 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1079 PK11_SETATTRS( attrs, CKA_TRUST, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1081 PK11_SETATTRS( attrs, CKA_TRUST, &ckfalse, sizeof(CK_BBOOL) ); attrs++;
1083 /* This loads the certificate in our PEM module into the appropriate
1086 rv = PK11_CreateGenericObject( slot, theTemplate, 4, PR_FALSE /* isPerm */ );
1088 PK11_FreeSlot( slot );
1091 PRErrorCode errcode = PR_GetError();
1092 Debug( LDAP_DEBUG_ANY,
1093 "TLS: could not add the certificate %s - error %d:%s.\n",
1094 ctx->tc_certname, errcode,
1095 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1099 tlsm_add_pem_obj( ctx, rv );
1105 tlsm_add_key_from_file( tlsm_ctx *ctx, const char *filename )
1108 PK11SlotInfo * slot = NULL;
1109 PK11GenericObject *rv;
1110 CK_ATTRIBUTE *attrs;
1111 CK_ATTRIBUTE theTemplate[20];
1112 CK_BBOOL cktrue = CK_TRUE;
1113 CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1118 memset( &fi, 0, sizeof(fi) );
1119 status = PR_GetFileInfo( filename, &fi );
1120 if ( PR_SUCCESS != status) {
1121 PRErrorCode errcode = PR_GetError();
1122 Debug( LDAP_DEBUG_ANY,
1123 "TLS: could not read key file %s - error %d:%s.\n",
1125 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1129 if ( fi.type != PR_FILE_FILE ) {
1130 PR_SetError(PR_IS_DIRECTORY_ERROR, 0);
1131 Debug( LDAP_DEBUG_ANY,
1132 "TLS: error: the key file %s is not a file.\n",
1137 attrs = theTemplate;
1139 if ( ctx->tc_slotname == NULL ) { /* need new slot */
1140 slotID = ++tlsm_slot_count;
1141 ctx->tc_slotname = PR_smprintf( TLSM_PEM_TOKEN_FMT, slotID );
1143 slot = PK11_FindSlotByName( ctx->tc_slotname );
1146 PRErrorCode errcode = PR_GetError();
1147 Debug( LDAP_DEBUG_ANY,
1148 "TLS: could not find the slot %s for the private key - error %d:%s.\n",
1149 ctx->tc_slotname, errcode,
1150 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1154 PK11_SETATTRS( attrs, CKA_CLASS, &objClass, sizeof(objClass) ); attrs++;
1155 PK11_SETATTRS( attrs, CKA_TOKEN, &cktrue, sizeof(CK_BBOOL) ); attrs++;
1156 PK11_SETATTRS( attrs, CKA_LABEL, (unsigned char *)filename, strlen(filename)+1 ); attrs++;
1157 rv = PK11_CreateGenericObject( slot, theTemplate, 3, PR_FALSE /* isPerm */ );
1160 PRErrorCode errcode = PR_GetError();
1161 Debug( LDAP_DEBUG_ANY,
1162 "TLS: could not add the certificate %s - error %d:%s.\n",
1163 ctx->tc_certname, errcode,
1164 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1167 /* When adding an encrypted key the PKCS#11 will be set as removed */
1168 /* This will force the token to be seen as re-inserted */
1169 SECMOD_WaitForAnyTokenEvent( pem_module, 0, 0 );
1170 PK11_IsPresent( slot );
1174 PK11_FreeSlot( slot );
1177 tlsm_add_pem_obj( ctx, rv );
1183 tlsm_init_ca_certs( tlsm_ctx *ctx, const char *cacertfile, const char *cacertdir )
1185 PRBool isca = PR_TRUE;
1186 PRStatus status = PR_FAILURE;
1187 PRErrorCode errcode = PR_SUCCESS;
1190 int rc = tlsm_add_cert_from_file( ctx, cacertfile, isca );
1192 errcode = PR_GetError();
1193 Debug( LDAP_DEBUG_ANY,
1194 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1195 cacertfile, errcode,
1196 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1198 Debug( LDAP_DEBUG_TRACE,
1199 "TLS: loaded CA certificate file %s.\n",
1201 status = PR_SUCCESS; /* have at least one good CA - we can proceed */
1209 PRStatus fistatus = PR_FAILURE;
1211 memset( &fi, 0, sizeof(fi) );
1212 fistatus = PR_GetFileInfo( cacertdir, &fi );
1213 if ( PR_SUCCESS != fistatus) {
1214 errcode = PR_GetError();
1215 Debug( LDAP_DEBUG_ANY,
1216 "TLS: could not get info about the CA certificate directory %s - error %d:%s.\n",
1218 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1222 if ( fi.type != PR_FILE_DIRECTORY ) {
1223 Debug( LDAP_DEBUG_ANY,
1224 "TLS: error: the CA certificate directory %s is not a directory.\n",
1229 dir = PR_OpenDir( cacertdir );
1230 if ( NULL == dir ) {
1231 errcode = PR_GetError();
1232 Debug( LDAP_DEBUG_ANY,
1233 "TLS: could not open the CA certificate directory %s - error %d:%s.\n",
1235 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1240 entry = PR_ReadDir( dir, PR_SKIP_BOTH | PR_SKIP_HIDDEN );
1241 if ( ( NULL != entry ) && ( NULL != entry->name ) ) {
1242 char *fullpath = NULL;
1245 ptr = PL_strrstr( entry->name, PEM_CA_HASH_FILE_SUFFIX );
1246 if ( ( ptr == NULL ) || ( *(ptr + PEM_CA_HASH_FILE_SUFFIX_LEN) != '\0' ) ) {
1247 Debug( LDAP_DEBUG_TRACE,
1248 "TLS: file %s does not end in [%s] - does not appear to be a CA certificate "
1249 "directory file with a properly hashed file name - skipping.\n",
1250 entry->name, PEM_CA_HASH_FILE_SUFFIX, 0 );
1253 fullpath = PR_smprintf( "%s/%s", cacertdir, entry->name );
1254 if ( !tlsm_add_cert_from_file( ctx, fullpath, isca ) ) {
1255 Debug( LDAP_DEBUG_TRACE,
1256 "TLS: loaded CA certificate file %s from CA certificate directory %s.\n",
1257 fullpath, cacertdir, 0 );
1258 status = PR_SUCCESS; /* found at least 1 valid CA file in the dir */
1260 errcode = PR_GetError();
1261 Debug( LDAP_DEBUG_TRACE,
1262 "TLS: %s is not a valid CA certificate file - error %d:%s.\n",
1264 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1266 PR_smprintf_free( fullpath );
1268 } while ( NULL != entry );
1272 if ( status != PR_SUCCESS ) {
1273 const char *fmtstr = NULL;
1274 if ( cacertfile && cacertdir ) {
1275 fmtstr = "TLS: did not find any valid CA certificates in %s or %s\n";
1277 fmtstr = "TLS: did not find any valid CA certificates in %s%s\n";
1279 Debug( LDAP_DEBUG_ANY, fmtstr, cacertdir ? cacertdir : "",
1280 cacertfile ? cacertfile : "", 0 );
1288 * NSS supports having multiple cert/key databases in the same
1289 * directory, each one having a unique string prefix e.g.
1290 * slapd-01-cert8.db - the prefix here is "slapd-01-"
1291 * this function examines the given certdir - if it looks like
1292 * /path/to/directory/prefix it will return the
1293 * /path/to/directory part in realcertdir, and the prefix in prefix
1296 tlsm_get_certdb_prefix( const char *certdir, char **realcertdir, char **prefix )
1298 char sep = PR_GetDirectorySeparator();
1300 struct PRFileInfo prfi;
1303 *realcertdir = (char *)certdir; /* default is the one passed in */
1305 /* if certdir is not given, just return */
1310 prc = PR_GetFileInfo( certdir, &prfi );
1311 /* if certdir exists (file or directory) then it cannot specify a prefix */
1312 if ( prc == PR_SUCCESS ) {
1316 /* if certdir was given, and there is a '/' in certdir, see if there
1317 is anything after the last '/' - if so, assume it is the prefix */
1318 if ( ( ( ptr = strrchr( certdir, sep ) ) ) && *(ptr+1) ) {
1319 *realcertdir = PL_strndup( certdir, ptr-certdir );
1320 *prefix = PL_strdup( ptr+1 );
1327 * This is the part of the init we defer until we get the
1328 * actual security configuration information. This is
1329 * only called once, protected by a PRCallOnce
1330 * NOTE: This must be done before the first call to SSL_ImportFD,
1331 * especially the setting of the policy
1332 * NOTE: This must be called after fork()
1335 tlsm_deferred_init( void *arg )
1337 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1338 struct ldaptls *lt = ctx->tc_config;
1339 const char *securitydirs[3];
1342 PRErrorCode errcode = 1;
1343 #ifdef HAVE_NSS_INITCONTEXT
1344 NSSInitParameters initParams;
1345 NSSInitContext *initctx = NULL;
1350 #ifdef HAVE_NSS_INITCONTEXT
1351 memset( &initParams, 0, sizeof( initParams ) );
1352 initParams.length = sizeof( initParams );
1353 #endif /* HAVE_NSS_INITCONTEXT */
1355 #ifndef HAVE_NSS_INITCONTEXT
1356 if ( !NSS_IsInitialized() ) {
1357 #endif /* HAVE_NSS_INITCONTEXT */
1359 MOZNSS_DIR will override everything else - you can
1360 always set MOZNSS_DIR to force the use of this
1362 If using MOZNSS, specify the location of the moznss db dir
1363 in the cacertdir directive of the OpenLDAP configuration.
1364 DEFAULT_MOZNSS_DIR will only be used if the code cannot
1365 find a security dir to use based on the current
1369 securitydirs[nn++] = PR_GetEnv( "MOZNSS_DIR" );
1370 securitydirs[nn++] = lt->lt_cacertdir;
1371 securitydirs[nn++] = PR_GetEnv( "DEFAULT_MOZNSS_DIR" );
1372 for ( ii = 0; !done && ( ii < nn ); ++ii ) {
1373 char *realcertdir = NULL;
1374 const char *defprefix = "";
1375 char *prefix = (char *)defprefix;
1376 const char *securitydir = securitydirs[ii];
1377 if ( NULL == securitydir ) {
1381 tlsm_get_certdb_prefix( securitydir, &realcertdir, &prefix );
1382 #ifdef HAVE_NSS_INITCONTEXT
1383 #ifdef INITCONTEXT_HACK
1384 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1385 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1387 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1388 &initParams, NSS_INIT_READONLY );
1389 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1392 initctx = NSS_InitContext( realcertdir, prefix, prefix, SECMOD_DB,
1393 &initParams, NSS_INIT_READONLY );
1394 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1397 rc = NSS_Initialize( realcertdir, prefix, prefix, SECMOD_DB, NSS_INIT_READONLY );
1400 if ( rc != SECSuccess ) {
1401 errcode = PORT_GetError();
1402 Debug( LDAP_DEBUG_TRACE,
1403 "TLS: could not initialize moznss using security dir %s prefix %s - error %d.\n",
1404 realcertdir, prefix, errcode );
1407 Debug( LDAP_DEBUG_TRACE, "TLS: using moznss security dir %s prefix %s.\n",
1408 realcertdir, prefix, 0 );
1412 if ( realcertdir != securitydir ) {
1413 PL_strfree( realcertdir );
1415 if ( prefix != defprefix ) {
1416 PL_strfree( prefix );
1420 if ( errcode ) { /* no moznss db found, or not using moznss db */
1421 #ifdef HAVE_NSS_INITCONTEXT
1422 int flags = NSS_INIT_READONLY|NSS_INIT_NOCERTDB|NSS_INIT_NOMODDB;
1423 #ifdef INITCONTEXT_HACK
1424 if ( !NSS_IsInitialized() && ctx->tc_is_server ) {
1425 rc = NSS_NoDB_Init( NULL );
1427 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1428 &initParams, flags );
1429 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1432 initctx = NSS_InitContext( "", "", "", SECMOD_DB,
1433 &initParams, flags );
1434 rc = (initctx == NULL) ? SECFailure : SECSuccess;
1437 rc = NSS_NoDB_Init( NULL );
1439 if ( rc != SECSuccess ) {
1440 errcode = PORT_GetError();
1441 Debug( LDAP_DEBUG_ANY,
1442 "TLS: could not initialize moznss - error %d:%s.\n",
1443 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1447 #ifdef HAVE_NSS_INITCONTEXT
1448 ctx->tc_initctx = initctx;
1451 /* initialize the PEM module */
1452 if ( tlsm_init_pem_module() ) {
1453 errcode = PORT_GetError();
1454 Debug( LDAP_DEBUG_ANY,
1455 "TLS: could not initialize moznss PEM module - error %d:%s.\n",
1456 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), 0 );
1460 if ( tlsm_init_ca_certs( ctx, lt->lt_cacertfile, lt->lt_cacertdir ) ) {
1464 ctx->tc_using_pem = PR_TRUE;
1467 #ifdef HAVE_NSS_INITCONTEXT
1468 if ( !ctx->tc_initctx ) {
1469 ctx->tc_initctx = initctx;
1473 NSS_SetDomesticPolicy();
1475 PK11_SetPasswordFunc( tlsm_pin_prompt );
1477 /* register cleanup function */
1478 /* delete the old one, if any */
1479 NSS_UnregisterShutdown( tlsm_nss_shutdown_cb, NULL );
1480 NSS_RegisterShutdown( tlsm_nss_shutdown_cb, NULL );
1482 #ifndef HAVE_NSS_INITCONTEXT
1484 #endif /* HAVE_NSS_INITCONTEXT */
1490 tlsm_authenticate( tlsm_ctx *ctx, const char *certname, const char *pininfo )
1492 const char *colon = NULL;
1493 char *token_name = NULL;
1494 PK11SlotInfo *slot = NULL;
1497 if ( !certname || !*certname ) {
1501 if ( ( colon = PL_strchr( certname, ':' ) ) ) {
1502 token_name = PL_strndup( certname, colon-certname );
1506 slot = PK11_FindSlotByName( token_name );
1508 slot = PK11_GetInternalKeySlot();
1512 PRErrorCode errcode = PR_GetError();
1513 Debug( LDAP_DEBUG_ANY,
1514 "TLS: could not find the slot for security token %s - error %d:%s.\n",
1515 token_name ? token_name : DEFAULT_TOKEN_NAME, errcode,
1516 PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1520 rc = tlsm_authenticate_to_slot( ctx, slot );
1523 PL_strfree( token_name );
1525 PK11_FreeSlot( slot );
1532 * Find and verify the certificate.
1533 * Either fd is given, in which case the cert will be taken from it via SSL_PeerCertificate
1534 * or certname is given, and it will be searched for by name
1537 tlsm_find_and_verify_cert_key(tlsm_ctx *ctx, PRFileDesc *fd, const char *certname, int isServer, CERTCertificate **pRetCert, SECKEYPrivateKey **pRetKey)
1539 CERTCertificate *cert = NULL;
1541 void *pin_arg = NULL;
1542 SECKEYPrivateKey *key = NULL;
1544 pin_arg = SSL_RevealPinArg( fd );
1546 cert = PK11_FindCertFromNickname( certname, pin_arg );
1548 PRErrorCode errcode = PR_GetError();
1549 Debug( LDAP_DEBUG_ANY,
1550 "TLS: error: the certificate %s could not be found in the database - error %d:%s\n",
1551 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1555 /* we are verifying the peer cert
1556 we also need to swap the isServer meaning */
1557 cert = SSL_PeerCertificate( fd );
1559 PRErrorCode errcode = PR_GetError();
1560 Debug( LDAP_DEBUG_ANY,
1561 "TLS: error: could not get the certificate from the peer connection - error %d:%s\n",
1562 errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ), NULL );
1565 isServer = !isServer; /* verify the peer's cert instead */
1568 if ( ctx->tc_slotname ) {
1569 PK11SlotInfo *slot = PK11_FindSlotByName( ctx->tc_slotname );
1570 key = PK11_FindPrivateKeyFromCert( slot, cert, NULL );
1571 PK11_FreeSlot( slot );
1573 key = PK11_FindKeyByAnyCert( cert, pin_arg );
1577 SECCertificateUsage certUsage;
1578 PRBool checkSig = PR_TRUE;
1582 *pRetKey = key; /* caller will deal with this */
1584 SECKEY_DestroyPrivateKey( key );
1587 certUsage = certificateUsageSSLServer;
1589 certUsage = certificateUsageSSLClient;
1591 if ( ctx->tc_verify_cert ) {
1594 checkSig = PR_FALSE;
1596 status = CERT_VerifyCertificateNow( ctx->tc_certdb, cert,
1597 checkSig, certUsage,
1599 if ( status != SECSuccess ) {
1600 /* NSS doesn't like self-signed CA certs that are also used for
1601 TLS/SSL server certs (such as generated by openssl req -x509)
1602 CERT_VerifyCertificateNow returns SEC_ERROR_UNTRUSTED_ISSUER in that case
1603 so, see if the cert and issuer are the same cert
1605 PRErrorCode errcode = PR_GetError();
1607 if ( errcode == SEC_ERROR_UNTRUSTED_ISSUER ) {
1608 CERTCertificate *issuer = CERT_FindCertIssuer( cert, PR_Now(), certUsageSSLServer );
1609 if ( NULL == issuer ) {
1610 /* no issuer - fail */
1611 Debug( LDAP_DEBUG_ANY,
1612 "TLS: error: the server certificate %s has no issuer - "
1613 "please check this certificate for validity\n",
1615 } else if ( CERT_CompareCerts( cert, issuer ) ) {
1616 /* self signed - warn and allow */
1617 status = SECSuccess;
1619 Debug( LDAP_DEBUG_ANY,
1620 "TLS: warning: using self-signed server certificate %s\n",
1623 CERT_DestroyCertificate( issuer );
1626 if ( status != SECSuccess ) {
1627 Debug( LDAP_DEBUG_ANY,
1628 "TLS: error: the certificate %s is not valid - error %d:%s\n",
1629 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1632 rc = 0; /* success */
1635 PRErrorCode errcode = PR_GetError();
1636 Debug( LDAP_DEBUG_ANY,
1637 "TLS: error: could not find the private key for certificate %s - error %d:%s\n",
1638 certname, errcode, PR_ErrorToString( errcode, PR_LANGUAGE_I_DEFAULT ) );
1642 *pRetCert = cert; /* caller will deal with this */
1644 CERT_DestroyCertificate( cert );
1651 tlsm_get_client_auth_data( void *arg, PRFileDesc *fd,
1652 CERTDistNames *caNames, CERTCertificate **pRetCert,
1653 SECKEYPrivateKey **pRetKey )
1655 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1658 /* don't need caNames - this function will call CERT_VerifyCertificateNow
1659 which will verify the cert against the known CAs */
1660 rc = tlsm_find_and_verify_cert_key( ctx, fd, ctx->tc_certname, 0, pRetCert, pRetKey );
1662 Debug( LDAP_DEBUG_ANY,
1663 "TLS: error: unable to perform client certificate authentication for "
1664 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1672 * ctx must have a tc_model that is valid
1673 * certname is in the form [<tokenname>:]<certnickname>
1674 * where <tokenname> is the name of the PKCS11 token
1675 * and <certnickname> is the nickname of the cert/key in
1679 tlsm_clientauth_init( tlsm_ctx *ctx )
1681 SECStatus status = SECFailure;
1684 rc = tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, 0, NULL, NULL );
1686 Debug( LDAP_DEBUG_ANY,
1687 "TLS: error: unable to set up client certificate authentication for "
1688 "certificate named %s\n", ctx->tc_certname, 0, 0 );
1692 status = SSL_GetClientAuthDataHook( ctx->tc_model,
1693 tlsm_get_client_auth_data,
1696 return ( status == SECSuccess ? 0 : -1 );
1700 * Tear down the TLS subsystem. Should only be called once.
1703 tlsm_destroy( void )
1708 tlsm_ctx_new ( struct ldapoptions *lo )
1712 ctx = LDAP_MALLOC( sizeof (*ctx) );
1715 #ifdef LDAP_R_COMPILE
1716 ldap_pvt_thread_mutex_init( &ctx->tc_refmutex );
1718 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 */
1719 ctx->tc_certdb = NULL;
1720 ctx->tc_certname = NULL;
1721 ctx->tc_pin_file = NULL;
1722 ctx->tc_model = NULL;
1723 memset(&ctx->tc_callonce, 0, sizeof(ctx->tc_callonce));
1724 ctx->tc_require_cert = lo->ldo_tls_require_cert;
1725 ctx->tc_verify_cert = PR_FALSE;
1726 ctx->tc_using_pem = PR_FALSE;
1727 ctx->tc_slotname = NULL;
1728 #ifdef HAVE_NSS_INITCONTEXT
1729 ctx->tc_initctx = NULL;
1730 #endif /* HAVE_NSS_INITCONTEXT */
1731 ctx->tc_pem_objs = NULL;
1732 ctx->tc_n_pem_objs = 0;
1734 return (tls_ctx *)ctx;
1738 tlsm_ctx_ref( tls_ctx *ctx )
1740 tlsm_ctx *c = (tlsm_ctx *)ctx;
1741 #ifdef LDAP_R_COMPILE
1742 ldap_pvt_thread_mutex_lock( &c->tc_refmutex );
1745 #ifdef LDAP_R_COMPILE
1746 ldap_pvt_thread_mutex_unlock( &c->tc_refmutex );
1751 tlsm_ctx_free ( tls_ctx *ctx )
1753 tlsm_ctx *c = (tlsm_ctx *)ctx;
1758 #ifdef LDAP_R_COMPILE
1759 ldap_pvt_thread_mutex_lock( &c->tc_refmutex );
1761 refcount = --c->tc_refcnt;
1762 #ifdef LDAP_R_COMPILE
1763 ldap_pvt_thread_mutex_unlock( &c->tc_refmutex );
1768 PR_Close( c->tc_model );
1769 c->tc_certdb = NULL; /* if not the default, may have to clean up */
1770 PL_strfree( c->tc_certname );
1771 c->tc_certname = NULL;
1772 PL_strfree( c->tc_pin_file );
1773 c->tc_pin_file = NULL;
1774 PL_strfree( c->tc_slotname );
1775 tlsm_free_pem_objs( c );
1776 #ifdef HAVE_NSS_INITCONTEXT
1778 NSS_ShutdownContext( c->tc_initctx );
1779 c->tc_initctx = NULL;
1780 #endif /* HAVE_NSS_INITCONTEXT */
1781 #ifdef LDAP_R_COMPILE
1782 ldap_pvt_thread_mutex_destroy( &c->tc_refmutex );
1788 * initialize a new TLS context
1791 tlsm_ctx_init( struct ldapoptions *lo, struct ldaptls *lt, int is_server )
1793 tlsm_ctx *ctx = (tlsm_ctx *)lo->ldo_tls_ctx;
1794 ctx->tc_is_server = is_server;
1800 tlsm_deferred_ctx_init( void *arg )
1802 tlsm_ctx *ctx = (tlsm_ctx *)arg;
1803 PRBool sslv2 = PR_FALSE;
1804 PRBool sslv3 = PR_TRUE;
1805 PRBool tlsv1 = PR_TRUE;
1806 PRBool request_cert = PR_FALSE;
1807 PRInt32 require_cert = PR_FALSE;
1811 if ( tlsm_deferred_init( ctx ) ) {
1812 Debug( LDAP_DEBUG_ANY,
1813 "TLS: could perform TLS system initialization.\n",
1818 ctx->tc_certdb = CERT_GetDefaultCertDB(); /* If there is ever a per-context db, change this */
1820 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
1822 ctx->tc_model = SSL_ImportFD( NULL, fd );
1825 if ( !ctx->tc_model ) {
1826 PRErrorCode err = PR_GetError();
1827 Debug( LDAP_DEBUG_ANY,
1828 "TLS: could perform TLS socket I/O layer initialization - error %d:%s.\n",
1829 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1837 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_SECURITY, PR_TRUE ) ) {
1838 Debug( LDAP_DEBUG_ANY,
1839 "TLS: could not set secure mode on.\n",
1844 lt = ctx->tc_config;
1846 /* default is sslv3 and tlsv1 */
1847 if ( lt->lt_protocol_min ) {
1848 if ( lt->lt_protocol_min > LDAP_OPT_X_TLS_PROTOCOL_SSL3 ) {
1850 } else if ( lt->lt_protocol_min <= LDAP_OPT_X_TLS_PROTOCOL_SSL2 ) {
1852 Debug( LDAP_DEBUG_ANY,
1853 "TLS: warning: minimum TLS protocol level set to "
1854 "include SSLv2 - SSLv2 is insecure - do not use\n", 0, 0, 0 );
1857 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL2, sslv2 ) ) {
1858 Debug( LDAP_DEBUG_ANY,
1859 "TLS: could not set SSLv2 mode on.\n",
1863 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_SSL3, sslv3 ) ) {
1864 Debug( LDAP_DEBUG_ANY,
1865 "TLS: could not set SSLv3 mode on.\n",
1869 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_ENABLE_TLS, tlsv1 ) ) {
1870 Debug( LDAP_DEBUG_ANY,
1871 "TLS: could not set TLSv1 mode on.\n",
1876 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_CLIENT, !ctx->tc_is_server ) ) {
1877 Debug( LDAP_DEBUG_ANY,
1878 "TLS: could not set handshake as client.\n",
1882 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_HANDSHAKE_AS_SERVER, ctx->tc_is_server ) ) {
1883 Debug( LDAP_DEBUG_ANY,
1884 "TLS: could not set handshake as server.\n",
1889 if ( lt->lt_ciphersuite &&
1890 tlsm_parse_ciphers( ctx, lt->lt_ciphersuite )) {
1891 Debug( LDAP_DEBUG_ANY,
1892 "TLS: could not set cipher list %s.\n",
1893 lt->lt_ciphersuite, 0, 0 );
1897 if ( ctx->tc_require_cert ) {
1898 request_cert = PR_TRUE;
1899 require_cert = SSL_REQUIRE_NO_ERROR;
1900 if ( ctx->tc_require_cert == LDAP_OPT_X_TLS_DEMAND ||
1901 ctx->tc_require_cert == LDAP_OPT_X_TLS_HARD ) {
1902 require_cert = SSL_REQUIRE_ALWAYS;
1904 if ( ctx->tc_require_cert != LDAP_OPT_X_TLS_ALLOW )
1905 ctx->tc_verify_cert = PR_TRUE;
1907 ctx->tc_verify_cert = PR_FALSE;
1910 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUEST_CERTIFICATE, request_cert ) ) {
1911 Debug( LDAP_DEBUG_ANY,
1912 "TLS: could not set request certificate mode.\n",
1917 if ( SECSuccess != SSL_OptionSet( ctx->tc_model, SSL_REQUIRE_CERTIFICATE, require_cert ) ) {
1918 Debug( LDAP_DEBUG_ANY,
1919 "TLS: could not set require certificate mode.\n",
1924 /* set up our cert and key, if any */
1925 if ( lt->lt_certfile ) {
1926 /* if using the PEM module, load the PEM file specified by lt_certfile */
1927 /* otherwise, assume this is the name of a cert already in the db */
1928 if ( ctx->tc_using_pem ) {
1929 /* this sets ctx->tc_certname to the correct value */
1930 int rc = tlsm_add_cert_from_file( ctx, lt->lt_certfile, PR_FALSE /* not a ca */ );
1935 PL_strfree( ctx->tc_certname );
1936 ctx->tc_certname = PL_strdup( lt->lt_certfile );
1940 if ( lt->lt_keyfile ) {
1941 /* if using the PEM module, load the PEM file specified by lt_keyfile */
1942 /* otherwise, assume this is the pininfo for the key */
1943 if ( ctx->tc_using_pem ) {
1944 /* this sets ctx->tc_certname to the correct value */
1945 int rc = tlsm_add_key_from_file( ctx, lt->lt_keyfile );
1950 PL_strfree( ctx->tc_pin_file );
1951 ctx->tc_pin_file = PL_strdup( lt->lt_keyfile );
1955 /* Set up callbacks for use by clients */
1956 if ( !ctx->tc_is_server ) {
1957 if ( SSL_OptionSet( ctx->tc_model, SSL_NO_CACHE, PR_TRUE ) != SECSuccess ) {
1958 PRErrorCode err = PR_GetError();
1959 Debug( LDAP_DEBUG_ANY,
1960 "TLS: error: could not set nocache option for moznss - error %d:%s\n",
1961 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1965 if ( SSL_BadCertHook( ctx->tc_model, tlsm_bad_cert_handler, ctx ) != SECSuccess ) {
1966 PRErrorCode err = PR_GetError();
1967 Debug( LDAP_DEBUG_ANY,
1968 "TLS: error: could not set bad cert handler for moznss - error %d:%s\n",
1969 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
1974 since a cert has been specified, assume the client wants to do cert auth
1976 if ( ctx->tc_certname ) {
1977 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
1978 Debug( LDAP_DEBUG_ANY,
1979 "TLS: error: unable to authenticate to the security device for certificate %s\n",
1980 ctx->tc_certname, 0, 0 );
1983 if ( tlsm_clientauth_init( ctx ) ) {
1984 Debug( LDAP_DEBUG_ANY,
1985 "TLS: error: unable to set up client certificate authentication using %s\n",
1986 ctx->tc_certname, 0, 0 );
1990 } else { /* set up secure server */
1992 CERTCertificate *serverCert;
1993 SECKEYPrivateKey *serverKey;
1996 /* must have a certificate for the server to use */
1997 if ( !ctx->tc_certname ) {
1998 Debug( LDAP_DEBUG_ANY,
1999 "TLS: error: no server certificate: must specify a certificate for the server to use\n",
2004 /* authenticate to the server's token - this will do nothing
2005 if the key/cert db is not password protected */
2006 if ( tlsm_authenticate( ctx, ctx->tc_certname, ctx->tc_pin_file ) ) {
2007 Debug( LDAP_DEBUG_ANY,
2008 "TLS: error: unable to authenticate to the security device for certificate %s\n",
2009 ctx->tc_certname, 0, 0 );
2013 /* get the server's key and cert */
2014 if ( tlsm_find_and_verify_cert_key( ctx, ctx->tc_model, ctx->tc_certname, ctx->tc_is_server,
2015 &serverCert, &serverKey ) ) {
2016 Debug( LDAP_DEBUG_ANY,
2017 "TLS: error: unable to find and verify server's cert and key for certificate %s\n",
2018 ctx->tc_certname, 0, 0 );
2022 certKEA = NSS_FindCertKEAType( serverCert );
2023 /* configure the socket to be a secure server socket */
2024 status = SSL_ConfigSecureServer( ctx->tc_model, serverCert, serverKey, certKEA );
2025 /* SSL_ConfigSecureServer copies these */
2026 CERT_DestroyCertificate( serverCert );
2027 SECKEY_DestroyPrivateKey( serverKey );
2029 if ( SECSuccess != status ) {
2030 PRErrorCode err = PR_GetError();
2031 Debug( LDAP_DEBUG_ANY,
2032 "TLS: error: unable to configure secure server using certificate %s - error %d:%s\n",
2033 ctx->tc_certname, err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) );
2038 /* Callback for authenticating certificate */
2039 if ( SSL_AuthCertificateHook( ctx->tc_model, tlsm_auth_cert_handler,
2040 ctx->tc_certdb ) != SECSuccess ) {
2041 PRErrorCode err = PR_GetError();
2042 Debug( LDAP_DEBUG_ANY,
2043 "TLS: error: could not set auth cert handler for moznss - error %d:%s\n",
2044 err, PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ), NULL );
2052 tlsm_session *session;
2053 Sockbuf_IO_Desc *sbiod;
2054 /* there seems to be no portable way to determine if the
2055 sockbuf sd has been set to nonblocking mode - the
2056 call to ber_pvt_socket_set_nonblock() takes place
2057 before the tls socket is set up, so we cannot
2058 intercept that call either.
2059 On systems where fcntl is available, we can just
2060 F_GETFL and test for O_NONBLOCK. On other systems,
2061 we will just see if the IO op returns EAGAIN or EWOULDBLOCK,
2062 and just set this flag */
2067 tlsm_is_io_ready( PRFileDesc *fd, PRInt16 in_flags, PRInt16 *out_flags )
2070 PRFileDesc *pollfd = NULL;
2072 PRPollDesc polldesc;
2075 myfd = PR_GetIdentitiesLayer( fd, tlsm_layer_id );
2081 p = (struct tls_data *)myfd->secret;
2083 if ( p == NULL || p->sbiod == NULL ) {
2087 /* wrap the sockbuf fd with a NSPR FD created especially
2088 for use with polling, and only with polling */
2089 pollfd = PR_CreateSocketPollFd( p->sbiod->sbiod_sb->sb_fd );
2090 polldesc.fd = pollfd;
2091 polldesc.in_flags = in_flags;
2092 polldesc.out_flags = 0;
2094 /* do the poll - no waiting, no blocking */
2095 rc = PR_Poll( &polldesc, 1, PR_INTERVAL_NO_WAIT );
2097 /* unwrap the socket */
2098 PR_DestroySocketPollFd( pollfd );
2100 /* rc will be either 1 if IO is ready, 0 if IO is not
2101 ready, or -1 if there was some error (and the caller
2102 should use PR_GetError() to figure out what */
2104 *out_flags = polldesc.out_flags;
2109 static tls_session *
2110 tlsm_session_new ( tls_ctx * ctx, int is_server )
2112 tlsm_ctx *c = (tlsm_ctx *)ctx;
2113 tlsm_session *session;
2117 c->tc_is_server = is_server;
2118 status = PR_CallOnceWithArg( &c->tc_callonce, tlsm_deferred_ctx_init, c );
2119 if ( PR_SUCCESS != status ) {
2120 PRErrorCode err = PR_GetError();
2121 Debug( LDAP_DEBUG_ANY,
2122 "TLS: error: could not initialize moznss security context - error %d:%s\n",
2123 err, PR_ErrorToString(err, PR_LANGUAGE_I_DEFAULT), NULL );
2127 fd = PR_CreateIOLayerStub( tlsm_layer_id, &tlsm_PR_methods );
2132 session = SSL_ImportFD( c->tc_model, fd );
2139 /* 0 means use the defaults here */
2140 SSL_ConfigServerSessionIDCache( 0, 0, 0, NULL );
2143 return (tls_session *)session;
2147 tlsm_session_accept( tls_session *session )
2149 tlsm_session *s = (tlsm_session *)session;
2152 int waitcounter = 0;
2154 rc = SSL_ResetHandshake( s, PR_TRUE /* server */ );
2156 err = PR_GetError();
2157 Debug( LDAP_DEBUG_TRACE,
2158 "TLS: error: accept - reset handshake failure %d - error %d:%s\n",
2160 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2169 rc = SSL_ForceHandshake( s );
2170 if (rc == SECSuccess) {
2174 err = PR_GetError();
2175 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2177 in_flags = PR_POLL_READ | PR_POLL_EXCEPT;
2180 filesReady = tlsm_is_io_ready( s, in_flags, &out_flags );
2181 if ( filesReady < 0 ) {
2182 err = PR_GetError();
2183 Debug( LDAP_DEBUG_ANY,
2184 "TLS: error: accept - error waiting for socket to be ready: %d - error %d:%s\n",
2186 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2188 break; /* hard error */
2189 } else if ( out_flags & PR_POLL_NVAL ) {
2190 PR_SetError(PR_BAD_DESCRIPTOR_ERROR, 0);
2191 Debug( LDAP_DEBUG_ANY,
2192 "TLS: error: accept failure - invalid socket\n",
2196 } else if ( out_flags & PR_POLL_EXCEPT ) {
2197 err = PR_GetError();
2198 Debug( LDAP_DEBUG_ANY,
2199 "TLS: error: accept - error waiting for socket to be ready: %d - error %d:%s\n",
2201 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2203 break; /* hard error */
2205 } else { /* hard error */
2206 err = PR_GetError();
2207 Debug( LDAP_DEBUG_ANY,
2208 "TLS: error: accept - force handshake failure: %d - error %d:%s\n",
2210 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2212 break; /* hard error */
2214 } while (rc == SECFailure);
2216 Debug( LDAP_DEBUG_TRACE,
2217 "TLS: accept completed after %d waits\n", waitcounter, NULL, NULL );
2223 tlsm_session_connect( LDAP *ld, tls_session *session )
2225 tlsm_session *s = (tlsm_session *)session;
2229 rc = SSL_ResetHandshake( s, PR_FALSE /* server */ );
2231 err = PR_GetError();
2232 Debug( LDAP_DEBUG_TRACE,
2233 "TLS: error: connect - reset handshake failure %d - error %d:%s\n",
2235 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2238 rc = SSL_ForceHandshake( s );
2240 err = PR_GetError();
2241 Debug( LDAP_DEBUG_TRACE,
2242 "TLS: error: connect - force handshake failure %d - error %d:%s\n",
2244 err ? PR_ErrorToString( err, PR_LANGUAGE_I_DEFAULT ) : "unknown" );
2251 tlsm_session_upflags( Sockbuf *sb, tls_session *session, int rc )
2253 /* Should never happen */
2256 if ( rc != PR_PENDING_INTERRUPT_ERROR && rc != PR_WOULD_BLOCK_ERROR )
2262 tlsm_session_errmsg( tls_session *sess, int rc, char *buf, size_t len )
2267 i = PR_GetErrorTextLength();
2269 char *msg = LDAP_MALLOC( i+1 );
2270 PR_GetErrorText( msg );
2271 memcpy( buf, msg, len );
2274 PR_GetErrorText( buf );
2277 return i ? buf : NULL;
2281 tlsm_session_my_dn( tls_session *session, struct berval *der_dn )
2283 tlsm_session *s = (tlsm_session *)session;
2284 CERTCertificate *cert;
2286 cert = SSL_LocalCertificate( s );
2287 if (!cert) return LDAP_INVALID_CREDENTIALS;
2289 der_dn->bv_val = (char *)cert->derSubject.data;
2290 der_dn->bv_len = cert->derSubject.len;
2291 CERT_DestroyCertificate( cert );
2296 tlsm_session_peer_dn( tls_session *session, struct berval *der_dn )
2298 tlsm_session *s = (tlsm_session *)session;
2299 CERTCertificate *cert;
2301 cert = SSL_PeerCertificate( s );
2302 if (!cert) return LDAP_INVALID_CREDENTIALS;
2304 der_dn->bv_val = (char *)cert->derSubject.data;
2305 der_dn->bv_len = cert->derSubject.len;
2306 CERT_DestroyCertificate( cert );
2310 /* what kind of hostname were we given? */
2316 tlsm_session_chkhost( LDAP *ld, tls_session *session, const char *name_in )
2318 tlsm_session *s = (tlsm_session *)session;
2319 CERTCertificate *cert;
2320 const char *name, *domain = NULL, *ptr;
2321 int ret, ntype = IS_DNS, nlen, dlen;
2322 #ifdef LDAP_PF_INET6
2323 struct in6_addr addr;
2325 struct in_addr addr;
2330 if( ldap_int_hostname &&
2331 ( !name_in || !strcasecmp( name_in, "localhost" ) ) )
2333 name = ldap_int_hostname;
2337 nlen = strlen( name );
2339 cert = SSL_PeerCertificate( s );
2341 Debug( LDAP_DEBUG_ANY,
2342 "TLS: unable to get peer certificate.\n",
2344 /* if this was a fatal condition, things would have
2345 * aborted long before now.
2347 return LDAP_SUCCESS;
2350 #ifdef LDAP_PF_INET6
2351 if (name[0] == '[' && strchr(name, ']')) {
2352 char *n2 = ldap_strdup(name+1);
2353 *strchr(n2, ']') = 0;
2354 if (inet_pton(AF_INET6, n2, &addr))
2359 if ((ptr = strrchr(name, '.')) && isdigit((unsigned char)ptr[1])) {
2360 if (inet_aton(name, (struct in_addr *)&addr)) ntype = IS_IP4;
2362 if (ntype == IS_DNS ) {
2363 domain = strchr( name, '.' );
2365 dlen = nlen - ( domain - name );
2368 ret = LDAP_LOCAL_ERROR;
2370 rv = CERT_FindCertExtension( cert, SEC_OID_X509_SUBJECT_ALT_NAME,
2372 if ( rv == SECSuccess && altname.data ) {
2374 CERTGeneralName *names, *cur;
2376 arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
2378 ret = LDAP_NO_MEMORY;
2382 names = cur = CERT_DecodeAltNameExtension(arena, &altname);
2391 if ( !cur->name.other.len ) continue;
2393 host = (char *)cur->name.other.data;
2394 hlen = cur->name.other.len;
2396 if ( cur->type == certDNSName ) {
2397 if ( ntype != IS_DNS ) continue;
2399 /* is this an exact match? */
2400 if ( nlen == hlen && !strncasecmp( name, host, nlen )) {
2405 /* is this a wildcard match? */
2406 if ( domain && host[0] == '*' && host[1] == '.' &&
2407 dlen == hlen-1 && !strncasecmp( domain, host+1, dlen )) {
2411 } else if ( cur->type == certIPAddress ) {
2412 if ( ntype == IS_DNS ) continue;
2414 #ifdef LDAP_PF_INET6
2415 if (ntype == IS_IP6 && hlen != sizeof(struct in6_addr)) {
2419 if (ntype == IS_IP4 && hlen != sizeof(struct in_addr)) {
2422 if (!memcmp(host, &addr, hlen)) {
2427 } while (( cur = CERT_GetNextGeneralName( cur )) != names );
2429 PORT_FreeArena( arena, PR_FALSE );
2430 SECITEM_FreeItem( &altname, PR_FALSE );
2432 /* no altnames matched, try the CN */
2433 if ( ret != LDAP_SUCCESS ) {
2434 /* find the last CN */
2435 CERTRDN *rdn, **rdns;
2436 CERTAVA *lastava = NULL;
2440 rdns = cert->subject.rdns;
2441 while ( rdns && ( rdn = *rdns++ )) {
2442 CERTAVA *ava, **avas = rdn->avas;
2443 while ( avas && ( ava = *avas++ )) {
2444 if ( CERT_GetAVATag( ava ) == SEC_OID_AVA_COMMON_NAME )
2449 SECItem *av = CERT_DecodeAVAValue( &lastava->value );
2451 if ( av->len == nlen && !strncasecmp( name, (char *)av->data, nlen )) {
2453 } else if ( av->data[0] == '*' && av->data[1] == '.' &&
2454 domain && dlen == av->len - 1 && !strncasecmp( name,
2455 (char *)(av->data+1), dlen )) {
2459 if ( len >= sizeof(buf) )
2460 len = sizeof(buf)-1;
2461 memcpy( buf, av->data, len );
2464 SECITEM_FreeItem( av, PR_TRUE );
2467 if ( ret != LDAP_SUCCESS ) {
2468 Debug( LDAP_DEBUG_ANY, "TLS: hostname (%s) does not match "
2469 "common name in certificate (%s).\n",
2471 ret = LDAP_CONNECT_ERROR;
2472 if ( ld->ld_error ) {
2473 LDAP_FREE( ld->ld_error );
2475 ld->ld_error = LDAP_STRDUP(
2476 _("TLS: hostname does not match CN in peer certificate"));
2481 CERT_DestroyCertificate( cert );
2486 tlsm_session_strength( tls_session *session )
2488 tlsm_session *s = (tlsm_session *)session;
2491 rc = SSL_SecurityStatus( s, NULL, NULL, NULL, &keySize,
2493 return rc ? 0 : keySize;
2497 * TLS support for LBER Sockbufs
2500 static PRStatus PR_CALLBACK
2501 tlsm_PR_Close(PRFileDesc *fd)
2503 int rc = PR_SUCCESS;
2505 /* we don't need to actually close anything here, just
2506 pop our io layer off the stack */
2507 fd->secret = NULL; /* must have been freed before calling PR_Close */
2509 fd = PR_PopIOLayer( fd, tlsm_layer_id );
2510 /* if we are not the last layer, pass the close along */
2515 rc = fd->methods->close( fd );
2518 /* we are the last layer - just call our dtor */
2525 static PRStatus PR_CALLBACK
2526 tlsm_PR_Shutdown(PRFileDesc *fd, PRShutdownHow how)
2528 int rc = PR_SUCCESS;
2531 rc = PR_Shutdown( fd->lower, how );
2537 static int PR_CALLBACK
2538 tlsm_PR_Recv(PRFileDesc *fd, void *buf, PRInt32 len, PRIntn flags,
2539 PRIntervalTime timeout)
2544 if ( buf == NULL || len <= 0 ) return 0;
2546 p = (struct tls_data *)fd->secret;
2548 if ( p == NULL || p->sbiod == NULL ) {
2552 rc = LBER_SBIOD_READ_NEXT( p->sbiod, buf, len );
2554 tlsm_map_error( errno );
2555 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2556 p->nonblock = PR_TRUE; /* fd is using non-blocking io */
2557 } else if ( errno ) { /* real error */
2558 Debug( LDAP_DEBUG_TRACE,
2559 "TLS: error: tlsm_PR_Recv returned %d - error %d:%s\n",
2560 rc, errno, STRERROR(errno) );
2567 static int PR_CALLBACK
2568 tlsm_PR_Send(PRFileDesc *fd, const void *buf, PRInt32 len, PRIntn flags,
2569 PRIntervalTime timeout)
2574 if ( buf == NULL || len <= 0 ) return 0;
2576 p = (struct tls_data *)fd->secret;
2578 if ( p == NULL || p->sbiod == NULL ) {
2582 rc = LBER_SBIOD_WRITE_NEXT( p->sbiod, (char *)buf, len );
2584 tlsm_map_error( errno );
2585 if ( errno == EAGAIN || errno == EWOULDBLOCK ) {
2586 p->nonblock = PR_TRUE;
2587 } else if ( errno ) { /* real error */
2588 Debug( LDAP_DEBUG_TRACE,
2589 "TLS: error: tlsm_PR_Send returned %d - error %d:%s\n",
2590 rc, errno, STRERROR(errno) );
2597 static int PR_CALLBACK
2598 tlsm_PR_Read(PRFileDesc *fd, void *buf, PRInt32 len)
2600 return tlsm_PR_Recv( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2603 static int PR_CALLBACK
2604 tlsm_PR_Write(PRFileDesc *fd, const void *buf, PRInt32 len)
2606 return tlsm_PR_Send( fd, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2609 static PRStatus PR_CALLBACK
2610 tlsm_PR_GetPeerName(PRFileDesc *fd, PRNetAddr *addr)
2615 p = (struct tls_data *)fd->secret;
2617 if ( p == NULL || p->sbiod == NULL ) {
2620 len = sizeof(PRNetAddr);
2621 return getpeername( p->sbiod->sbiod_sb->sb_fd, (struct sockaddr *)addr, &len );
2624 static PRStatus PR_CALLBACK
2625 tlsm_PR_GetSocketOption(PRFileDesc *fd, PRSocketOptionData *data)
2628 p = (struct tls_data *)fd->secret;
2634 /* only the nonblocking option is supported at this time
2635 MozNSS SSL code needs it */
2636 if ( data->option != PR_SockOpt_Nonblocking ) {
2637 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2641 int flags = fcntl( p->sbiod->sbiod_sb->sb_fd, F_GETFL );
2642 data->value.non_blocking = (flags & O_NONBLOCK) ? PR_TRUE : PR_FALSE;
2644 data->value.non_blocking = p->nonblock;
2649 static PRStatus PR_CALLBACK
2652 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2656 static PRFileDesc * PR_CALLBACK
2659 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2663 static PRInt16 PR_CALLBACK
2666 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2670 static PRInt32 PR_CALLBACK
2673 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2677 static PRInt64 PR_CALLBACK
2682 PR_SetError(PR_NOT_IMPLEMENTED_ERROR, 0);
2687 static const PRIOMethods tlsm_PR_methods = {
2689 tlsm_PR_Close, /* close */
2690 tlsm_PR_Read, /* read */
2691 tlsm_PR_Write, /* write */
2692 tlsm_PR_i32_unimp, /* available */
2693 tlsm_PR_i64_unimp, /* available64 */
2694 tlsm_PR_prs_unimp, /* fsync */
2695 tlsm_PR_i32_unimp, /* seek */
2696 tlsm_PR_i64_unimp, /* seek64 */
2697 tlsm_PR_prs_unimp, /* fileInfo */
2698 tlsm_PR_prs_unimp, /* fileInfo64 */
2699 tlsm_PR_i32_unimp, /* writev */
2700 tlsm_PR_prs_unimp, /* connect */
2701 tlsm_PR_pfd_unimp, /* accept */
2702 tlsm_PR_prs_unimp, /* bind */
2703 tlsm_PR_prs_unimp, /* listen */
2704 (PRShutdownFN)tlsm_PR_Shutdown, /* shutdown */
2705 tlsm_PR_Recv, /* recv */
2706 tlsm_PR_Send, /* send */
2707 tlsm_PR_i32_unimp, /* recvfrom */
2708 tlsm_PR_i32_unimp, /* sendto */
2709 (PRPollFN)tlsm_PR_i16_unimp, /* poll */
2710 tlsm_PR_i32_unimp, /* acceptread */
2711 tlsm_PR_i32_unimp, /* transmitfile */
2712 tlsm_PR_prs_unimp, /* getsockname */
2713 tlsm_PR_GetPeerName, /* getpeername */
2714 tlsm_PR_i32_unimp, /* getsockopt OBSOLETE */
2715 tlsm_PR_i32_unimp, /* setsockopt OBSOLETE */
2716 tlsm_PR_GetSocketOption, /* getsocketoption */
2717 tlsm_PR_i32_unimp, /* setsocketoption */
2718 tlsm_PR_i32_unimp, /* Send a (partial) file with header/trailer*/
2719 (PRConnectcontinueFN)tlsm_PR_prs_unimp, /* connectcontinue */
2720 tlsm_PR_i32_unimp, /* reserved for future use */
2721 tlsm_PR_i32_unimp, /* reserved for future use */
2722 tlsm_PR_i32_unimp, /* reserved for future use */
2723 tlsm_PR_i32_unimp /* reserved for future use */
2727 * Initialize TLS subsystem. Should be called only once.
2728 * See tlsm_deferred_init for the bulk of the init process
2735 tlsm_layer_id = PR_GetUniqueIdentity( "OpenLDAP" );
2741 tlsm_sb_setup( Sockbuf_IO_Desc *sbiod, void *arg )
2744 tlsm_session *session = arg;
2747 assert( sbiod != NULL );
2749 p = LBER_MALLOC( sizeof( *p ) );
2754 fd = PR_GetIdentitiesLayer( session, tlsm_layer_id );
2760 fd->secret = (PRFilePrivate *)p;
2761 p->session = session;
2763 sbiod->sbiod_pvt = p;
2768 tlsm_sb_remove( Sockbuf_IO_Desc *sbiod )
2772 assert( sbiod != NULL );
2773 assert( sbiod->sbiod_pvt != NULL );
2775 p = (struct tls_data *)sbiod->sbiod_pvt;
2776 PR_Close( p->session );
2777 LBER_FREE( sbiod->sbiod_pvt );
2778 sbiod->sbiod_pvt = NULL;
2783 tlsm_sb_close( Sockbuf_IO_Desc *sbiod )
2787 assert( sbiod != NULL );
2788 assert( sbiod->sbiod_pvt != NULL );
2790 p = (struct tls_data *)sbiod->sbiod_pvt;
2791 PR_Shutdown( p->session, PR_SHUTDOWN_BOTH );
2796 tlsm_sb_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
2800 assert( sbiod != NULL );
2801 assert( sbiod->sbiod_pvt != NULL );
2803 p = (struct tls_data *)sbiod->sbiod_pvt;
2805 if ( opt == LBER_SB_OPT_GET_SSL ) {
2806 *((tlsm_session **)arg) = p->session;
2809 } else if ( opt == LBER_SB_OPT_DATA_READY ) {
2810 if ( tlsm_is_io_ready( p->session, PR_POLL_READ, NULL ) > 0 ) {
2816 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
2820 tlsm_sb_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
2826 assert( sbiod != NULL );
2827 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
2829 p = (struct tls_data *)sbiod->sbiod_pvt;
2831 ret = PR_Recv( p->session, buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2833 err = PR_GetError();
2834 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
2835 sbiod->sbiod_sb->sb_trans_needs_read = 1;
2836 sock_errset(EWOULDBLOCK);
2839 sbiod->sbiod_sb->sb_trans_needs_read = 0;
2845 tlsm_sb_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
2851 assert( sbiod != NULL );
2852 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
2854 p = (struct tls_data *)sbiod->sbiod_pvt;
2856 ret = PR_Send( p->session, (char *)buf, len, 0, PR_INTERVAL_NO_TIMEOUT );
2858 err = PR_GetError();
2859 if ( err == PR_PENDING_INTERRUPT_ERROR || err == PR_WOULD_BLOCK_ERROR ) {
2860 sbiod->sbiod_sb->sb_trans_needs_write = 1;
2861 sock_errset(EWOULDBLOCK);
2865 sbiod->sbiod_sb->sb_trans_needs_write = 0;
2870 static Sockbuf_IO tlsm_sbio =
2872 tlsm_sb_setup, /* sbi_setup */
2873 tlsm_sb_remove, /* sbi_remove */
2874 tlsm_sb_ctrl, /* sbi_ctrl */
2875 tlsm_sb_read, /* sbi_read */
2876 tlsm_sb_write, /* sbi_write */
2877 tlsm_sb_close /* sbi_close */
2880 tls_impl ldap_int_tls_impl = {
2892 tlsm_session_connect,
2893 tlsm_session_accept,
2894 tlsm_session_upflags,
2895 tlsm_session_errmsg,
2897 tlsm_session_peer_dn,
2898 tlsm_session_chkhost,
2899 tlsm_session_strength,
2903 #ifdef LDAP_R_COMPILE
2912 #endif /* HAVE_MOZNSS */