2 * Copyright 2000-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
11 #include "internal/cryptlib.h"
12 #include <openssl/objects.h>
13 #include <openssl/x509.h>
14 #include <openssl/ocsp.h>
16 #include <openssl/rand.h>
17 #include <openssl/x509v3.h>
19 /* Standard wrapper functions for extensions */
21 /* OCSP request extensions */
23 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x)
25 return (X509v3_get_ext_count(x->tbsRequest.requestExtensions));
28 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos)
30 return (X509v3_get_ext_by_NID
31 (x->tbsRequest.requestExtensions, nid, lastpos));
34 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, const ASN1_OBJECT *obj,
37 return (X509v3_get_ext_by_OBJ
38 (x->tbsRequest.requestExtensions, obj, lastpos));
41 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos)
43 return (X509v3_get_ext_by_critical
44 (x->tbsRequest.requestExtensions, crit, lastpos));
47 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc)
49 return (X509v3_get_ext(x->tbsRequest.requestExtensions, loc));
52 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc)
54 return (X509v3_delete_ext(x->tbsRequest.requestExtensions, loc));
57 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit, int *idx)
59 return X509V3_get_d2i(x->tbsRequest.requestExtensions, nid, crit, idx);
62 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
65 return X509V3_add1_i2d(&x->tbsRequest.requestExtensions, nid, value,
69 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc)
71 return (X509v3_add_ext(&(x->tbsRequest.requestExtensions), ex, loc) !=
75 /* Single extensions */
77 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x)
79 return (X509v3_get_ext_count(x->singleRequestExtensions));
82 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos)
84 return (X509v3_get_ext_by_NID(x->singleRequestExtensions, nid, lastpos));
87 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, const ASN1_OBJECT *obj,
90 return (X509v3_get_ext_by_OBJ(x->singleRequestExtensions, obj, lastpos));
93 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos)
95 return (X509v3_get_ext_by_critical
96 (x->singleRequestExtensions, crit, lastpos));
99 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc)
101 return (X509v3_get_ext(x->singleRequestExtensions, loc));
104 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc)
106 return (X509v3_delete_ext(x->singleRequestExtensions, loc));
109 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx)
111 return X509V3_get_d2i(x->singleRequestExtensions, nid, crit, idx);
114 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
117 return X509V3_add1_i2d(&x->singleRequestExtensions, nid, value, crit,
121 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc)
123 return (X509v3_add_ext(&(x->singleRequestExtensions), ex, loc) != NULL);
126 /* OCSP Basic response */
128 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x)
130 return (X509v3_get_ext_count(x->tbsResponseData.responseExtensions));
133 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos)
135 return (X509v3_get_ext_by_NID
136 (x->tbsResponseData.responseExtensions, nid, lastpos));
139 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, const ASN1_OBJECT *obj,
142 return (X509v3_get_ext_by_OBJ
143 (x->tbsResponseData.responseExtensions, obj, lastpos));
146 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
149 return (X509v3_get_ext_by_critical
150 (x->tbsResponseData.responseExtensions, crit, lastpos));
153 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc)
155 return (X509v3_get_ext(x->tbsResponseData.responseExtensions, loc));
158 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc)
160 return (X509v3_delete_ext(x->tbsResponseData.responseExtensions, loc));
163 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
166 return X509V3_get_d2i(x->tbsResponseData.responseExtensions, nid, crit,
170 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
171 int crit, unsigned long flags)
173 return X509V3_add1_i2d(&x->tbsResponseData.responseExtensions, nid,
177 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc)
179 return (X509v3_add_ext(&(x->tbsResponseData.responseExtensions), ex, loc)
183 /* OCSP single response extensions */
185 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x)
187 return (X509v3_get_ext_count(x->singleExtensions));
190 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos)
192 return (X509v3_get_ext_by_NID(x->singleExtensions, nid, lastpos));
195 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, const ASN1_OBJECT *obj,
198 return (X509v3_get_ext_by_OBJ(x->singleExtensions, obj, lastpos));
201 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
204 return (X509v3_get_ext_by_critical(x->singleExtensions, crit, lastpos));
207 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc)
209 return (X509v3_get_ext(x->singleExtensions, loc));
212 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc)
214 return (X509v3_delete_ext(x->singleExtensions, loc));
217 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
220 return X509V3_get_d2i(x->singleExtensions, nid, crit, idx);
223 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
224 int crit, unsigned long flags)
226 return X509V3_add1_i2d(&x->singleExtensions, nid, value, crit, flags);
229 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc)
231 return (X509v3_add_ext(&(x->singleExtensions), ex, loc) != NULL);
234 /* also CRL Entry Extensions */
236 /* Nonce handling functions */
239 * Add a nonce to an extension stack. A nonce can be specified or if NULL a
240 * random nonce will be generated. Note: OpenSSL 0.9.7d and later create an
241 * OCTET STRING containing the nonce, previous versions used the raw nonce.
244 static int ocsp_add1_nonce(STACK_OF(X509_EXTENSION) **exts,
245 unsigned char *val, int len)
247 unsigned char *tmpval;
248 ASN1_OCTET_STRING os;
251 len = OCSP_DEFAULT_NONCE_LENGTH;
253 * Create the OCTET STRING manually by writing out the header and
254 * appending the content octets. This avoids an extra memory allocation
255 * operation in some cases. Applications should *NOT* do this because it
256 * relies on library internals.
258 os.length = ASN1_object_size(0, len, V_ASN1_OCTET_STRING);
262 os.data = OPENSSL_malloc(os.length);
266 ASN1_put_object(&tmpval, 0, len, V_ASN1_OCTET_STRING, V_ASN1_UNIVERSAL);
268 memcpy(tmpval, val, len);
269 else if (RAND_bytes(tmpval, len) <= 0)
271 if (!X509V3_add1_i2d(exts, NID_id_pkix_OCSP_Nonce,
272 &os, 0, X509V3_ADD_REPLACE))
276 OPENSSL_free(os.data);
280 /* Add nonce to an OCSP request */
282 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len)
284 return ocsp_add1_nonce(&req->tbsRequest.requestExtensions, val, len);
287 /* Same as above but for a response */
289 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len)
291 return ocsp_add1_nonce(&resp->tbsResponseData.responseExtensions, val,
296 * Check nonce validity in a request and response.
297 * Return value reflects result:
298 * 1: nonces present and equal.
299 * 2: nonces both absent.
300 * 3: nonce present in response only.
301 * 0: nonces both present and not equal.
302 * -1: nonce in request only.
304 * For most responders clients can check return > 0.
305 * If responder doesn't handle nonces return != 0 may be
306 * necessary. return == 0 is always an error.
309 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs)
312 * Since we are only interested in the presence or absence of
313 * the nonce and comparing its value there is no need to use
314 * the X509V3 routines: this way we can avoid them allocating an
315 * ASN1_OCTET_STRING structure for the value which would be
316 * freed immediately anyway.
319 int req_idx, resp_idx;
320 X509_EXTENSION *req_ext, *resp_ext;
321 req_idx = OCSP_REQUEST_get_ext_by_NID(req, NID_id_pkix_OCSP_Nonce, -1);
322 resp_idx = OCSP_BASICRESP_get_ext_by_NID(bs, NID_id_pkix_OCSP_Nonce, -1);
323 /* Check both absent */
324 if ((req_idx < 0) && (resp_idx < 0))
326 /* Check in request only */
327 if ((req_idx >= 0) && (resp_idx < 0))
329 /* Check in response but not request */
330 if ((req_idx < 0) && (resp_idx >= 0))
333 * Otherwise nonce in request and response so retrieve the extensions
335 req_ext = OCSP_REQUEST_get_ext(req, req_idx);
336 resp_ext = OCSP_BASICRESP_get_ext(bs, resp_idx);
337 if (ASN1_OCTET_STRING_cmp(X509_EXTENSION_get_data(req_ext),
338 X509_EXTENSION_get_data(resp_ext)))
344 * Copy the nonce value (if any) from an OCSP request to a response.
347 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req)
349 X509_EXTENSION *req_ext;
351 /* Check for nonce in request */
352 req_idx = OCSP_REQUEST_get_ext_by_NID(req, NID_id_pkix_OCSP_Nonce, -1);
353 /* If no nonce that's OK */
356 req_ext = OCSP_REQUEST_get_ext(req, req_idx);
357 return OCSP_BASICRESP_add_ext(resp, req_ext, -1);
360 X509_EXTENSION *OCSP_crlID_new(const char *url, long *n, char *tim)
362 X509_EXTENSION *x = NULL;
363 OCSP_CRLID *cid = NULL;
365 if ((cid = OCSP_CRLID_new()) == NULL)
368 if ((cid->crlUrl = ASN1_IA5STRING_new()) == NULL)
370 if (!(ASN1_STRING_set(cid->crlUrl, url, -1)))
374 if ((cid->crlNum = ASN1_INTEGER_new()) == NULL)
376 if (!(ASN1_INTEGER_set(cid->crlNum, *n)))
380 if ((cid->crlTime = ASN1_GENERALIZEDTIME_new()) == NULL)
382 if (!(ASN1_GENERALIZEDTIME_set_string(cid->crlTime, tim)))
385 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_CrlID, 0, cid);
387 OCSP_CRLID_free(cid);
391 /* AcceptableResponses ::= SEQUENCE OF OBJECT IDENTIFIER */
392 X509_EXTENSION *OCSP_accept_responses_new(char **oids)
395 STACK_OF(ASN1_OBJECT) *sk = NULL;
396 ASN1_OBJECT *o = NULL;
397 X509_EXTENSION *x = NULL;
399 if ((sk = sk_ASN1_OBJECT_new_null()) == NULL)
401 while (oids && *oids) {
402 if ((nid = OBJ_txt2nid(*oids)) != NID_undef && (o = OBJ_nid2obj(nid)))
403 sk_ASN1_OBJECT_push(sk, o);
406 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_acceptableResponses, 0, sk);
408 sk_ASN1_OBJECT_pop_free(sk, ASN1_OBJECT_free);
412 /* ArchiveCutoff ::= GeneralizedTime */
413 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim)
415 X509_EXTENSION *x = NULL;
416 ASN1_GENERALIZEDTIME *gt = NULL;
418 if ((gt = ASN1_GENERALIZEDTIME_new()) == NULL)
420 if (!(ASN1_GENERALIZEDTIME_set_string(gt, tim)))
422 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_archiveCutoff, 0, gt);
424 ASN1_GENERALIZEDTIME_free(gt);
429 * per ACCESS_DESCRIPTION parameter are oids, of which there are currently
430 * two--NID_ad_ocsp, NID_id_ad_caIssuers--and GeneralName value. This method
431 * forces NID_ad_ocsp and uniformResourceLocator [6] IA5String.
433 X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME *issuer, const char **urls)
435 X509_EXTENSION *x = NULL;
436 ASN1_IA5STRING *ia5 = NULL;
437 OCSP_SERVICELOC *sloc = NULL;
438 ACCESS_DESCRIPTION *ad = NULL;
440 if ((sloc = OCSP_SERVICELOC_new()) == NULL)
442 if ((sloc->issuer = X509_NAME_dup(issuer)) == NULL)
445 && (sloc->locator = sk_ACCESS_DESCRIPTION_new_null()) == NULL)
447 while (urls && *urls) {
448 if ((ad = ACCESS_DESCRIPTION_new()) == NULL)
450 if ((ad->method = OBJ_nid2obj(NID_ad_OCSP)) == NULL)
452 if ((ad->location = GENERAL_NAME_new()) == NULL)
454 if ((ia5 = ASN1_IA5STRING_new()) == NULL)
456 if (!ASN1_STRING_set((ASN1_STRING *)ia5, *urls, -1))
458 ad->location->type = GEN_URI;
459 ad->location->d.ia5 = ia5;
461 if (!sk_ACCESS_DESCRIPTION_push(sloc->locator, ad))
466 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_serviceLocator, 0, sloc);
468 ASN1_IA5STRING_free(ia5);
469 ACCESS_DESCRIPTION_free(ad);
470 OCSP_SERVICELOC_free(sloc);