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 #include "ocsp_lcl.h"
  77
  78 /*
  79  * Utility functions related to sending OCSP requests and extracting relevant
  80  * information from the response.
  81  */
  82
  83 /*
  84  * Add an OCSP_CERTID to an OCSP request. Return new OCSP_ONEREQ pointer:
  85  * useful if we want to add extensions.
  86  */
  87
  88 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid)
  89 {
  90     OCSP_ONEREQ *one = NULL;
  91
  92     if (!(one = OCSP_ONEREQ_new()))
  93         goto err;
  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
 110     gen = GENERAL_NAME_new();
 111     if (gen == NULL)
 112         return 0;
 113     if (!X509_NAME_set(&gen->d.directoryName, nm)) {
 114         GENERAL_NAME_free(gen);
 115         return 0;
 116     }
 117     gen->type = GEN_DIRNAME;
 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     X509 *x;
 158
 159     if (!OCSP_request_set1_name(req, X509_get_subject_name(signer)))
 160         goto err;
 161
 162     if (!(req->optionalSignature = OCSP_SIGNATURE_new()))
 163         goto err;
 164     if (key) {
 165         if (!X509_check_private_key(signer, key)) {
 166             OCSPerr(OCSP_F_OCSP_REQUEST_SIGN,
 167                     OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE);
 168             goto err;
 169         }
 170         if (!OCSP_REQUEST_sign(req, key, dgst))
 171             goto err;
 172     }
 173
 174     if (!(flags & OCSP_NOCERTS)) {
 175         if (!OCSP_request_add1_cert(req, signer))
 176             goto err;
 177         for (i = 0; i < sk_X509_num(certs); i++) {
 178             x = sk_X509_value(certs, i);
 179             if (!OCSP_request_add1_cert(req, x))
 180                 goto err;
 181         }
 182     }
 183
 184     return 1;
 185  err:
 186     OCSP_SIGNATURE_free(req->optionalSignature);
 187     req->optionalSignature = NULL;
 188     return 0;
 189 }
 190
 191 /* Get response status */
 192
 193 int OCSP_response_status(OCSP_RESPONSE *resp)
 194 {
 195     return ASN1_ENUMERATED_get(resp->responseStatus);
 196 }
 197
 198 /*
 199  * Extract basic response from OCSP_RESPONSE or NULL if no basic response
 200  * present.
 201  */
 202
 203 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp)
 204 {
 205     OCSP_RESPBYTES *rb;
 206     rb = resp->responseBytes;
 207     if (!rb) {
 208         OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NO_RESPONSE_DATA);
 209         return NULL;
 210     }
 211     if (OBJ_obj2nid(rb->responseType) != NID_id_pkix_OCSP_basic) {
 212         OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NOT_BASIC_RESPONSE);
 213         return NULL;
 214     }
 215
 216     return ASN1_item_unpack(rb->response, ASN1_ITEM_rptr(OCSP_BASICRESP));
 217 }
 218
 219 ASN1_OCTET_STRING *OCSP_resp_get0_signature(OCSP_BASICRESP *bs)
 220 {
 221     return bs->signature;
 222 }
 223
 224 /*
 225  * Return number of OCSP_SINGLERESP reponses present in a basic response.
 226  */
 227
 228 int OCSP_resp_count(OCSP_BASICRESP *bs)
 229 {
 230     if (!bs)
 231         return -1;
 232     return sk_OCSP_SINGLERESP_num(bs->tbsResponseData->responses);
 233 }
 234
 235 /* Extract an OCSP_SINGLERESP response with a given index */
 236
 237 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx)
 238 {
 239     if (!bs)
 240         return NULL;
 241     return sk_OCSP_SINGLERESP_value(bs->tbsResponseData->responses, idx);
 242 }
 243
 244 /* Look single response matching a given certificate ID */
 245
 246 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last)
 247 {
 248     int i;
 249     STACK_OF(OCSP_SINGLERESP) *sresp;
 250     OCSP_SINGLERESP *single;
 251     if (!bs)
 252         return -1;
 253     if (last < 0)
 254         last = 0;
 255     else
 256         last++;
 257     sresp = bs->tbsResponseData->responses;
 258     for (i = last; i < sk_OCSP_SINGLERESP_num(sresp); i++) {
 259         single = sk_OCSP_SINGLERESP_value(sresp, i);
 260         if (!OCSP_id_cmp(id, single->certId))
 261             return i;
 262     }
 263     return -1;
 264 }
 265
 266 /*
 267  * Extract status information from an OCSP_SINGLERESP structure. Note: the
 268  * revtime and reason values are only set if the certificate status is
 269  * revoked. Returns numerical value of status.
 270  */
 271
 272 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
 273                             ASN1_GENERALIZEDTIME **revtime,
 274                             ASN1_GENERALIZEDTIME **thisupd,
 275                             ASN1_GENERALIZEDTIME **nextupd)
 276 {
 277     int ret;
 278     OCSP_CERTSTATUS *cst;
 279     if (!single)
 280         return -1;
 281     cst = single->certStatus;
 282     ret = cst->type;
 283     if (ret == V_OCSP_CERTSTATUS_REVOKED) {
 284         OCSP_REVOKEDINFO *rev = cst->value.revoked;
 285         if (revtime)
 286             *revtime = rev->revocationTime;
 287         if (reason) {
 288             if (rev->revocationReason)
 289                 *reason = ASN1_ENUMERATED_get(rev->revocationReason);
 290             else
 291                 *reason = -1;
 292         }
 293     }
 294     if (thisupd)
 295         *thisupd = single->thisUpdate;
 296     if (nextupd)
 297         *nextupd = single->nextUpdate;
 298     return ret;
 299 }
 300
 301 /*
 302  * This function combines the previous ones: look up a certificate ID and if
 303  * found extract status information. Return 0 is successful.
 304  */
 305
 306 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
 307                           int *reason,
 308                           ASN1_GENERALIZEDTIME **revtime,
 309                           ASN1_GENERALIZEDTIME **thisupd,
 310                           ASN1_GENERALIZEDTIME **nextupd)
 311 {
 312     int i;
 313     OCSP_SINGLERESP *single;
 314     i = OCSP_resp_find(bs, id, -1);
 315     /* Maybe check for multiple responses and give an error? */
 316     if (i < 0)
 317         return 0;
 318     single = OCSP_resp_get0(bs, i);
 319     i = OCSP_single_get0_status(single, reason, revtime, thisupd, nextupd);
 320     if (status)
 321         *status = i;
 322     return 1;
 323 }
 324
 325 /*
 326  * Check validity of thisUpdate and nextUpdate fields. It is possible that
 327  * the request will take a few seconds to process and/or the time wont be
 328  * totally accurate. Therefore to avoid rejecting otherwise valid time we
 329  * allow the times to be within 'nsec' of the current time. Also to avoid
 330  * accepting very old responses without a nextUpdate field an optional maxage
 331  * parameter specifies the maximum age the thisUpdate field can be.
 332  */
 333
 334 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
 335                         ASN1_GENERALIZEDTIME *nextupd, long nsec, long maxsec)
 336 {
 337     int ret = 1;
 338     time_t t_now, t_tmp;
 339     time(&t_now);
 340     /* Check thisUpdate is valid and not more than nsec in the future */
 341     if (!ASN1_GENERALIZEDTIME_check(thisupd)) {
 342         OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_THISUPDATE_FIELD);
 343         ret = 0;
 344     } else {
 345         t_tmp = t_now + nsec;
 346         if (X509_cmp_time(thisupd, &t_tmp) > 0) {
 347             OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_NOT_YET_VALID);
 348             ret = 0;
 349         }
 350
 351         /*
 352          * If maxsec specified check thisUpdate is not more than maxsec in
 353          * the past
 354          */
 355         if (maxsec >= 0) {
 356             t_tmp = t_now - maxsec;
 357             if (X509_cmp_time(thisupd, &t_tmp) < 0) {
 358                 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_TOO_OLD);
 359                 ret = 0;
 360             }
 361         }
 362     }
 363
 364     if (!nextupd)
 365         return ret;
 366
 367     /* Check nextUpdate is valid and not more than nsec in the past */
 368     if (!ASN1_GENERALIZEDTIME_check(nextupd)) {
 369         OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_NEXTUPDATE_FIELD);
 370         ret = 0;
 371     } else {
 372         t_tmp = t_now - nsec;
 373         if (X509_cmp_time(nextupd, &t_tmp) < 0) {
 374             OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_EXPIRED);
 375             ret = 0;
 376         }
 377     }
 378
 379     /* Also don't allow nextUpdate to precede thisUpdate */
 380     if (ASN1_STRING_cmp(nextupd, thisupd) < 0) {
 381         OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
 382                 OCSP_R_NEXTUPDATE_BEFORE_THISUPDATE);
 383         ret = 0;
 384     }
 385
 386     return ret;
 387 }