3 * Written by Tom Titchener <Tom_Titchener@groove.net> for the OpenSSL
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
13 /* ====================================================================
14 * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
42 * 6. Redistributions of any form whatsoever must retain the following
44 * "This product includes software developed by the OpenSSL Project
45 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
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>
78 * Utility functions related to sending OCSP requests and extracting relevant
79 * information from the response.
83 * Add an OCSP_CERTID to an OCSP request. Return new OCSP_ONEREQ pointer:
84 * useful if we want to add extensions.
87 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid)
89 OCSP_ONEREQ *one = NULL;
91 if (!(one = OCSP_ONEREQ_new()))
94 OCSP_CERTID_free(one->reqCert);
96 if (req && !sk_OCSP_ONEREQ_push(req->tbsRequest->requestList, one)) {
97 one->reqCert = NULL; /* do not free on error */
102 OCSP_ONEREQ_free(one);
106 /* Set requestorName from an X509_NAME structure */
108 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm)
111 gen = GENERAL_NAME_new();
114 if (!X509_NAME_set(&gen->d.directoryName, nm)) {
115 GENERAL_NAME_free(gen);
118 gen->type = GEN_DIRNAME;
119 if (req->tbsRequest->requestorName)
120 GENERAL_NAME_free(req->tbsRequest->requestorName);
121 req->tbsRequest->requestorName = gen;
125 /* Add a certificate to an OCSP request */
127 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert)
130 if (!req->optionalSignature)
131 req->optionalSignature = OCSP_SIGNATURE_new();
132 sig = req->optionalSignature;
137 if (!sig->certs && !(sig->certs = sk_X509_new_null()))
140 if (!sk_X509_push(sig->certs, cert))
142 CRYPTO_add(&cert->references, 1, CRYPTO_LOCK_X509);
147 * Sign an OCSP request set the requestorName to the subjec name of an
148 * optional signers certificate and include one or more optional certificates
149 * in the request. Behaves like PKCS7_sign().
152 int OCSP_request_sign(OCSP_REQUEST *req,
156 STACK_OF(X509) *certs, unsigned long flags)
162 if (!OCSP_request_set1_name(req, X509_get_subject_name(signer)))
165 if (!(req->optionalSignature = sig = OCSP_SIGNATURE_new()))
168 if (!X509_check_private_key(signer, key)) {
169 OCSPerr(OCSP_F_OCSP_REQUEST_SIGN,
170 OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE);
173 if (!OCSP_REQUEST_sign(req, key, dgst))
177 if (!(flags & OCSP_NOCERTS)) {
178 if (!OCSP_request_add1_cert(req, signer))
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))
189 OCSP_SIGNATURE_free(req->optionalSignature);
190 req->optionalSignature = NULL;
194 /* Get response status */
196 int OCSP_response_status(OCSP_RESPONSE *resp)
198 return ASN1_ENUMERATED_get(resp->responseStatus);
202 * Extract basic response from OCSP_RESPONSE or NULL if no basic response
206 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp)
209 rb = resp->responseBytes;
211 OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NO_RESPONSE_DATA);
214 if (OBJ_obj2nid(rb->responseType) != NID_id_pkix_OCSP_basic) {
215 OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NOT_BASIC_RESPONSE);
219 return ASN1_item_unpack(rb->response, ASN1_ITEM_rptr(OCSP_BASICRESP));
223 * Return number of OCSP_SINGLERESP reponses present in a basic response.
226 int OCSP_resp_count(OCSP_BASICRESP *bs)
230 return sk_OCSP_SINGLERESP_num(bs->tbsResponseData->responses);
233 /* Extract an OCSP_SINGLERESP response with a given index */
235 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx)
239 return sk_OCSP_SINGLERESP_value(bs->tbsResponseData->responses, idx);
242 /* Look single response matching a given certificate ID */
244 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last)
247 STACK_OF(OCSP_SINGLERESP) *sresp;
248 OCSP_SINGLERESP *single;
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))
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.
270 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
271 ASN1_GENERALIZEDTIME **revtime,
272 ASN1_GENERALIZEDTIME **thisupd,
273 ASN1_GENERALIZEDTIME **nextupd)
276 OCSP_CERTSTATUS *cst;
279 cst = single->certStatus;
281 if (ret == V_OCSP_CERTSTATUS_REVOKED) {
282 OCSP_REVOKEDINFO *rev = cst->value.revoked;
284 *revtime = rev->revocationTime;
286 if (rev->revocationReason)
287 *reason = ASN1_ENUMERATED_get(rev->revocationReason);
293 *thisupd = single->thisUpdate;
295 *nextupd = single->nextUpdate;
300 * This function combines the previous ones: look up a certificate ID and if
301 * found extract status information. Return 0 is successful.
304 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
306 ASN1_GENERALIZEDTIME **revtime,
307 ASN1_GENERALIZEDTIME **thisupd,
308 ASN1_GENERALIZEDTIME **nextupd)
311 OCSP_SINGLERESP *single;
312 i = OCSP_resp_find(bs, id, -1);
313 /* Maybe check for multiple responses and give an error? */
316 single = OCSP_resp_get0(bs, i);
317 i = OCSP_single_get0_status(single, reason, revtime, thisupd, nextupd);
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.
332 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
333 ASN1_GENERALIZEDTIME *nextupd, long nsec, long maxsec)
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);
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);
350 * If maxsec specified check thisUpdate is not more than maxsec in
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);
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);
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);
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);