2 * Copyright 2007-2020 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_* */
15 #include "crypto/x509.h" /* for x509v3_cache_extensions() */
17 #include "cmp_local.h"
19 /* explicit #includes not strictly needed since implied by the above: */
20 #include <openssl/cmp.h>
21 #include <openssl/crmf.h>
22 #include <openssl/err.h>
24 DEFINE_STACK_OF(OSSL_CMP_ITAV
)
27 * Get current certificate store containing trusted root CA certs
29 X509_STORE
*OSSL_CMP_CTX_get0_trustedStore(const OSSL_CMP_CTX
*ctx
)
32 CMPerr(0, CMP_R_NULL_ARGUMENT
);
39 * Set certificate store containing trusted (root) CA certs and possibly CRLs
40 * and a cert verification callback function used for CMP server authentication.
41 * Any already existing store entry is freed. Given NULL, the entry is reset.
43 int OSSL_CMP_CTX_set0_trustedStore(OSSL_CMP_CTX
*ctx
, X509_STORE
*store
)
46 CMPerr(0, CMP_R_NULL_ARGUMENT
);
49 X509_STORE_free(ctx
->trusted
);
54 /* Get current list of non-trusted intermediate certs */
55 STACK_OF(X509
) *OSSL_CMP_CTX_get0_untrusted(const OSSL_CMP_CTX
*ctx
)
58 CMPerr(0, CMP_R_NULL_ARGUMENT
);
61 return ctx
->untrusted
;
65 * Set untrusted certificates for path construction in authentication of
66 * the CMP server and potentially others (TLS server, newly enrolled cert).
68 int OSSL_CMP_CTX_set1_untrusted(OSSL_CMP_CTX
*ctx
, STACK_OF(X509
) *certs
)
70 STACK_OF(X509
) *untrusted
;
72 CMPerr(0, CMP_R_NULL_ARGUMENT
);
75 if ((untrusted
= sk_X509_new_null()) == NULL
)
77 if (X509_add_certs(untrusted
, certs
,
78 X509_ADD_FLAG_UP_REF
| X509_ADD_FLAG_NO_DUP
) != 1)
80 sk_X509_pop_free(ctx
->untrusted
, X509_free
);
81 ctx
->untrusted
= untrusted
;
84 sk_X509_pop_free(untrusted
, X509_free
);
88 static int cmp_ctx_set_md(OSSL_CMP_CTX
*ctx
, EVP_MD
**pmd
, int nid
)
90 EVP_MD
*md
= EVP_MD_fetch(ctx
->libctx
, OBJ_nid2sn(nid
), ctx
->propq
);
91 /* fetching in advance to be able to throw error early if unsupported */
94 CMPerr(0, CMP_R_UNSUPPORTED_ALGORITHM
);
103 * Allocates and initializes OSSL_CMP_CTX context structure with default values.
104 * Returns new context on success, NULL on error
106 OSSL_CMP_CTX
*OSSL_CMP_CTX_new(OPENSSL_CTX
*libctx
, const char *propq
)
108 OSSL_CMP_CTX
*ctx
= OPENSSL_zalloc(sizeof(*ctx
));
113 ctx
->libctx
= libctx
;
114 if (propq
!= NULL
&& (ctx
->propq
= OPENSSL_strdup(propq
)) == NULL
)
117 ctx
->log_verbosity
= OSSL_CMP_LOG_INFO
;
120 ctx
->failInfoCode
= -1;
122 ctx
->msg_timeout
= 2 * 60;
124 if ((ctx
->untrusted
= sk_X509_new_null()) == NULL
)
128 if (!cmp_ctx_set_md(ctx
, &ctx
->pbm_owf
, NID_sha256
))
130 ctx
->pbm_itercnt
= 500;
131 ctx
->pbm_mac
= NID_hmac_sha1
;
133 if (!cmp_ctx_set_md(ctx
, &ctx
->digest
, NID_sha256
))
135 ctx
->popoMethod
= OSSL_CRMF_POPO_SIGNATURE
;
136 ctx
->revocationReason
= CRL_REASON_NONE
;
138 /* all other elements are initialized to 0 or NULL, respectively */
142 OSSL_CMP_CTX_free(ctx
);
143 X509err(0, ERR_R_MALLOC_FAILURE
);
147 /* Prepare the OSSL_CMP_CTX for next use, partly re-initializing OSSL_CMP_CTX */
148 int OSSL_CMP_CTX_reinit(OSSL_CMP_CTX
*ctx
)
151 CMPerr(0, CMP_R_NULL_ARGUMENT
);
156 ctx
->failInfoCode
= -1;
158 return ossl_cmp_ctx_set0_statusString(ctx
, NULL
)
159 && ossl_cmp_ctx_set0_newCert(ctx
, NULL
)
160 && ossl_cmp_ctx_set1_newChain(ctx
, NULL
)
161 && ossl_cmp_ctx_set1_caPubs(ctx
, NULL
)
162 && ossl_cmp_ctx_set1_extraCertsIn(ctx
, NULL
)
163 && ossl_cmp_ctx_set0_validatedSrvCert(ctx
, NULL
)
164 && OSSL_CMP_CTX_set1_transactionID(ctx
, NULL
)
165 && OSSL_CMP_CTX_set1_senderNonce(ctx
, NULL
)
166 && ossl_cmp_ctx_set1_recipNonce(ctx
, NULL
);
169 /* Frees OSSL_CMP_CTX variables allocated in OSSL_CMP_CTX_new() */
170 void OSSL_CMP_CTX_free(OSSL_CMP_CTX
*ctx
)
175 OPENSSL_free(ctx
->serverPath
);
176 OPENSSL_free(ctx
->server
);
177 OPENSSL_free(ctx
->proxy
);
178 OPENSSL_free(ctx
->no_proxy
);
180 X509_free(ctx
->srvCert
);
181 X509_free(ctx
->validatedSrvCert
);
182 X509_NAME_free(ctx
->expected_sender
);
183 X509_STORE_free(ctx
->trusted
);
184 sk_X509_pop_free(ctx
->untrusted
, X509_free
);
186 X509_free(ctx
->cert
);
187 sk_X509_pop_free(ctx
->chain
, X509_free
);
188 EVP_PKEY_free(ctx
->pkey
);
189 ASN1_OCTET_STRING_free(ctx
->referenceValue
);
190 if (ctx
->secretValue
!= NULL
)
191 OPENSSL_cleanse(ctx
->secretValue
->data
, ctx
->secretValue
->length
);
192 ASN1_OCTET_STRING_free(ctx
->secretValue
);
193 EVP_MD_free(ctx
->pbm_owf
);
195 X509_NAME_free(ctx
->recipient
);
196 EVP_MD_free(ctx
->digest
);
197 ASN1_OCTET_STRING_free(ctx
->transactionID
);
198 ASN1_OCTET_STRING_free(ctx
->senderNonce
);
199 ASN1_OCTET_STRING_free(ctx
->recipNonce
);
200 sk_OSSL_CMP_ITAV_pop_free(ctx
->geninfo_ITAVs
, OSSL_CMP_ITAV_free
);
201 sk_X509_pop_free(ctx
->extraCertsOut
, X509_free
);
203 EVP_PKEY_free(ctx
->newPkey
);
204 X509_NAME_free(ctx
->issuer
);
205 X509_NAME_free(ctx
->subjectName
);
206 sk_GENERAL_NAME_pop_free(ctx
->subjectAltNames
, GENERAL_NAME_free
);
207 sk_X509_EXTENSION_pop_free(ctx
->reqExtensions
, X509_EXTENSION_free
);
208 sk_POLICYINFO_pop_free(ctx
->policies
, POLICYINFO_free
);
209 X509_free(ctx
->oldCert
);
210 X509_REQ_free(ctx
->p10CSR
);
212 sk_OSSL_CMP_ITAV_pop_free(ctx
->genm_ITAVs
, OSSL_CMP_ITAV_free
);
214 sk_ASN1_UTF8STRING_pop_free(ctx
->statusString
, ASN1_UTF8STRING_free
);
215 X509_free(ctx
->newCert
);
216 sk_X509_pop_free(ctx
->newChain
, X509_free
);
217 sk_X509_pop_free(ctx
->caPubs
, X509_free
);
218 sk_X509_pop_free(ctx
->extraCertsIn
, X509_free
);
223 int ossl_cmp_ctx_set_status(OSSL_CMP_CTX
*ctx
, int status
)
225 if (!ossl_assert(ctx
!= NULL
))
227 ctx
->status
= status
;
232 * Returns the PKIStatus from the last CertRepMessage
233 * or Revocation Response or error message, -1 on error
235 int OSSL_CMP_CTX_get_status(const OSSL_CMP_CTX
*ctx
)
238 CMPerr(0, CMP_R_NULL_ARGUMENT
);
245 * Returns the statusString from the last CertRepMessage
246 * or Revocation Response or error message, NULL on error
248 OSSL_CMP_PKIFREETEXT
*OSSL_CMP_CTX_get0_statusString(const OSSL_CMP_CTX
*ctx
)
251 CMPerr(0, CMP_R_NULL_ARGUMENT
);
254 return ctx
->statusString
;
257 int ossl_cmp_ctx_set0_statusString(OSSL_CMP_CTX
*ctx
,
258 OSSL_CMP_PKIFREETEXT
*text
)
260 if (!ossl_assert(ctx
!= NULL
))
262 sk_ASN1_UTF8STRING_pop_free(ctx
->statusString
, ASN1_UTF8STRING_free
);
263 ctx
->statusString
= text
;
267 int ossl_cmp_ctx_set0_validatedSrvCert(OSSL_CMP_CTX
*ctx
, X509
*cert
)
269 if (!ossl_assert(ctx
!= NULL
))
271 X509_free(ctx
->validatedSrvCert
);
272 ctx
->validatedSrvCert
= cert
;
276 /* Set callback function for checking if the cert is ok or should be rejected */
277 int OSSL_CMP_CTX_set_certConf_cb(OSSL_CMP_CTX
*ctx
, OSSL_CMP_certConf_cb_t cb
)
280 CMPerr(0, CMP_R_NULL_ARGUMENT
);
283 ctx
->certConf_cb
= cb
;
288 * Set argument, respectively a pointer to a structure containing arguments,
289 * optionally to be used by the certConf callback.
291 int OSSL_CMP_CTX_set_certConf_cb_arg(OSSL_CMP_CTX
*ctx
, void *arg
)
294 CMPerr(0, CMP_R_NULL_ARGUMENT
);
297 ctx
->certConf_cb_arg
= arg
;
302 * Get argument, respectively the pointer to a structure containing arguments,
303 * optionally to be used by certConf callback.
304 * Returns callback argument set previously (NULL if not set or on error)
306 void *OSSL_CMP_CTX_get_certConf_cb_arg(const OSSL_CMP_CTX
*ctx
)
309 CMPerr(0, CMP_R_NULL_ARGUMENT
);
312 return ctx
->certConf_cb_arg
;
315 #ifndef OPENSSL_NO_TRACE
316 static size_t ossl_cmp_log_trace_cb(const char *buf
, size_t cnt
,
317 int category
, int cmd
, void *vdata
)
319 OSSL_CMP_CTX
*ctx
= vdata
;
321 OSSL_CMP_severity level
= -1;
326 if (buf
== NULL
|| cnt
== 0 || cmd
!= OSSL_TRACE_CTRL_WRITE
|| ctx
== NULL
)
328 if (ctx
->log_cb
== NULL
)
329 return 1; /* silently drop message */
331 msg
= ossl_cmp_log_parse_metadata(buf
, &level
, &func
, &file
, &line
);
333 if (level
> ctx
->log_verbosity
) /* excludes the case level is unknown */
334 goto end
; /* suppress output since severity is not sufficient */
336 if (!ctx
->log_cb(func
!= NULL
? func
: "(no func)",
337 file
!= NULL
? file
: "(no file)",
348 /* Print CMP log messages (i.e., diagnostic info) via the log cb of the ctx */
349 int ossl_cmp_print_log(OSSL_CMP_severity level
, const OSSL_CMP_CTX
*ctx
,
350 const char *func
, const char *file
, int line
,
351 const char *level_str
, const char *format
, ...)
354 char hugebuf
[1024 * 2];
357 if (ctx
== NULL
|| ctx
->log_cb
== NULL
)
358 return 1; /* silently drop message */
360 if (level
> ctx
->log_verbosity
) /* excludes the case level is unknown */
361 return 1; /* suppress output since severity is not sufficient */
366 va_start(args
, format
);
369 func
= "(unset function name)";
371 file
= "(unset file name)";
372 if (level_str
== NULL
)
373 level_str
= "(unset level string)";
375 #ifndef OPENSSL_NO_TRACE
376 if (OSSL_TRACE_ENABLED(CMP
)) {
377 OSSL_TRACE_BEGIN(CMP
) {
379 BIO_snprintf(hugebuf
, sizeof(hugebuf
),
380 "%s:%s:%d:" OSSL_CMP_LOG_PREFIX
"%s: ",
381 func
, file
, line
, level_str
);
382 if (printed
> 0 && (size_t)printed
< sizeof(hugebuf
)) {
383 if (BIO_vsnprintf(hugebuf
+ printed
,
384 sizeof(hugebuf
) - printed
, format
, args
) > 0)
385 res
= BIO_puts(trc_out
, hugebuf
) > 0;
387 } OSSL_TRACE_END(CMP
);
389 #else /* compensate for disabled trace API */
391 if (BIO_vsnprintf(hugebuf
, sizeof(hugebuf
), format
, args
) > 0)
392 res
= ctx
->log_cb(func
, file
, line
, level
, hugebuf
);
399 /* Set a callback function for error reporting and logging messages */
400 int OSSL_CMP_CTX_set_log_cb(OSSL_CMP_CTX
*ctx
, OSSL_CMP_log_cb_t cb
)
403 CMPerr(0, CMP_R_NULL_ARGUMENT
);
408 #ifndef OPENSSL_NO_TRACE
409 /* do also in case cb == NULL, to switch off logging output: */
410 if (!OSSL_trace_set_callback(OSSL_TRACE_CATEGORY_CMP
,
411 ossl_cmp_log_trace_cb
, ctx
))
418 /* Print OpenSSL and CMP errors via the log cb of the ctx or ERR_print_errors */
419 void OSSL_CMP_CTX_print_errors(const OSSL_CMP_CTX
*ctx
)
421 if (ctx
!= NULL
&& OSSL_CMP_LOG_ERR
> ctx
->log_verbosity
)
422 return; /* suppress output since severity is not sufficient */
423 OSSL_CMP_print_errors_cb(ctx
== NULL
? NULL
: ctx
->log_cb
);
427 * Set or clear the reference value to be used for identification
428 * (i.e., the user name) when using PBMAC.
430 int OSSL_CMP_CTX_set1_referenceValue(OSSL_CMP_CTX
*ctx
,
431 const unsigned char *ref
, int len
)
434 CMPerr(0, CMP_R_NULL_ARGUMENT
);
437 return ossl_cmp_asn1_octet_string_set1_bytes(&ctx
->referenceValue
, ref
,
441 /* Set or clear the password to be used for protecting messages with PBMAC */
442 int OSSL_CMP_CTX_set1_secretValue(OSSL_CMP_CTX
*ctx
, const unsigned char *sec
,
445 ASN1_OCTET_STRING
*secretValue
= NULL
;
447 CMPerr(0, CMP_R_NULL_ARGUMENT
);
450 if (ossl_cmp_asn1_octet_string_set1_bytes(&secretValue
, sec
, len
) != 1)
452 if (ctx
->secretValue
!= NULL
) {
453 OPENSSL_cleanse(ctx
->secretValue
->data
, ctx
->secretValue
->length
);
454 ASN1_OCTET_STRING_free(ctx
->secretValue
);
456 ctx
->secretValue
= secretValue
;
460 /* Returns the cert chain computed by OSSL_CMP_certConf_cb(), NULL on error */
461 STACK_OF(X509
) *OSSL_CMP_CTX_get1_newChain(const OSSL_CMP_CTX
*ctx
)
464 CMPerr(0, CMP_R_NULL_ARGUMENT
);
467 if (ctx
->newChain
== NULL
)
468 return sk_X509_new_null();
469 return X509_chain_up_ref(ctx
->newChain
);
473 * Copies any given stack of inbound X509 certificates to newChain
474 * of the OSSL_CMP_CTX structure so that they may be retrieved later.
476 int ossl_cmp_ctx_set1_newChain(OSSL_CMP_CTX
*ctx
, STACK_OF(X509
) *newChain
)
478 if (!ossl_assert(ctx
!= NULL
))
481 sk_X509_pop_free(ctx
->newChain
, X509_free
);
483 if (newChain
== NULL
)
485 return (ctx
->newChain
= X509_chain_up_ref(newChain
)) != NULL
;
488 /* Returns the stack of extraCerts received in CertRepMessage, NULL on error */
489 STACK_OF(X509
) *OSSL_CMP_CTX_get1_extraCertsIn(const OSSL_CMP_CTX
*ctx
)
492 CMPerr(0, CMP_R_NULL_ARGUMENT
);
495 if (ctx
->extraCertsIn
== NULL
)
496 return sk_X509_new_null();
497 return X509_chain_up_ref(ctx
->extraCertsIn
);
501 * Copies any given stack of inbound X509 certificates to extraCertsIn
502 * of the OSSL_CMP_CTX structure so that they may be retrieved later.
504 int ossl_cmp_ctx_set1_extraCertsIn(OSSL_CMP_CTX
*ctx
,
505 STACK_OF(X509
) *extraCertsIn
)
507 if (!ossl_assert(ctx
!= NULL
))
510 sk_X509_pop_free(ctx
->extraCertsIn
, X509_free
);
511 ctx
->extraCertsIn
= NULL
;
512 if (extraCertsIn
== NULL
)
514 return (ctx
->extraCertsIn
= X509_chain_up_ref(extraCertsIn
)) != NULL
;
518 * Copies any given stack as the new stack of X509
519 * certificates to send out in the extraCerts field.
521 int OSSL_CMP_CTX_set1_extraCertsOut(OSSL_CMP_CTX
*ctx
,
522 STACK_OF(X509
) *extraCertsOut
)
525 CMPerr(0, CMP_R_NULL_ARGUMENT
);
529 sk_X509_pop_free(ctx
->extraCertsOut
, X509_free
);
530 ctx
->extraCertsOut
= NULL
;
531 if (extraCertsOut
== NULL
)
533 return (ctx
->extraCertsOut
= X509_chain_up_ref(extraCertsOut
)) != NULL
;
537 * Add the given policy info object
538 * to the X509_EXTENSIONS of the requested certificate template.
540 int OSSL_CMP_CTX_push0_policy(OSSL_CMP_CTX
*ctx
, POLICYINFO
*pinfo
)
542 if (ctx
== NULL
|| pinfo
== NULL
) {
543 CMPerr(0, CMP_R_NULL_ARGUMENT
);
547 if (ctx
->policies
== NULL
548 && (ctx
->policies
= CERTIFICATEPOLICIES_new()) == NULL
)
551 return sk_POLICYINFO_push(ctx
->policies
, pinfo
);
554 /* Add an ITAV for geninfo of the PKI message header */
555 int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX
*ctx
, OSSL_CMP_ITAV
*itav
)
558 CMPerr(0, CMP_R_NULL_ARGUMENT
);
561 return OSSL_CMP_ITAV_push0_stack_item(&ctx
->geninfo_ITAVs
, itav
);
564 /* Add an itav for the body of outgoing general messages */
565 int OSSL_CMP_CTX_push0_genm_ITAV(OSSL_CMP_CTX
*ctx
, OSSL_CMP_ITAV
*itav
)
568 CMPerr(0, CMP_R_NULL_ARGUMENT
);
571 return OSSL_CMP_ITAV_push0_stack_item(&ctx
->genm_ITAVs
, itav
);
575 * Returns a duplicate of the stack of X509 certificates that
576 * were received in the caPubs field of the last CertRepMessage.
577 * Returns NULL on error
579 STACK_OF(X509
) *OSSL_CMP_CTX_get1_caPubs(const OSSL_CMP_CTX
*ctx
)
582 CMPerr(0, CMP_R_NULL_ARGUMENT
);
585 if (ctx
->caPubs
== NULL
)
586 return sk_X509_new_null();
587 return X509_chain_up_ref(ctx
->caPubs
);
591 * Copies any given stack of certificates to the given
592 * OSSL_CMP_CTX structure so that they may be retrieved later.
594 int ossl_cmp_ctx_set1_caPubs(OSSL_CMP_CTX
*ctx
, STACK_OF(X509
) *caPubs
)
596 if (!ossl_assert(ctx
!= NULL
))
599 sk_X509_pop_free(ctx
->caPubs
, X509_free
);
603 return (ctx
->caPubs
= X509_chain_up_ref(caPubs
)) != NULL
;
606 #define char_dup OPENSSL_strdup
607 #define char_free OPENSSL_free
608 #define DEFINE_OSSL_CMP_CTX_set1(FIELD, TYPE) /* this uses _dup */ \
609 int OSSL_CMP_CTX_set1_##FIELD(OSSL_CMP_CTX *ctx, const TYPE *val) \
611 TYPE *val_dup = NULL; \
614 CMPerr(0, CMP_R_NULL_ARGUMENT); \
618 if (val != NULL && (val_dup = TYPE##_dup(val)) == NULL) \
620 TYPE##_free(ctx->FIELD); \
621 ctx->FIELD = val_dup; \
625 #define X509_invalid(cert) (!x509v3_cache_extensions(cert))
626 #define EVP_PKEY_invalid(key) 0
627 #define DEFINE_OSSL_CMP_CTX_set1_up_ref(FIELD, TYPE) \
628 int OSSL_CMP_CTX_set1_##FIELD(OSSL_CMP_CTX *ctx, TYPE *val) \
631 CMPerr(0, CMP_R_NULL_ARGUMENT); \
635 /* prevent misleading error later on malformed cert or provider issue */ \
636 if (val != NULL && TYPE##_invalid(val)) { \
637 CMPerr(0, CMP_R_POTENTIALLY_INVALID_CERTIFICATE); \
640 if (val != NULL && !TYPE##_up_ref(val)) \
642 TYPE##_free(ctx->FIELD); \
648 * Pins the server certificate to be directly trusted (even if it is expired)
649 * for verifying response messages.
650 * Cert pointer is not consumed. It may be NULL to clear the entry.
652 DEFINE_OSSL_CMP_CTX_set1_up_ref(srvCert
, X509
)
654 /* Set the X509 name of the recipient. Set in the PKIHeader */
655 DEFINE_OSSL_CMP_CTX_set1(recipient
, X509_NAME
)
657 /* Store the X509 name of the expected sender in the PKIHeader of responses */
658 DEFINE_OSSL_CMP_CTX_set1(expected_sender
, X509_NAME
)
660 /* Set the X509 name of the issuer. Set in the PKIHeader */
661 DEFINE_OSSL_CMP_CTX_set1(issuer
, X509_NAME
)
664 * Set the subject name that will be placed in the certificate
665 * request. This will be the subject name on the received certificate.
667 DEFINE_OSSL_CMP_CTX_set1(subjectName
, X509_NAME
)
669 /* Set the X.509v3 certificate request extensions to be used in IR/CR/KUR */
670 int OSSL_CMP_CTX_set0_reqExtensions(OSSL_CMP_CTX
*ctx
, X509_EXTENSIONS
*exts
)
673 CMPerr(0, CMP_R_NULL_ARGUMENT
);
677 if (sk_GENERAL_NAME_num(ctx
->subjectAltNames
) > 0 && exts
!= NULL
678 && X509v3_get_ext_by_NID(exts
, NID_subject_alt_name
, -1) >= 0) {
679 CMPerr(0, CMP_R_MULTIPLE_SAN_SOURCES
);
682 sk_X509_EXTENSION_pop_free(ctx
->reqExtensions
, X509_EXTENSION_free
);
683 ctx
->reqExtensions
= exts
;
687 /* returns 1 if ctx contains a Subject Alternative Name extension, else 0 */
688 int OSSL_CMP_CTX_reqExtensions_have_SAN(OSSL_CMP_CTX
*ctx
)
691 CMPerr(0, CMP_R_NULL_ARGUMENT
);
694 /* if one of the following conditions 'fail' this is not an error */
695 return ctx
->reqExtensions
!= NULL
696 && X509v3_get_ext_by_NID(ctx
->reqExtensions
,
697 NID_subject_alt_name
, -1) >= 0;
701 * Add a GENERAL_NAME structure that will be added to the CRMF
702 * request's extensions field to request subject alternative names.
704 int OSSL_CMP_CTX_push1_subjectAltName(OSSL_CMP_CTX
*ctx
,
705 const GENERAL_NAME
*name
)
707 GENERAL_NAME
*name_dup
;
709 if (ctx
== NULL
|| name
== NULL
) {
710 CMPerr(0, CMP_R_NULL_ARGUMENT
);
714 if (OSSL_CMP_CTX_reqExtensions_have_SAN(ctx
) == 1) {
715 CMPerr(0, CMP_R_MULTIPLE_SAN_SOURCES
);
719 if (ctx
->subjectAltNames
== NULL
720 && (ctx
->subjectAltNames
= sk_GENERAL_NAME_new_null()) == NULL
)
722 if ((name_dup
= GENERAL_NAME_dup(name
)) == NULL
)
724 if (!sk_GENERAL_NAME_push(ctx
->subjectAltNames
, name_dup
)) {
725 GENERAL_NAME_free(name_dup
);
732 * Set our own client certificate, used for example in KUR and when
733 * doing the IR with existing certificate.
735 DEFINE_OSSL_CMP_CTX_set1_up_ref(cert
, X509
)
737 int OSSL_CMP_CTX_build_cert_chain(OSSL_CMP_CTX
*ctx
, X509_STORE
*own_trusted
,
738 STACK_OF(X509
) *candidates
)
740 STACK_OF(X509
) *chain
;
743 CMPerr(0, CMP_R_NULL_ARGUMENT
);
747 if (ctx
->untrusted
!= NULL
?
748 !X509_add_certs(ctx
->untrusted
, candidates
,
749 X509_ADD_FLAG_UP_REF
| X509_ADD_FLAG_NO_DUP
) :
750 !OSSL_CMP_CTX_set1_untrusted(ctx
, candidates
))
753 ossl_cmp_debug(ctx
, "trying to build chain for own CMP signer cert");
754 chain
= ossl_cmp_build_cert_chain(ctx
->libctx
, ctx
->propq
, own_trusted
,
755 ctx
->untrusted
, ctx
->cert
);
757 CMPerr(0, CMP_R_FAILED_BUILDING_OWN_CHAIN
);
760 ossl_cmp_debug(ctx
, "success building chain for own CMP signer cert");
766 * Set the old certificate that we are updating in KUR
767 * or the certificate to be revoked in RR, respectively.
768 * Also used as reference cert (defaulting to cert) for deriving subject DN
769 * and SANs. Its issuer is used as default recipient in the CMP message header.
771 DEFINE_OSSL_CMP_CTX_set1_up_ref(oldCert
, X509
)
773 /* Set the PKCS#10 CSR to be sent in P10CR */
774 DEFINE_OSSL_CMP_CTX_set1(p10CSR
, X509_REQ
)
777 * Set the (newly received in IP/KUP/CP) certificate in the context.
778 * TODO: this only permits for one cert to be enrolled at a time.
780 int ossl_cmp_ctx_set0_newCert(OSSL_CMP_CTX
*ctx
, X509
*cert
)
782 if (!ossl_assert(ctx
!= NULL
))
785 X509_free(ctx
->newCert
);
791 * Get the (newly received in IP/KUP/CP) client certificate from the context
792 * TODO: this only permits for one client cert to be received...
794 X509
*OSSL_CMP_CTX_get0_newCert(const OSSL_CMP_CTX
*ctx
)
797 CMPerr(0, CMP_R_NULL_ARGUMENT
);
803 /* Set the client's current private key */
804 DEFINE_OSSL_CMP_CTX_set1_up_ref(pkey
, EVP_PKEY
)
806 /* Set new key pair. Used e.g. when doing Key Update */
807 int OSSL_CMP_CTX_set0_newPkey(OSSL_CMP_CTX
*ctx
, int priv
, EVP_PKEY
*pkey
)
810 CMPerr(0, CMP_R_NULL_ARGUMENT
);
814 EVP_PKEY_free(ctx
->newPkey
);
816 ctx
->newPkey_priv
= priv
;
820 /* Get the private/public key to use for cert enrollment, or NULL on error */
821 EVP_PKEY
*OSSL_CMP_CTX_get0_newPkey(const OSSL_CMP_CTX
*ctx
, int priv
)
824 CMPerr(0, CMP_R_NULL_ARGUMENT
);
828 if (ctx
->newPkey
!= NULL
)
829 return priv
&& !ctx
->newPkey_priv
? NULL
: ctx
->newPkey
;
830 if (ctx
->p10CSR
!= NULL
)
831 return priv
? NULL
: X509_REQ_get0_pubkey(ctx
->p10CSR
);
832 return ctx
->pkey
; /* may be NULL */
835 /* Set the given transactionID to the context */
836 int OSSL_CMP_CTX_set1_transactionID(OSSL_CMP_CTX
*ctx
,
837 const ASN1_OCTET_STRING
*id
)
840 CMPerr(0, CMP_R_NULL_ARGUMENT
);
843 return ossl_cmp_asn1_octet_string_set1(&ctx
->transactionID
, id
);
846 /* Set the nonce to be used for the recipNonce in the message created next */
847 int ossl_cmp_ctx_set1_recipNonce(OSSL_CMP_CTX
*ctx
,
848 const ASN1_OCTET_STRING
*nonce
)
850 if (!ossl_assert(ctx
!= NULL
))
852 return ossl_cmp_asn1_octet_string_set1(&ctx
->recipNonce
, nonce
);
855 /* Stores the given nonce as the last senderNonce sent out */
856 int OSSL_CMP_CTX_set1_senderNonce(OSSL_CMP_CTX
*ctx
,
857 const ASN1_OCTET_STRING
*nonce
)
860 CMPerr(0, CMP_R_NULL_ARGUMENT
);
863 return ossl_cmp_asn1_octet_string_set1(&ctx
->senderNonce
, nonce
);
866 /* Set the proxy server to use for HTTP(S) connections */
867 DEFINE_OSSL_CMP_CTX_set1(proxy
, char)
869 /* Set the (HTTP) host name of the CMP server */
870 DEFINE_OSSL_CMP_CTX_set1(server
, char)
872 /* Set the server exclusion list of the HTTP proxy server */
873 DEFINE_OSSL_CMP_CTX_set1(no_proxy
, char)
875 /* Set the http connect/disconnect callback function to be used for HTTP(S) */
876 int OSSL_CMP_CTX_set_http_cb(OSSL_CMP_CTX
*ctx
, OSSL_HTTP_bio_cb_t cb
)
879 CMPerr(0, CMP_R_NULL_ARGUMENT
);
886 /* Set argument optionally to be used by the http connect/disconnect callback */
887 int OSSL_CMP_CTX_set_http_cb_arg(OSSL_CMP_CTX
*ctx
, void *arg
)
890 CMPerr(0, CMP_R_NULL_ARGUMENT
);
893 ctx
->http_cb_arg
= arg
;
898 * Get argument optionally to be used by the http connect/disconnect callback
899 * Returns callback argument set previously (NULL if not set or on error)
901 void *OSSL_CMP_CTX_get_http_cb_arg(const OSSL_CMP_CTX
*ctx
)
904 CMPerr(0, CMP_R_NULL_ARGUMENT
);
907 return ctx
->http_cb_arg
;
910 /* Set callback function for sending CMP request and receiving response */
911 int OSSL_CMP_CTX_set_transfer_cb(OSSL_CMP_CTX
*ctx
, OSSL_CMP_transfer_cb_t cb
)
914 CMPerr(0, CMP_R_NULL_ARGUMENT
);
917 ctx
->transfer_cb
= cb
;
921 /* Set argument optionally to be used by the transfer callback */
922 int OSSL_CMP_CTX_set_transfer_cb_arg(OSSL_CMP_CTX
*ctx
, void *arg
)
925 CMPerr(0, CMP_R_NULL_ARGUMENT
);
928 ctx
->transfer_cb_arg
= arg
;
933 * Get argument optionally to be used by the transfer callback.
934 * Returns callback argument set previously (NULL if not set or on error)
936 void *OSSL_CMP_CTX_get_transfer_cb_arg(const OSSL_CMP_CTX
*ctx
)
939 CMPerr(0, CMP_R_NULL_ARGUMENT
);
942 return ctx
->transfer_cb_arg
;
945 /** Set the HTTP server port to be used */
946 int OSSL_CMP_CTX_set_serverPort(OSSL_CMP_CTX
*ctx
, int port
)
949 CMPerr(0, CMP_R_NULL_ARGUMENT
);
952 ctx
->serverPort
= port
;
956 /* Set the HTTP path to be used on the server (e.g "pkix/") */
957 DEFINE_OSSL_CMP_CTX_set1(serverPath
, char)
959 /* Set the failInfo error code as bit encoding in OSSL_CMP_CTX */
960 int ossl_cmp_ctx_set_failInfoCode(OSSL_CMP_CTX
*ctx
, int fail_info
)
962 if (!ossl_assert(ctx
!= NULL
))
964 ctx
->failInfoCode
= fail_info
;
969 * Get the failInfo error code in OSSL_CMP_CTX as bit encoding.
970 * Returns bit string as integer on success, -1 on error
972 int OSSL_CMP_CTX_get_failInfoCode(const OSSL_CMP_CTX
*ctx
)
975 CMPerr(0, CMP_R_NULL_ARGUMENT
);
978 return ctx
->failInfoCode
;
981 /* Set a Boolean or integer option of the context to the "val" arg */
982 int OSSL_CMP_CTX_set_option(OSSL_CMP_CTX
*ctx
, int opt
, int val
)
987 CMPerr(0, CMP_R_NULL_ARGUMENT
);
992 case OSSL_CMP_OPT_REVOCATION_REASON
:
993 min_val
= OCSP_REVOKED_STATUS_NOSTATUS
;
995 case OSSL_CMP_OPT_POPO_METHOD
:
996 min_val
= OSSL_CRMF_POPO_NONE
;
1002 if (val
< min_val
) {
1003 CMPerr(0, CMP_R_VALUE_TOO_SMALL
);
1008 case OSSL_CMP_OPT_LOG_VERBOSITY
:
1009 if (val
> OSSL_CMP_LOG_MAX
) {
1010 CMPerr(0, CMP_R_VALUE_TOO_LARGE
);
1013 ctx
->log_verbosity
= val
;
1015 case OSSL_CMP_OPT_IMPLICIT_CONFIRM
:
1016 ctx
->implicitConfirm
= val
;
1018 case OSSL_CMP_OPT_DISABLE_CONFIRM
:
1019 ctx
->disableConfirm
= val
;
1021 case OSSL_CMP_OPT_UNPROTECTED_SEND
:
1022 ctx
->unprotectedSend
= val
;
1024 case OSSL_CMP_OPT_UNPROTECTED_ERRORS
:
1025 ctx
->unprotectedErrors
= val
;
1027 case OSSL_CMP_OPT_VALIDITY_DAYS
:
1030 case OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT
:
1031 ctx
->SubjectAltName_nodefault
= val
;
1033 case OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL
:
1034 ctx
->setSubjectAltNameCritical
= val
;
1036 case OSSL_CMP_OPT_POLICIES_CRITICAL
:
1037 ctx
->setPoliciesCritical
= val
;
1039 case OSSL_CMP_OPT_IGNORE_KEYUSAGE
:
1040 ctx
->ignore_keyusage
= val
;
1042 case OSSL_CMP_OPT_POPO_METHOD
:
1043 if (val
> OSSL_CRMF_POPO_KEYAGREE
) {
1044 CMPerr(0, CMP_R_VALUE_TOO_LARGE
);
1047 ctx
->popoMethod
= val
;
1049 case OSSL_CMP_OPT_DIGEST_ALGNID
:
1050 if (!cmp_ctx_set_md(ctx
, &ctx
->digest
, val
))
1053 case OSSL_CMP_OPT_OWF_ALGNID
:
1054 if (!cmp_ctx_set_md(ctx
, &ctx
->pbm_owf
, val
))
1057 case OSSL_CMP_OPT_MAC_ALGNID
:
1060 case OSSL_CMP_OPT_MSG_TIMEOUT
:
1061 ctx
->msg_timeout
= val
;
1063 case OSSL_CMP_OPT_TOTAL_TIMEOUT
:
1064 ctx
->total_timeout
= val
;
1066 case OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR
:
1067 ctx
->permitTAInExtraCertsForIR
= val
;
1069 case OSSL_CMP_OPT_REVOCATION_REASON
:
1070 if (val
> OCSP_REVOKED_STATUS_AACOMPROMISE
) {
1071 CMPerr(0, CMP_R_VALUE_TOO_LARGE
);
1074 ctx
->revocationReason
= val
;
1077 CMPerr(0, CMP_R_INVALID_OPTION
);
1085 * Reads a Boolean or integer option value from the context.
1086 * Returns -1 on error (which is the default OSSL_CMP_OPT_REVOCATION_REASON)
1088 int OSSL_CMP_CTX_get_option(const OSSL_CMP_CTX
*ctx
, int opt
)
1091 CMPerr(0, CMP_R_NULL_ARGUMENT
);
1096 case OSSL_CMP_OPT_LOG_VERBOSITY
:
1097 return ctx
->log_verbosity
;
1098 case OSSL_CMP_OPT_IMPLICIT_CONFIRM
:
1099 return ctx
->implicitConfirm
;
1100 case OSSL_CMP_OPT_DISABLE_CONFIRM
:
1101 return ctx
->disableConfirm
;
1102 case OSSL_CMP_OPT_UNPROTECTED_SEND
:
1103 return ctx
->unprotectedSend
;
1104 case OSSL_CMP_OPT_UNPROTECTED_ERRORS
:
1105 return ctx
->unprotectedErrors
;
1106 case OSSL_CMP_OPT_VALIDITY_DAYS
:
1108 case OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT
:
1109 return ctx
->SubjectAltName_nodefault
;
1110 case OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL
:
1111 return ctx
->setSubjectAltNameCritical
;
1112 case OSSL_CMP_OPT_POLICIES_CRITICAL
:
1113 return ctx
->setPoliciesCritical
;
1114 case OSSL_CMP_OPT_IGNORE_KEYUSAGE
:
1115 return ctx
->ignore_keyusage
;
1116 case OSSL_CMP_OPT_POPO_METHOD
:
1117 return ctx
->popoMethod
;
1118 case OSSL_CMP_OPT_DIGEST_ALGNID
:
1119 return EVP_MD_type(ctx
->digest
);
1120 case OSSL_CMP_OPT_OWF_ALGNID
:
1121 return EVP_MD_type(ctx
->pbm_owf
);
1122 case OSSL_CMP_OPT_MAC_ALGNID
:
1123 return ctx
->pbm_mac
;
1124 case OSSL_CMP_OPT_MSG_TIMEOUT
:
1125 return ctx
->msg_timeout
;
1126 case OSSL_CMP_OPT_TOTAL_TIMEOUT
:
1127 return ctx
->total_timeout
;
1128 case OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR
:
1129 return ctx
->permitTAInExtraCertsForIR
;
1130 case OSSL_CMP_OPT_REVOCATION_REASON
:
1131 return ctx
->revocationReason
;
1133 CMPerr(0, CMP_R_INVALID_OPTION
);