2 * Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include "internal/cryptlib.h"
13 #include <openssl/asn1.h>
14 #include <openssl/objects.h>
15 #include <openssl/x509.h>
16 #include <openssl/pem.h>
17 #include <openssl/x509v3.h>
18 #include <openssl/ocsp.h>
22 * Utility functions related to sending OCSP requests and extracting relevant
23 * information from the response.
27 * Add an OCSP_CERTID to an OCSP request. Return new OCSP_ONEREQ pointer:
28 * useful if we want to add extensions.
31 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid)
33 OCSP_ONEREQ *one = NULL;
35 if ((one = OCSP_ONEREQ_new()) == NULL)
37 OCSP_CERTID_free(one->reqCert);
39 if (req && !sk_OCSP_ONEREQ_push(req->tbsRequest.requestList, one)) {
40 one->reqCert = NULL; /* do not free on error */
45 OCSP_ONEREQ_free(one);
49 /* Set requestorName from an X509_NAME structure */
51 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm)
55 gen = GENERAL_NAME_new();
58 if (!X509_NAME_set(&gen->d.directoryName, nm)) {
59 GENERAL_NAME_free(gen);
62 gen->type = GEN_DIRNAME;
63 GENERAL_NAME_free(req->tbsRequest.requestorName);
64 req->tbsRequest.requestorName = gen;
68 /* Add a certificate to an OCSP request */
70 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert)
73 if (req->optionalSignature == NULL)
74 req->optionalSignature = OCSP_SIGNATURE_new();
75 sig = req->optionalSignature;
80 if (sig->certs == NULL
81 && (sig->certs = sk_X509_new_null()) == NULL)
84 if (!sk_X509_push(sig->certs, cert))
91 * Sign an OCSP request set the requestorName to the subject name of an
92 * optional signers certificate and include one or more optional certificates
93 * in the request. Behaves like PKCS7_sign().
96 int OCSP_request_sign(OCSP_REQUEST *req,
100 STACK_OF(X509) *certs, unsigned long flags)
105 if (!OCSP_request_set1_name(req, X509_get_subject_name(signer)))
108 if ((req->optionalSignature = OCSP_SIGNATURE_new()) == NULL)
111 if (!X509_check_private_key(signer, key)) {
112 OCSPerr(OCSP_F_OCSP_REQUEST_SIGN,
113 OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE);
116 if (!OCSP_REQUEST_sign(req, key, dgst))
120 if (!(flags & OCSP_NOCERTS)) {
121 if (!OCSP_request_add1_cert(req, signer))
123 for (i = 0; i < sk_X509_num(certs); i++) {
124 x = sk_X509_value(certs, i);
125 if (!OCSP_request_add1_cert(req, x))
132 OCSP_SIGNATURE_free(req->optionalSignature);
133 req->optionalSignature = NULL;
137 /* Get response status */
139 int OCSP_response_status(OCSP_RESPONSE *resp)
141 return ASN1_ENUMERATED_get(resp->responseStatus);
145 * Extract basic response from OCSP_RESPONSE or NULL if no basic response
149 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp)
152 rb = resp->responseBytes;
154 OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NO_RESPONSE_DATA);
157 if (OBJ_obj2nid(rb->responseType) != NID_id_pkix_OCSP_basic) {
158 OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NOT_BASIC_RESPONSE);
162 return ASN1_item_unpack(rb->response, ASN1_ITEM_rptr(OCSP_BASICRESP));
165 const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs)
167 return bs->signature;
171 * Return number of OCSP_SINGLERESP responses present in a basic response.
174 int OCSP_resp_count(OCSP_BASICRESP *bs)
178 return sk_OCSP_SINGLERESP_num(bs->tbsResponseData.responses);
181 /* Extract an OCSP_SINGLERESP response with a given index */
183 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx)
187 return sk_OCSP_SINGLERESP_value(bs->tbsResponseData.responses, idx);
190 const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(const OCSP_BASICRESP* bs)
192 return bs->tbsResponseData.producedAt;
195 const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs)
200 int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
201 const ASN1_OCTET_STRING **pid,
202 const X509_NAME **pname)
204 const OCSP_RESPID *rid = &bs->tbsResponseData.responderId;
206 if (rid->type == V_OCSP_RESPID_NAME) {
207 *pname = rid->value.byName;
209 } else if (rid->type == V_OCSP_RESPID_KEY) {
210 *pid = rid->value.byKey;
218 int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
219 ASN1_OCTET_STRING **pid,
222 const OCSP_RESPID *rid = &bs->tbsResponseData.responderId;
224 if (rid->type == V_OCSP_RESPID_NAME) {
225 *pname = X509_NAME_dup(rid->value.byName);
227 } else if (rid->type == V_OCSP_RESPID_KEY) {
228 *pid = ASN1_OCTET_STRING_dup(rid->value.byKey);
233 if (*pname == NULL && *pid == NULL)
238 /* Look single response matching a given certificate ID */
240 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last)
243 STACK_OF(OCSP_SINGLERESP) *sresp;
244 OCSP_SINGLERESP *single;
251 sresp = bs->tbsResponseData.responses;
252 for (i = last; i < sk_OCSP_SINGLERESP_num(sresp); i++) {
253 single = sk_OCSP_SINGLERESP_value(sresp, i);
254 if (!OCSP_id_cmp(id, single->certId))
261 * Extract status information from an OCSP_SINGLERESP structure. Note: the
262 * revtime and reason values are only set if the certificate status is
263 * revoked. Returns numerical value of status.
266 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
267 ASN1_GENERALIZEDTIME **revtime,
268 ASN1_GENERALIZEDTIME **thisupd,
269 ASN1_GENERALIZEDTIME **nextupd)
272 OCSP_CERTSTATUS *cst;
275 cst = single->certStatus;
277 if (ret == V_OCSP_CERTSTATUS_REVOKED) {
278 OCSP_REVOKEDINFO *rev = cst->value.revoked;
280 *revtime = rev->revocationTime;
282 if (rev->revocationReason)
283 *reason = ASN1_ENUMERATED_get(rev->revocationReason);
289 *thisupd = single->thisUpdate;
291 *nextupd = single->nextUpdate;
296 * This function combines the previous ones: look up a certificate ID and if
297 * found extract status information. Return 0 is successful.
300 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
302 ASN1_GENERALIZEDTIME **revtime,
303 ASN1_GENERALIZEDTIME **thisupd,
304 ASN1_GENERALIZEDTIME **nextupd)
307 OCSP_SINGLERESP *single;
308 i = OCSP_resp_find(bs, id, -1);
309 /* Maybe check for multiple responses and give an error? */
312 single = OCSP_resp_get0(bs, i);
313 i = OCSP_single_get0_status(single, reason, revtime, thisupd, nextupd);
320 * Check validity of thisUpdate and nextUpdate fields. It is possible that
321 * the request will take a few seconds to process and/or the time won't be
322 * totally accurate. Therefore to avoid rejecting otherwise valid time we
323 * allow the times to be within 'nsec' of the current time. Also to avoid
324 * accepting very old responses without a nextUpdate field an optional maxage
325 * parameter specifies the maximum age the thisUpdate field can be.
328 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
329 ASN1_GENERALIZEDTIME *nextupd, long nsec, long maxsec)
334 /* Check thisUpdate is valid and not more than nsec in the future */
335 if (!ASN1_GENERALIZEDTIME_check(thisupd)) {
336 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_THISUPDATE_FIELD);
339 t_tmp = t_now + nsec;
340 if (X509_cmp_time(thisupd, &t_tmp) > 0) {
341 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_NOT_YET_VALID);
346 * If maxsec specified check thisUpdate is not more than maxsec in
350 t_tmp = t_now - maxsec;
351 if (X509_cmp_time(thisupd, &t_tmp) < 0) {
352 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_TOO_OLD);
361 /* Check nextUpdate is valid and not more than nsec in the past */
362 if (!ASN1_GENERALIZEDTIME_check(nextupd)) {
363 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_NEXTUPDATE_FIELD);
366 t_tmp = t_now - nsec;
367 if (X509_cmp_time(nextupd, &t_tmp) < 0) {
368 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_EXPIRED);
373 /* Also don't allow nextUpdate to precede thisUpdate */
374 if (ASN1_STRING_cmp(nextupd, thisupd) < 0) {
375 OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
376 OCSP_R_NEXTUPDATE_BEFORE_THISUPDATE);
383 const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *single)
385 return single->certId;