contrib/sendmail/src/tls.c

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