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