1 /* $OpenBSD: ocsp_ext.c,v 1.18 2018/05/14 23:47:10 tb Exp $ */
2 /* Written by Tom Titchener <Tom_Titchener@groove.net> for the OpenSSL
6 This file was transfered to Richard Levitte from CertCo by Kathy
7 Weinhold in mid-spring 2000 to be included in OpenSSL or released
10 /* ====================================================================
11 * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
25 * 3. All advertising materials mentioning features or use of this
26 * software must display the following acknowledgment:
27 * "This product includes software developed by the OpenSSL Project
28 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
30 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
31 * endorse or promote products derived from this software without
32 * prior written permission. For written permission, please contact
33 * openssl-core@openssl.org.
35 * 5. Products derived from this software may not be called "OpenSSL"
36 * nor may "OpenSSL" appear in their names without prior written
37 * permission of the OpenSSL Project.
39 * 6. Redistributions of any form whatsoever must retain the following
41 * "This product includes software developed by the OpenSSL Project
42 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
44 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
45 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
47 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
48 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
51 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
53 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
55 * OF THE POSSIBILITY OF SUCH DAMAGE.
56 * ====================================================================
58 * This product includes cryptographic software written by Eric Young
59 * (eay@cryptsoft.com). This product includes software written by Tim
60 * Hudson (tjh@cryptsoft.com).
68 #include <openssl/objects.h>
69 #include <openssl/ocsp.h>
70 #include <openssl/x509.h>
71 #include <openssl/x509v3.h>
73 /* Standard wrapper functions for extensions */
75 /* OCSP request extensions */
78 OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x)
80 return X509v3_get_ext_count(x->tbsRequest->requestExtensions);
84 OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos)
86 return X509v3_get_ext_by_NID(x->tbsRequest->requestExtensions, nid,
91 OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
94 return X509v3_get_ext_by_OBJ(x->tbsRequest->requestExtensions, obj,
99 OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos)
101 return X509v3_get_ext_by_critical(x->tbsRequest->requestExtensions,
106 OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc)
108 return X509v3_get_ext(x->tbsRequest->requestExtensions, loc);
112 OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc)
114 return X509v3_delete_ext(x->tbsRequest->requestExtensions, loc);
118 OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit, int *idx)
120 return X509V3_get_d2i(x->tbsRequest->requestExtensions, nid, crit, idx);
124 OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
127 return X509V3_add1_i2d(&x->tbsRequest->requestExtensions, nid, value,
132 OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc)
134 return X509v3_add_ext(&(x->tbsRequest->requestExtensions), ex,
138 /* Single extensions */
141 OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x)
143 return X509v3_get_ext_count(x->singleRequestExtensions);
147 OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos)
149 return X509v3_get_ext_by_NID(x->singleRequestExtensions, nid, lastpos);
153 OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj, int lastpos)
155 return X509v3_get_ext_by_OBJ(x->singleRequestExtensions, obj, lastpos);
159 OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos)
161 return X509v3_get_ext_by_critical(x->singleRequestExtensions, crit,
166 OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc)
168 return X509v3_get_ext(x->singleRequestExtensions, loc);
172 OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc)
174 return X509v3_delete_ext(x->singleRequestExtensions, loc);
178 OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx)
180 return X509V3_get_d2i(x->singleRequestExtensions, nid, crit, idx);
184 OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
187 return X509V3_add1_i2d(&x->singleRequestExtensions, nid, value, crit,
192 OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc)
194 return X509v3_add_ext(&(x->singleRequestExtensions), ex, loc) != NULL;
197 /* OCSP Basic response */
200 OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x)
202 return X509v3_get_ext_count(x->tbsResponseData->responseExtensions);
206 OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos)
208 return X509v3_get_ext_by_NID(x->tbsResponseData->responseExtensions,
213 OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
216 return X509v3_get_ext_by_OBJ(x->tbsResponseData->responseExtensions,
221 OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit, int lastpos)
223 return X509v3_get_ext_by_critical(
224 x->tbsResponseData->responseExtensions, crit, lastpos);
228 OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc)
230 return X509v3_get_ext(x->tbsResponseData->responseExtensions, loc);
234 OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc)
236 return X509v3_delete_ext(x->tbsResponseData->responseExtensions, loc);
240 OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit, int *idx)
242 return X509V3_get_d2i(x->tbsResponseData->responseExtensions, nid,
247 OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value, int crit,
250 return X509V3_add1_i2d(&x->tbsResponseData->responseExtensions, nid,
255 OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc)
257 return X509v3_add_ext(&(x->tbsResponseData->responseExtensions), ex,
261 /* OCSP single response extensions */
264 OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x)
266 return X509v3_get_ext_count(x->singleExtensions);
270 OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos)
272 return X509v3_get_ext_by_NID(x->singleExtensions, nid, lastpos);
276 OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
279 return X509v3_get_ext_by_OBJ(x->singleExtensions, obj, lastpos);
283 OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit, int lastpos)
285 return X509v3_get_ext_by_critical(x->singleExtensions, crit, lastpos);
289 OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc)
291 return X509v3_get_ext(x->singleExtensions, loc);
295 OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc)
297 return X509v3_delete_ext(x->singleExtensions, loc);
301 OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit, int *idx)
303 return X509V3_get_d2i(x->singleExtensions, nid, crit, idx);
307 OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value, int crit,
310 return X509V3_add1_i2d(&x->singleExtensions, nid, value, crit, flags);
314 OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc)
316 return X509v3_add_ext(&(x->singleExtensions), ex, loc) != NULL;
319 /* Nonce handling functions */
321 /* Add a nonce to an extension stack. A nonce can be specificed or if NULL
322 * a random nonce will be generated.
323 * Note: OpenSSL 0.9.7d and later create an OCTET STRING containing the
324 * nonce, previous versions used the raw nonce.
328 ocsp_add1_nonce(STACK_OF(X509_EXTENSION) **exts, unsigned char *val, int len)
330 unsigned char *tmpval;
331 ASN1_OCTET_STRING os;
335 len = OCSP_DEFAULT_NONCE_LENGTH;
336 /* Create the OCTET STRING manually by writing out the header and
337 * appending the content octets. This avoids an extra memory allocation
338 * operation in some cases. Applications should *NOT* do this because
339 * it relies on library internals.
341 os.length = ASN1_object_size(0, len, V_ASN1_OCTET_STRING);
342 os.data = malloc(os.length);
346 ASN1_put_object(&tmpval, 0, len, V_ASN1_OCTET_STRING, V_ASN1_UNIVERSAL);
348 memcpy(tmpval, val, len);
350 arc4random_buf(tmpval, len);
351 if (!X509V3_add1_i2d(exts, NID_id_pkix_OCSP_Nonce, &os, 0,
361 /* Add nonce to an OCSP request */
363 OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len)
365 return ocsp_add1_nonce(&req->tbsRequest->requestExtensions, val, len);
368 /* Same as above but for a response */
370 OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len)
372 return ocsp_add1_nonce(&resp->tbsResponseData->responseExtensions, val,
376 /* Check nonce validity in a request and response.
377 * Return value reflects result:
378 * 1: nonces present and equal.
379 * 2: nonces both absent.
380 * 3: nonce present in response only.
381 * 0: nonces both present and not equal.
382 * -1: nonce in request only.
384 * For most responders clients can check return > 0.
385 * If responder doesn't handle nonces return != 0 may be
386 * necessary. return == 0 is always an error.
389 OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs)
392 * Since we are only interested in the presence or absence of
393 * the nonce and comparing its value there is no need to use
394 * the X509V3 routines: this way we can avoid them allocating an
395 * ASN1_OCTET_STRING structure for the value which would be
396 * freed immediately anyway.
398 int req_idx, resp_idx;
399 X509_EXTENSION *req_ext, *resp_ext;
401 req_idx = OCSP_REQUEST_get_ext_by_NID(req, NID_id_pkix_OCSP_Nonce, -1);
402 resp_idx = OCSP_BASICRESP_get_ext_by_NID(bs,
403 NID_id_pkix_OCSP_Nonce, -1);
404 /* Check both absent */
405 if (req_idx < 0 && resp_idx < 0)
407 /* Check in request only */
408 if (req_idx >= 0 && resp_idx < 0)
410 /* Check in response but not request */
411 if (req_idx < 0 && resp_idx >= 0)
413 /* Otherwise nonce in request and response so retrieve the extensions */
414 req_ext = OCSP_REQUEST_get_ext(req, req_idx);
415 resp_ext = OCSP_BASICRESP_get_ext(bs, resp_idx);
416 if (ASN1_OCTET_STRING_cmp(req_ext->value, resp_ext->value))
421 /* Copy the nonce value (if any) from an OCSP request to
425 OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req)
427 X509_EXTENSION *req_ext;
430 /* Check for nonce in request */
431 req_idx = OCSP_REQUEST_get_ext_by_NID(req, NID_id_pkix_OCSP_Nonce, -1);
432 /* If no nonce that's OK */
435 req_ext = OCSP_REQUEST_get_ext(req, req_idx);
436 return OCSP_BASICRESP_add_ext(resp, req_ext, -1);
440 OCSP_crlID_new(const char *url, long *n, char *tim)
442 X509_EXTENSION *x = NULL;
443 OCSP_CRLID *cid = NULL;
445 if (!(cid = OCSP_CRLID_new()))
448 if (!(cid->crlUrl = ASN1_IA5STRING_new()))
450 if (!(ASN1_STRING_set(cid->crlUrl, url, -1)))
454 if (!(cid->crlNum = ASN1_INTEGER_new()))
456 if (!(ASN1_INTEGER_set(cid->crlNum, *n)))
460 if (!(cid->crlTime = ASN1_GENERALIZEDTIME_new()))
462 if (!(ASN1_GENERALIZEDTIME_set_string(cid->crlTime, tim)))
465 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_CrlID, 0, cid);
469 OCSP_CRLID_free(cid);
473 /* AcceptableResponses ::= SEQUENCE OF OBJECT IDENTIFIER */
475 OCSP_accept_responses_new(char **oids)
478 STACK_OF(ASN1_OBJECT) *sk = NULL;
479 ASN1_OBJECT *o = NULL;
480 X509_EXTENSION *x = NULL;
482 if (!(sk = sk_ASN1_OBJECT_new_null()))
484 while (oids && *oids) {
485 if ((nid = OBJ_txt2nid(*oids)) != NID_undef &&
486 (o = OBJ_nid2obj(nid)))
487 if (sk_ASN1_OBJECT_push(sk, o) == 0) {
488 sk_ASN1_OBJECT_pop_free(sk, ASN1_OBJECT_free);
493 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_acceptableResponses, 0, sk);
494 sk_ASN1_OBJECT_pop_free(sk, ASN1_OBJECT_free);
498 /* ArchiveCutoff ::= GeneralizedTime */
500 OCSP_archive_cutoff_new(char* tim)
502 X509_EXTENSION *x = NULL;
503 ASN1_GENERALIZEDTIME *gt = NULL;
505 if (!(gt = ASN1_GENERALIZEDTIME_new()))
507 if (!(ASN1_GENERALIZEDTIME_set_string(gt, tim)))
509 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_archiveCutoff, 0, gt);
513 ASN1_GENERALIZEDTIME_free(gt);
517 /* per ACCESS_DESCRIPTION parameter are oids, of which there are currently
518 * two--NID_ad_ocsp, NID_id_ad_caIssuers--and GeneralName value. This
519 * method forces NID_ad_ocsp and uniformResourceLocator [6] IA5String.
522 OCSP_url_svcloc_new(X509_NAME* issuer, const char **urls)
524 X509_EXTENSION *x = NULL;
525 ASN1_IA5STRING *ia5 = NULL;
526 OCSP_SERVICELOC *sloc = NULL;
527 ACCESS_DESCRIPTION *ad = NULL;
529 if (!(sloc = OCSP_SERVICELOC_new()))
531 if (!(sloc->issuer = X509_NAME_dup(issuer)))
534 !(sloc->locator = sk_ACCESS_DESCRIPTION_new_null()))
536 while (urls && *urls) {
537 if (!(ad = ACCESS_DESCRIPTION_new()))
539 if (!(ad->method = OBJ_nid2obj(NID_ad_OCSP)))
541 if (!(ad->location = GENERAL_NAME_new()))
543 if (!(ia5 = ASN1_IA5STRING_new()))
545 if (!ASN1_STRING_set((ASN1_STRING*)ia5, *urls, -1))
547 ad->location->type = GEN_URI;
548 ad->location->d.ia5 = ia5;
550 if (!sk_ACCESS_DESCRIPTION_push(sloc->locator, ad))
555 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_serviceLocator, 0, sloc);
559 ASN1_IA5STRING_free(ia5);
561 ACCESS_DESCRIPTION_free(ad);
563 OCSP_SERVICELOC_free(sloc);