1 /* $OpenBSD: ocsp_cl.c,v 1.10 2016/07/05 03:24:38 beck Exp $ */
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 
67 #include <openssl/err.h>
68 #include <openssl/ocsp.h>
69 #include <openssl/objects.h>
70 #include <openssl/pem.h>
71 #include <openssl/x509.h>
72 #include <openssl/x509v3.h>
73 
74 int asn1_time_parse(const char *, size_t, struct tm *, int);
75 int asn1_tm_cmp(struct tm *, struct tm *);
76 
77 /* Utility functions related to sending OCSP requests and extracting
78  * relevant information from the response.
79  */
80 
81 /* Add an OCSP_CERTID to an OCSP request. Return new OCSP_ONEREQ
82  * pointer: useful if we want to add extensions.
83  */
84 OCSP_ONEREQ *
85 OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid)
86 {
87 	OCSP_ONEREQ *one = NULL;
88 
89 	if (!(one = OCSP_ONEREQ_new()))
90 		goto err;
91 	if (one->reqCert)
92 		OCSP_CERTID_free(one->reqCert);
93 	one->reqCert = cid;
94 	if (req && !sk_OCSP_ONEREQ_push(req->tbsRequest->requestList, one))
95 		goto err;
96 	return one;
97 
98 err:
99 	OCSP_ONEREQ_free(one);
100 	return NULL;
101 }
102 
103 /* Set requestorName from an X509_NAME structure */
104 int
105 OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm)
106 {
107 	GENERAL_NAME *gen;
108 
109 	gen = GENERAL_NAME_new();
110 	if (gen == NULL)
111 		return 0;
112 	if (!X509_NAME_set(&gen->d.directoryName, nm)) {
113 		GENERAL_NAME_free(gen);
114 		return 0;
115 	}
116 	gen->type = GEN_DIRNAME;
117 	if (req->tbsRequest->requestorName)
118 		GENERAL_NAME_free(req->tbsRequest->requestorName);
119 	req->tbsRequest->requestorName = gen;
120 	return 1;
121 }
122 
123 /* Add a certificate to an OCSP request */
124 int
125 OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert)
126 {
127 	OCSP_SIGNATURE *sig;
128 
129 	if (!req->optionalSignature)
130 		req->optionalSignature = OCSP_SIGNATURE_new();
131 	sig = req->optionalSignature;
132 	if (!sig)
133 		return 0;
134 	if (!cert)
135 		return 1;
136 	if (!sig->certs && !(sig->certs = sk_X509_new_null()))
137 		return 0;
138 
139 	if (!sk_X509_push(sig->certs, cert))
140 		return 0;
141 	CRYPTO_add(&cert->references, 1, CRYPTO_LOCK_X509);
142 	return 1;
143 }
144 
145 /* Sign an OCSP request set the requestorName to the subjec
146  * name of an optional signers certificate and include one
147  * or more optional certificates in the request. Behaves
148  * like PKCS7_sign().
149  */
150 int
151 OCSP_request_sign(OCSP_REQUEST *req, X509 *signer, EVP_PKEY *key,
152     const EVP_MD *dgst, STACK_OF(X509) *certs, unsigned long flags)
153 {
154 	int i;
155 	OCSP_SIGNATURE *sig;
156 	X509 *x;
157 
158 	if (!OCSP_request_set1_name(req, X509_get_subject_name(signer)))
159 		goto err;
160 
161 	if (!(req->optionalSignature = sig = OCSP_SIGNATURE_new()))
162 		goto err;
163 	if (key) {
164 		if (!X509_check_private_key(signer, key)) {
165 			OCSPerr(OCSP_F_OCSP_REQUEST_SIGN,
166 			    OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE);
167 			goto err;
168 		}
169 		if (!OCSP_REQUEST_sign(req, key, dgst))
170 			goto err;
171 	}
172 
173 	if (!(flags & OCSP_NOCERTS)) {
174 		if (!OCSP_request_add1_cert(req, signer))
175 			goto err;
176 		for (i = 0; i < sk_X509_num(certs); i++) {
177 			x = sk_X509_value(certs, i);
178 			if (!OCSP_request_add1_cert(req, x))
179 				goto err;
180 		}
181 	}
182 
183 	return 1;
184 
185 err:
186 	OCSP_SIGNATURE_free(req->optionalSignature);
187 	req->optionalSignature = NULL;
188 	return 0;
189 }
190 
191 /* Get response status */
192 int
193 OCSP_response_status(OCSP_RESPONSE *resp)
194 {
195 	return ASN1_ENUMERATED_get(resp->responseStatus);
196 }
197 
198 /* Extract basic response from OCSP_RESPONSE or NULL if
199  * no basic response present.
200  */
201 OCSP_BASICRESP *
202 OCSP_response_get1_basic(OCSP_RESPONSE *resp)
203 {
204 	OCSP_RESPBYTES *rb;
205 
206 	rb = resp->responseBytes;
207 	if (!rb) {
208 		OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC,
209 		    OCSP_R_NO_RESPONSE_DATA);
210 		return NULL;
211 	}
212 	if (OBJ_obj2nid(rb->responseType) != NID_id_pkix_OCSP_basic) {
213 		OCSPerr(OCSP_F_OCSP_RESPONSE_GET1_BASIC,
214 		    OCSP_R_NOT_BASIC_RESPONSE);
215 		return NULL;
216 	}
217 
218 	return ASN1_item_unpack(rb->response, ASN1_ITEM_rptr(OCSP_BASICRESP));
219 }
220 
221 /* Return number of OCSP_SINGLERESP reponses present in
222  * a basic response.
223  */
224 int
225 OCSP_resp_count(OCSP_BASICRESP *bs)
226 {
227 	if (!bs)
228 		return -1;
229 	return sk_OCSP_SINGLERESP_num(bs->tbsResponseData->responses);
230 }
231 
232 /* Extract an OCSP_SINGLERESP response with a given index */
233 OCSP_SINGLERESP *
234 OCSP_resp_get0(OCSP_BASICRESP *bs, int idx)
235 {
236 	if (!bs)
237 		return NULL;
238 	return sk_OCSP_SINGLERESP_value(bs->tbsResponseData->responses, idx);
239 }
240 
241 /* Look single response matching a given certificate ID */
242 int
243 OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last)
244 {
245 	int i;
246 	STACK_OF(OCSP_SINGLERESP) *sresp;
247 	OCSP_SINGLERESP *single;
248 
249 	if (!bs)
250 		return -1;
251 	if (last < 0)
252 		last = 0;
253 	else
254 		last++;
255 	sresp = bs->tbsResponseData->responses;
256 	for (i = last; i < sk_OCSP_SINGLERESP_num(sresp); i++) {
257 		single = sk_OCSP_SINGLERESP_value(sresp, i);
258 		if (!OCSP_id_cmp(id, single->certId))
259 			return i;
260 	}
261 	return -1;
262 }
263 
264 /* Extract status information from an OCSP_SINGLERESP structure.
265  * Note: the revtime and reason values are only set if the
266  * certificate status is revoked. Returns numerical value of
267  * status.
268  */
269 int
270 OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
271     ASN1_GENERALIZEDTIME **revtime, ASN1_GENERALIZEDTIME **thisupd,
272     ASN1_GENERALIZEDTIME **nextupd)
273 {
274 	int ret;
275 	OCSP_CERTSTATUS *cst;
276 
277 	if (!single)
278 		return -1;
279 	cst = single->certStatus;
280 	ret = cst->type;
281 	if (ret == V_OCSP_CERTSTATUS_REVOKED) {
282 		OCSP_REVOKEDINFO *rev = cst->value.revoked;
283 
284 		if (revtime)
285 			*revtime = rev->revocationTime;
286 		if (reason) {
287 			if (rev->revocationReason)
288 				*reason = ASN1_ENUMERATED_get(
289 				    rev->revocationReason);
290 			else
291 				*reason = -1;
292 		}
293 	}
294 	if (thisupd)
295 		*thisupd = single->thisUpdate;
296 	if (nextupd)
297 		*nextupd = single->nextUpdate;
298 	return ret;
299 }
300 
301 /* This function combines the previous ones: look up a certificate ID and
302  * if found extract status information. Return 0 is successful.
303  */
304 int
305 OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
306     int *reason, ASN1_GENERALIZEDTIME **revtime, ASN1_GENERALIZEDTIME **thisupd,
307     ASN1_GENERALIZEDTIME **nextupd)
308 {
309 	int i;
310 	OCSP_SINGLERESP *single;
311 
312 	i = OCSP_resp_find(bs, id, -1);
313 	/* Maybe check for multiple responses and give an error? */
314 	if (i < 0)
315 		return 0;
316 	single = OCSP_resp_get0(bs, i);
317 	i = OCSP_single_get0_status(single, reason, revtime, thisupd, nextupd);
318 	if (status)
319 		*status = i;
320 	return 1;
321 }
322 
323 /* Check validity of thisUpdate and nextUpdate fields. It is possible that the request will
324  * take a few seconds to process and/or the time wont be totally accurate. Therefore to avoid
325  * rejecting otherwise valid time we allow the times to be within 'nsec' of the current time.
326  * Also to avoid accepting very old responses without a nextUpdate field an optional maxage
327  * parameter specifies the maximum age the thisUpdate field can be.
328  */
329 int
330 OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
331     ASN1_GENERALIZEDTIME *nextupd, long nsec, long maxsec)
332 {
333 	time_t t_now, t_tmp;
334 	struct tm tm_this, tm_next, tm_tmp;
335 
336 	time(&t_now);
337 
338 	/*
339 	 * Times must explicitly be a GENERALIZEDTIME as per section
340 	 * 4.2.2.1 of RFC 6960 - It is invalid to accept other times
341 	 * (such as UTCTIME permitted/required by RFC 5280 for certificates)
342 	 */
343 
344 	/* Check thisUpdate is valid and not more than nsec in the future */
345 	if (asn1_time_parse(thisupd->data, thisupd->length, &tm_this,
346 	    V_ASN1_GENERALIZEDTIME) != V_ASN1_GENERALIZEDTIME) {
347 		OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
348 		    OCSP_R_ERROR_IN_THISUPDATE_FIELD);
349 		return 0;
350 	} else {
351 		t_tmp = t_now + nsec;
352 		if (gmtime_r(&t_tmp, &tm_tmp) == NULL)
353 			return 0;
354 		if (asn1_tm_cmp(&tm_this, &tm_tmp) > 0) {
355 			OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
356 			    OCSP_R_STATUS_NOT_YET_VALID);
357 			return 0;
358 		}
359 
360 		/*
361 		 * If maxsec specified check thisUpdate is not more than maxsec
362 		 * in the past
363 		 */
364 		if (maxsec >= 0) {
365 			t_tmp = t_now - maxsec;
366 			if (gmtime_r(&t_tmp, &tm_tmp) == NULL)
367 				return 0;
368 			if (asn1_tm_cmp(&tm_this, &tm_tmp) < 0) {
369 				OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
370 				    OCSP_R_STATUS_TOO_OLD);
371 				return 0;
372 			}
373 		}
374 	}
375 
376 	if (!nextupd)
377 		return 1;
378 
379 	/* Check nextUpdate is valid and not more than nsec in the past */
380 	if (asn1_time_parse(nextupd->data, nextupd->length, &tm_next,
381 	    V_ASN1_GENERALIZEDTIME) != V_ASN1_GENERALIZEDTIME) {
382 		OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
383 		    OCSP_R_ERROR_IN_NEXTUPDATE_FIELD);
384 		return 0;
385 	} else {
386 		t_tmp = t_now - nsec;
387 		if (gmtime_r(&t_tmp, &tm_tmp) == NULL)
388 			return 0;
389 		if (asn1_tm_cmp(&tm_next, &tm_tmp) < 0) {
390 			OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
391 			    OCSP_R_STATUS_EXPIRED);
392 			return 0;
393 		}
394 	}
395 
396 	/* Also don't allow nextUpdate to precede thisUpdate */
397 	if (asn1_tm_cmp(&tm_next, &tm_this) < 0) {
398 		OCSPerr(OCSP_F_OCSP_CHECK_VALIDITY,
399 		    OCSP_R_NEXTUPDATE_BEFORE_THISUPDATE);
400 		return 0;
401 	}
402 
403 	return 1;
404 }
405