1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
|
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla Communicator client code, released
* March 31, 1998.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998-1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* clientinit.c
*/
#if defined(NET_SSL)
#if defined( _WINDOWS )
#include <windows.h>
#include "proto-ntutil.h"
#endif
#include <nspr.h>
#include <plstr.h>
#include <cert.h>
#include <key.h>
#include <ssl.h>
#include <sslproto.h>
#include <ldap.h>
#include <ldap_ssl.h>
#include <nss.h>
/* XXX:mhein The following is a workaround for the redefinition of */
/* const problem on OSF. Fix to be provided by NSS */
/* This is a pretty benign workaround for us which */
/* should not cause problems in the future even if */
/* we forget to take it out :-) */
#ifdef OSF1V4D
#ifndef __STDC__
# define __STDC__
#endif /* __STDC__ */
#endif /* OSF1V4D */
#ifndef FILE_PATHSEP
#define FILE_PATHSEP '/'
#endif
static PRStatus local_SSLPLCY_Install(void);
static char *ldapssl_strdup ( const char * );
static void ldapssl_free( void ** );
/*
* This little tricky guy keeps us from initializing twice
*/
static int inited = 0;
static char tokDes[34] = "Internal (Software) Database ";
static char ptokDes[34] = "Internal (Software) Token ";
/* IN: */
/* string: /u/mhein/.netscape/mykey3.db */
/* OUT: */
/* dir: /u/mhein/.netscape/ */
/* prefix: my */
/* key: key3.db */
static int
splitpath(char *string, char *dir, char *prefix, char *key) {
char *k;
char *s = NULL;
char *d = string;
char *l;
int len = 0;
/* XXXmcs: This function knows more about the NSS certificate and key database
* filenames than it should. It relies on the fact that the suffix for
* these files is ".db" and that the first letter in the main part of
* the name is either 'c' or 'k'.
*/
if (string == NULL)
return (-1);
/* goto the end of the string, and walk backwards until */
/* you get to the first pathseparator */
len = PL_strlen(string);
l = string + len - 1;
while (l != string && *l != '/' && *l != '\\')
l--;
/* search for the .db */
if ((k = PL_strstr(l, ".db")) != NULL) {
/* now we are sitting on . of .db */
/* move backward to the first 'c' or 'k' */
/* indicating cert or key */
while (k != l && *k != 'c' && *k != 'k')
k--;
/* move backwards to the first path separator */
if (k != d && k > d)
s = k - 1;
while (s != d && *s != '/' && *s != '\\')
s--;
/* if we are sitting on top of a path */
/* separator there is no prefix */
if (s + 1 == k) {
/* we know there is no prefix */
prefix = '\0';
PL_strcpy(key, k);
*k = '\0';
PL_strcpy(dir, d);
} else {
/* grab the prefix */
PL_strcpy(key, k);
*k = '\0';
PL_strcpy(prefix, ++s);
*s = '\0';
PL_strcpy(dir, d);
}
} else {
/* neither *key[0-9].db nor *cert[0-9].db found */
return (-1);
}
return (0);
}
static PRStatus local_SSLPLCY_Install(void)
{
SECStatus s;
#ifdef NS_DOMESTIC
s = NSS_SetDomesticPolicy();
#elif NS_EXPORT
s = NSS_SetExportPolicy();
#else
s = PR_FAILURE;
#endif
return s?PR_FAILURE:PR_SUCCESS;
}
static SECStatus
ldapssl_shutdown_handler(void *appData, void *nssData)
{
SSL_ClearSessionCache();
if ( NSS_UnregisterShutdown(ldapssl_shutdown_handler,
(void *)NULL) != SECSuccess ) {
return SECFailure;
}
inited = 0;
return SECSuccess;
}
/*
* Perform necessary cleanup and attempt to shutdown NSS. All existing
* ld session handles should be ldap_unbind(ld) prior to calling this.
*/
int
LDAP_CALL
ldapssl_shutdown()
{
if ( ldapssl_shutdown_handler( (void *)NULL,
(void *)NULL ) != SECSuccess ) {
return( -1 );
}
if ( NSS_Shutdown() != SECSuccess ) {
inited = 1;
return( -1 );
}
return( LDAP_SUCCESS );
}
/*
* Note: by design, the keydbpath can actually be a certdbpath. Some
* callers rely on this behavior, e.g., the LDAP command line tools.
* This function simply does not care whether the paths end in the
* correct NSS filenames or not; the mission here is just to extract
* the base directory (which is pulled out of certdbpath) and the
* cert and key prefixes (pulled out of certdbpath and keydbpath
* respectively).
*/
static int
ldapssl_basic_init( const char *certdbpath, const char *keydbpath,
const char *secmoddbpath )
{
char *confDir = NULL, *certdbPrefix = NULL, *certdbName = NULL;
char *keyconfDir = NULL, *keydbPrefix = NULL, *keydbName = NULL;
char *certPath = NULL, *keyPath = NULL;
int retcode = 0;
/* PR_Init() must to be called before everything else... */
PR_Init(PR_USER_THREAD, PR_PRIORITY_NORMAL, 0);
PR_SetConcurrency( 4 ); /* work around for NSPR 3.x I/O hangs */
/* Get confDir, certdbPrefix and certdbName from certdbpath */
certPath = ldapssl_strdup( certdbpath );
confDir = ldapssl_strdup( certdbpath );
certdbPrefix = ldapssl_strdup( certdbpath );
certdbName = ldapssl_strdup( certdbpath );
if (certdbPrefix) {
*certdbPrefix = '\0';
}
(void)splitpath(certPath, confDir, certdbPrefix, certdbName);
/* Get keyconfDir, keydbPrefix and keydbName from keydbpath */
keyPath = ldapssl_strdup( keydbpath );
keyconfDir = ldapssl_strdup( keydbpath );
keydbPrefix = ldapssl_strdup( keydbpath );
keydbName = ldapssl_strdup( keydbpath );
if (keydbPrefix) {
*keydbPrefix = '\0';
}
(void)splitpath(keyPath, keyconfDir, keydbPrefix, keydbName);
/* Free the variables we no longer need */
ldapssl_free((void **)&certPath);
ldapssl_free((void **)&certdbName);
ldapssl_free((void **)&keyPath);
ldapssl_free((void **)&keydbName);
ldapssl_free((void **)&keyconfDir);
/*
* Accept a NULL secmoddbpath (NSS_Initialize() does not; it would
* be nice if it did!)
*/
if ( NULL == secmoddbpath ) {
secmoddbpath = "secmod.db";
}
if ( NSS_Initialize(confDir,certdbPrefix,keydbPrefix,
secmoddbpath, NSS_INIT_READONLY) != SECSuccess) {
retcode = -1;
} else {
if ( NSS_RegisterShutdown(ldapssl_shutdown_handler,
(void *)NULL) != SECSuccess ) {
retcode = -1;
}
}
ldapssl_free((void **)&certdbPrefix);
ldapssl_free((void **)&keydbPrefix);
ldapssl_free((void **)&confDir);
return (retcode);
}
/*
* Cover functions for malloc(), calloc(), strdup() and free() that are
* compatible with the NSS libraries (they seem to use the C runtime
* library malloc/free so these functions are quite simple right now).
*/
#if 0 /* we do not use ldapssl_malloc() yet */
static void *
ldapssl_malloc( size_t size )
{
void *p;
p = malloc( size );
return p;
}
#endif /* 0 */
#if 0 /* we do not use ldapssl_calloc() yet */
static void *
ldapssl_calloc( int nelem, size_t elsize )
{
void *p;
p = calloc( nelem, elsize );
return p;
}
#endif /* 0 */
static char *
ldapssl_strdup( const char *s )
{
char *scopy;
if ( NULL == s ) {
scopy = NULL;
} else {
scopy = strdup( s );
}
return scopy;
}
static void
ldapssl_free( void **pp )
{
if ( NULL != pp && NULL != *pp ) {
free( (void *)*pp );
*pp = NULL;
}
}
/*
* Initialize ns/security so it can be used for SSL client authentication.
* It is safe to call this more than once.
*
* If needkeydb == 0, no key database is opened and SSL server authentication
* is supported but not client authentication.
*
* If "certdbpath" is NULL or "", the default cert. db is used (typically
* ~/.netscape/cert8.db).
*
* If "certdbpath" ends with ".db" (case-insensitive compare), then
* it is assumed to be a full path to the cert. db file; otherwise,
* it is assumed to be a directory that contains such a file.
*
* If certdbhandle is non-NULL, it is assumed to be a pointer to a
* SECCertDBHandle structure. It is fine to pass NULL since this
* routine will allocate one for you (CERT_GetDefaultDB() can be
* used to retrieve the cert db handle).
*
* If "keydbpath" is NULL or "", the default key db is used (typically
* ~/.netscape/key3.db).
*
* If "keydbpath" ends with ".db" (case-insensitive compare), then
* it is assumed to be a full path to the key db file; otherwise,
* it is assumed to be a directory that contains such a file.
*
* If certdbhandle is non-NULL< it is assumed to be a pointed to a
* SECKEYKeyDBHandle structure. It is fine to pass NULL since this
* routine will allocate one for you (SECKEY_GetDefaultDB() can be
* used to retrieve the cert db handle).
*/
/*ARGSUSED*/
int
LDAP_CALL
ldapssl_clientauth_init( const char *certdbpath, void *certdbhandle,
const int needkeydb, const char *keydbpath, void *keydbhandle )
{
int rc;
/*
* LDAPDebug(LDAP_DEBUG_TRACE, "ldapssl_clientauth_init\n",0 ,0 ,0);
*/
if ( inited ) {
return( 0 );
}
if ( ldapssl_basic_init(certdbpath, keydbpath, NULL) != 0) {
return (-1);
}
if (SSL_OptionSetDefault(SSL_ENABLE_SSL2, PR_FALSE)
|| SSL_OptionSetDefault(SSL_ENABLE_SSL3, PR_TRUE)
|| SSL_OptionSetDefault(SSL_ENABLE_TLS, PR_TRUE)) {
if (( rc = PR_GetError()) >= 0 ) {
rc = -1;
}
return( rc );
}
#if defined(NS_DOMESTIC)
if (local_SSLPLCY_Install() == PR_FAILURE)
return( -1 );
#elif(NS_EXPORT)
if (local_SSLPLCY_Install() == PR_FAILURE)
return( -1 );
#else
return( -1 );
#endif
inited = 1;
return( 0 );
}
/*
* Initialize ns/security so it can be used for SSL client authentication.
* It is safe to call this more than once.
*
* If needkeydb == 0, no key database is opened and SSL server authentication
* is supported but not client authentication.
*
* If "certdbpath" is NULL or "", the default cert. db is used (typically
* ~/.netscape/cert8.db).
*
* If "certdbpath" ends with ".db" (case-insensitive compare), then
* it is assumed to be a full path to the cert. db file; otherwise,
* it is assumed to be a directory that contains such a file.
*
* If certdbhandle is non-NULL, it is assumed to be a pointer to a
* SECCertDBHandle structure. It is fine to pass NULL since this
* routine will allocate one for you (CERT_GetDefaultDB() can be
* used to retrieve the cert db handle).
*
* If "keydbpath" is NULL or "", the default key db is used (typically
* ~/.netscape/key3.db).
*
* If "keydbpath" ends with ".db" (case-insensitive compare), then
* it is assumed to be a full path to the key db file; otherwise,
* it is assumed to be a directory that contains such a file.
*
* If certdbhandle is non-NULL< it is assumed to be a pointed to a
* SECKEYKeyDBHandle structure. It is fine to pass NULL since this
* routine will allocate one for you (SECKEY_GetDefaultDB() can be
* used to retrieve the cert db handle).
*/
/*ARGSUSED*/
int
LDAP_CALL
ldapssl_advclientauth_init(
const char *certdbpath, void *certdbhandle,
const int needkeydb, const char *keydbpath, void *keydbhandle,
const int needsecmoddb, const char *secmoddbpath,
const int sslstrength )
{
if ( inited ) {
return( 0 );
}
/*
* LDAPDebug(LDAP_DEBUG_TRACE, "ldapssl_advclientauth_init\n",0 ,0 ,0);
*/
if ( ldapssl_basic_init(certdbpath, keydbpath, NULL) != 0) {
return (-1);
}
#if defined(NS_DOMESTIC)
if (local_SSLPLCY_Install() == PR_FAILURE)
return( -1 );
#elif(NS_EXPORT)
if (local_SSLPLCY_Install() == PR_FAILURE)
return( -1 );
#else
return( -1 );
#endif
inited = 1;
return ( ldapssl_set_strength( NULL, sslstrength ));
}
/*
* Initialize ns/security so it can be used for SSL client authentication.
* It is safe to call this more than once.
*/
/*
* XXXceb This is a hack until the new IO functions are done.
* this function lives in ldapsinit.c
*/
void set_using_pkcs_functions( int val );
int
LDAP_CALL
ldapssl_pkcs_init( const struct ldapssl_pkcs_fns *pfns )
{
char *certdbpath, *keydbpath, *secmoddbpath;
int rc;
if ( inited ) {
return( 0 );
}
/*
* XXXceb This is a hack until the new IO functions are done.
* this function MUST be called before ldapssl_enable_clientauth.
*
*/
set_using_pkcs_functions( 1 );
/*
* LDAPDebug(LDAP_DEBUG_TRACE, "ldapssl_pkcs_init\n",0 ,0 ,0);
*/
certdbpath = keydbpath = secmoddbpath = NULL;
pfns->pkcs_getcertpath( NULL, &certdbpath);
pfns->pkcs_getkeypath( NULL, &keydbpath);
pfns->pkcs_getmodpath( NULL, &secmoddbpath);
if ( ldapssl_basic_init(certdbpath, keydbpath, secmoddbpath) != 0 ) {
return( -1 );
}
/* this is odd */
PK11_ConfigurePKCS11(NULL, NULL, tokDes, ptokDes, NULL, NULL, NULL, NULL, 0, 0 );
if (SSL_OptionSetDefault(SSL_ENABLE_SSL2, PR_FALSE)
|| SSL_OptionSetDefault(SSL_ENABLE_SSL3, PR_TRUE)
|| SSL_OptionSetDefault(SSL_ENABLE_TLS, PR_TRUE)) {
if (( rc = PR_GetError()) >= 0 ) {
rc = -1;
}
return( rc );
}
#if defined(NS_DOMESTIC)
if (local_SSLPLCY_Install() == PR_FAILURE)
return( -1 );
#elif(NS_EXPORT)
if (local_SSLPLCY_Install() == PR_FAILURE)
return( -1 );
#else
return( -1 );
#endif
inited = 1;
return ( ldapssl_set_strength( NULL, LDAPSSL_AUTH_CERT ));
}
/*
* ldapssl_client_init() is a server-authentication only version of
* ldapssl_clientauth_init().
*/
int
LDAP_CALL
ldapssl_client_init(const char* certdbpath, void *certdbhandle )
{
return( ldapssl_clientauth_init( certdbpath, certdbhandle,
0, NULL, NULL ));
}
/*
* ldapssl_serverauth_init() is a server-authentication only version of
* ldapssl_clientauth_init(). This function allows the sslstrength
* to be passed in. The sslstrength can take one of the following
* values:
* LDAPSSL_AUTH_WEAK: indicate that you accept the server's
* certificate without checking the CA who
* issued the certificate
* LDAPSSL_AUTH_CERT: indicates that you accept the server's
* certificate only if you trust the CA who
* issued the certificate
* LDAPSSL_AUTH_CNCHECK:
indicates that you accept the server's
* certificate only if you trust the CA who
* issued the certificate and if the value
* of the cn attribute in the DNS hostname
* of the server
*/
int
LDAP_CALL
ldapssl_serverauth_init(const char* certdbpath,
void *certdbhandle,
const int sslstrength )
{
if ( ldapssl_set_strength( NULL, sslstrength ) != 0 ) {
return( -1 );
}
return( ldapssl_clientauth_init( certdbpath, certdbhandle,
0, NULL, NULL ));
}
#endif /* NET_SSL */
|