crypto/openssl/crypto/ocsp/ocsp_cl.c

   1 /* ocsp_cl.c */
   2 /*
   3  * Written by Tom Titchener <Tom_Titchener@groove.net> for the OpenSSL
   4  * project.
   5  */
   6
   7 /*
   8  * History: This file was transfered to Richard Levitte from CertCo by Kathy
   9  * Weinhold in mid-spring 2000 to be included in OpenSSL or released as a
  10  * patch kit.
  11  */
  12
  13 /* ====================================================================
  14  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  *
  20  * 1. Redistributions of source code must retain the above copyright
  21  *    notice, this list of conditions and the following disclaimer.
  22  *
  23  * 2. Redistributions in binary form must reproduce the above copyright
  24  *    notice, this list of conditions and the following disclaimer in
  25  *    the documentation and/or other materials provided with the
  26  *    distribution.
  27  *
  28  * 3. All advertising materials mentioning features or use of this
  29  *    software must display the following acknowledgment:
  30  *    "This product includes software developed by the OpenSSL Project
  31  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  32  *
  33  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  34  *    endorse or promote products derived from this software without
  35  *    prior written permission. For written permission, please contact
  36  *    openssl-core@openssl.org.
  37  *
  38  * 5. Products derived from this software may not be called "OpenSSL"
  39  *    nor may "OpenSSL" appear in their names without prior written
  40  *    permission of the OpenSSL Project.
  41  *
  42  * 6. Redistributions of any form whatsoever must retain the following
  43  *    acknowledgment:
  44  *    "This product includes software developed by the OpenSSL Project
  45  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  48  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  50  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  51  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  52  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  53  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  54  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  56  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  57  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  58  * OF THE POSSIBILITY OF SUCH DAMAGE.
  59  * ====================================================================
  60  *
  61  * This product includes cryptographic software written by Eric Young
  62  * (eay@cryptsoft.com).  This product includes software written by Tim
  63  * Hudson (tjh@cryptsoft.com).
  64  *
  65  */
  66
  67 #include <stdio.h>
  68 #include <time.h>
  69 #include <cryptlib.h>
  70 #include <openssl/objects.h>
  71 #include <openssl/rand.h>
  72 #include <openssl/x509.h>
  73 #include <openssl/pem.h>
  74 #include <openssl/x509v3.h>
  75 #include <openssl/ocsp.h>
  76
  77 /*
  78  * Utility functions related to sending OCSP requests and extracting relevant
  79  * information from the response.
  80  */
  81
  82 /*
  83  * Add an OCSP_CERTID to an OCSP request. Return new OCSP_ONEREQ pointer:
  84  * useful if we want to add extensions.
  85  */
  86
  87 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid)
  88 {
  89     OCSP_ONEREQ *one = NULL;
  90
  91     if (!(one = OCSP_ONEREQ_new()))
  92         goto err;
  93     if (one->reqCert)
  94         OCSP_CERTID_free(one->reqCert);
  95     one->reqCert = cid;
  96     if (req && !sk_OCSP_ONEREQ_push(req->tbsRequest->requestList, one))
  97         goto err;
  98     return one;
  99  err:
 100     OCSP_ONEREQ_free(one);
 101     return NULL;
 102 }
 103
 104 /* Set requestorName from an X509_NAME structure */
 105
 106 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm)
 107 {
 108     GENERAL_NAME *gen;
 109     gen = GENERAL_NAME_new();
 110     if (gen == NULL)
 111         return 0;
 112     if (!X509_NAME_set(&gen->d.directoryName, nm)) {
 113         GENERAL_NAME_free(gen);
 114         return 0;
 115     }
 116     gen->type = GEN_DIRNAME;
 117     if (req->tbsRequest->requestorName)
 118         GENERAL_NAME_free(req->tbsRequest->requestorName);
 119     req->tbsRequest->requestorName = gen;
 120     return 1;
 121 }
 122
 123 /* Add a certificate to an OCSP request */
 124
 125 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert)
 126 {
 127     OCSP_SIGNATURE *sig;
 128     if (!req->optionalSignature)
 129         req->optionalSignature = OCSP_SIGNATURE_new();
 130     sig = req->optionalSignature;
 131     if (!sig)
 132         return 0;
 133     if (!cert)
 134         return 1;
 135     if (!sig->certs && !(sig->certs = sk_X509_new_null()))
 136         return 0;
 137
 138     if (!sk_X509_push(sig->certs, cert))
 139         return 0;
 140     CRYPTO_add(&cert->references, 1, CRYPTO_LOCK_X509);
 141     return 1;
 142 }
 143
 144 /*
 145  * Sign an OCSP request set the requestorName to the subjec name of an
 146  * optional signers certificate and include one or more optional certificates
 147  * in the request. Behaves like PKCS7_sign().
 148  */
 149
 150 int OCSP_request_sign(OCSP_REQUEST *req,
 151                       X509 *signer,
 152                       EVP_PKEY *key,
 153                       const EVP_MD *dgst,
 154                       STACK_OF(X509) *certs, unsigned long flags)
 155 {
 156     int i;
 157     OCSP_SIGNATURE *sig;
 158     X509 *x;
 159
 160     if (!OCSP_request_set1_name(req, X509_get_subject_name(signer)))
 161         goto err;
 162
 163     if (!(req->optionalSignature = sig = OCSP_SIGNATURE_new()))
 164         goto err;
 165     if (!dgst)
 166         dgst = EVP_sha1();
 167     if (key) {
 168         if (!X509_check_private_key(signer, key)) {
 169             OCSPerr(OCSP_F_OCSP_REQUEST_SIGN,
 170                     OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE);
 171             goto err;
 172         }
 173         if (!OCSP_REQUEST_sign(req, key, dgst))
 174             goto err;
 175     }
 176
 177     if (!(flags & OCSP_NOCERTS)) {
 178         if (!OCSP_request_add1_cert(req, signer))
 179             goto err;
 180         for (i = 0; i < sk_X509_num(certs); i++) {
 181             x = sk_X509_value(certs, i);
 182             if (!OCSP_request_add1_cert(req, x))
 183                 goto err;
 184         }
 185     }
 186
 187     return 1;
 188  err:
 189     OCSP_SIGNATURE_free(req->optionalSignature);
 190     req->optionalSignature = NULL;
 191     return 0;
 192 }
 193
 194 /* Get response status */
 195
 196 int OCSP_response_status(OCSP_RESPONSE *resp)
 197 {
 198     return ASN1_ENUMERATED_get(resp->responseStatus);
 199 }
 200
 201 /*
 202  * Extract basic response from OCSP_RESPONSE or NULL if no basic response
 203  * present.
 204  */
 205
 206 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp)
 207 {
 208     OCSP_RESPBYTES *rb;
 209     rb = resp->responseBytes;
 210     if (!rb) {
 211         OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NO_RESPONSE_DATA);
 212         return NULL;
 213     }
 214     if (OBJ_obj2nid(rb->responseType) != NID_id_pkix_OCSP_basic) {
 215         OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NOT_BASIC_RESPONSE);
 216         return NULL;
 217     }
 218
 219     return ASN1_item_unpack(rb->response, ASN1_ITEM_rptr(OCSP_BASICRESP));
 220 }
 221
 222 /*
 223  * Return number of OCSP_SINGLERESP reponses present in a basic response.
 224  */
 225
 226 int OCSP_resp_count(OCSP_BASICRESP *bs)
 227 {
 228     if (!bs)
 229         return -1;
 230     return sk_OCSP_SINGLERESP_num(bs->tbsResponseData->responses);
 231 }
 232
 233 /* Extract an OCSP_SINGLERESP response with a given index */
 234
 235 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx)
 236 {
 237     if (!bs)
 238         return NULL;
 239     return sk_OCSP_SINGLERESP_value(bs->tbsResponseData->responses, idx);
 240 }
 241
 242 /* Look single response matching a given certificate ID */
 243
 244 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last)
 245 {
 246     int i;
 247     STACK_OF(OCSP_SINGLERESP) *sresp;
 248     OCSP_SINGLERESP *single;
 249     if (!bs)
 250         return -1;
 251     if (last < 0)
 252         last = 0;
 253     else
 254         last++;
 255     sresp = bs->tbsResponseData->responses;
 256     for (i = last; i < sk_OCSP_SINGLERESP_num(sresp); i++) {
 257         single = sk_OCSP_SINGLERESP_value(sresp, i);
 258         if (!OCSP_id_cmp(id, single->certId))
 259             return i;
 260     }
 261     return -1;
 262 }
 263
 264 /*
 265  * Extract status information from an OCSP_SINGLERESP structure. Note: the
 266  * revtime and reason values are only set if the certificate status is
 267  * revoked. Returns numerical value of status.
 268  */
 269
 270 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
 271                             ASN1_GENERALIZEDTIME **revtime,
 272                             ASN1_GENERALIZEDTIME **thisupd,
 273                             ASN1_GENERALIZEDTIME **nextupd)
 274 {
 275     int ret;
 276     OCSP_CERTSTATUS *cst;
 277     if (!single)
 278         return -1;
 279     cst = single->certStatus;
 280     ret = cst->type;
 281     if (ret == V_OCSP_CERTSTATUS_REVOKED) {
 282         OCSP_REVOKEDINFO *rev = cst->value.revoked;
 283         if (revtime)
 284             *revtime = rev->revocationTime;
 285         if (reason) {
 286             if (rev->revocationReason)
 287                 *reason = ASN1_ENUMERATED_get(rev->revocationReason);
 288             else
 289                 *reason = -1;
 290         }
 291     }
 292     if (thisupd)
 293         *thisupd = single->thisUpdate;
 294     if (nextupd)
 295         *nextupd = single->nextUpdate;
 296     return ret;
 297 }
 298
 299 /*
 300  * This function combines the previous ones: look up a certificate ID and if
 301  * found extract status information. Return 0 is successful.
 302  */
 303
 304 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
 305                           int *reason,
 306                           ASN1_GENERALIZEDTIME **revtime,
 307                           ASN1_GENERALIZEDTIME **thisupd,
 308                           ASN1_GENERALIZEDTIME **nextupd)
 309 {
 310     int i;
 311     OCSP_SINGLERESP *single;
 312     i = OCSP_resp_find(bs, id, -1);
 313     /* Maybe check for multiple responses and give an error? */
 314     if (i < 0)
 315         return 0;
 316     single = OCSP_resp_get0(bs, i);
 317     i = OCSP_single_get0_status(single, reason, revtime, thisupd, nextupd);
 318     if (status)
 319         *status = i;
 320     return 1;
 321 }
 322
 323 /*
 324  * Check validity of thisUpdate and nextUpdate fields. It is possible that
 325  * the request will take a few seconds to process and/or the time wont be
 326  * totally accurate. Therefore to avoid rejecting otherwise valid time we
 327  * allow the times to be within 'nsec' of the current time. Also to avoid
 328  * accepting very old responses without a nextUpdate field an optional maxage
 329  * parameter specifies the maximum age the thisUpdate field can be.
 330  */
 331
 332 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
 333                         ASN1_GENERALIZEDTIME *nextupd, long nsec, long maxsec)
 334 {
 335     int ret = 1;
 336     time_t t_now, t_tmp;
 337     time(&t_now);
 338     /* Check thisUpdate is valid and not more than nsec in the future */
 339     if (!ASN1_GENERALIZEDTIME_check(thisupd)) {
 340         OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_THISUPDATE_FIELD);
 341         ret = 0;
 342     } else {
 343         t_tmp = t_now + nsec;
 344         if (X509_cmp_time(thisupd, &t_tmp) > 0) {
 345             OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_NOT_YET_VALID);
 346             ret = 0;
 347         }
 348
 349         /*
 350          * If maxsec specified check thisUpdate is not more than maxsec in
 351          * the past
 352          */
 353         if (maxsec >= 0) {
 354             t_tmp = t_now - maxsec;
 355             if (X509_cmp_time(thisupd, &t_tmp) < 0) {
 356                 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_TOO_OLD);
 357                 ret = 0;
 358             }
 359         }
 360     }
 361
 362     if (!nextupd)
 363         return ret;
 364
 365     /* Check nextUpdate is valid and not more than nsec in the past */
 366     if (!ASN1_GENERALIZEDTIME_check(nextupd)) {
 367         OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_NEXTUPDATE_FIELD);
 368         ret = 0;
 369     } else {
 370         t_tmp = t_now - nsec;
 371         if (X509_cmp_time(nextupd, &t_tmp) < 0) {
 372             OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_EXPIRED);
 373             ret = 0;
 374         }
 375     }
 376
 377     /* Also don't allow nextUpdate to precede thisUpdate */
 378     if (ASN1_STRING_cmp(nextupd, thisupd) < 0) {
 379         OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
 380                 OCSP_R_NEXTUPDATE_BEFORE_THISUPDATE);
 381         ret = 0;
 382     }
 383
 384     return ret;
 385 }