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 <openssl/trace.h>
13 #include <openssl/bio.h>
14 #include <openssl/ocsp.h> /* for OCSP_REVOKED_STATUS_* */
16 #include "cmp_local.h"
18 /* explicit #includes not strictly needed since implied by the above: */
19 #include <openssl/cmp.h>
20 #include <openssl/crmf.h>
21 #include <openssl/err.h>
23 #define DEFINE_OSSL_CMP_CTX_get0(FIELD, TYPE) \
24 DEFINE_OSSL_CMP_CTX_get0_NAME(FIELD, FIELD, TYPE)
25 #define DEFINE_OSSL_CMP_CTX_get0_NAME(NAME, FIELD, TYPE) \
26 TYPE *OSSL_CMP_CTX_get0_##NAME(const OSSL_CMP_CTX *ctx) \
29 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
36 * Get current certificate store containing trusted root CA certs
38 DEFINE_OSSL_CMP_CTX_get0_NAME(trusted
, trusted
, X509_STORE
)
40 #define DEFINE_OSSL_set0(PREFIX, FIELD, TYPE) \
41 DEFINE_OSSL_set0_NAME(PREFIX, FIELD, FIELD, TYPE)
42 #define DEFINE_OSSL_set0_NAME(PREFIX, NAME, FIELD, TYPE) \
43 int PREFIX##_set0##_##NAME(OSSL_CMP_CTX *ctx, TYPE *val) \
46 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
49 TYPE##_free(ctx->FIELD); \
55 * Set certificate store containing trusted (root) CA certs and possibly CRLs
56 * and a cert verification callback function used for CMP server authentication.
57 * Any already existing store entry is freed. Given NULL, the entry is reset.
59 DEFINE_OSSL_set0_NAME(OSSL_CMP_CTX
, trusted
, trusted
, X509_STORE
)
61 DEFINE_OSSL_CMP_CTX_get0(libctx
, OSSL_LIB_CTX
)
62 DEFINE_OSSL_CMP_CTX_get0(propq
, const char)
64 /* Get current list of non-trusted intermediate certs */
65 DEFINE_OSSL_CMP_CTX_get0(untrusted
, STACK_OF(X509
))
68 * Set untrusted certificates for path construction in authentication of
69 * the CMP server and potentially others (TLS server, newly enrolled cert).
71 int OSSL_CMP_CTX_set1_untrusted(OSSL_CMP_CTX
*ctx
, STACK_OF(X509
) *certs
)
73 STACK_OF(X509
) *untrusted
= NULL
;
76 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
79 if (!ossl_x509_add_certs_new(&untrusted
, certs
,
80 X509_ADD_FLAG_UP_REF
| X509_ADD_FLAG_NO_DUP
))
82 OSSL_STACK_OF_X509_free(ctx
->untrusted
);
83 ctx
->untrusted
= untrusted
;
86 OSSL_STACK_OF_X509_free(untrusted
);
90 static int cmp_ctx_set_md(OSSL_CMP_CTX
*ctx
, EVP_MD
**pmd
, int nid
)
92 EVP_MD
*md
= EVP_MD_fetch(ctx
->libctx
, OBJ_nid2sn(nid
), ctx
->propq
);
93 /* fetching in advance to be able to throw error early if unsupported */
96 ERR_raise(ERR_LIB_CMP
, CMP_R_UNSUPPORTED_ALGORITHM
);
105 * Allocates and initializes OSSL_CMP_CTX context structure with default values.
106 * Returns new context on success, NULL on error
108 OSSL_CMP_CTX
*OSSL_CMP_CTX_new(OSSL_LIB_CTX
*libctx
, const char *propq
)
110 OSSL_CMP_CTX
*ctx
= OPENSSL_zalloc(sizeof(*ctx
));
115 ctx
->libctx
= libctx
;
116 if (propq
!= NULL
&& (ctx
->propq
= OPENSSL_strdup(propq
)) == NULL
)
119 ctx
->log_verbosity
= OSSL_CMP_LOG_INFO
;
121 ctx
->status
= OSSL_CMP_PKISTATUS_unspecified
;
122 ctx
->failInfoCode
= -1;
125 ctx
->msg_timeout
= -1;
127 if ((ctx
->untrusted
= sk_X509_new_null()) == NULL
) {
128 ERR_raise(ERR_LIB_X509
, ERR_R_CRYPTO_LIB
);
133 if (!cmp_ctx_set_md(ctx
, &ctx
->pbm_owf
, NID_sha256
))
135 ctx
->pbm_itercnt
= 500;
136 ctx
->pbm_mac
= NID_hmac_sha1
;
138 if (!cmp_ctx_set_md(ctx
, &ctx
->digest
, NID_sha256
))
140 ctx
->popoMethod
= OSSL_CRMF_POPO_SIGNATURE
;
141 ctx
->revocationReason
= CRL_REASON_NONE
;
143 /* all other elements are initialized to 0 or NULL, respectively */
147 OSSL_CMP_CTX_free(ctx
);
151 #define OSSL_CMP_ITAVs_free(itavs) \
152 sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
153 #define X509_EXTENSIONS_free(exts) \
154 sk_X509_EXTENSION_pop_free(exts, X509_EXTENSION_free)
155 #define OSSL_CMP_PKIFREETEXT_free(text) \
156 sk_ASN1_UTF8STRING_pop_free(text, ASN1_UTF8STRING_free)
158 /* Prepare the OSSL_CMP_CTX for next use, partly re-initializing OSSL_CMP_CTX */
159 int OSSL_CMP_CTX_reinit(OSSL_CMP_CTX
*ctx
)
162 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
166 if (ctx
->http_ctx
!= NULL
) {
167 (void)OSSL_HTTP_close(ctx
->http_ctx
, 1);
168 ossl_cmp_debug(ctx
, "disconnected from CMP server");
169 ctx
->http_ctx
= NULL
;
171 ctx
->status
= OSSL_CMP_PKISTATUS_unspecified
;
172 ctx
->failInfoCode
= -1;
174 OSSL_CMP_ITAVs_free(ctx
->genm_ITAVs
);
175 ctx
->genm_ITAVs
= NULL
;
177 return ossl_cmp_ctx_set0_statusString(ctx
, NULL
)
178 && ossl_cmp_ctx_set0_newCert(ctx
, NULL
)
179 && ossl_cmp_ctx_set1_newChain(ctx
, NULL
)
180 && ossl_cmp_ctx_set1_caPubs(ctx
, NULL
)
181 && ossl_cmp_ctx_set1_extraCertsIn(ctx
, NULL
)
182 && ossl_cmp_ctx_set1_validatedSrvCert(ctx
, NULL
)
183 && OSSL_CMP_CTX_set1_transactionID(ctx
, NULL
)
184 && OSSL_CMP_CTX_set1_senderNonce(ctx
, NULL
)
185 && ossl_cmp_ctx_set1_recipNonce(ctx
, NULL
);
188 /* Frees OSSL_CMP_CTX variables allocated in OSSL_CMP_CTX_new() */
189 void OSSL_CMP_CTX_free(OSSL_CMP_CTX
*ctx
)
194 if (ctx
->http_ctx
!= NULL
) {
195 (void)OSSL_HTTP_close(ctx
->http_ctx
, 1);
196 ossl_cmp_debug(ctx
, "disconnected from CMP server");
198 OPENSSL_free(ctx
->propq
);
199 OPENSSL_free(ctx
->serverPath
);
200 OPENSSL_free(ctx
->server
);
201 OPENSSL_free(ctx
->proxy
);
202 OPENSSL_free(ctx
->no_proxy
);
204 X509_free(ctx
->srvCert
);
205 X509_free(ctx
->validatedSrvCert
);
206 X509_NAME_free(ctx
->expected_sender
);
207 X509_STORE_free(ctx
->trusted
);
208 OSSL_STACK_OF_X509_free(ctx
->untrusted
);
210 X509_free(ctx
->cert
);
211 OSSL_STACK_OF_X509_free(ctx
->chain
);
212 EVP_PKEY_free(ctx
->pkey
);
213 ASN1_OCTET_STRING_free(ctx
->referenceValue
);
214 if (ctx
->secretValue
!= NULL
)
215 OPENSSL_cleanse(ctx
->secretValue
->data
, ctx
->secretValue
->length
);
216 ASN1_OCTET_STRING_free(ctx
->secretValue
);
217 EVP_MD_free(ctx
->pbm_owf
);
219 X509_NAME_free(ctx
->recipient
);
220 EVP_MD_free(ctx
->digest
);
221 ASN1_OCTET_STRING_free(ctx
->transactionID
);
222 ASN1_OCTET_STRING_free(ctx
->senderNonce
);
223 ASN1_OCTET_STRING_free(ctx
->recipNonce
);
224 OSSL_CMP_ITAVs_free(ctx
->geninfo_ITAVs
);
225 OSSL_STACK_OF_X509_free(ctx
->extraCertsOut
);
227 EVP_PKEY_free(ctx
->newPkey
);
228 X509_NAME_free(ctx
->issuer
);
229 X509_NAME_free(ctx
->subjectName
);
230 sk_GENERAL_NAME_pop_free(ctx
->subjectAltNames
, GENERAL_NAME_free
);
231 X509_EXTENSIONS_free(ctx
->reqExtensions
);
232 sk_POLICYINFO_pop_free(ctx
->policies
, POLICYINFO_free
);
233 X509_free(ctx
->oldCert
);
234 X509_REQ_free(ctx
->p10CSR
);
236 OSSL_CMP_ITAVs_free(ctx
->genm_ITAVs
);
238 OSSL_CMP_PKIFREETEXT_free(ctx
->statusString
);
239 X509_free(ctx
->newCert
);
240 OSSL_STACK_OF_X509_free(ctx
->newChain
);
241 OSSL_STACK_OF_X509_free(ctx
->caPubs
);
242 OSSL_STACK_OF_X509_free(ctx
->extraCertsIn
);
247 #define DEFINE_OSSL_set(PREFIX, FIELD, TYPE) \
248 int PREFIX##_set_##FIELD(OSSL_CMP_CTX *ctx, TYPE val) \
251 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
258 DEFINE_OSSL_set(ossl_cmp_ctx
, status
, int)
260 #define DEFINE_OSSL_get(PREFIX, FIELD, TYPE, ERR_RET) \
261 TYPE PREFIX##_get_##FIELD(const OSSL_CMP_CTX *ctx) \
264 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
271 * Returns the PKIStatus from the last CertRepMessage
272 * or Revocation Response or error message, -1 on error
274 DEFINE_OSSL_get(OSSL_CMP_CTX
, status
, int, -1)
277 * Returns the statusString from the last CertRepMessage
278 * or Revocation Response or error message, NULL on error
280 DEFINE_OSSL_CMP_CTX_get0(statusString
, OSSL_CMP_PKIFREETEXT
)
282 DEFINE_OSSL_set0(ossl_cmp_ctx
, statusString
, OSSL_CMP_PKIFREETEXT
)
284 /* Set callback function for checking if the cert is ok or should be rejected */
285 DEFINE_OSSL_set(OSSL_CMP_CTX
, certConf_cb
, OSSL_CMP_certConf_cb_t
)
288 * Set argument, respectively a pointer to a structure containing arguments,
289 * optionally to be used by the certConf callback.
291 DEFINE_OSSL_set(OSSL_CMP_CTX
, certConf_cb_arg
, void *)
294 * Get argument, respectively the pointer to a structure containing arguments,
295 * optionally to be used by certConf callback.
296 * Returns callback argument set previously (NULL if not set or on error)
298 DEFINE_OSSL_get(OSSL_CMP_CTX
, certConf_cb_arg
, void *, NULL
)
300 #ifndef OPENSSL_NO_TRACE
301 static size_t ossl_cmp_log_trace_cb(const char *buf
, size_t cnt
,
302 int category
, int cmd
, void *vdata
)
304 OSSL_CMP_CTX
*ctx
= vdata
;
306 OSSL_CMP_severity level
= -1;
311 if (buf
== NULL
|| cnt
== 0 || cmd
!= OSSL_TRACE_CTRL_WRITE
|| ctx
== NULL
)
313 if (ctx
->log_cb
== NULL
)
314 return 1; /* silently drop message */
316 msg
= ossl_cmp_log_parse_metadata(buf
, &level
, &func
, &file
, &line
);
318 if (level
> ctx
->log_verbosity
) /* excludes the case level is unknown */
319 goto end
; /* suppress output since severity is not sufficient */
321 if (!ctx
->log_cb(func
!= NULL
? func
: "(no func)",
322 file
!= NULL
? file
: "(no file)",
333 /* Print CMP log messages (i.e., diagnostic info) via the log cb of the ctx */
334 int ossl_cmp_print_log(OSSL_CMP_severity level
, const OSSL_CMP_CTX
*ctx
,
335 const char *func
, const char *file
, int line
,
336 const char *level_str
, const char *format
, ...)
339 char hugebuf
[1024 * 2];
342 if (ctx
== NULL
|| ctx
->log_cb
== NULL
)
343 return 1; /* silently drop message */
345 if (level
> ctx
->log_verbosity
) /* excludes the case level is unknown */
346 return 1; /* suppress output since severity is not sufficient */
351 va_start(args
, format
);
354 func
= "(unset function name)";
356 file
= "(unset file name)";
357 if (level_str
== NULL
)
358 level_str
= "(unset level string)";
360 #ifndef OPENSSL_NO_TRACE
361 if (OSSL_TRACE_ENABLED(CMP
)) {
362 OSSL_TRACE_BEGIN(CMP
) {
364 BIO_snprintf(hugebuf
, sizeof(hugebuf
),
365 "%s:%s:%d:" OSSL_CMP_LOG_PREFIX
"%s: ",
366 func
, file
, line
, level_str
);
367 if (printed
> 0 && (size_t)printed
< sizeof(hugebuf
)) {
368 if (BIO_vsnprintf(hugebuf
+ printed
,
369 sizeof(hugebuf
) - printed
, format
, args
) > 0)
370 res
= BIO_puts(trc_out
, hugebuf
) > 0;
372 } OSSL_TRACE_END(CMP
);
374 #else /* compensate for disabled trace API */
376 if (BIO_vsnprintf(hugebuf
, sizeof(hugebuf
), format
, args
) > 0)
377 res
= ctx
->log_cb(func
, file
, line
, level
, hugebuf
);
384 /* Set a callback function for error reporting and logging messages */
385 int OSSL_CMP_CTX_set_log_cb(OSSL_CMP_CTX
*ctx
, OSSL_CMP_log_cb_t cb
)
388 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
393 #ifndef OPENSSL_NO_TRACE
394 /* do also in case cb == NULL, to switch off logging output: */
395 if (!OSSL_trace_set_callback(OSSL_TRACE_CATEGORY_CMP
,
396 ossl_cmp_log_trace_cb
, ctx
))
403 /* Print OpenSSL and CMP errors via the log cb of the ctx or ERR_print_errors */
404 void OSSL_CMP_CTX_print_errors(const OSSL_CMP_CTX
*ctx
)
406 if (ctx
!= NULL
&& OSSL_CMP_LOG_ERR
> ctx
->log_verbosity
)
407 return; /* suppress output since severity is not sufficient */
408 OSSL_CMP_print_errors_cb(ctx
== NULL
? NULL
: ctx
->log_cb
);
412 * Set or clear the reference value to be used for identification
413 * (i.e., the user name) when using PBMAC.
415 int OSSL_CMP_CTX_set1_referenceValue(OSSL_CMP_CTX
*ctx
,
416 const unsigned char *ref
, int len
)
419 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
423 ossl_cmp_asn1_octet_string_set1_bytes(&ctx
->referenceValue
, ref
, len
);
426 /* Set or clear the password to be used for protecting messages with PBMAC */
427 int OSSL_CMP_CTX_set1_secretValue(OSSL_CMP_CTX
*ctx
, const unsigned char *sec
,
430 ASN1_OCTET_STRING
*secretValue
= NULL
;
433 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
436 if (ossl_cmp_asn1_octet_string_set1_bytes(&secretValue
, sec
, len
) != 1)
438 if (ctx
->secretValue
!= NULL
) {
439 OPENSSL_cleanse(ctx
->secretValue
->data
, ctx
->secretValue
->length
);
440 ASN1_OCTET_STRING_free(ctx
->secretValue
);
442 ctx
->secretValue
= secretValue
;
446 #define DEFINE_OSSL_CMP_CTX_get1_certs(FIELD) \
447 STACK_OF(X509) *OSSL_CMP_CTX_get1_##FIELD(const OSSL_CMP_CTX *ctx) \
450 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
453 return X509_chain_up_ref(ctx->FIELD); \
456 /* Returns the cert chain computed by OSSL_CMP_certConf_cb(), NULL on error */
457 DEFINE_OSSL_CMP_CTX_get1_certs(newChain
)
459 #define DEFINE_OSSL_set1_certs(PREFIX, FIELD) \
460 int PREFIX##_set1_##FIELD(OSSL_CMP_CTX *ctx, STACK_OF(X509) *certs) \
463 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
466 OSSL_STACK_OF_X509_free(ctx->FIELD); \
468 return certs == NULL || (ctx->FIELD = X509_chain_up_ref(certs)) != NULL; \
472 * Copies any given stack of inbound X509 certificates to newChain
473 * of the OSSL_CMP_CTX structure so that they may be retrieved later.
475 DEFINE_OSSL_set1_certs(ossl_cmp_ctx
, newChain
)
477 /* Returns the stack of extraCerts received in CertRepMessage, NULL on error */
478 DEFINE_OSSL_CMP_CTX_get1_certs(extraCertsIn
)
481 * Copies any given stack of inbound X509 certificates to extraCertsIn
482 * of the OSSL_CMP_CTX structure so that they may be retrieved later.
484 DEFINE_OSSL_set1_certs(ossl_cmp_ctx
, extraCertsIn
)
487 * Copies any given stack as the new stack of X509
488 * certificates to send out in the extraCerts field.
490 DEFINE_OSSL_set1_certs(OSSL_CMP_CTX
, extraCertsOut
)
493 * Add the given policy info object
494 * to the X509_EXTENSIONS of the requested certificate template.
496 int OSSL_CMP_CTX_push0_policy(OSSL_CMP_CTX
*ctx
, POLICYINFO
*pinfo
)
498 if (ctx
== NULL
|| pinfo
== NULL
) {
499 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
503 if (ctx
->policies
== NULL
504 && (ctx
->policies
= CERTIFICATEPOLICIES_new()) == NULL
)
507 return sk_POLICYINFO_push(ctx
->policies
, pinfo
);
510 /* Add an ITAV for geninfo of the PKI message header */
511 int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX
*ctx
, OSSL_CMP_ITAV
*itav
)
514 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
517 return OSSL_CMP_ITAV_push0_stack_item(&ctx
->geninfo_ITAVs
, itav
);
520 /* Add an itav for the body of outgoing general messages */
521 int OSSL_CMP_CTX_push0_genm_ITAV(OSSL_CMP_CTX
*ctx
, OSSL_CMP_ITAV
*itav
)
524 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
527 return OSSL_CMP_ITAV_push0_stack_item(&ctx
->genm_ITAVs
, itav
);
531 * Returns a duplicate of the stack of X509 certificates that
532 * were received in the caPubs field of the last CertRepMessage.
533 * Returns NULL on error
535 DEFINE_OSSL_CMP_CTX_get1_certs(caPubs
)
538 * Copies any given stack of certificates to the given
539 * OSSL_CMP_CTX structure so that they may be retrieved later.
541 DEFINE_OSSL_set1_certs(ossl_cmp_ctx
, caPubs
)
543 #define char_dup OPENSSL_strdup
544 #define char_free OPENSSL_free
545 #define DEFINE_OSSL_CMP_CTX_set1(FIELD, TYPE) /* this uses _dup */ \
546 int OSSL_CMP_CTX_set1_##FIELD(OSSL_CMP_CTX *ctx, const TYPE *val) \
548 TYPE *val_dup = NULL; \
551 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
555 if (val != NULL && (val_dup = TYPE##_dup(val)) == NULL) \
557 TYPE##_free(ctx->FIELD); \
558 ctx->FIELD = val_dup; \
562 #define X509_invalid(cert) (!ossl_x509v3_cache_extensions(cert))
563 #define EVP_PKEY_invalid(key) 0
565 #define DEFINE_OSSL_set1_up_ref(PREFIX, FIELD, TYPE) \
566 int PREFIX##_set1_##FIELD(OSSL_CMP_CTX *ctx, TYPE *val) \
569 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
573 /* prevent misleading error later on malformed cert or provider issue */ \
574 if (val != NULL && TYPE##_invalid(val)) { \
575 ERR_raise(ERR_LIB_CMP, CMP_R_POTENTIALLY_INVALID_CERTIFICATE); \
578 if (val != NULL && !TYPE##_up_ref(val)) \
580 TYPE##_free(ctx->FIELD); \
585 DEFINE_OSSL_set1_up_ref(ossl_cmp_ctx
, validatedSrvCert
, X509
)
588 * Pins the server certificate to be directly trusted (even if it is expired)
589 * for verifying response messages.
590 * Cert pointer is not consumed. It may be NULL to clear the entry.
592 DEFINE_OSSL_set1_up_ref(OSSL_CMP_CTX
, srvCert
, X509
)
594 /* Set the X509 name of the recipient. Set in the PKIHeader */
595 DEFINE_OSSL_CMP_CTX_set1(recipient
, X509_NAME
)
597 /* Store the X509 name of the expected sender in the PKIHeader of responses */
598 DEFINE_OSSL_CMP_CTX_set1(expected_sender
, X509_NAME
)
600 /* Set the X509 name of the issuer. Set in the PKIHeader */
601 DEFINE_OSSL_CMP_CTX_set1(issuer
, X509_NAME
)
604 * Set the subject name that will be placed in the certificate
605 * request. This will be the subject name on the received certificate.
607 DEFINE_OSSL_CMP_CTX_set1(subjectName
, X509_NAME
)
609 /* Set the X.509v3 certificate request extensions to be used in IR/CR/KUR */
610 int OSSL_CMP_CTX_set0_reqExtensions(OSSL_CMP_CTX
*ctx
, X509_EXTENSIONS
*exts
)
613 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
617 if (sk_GENERAL_NAME_num(ctx
->subjectAltNames
) > 0 && exts
!= NULL
618 && X509v3_get_ext_by_NID(exts
, NID_subject_alt_name
, -1) >= 0) {
619 ERR_raise(ERR_LIB_CMP
, CMP_R_MULTIPLE_SAN_SOURCES
);
622 X509_EXTENSIONS_free(ctx
->reqExtensions
);
623 ctx
->reqExtensions
= exts
;
627 /* returns 1 if ctx contains a Subject Alternative Name extension, else 0 */
628 int OSSL_CMP_CTX_reqExtensions_have_SAN(OSSL_CMP_CTX
*ctx
)
631 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
634 /* if one of the following conditions 'fail' this is not an error */
635 return ctx
->reqExtensions
!= NULL
636 && X509v3_get_ext_by_NID(ctx
->reqExtensions
,
637 NID_subject_alt_name
, -1) >= 0;
641 * Add a GENERAL_NAME structure that will be added to the CRMF
642 * request's extensions field to request subject alternative names.
644 int OSSL_CMP_CTX_push1_subjectAltName(OSSL_CMP_CTX
*ctx
,
645 const GENERAL_NAME
*name
)
647 GENERAL_NAME
*name_dup
;
649 if (ctx
== NULL
|| name
== NULL
) {
650 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
654 if (OSSL_CMP_CTX_reqExtensions_have_SAN(ctx
) == 1) {
655 ERR_raise(ERR_LIB_CMP
, CMP_R_MULTIPLE_SAN_SOURCES
);
659 if (ctx
->subjectAltNames
== NULL
660 && (ctx
->subjectAltNames
= sk_GENERAL_NAME_new_null()) == NULL
)
662 if ((name_dup
= GENERAL_NAME_dup(name
)) == NULL
)
664 if (!sk_GENERAL_NAME_push(ctx
->subjectAltNames
, name_dup
)) {
665 GENERAL_NAME_free(name_dup
);
672 * Set our own client certificate, used for example in KUR and when
673 * doing the IR with existing certificate.
675 DEFINE_OSSL_set1_up_ref(OSSL_CMP_CTX
, cert
, X509
)
677 int OSSL_CMP_CTX_build_cert_chain(OSSL_CMP_CTX
*ctx
, X509_STORE
*own_trusted
,
678 STACK_OF(X509
) *candidates
)
680 STACK_OF(X509
) *chain
;
683 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
687 if (!ossl_x509_add_certs_new(&ctx
->untrusted
, candidates
,
688 X509_ADD_FLAG_UP_REF
| X509_ADD_FLAG_NO_DUP
))
691 ossl_cmp_debug(ctx
, "trying to build chain for own CMP signer cert");
692 chain
= X509_build_chain(ctx
->cert
, ctx
->untrusted
, own_trusted
, 0,
693 ctx
->libctx
, ctx
->propq
);
695 ERR_raise(ERR_LIB_CMP
, CMP_R_FAILED_BUILDING_OWN_CHAIN
);
698 ossl_cmp_debug(ctx
, "success building chain for own CMP signer cert");
704 * Set the old certificate that we are updating in KUR
705 * or the certificate to be revoked in RR, respectively.
706 * Also used as reference cert (defaulting to cert) for deriving subject DN
707 * and SANs. Its issuer is used as default recipient in the CMP message header.
709 DEFINE_OSSL_set1_up_ref(OSSL_CMP_CTX
, oldCert
, X509
)
711 /* Set the PKCS#10 CSR to be sent in P10CR */
712 DEFINE_OSSL_CMP_CTX_set1(p10CSR
, X509_REQ
)
715 * Set the (newly received in IP/KUP/CP) certificate in the context.
716 * This only permits for one cert to be enrolled at a time.
718 DEFINE_OSSL_set0(ossl_cmp_ctx
, newCert
, X509
)
720 /* Get successfully validated server cert, if any, of current transaction */
721 DEFINE_OSSL_CMP_CTX_get0(validatedSrvCert
, X509
)
724 * Get the (newly received in IP/KUP/CP) client certificate from the context
725 * This only permits for one client cert to be received...
727 DEFINE_OSSL_CMP_CTX_get0(newCert
, X509
)
729 /* Set the client's current private key */
730 DEFINE_OSSL_set1_up_ref(OSSL_CMP_CTX
, pkey
, EVP_PKEY
)
732 /* Set new key pair. Used e.g. when doing Key Update */
733 int OSSL_CMP_CTX_set0_newPkey(OSSL_CMP_CTX
*ctx
, int priv
, EVP_PKEY
*pkey
)
736 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
740 EVP_PKEY_free(ctx
->newPkey
);
742 ctx
->newPkey_priv
= priv
;
746 /* Get the private/public key to use for cert enrollment, or NULL on error */
747 EVP_PKEY
*OSSL_CMP_CTX_get0_newPkey(const OSSL_CMP_CTX
*ctx
, int priv
)
750 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
754 if (ctx
->newPkey
!= NULL
)
755 return priv
&& !ctx
->newPkey_priv
? NULL
: ctx
->newPkey
;
756 if (ctx
->p10CSR
!= NULL
)
757 return priv
? NULL
: X509_REQ_get0_pubkey(ctx
->p10CSR
);
758 return ctx
->pkey
; /* may be NULL */
761 #define DEFINE_set1_ASN1_OCTET_STRING(PREFIX, FIELD) \
762 int PREFIX##_set1_##FIELD(OSSL_CMP_CTX *ctx, const ASN1_OCTET_STRING *id) \
765 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT); \
768 return ossl_cmp_asn1_octet_string_set1(&ctx->FIELD, id); \
771 /* Set the given transactionID to the context */
772 DEFINE_set1_ASN1_OCTET_STRING(OSSL_CMP_CTX
, transactionID
)
774 /* Set the nonce to be used for the recipNonce in the message created next */
775 DEFINE_set1_ASN1_OCTET_STRING(ossl_cmp_ctx
, recipNonce
)
777 /* Stores the given nonce as the last senderNonce sent out */
778 DEFINE_set1_ASN1_OCTET_STRING(OSSL_CMP_CTX
, senderNonce
)
780 /* Set the proxy server to use for HTTP(S) connections */
781 DEFINE_OSSL_CMP_CTX_set1(proxy
, char)
783 /* Set the (HTTP) hostname of the CMP server */
784 DEFINE_OSSL_CMP_CTX_set1(server
, char)
786 /* Set the server exclusion list of the HTTP proxy server */
787 DEFINE_OSSL_CMP_CTX_set1(no_proxy
, char)
789 /* Set the http connect/disconnect callback function to be used for HTTP(S) */
790 DEFINE_OSSL_set(OSSL_CMP_CTX
, http_cb
, OSSL_HTTP_bio_cb_t
)
792 /* Set argument optionally to be used by the http connect/disconnect callback */
793 DEFINE_OSSL_set(OSSL_CMP_CTX
, http_cb_arg
, void *)
796 * Get argument optionally to be used by the http connect/disconnect callback
797 * Returns callback argument set previously (NULL if not set or on error)
799 DEFINE_OSSL_get(OSSL_CMP_CTX
, http_cb_arg
, void *, NULL
)
801 /* Set callback function for sending CMP request and receiving response */
802 DEFINE_OSSL_set(OSSL_CMP_CTX
, transfer_cb
, OSSL_CMP_transfer_cb_t
)
804 /* Set argument optionally to be used by the transfer callback */
805 DEFINE_OSSL_set(OSSL_CMP_CTX
, transfer_cb_arg
, void *)
808 * Get argument optionally to be used by the transfer callback.
809 * Returns callback argument set previously (NULL if not set or on error)
811 DEFINE_OSSL_get(OSSL_CMP_CTX
, transfer_cb_arg
, void *, NULL
)
813 /** Set the HTTP server port to be used */
814 DEFINE_OSSL_set(OSSL_CMP_CTX
, serverPort
, int)
816 /* Set the HTTP path to be used on the server (e.g "pkix/") */
817 DEFINE_OSSL_CMP_CTX_set1(serverPath
, char)
819 /* Set the failInfo error code as bit encoding in OSSL_CMP_CTX */
820 DEFINE_OSSL_set(ossl_cmp_ctx
, failInfoCode
, int)
823 * Get the failInfo error code in OSSL_CMP_CTX as bit encoding.
824 * Returns bit string as integer on success, -1 on error
826 DEFINE_OSSL_get(OSSL_CMP_CTX
, failInfoCode
, int, -1)
828 /* Set a Boolean or integer option of the context to the "val" arg */
829 int OSSL_CMP_CTX_set_option(OSSL_CMP_CTX
*ctx
, int opt
, int val
)
834 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
839 case OSSL_CMP_OPT_REVOCATION_REASON
:
840 min_val
= OCSP_REVOKED_STATUS_NOSTATUS
;
842 case OSSL_CMP_OPT_POPO_METHOD
:
843 min_val
= OSSL_CRMF_POPO_NONE
;
850 ERR_raise(ERR_LIB_CMP
, CMP_R_VALUE_TOO_SMALL
);
855 case OSSL_CMP_OPT_LOG_VERBOSITY
:
856 if (val
> OSSL_CMP_LOG_MAX
) {
857 ERR_raise(ERR_LIB_CMP
, CMP_R_VALUE_TOO_LARGE
);
860 ctx
->log_verbosity
= val
;
862 case OSSL_CMP_OPT_IMPLICIT_CONFIRM
:
863 ctx
->implicitConfirm
= val
;
865 case OSSL_CMP_OPT_DISABLE_CONFIRM
:
866 ctx
->disableConfirm
= val
;
868 case OSSL_CMP_OPT_UNPROTECTED_SEND
:
869 ctx
->unprotectedSend
= val
;
871 case OSSL_CMP_OPT_UNPROTECTED_ERRORS
:
872 ctx
->unprotectedErrors
= val
;
874 case OSSL_CMP_OPT_VALIDITY_DAYS
:
877 case OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT
:
878 ctx
->SubjectAltName_nodefault
= val
;
880 case OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL
:
881 ctx
->setSubjectAltNameCritical
= val
;
883 case OSSL_CMP_OPT_POLICIES_CRITICAL
:
884 ctx
->setPoliciesCritical
= val
;
886 case OSSL_CMP_OPT_IGNORE_KEYUSAGE
:
887 ctx
->ignore_keyusage
= val
;
889 case OSSL_CMP_OPT_POPO_METHOD
:
890 if (val
> OSSL_CRMF_POPO_KEYAGREE
) {
891 ERR_raise(ERR_LIB_CMP
, CMP_R_VALUE_TOO_LARGE
);
894 ctx
->popoMethod
= val
;
896 case OSSL_CMP_OPT_DIGEST_ALGNID
:
897 if (!cmp_ctx_set_md(ctx
, &ctx
->digest
, val
))
900 case OSSL_CMP_OPT_OWF_ALGNID
:
901 if (!cmp_ctx_set_md(ctx
, &ctx
->pbm_owf
, val
))
904 case OSSL_CMP_OPT_MAC_ALGNID
:
907 case OSSL_CMP_OPT_KEEP_ALIVE
:
908 ctx
->keep_alive
= val
;
910 case OSSL_CMP_OPT_MSG_TIMEOUT
:
911 ctx
->msg_timeout
= val
;
913 case OSSL_CMP_OPT_TOTAL_TIMEOUT
:
914 ctx
->total_timeout
= val
;
916 case OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR
:
917 ctx
->permitTAInExtraCertsForIR
= val
;
919 case OSSL_CMP_OPT_REVOCATION_REASON
:
920 if (val
> OCSP_REVOKED_STATUS_AACOMPROMISE
) {
921 ERR_raise(ERR_LIB_CMP
, CMP_R_VALUE_TOO_LARGE
);
924 ctx
->revocationReason
= val
;
927 ERR_raise(ERR_LIB_CMP
, CMP_R_INVALID_OPTION
);
935 * Reads a Boolean or integer option value from the context.
936 * Returns -1 on error (which is the default OSSL_CMP_OPT_REVOCATION_REASON)
938 int OSSL_CMP_CTX_get_option(const OSSL_CMP_CTX
*ctx
, int opt
)
941 ERR_raise(ERR_LIB_CMP
, CMP_R_NULL_ARGUMENT
);
946 case OSSL_CMP_OPT_LOG_VERBOSITY
:
947 return ctx
->log_verbosity
;
948 case OSSL_CMP_OPT_IMPLICIT_CONFIRM
:
949 return ctx
->implicitConfirm
;
950 case OSSL_CMP_OPT_DISABLE_CONFIRM
:
951 return ctx
->disableConfirm
;
952 case OSSL_CMP_OPT_UNPROTECTED_SEND
:
953 return ctx
->unprotectedSend
;
954 case OSSL_CMP_OPT_UNPROTECTED_ERRORS
:
955 return ctx
->unprotectedErrors
;
956 case OSSL_CMP_OPT_VALIDITY_DAYS
:
958 case OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT
:
959 return ctx
->SubjectAltName_nodefault
;
960 case OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL
:
961 return ctx
->setSubjectAltNameCritical
;
962 case OSSL_CMP_OPT_POLICIES_CRITICAL
:
963 return ctx
->setPoliciesCritical
;
964 case OSSL_CMP_OPT_IGNORE_KEYUSAGE
:
965 return ctx
->ignore_keyusage
;
966 case OSSL_CMP_OPT_POPO_METHOD
:
967 return ctx
->popoMethod
;
968 case OSSL_CMP_OPT_DIGEST_ALGNID
:
969 return EVP_MD_get_type(ctx
->digest
);
970 case OSSL_CMP_OPT_OWF_ALGNID
:
971 return EVP_MD_get_type(ctx
->pbm_owf
);
972 case OSSL_CMP_OPT_MAC_ALGNID
:
974 case OSSL_CMP_OPT_KEEP_ALIVE
:
975 return ctx
->keep_alive
;
976 case OSSL_CMP_OPT_MSG_TIMEOUT
:
977 return ctx
->msg_timeout
;
978 case OSSL_CMP_OPT_TOTAL_TIMEOUT
:
979 return ctx
->total_timeout
;
980 case OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR
:
981 return ctx
->permitTAInExtraCertsForIR
;
982 case OSSL_CMP_OPT_REVOCATION_REASON
:
983 return ctx
->revocationReason
;
985 ERR_raise(ERR_LIB_CMP
, CMP_R_INVALID_OPTION
);