2 * Written by Tom Titchener <Tom_Titchener@groove.net> for the OpenSSL
7 * History: This file was transferred to Richard Levitte from CertCo by Kathy
8 * Weinhold in mid-spring 2000 to be included in OpenSSL or released as a
12 /* ====================================================================
13 * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in
24 * the documentation and/or other materials provided with the
27 * 3. All advertising materials mentioning features or use of this
28 * software must display the following acknowledgment:
29 * "This product includes software developed by the OpenSSL Project
30 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
32 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
33 * endorse or promote products derived from this software without
34 * prior written permission. For written permission, please contact
35 * openssl-core@openssl.org.
37 * 5. Products derived from this software may not be called "OpenSSL"
38 * nor may "OpenSSL" appear in their names without prior written
39 * permission of the OpenSSL Project.
41 * 6. Redistributions of any form whatsoever must retain the following
43 * "This product includes software developed by the OpenSSL Project
44 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
46 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
47 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
49 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
50 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
51 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
53 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
55 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
56 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
57 * OF THE POSSIBILITY OF SUCH DAMAGE.
58 * ====================================================================
60 * This product includes cryptographic software written by Eric Young
61 * (eay@cryptsoft.com). This product includes software written by Tim
62 * Hudson (tjh@cryptsoft.com).
67 #include "internal/cryptlib.h"
68 #include <openssl/objects.h>
69 #include <openssl/x509.h>
70 #include <openssl/ocsp.h>
72 #include <openssl/rand.h>
73 #include <openssl/x509v3.h>
75 /* Standard wrapper functions for extensions */
77 /* OCSP request extensions */
79 int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x)
81 return (X509v3_get_ext_count(x->tbsRequest.requestExtensions));
84 int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos)
86 return (X509v3_get_ext_by_NID
87 (x->tbsRequest.requestExtensions, nid, lastpos));
90 int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, ASN1_OBJECT *obj,
93 return (X509v3_get_ext_by_OBJ
94 (x->tbsRequest.requestExtensions, obj, lastpos));
97 int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos)
99 return (X509v3_get_ext_by_critical
100 (x->tbsRequest.requestExtensions, crit, lastpos));
103 X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc)
105 return (X509v3_get_ext(x->tbsRequest.requestExtensions, loc));
108 X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc)
110 return (X509v3_delete_ext(x->tbsRequest.requestExtensions, loc));
113 void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit, int *idx)
115 return X509V3_get_d2i(x->tbsRequest.requestExtensions, nid, crit, idx);
118 int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit,
121 return X509V3_add1_i2d(&x->tbsRequest.requestExtensions, nid, value,
125 int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc)
127 return (X509v3_add_ext(&(x->tbsRequest.requestExtensions), ex, loc) !=
131 /* Single extensions */
133 int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x)
135 return (X509v3_get_ext_count(x->singleRequestExtensions));
138 int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos)
140 return (X509v3_get_ext_by_NID(x->singleRequestExtensions, nid, lastpos));
143 int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, ASN1_OBJECT *obj, int lastpos)
145 return (X509v3_get_ext_by_OBJ(x->singleRequestExtensions, obj, lastpos));
148 int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos)
150 return (X509v3_get_ext_by_critical
151 (x->singleRequestExtensions, crit, lastpos));
154 X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc)
156 return (X509v3_get_ext(x->singleRequestExtensions, loc));
159 X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc)
161 return (X509v3_delete_ext(x->singleRequestExtensions, loc));
164 void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx)
166 return X509V3_get_d2i(x->singleRequestExtensions, nid, crit, idx);
169 int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit,
172 return X509V3_add1_i2d(&x->singleRequestExtensions, nid, value, crit,
176 int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc)
178 return (X509v3_add_ext(&(x->singleRequestExtensions), ex, loc) != NULL);
181 /* OCSP Basic response */
183 int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x)
185 return (X509v3_get_ext_count(x->tbsResponseData.responseExtensions));
188 int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos)
190 return (X509v3_get_ext_by_NID
191 (x->tbsResponseData.responseExtensions, nid, lastpos));
194 int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, ASN1_OBJECT *obj,
197 return (X509v3_get_ext_by_OBJ
198 (x->tbsResponseData.responseExtensions, obj, lastpos));
201 int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit,
204 return (X509v3_get_ext_by_critical
205 (x->tbsResponseData.responseExtensions, crit, lastpos));
208 X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc)
210 return (X509v3_get_ext(x->tbsResponseData.responseExtensions, loc));
213 X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc)
215 return (X509v3_delete_ext(x->tbsResponseData.responseExtensions, loc));
218 void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit,
221 return X509V3_get_d2i(x->tbsResponseData.responseExtensions, nid, crit,
225 int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value,
226 int crit, unsigned long flags)
228 return X509V3_add1_i2d(&x->tbsResponseData.responseExtensions, nid,
232 int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc)
234 return (X509v3_add_ext(&(x->tbsResponseData.responseExtensions), ex, loc)
238 /* OCSP single response extensions */
240 int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x)
242 return (X509v3_get_ext_count(x->singleExtensions));
245 int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos)
247 return (X509v3_get_ext_by_NID(x->singleExtensions, nid, lastpos));
250 int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, ASN1_OBJECT *obj,
253 return (X509v3_get_ext_by_OBJ(x->singleExtensions, obj, lastpos));
256 int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit,
259 return (X509v3_get_ext_by_critical(x->singleExtensions, crit, lastpos));
262 X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc)
264 return (X509v3_get_ext(x->singleExtensions, loc));
267 X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc)
269 return (X509v3_delete_ext(x->singleExtensions, loc));
272 void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit,
275 return X509V3_get_d2i(x->singleExtensions, nid, crit, idx);
278 int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value,
279 int crit, unsigned long flags)
281 return X509V3_add1_i2d(&x->singleExtensions, nid, value, crit, flags);
284 int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc)
286 return (X509v3_add_ext(&(x->singleExtensions), ex, loc) != NULL);
289 /* also CRL Entry Extensions */
291 /* Nonce handling functions */
294 * Add a nonce to an extension stack. A nonce can be specified or if NULL a
295 * random nonce will be generated. Note: OpenSSL 0.9.7d and later create an
296 * OCTET STRING containing the nonce, previous versions used the raw nonce.
299 static int ocsp_add1_nonce(STACK_OF(X509_EXTENSION) **exts,
300 unsigned char *val, int len)
302 unsigned char *tmpval;
303 ASN1_OCTET_STRING os;
306 len = OCSP_DEFAULT_NONCE_LENGTH;
308 * Create the OCTET STRING manually by writing out the header and
309 * appending the content octets. This avoids an extra memory allocation
310 * operation in some cases. Applications should *NOT* do this because it
311 * relies on library internals.
313 os.length = ASN1_object_size(0, len, V_ASN1_OCTET_STRING);
314 os.data = OPENSSL_malloc(os.length);
318 ASN1_put_object(&tmpval, 0, len, V_ASN1_OCTET_STRING, V_ASN1_UNIVERSAL);
320 memcpy(tmpval, val, len);
321 else if (RAND_bytes(tmpval, len) <= 0)
323 if (!X509V3_add1_i2d(exts, NID_id_pkix_OCSP_Nonce,
324 &os, 0, X509V3_ADD_REPLACE))
328 OPENSSL_free(os.data);
332 /* Add nonce to an OCSP request */
334 int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len)
336 return ocsp_add1_nonce(&req->tbsRequest.requestExtensions, val, len);
339 /* Same as above but for a response */
341 int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len)
343 return ocsp_add1_nonce(&resp->tbsResponseData.responseExtensions, val,
348 * Check nonce validity in a request and response.
349 * Return value reflects result:
350 * 1: nonces present and equal.
351 * 2: nonces both absent.
352 * 3: nonce present in response only.
353 * 0: nonces both present and not equal.
354 * -1: nonce in request only.
356 * For most responders clients can check return > 0.
357 * If responder doesn't handle nonces return != 0 may be
358 * necessary. return == 0 is always an error.
361 int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs)
364 * Since we are only interested in the presence or absence of
365 * the nonce and comparing its value there is no need to use
366 * the X509V3 routines: this way we can avoid them allocating an
367 * ASN1_OCTET_STRING structure for the value which would be
368 * freed immediately anyway.
371 int req_idx, resp_idx;
372 X509_EXTENSION *req_ext, *resp_ext;
373 req_idx = OCSP_REQUEST_get_ext_by_NID(req, NID_id_pkix_OCSP_Nonce, -1);
374 resp_idx = OCSP_BASICRESP_get_ext_by_NID(bs, NID_id_pkix_OCSP_Nonce, -1);
375 /* Check both absent */
376 if ((req_idx < 0) && (resp_idx < 0))
378 /* Check in request only */
379 if ((req_idx >= 0) && (resp_idx < 0))
381 /* Check in response but not request */
382 if ((req_idx < 0) && (resp_idx >= 0))
385 * Otherwise nonce in request and response so retrieve the extensions
387 req_ext = OCSP_REQUEST_get_ext(req, req_idx);
388 resp_ext = OCSP_BASICRESP_get_ext(bs, resp_idx);
389 if (ASN1_OCTET_STRING_cmp(X509_EXTENSION_get_data(req_ext),
390 X509_EXTENSION_get_data(resp_ext)))
396 * Copy the nonce value (if any) from an OCSP request to a response.
399 int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req)
401 X509_EXTENSION *req_ext;
403 /* Check for nonce in request */
404 req_idx = OCSP_REQUEST_get_ext_by_NID(req, NID_id_pkix_OCSP_Nonce, -1);
405 /* If no nonce that's OK */
408 req_ext = OCSP_REQUEST_get_ext(req, req_idx);
409 return OCSP_BASICRESP_add_ext(resp, req_ext, -1);
412 X509_EXTENSION *OCSP_crlID_new(char *url, long *n, char *tim)
414 X509_EXTENSION *x = NULL;
415 OCSP_CRLID *cid = NULL;
417 if ((cid = OCSP_CRLID_new()) == NULL)
420 if ((cid->crlUrl = ASN1_IA5STRING_new()) == NULL)
422 if (!(ASN1_STRING_set(cid->crlUrl, url, -1)))
426 if ((cid->crlNum = ASN1_INTEGER_new()) == NULL)
428 if (!(ASN1_INTEGER_set(cid->crlNum, *n)))
432 if ((cid->crlTime = ASN1_GENERALIZEDTIME_new()) == NULL)
434 if (!(ASN1_GENERALIZEDTIME_set_string(cid->crlTime, tim)))
437 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_CrlID, 0, cid);
439 OCSP_CRLID_free(cid);
443 /* AcceptableResponses ::= SEQUENCE OF OBJECT IDENTIFIER */
444 X509_EXTENSION *OCSP_accept_responses_new(char **oids)
447 STACK_OF(ASN1_OBJECT) *sk = NULL;
448 ASN1_OBJECT *o = NULL;
449 X509_EXTENSION *x = NULL;
451 if ((sk = sk_ASN1_OBJECT_new_null()) == NULL)
453 while (oids && *oids) {
454 if ((nid = OBJ_txt2nid(*oids)) != NID_undef && (o = OBJ_nid2obj(nid)))
455 sk_ASN1_OBJECT_push(sk, o);
458 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_acceptableResponses, 0, sk);
460 sk_ASN1_OBJECT_pop_free(sk, ASN1_OBJECT_free);
464 /* ArchiveCutoff ::= GeneralizedTime */
465 X509_EXTENSION *OCSP_archive_cutoff_new(char *tim)
467 X509_EXTENSION *x = NULL;
468 ASN1_GENERALIZEDTIME *gt = NULL;
470 if ((gt = ASN1_GENERALIZEDTIME_new()) == NULL)
472 if (!(ASN1_GENERALIZEDTIME_set_string(gt, tim)))
474 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_archiveCutoff, 0, gt);
476 ASN1_GENERALIZEDTIME_free(gt);
481 * per ACCESS_DESCRIPTION parameter are oids, of which there are currently
482 * two--NID_ad_ocsp, NID_id_ad_caIssuers--and GeneralName value. This method
483 * forces NID_ad_ocsp and uniformResourceLocator [6] IA5String.
485 X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME *issuer, char **urls)
487 X509_EXTENSION *x = NULL;
488 ASN1_IA5STRING *ia5 = NULL;
489 OCSP_SERVICELOC *sloc = NULL;
490 ACCESS_DESCRIPTION *ad = NULL;
492 if ((sloc = OCSP_SERVICELOC_new()) == NULL)
494 if ((sloc->issuer = X509_NAME_dup(issuer)) == NULL)
497 && (sloc->locator = sk_ACCESS_DESCRIPTION_new_null()) == NULL)
499 while (urls && *urls) {
500 if ((ad = ACCESS_DESCRIPTION_new()) == NULL)
502 if ((ad->method = OBJ_nid2obj(NID_ad_OCSP)) == NULL)
504 if ((ad->location = GENERAL_NAME_new()) == NULL)
506 if ((ia5 = ASN1_IA5STRING_new()) == NULL)
508 if (!ASN1_STRING_set((ASN1_STRING *)ia5, *urls, -1))
510 ad->location->type = GEN_URI;
511 ad->location->d.ia5 = ia5;
512 if (!sk_ACCESS_DESCRIPTION_push(sloc->locator, ad))
516 x = X509V3_EXT_i2d(NID_id_pkix_OCSP_serviceLocator, 0, sloc);
518 OCSP_SERVICELOC_free(sloc);