1 /* 2 * Copyright (c) 2000-2005 Sendmail, Inc. and its suppliers. 3 * All rights reserved. 4 * 5 * By using this file, you agree to the terms and conditions set 6 * forth in the LICENSE file which can be found at the top level of 7 * the sendmail distribution. 8 * 9 */ 10 11 #pragma ident "%Z%%M% %I% %E% SMI" 12 13 #include <sendmail.h> 14 15 SM_RCSID("@(#)$Id: tls.c,v 8.102 2006/03/02 19:18:27 ca Exp $") 16 17 #if STARTTLS 18 # include <openssl/err.h> 19 # include <openssl/bio.h> 20 # include <openssl/pem.h> 21 # ifndef HASURANDOMDEV 22 # include <openssl/rand.h> 23 # endif /* ! HASURANDOMDEV */ 24 # if !TLS_NO_RSA 25 static RSA *rsa_tmp = NULL; /* temporary RSA key */ 26 static RSA *tmp_rsa_key __P((SSL *, int, int)); 27 # endif /* !TLS_NO_RSA */ 28 # if !defined(OPENSSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER < 0x00907000L 29 static int tls_verify_cb __P((X509_STORE_CTX *)); 30 # else /* !defined() || OPENSSL_VERSION_NUMBER < 0x00907000L */ 31 static int tls_verify_cb __P((X509_STORE_CTX *, void *)); 32 # endif /* !defined() || OPENSSL_VERSION_NUMBER < 0x00907000L */ 33 34 # if OPENSSL_VERSION_NUMBER > 0x00907000L 35 static int x509_verify_cb __P((int, X509_STORE_CTX *)); 36 # endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */ 37 38 # if !defined(OPENSSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER < 0x00907000L 39 # define CONST097 40 # else /* !defined() || OPENSSL_VERSION_NUMBER < 0x00907000L */ 41 # define CONST097 const 42 # endif /* !defined() || OPENSSL_VERSION_NUMBER < 0x00907000L */ 43 static void apps_ssl_info_cb __P((CONST097 SSL *, int , int)); 44 static bool tls_ok_f __P((char *, char *, int)); 45 static bool tls_safe_f __P((char *, long, bool)); 46 static int tls_verify_log __P((int, X509_STORE_CTX *, char *)); 47 48 # if !NO_DH 49 static DH *get_dh512 __P((void)); 50 51 static unsigned char dh512_p[] = 52 { 53 0xDA,0x58,0x3C,0x16,0xD9,0x85,0x22,0x89,0xD0,0xE4,0xAF,0x75, 54 0x6F,0x4C,0xCA,0x92,0xDD,0x4B,0xE5,0x33,0xB8,0x04,0xFB,0x0F, 55 0xED,0x94,0xEF,0x9C,0x8A,0x44,0x03,0xED,0x57,0x46,0x50,0xD3, 56 0x69,0x99,0xDB,0x29,0xD7,0x76,0x27,0x6B,0xA2,0xD3,0xD4,0x12, 57 0xE2,0x18,0xF4,0xDD,0x1E,0x08,0x4C,0xF6,0xD8,0x00,0x3E,0x7C, 58 0x47,0x74,0xE8,0x33 59 }; 60 static unsigned char dh512_g[] = 61 { 62 0x02 63 }; 64 65 static DH * 66 get_dh512() 67 { 68 DH *dh = NULL; 69 70 if ((dh = DH_new()) == NULL) 71 return NULL; 72 dh->p = BN_bin2bn(dh512_p, sizeof(dh512_p), NULL); 73 dh->g = BN_bin2bn(dh512_g, sizeof(dh512_g), NULL); 74 if ((dh->p == NULL) || (dh->g == NULL)) 75 return NULL; 76 return dh; 77 } 78 # endif /* !NO_DH */ 79 80 81 /* 82 ** TLS_RAND_INIT -- initialize STARTTLS random generator 83 ** 84 ** Parameters: 85 ** randfile -- name of file with random data 86 ** logl -- loglevel 87 ** 88 ** Returns: 89 ** success/failure 90 ** 91 ** Side Effects: 92 ** initializes PRNG for tls library. 93 */ 94 95 # define MIN_RAND_BYTES 128 /* 1024 bits */ 96 97 # define RF_OK 0 /* randfile OK */ 98 # define RF_MISS 1 /* randfile == NULL || *randfile == '\0' */ 99 # define RF_UNKNOWN 2 /* unknown prefix for randfile */ 100 101 # define RI_NONE 0 /* no init yet */ 102 # define RI_SUCCESS 1 /* init was successful */ 103 # define RI_FAIL 2 /* init failed */ 104 105 static bool tls_rand_init __P((char *, int)); 106 107 static bool 108 tls_rand_init(randfile, logl) 109 char *randfile; 110 int logl; 111 { 112 # ifndef HASURANDOMDEV 113 /* not required if /dev/urandom exists, OpenSSL does it internally */ 114 115 bool ok; 116 int randdef; 117 static int done = RI_NONE; 118 119 /* 120 ** initialize PRNG 121 */ 122 123 /* did we try this before? if yes: return old value */ 124 if (done != RI_NONE) 125 return done == RI_SUCCESS; 126 127 /* set default values */ 128 ok = false; 129 done = RI_FAIL; 130 randdef = (randfile == NULL || *randfile == '\0') ? RF_MISS : RF_OK; 131 # if EGD 132 if (randdef == RF_OK && sm_strncasecmp(randfile, "egd:", 4) == 0) 133 { 134 randfile += 4; 135 if (RAND_egd(randfile) < 0) 136 { 137 sm_syslog(LOG_WARNING, NOQID, 138 "STARTTLS: RAND_egd(%s) failed: random number generator not seeded", 139 randfile); 140 } 141 else 142 ok = true; 143 } 144 else 145 # endif /* EGD */ 146 if (randdef == RF_OK && sm_strncasecmp(randfile, "file:", 5) == 0) 147 { 148 int fd; 149 long sff; 150 struct stat st; 151 152 randfile += 5; 153 sff = SFF_SAFEDIRPATH | SFF_NOWLINK 154 | SFF_NOGWFILES | SFF_NOWWFILES 155 | SFF_NOGRFILES | SFF_NOWRFILES 156 | SFF_MUSTOWN | SFF_ROOTOK | SFF_OPENASROOT; 157 if (DontLockReadFiles) 158 sff |= SFF_NOLOCK; 159 if ((fd = safeopen(randfile, O_RDONLY, 0, sff)) >= 0) 160 { 161 if (fstat(fd, &st) < 0) 162 { 163 if (LogLevel > logl) 164 sm_syslog(LOG_ERR, NOQID, 165 "STARTTLS: can't fstat(%s)", 166 randfile); 167 } 168 else 169 { 170 bool use, problem; 171 172 use = true; 173 problem = false; 174 175 /* max. age of file: 10 minutes */ 176 if (st.st_mtime + 600 < curtime()) 177 { 178 use = bitnset(DBS_INSUFFICIENTENTROPY, 179 DontBlameSendmail); 180 problem = true; 181 if (LogLevel > logl) 182 sm_syslog(LOG_ERR, NOQID, 183 "STARTTLS: RandFile %s too old: %s", 184 randfile, 185 use ? "unsafe" : 186 "unusable"); 187 } 188 if (use && st.st_size < MIN_RAND_BYTES) 189 { 190 use = bitnset(DBS_INSUFFICIENTENTROPY, 191 DontBlameSendmail); 192 problem = true; 193 if (LogLevel > logl) 194 sm_syslog(LOG_ERR, NOQID, 195 "STARTTLS: size(%s) < %d: %s", 196 randfile, 197 MIN_RAND_BYTES, 198 use ? "unsafe" : 199 "unusable"); 200 } 201 if (use) 202 ok = RAND_load_file(randfile, -1) >= 203 MIN_RAND_BYTES; 204 if (use && !ok) 205 { 206 if (LogLevel > logl) 207 sm_syslog(LOG_WARNING, NOQID, 208 "STARTTLS: RAND_load_file(%s) failed: random number generator not seeded", 209 randfile); 210 } 211 if (problem) 212 ok = false; 213 } 214 if (ok || bitnset(DBS_INSUFFICIENTENTROPY, 215 DontBlameSendmail)) 216 { 217 /* add this even if fstat() failed */ 218 RAND_seed((void *) &st, sizeof st); 219 } 220 (void) close(fd); 221 } 222 else 223 { 224 if (LogLevel > logl) 225 sm_syslog(LOG_WARNING, NOQID, 226 "STARTTLS: Warning: safeopen(%s) failed", 227 randfile); 228 } 229 } 230 else if (randdef == RF_OK) 231 { 232 if (LogLevel > logl) 233 sm_syslog(LOG_WARNING, NOQID, 234 "STARTTLS: Error: no proper random file definition %s", 235 randfile); 236 randdef = RF_UNKNOWN; 237 } 238 if (randdef == RF_MISS) 239 { 240 if (LogLevel > logl) 241 sm_syslog(LOG_WARNING, NOQID, 242 "STARTTLS: Error: missing random file definition"); 243 } 244 if (!ok && bitnset(DBS_INSUFFICIENTENTROPY, DontBlameSendmail)) 245 { 246 int i; 247 long r; 248 unsigned char buf[MIN_RAND_BYTES]; 249 250 /* assert((MIN_RAND_BYTES % sizeof(long)) == 0); */ 251 for (i = 0; i <= sizeof(buf) - sizeof(long); i += sizeof(long)) 252 { 253 r = get_random(); 254 (void) memcpy(buf + i, (void *) &r, sizeof(long)); 255 } 256 RAND_seed(buf, sizeof buf); 257 if (LogLevel > logl) 258 sm_syslog(LOG_WARNING, NOQID, 259 "STARTTLS: Warning: random number generator not properly seeded"); 260 ok = true; 261 } 262 done = ok ? RI_SUCCESS : RI_FAIL; 263 return ok; 264 # else /* ! HASURANDOMDEV */ 265 return true; 266 # endif /* ! HASURANDOMDEV */ 267 } 268 /* 269 ** INIT_TLS_LIBRARY -- Calls functions which setup TLS library for global use. 270 ** 271 ** Parameters: 272 ** none. 273 ** 274 ** Returns: 275 ** succeeded? 276 */ 277 278 bool 279 init_tls_library() 280 { 281 /* basic TLS initialization, ignore result for now */ 282 SSL_library_init(); 283 SSL_load_error_strings(); 284 # if 0 285 /* this is currently a macro for SSL_library_init */ 286 SSLeay_add_ssl_algorithms(); 287 # endif /* 0 */ 288 289 return tls_rand_init(RandFile, 7); 290 } 291 /* 292 ** TLS_SET_VERIFY -- request client certificate? 293 ** 294 ** Parameters: 295 ** ctx -- TLS context 296 ** ssl -- TLS structure 297 ** vrfy -- require certificate? 298 ** 299 ** Returns: 300 ** none. 301 ** 302 ** Side Effects: 303 ** Sets verification state for TLS 304 ** 305 # if TLS_VRFY_PER_CTX 306 ** Notice: 307 ** This is per TLS context, not per TLS structure; 308 ** the former is global, the latter per connection. 309 ** It would be nice to do this per connection, but this 310 ** doesn't work in the current TLS libraries :-( 311 # endif * TLS_VRFY_PER_CTX * 312 */ 313 314 void 315 tls_set_verify(ctx, ssl, vrfy) 316 SSL_CTX *ctx; 317 SSL *ssl; 318 bool vrfy; 319 { 320 # if !TLS_VRFY_PER_CTX 321 SSL_set_verify(ssl, vrfy ? SSL_VERIFY_PEER : SSL_VERIFY_NONE, NULL); 322 # else /* !TLS_VRFY_PER_CTX */ 323 SSL_CTX_set_verify(ctx, vrfy ? SSL_VERIFY_PEER : SSL_VERIFY_NONE, 324 NULL); 325 # endif /* !TLS_VRFY_PER_CTX */ 326 } 327 328 /* 329 ** status in initialization 330 ** these flags keep track of the status of the initialization 331 ** i.e., whether a file exists (_EX) and whether it can be used (_OK) 332 ** [due to permissions] 333 */ 334 335 # define TLS_S_NONE 0x00000000 /* none yet */ 336 # define TLS_S_CERT_EX 0x00000001 /* cert file exists */ 337 # define TLS_S_CERT_OK 0x00000002 /* cert file is ok */ 338 # define TLS_S_KEY_EX 0x00000004 /* key file exists */ 339 # define TLS_S_KEY_OK 0x00000008 /* key file is ok */ 340 # define TLS_S_CERTP_EX 0x00000010 /* CA cert path exists */ 341 # define TLS_S_CERTP_OK 0x00000020 /* CA cert path is ok */ 342 # define TLS_S_CERTF_EX 0x00000040 /* CA cert file exists */ 343 # define TLS_S_CERTF_OK 0x00000080 /* CA cert file is ok */ 344 # define TLS_S_CRLF_EX 0x00000100 /* CRL file exists */ 345 # define TLS_S_CRLF_OK 0x00000200 /* CRL file is ok */ 346 347 # if _FFR_TLS_1 348 # define TLS_S_CERT2_EX 0x00001000 /* 2nd cert file exists */ 349 # define TLS_S_CERT2_OK 0x00002000 /* 2nd cert file is ok */ 350 # define TLS_S_KEY2_EX 0x00004000 /* 2nd key file exists */ 351 # define TLS_S_KEY2_OK 0x00008000 /* 2nd key file is ok */ 352 # endif /* _FFR_TLS_1 */ 353 354 # define TLS_S_DH_OK 0x00200000 /* DH cert is ok */ 355 # define TLS_S_DHPAR_EX 0x00400000 /* DH param file exists */ 356 # define TLS_S_DHPAR_OK 0x00800000 /* DH param file is ok to use */ 357 358 /* Type of variable */ 359 # define TLS_T_OTHER 0 360 # define TLS_T_SRV 1 361 # define TLS_T_CLT 2 362 363 /* 364 ** TLS_OK_F -- can var be an absolute filename? 365 ** 366 ** Parameters: 367 ** var -- filename 368 ** fn -- what is the filename used for? 369 ** type -- type of variable 370 ** 371 ** Returns: 372 ** ok? 373 */ 374 375 static bool 376 tls_ok_f(var, fn, type) 377 char *var; 378 char *fn; 379 int type; 380 { 381 /* must be absolute pathname */ 382 if (var != NULL && *var == '/') 383 return true; 384 if (LogLevel > 12) 385 sm_syslog(LOG_WARNING, NOQID, "STARTTLS: %s%s missing", 386 type == TLS_T_SRV ? "Server" : 387 (type == TLS_T_CLT ? "Client" : ""), fn); 388 return false; 389 } 390 /* 391 ** TLS_SAFE_F -- is a file safe to use? 392 ** 393 ** Parameters: 394 ** var -- filename 395 ** sff -- flags for safefile() 396 ** srv -- server side? 397 ** 398 ** Returns: 399 ** ok? 400 */ 401 402 static bool 403 tls_safe_f(var, sff, srv) 404 char *var; 405 long sff; 406 bool srv; 407 { 408 int ret; 409 410 if ((ret = safefile(var, RunAsUid, RunAsGid, RunAsUserName, sff, 411 S_IRUSR, NULL)) == 0) 412 return true; 413 if (LogLevel > 7) 414 sm_syslog(LOG_WARNING, NOQID, "STARTTLS=%s: file %s unsafe: %s", 415 srv ? "server" : "client", var, sm_errstring(ret)); 416 return false; 417 } 418 419 /* 420 ** TLS_OK_F -- macro to simplify calls to tls_ok_f 421 ** 422 ** Parameters: 423 ** var -- filename 424 ** fn -- what is the filename used for? 425 ** req -- is the file required? 426 ** st -- status bit to set if ok 427 ** type -- type of variable 428 ** 429 ** Side Effects: 430 ** uses r, ok; may change ok and status. 431 ** 432 */ 433 434 # define TLS_OK_F(var, fn, req, st, type) if (ok) \ 435 { \ 436 r = tls_ok_f(var, fn, type); \ 437 if (r) \ 438 status |= st; \ 439 else if (req) \ 440 ok = false; \ 441 } 442 443 /* 444 ** TLS_UNR -- macro to return whether a file should be unreadable 445 ** 446 ** Parameters: 447 ** bit -- flag to test 448 ** req -- flags 449 ** 450 ** Returns: 451 ** 0/SFF_NORFILES 452 */ 453 # define TLS_UNR(bit, req) (bitset(bit, req) ? SFF_NORFILES : 0) 454 # define TLS_OUNR(bit, req) (bitset(bit, req) ? SFF_NOWRFILES : 0) 455 # define TLS_KEYSFF(req) \ 456 (bitnset(DBS_GROUPREADABLEKEYFILE, DontBlameSendmail) ? \ 457 TLS_OUNR(TLS_I_KEY_OUNR, req) : \ 458 TLS_UNR(TLS_I_KEY_UNR, req)) 459 460 /* 461 ** TLS_SAFE_F -- macro to simplify calls to tls_safe_f 462 ** 463 ** Parameters: 464 ** var -- filename 465 ** sff -- flags for safefile() 466 ** req -- is the file required? 467 ** ex -- does the file exist? 468 ** st -- status bit to set if ok 469 ** srv -- server side? 470 ** 471 ** Side Effects: 472 ** uses r, ok, ex; may change ok and status. 473 ** 474 */ 475 476 # define TLS_SAFE_F(var, sff, req, ex, st, srv) if (ex && ok) \ 477 { \ 478 r = tls_safe_f(var, sff, srv); \ 479 if (r) \ 480 status |= st; \ 481 else if (req) \ 482 ok = false; \ 483 } 484 485 /* 486 ** INITTLS -- initialize TLS 487 ** 488 ** Parameters: 489 ** ctx -- pointer to context 490 ** req -- requirements for initialization (see sendmail.h) 491 ** srv -- server side? 492 ** certfile -- filename of certificate 493 ** keyfile -- filename of private key 494 ** cacertpath -- path to CAs 495 ** cacertfile -- file with CA(s) 496 ** dhparam -- parameters for DH 497 ** 498 ** Returns: 499 ** succeeded? 500 */ 501 502 /* 503 ** The session_id_context identifies the service that created a session. 504 ** This information is used to distinguish between multiple TLS-based 505 ** servers running on the same server. We use the name of the mail system. 506 ** Note: the session cache is not persistent. 507 */ 508 509 static char server_session_id_context[] = "sendmail8"; 510 511 bool 512 inittls(ctx, req, srv, certfile, keyfile, cacertpath, cacertfile, dhparam) 513 SSL_CTX **ctx; 514 unsigned long req; 515 bool srv; 516 char *certfile, *keyfile, *cacertpath, *cacertfile, *dhparam; 517 { 518 # if !NO_DH 519 static DH *dh = NULL; 520 # endif /* !NO_DH */ 521 int r; 522 bool ok; 523 long sff, status; 524 char *who; 525 # if _FFR_TLS_1 526 char *cf2, *kf2; 527 # endif /* _FFR_TLS_1 */ 528 # if SM_CONF_SHM 529 extern int ShmId; 530 # endif /* SM_CONF_SHM */ 531 # if OPENSSL_VERSION_NUMBER > 0x00907000L 532 BIO *crl_file; 533 X509_CRL *crl; 534 X509_STORE *store; 535 # endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */ 536 537 status = TLS_S_NONE; 538 who = srv ? "server" : "client"; 539 if (ctx == NULL) 540 syserr("STARTTLS=%s, inittls: ctx == NULL", who); 541 542 /* already initialized? (we could re-init...) */ 543 if (*ctx != NULL) 544 return true; 545 ok = true; 546 547 # if _FFR_TLS_1 548 /* 549 ** look for a second filename: it must be separated by a ',' 550 ** no blanks allowed (they won't be skipped). 551 ** we change a global variable here! this change will be undone 552 ** before return from the function but only if it returns true. 553 ** this isn't a problem since in a failure case this function 554 ** won't be called again with the same (overwritten) values. 555 ** otherwise each return must be replaced with a goto endinittls. 556 */ 557 558 cf2 = NULL; 559 kf2 = NULL; 560 if (certfile != NULL && (cf2 = strchr(certfile, ',')) != NULL) 561 { 562 *cf2++ = '\0'; 563 if (keyfile != NULL && (kf2 = strchr(keyfile, ',')) != NULL) 564 *kf2++ = '\0'; 565 } 566 # endif /* _FFR_TLS_1 */ 567 568 /* 569 ** Check whether files/paths are defined 570 */ 571 572 TLS_OK_F(certfile, "CertFile", bitset(TLS_I_CERT_EX, req), 573 TLS_S_CERT_EX, srv ? TLS_T_SRV : TLS_T_CLT); 574 TLS_OK_F(keyfile, "KeyFile", bitset(TLS_I_KEY_EX, req), 575 TLS_S_KEY_EX, srv ? TLS_T_SRV : TLS_T_CLT); 576 TLS_OK_F(cacertpath, "CACertPath", bitset(TLS_I_CERTP_EX, req), 577 TLS_S_CERTP_EX, TLS_T_OTHER); 578 TLS_OK_F(cacertfile, "CACertFile", bitset(TLS_I_CERTF_EX, req), 579 TLS_S_CERTF_EX, TLS_T_OTHER); 580 581 # if OPENSSL_VERSION_NUMBER > 0x00907000L 582 TLS_OK_F(CRLFile, "CRLFile", bitset(TLS_I_CRLF_EX, req), 583 TLS_S_CRLF_EX, TLS_T_OTHER); 584 # endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */ 585 586 # if _FFR_TLS_1 587 /* 588 ** if the second file is specified it must exist 589 ** XXX: it is possible here to define only one of those files 590 */ 591 592 if (cf2 != NULL) 593 { 594 TLS_OK_F(cf2, "CertFile", bitset(TLS_I_CERT_EX, req), 595 TLS_S_CERT2_EX, srv ? TLS_T_SRV : TLS_T_CLT); 596 } 597 if (kf2 != NULL) 598 { 599 TLS_OK_F(kf2, "KeyFile", bitset(TLS_I_KEY_EX, req), 600 TLS_S_KEY2_EX, srv ? TLS_T_SRV : TLS_T_CLT); 601 } 602 # endif /* _FFR_TLS_1 */ 603 604 /* 605 ** valid values for dhparam are (only the first char is checked) 606 ** none no parameters: don't use DH 607 ** 512 generate 512 bit parameters (fixed) 608 ** 1024 generate 1024 bit parameters 609 ** /file/name read parameters from /file/name 610 ** default is: 1024 for server, 512 for client (OK? XXX) 611 */ 612 613 if (bitset(TLS_I_TRY_DH, req)) 614 { 615 if (dhparam != NULL) 616 { 617 char c = *dhparam; 618 619 if (c == '1') 620 req |= TLS_I_DH1024; 621 else if (c == '5') 622 req |= TLS_I_DH512; 623 else if (c != 'n' && c != 'N' && c != '/') 624 { 625 if (LogLevel > 12) 626 sm_syslog(LOG_WARNING, NOQID, 627 "STARTTLS=%s, error: illegal value '%s' for DHParam", 628 who, dhparam); 629 dhparam = NULL; 630 } 631 } 632 if (dhparam == NULL) 633 dhparam = srv ? "1" : "5"; 634 else if (*dhparam == '/') 635 { 636 TLS_OK_F(dhparam, "DHParameters", 637 bitset(TLS_I_DHPAR_EX, req), 638 TLS_S_DHPAR_EX, TLS_T_OTHER); 639 } 640 } 641 if (!ok) 642 return ok; 643 644 /* certfile etc. must be "safe". */ 645 sff = SFF_REGONLY | SFF_SAFEDIRPATH | SFF_NOWLINK 646 | SFF_NOGWFILES | SFF_NOWWFILES 647 | SFF_MUSTOWN | SFF_ROOTOK | SFF_OPENASROOT; 648 if (DontLockReadFiles) 649 sff |= SFF_NOLOCK; 650 651 TLS_SAFE_F(certfile, sff | TLS_UNR(TLS_I_CERT_UNR, req), 652 bitset(TLS_I_CERT_EX, req), 653 bitset(TLS_S_CERT_EX, status), TLS_S_CERT_OK, srv); 654 TLS_SAFE_F(keyfile, sff | TLS_KEYSFF(req), 655 bitset(TLS_I_KEY_EX, req), 656 bitset(TLS_S_KEY_EX, status), TLS_S_KEY_OK, srv); 657 TLS_SAFE_F(cacertfile, sff | TLS_UNR(TLS_I_CERTF_UNR, req), 658 bitset(TLS_I_CERTF_EX, req), 659 bitset(TLS_S_CERTF_EX, status), TLS_S_CERTF_OK, srv); 660 TLS_SAFE_F(dhparam, sff | TLS_UNR(TLS_I_DHPAR_UNR, req), 661 bitset(TLS_I_DHPAR_EX, req), 662 bitset(TLS_S_DHPAR_EX, status), TLS_S_DHPAR_OK, srv); 663 # if OPENSSL_VERSION_NUMBER > 0x00907000L 664 TLS_SAFE_F(CRLFile, sff | TLS_UNR(TLS_I_CRLF_UNR, req), 665 bitset(TLS_I_CRLF_EX, req), 666 bitset(TLS_S_CRLF_EX, status), TLS_S_CRLF_OK, srv); 667 # endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */ 668 if (!ok) 669 return ok; 670 # if _FFR_TLS_1 671 if (cf2 != NULL) 672 { 673 TLS_SAFE_F(cf2, sff | TLS_UNR(TLS_I_CERT_UNR, req), 674 bitset(TLS_I_CERT_EX, req), 675 bitset(TLS_S_CERT2_EX, status), TLS_S_CERT2_OK, srv); 676 } 677 if (kf2 != NULL) 678 { 679 TLS_SAFE_F(kf2, sff | TLS_KEYSFF(req), 680 bitset(TLS_I_KEY_EX, req), 681 bitset(TLS_S_KEY2_EX, status), TLS_S_KEY2_OK, srv); 682 } 683 # endif /* _FFR_TLS_1 */ 684 685 /* create a method and a new context */ 686 if ((*ctx = SSL_CTX_new(srv ? SSLv23_server_method() : 687 SSLv23_client_method())) == NULL) 688 { 689 if (LogLevel > 7) 690 sm_syslog(LOG_WARNING, NOQID, 691 "STARTTLS=%s, error: SSL_CTX_new(SSLv23_%s_method()) failed", 692 who, who); 693 if (LogLevel > 9) 694 tlslogerr(who); 695 return false; 696 } 697 698 # if OPENSSL_VERSION_NUMBER > 0x00907000L 699 if (CRLFile != NULL) 700 { 701 /* get a pointer to the current certificate validation store */ 702 store = SSL_CTX_get_cert_store(*ctx); /* does not fail */ 703 crl_file = BIO_new(BIO_s_file_internal()); 704 if (crl_file != NULL) 705 { 706 if (BIO_read_filename(crl_file, CRLFile) >= 0) 707 { 708 crl = PEM_read_bio_X509_CRL(crl_file, NULL, 709 NULL, NULL); 710 BIO_free(crl_file); 711 X509_STORE_add_crl(store, crl); 712 X509_CRL_free(crl); 713 X509_STORE_set_flags(store, 714 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL); 715 X509_STORE_set_verify_cb_func(store, 716 x509_verify_cb); 717 } 718 else 719 { 720 if (LogLevel > 9) 721 { 722 sm_syslog(LOG_WARNING, NOQID, 723 "STARTTLS=%s, error: PEM_read_bio_X509_CRL(%s)=failed", 724 who, CRLFile); 725 } 726 727 /* avoid memory leaks */ 728 BIO_free(crl_file); 729 return false; 730 } 731 732 } 733 else if (LogLevel > 9) 734 sm_syslog(LOG_WARNING, NOQID, 735 "STARTTLS=%s, error: BIO_new=failed", who); 736 } 737 # if _FFR_CRLPATH 738 if (CRLPath != NULL) 739 { 740 X509_LOOKUP *lookup; 741 742 lookup = X509_STORE_add_lookup(store, X509_LOOKUP_hash_dir()); 743 if (lookup == NULL) 744 { 745 if (LogLevel > 9) 746 { 747 sm_syslog(LOG_WARNING, NOQID, 748 "STARTTLS=%s, error: X509_STORE_add_lookup(hash)=failed", 749 who, CRLFile); 750 } 751 return false; 752 } 753 X509_LOOKUP_add_dir(lookup, CRLPath, X509_FILETYPE_PEM); 754 X509_STORE_set_flags(store, 755 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL); 756 } 757 # endif /* _FFR_CRLPATH */ 758 # endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */ 759 760 # if TLS_NO_RSA 761 /* turn off backward compatibility, required for no-rsa */ 762 SSL_CTX_set_options(*ctx, SSL_OP_NO_SSLv2); 763 # endif /* TLS_NO_RSA */ 764 765 766 # if !TLS_NO_RSA 767 /* 768 ** Create a temporary RSA key 769 ** XXX Maybe we shouldn't create this always (even though it 770 ** is only at startup). 771 ** It is a time-consuming operation and it is not always necessary. 772 ** maybe we should do it only on demand... 773 */ 774 775 if (bitset(TLS_I_RSA_TMP, req) 776 # if SM_CONF_SHM 777 && ShmId != SM_SHM_NO_ID && 778 (rsa_tmp = RSA_generate_key(RSA_KEYLENGTH, RSA_F4, NULL, 779 NULL)) == NULL 780 # else /* SM_CONF_SHM */ 781 && 0 /* no shared memory: no need to generate key now */ 782 # endif /* SM_CONF_SHM */ 783 ) 784 { 785 if (LogLevel > 7) 786 { 787 sm_syslog(LOG_WARNING, NOQID, 788 "STARTTLS=%s, error: RSA_generate_key failed", 789 who); 790 if (LogLevel > 9) 791 tlslogerr(who); 792 } 793 return false; 794 } 795 # endif /* !TLS_NO_RSA */ 796 797 /* 798 ** load private key 799 ** XXX change this for DSA-only version 800 */ 801 802 if (bitset(TLS_S_KEY_OK, status) && 803 SSL_CTX_use_PrivateKey_file(*ctx, keyfile, 804 SSL_FILETYPE_PEM) <= 0) 805 { 806 if (LogLevel > 7) 807 { 808 sm_syslog(LOG_WARNING, NOQID, 809 "STARTTLS=%s, error: SSL_CTX_use_PrivateKey_file(%s) failed", 810 who, keyfile); 811 if (LogLevel > 9) 812 tlslogerr(who); 813 } 814 if (bitset(TLS_I_USE_KEY, req)) 815 return false; 816 } 817 818 /* get the certificate file */ 819 if (bitset(TLS_S_CERT_OK, status) && 820 SSL_CTX_use_certificate_file(*ctx, certfile, 821 SSL_FILETYPE_PEM) <= 0) 822 { 823 if (LogLevel > 7) 824 { 825 sm_syslog(LOG_WARNING, NOQID, 826 "STARTTLS=%s, error: SSL_CTX_use_certificate_file(%s) failed", 827 who, certfile); 828 if (LogLevel > 9) 829 tlslogerr(who); 830 } 831 if (bitset(TLS_I_USE_CERT, req)) 832 return false; 833 } 834 835 /* check the private key */ 836 if (bitset(TLS_S_KEY_OK, status) && 837 (r = SSL_CTX_check_private_key(*ctx)) <= 0) 838 { 839 /* Private key does not match the certificate public key */ 840 if (LogLevel > 5) 841 { 842 sm_syslog(LOG_WARNING, NOQID, 843 "STARTTLS=%s, error: SSL_CTX_check_private_key failed(%s): %d", 844 who, keyfile, r); 845 if (LogLevel > 9) 846 tlslogerr(who); 847 } 848 if (bitset(TLS_I_USE_KEY, req)) 849 return false; 850 } 851 852 # if _FFR_TLS_1 853 /* XXX this code is pretty much duplicated from above! */ 854 855 /* load private key */ 856 if (bitset(TLS_S_KEY2_OK, status) && 857 SSL_CTX_use_PrivateKey_file(*ctx, kf2, SSL_FILETYPE_PEM) <= 0) 858 { 859 if (LogLevel > 7) 860 { 861 sm_syslog(LOG_WARNING, NOQID, 862 "STARTTLS=%s, error: SSL_CTX_use_PrivateKey_file(%s) failed", 863 who, kf2); 864 if (LogLevel > 9) 865 tlslogerr(who); 866 } 867 } 868 869 /* get the certificate file */ 870 if (bitset(TLS_S_CERT2_OK, status) && 871 SSL_CTX_use_certificate_file(*ctx, cf2, SSL_FILETYPE_PEM) <= 0) 872 { 873 if (LogLevel > 7) 874 { 875 sm_syslog(LOG_WARNING, NOQID, 876 "STARTTLS=%s, error: SSL_CTX_use_certificate_file(%s) failed", 877 who, cf2); 878 if (LogLevel > 9) 879 tlslogerr(who); 880 } 881 } 882 883 /* also check the private key */ 884 if (bitset(TLS_S_KEY2_OK, status) && 885 (r = SSL_CTX_check_private_key(*ctx)) <= 0) 886 { 887 /* Private key does not match the certificate public key */ 888 if (LogLevel > 5) 889 { 890 sm_syslog(LOG_WARNING, NOQID, 891 "STARTTLS=%s, error: SSL_CTX_check_private_key 2 failed: %d", 892 who, r); 893 if (LogLevel > 9) 894 tlslogerr(who); 895 } 896 } 897 # endif /* _FFR_TLS_1 */ 898 899 /* SSL_CTX_set_quiet_shutdown(*ctx, 1); violation of standard? */ 900 SSL_CTX_set_options(*ctx, SSL_OP_ALL); /* XXX bug compatibility? */ 901 902 # if !NO_DH 903 /* Diffie-Hellman initialization */ 904 if (bitset(TLS_I_TRY_DH, req)) 905 { 906 if (bitset(TLS_S_DHPAR_OK, status)) 907 { 908 BIO *bio; 909 910 if ((bio = BIO_new_file(dhparam, "r")) != NULL) 911 { 912 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL); 913 BIO_free(bio); 914 if (dh == NULL && LogLevel > 7) 915 { 916 unsigned long err; 917 918 err = ERR_get_error(); 919 sm_syslog(LOG_WARNING, NOQID, 920 "STARTTLS=%s, error: cannot read DH parameters(%s): %s", 921 who, dhparam, 922 ERR_error_string(err, NULL)); 923 if (LogLevel > 9) 924 tlslogerr(who); 925 } 926 } 927 else 928 { 929 if (LogLevel > 5) 930 { 931 sm_syslog(LOG_WARNING, NOQID, 932 "STARTTLS=%s, error: BIO_new_file(%s) failed", 933 who, dhparam); 934 if (LogLevel > 9) 935 tlslogerr(who); 936 } 937 } 938 } 939 if (dh == NULL && bitset(TLS_I_DH1024, req)) 940 { 941 DSA *dsa; 942 943 /* this takes a while! (7-130s on a 450MHz AMD K6-2) */ 944 dsa = DSA_generate_parameters(1024, NULL, 0, NULL, 945 NULL, 0, NULL); 946 dh = DSA_dup_DH(dsa); 947 DSA_free(dsa); 948 } 949 else 950 if (dh == NULL && bitset(TLS_I_DH512, req)) 951 dh = get_dh512(); 952 953 if (dh == NULL) 954 { 955 if (LogLevel > 9) 956 { 957 unsigned long err; 958 959 err = ERR_get_error(); 960 sm_syslog(LOG_WARNING, NOQID, 961 "STARTTLS=%s, error: cannot read or set DH parameters(%s): %s", 962 who, dhparam, 963 ERR_error_string(err, NULL)); 964 } 965 if (bitset(TLS_I_REQ_DH, req)) 966 return false; 967 } 968 else 969 { 970 SSL_CTX_set_tmp_dh(*ctx, dh); 971 972 /* important to avoid small subgroup attacks */ 973 SSL_CTX_set_options(*ctx, SSL_OP_SINGLE_DH_USE); 974 if (LogLevel > 13) 975 sm_syslog(LOG_INFO, NOQID, 976 "STARTTLS=%s, Diffie-Hellman init, key=%d bit (%c)", 977 who, 8 * DH_size(dh), *dhparam); 978 DH_free(dh); 979 } 980 } 981 # endif /* !NO_DH */ 982 983 984 /* XXX do we need this cache here? */ 985 if (bitset(TLS_I_CACHE, req)) 986 { 987 SSL_CTX_sess_set_cache_size(*ctx, 1); 988 SSL_CTX_set_timeout(*ctx, 1); 989 SSL_CTX_set_session_id_context(*ctx, 990 (void *) &server_session_id_context, 991 sizeof(server_session_id_context)); 992 (void) SSL_CTX_set_session_cache_mode(*ctx, 993 SSL_SESS_CACHE_SERVER); 994 } 995 else 996 { 997 (void) SSL_CTX_set_session_cache_mode(*ctx, 998 SSL_SESS_CACHE_OFF); 999 } 1000 1001 /* load certificate locations and default CA paths */ 1002 if (bitset(TLS_S_CERTP_EX, status) && bitset(TLS_S_CERTF_EX, status)) 1003 { 1004 if ((r = SSL_CTX_load_verify_locations(*ctx, cacertfile, 1005 cacertpath)) == 1) 1006 { 1007 # if !TLS_NO_RSA 1008 if (bitset(TLS_I_RSA_TMP, req)) 1009 SSL_CTX_set_tmp_rsa_callback(*ctx, tmp_rsa_key); 1010 # endif /* !TLS_NO_RSA */ 1011 1012 /* 1013 ** We have to install our own verify callback: 1014 ** SSL_VERIFY_PEER requests a client cert but even 1015 ** though *FAIL_IF* isn't set, the connection 1016 ** will be aborted if the client presents a cert 1017 ** that is not "liked" (can't be verified?) by 1018 ** the TLS library :-( 1019 */ 1020 1021 /* 1022 ** XXX currently we could call tls_set_verify() 1023 ** but we hope that that function will later on 1024 ** only set the mode per connection. 1025 */ 1026 SSL_CTX_set_verify(*ctx, 1027 bitset(TLS_I_NO_VRFY, req) ? SSL_VERIFY_NONE 1028 : SSL_VERIFY_PEER, 1029 NULL); 1030 1031 /* install verify callback */ 1032 SSL_CTX_set_cert_verify_callback(*ctx, tls_verify_cb, 1033 NULL); 1034 SSL_CTX_set_client_CA_list(*ctx, 1035 SSL_load_client_CA_file(cacertfile)); 1036 } 1037 else 1038 { 1039 /* 1040 ** can't load CA data; do we care? 1041 ** the data is necessary to authenticate the client, 1042 ** which in turn would be necessary 1043 ** if we want to allow relaying based on it. 1044 */ 1045 if (LogLevel > 5) 1046 { 1047 sm_syslog(LOG_WARNING, NOQID, 1048 "STARTTLS=%s, error: load verify locs %s, %s failed: %d", 1049 who, cacertpath, cacertfile, r); 1050 if (LogLevel > 9) 1051 tlslogerr(who); 1052 } 1053 if (bitset(TLS_I_VRFY_LOC, req)) 1054 return false; 1055 } 1056 } 1057 1058 /* XXX: make this dependent on an option? */ 1059 if (tTd(96, 9)) 1060 SSL_CTX_set_info_callback(*ctx, apps_ssl_info_cb); 1061 1062 # if _FFR_TLS_1 1063 /* install our own cipher list */ 1064 if (CipherList != NULL && *CipherList != '\0') 1065 { 1066 if (SSL_CTX_set_cipher_list(*ctx, CipherList) <= 0) 1067 { 1068 if (LogLevel > 7) 1069 { 1070 sm_syslog(LOG_WARNING, NOQID, 1071 "STARTTLS=%s, error: SSL_CTX_set_cipher_list(%s) failed, list ignored", 1072 who, CipherList); 1073 1074 if (LogLevel > 9) 1075 tlslogerr(who); 1076 } 1077 /* failure if setting to this list is required? */ 1078 } 1079 } 1080 # endif /* _FFR_TLS_1 */ 1081 if (LogLevel > 12) 1082 sm_syslog(LOG_INFO, NOQID, "STARTTLS=%s, init=%d", who, ok); 1083 1084 # if _FFR_TLS_1 1085 # if 0 1086 /* 1087 ** this label is required if we want to have a "clean" exit 1088 ** see the comments above at the initialization of cf2 1089 */ 1090 1091 endinittls: 1092 # endif /* 0 */ 1093 1094 /* undo damage to global variables */ 1095 if (cf2 != NULL) 1096 *--cf2 = ','; 1097 if (kf2 != NULL) 1098 *--kf2 = ','; 1099 # endif /* _FFR_TLS_1 */ 1100 1101 return ok; 1102 } 1103 /* 1104 ** TLS_GET_INFO -- get information about TLS connection 1105 ** 1106 ** Parameters: 1107 ** ssl -- TLS connection structure 1108 ** srv -- server or client 1109 ** host -- hostname of other side 1110 ** mac -- macro storage 1111 ** certreq -- did we ask for a cert? 1112 ** 1113 ** Returns: 1114 ** result of authentication. 1115 ** 1116 ** Side Effects: 1117 ** sets macros: {cipher}, {tls_version}, {verify}, 1118 ** {cipher_bits}, {alg_bits}, {cert}, {cert_subject}, 1119 ** {cert_issuer}, {cn_subject}, {cn_issuer} 1120 */ 1121 1122 int 1123 tls_get_info(ssl, srv, host, mac, certreq) 1124 SSL *ssl; 1125 bool srv; 1126 char *host; 1127 MACROS_T *mac; 1128 bool certreq; 1129 { 1130 SSL_CIPHER *c; 1131 int b, r; 1132 long verifyok; 1133 char *s, *who; 1134 char bitstr[16]; 1135 X509 *cert; 1136 1137 c = SSL_get_current_cipher(ssl); 1138 1139 /* cast is just workaround for compiler warning */ 1140 macdefine(mac, A_TEMP, macid("{cipher}"), 1141 (char *) SSL_CIPHER_get_name(c)); 1142 b = SSL_CIPHER_get_bits(c, &r); 1143 (void) sm_snprintf(bitstr, sizeof bitstr, "%d", b); 1144 macdefine(mac, A_TEMP, macid("{cipher_bits}"), bitstr); 1145 (void) sm_snprintf(bitstr, sizeof bitstr, "%d", r); 1146 macdefine(mac, A_TEMP, macid("{alg_bits}"), bitstr); 1147 s = SSL_CIPHER_get_version(c); 1148 if (s == NULL) 1149 s = "UNKNOWN"; 1150 macdefine(mac, A_TEMP, macid("{tls_version}"), s); 1151 1152 who = srv ? "server" : "client"; 1153 cert = SSL_get_peer_certificate(ssl); 1154 verifyok = SSL_get_verify_result(ssl); 1155 if (LogLevel > 14) 1156 sm_syslog(LOG_INFO, NOQID, 1157 "STARTTLS=%s, get_verify: %ld get_peer: 0x%lx", 1158 who, verifyok, (unsigned long) cert); 1159 if (cert != NULL) 1160 { 1161 unsigned int n; 1162 unsigned char md[EVP_MAX_MD_SIZE]; 1163 char buf[MAXNAME]; 1164 1165 X509_NAME_oneline(X509_get_subject_name(cert), 1166 buf, sizeof buf); 1167 macdefine(mac, A_TEMP, macid("{cert_subject}"), 1168 xtextify(buf, "<>\")")); 1169 X509_NAME_oneline(X509_get_issuer_name(cert), 1170 buf, sizeof buf); 1171 macdefine(mac, A_TEMP, macid("{cert_issuer}"), 1172 xtextify(buf, "<>\")")); 1173 X509_NAME_get_text_by_NID(X509_get_subject_name(cert), 1174 NID_commonName, buf, sizeof buf); 1175 macdefine(mac, A_TEMP, macid("{cn_subject}"), 1176 xtextify(buf, "<>\")")); 1177 X509_NAME_get_text_by_NID(X509_get_issuer_name(cert), 1178 NID_commonName, buf, sizeof buf); 1179 macdefine(mac, A_TEMP, macid("{cn_issuer}"), 1180 xtextify(buf, "<>\")")); 1181 n = 0; 1182 if (X509_digest(cert, EVP_md5(), md, &n) != 0 && n > 0) 1183 { 1184 char md5h[EVP_MAX_MD_SIZE * 3]; 1185 static const char hexcodes[] = "0123456789ABCDEF"; 1186 1187 SM_ASSERT((n * 3) + 2 < sizeof(md5h)); 1188 for (r = 0; r < (int) n; r++) 1189 { 1190 md5h[r * 3] = hexcodes[(md[r] & 0xf0) >> 4]; 1191 md5h[(r * 3) + 1] = hexcodes[(md[r] & 0x0f)]; 1192 md5h[(r * 3) + 2] = ':'; 1193 } 1194 md5h[(n * 3) - 1] = '\0'; 1195 macdefine(mac, A_TEMP, macid("{cert_md5}"), md5h); 1196 } 1197 else 1198 macdefine(mac, A_TEMP, macid("{cert_md5}"), ""); 1199 } 1200 else 1201 { 1202 macdefine(mac, A_PERM, macid("{cert_subject}"), ""); 1203 macdefine(mac, A_PERM, macid("{cert_issuer}"), ""); 1204 macdefine(mac, A_PERM, macid("{cn_subject}"), ""); 1205 macdefine(mac, A_PERM, macid("{cn_issuer}"), ""); 1206 macdefine(mac, A_TEMP, macid("{cert_md5}"), ""); 1207 } 1208 switch (verifyok) 1209 { 1210 case X509_V_OK: 1211 if (cert != NULL) 1212 { 1213 s = "OK"; 1214 r = TLS_AUTH_OK; 1215 } 1216 else 1217 { 1218 s = certreq ? "NO" : "NOT", 1219 r = TLS_AUTH_NO; 1220 } 1221 break; 1222 default: 1223 s = "FAIL"; 1224 r = TLS_AUTH_FAIL; 1225 break; 1226 } 1227 macdefine(mac, A_PERM, macid("{verify}"), s); 1228 if (cert != NULL) 1229 X509_free(cert); 1230 1231 /* do some logging */ 1232 if (LogLevel > 8) 1233 { 1234 char *vers, *s1, *s2, *cbits, *algbits; 1235 1236 vers = macget(mac, macid("{tls_version}")); 1237 cbits = macget(mac, macid("{cipher_bits}")); 1238 algbits = macget(mac, macid("{alg_bits}")); 1239 s1 = macget(mac, macid("{verify}")); 1240 s2 = macget(mac, macid("{cipher}")); 1241 1242 /* XXX: maybe cut off ident info? */ 1243 sm_syslog(LOG_INFO, NOQID, 1244 "STARTTLS=%s, relay=%.100s, version=%.16s, verify=%.16s, cipher=%.64s, bits=%.6s/%.6s", 1245 who, 1246 host == NULL ? "local" : host, 1247 vers, s1, s2, /* sm_snprintf() can deal with NULL */ 1248 algbits == NULL ? "0" : algbits, 1249 cbits == NULL ? "0" : cbits); 1250 if (LogLevel > 11) 1251 { 1252 /* 1253 ** Maybe run xuntextify on the strings? 1254 ** That is easier to read but makes it maybe a bit 1255 ** more complicated to figure out the right values 1256 ** for the access map... 1257 */ 1258 1259 s1 = macget(mac, macid("{cert_subject}")); 1260 s2 = macget(mac, macid("{cert_issuer}")); 1261 sm_syslog(LOG_INFO, NOQID, 1262 "STARTTLS=%s, cert-subject=%.256s, cert-issuer=%.256s, verifymsg=%s", 1263 who, s1, s2, 1264 X509_verify_cert_error_string(verifyok)); 1265 } 1266 } 1267 return r; 1268 } 1269 /* 1270 ** ENDTLS -- shutdown secure connection 1271 ** 1272 ** Parameters: 1273 ** ssl -- SSL connection information. 1274 ** side -- server/client (for logging). 1275 ** 1276 ** Returns: 1277 ** success? (EX_* code) 1278 */ 1279 1280 int 1281 endtls(ssl, side) 1282 SSL *ssl; 1283 char *side; 1284 { 1285 int ret = EX_OK; 1286 1287 if (ssl != NULL) 1288 { 1289 int r; 1290 1291 if ((r = SSL_shutdown(ssl)) < 0) 1292 { 1293 if (LogLevel > 11) 1294 { 1295 sm_syslog(LOG_WARNING, NOQID, 1296 "STARTTLS=%s, SSL_shutdown failed: %d", 1297 side, r); 1298 tlslogerr(side); 1299 } 1300 ret = EX_SOFTWARE; 1301 } 1302 # if !defined(OPENSSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER > 0x0090602fL 1303 1304 /* 1305 ** Bug in OpenSSL (at least up to 0.9.6b): 1306 ** From: Lutz.Jaenicke@aet.TU-Cottbus.DE 1307 ** Message-ID: <20010723152244.A13122@serv01.aet.tu-cottbus.de> 1308 ** To: openssl-users@openssl.org 1309 ** Subject: Re: SSL_shutdown() woes (fwd) 1310 ** 1311 ** The side sending the shutdown alert first will 1312 ** not care about the answer of the peer but will 1313 ** immediately return with a return value of "0" 1314 ** (ssl/s3_lib.c:ssl3_shutdown()). SSL_get_error will evaluate 1315 ** the value of "0" and as the shutdown alert of the peer was 1316 ** not received (actually, the program did not even wait for 1317 ** the answer), an SSL_ERROR_SYSCALL is flagged, because this 1318 ** is the default rule in case everything else does not apply. 1319 ** 1320 ** For your server the problem is different, because it 1321 ** receives the shutdown first (setting SSL_RECEIVED_SHUTDOWN), 1322 ** then sends its response (SSL_SENT_SHUTDOWN), so for the 1323 ** server the shutdown was successfull. 1324 ** 1325 ** As is by know, you would have to call SSL_shutdown() once 1326 ** and ignore an SSL_ERROR_SYSCALL returned. Then call 1327 ** SSL_shutdown() again to actually get the server's response. 1328 ** 1329 ** In the last discussion, Bodo Moeller concluded that a 1330 ** rewrite of the shutdown code would be necessary, but 1331 ** probably with another API, as the change would not be 1332 ** compatible to the way it is now. Things do not become 1333 ** easier as other programs do not follow the shutdown 1334 ** guidelines anyway, so that a lot error conditions and 1335 ** compitibility issues would have to be caught. 1336 ** 1337 ** For now the recommondation is to ignore the error message. 1338 */ 1339 1340 else if (r == 0) 1341 { 1342 if (LogLevel > 15) 1343 { 1344 sm_syslog(LOG_WARNING, NOQID, 1345 "STARTTLS=%s, SSL_shutdown not done", 1346 side); 1347 tlslogerr(side); 1348 } 1349 ret = EX_SOFTWARE; 1350 } 1351 # endif /* !defined(OPENSSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER > 0x0090602fL */ 1352 SSL_free(ssl); 1353 ssl = NULL; 1354 } 1355 return ret; 1356 } 1357 1358 # if !TLS_NO_RSA 1359 /* 1360 ** TMP_RSA_KEY -- return temporary RSA key 1361 ** 1362 ** Parameters: 1363 ** s -- TLS connection structure 1364 ** export -- 1365 ** keylength -- 1366 ** 1367 ** Returns: 1368 ** temporary RSA key. 1369 */ 1370 1371 # ifndef MAX_RSA_TMP_CNT 1372 # define MAX_RSA_TMP_CNT 1000 /* XXX better value? */ 1373 # endif /* ! MAX_RSA_TMP_CNT */ 1374 1375 /* ARGUSED0 */ 1376 static RSA * 1377 tmp_rsa_key(s, export, keylength) 1378 SSL *s; 1379 int export; 1380 int keylength; 1381 { 1382 # if SM_CONF_SHM 1383 extern int ShmId; 1384 extern int *PRSATmpCnt; 1385 1386 if (ShmId != SM_SHM_NO_ID && rsa_tmp != NULL && 1387 ++(*PRSATmpCnt) < MAX_RSA_TMP_CNT) 1388 return rsa_tmp; 1389 # endif /* SM_CONF_SHM */ 1390 1391 if (rsa_tmp != NULL) 1392 RSA_free(rsa_tmp); 1393 rsa_tmp = RSA_generate_key(RSA_KEYLENGTH, RSA_F4, NULL, NULL); 1394 if (rsa_tmp == NULL) 1395 { 1396 if (LogLevel > 0) 1397 sm_syslog(LOG_ERR, NOQID, 1398 "STARTTLS=server, tmp_rsa_key: RSA_generate_key failed!"); 1399 } 1400 else 1401 { 1402 # if SM_CONF_SHM 1403 # if 0 1404 /* 1405 ** XXX we can't (yet) share the new key... 1406 ** The RSA structure contains pointers hence it can't be 1407 ** easily kept in shared memory. It must be transformed 1408 ** into a continous memory region first, then stored, 1409 ** and later read out again (each time re-transformed). 1410 */ 1411 1412 if (ShmId != SM_SHM_NO_ID) 1413 *PRSATmpCnt = 0; 1414 # endif /* 0 */ 1415 # endif /* SM_CONF_SHM */ 1416 if (LogLevel > 9) 1417 sm_syslog(LOG_ERR, NOQID, 1418 "STARTTLS=server, tmp_rsa_key: new temp RSA key"); 1419 } 1420 return rsa_tmp; 1421 } 1422 # endif /* !TLS_NO_RSA */ 1423 /* 1424 ** APPS_SSL_INFO_CB -- info callback for TLS connections 1425 ** 1426 ** Parameters: 1427 ** s -- TLS connection structure 1428 ** where -- state in handshake 1429 ** ret -- return code of last operation 1430 ** 1431 ** Returns: 1432 ** none. 1433 */ 1434 1435 static void 1436 apps_ssl_info_cb(s, where, ret) 1437 CONST097 SSL *s; 1438 int where; 1439 int ret; 1440 { 1441 int w; 1442 char *str; 1443 BIO *bio_err = NULL; 1444 1445 if (LogLevel > 14) 1446 sm_syslog(LOG_INFO, NOQID, 1447 "STARTTLS: info_callback where=0x%x, ret=%d", 1448 where, ret); 1449 1450 w = where & ~SSL_ST_MASK; 1451 if (bio_err == NULL) 1452 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE); 1453 1454 if (bitset(SSL_ST_CONNECT, w)) 1455 str = "SSL_connect"; 1456 else if (bitset(SSL_ST_ACCEPT, w)) 1457 str = "SSL_accept"; 1458 else 1459 str = "undefined"; 1460 1461 if (bitset(SSL_CB_LOOP, where)) 1462 { 1463 if (LogLevel > 12) 1464 sm_syslog(LOG_NOTICE, NOQID, 1465 "STARTTLS: %s:%s", 1466 str, SSL_state_string_long(s)); 1467 } 1468 else if (bitset(SSL_CB_ALERT, where)) 1469 { 1470 str = bitset(SSL_CB_READ, where) ? "read" : "write"; 1471 if (LogLevel > 12) 1472 sm_syslog(LOG_NOTICE, NOQID, 1473 "STARTTLS: SSL3 alert %s:%s:%s", 1474 str, SSL_alert_type_string_long(ret), 1475 SSL_alert_desc_string_long(ret)); 1476 } 1477 else if (bitset(SSL_CB_EXIT, where)) 1478 { 1479 if (ret == 0) 1480 { 1481 if (LogLevel > 7) 1482 sm_syslog(LOG_WARNING, NOQID, 1483 "STARTTLS: %s:failed in %s", 1484 str, SSL_state_string_long(s)); 1485 } 1486 else if (ret < 0) 1487 { 1488 if (LogLevel > 7) 1489 sm_syslog(LOG_WARNING, NOQID, 1490 "STARTTLS: %s:error in %s", 1491 str, SSL_state_string_long(s)); 1492 } 1493 } 1494 } 1495 /* 1496 ** TLS_VERIFY_LOG -- log verify error for TLS certificates 1497 ** 1498 ** Parameters: 1499 ** ok -- verify ok? 1500 ** ctx -- x509 context 1501 ** 1502 ** Returns: 1503 ** 0 -- fatal error 1504 ** 1 -- ok 1505 */ 1506 1507 static int 1508 tls_verify_log(ok, ctx, name) 1509 int ok; 1510 X509_STORE_CTX *ctx; 1511 char *name; 1512 { 1513 SSL *ssl; 1514 X509 *cert; 1515 int reason, depth; 1516 char buf[512]; 1517 1518 cert = X509_STORE_CTX_get_current_cert(ctx); 1519 reason = X509_STORE_CTX_get_error(ctx); 1520 depth = X509_STORE_CTX_get_error_depth(ctx); 1521 ssl = (SSL *) X509_STORE_CTX_get_ex_data(ctx, 1522 SSL_get_ex_data_X509_STORE_CTX_idx()); 1523 1524 if (ssl == NULL) 1525 { 1526 /* internal error */ 1527 sm_syslog(LOG_ERR, NOQID, 1528 "STARTTLS: internal error: tls_verify_cb: ssl == NULL"); 1529 return 0; 1530 } 1531 1532 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof buf); 1533 sm_syslog(LOG_INFO, NOQID, 1534 "STARTTLS: %s cert verify: depth=%d %s, state=%d, reason=%s", 1535 name, depth, buf, ok, X509_verify_cert_error_string(reason)); 1536 return 1; 1537 } 1538 1539 /* 1540 ** TLS_VERIFY_CB -- verify callback for TLS certificates 1541 ** 1542 ** Parameters: 1543 ** ctx -- x509 context 1544 ** 1545 ** Returns: 1546 ** accept connection? 1547 ** currently: always yes. 1548 */ 1549 1550 static int 1551 # if !defined(OPENSSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER < 0x00907000L 1552 tls_verify_cb(ctx) 1553 X509_STORE_CTX *ctx; 1554 # else /* !defined() || OPENSSL_VERSION_NUMBER < 0x00907000L */ 1555 tls_verify_cb(ctx, unused) 1556 X509_STORE_CTX *ctx; 1557 void *unused; 1558 # endif /* !defined() || OPENSSL_VERSION_NUMBER < 0x00907000L */ 1559 { 1560 int ok; 1561 1562 ok = X509_verify_cert(ctx); 1563 if (ok == 0) 1564 { 1565 if (LogLevel > 13) 1566 return tls_verify_log(ok, ctx, "TLS"); 1567 return 1; /* override it */ 1568 } 1569 return ok; 1570 } 1571 /* 1572 ** TLSLOGERR -- log the errors from the TLS error stack 1573 ** 1574 ** Parameters: 1575 ** who -- server/client (for logging). 1576 ** 1577 ** Returns: 1578 ** none. 1579 */ 1580 1581 void 1582 tlslogerr(who) 1583 const char *who; 1584 { 1585 unsigned long l; 1586 int line, flags; 1587 unsigned long es; 1588 char *file, *data; 1589 char buf[256]; 1590 # define CP (const char **) 1591 1592 es = CRYPTO_thread_id(); 1593 while ((l = ERR_get_error_line_data(CP &file, &line, CP &data, &flags)) 1594 != 0) 1595 { 1596 sm_syslog(LOG_WARNING, NOQID, 1597 "STARTTLS=%s: %lu:%s:%s:%d:%s", who, es, 1598 ERR_error_string(l, buf), 1599 file, line, 1600 bitset(ERR_TXT_STRING, flags) ? data : ""); 1601 } 1602 } 1603 1604 # if OPENSSL_VERSION_NUMBER > 0x00907000L 1605 /* 1606 ** X509_VERIFY_CB -- verify callback 1607 ** 1608 ** Parameters: 1609 ** ctx -- x509 context 1610 ** 1611 ** Returns: 1612 ** accept connection? 1613 ** currently: always yes. 1614 */ 1615 1616 static int 1617 x509_verify_cb(ok, ctx) 1618 int ok; 1619 X509_STORE_CTX *ctx; 1620 { 1621 if (ok == 0) 1622 { 1623 if (LogLevel > 13) 1624 tls_verify_log(ok, ctx, "x509"); 1625 if (ctx->error == X509_V_ERR_UNABLE_TO_GET_CRL) 1626 { 1627 ctx->error = 0; 1628 return 1; /* override it */ 1629 } 1630 } 1631 return ok; 1632 } 1633 # endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */ 1634 #endif /* STARTTLS */ 1635