2 * Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
12 #include "cmp_local.h"
13 #include "internal/cryptlib.h"
14 #include "e_os.h" /* ossl_sleep() */
16 /* explicit #includes not strictly needed since implied by the above: */
17 #include <openssl/bio.h>
18 #include <openssl/cmp.h>
19 #include <openssl/err.h>
20 #include <openssl/evp.h>
21 #include <openssl/x509v3.h>
22 #include <openssl/cmp_util.h>
24 #define IS_CREP(t) ((t) == OSSL_CMP_PKIBODY_IP || (t) == OSSL_CMP_PKIBODY_CP \
25 || (t) == OSSL_CMP_PKIBODY_KUP)
28 * Evaluate whether there's an exception (violating the standard) configured for
29 * handling negative responses without protection or with invalid protection.
30 * Returns 1 on acceptance, 0 on rejection, or -1 on (internal) error.
32 static int unprotected_exception(const OSSL_CMP_CTX
*ctx
,
33 const OSSL_CMP_MSG
*rep
,
34 int invalid_protection
,
35 int expected_type
/* ignored here */)
37 int rcvd_type
= ossl_cmp_msg_get_bodytype(rep
/* may be NULL */);
38 const char *msg_type
= NULL
;
40 if (!ossl_assert(ctx
!= NULL
&& rep
!= NULL
))
43 if (!ctx
->unprotectedErrors
)
47 case OSSL_CMP_PKIBODY_ERROR
:
48 msg_type
= "error response";
50 case OSSL_CMP_PKIBODY_RP
:
53 ossl_cmp_revrepcontent_get_pkisi(rep
->body
->value
.rp
,
58 if (ossl_cmp_pkisi_get_status(si
) == OSSL_CMP_PKISTATUS_rejection
)
59 msg_type
= "revocation response message with rejection status";
62 case OSSL_CMP_PKIBODY_PKICONF
:
63 msg_type
= "PKI Confirmation message";
66 if (IS_CREP(rcvd_type
)) {
67 OSSL_CMP_CERTREPMESSAGE
*crepmsg
= rep
->body
->value
.ip
;
68 OSSL_CMP_CERTRESPONSE
*crep
=
69 ossl_cmp_certrepmessage_get0_certresponse(crepmsg
,
72 if (sk_OSSL_CMP_CERTRESPONSE_num(crepmsg
->response
) > 1)
74 /* TODO: handle potentially multiple CertResponses in CertRepMsg */
77 if (ossl_cmp_pkisi_get_status(crep
->status
)
78 == OSSL_CMP_PKISTATUS_rejection
)
79 msg_type
= "CertRepMessage with rejection status";
84 ossl_cmp_log2(WARN
, ctx
, "ignoring %s protection of %s",
85 invalid_protection
? "invalid" : "missing", msg_type
);
89 /* Save error info from PKIStatusInfo field of a certresponse into ctx */
90 static int save_statusInfo(OSSL_CMP_CTX
*ctx
, OSSL_CMP_PKISI
*si
)
93 OSSL_CMP_PKIFREETEXT
*ss
;
95 if (!ossl_assert(ctx
!= NULL
&& si
!= NULL
))
98 if ((ctx
->status
= ossl_cmp_pkisi_get_status(si
)) < 0)
101 ctx
->failInfoCode
= 0;
102 if (si
->failInfo
!= NULL
) {
103 for (i
= 0; i
<= OSSL_CMP_PKIFAILUREINFO_MAX
; i
++) {
104 if (ASN1_BIT_STRING_get_bit(si
->failInfo
, i
))
105 ctx
->failInfoCode
|= (1 << i
);
109 if (!ossl_cmp_ctx_set0_statusString(ctx
, sk_ASN1_UTF8STRING_new_null())
110 || (ctx
->statusString
== NULL
))
113 ss
= si
->statusString
; /* may be NULL */
114 for (i
= 0; i
< sk_ASN1_UTF8STRING_num(ss
); i
++) {
115 ASN1_UTF8STRING
*str
= sk_ASN1_UTF8STRING_value(ss
, i
);
117 if (!sk_ASN1_UTF8STRING_push(ctx
->statusString
, ASN1_STRING_dup(str
)))
124 * Perform the generic aspects of sending a request and receiving a response.
125 * Returns 1 on success and provides the received PKIMESSAGE in *rep.
126 * Returns 0 on error.
127 * Regardless of success, caller is responsible for freeing *rep (unless NULL).
129 static int send_receive_check(OSSL_CMP_CTX
*ctx
, const OSSL_CMP_MSG
*req
,
130 OSSL_CMP_MSG
**rep
, int expected_type
)
132 int is_enrollment
= IS_CREP(expected_type
)
133 || expected_type
== OSSL_CMP_PKIBODY_POLLREP
134 || expected_type
== OSSL_CMP_PKIBODY_PKICONF
;
135 const char *req_type_str
=
136 ossl_cmp_bodytype_to_string(ossl_cmp_msg_get_bodytype(req
));
137 const char *expected_type_str
= ossl_cmp_bodytype_to_string(expected_type
);
140 time_t now
= time(NULL
);
142 OSSL_CMP_transfer_cb_t transfer_cb
= ctx
->transfer_cb
;
144 if (transfer_cb
== NULL
)
145 transfer_cb
= OSSL_CMP_MSG_http_perform
;
148 msg_timeout
= ctx
->msg_timeout
; /* backup original value */
149 if (is_enrollment
&& ctx
->total_timeout
> 0 /* timeout is not infinite */) {
150 if (now
>= ctx
->end_time
) {
151 ERR_raise(ERR_LIB_CMP
, CMP_R_TOTAL_TIMEOUT
);
154 if (!ossl_assert(ctx
->end_time
- time(NULL
) < INT_MAX
)) {
155 /* actually cannot happen due to assignment in initial_certreq() */
156 ERR_raise(ERR_LIB_CMP
, CMP_R_INVALID_ARGS
);
159 time_left
= (int)(ctx
->end_time
- now
);
160 if (ctx
->msg_timeout
== 0 || time_left
< ctx
->msg_timeout
)
161 ctx
->msg_timeout
= time_left
;
164 /* should print error queue since transfer_cb may call ERR_clear_error() */
165 OSSL_CMP_CTX_print_errors(ctx
);
167 ossl_cmp_log1(INFO
, ctx
, "sending %s", req_type_str
);
169 *rep
= (*transfer_cb
)(ctx
, req
);
170 ctx
->msg_timeout
= msg_timeout
; /* restore original value */
173 ERR_raise_data(ERR_LIB_CMP
,
174 ctx
->total_timeout
> 0 && time(NULL
) >= ctx
->end_time
?
175 CMP_R_TOTAL_TIMEOUT
: CMP_R_TRANSFER_ERROR
,
176 "request sent: %s, expected response: %s",
177 req_type_str
, expected_type_str
);
181 bt
= ossl_cmp_msg_get_bodytype(*rep
);
183 * The body type in the 'bt' variable is not yet verified.
184 * Still we use this preliminary value already for a progress report because
185 * the following msg verification may also produce log entries and may fail.
187 ossl_cmp_log1(INFO
, ctx
, "received %s", ossl_cmp_bodytype_to_string(bt
));
189 /* copy received extraCerts to ctx->extraCertsIn so they can be retrieved */
190 if (bt
!= OSSL_CMP_PKIBODY_POLLREP
&& bt
!= OSSL_CMP_PKIBODY_PKICONF
191 && !ossl_cmp_ctx_set1_extraCertsIn(ctx
, (*rep
)->extraCerts
))
194 if (!ossl_cmp_msg_check_update(ctx
, *rep
, unprotected_exception
,
198 if (bt
== expected_type
199 /* as an answer to polling, there could be IP/CP/KUP: */
200 || (IS_CREP(bt
) && expected_type
== OSSL_CMP_PKIBODY_POLLREP
))
203 /* received message type is not one of the expected ones (e.g., error) */
204 ERR_raise(ERR_LIB_CMP
, bt
== OSSL_CMP_PKIBODY_ERROR
? CMP_R_RECEIVED_ERROR
:
205 CMP_R_UNEXPECTED_PKIBODY
); /* in next line for mkerr.pl */
207 if (bt
!= OSSL_CMP_PKIBODY_ERROR
) {
208 ERR_add_error_data(3, "message type is '",
209 ossl_cmp_bodytype_to_string(bt
), "'");
211 OSSL_CMP_ERRORMSGCONTENT
*emc
= (*rep
)->body
->value
.error
;
212 OSSL_CMP_PKISI
*si
= emc
->pKIStatusInfo
;
213 char buf
[OSSL_CMP_PKISI_BUFLEN
];
215 if (save_statusInfo(ctx
, si
)
216 && OSSL_CMP_CTX_snprint_PKIStatus(ctx
, buf
,
217 sizeof(buf
)) != NULL
)
218 ERR_add_error_data(1, buf
);
219 if (emc
->errorCode
!= NULL
220 && BIO_snprintf(buf
, sizeof(buf
), "; errorCode: %ld",
221 ASN1_INTEGER_get(emc
->errorCode
)) > 0)
222 ERR_add_error_data(1, buf
);
223 if (emc
->errorDetails
!= NULL
) {
224 char *text
= ossl_sk_ASN1_UTF8STRING2text(emc
->errorDetails
, ", ",
225 OSSL_CMP_PKISI_BUFLEN
- 1);
228 ERR_add_error_data(2, "; errorDetails: ", text
);
231 if (ctx
->status
!= OSSL_CMP_PKISTATUS_rejection
) {
232 ERR_raise(ERR_LIB_CMP
, CMP_R_UNEXPECTED_PKISTATUS
);
233 if (ctx
->status
== OSSL_CMP_PKISTATUS_waiting
)
234 ctx
->status
= OSSL_CMP_PKISTATUS_rejection
;
241 * When a 'waiting' PKIStatus has been received, this function is used to
242 * poll, which should yield a pollRep or finally a CertRepMessage in ip/cp/kup.
243 * On receiving a pollRep, which includes a checkAfter value, it return this
244 * value if sleep == 0, else it sleeps as long as indicated and retries.
246 * A transaction timeout is enabled if ctx->total_timeout is > 0.
247 * In this case polling will continue until the timeout is reached and then
248 * polling is done a last time even if this is before the "checkAfter" time.
250 * Returns -1 on receiving pollRep if sleep == 0, setting the checkAfter value.
251 * Returns 1 on success and provides the received PKIMESSAGE in *rep.
252 * In this case the caller is responsible for freeing *rep.
253 * Returns 0 on error (which includes the case that timeout has been reached).
255 static int poll_for_response(OSSL_CMP_CTX
*ctx
, int sleep
, int rid
,
256 OSSL_CMP_MSG
**rep
, int *checkAfter
)
258 OSSL_CMP_MSG
*preq
= NULL
;
259 OSSL_CMP_MSG
*prep
= NULL
;
262 "received 'waiting' PKIStatus, starting to poll for response");
265 /* TODO: handle potentially multiple poll requests per message */
266 if ((preq
= ossl_cmp_pollReq_new(ctx
, rid
)) == NULL
)
269 if (!send_receive_check(ctx
, preq
, &prep
, OSSL_CMP_PKIBODY_POLLREP
))
272 /* handle potential pollRep */
273 if (ossl_cmp_msg_get_bodytype(prep
) == OSSL_CMP_PKIBODY_POLLREP
) {
274 OSSL_CMP_POLLREPCONTENT
*prc
= prep
->body
->value
.pollRep
;
275 OSSL_CMP_POLLREP
*pollRep
= NULL
;
277 char str
[OSSL_CMP_PKISI_BUFLEN
];
280 /* TODO: handle potentially multiple elements in pollRep */
281 if (sk_OSSL_CMP_POLLREP_num(prc
) > 1) {
282 ERR_raise(ERR_LIB_CMP
, CMP_R_MULTIPLE_RESPONSES_NOT_SUPPORTED
);
285 pollRep
= ossl_cmp_pollrepcontent_get0_pollrep(prc
, rid
);
289 if (!ASN1_INTEGER_get_int64(&check_after
, pollRep
->checkAfter
)) {
290 ERR_raise(ERR_LIB_CMP
, CMP_R_BAD_CHECKAFTER_IN_POLLREP
);
293 if (check_after
< 0 || (uint64_t)check_after
294 > (sleep
? ULONG_MAX
/ 1000 : INT_MAX
)) {
295 ERR_raise(ERR_LIB_CMP
, CMP_R_CHECKAFTER_OUT_OF_RANGE
);
296 if (BIO_snprintf(str
, OSSL_CMP_PKISI_BUFLEN
, "value = %jd",
298 ERR_add_error_data(1, str
);
301 if (ctx
->total_timeout
> 0) { /* timeout is not infinite */
302 const int exp
= 5; /* expected max time per msg round trip */
303 int64_t time_left
= (int64_t)(ctx
->end_time
- exp
- time(NULL
));
305 if (time_left
<= 0) {
306 ERR_raise(ERR_LIB_CMP
, CMP_R_TOTAL_TIMEOUT
);
309 if (time_left
< check_after
)
310 check_after
= time_left
;
311 /* poll one last time just when timeout was reached */
314 if (pollRep
->reason
== NULL
315 || (len
= BIO_snprintf(str
, OSSL_CMP_PKISI_BUFLEN
,
316 " with reason = '")) < 0) {
319 char *text
= ossl_sk_ASN1_UTF8STRING2text(pollRep
->reason
, ", ",
320 sizeof(str
) - len
- 2);
323 || BIO_snprintf(str
+ len
, sizeof(str
) - len
,
328 ossl_cmp_log2(INFO
, ctx
,
329 "received polling response%s; checkAfter = %ld seconds",
332 OSSL_CMP_MSG_free(preq
);
334 OSSL_CMP_MSG_free(prep
);
337 ossl_sleep((unsigned long)(1000 * check_after
));
339 if (checkAfter
!= NULL
)
340 *checkAfter
= (int)check_after
;
341 return -1; /* exits the loop */
344 ossl_cmp_info(ctx
, "received ip/cp/kup after polling");
345 /* any other body type has been rejected by send_receive_check() */
352 OSSL_CMP_MSG_free(preq
);
357 OSSL_CMP_MSG_free(preq
);
358 OSSL_CMP_MSG_free(prep
);
362 /* Send certConf for IR, CR or KUR sequences and check response */
363 int ossl_cmp_exchange_certConf(OSSL_CMP_CTX
*ctx
, int fail_info
,
366 OSSL_CMP_MSG
*certConf
;
367 OSSL_CMP_MSG
*PKIconf
= NULL
;
370 /* OSSL_CMP_certConf_new() also checks if all necessary options are set */
371 if ((certConf
= ossl_cmp_certConf_new(ctx
, fail_info
, txt
)) == NULL
)
374 res
= send_receive_check(ctx
, certConf
, &PKIconf
, OSSL_CMP_PKIBODY_PKICONF
);
377 OSSL_CMP_MSG_free(certConf
);
378 OSSL_CMP_MSG_free(PKIconf
);
382 /* Send given error and check response */
383 int ossl_cmp_exchange_error(OSSL_CMP_CTX
*ctx
, int status
, int fail_info
,
384 const char *txt
, int errorCode
, const char *details
)
386 OSSL_CMP_MSG
*error
= NULL
;
387 OSSL_CMP_PKISI
*si
= NULL
;
388 OSSL_CMP_MSG
*PKIconf
= NULL
;
391 if ((si
= OSSL_CMP_STATUSINFO_new(status
, fail_info
, txt
)) == NULL
)
393 /* ossl_cmp_error_new() also checks if all necessary options are set */
394 if ((error
= ossl_cmp_error_new(ctx
, si
, errorCode
, details
, 0)) == NULL
)
397 res
= send_receive_check(ctx
, error
, &PKIconf
, OSSL_CMP_PKIBODY_PKICONF
);
400 OSSL_CMP_MSG_free(error
);
401 OSSL_CMP_PKISI_free(si
);
402 OSSL_CMP_MSG_free(PKIconf
);
407 * Retrieve a copy of the certificate, if any, from the given CertResponse.
408 * Take into account PKIStatusInfo of CertResponse in ctx, report it on error.
409 * Returns NULL if not found or on error.
411 static X509
*get1_cert_status(OSSL_CMP_CTX
*ctx
, int bodytype
,
412 OSSL_CMP_CERTRESPONSE
*crep
)
414 char buf
[OSSL_CMP_PKISI_BUFLEN
];
418 if (!ossl_assert(ctx
!= NULL
&& crep
!= NULL
))
421 privkey
= OSSL_CMP_CTX_get0_newPkey(ctx
, 1);
422 switch (ossl_cmp_pkisi_get_status(crep
->status
)) {
423 case OSSL_CMP_PKISTATUS_waiting
:
425 "received \"waiting\" status for cert when actually aiming to extract cert");
426 ERR_raise(ERR_LIB_CMP
, CMP_R_ENCOUNTERED_WAITING
);
428 case OSSL_CMP_PKISTATUS_grantedWithMods
:
429 ossl_cmp_warn(ctx
, "received \"grantedWithMods\" for certificate");
431 case OSSL_CMP_PKISTATUS_accepted
:
433 /* get all information in case of a rejection before going to error */
434 case OSSL_CMP_PKISTATUS_rejection
:
435 ossl_cmp_err(ctx
, "received \"rejection\" status rather than cert");
436 ERR_raise(ERR_LIB_CMP
, CMP_R_REQUEST_REJECTED_BY_SERVER
);
438 case OSSL_CMP_PKISTATUS_revocationWarning
:
440 "received \"revocationWarning\" - a revocation of the cert is imminent");
442 case OSSL_CMP_PKISTATUS_revocationNotification
:
444 "received \"revocationNotification\" - a revocation of the cert has occurred");
446 case OSSL_CMP_PKISTATUS_keyUpdateWarning
:
447 if (bodytype
!= OSSL_CMP_PKIBODY_KUR
) {
448 ERR_raise(ERR_LIB_CMP
, CMP_R_ENCOUNTERED_KEYUPDATEWARNING
);
453 ossl_cmp_log1(ERROR
, ctx
,
454 "received unsupported PKIStatus %d for certificate",
456 ERR_raise(ERR_LIB_CMP
, CMP_R_UNKNOWN_PKISTATUS
);
459 crt
= ossl_cmp_certresponse_get1_cert(crep
, ctx
, privkey
);
460 if (crt
== NULL
) /* according to PKIStatus, we can expect a cert */
461 ERR_raise(ERR_LIB_CMP
, CMP_R_CERTIFICATE_NOT_FOUND
);
466 if (OSSL_CMP_CTX_snprint_PKIStatus(ctx
, buf
, sizeof(buf
)) != NULL
)
467 ERR_add_error_data(1, buf
);
472 * Callback fn validating that the new certificate can be verified, using
473 * ctx->certConf_cb_arg, which has been initialized using opt_out_trusted, and
474 * ctx->untrusted, which at this point already contains msg->extraCerts.
475 * Returns 0 on acceptance, else a bit field reflecting PKIFailureInfo.
476 * Quoting from RFC 4210 section 5.1. Overall PKI Message:
477 * The extraCerts field can contain certificates that may be useful to
478 * the recipient. For example, this can be used by a CA or RA to
479 * present an end entity with certificates that it needs to verify its
480 * own new certificate (if, for example, the CA that issued the end
481 * entity's certificate is not a root CA for the end entity). Note that
482 * this field does not necessarily contain a certification path; the
483 * recipient may have to sort, select from, or otherwise process the
484 * extra certificates in order to use them.
485 * Note: While often handy, there is no hard requirement by CMP that
486 * an EE must be able to validate the certificates it gets enrolled.
488 int OSSL_CMP_certConf_cb(OSSL_CMP_CTX
*ctx
, X509
*cert
, int fail_info
,
491 X509_STORE
*out_trusted
= OSSL_CMP_CTX_get_certConf_cb_arg(ctx
);
492 STACK_OF(X509
) *chain
= NULL
;
493 (void)text
; /* make (artificial) use of var to prevent compiler warning */
495 if (fail_info
!= 0) /* accept any error flagged by CMP core library */
498 ossl_cmp_debug(ctx
, "trying to build chain for newly enrolled cert");
499 chain
= X509_build_chain(cert
, ctx
->untrusted
, out_trusted
/* maybe NULL */,
500 0, ctx
->libctx
, ctx
->propq
);
501 if (sk_X509_num(chain
) > 0)
502 X509_free(sk_X509_shift(chain
)); /* remove leaf (EE) cert */
503 if (out_trusted
!= NULL
) {
505 ossl_cmp_err(ctx
, "failed building chain for newly enrolled cert");
506 fail_info
= 1 << OSSL_CMP_PKIFAILUREINFO_incorrectData
;
509 "succeeded building proper chain for newly enrolled cert");
511 } else if (chain
== NULL
) {
512 ossl_cmp_warn(ctx
, "could not build approximate chain for newly enrolled cert, resorting to received extraCerts");
513 chain
= OSSL_CMP_CTX_get1_extraCertsIn(ctx
);
516 "success building approximate chain for newly enrolled cert");
518 (void)ossl_cmp_ctx_set1_newChain(ctx
, chain
);
519 sk_X509_pop_free(chain
, X509_free
);
525 * Perform the generic handling of certificate responses for IR/CR/KUR/P10CR.
526 * Returns -1 on receiving pollRep if sleep == 0, setting the checkAfter value.
527 * Returns 1 on success and provides the received PKIMESSAGE in *resp.
528 * Returns 0 on error (which includes the case that timeout has been reached).
529 * Regardless of success, caller is responsible for freeing *resp (unless NULL).
531 static int cert_response(OSSL_CMP_CTX
*ctx
, int sleep
, int rid
,
532 OSSL_CMP_MSG
**resp
, int *checkAfter
,
533 int req_type
, int expected_type
)
535 EVP_PKEY
*rkey
= OSSL_CMP_CTX_get0_newPkey(ctx
/* may be NULL */, 0);
536 int fail_info
= 0; /* no failure */
537 const char *txt
= NULL
;
538 OSSL_CMP_CERTREPMESSAGE
*crepmsg
;
539 OSSL_CMP_CERTRESPONSE
*crep
;
540 OSSL_CMP_certConf_cb_t cb
;
545 if (!ossl_assert(ctx
!= NULL
))
549 crepmsg
= (*resp
)->body
->value
.ip
; /* same for cp and kup */
550 if (sk_OSSL_CMP_CERTRESPONSE_num(crepmsg
->response
) > 1) {
551 ERR_raise(ERR_LIB_CMP
, CMP_R_MULTIPLE_RESPONSES_NOT_SUPPORTED
);
554 /* TODO: handle potentially multiple CertResponses in CertRepMsg */
555 crep
= ossl_cmp_certrepmessage_get0_certresponse(crepmsg
, rid
);
558 if (!save_statusInfo(ctx
, crep
->status
))
561 /* for OSSL_CMP_PKIBODY_P10CR learn CertReqId from response */
562 rid
= ossl_cmp_asn1_get_int(crep
->certReqId
);
564 ERR_raise(ERR_LIB_CMP
, CMP_R_BAD_REQUEST_ID
);
569 if (ossl_cmp_pkisi_get_status(crep
->status
) == OSSL_CMP_PKISTATUS_waiting
) {
570 OSSL_CMP_MSG_free(*resp
);
572 if ((ret
= poll_for_response(ctx
, sleep
, rid
, resp
, checkAfter
)) != 0) {
573 if (ret
== -1) /* at this point implies sleep == 0 */
574 return ret
; /* waiting */
575 goto retry
; /* got ip/cp/kup, which may still indicate 'waiting' */
577 ERR_raise(ERR_LIB_CMP
, CMP_R_POLLING_FAILED
);
582 cert
= get1_cert_status(ctx
, (*resp
)->body
->type
, crep
);
584 ERR_add_error_data(1, "; cannot extract certificate from response");
587 if (!ossl_cmp_ctx_set0_newCert(ctx
, cert
))
591 * if the CMP server returned certificates in the caPubs field, copy them
592 * to the context so that they can be retrieved if necessary
594 if (crepmsg
->caPubs
!= NULL
595 && !ossl_cmp_ctx_set1_caPubs(ctx
, crepmsg
->caPubs
))
598 subj
= X509_NAME_oneline(X509_get_subject_name(cert
), NULL
, 0);
600 /* X509_check_private_key() also works if rkey is just public key */
601 && !(X509_check_private_key(ctx
->newCert
, rkey
))) {
602 fail_info
= 1 << OSSL_CMP_PKIFAILUREINFO_incorrectData
;
603 txt
= "public key in new certificate does not match our enrollment key";
605 * not calling (void)ossl_cmp_exchange_error(ctx,
606 * OSSL_CMP_PKISTATUS_rejection, fail_info, txt)
607 * not throwing CMP_R_CERTIFICATE_NOT_ACCEPTED with txt
609 * since we better leave this for the certConf_cb to decide
614 * Execute the certification checking callback function,
615 * which can determine whether to accept a newly enrolled certificate.
616 * It may overrule the pre-decision reflected in 'fail_info' and '*txt'.
618 cb
= ctx
->certConf_cb
!= NULL
? ctx
->certConf_cb
: OSSL_CMP_certConf_cb
;
619 if ((fail_info
= cb(ctx
, ctx
->newCert
, fail_info
, &txt
)) != 0
621 txt
= "CMP client did not accept it";
622 if (fail_info
!= 0) /* immediately log error before any certConf exchange */
623 ossl_cmp_log1(ERROR
, ctx
,
624 "rejecting newly enrolled cert with subject: %s", subj
);
627 * TODO: better move certConf exchange to do_certreq_seq() such that
628 * also more low-level errors with CertReqMessages get reported to server
630 if (!ctx
->disableConfirm
631 && !ossl_cmp_hdr_has_implicitConfirm((*resp
)->header
)) {
632 if (!ossl_cmp_exchange_certConf(ctx
, fail_info
, txt
))
636 /* not throwing failure earlier as transfer_cb may call ERR_clear_error() */
637 if (fail_info
!= 0) {
638 ERR_raise_data(ERR_LIB_CMP
, CMP_R_CERTIFICATE_NOT_ACCEPTED
,
639 "rejecting newly enrolled cert with subject: %s; %s",
647 static int initial_certreq(OSSL_CMP_CTX
*ctx
,
648 int req_type
, const OSSL_CRMF_MSG
*crm
,
649 OSSL_CMP_MSG
**p_rep
, int rep_type
)
655 if (!ossl_cmp_ctx_set0_newCert(ctx
, NULL
))
658 if (ctx
->total_timeout
> 0) /* else ctx->end_time is not used */
659 ctx
->end_time
= time(NULL
) + ctx
->total_timeout
;
661 /* also checks if all necessary options are set */
662 if ((req
= ossl_cmp_certreq_new(ctx
, req_type
, crm
)) == NULL
)
665 res
= send_receive_check(ctx
, req
, p_rep
, rep_type
);
666 OSSL_CMP_MSG_free(req
);
670 int OSSL_CMP_try_certreq(OSSL_CMP_CTX
*ctx
, int req_type
,
671 const OSSL_CRMF_MSG
*crm
, int *checkAfter
)
673 OSSL_CMP_MSG
*rep
= NULL
;
674 int is_p10
= req_type
== OSSL_CMP_PKIBODY_P10CR
;
675 int rid
= is_p10
? -1 : OSSL_CMP_CERTREQID
;
676 int rep_type
= is_p10
? OSSL_CMP_PKIBODY_CP
: req_type
+ 1;
680 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
684 if (ctx
->status
!= OSSL_CMP_PKISTATUS_waiting
) { /* not polling already */
685 if (!initial_certreq(ctx
, req_type
, crm
, &rep
, rep_type
))
689 return ossl_cmp_exchange_error(ctx
, OSSL_CMP_PKISTATUS_rejection
,
690 0 /* TODO better fail_info value? */,
691 "polling aborted", 0 /* errorCode */,
693 res
= poll_for_response(ctx
, 0 /* no sleep */, rid
, &rep
, checkAfter
);
694 if (res
<= 0) /* waiting or error */
697 res
= cert_response(ctx
, 0 /* no sleep */, rid
, &rep
, checkAfter
,
701 OSSL_CMP_MSG_free(rep
);
706 * Do the full sequence CR/IR/KUR/P10CR, CP/IP/KUP/CP,
707 * certConf, PKIconf, and polling if required.
708 * Will sleep as long as indicated by the server (according to checkAfter).
709 * All enrollment options need to be present in the context.
710 * TODO: another function to request two certificates at once should be created.
711 * Returns pointer to received certificate, or NULL if none was received.
713 X509
*OSSL_CMP_exec_certreq(OSSL_CMP_CTX
*ctx
, int req_type
,
714 const OSSL_CRMF_MSG
*crm
)
717 OSSL_CMP_MSG
*rep
= NULL
;
718 int is_p10
= req_type
== OSSL_CMP_PKIBODY_P10CR
;
719 int rid
= is_p10
? -1 : OSSL_CMP_CERTREQID
;
720 int rep_type
= is_p10
? OSSL_CMP_PKIBODY_CP
: req_type
+ 1;
724 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
728 if (!initial_certreq(ctx
, req_type
, crm
, &rep
, rep_type
))
731 if (cert_response(ctx
, 1 /* sleep */, rid
, &rep
, NULL
, req_type
, rep_type
)
735 result
= ctx
->newCert
;
737 OSSL_CMP_MSG_free(rep
);
741 int OSSL_CMP_exec_RR_ses(OSSL_CMP_CTX
*ctx
)
743 OSSL_CMP_MSG
*rr
= NULL
;
744 OSSL_CMP_MSG
*rp
= NULL
;
745 const int num_RevDetails
= 1;
746 const int rsid
= OSSL_CMP_REVREQSID
;
747 OSSL_CMP_REVREPCONTENT
*rrep
= NULL
;
748 OSSL_CMP_PKISI
*si
= NULL
;
749 char buf
[OSSL_CMP_PKISI_BUFLEN
];
753 ERR_raise(ERR_LIB_CMP
, CMP_R_INVALID_ARGS
);
756 if (ctx
->oldCert
== NULL
&& ctx
->p10CSR
== NULL
) {
757 ERR_raise(ERR_LIB_CMP
, CMP_R_MISSING_REFERENCE_CERT
);
762 /* OSSL_CMP_rr_new() also checks if all necessary options are set */
763 if ((rr
= ossl_cmp_rr_new(ctx
)) == NULL
)
766 if (!send_receive_check(ctx
, rr
, &rp
, OSSL_CMP_PKIBODY_RP
))
769 rrep
= rp
->body
->value
.rp
;
770 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
771 if (sk_OSSL_CMP_PKISI_num(rrep
->status
) != num_RevDetails
) {
772 ERR_raise(ERR_LIB_CMP
, CMP_R_WRONG_RP_COMPONENT_COUNT
);
776 if (sk_OSSL_CMP_PKISI_num(rrep
->status
) < 1) {
777 ERR_raise(ERR_LIB_CMP
, CMP_R_WRONG_RP_COMPONENT_COUNT
);
782 /* evaluate PKIStatus field */
783 si
= ossl_cmp_revrepcontent_get_pkisi(rrep
, rsid
);
784 if (!save_statusInfo(ctx
, si
))
786 switch (ossl_cmp_pkisi_get_status(si
)) {
787 case OSSL_CMP_PKISTATUS_accepted
:
788 ossl_cmp_info(ctx
, "revocation accepted (PKIStatus=accepted)");
791 case OSSL_CMP_PKISTATUS_grantedWithMods
:
792 ossl_cmp_info(ctx
, "revocation accepted (PKIStatus=grantedWithMods)");
795 case OSSL_CMP_PKISTATUS_rejection
:
796 ERR_raise(ERR_LIB_CMP
, CMP_R_REQUEST_REJECTED_BY_SERVER
);
798 case OSSL_CMP_PKISTATUS_revocationWarning
:
799 ossl_cmp_info(ctx
, "revocation accepted (PKIStatus=revocationWarning)");
802 case OSSL_CMP_PKISTATUS_revocationNotification
:
803 /* interpretation as warning or error depends on CA */
805 "revocation accepted (PKIStatus=revocationNotification)");
808 case OSSL_CMP_PKISTATUS_waiting
:
809 case OSSL_CMP_PKISTATUS_keyUpdateWarning
:
810 ERR_raise(ERR_LIB_CMP
, CMP_R_UNEXPECTED_PKISTATUS
);
813 ERR_raise(ERR_LIB_CMP
, CMP_R_UNKNOWN_PKISTATUS
);
817 /* check any present CertId in optional revCerts field */
818 if (sk_OSSL_CRMF_CERTID_num(rrep
->revCerts
) >= 1) {
819 OSSL_CRMF_CERTID
*cid
;
820 OSSL_CRMF_CERTTEMPLATE
*tmpl
=
821 sk_OSSL_CMP_REVDETAILS_value(rr
->body
->value
.rr
, rsid
)->certDetails
;
822 const X509_NAME
*issuer
= OSSL_CRMF_CERTTEMPLATE_get0_issuer(tmpl
);
823 ASN1_INTEGER
*serial
= OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(tmpl
);
825 if (sk_OSSL_CRMF_CERTID_num(rrep
->revCerts
) != num_RevDetails
) {
826 ERR_raise(ERR_LIB_CMP
, CMP_R_WRONG_RP_COMPONENT_COUNT
);
830 if ((cid
= ossl_cmp_revrepcontent_get_CertId(rrep
, rsid
)) == NULL
) {
834 if (X509_NAME_cmp(issuer
, OSSL_CRMF_CERTID_get0_issuer(cid
)) != 0) {
835 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
836 ERR_raise(ERR_LIB_CMP
, CMP_R_WRONG_CERTID_IN_RP
);
841 if (ASN1_INTEGER_cmp(serial
,
842 OSSL_CRMF_CERTID_get0_serialNumber(cid
)) != 0) {
843 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
844 ERR_raise(ERR_LIB_CMP
, CMP_R_WRONG_SERIAL_IN_RP
);
851 /* check number of any optionally present crls */
852 if (rrep
->crls
!= NULL
&& sk_X509_CRL_num(rrep
->crls
) != num_RevDetails
) {
853 ERR_raise(ERR_LIB_CMP
, CMP_R_WRONG_RP_COMPONENT_COUNT
);
860 && OSSL_CMP_CTX_snprint_PKIStatus(ctx
, buf
, sizeof(buf
)) != NULL
)
861 ERR_add_error_data(1, buf
);
864 OSSL_CMP_MSG_free(rr
);
865 OSSL_CMP_MSG_free(rp
);
869 STACK_OF(OSSL_CMP_ITAV
) *OSSL_CMP_exec_GENM_ses(OSSL_CMP_CTX
*ctx
)
872 OSSL_CMP_MSG
*genp
= NULL
;
873 STACK_OF(OSSL_CMP_ITAV
) *rcvd_itavs
= NULL
;
876 ERR_raise(ERR_LIB_CMP
, CMP_R_INVALID_ARGS
);
881 if ((genm
= ossl_cmp_genm_new(ctx
)) == NULL
)
884 if (!send_receive_check(ctx
, genm
, &genp
, OSSL_CMP_PKIBODY_GENP
))
887 /* received stack of itavs not to be freed with the genp */
888 rcvd_itavs
= genp
->body
->value
.genp
;
889 genp
->body
->value
.genp
= NULL
;
892 OSSL_CMP_MSG_free(genm
);
893 OSSL_CMP_MSG_free(genp
);
895 return rcvd_itavs
; /* recv_itavs == NULL indicates an error */