xref: /openbsd-src/lib/libcrypto/ocsp/ocsp_cl.c (revision db3296cf5c1dd9058ceecc3a29fe4aaa0bd26000)
1 /* ocsp_cl.c */
2 /* Written by Tom Titchener <Tom_Titchener@groove.net> for the OpenSSL
3  * project. */
4 
5 /* History:
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
8    as a patch kit. */
9 
10 /* ====================================================================
11  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  *
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
23  *    distribution.
24  *
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/)"
29  *
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.
34  *
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.
38  *
39  * 6. Redistributions of any form whatsoever must retain the following
40  *    acknowledgment:
41  *    "This product includes software developed by the OpenSSL Project
42  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
43  *
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  * ====================================================================
57  *
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).
61  *
62  */
63 
64 #include <stdio.h>
65 #include <time.h>
66 #include <cryptlib.h>
67 #include <openssl/objects.h>
68 #include <openssl/rand.h>
69 #include <openssl/x509.h>
70 #include <openssl/pem.h>
71 #include <openssl/x509v3.h>
72 #include <openssl/ocsp.h>
73 
74 /* Utility functions related to sending OCSP requests and extracting
75  * relevant information from the response.
76  */
77 
78 /* Add an OCSP_CERTID to an OCSP request. Return new OCSP_ONEREQ
79  * pointer: useful if we want to add extensions.
80  */
81 
82 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid)
83         {
84 	OCSP_ONEREQ *one = NULL;
85 
86 	if (!(one = OCSP_ONEREQ_new())) goto err;
87 	if (one->reqCert) OCSP_CERTID_free(one->reqCert);
88 	one->reqCert = cid;
89 	if (req &&
90 		!sk_OCSP_ONEREQ_push(req->tbsRequest->requestList, one))
91 				goto err;
92 	return one;
93 err:
94 	OCSP_ONEREQ_free(one);
95 	return NULL;
96         }
97 
98 /* Set requestorName from an X509_NAME structure */
99 
100 int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm)
101 	{
102 	GENERAL_NAME *gen;
103 	gen = GENERAL_NAME_new();
104 	if (!X509_NAME_set(&gen->d.directoryName, nm))
105 		{
106 		GENERAL_NAME_free(gen);
107 		return 0;
108 		}
109 	gen->type = GEN_DIRNAME;
110 	if (req->tbsRequest->requestorName)
111 		GENERAL_NAME_free(req->tbsRequest->requestorName);
112 	req->tbsRequest->requestorName = gen;
113 	return 1;
114 	}
115 
116 
117 /* Add a certificate to an OCSP request */
118 
119 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert)
120 	{
121 	OCSP_SIGNATURE *sig;
122 	if (!req->optionalSignature)
123 		req->optionalSignature = OCSP_SIGNATURE_new();
124 	sig = req->optionalSignature;
125 	if (!sig) return 0;
126 	if (!cert) return 1;
127 	if (!sig->certs && !(sig->certs = sk_X509_new_null()))
128 		return 0;
129 
130 	if(!sk_X509_push(sig->certs, cert)) return 0;
131 	CRYPTO_add(&cert->references, 1, CRYPTO_LOCK_X509);
132 	return 1;
133 	}
134 
135 /* Sign an OCSP request set the requestorName to the subjec
136  * name of an optional signers certificate and include one
137  * or more optional certificates in the request. Behaves
138  * like PKCS7_sign().
139  */
140 
141 int OCSP_request_sign(OCSP_REQUEST   *req,
142 		      X509           *signer,
143 		      EVP_PKEY       *key,
144 		      const EVP_MD   *dgst,
145 		      STACK_OF(X509) *certs,
146 		      unsigned long flags)
147         {
148 	int i;
149 	OCSP_SIGNATURE *sig;
150 	X509 *x;
151 
152 	if (!OCSP_request_set1_name(req, X509_get_subject_name(signer)))
153 			goto err;
154 
155 	if (!(req->optionalSignature = sig = OCSP_SIGNATURE_new())) goto err;
156 	if (!dgst) dgst = EVP_sha1();
157 	if (key)
158 		{
159 		if (!X509_check_private_key(signer, key))
160 			{
161 			OCSPerr(OCSP_F_OCSP_REQUEST_SIGN, OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE);
162 			goto err;
163 			}
164 		if (!OCSP_REQUEST_sign(req, key, dgst)) goto err;
165 		}
166 
167 	if (!(flags & OCSP_NOCERTS))
168 		{
169 		if(!OCSP_request_add1_cert(req, signer)) goto err;
170 		for (i = 0; i < sk_X509_num(certs); i++)
171 			{
172 			x = sk_X509_value(certs, i);
173 			if (!OCSP_request_add1_cert(req, x)) goto err;
174 			}
175 		}
176 
177 	return 1;
178 err:
179 	OCSP_SIGNATURE_free(req->optionalSignature);
180 	req->optionalSignature = NULL;
181 	return 0;
182 	}
183 
184 /* Get response status */
185 
186 int OCSP_response_status(OCSP_RESPONSE *resp)
187 	{
188 	return ASN1_ENUMERATED_get(resp->responseStatus);
189 	}
190 
191 /* Extract basic response from OCSP_RESPONSE or NULL if
192  * no basic response present.
193  */
194 
195 
196 OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp)
197 	{
198 	OCSP_RESPBYTES *rb;
199 	rb = resp->responseBytes;
200 	if (!rb)
201 		{
202 		OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NO_RESPONSE_DATA);
203 		return NULL;
204 		}
205 	if (OBJ_obj2nid(rb->responseType) != NID_id_pkix_OCSP_basic)
206 		{
207 		OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC, OCSP_R_NOT_BASIC_RESPONSE);
208 		return NULL;
209 		}
210 
211 	return ASN1_item_unpack(rb->response, ASN1_ITEM_rptr(OCSP_BASICRESP));
212 	}
213 
214 /* Return number of OCSP_SINGLERESP reponses present in
215  * a basic response.
216  */
217 
218 int OCSP_resp_count(OCSP_BASICRESP *bs)
219 	{
220 	if (!bs) return -1;
221 	return sk_OCSP_SINGLERESP_num(bs->tbsResponseData->responses);
222 	}
223 
224 /* Extract an OCSP_SINGLERESP response with a given index */
225 
226 OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx)
227 	{
228 	if (!bs) return NULL;
229 	return sk_OCSP_SINGLERESP_value(bs->tbsResponseData->responses, idx);
230 	}
231 
232 /* Look single response matching a given certificate ID */
233 
234 int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last)
235 	{
236 	int i;
237 	STACK_OF(OCSP_SINGLERESP) *sresp;
238 	OCSP_SINGLERESP *single;
239 	if (!bs) return -1;
240 	if (last < 0) last = 0;
241 	else last++;
242 	sresp = bs->tbsResponseData->responses;
243 	for (i = last; i < sk_OCSP_SINGLERESP_num(sresp); i++)
244 		{
245 		single = sk_OCSP_SINGLERESP_value(sresp, i);
246 		if (!OCSP_id_cmp(id, single->certId)) return i;
247 		}
248 	return -1;
249 	}
250 
251 /* Extract status information from an OCSP_SINGLERESP structure.
252  * Note: the revtime and reason values are only set if the
253  * certificate status is revoked. Returns numerical value of
254  * status.
255  */
256 
257 int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
258 				ASN1_GENERALIZEDTIME **revtime,
259 				ASN1_GENERALIZEDTIME **thisupd,
260 				ASN1_GENERALIZEDTIME **nextupd)
261 	{
262 	int ret;
263 	OCSP_CERTSTATUS *cst;
264 	if(!single) return -1;
265 	cst = single->certStatus;
266 	ret = cst->type;
267 	if (ret == V_OCSP_CERTSTATUS_REVOKED)
268 		{
269 		OCSP_REVOKEDINFO *rev = cst->value.revoked;
270 		if (revtime) *revtime = rev->revocationTime;
271 		if (reason)
272 			{
273 			if(rev->revocationReason)
274 				*reason = ASN1_ENUMERATED_get(rev->revocationReason);
275 			else *reason = -1;
276 			}
277 		}
278 	if(thisupd) *thisupd = single->thisUpdate;
279 	if(nextupd) *nextupd = single->nextUpdate;
280 	return ret;
281 	}
282 
283 /* This function combines the previous ones: look up a certificate ID and
284  * if found extract status information. Return 0 is successful.
285  */
286 
287 int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
288 				int *reason,
289 				ASN1_GENERALIZEDTIME **revtime,
290 				ASN1_GENERALIZEDTIME **thisupd,
291 				ASN1_GENERALIZEDTIME **nextupd)
292 	{
293 	int i;
294 	OCSP_SINGLERESP *single;
295 	i = OCSP_resp_find(bs, id, -1);
296 	/* Maybe check for multiple responses and give an error? */
297 	if(i < 0) return 0;
298 	single = OCSP_resp_get0(bs, i);
299 	i = OCSP_single_get0_status(single, reason, revtime, thisupd, nextupd);
300 	if(status) *status = i;
301 	return 1;
302 	}
303 
304 /* Check validity of thisUpdate and nextUpdate fields. It is possible that the request will
305  * take a few seconds to process and/or the time wont be totally accurate. Therefore to avoid
306  * rejecting otherwise valid time we allow the times to be within 'nsec' of the current time.
307  * Also to avoid accepting very old responses without a nextUpdate field an optional maxage
308  * parameter specifies the maximum age the thisUpdate field can be.
309  */
310 
311 int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd, ASN1_GENERALIZEDTIME *nextupd, long nsec, long maxsec)
312 	{
313 	int ret = 1;
314 	time_t t_now, t_tmp;
315 	time(&t_now);
316 	/* Check thisUpdate is valid and not more than nsec in the future */
317 	if (!ASN1_GENERALIZEDTIME_check(thisupd))
318 		{
319 		OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_THISUPDATE_FIELD);
320 		ret = 0;
321 		}
322 	else
323 		{
324 			t_tmp = t_now + nsec;
325 			if (X509_cmp_time(thisupd, &t_tmp) > 0)
326 			{
327 			OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_NOT_YET_VALID);
328 			ret = 0;
329 			}
330 
331 		/* If maxsec specified check thisUpdate is not more than maxsec in the past */
332 		if (maxsec >= 0)
333 			{
334 			t_tmp = t_now - maxsec;
335 			if (X509_cmp_time(thisupd, &t_tmp) < 0)
336 				{
337 				OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_TOO_OLD);
338 				ret = 0;
339 				}
340 			}
341 		}
342 
343 
344 	if (!nextupd) return ret;
345 
346 	/* Check nextUpdate is valid and not more than nsec in the past */
347 	if (!ASN1_GENERALIZEDTIME_check(nextupd))
348 		{
349 		OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_ERROR_IN_NEXTUPDATE_FIELD);
350 		ret = 0;
351 		}
352 	else
353 		{
354 		t_tmp = t_now - nsec;
355 		if (X509_cmp_time(nextupd, &t_tmp) < 0)
356 			{
357 			OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_STATUS_EXPIRED);
358 			ret = 0;
359 			}
360 		}
361 
362 	/* Also don't allow nextUpdate to precede thisUpdate */
363 	if (ASN1_STRING_cmp(nextupd, thisupd) < 0)
364 		{
365 		OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY, OCSP_R_NEXTUPDATE_BEFORE_THISUPDATE);
366 		ret = 0;
367 		}
368 
369 	return ret;
370 	}
371