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 #ifndef OSSL_CRYPTO_CMP_LOCAL_H
13 # define OSSL_CRYPTO_CMP_LOCAL_H
15 # include "internal/cryptlib.h"
17 # include <openssl/cmp.h>
18 # include <openssl/err.h>
20 /* explicit #includes not strictly needed since implied by the above: */
21 # include <openssl/crmf.h>
22 # include <openssl/types.h>
23 # include <openssl/safestack.h>
24 # include <openssl/x509.h>
25 # include <openssl/x509v3.h>
28 * this structure is used to store the context for CMP sessions
30 struct ossl_cmp_ctx_st
{
31 OSSL_CMP_log_cb_t log_cb
; /* log callback for error/debug/etc. output */
32 OSSL_CMP_severity log_verbosity
; /* level of verbosity of log output */
34 /* message transfer */
35 OSSL_CMP_transfer_cb_t transfer_cb
; /* default: OSSL_CMP_MSG_http_perform */
36 void *transfer_cb_arg
; /* allows to store optional argument to cb */
37 /* HTTP-based transfer */
43 int msg_timeout
; /* max seconds to wait for each CMP message round trip */
44 int total_timeout
; /* max number of seconds an enrollment may take, incl. */
45 /* attempts polling for a response if a 'waiting' PKIStatus is received */
46 time_t end_time
; /* session start time + totaltimeout */
47 OSSL_HTTP_bio_cb_t http_cb
;
48 void *http_cb_arg
; /* allows to store optional argument to cb */
50 /* server authentication */
52 * unprotectedErrors may be set as workaround for broken server responses:
53 * accept missing or invalid protection of regular error messages, negative
54 * certificate responses (ip/cp/kup), revocation responses (rp), and PKIConf
56 int unprotectedErrors
;
57 X509
*srvCert
; /* certificate used to identify the server */
58 X509
*validatedSrvCert
; /* caches any already validated server cert */
59 X509_NAME
*expected_sender
; /* expected sender in header of response */
60 X509_STORE
*trusted
; /* trust store maybe w CRLs and cert verify callback */
61 STACK_OF(X509
) *untrusted_certs
; /* untrusted (intermediate) certs */
62 int ignore_keyusage
; /* ignore key usage entry when validating certs */
64 * permitTAInExtraCertsForIR allows use of root certs in extracerts
65 * when validating message protection; this is used for 3GPP-style E.7
67 int permitTAInExtraCertsForIR
;
69 /* client authentication */
70 int unprotectedSend
; /* send unprotected PKI messages */
71 X509
*cert
; /* protection cert used to identify and sign for MSG_SIG_ALG */
72 EVP_PKEY
*pkey
; /* the key pair corresponding to cert */
73 ASN1_OCTET_STRING
*referenceValue
; /* optional user name for MSG_MAC_ALG */
74 ASN1_OCTET_STRING
*secretValue
; /* password/shared secret for MSG_MAC_ALG */
75 /* PBMParameters for MSG_MAC_ALG */
76 size_t pbm_slen
; /* currently fixed to 16 */
77 int pbm_owf
; /* NID of one-way function (OWF), default: SHA256 */
78 int pbm_itercnt
; /* currently fixed to 500 */
79 int pbm_mac
; /* NID of MAC algorithm, default: HMAC-SHA1 as per RFC 4210 */
81 /* CMP message header and extra certificates */
82 X509_NAME
*recipient
; /* to set in recipient in pkiheader */
83 int digest
; /* NID of digest used in MSG_SIG_ALG and POPO, default SHA256 */
84 ASN1_OCTET_STRING
*transactionID
; /* the current transaction ID */
85 ASN1_OCTET_STRING
*senderNonce
; /* last nonce sent */
86 ASN1_OCTET_STRING
*recipNonce
; /* last nonce received */
87 ASN1_UTF8STRING
*freeText
; /* optional string to include each msg */
88 STACK_OF(OSSL_CMP_ITAV
) *geninfo_ITAVs
;
89 int implicitConfirm
; /* set implicitConfirm in IR/KUR/CR messages */
90 int disableConfirm
; /* disable certConf in IR/KUR/CR for broken servers */
91 STACK_OF(X509
) *extraCertsOut
; /* to be included in request messages */
93 /* certificate template */
94 EVP_PKEY
*newPkey
; /* explicit new private/public key for cert enrollment */
95 int newPkey_priv
; /* flag indicating if newPkey contains private key */
96 X509_NAME
*issuer
; /* issuer name to used in cert template */
97 int days
; /* Number of days new certificates are asked to be valid for */
98 X509_NAME
*subjectName
; /* subject name to be used in cert template */
99 STACK_OF(GENERAL_NAME
) *subjectAltNames
; /* to add to the cert template */
100 int SubjectAltName_nodefault
;
101 int setSubjectAltNameCritical
;
102 X509_EXTENSIONS
*reqExtensions
; /* exts to be added to cert template */
103 CERTIFICATEPOLICIES
*policies
; /* policies to be included in extensions */
104 int setPoliciesCritical
;
105 int popoMethod
; /* Proof-of-possession mechanism; default: signature */
106 X509
*oldCert
; /* cert to be updated (via KUR) or to be revoked (via RR) */
107 X509_REQ
*p10CSR
; /* for P10CR: PKCS#10 CSR to be sent */
109 /* misc body contents */
110 int revocationReason
; /* revocation reason code to be included in RR */
111 STACK_OF(OSSL_CMP_ITAV
) *genm_ITAVs
; /* content of general message */
113 /* result returned in responses */
114 int status
; /* PKIStatus of last received IP/CP/KUP/RP/error or -1 */
115 /* TODO: this should be a stack since there could be more than one */
116 OSSL_CMP_PKIFREETEXT
*statusString
; /* of last IP/CP/KUP/RP/error */
117 int failInfoCode
; /* failInfoCode of last received IP/CP/KUP/error, or -1 */
118 /* TODO: this should be a stack since there could be more than one */
119 X509
*newCert
; /* newly enrolled cert received from the CA */
120 /* TODO: this should be a stack since there could be more than one */
121 STACK_OF(X509
) *caPubs
; /* CA certs received from server (in IP message) */
122 STACK_OF(X509
) *extraCertsIn
; /* extraCerts received from server */
124 /* certificate confirmation */
125 OSSL_CMP_certConf_cb_t certConf_cb
; /* callback for app checking new cert */
126 void *certConf_cb_arg
; /* allows to store an argument individual to cb */
127 } /* OSSL_CMP_CTX */;
130 * ##########################################################################
132 * ##########################################################################
136 * RevAnnContent ::= SEQUENCE {
139 * willBeRevokedAt GeneralizedTime,
140 * badSinceDate GeneralizedTime,
141 * crlDetails Extensions OPTIONAL
142 * -- extra CRL details (e.g., crl number, reason, location, etc.)
145 typedef struct ossl_cmp_revanncontent_st
{
146 ASN1_INTEGER
*status
;
147 OSSL_CRMF_CERTID
*certId
;
148 ASN1_GENERALIZEDTIME
*willBeRevokedAt
;
149 ASN1_GENERALIZEDTIME
*badSinceDate
;
150 X509_EXTENSIONS
*crlDetails
;
151 } OSSL_CMP_REVANNCONTENT
;
152 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVANNCONTENT
)
155 * Challenge ::= SEQUENCE {
156 * owf AlgorithmIdentifier OPTIONAL,
158 * -- MUST be present in the first Challenge; MAY be omitted in
159 * -- any subsequent Challenge in POPODecKeyChallContent (if
160 * -- omitted, then the owf used in the immediately preceding
161 * -- Challenge is to be used).
163 * witness OCTET STRING,
164 * -- the result of applying the one-way function (owf) to a
165 * -- randomly-generated INTEGER, A. [Note that a different
166 * -- INTEGER MUST be used for each Challenge.]
167 * challenge OCTET STRING
168 * -- the encryption (under the public key for which the cert.
169 * -- request is being made) of Rand, where Rand is specified as
170 * -- Rand ::= SEQUENCE {
172 * -- - the randomly-generated INTEGER A (above)
173 * -- sender GeneralName
174 * -- - the sender's name (as included in PKIHeader)
178 typedef struct ossl_cmp_challenge_st
{
180 ASN1_OCTET_STRING
*witness
;
181 ASN1_OCTET_STRING
*challenge
;
182 } OSSL_CMP_CHALLENGE
;
183 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CHALLENGE
)
186 * CAKeyUpdAnnContent ::= SEQUENCE {
187 * oldWithNew Certificate,
188 * newWithOld Certificate,
189 * newWithNew Certificate
192 typedef struct ossl_cmp_cakeyupdanncontent_st
{
196 } OSSL_CMP_CAKEYUPDANNCONTENT
;
197 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CAKEYUPDANNCONTENT
)
200 * declared already here as it will be used in OSSL_CMP_MSG (nested) and
201 * infoType and infoValue
203 typedef STACK_OF(OSSL_CMP_MSG
) OSSL_CMP_MSGS
;
204 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_MSGS
)
207 * InfoTypeAndValue ::= SEQUENCE {
208 * infoType OBJECT IDENTIFIER,
209 * infoValue ANY DEFINED BY infoType OPTIONAL
212 struct ossl_cmp_itav_st
{
213 ASN1_OBJECT
*infoType
;
216 /* NID_id_it_caProtEncCert - CA Protocol Encryption Certificate */
218 /* NID_id_it_signKeyPairTypes - Signing Key Pair Types */
219 STACK_OF(X509_ALGOR
) *signKeyPairTypes
;
220 /* NID_id_it_encKeyPairTypes - Encryption/Key Agreement Key Pair Types */
221 STACK_OF(X509_ALGOR
) *encKeyPairTypes
;
222 /* NID_id_it_preferredSymmAlg - Preferred Symmetric Algorithm */
223 X509_ALGOR
*preferredSymmAlg
;
224 /* NID_id_it_caKeyUpdateInfo - Updated CA Key Pair */
225 OSSL_CMP_CAKEYUPDANNCONTENT
*caKeyUpdateInfo
;
226 /* NID_id_it_currentCRL - CRL */
227 X509_CRL
*currentCRL
;
228 /* NID_id_it_unsupportedOIDs - Unsupported Object Identifiers */
229 STACK_OF(ASN1_OBJECT
) *unsupportedOIDs
;
230 /* NID_id_it_keyPairParamReq - Key Pair Parameters Request */
231 ASN1_OBJECT
*keyPairParamReq
;
232 /* NID_id_it_keyPairParamRep - Key Pair Parameters Response */
233 X509_ALGOR
*keyPairParamRep
;
234 /* NID_id_it_revPassphrase - Revocation Passphrase */
235 OSSL_CRMF_ENCRYPTEDVALUE
*revPassphrase
;
236 /* NID_id_it_implicitConfirm - ImplicitConfirm */
237 ASN1_NULL
*implicitConfirm
;
238 /* NID_id_it_confirmWaitTime - ConfirmWaitTime */
239 ASN1_GENERALIZEDTIME
*confirmWaitTime
;
240 /* NID_id_it_origPKIMessage - origPKIMessage */
241 OSSL_CMP_MSGS
*origPKIMessage
;
242 /* NID_id_it_suppLangTags - Supported Language Tags */
243 STACK_OF(ASN1_UTF8STRING
) *suppLangTagsValue
;
244 /* this is to be used for so far undeclared objects */
247 } /* OSSL_CMP_ITAV */;
248 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ITAV
)
250 typedef struct ossl_cmp_certorenccert_st
{
254 OSSL_CRMF_ENCRYPTEDVALUE
*encryptedCert
;
256 } OSSL_CMP_CERTORENCCERT
;
257 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTORENCCERT
)
260 * CertifiedKeyPair ::= SEQUENCE {
261 * certOrEncCert CertOrEncCert,
262 * privateKey [0] EncryptedValue OPTIONAL,
263 * -- see [CRMF] for comment on encoding
264 * publicationInfo [1] PKIPublicationInfo OPTIONAL
267 typedef struct ossl_cmp_certifiedkeypair_st
{
268 OSSL_CMP_CERTORENCCERT
*certOrEncCert
;
269 OSSL_CRMF_ENCRYPTEDVALUE
*privateKey
;
270 OSSL_CRMF_PKIPUBLICATIONINFO
*publicationInfo
;
271 } OSSL_CMP_CERTIFIEDKEYPAIR
;
272 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTIFIEDKEYPAIR
)
275 * PKIStatusInfo ::= SEQUENCE {
277 * statusString PKIFreeText OPTIONAL,
278 * failInfo PKIFailureInfo OPTIONAL
281 struct ossl_cmp_pkisi_st
{
282 OSSL_CMP_PKISTATUS
*status
;
283 OSSL_CMP_PKIFREETEXT
*statusString
;
284 OSSL_CMP_PKIFAILUREINFO
*failInfo
;
285 } /* OSSL_CMP_PKISI */;
288 * RevReqContent ::= SEQUENCE OF RevDetails
290 * RevDetails ::= SEQUENCE {
291 * certDetails CertTemplate,
292 * crlEntryDetails Extensions OPTIONAL
295 struct ossl_cmp_revdetails_st
{
296 OSSL_CRMF_CERTTEMPLATE
*certDetails
;
297 X509_EXTENSIONS
*crlEntryDetails
;
298 } /* OSSL_CMP_REVDETAILS */;
299 typedef struct ossl_cmp_revdetails_st OSSL_CMP_REVDETAILS
;
300 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVDETAILS
)
301 DEFINE_STACK_OF(OSSL_CMP_REVDETAILS
)
304 * RevRepContent ::= SEQUENCE {
305 * status SEQUENCE SIZE (1..MAX) OF PKIStatusInfo,
306 * -- in same order as was sent in RevReqContent
307 * revCerts [0] SEQUENCE SIZE (1..MAX) OF CertId
309 * -- IDs for which revocation was requested
310 * -- (same order as status)
311 * crls [1] SEQUENCE SIZE (1..MAX) OF CertificateList
313 * -- the resulting CRLs (there may be more than one)
316 struct ossl_cmp_revrepcontent_st
{
317 STACK_OF(OSSL_CMP_PKISI
) *status
;
318 STACK_OF(OSSL_CRMF_CERTID
) *revCerts
;
319 STACK_OF(X509_CRL
) *crls
;
320 } /* OSSL_CMP_REVREPCONTENT */;
321 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVREPCONTENT
)
324 * KeyRecRepContent ::= SEQUENCE {
325 * status PKIStatusInfo,
326 * newSigCert [0] Certificate OPTIONAL,
327 * caCerts [1] SEQUENCE SIZE (1..MAX) OF
328 * Certificate OPTIONAL,
329 * keyPairHist [2] SEQUENCE SIZE (1..MAX) OF
330 * CertifiedKeyPair OPTIONAL
333 typedef struct ossl_cmp_keyrecrepcontent_st
{
334 OSSL_CMP_PKISI
*status
;
336 STACK_OF(X509
) *caCerts
;
337 STACK_OF(OSSL_CMP_CERTIFIEDKEYPAIR
) *keyPairHist
;
338 } OSSL_CMP_KEYRECREPCONTENT
;
339 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_KEYRECREPCONTENT
)
342 * ErrorMsgContent ::= SEQUENCE {
343 * pKIStatusInfo PKIStatusInfo,
344 * errorCode INTEGER OPTIONAL,
345 * -- implementation-specific error codes
346 * errorDetails PKIFreeText OPTIONAL
347 * -- implementation-specific error details
350 typedef struct ossl_cmp_errormsgcontent_st
{
351 OSSL_CMP_PKISI
*pKIStatusInfo
;
352 ASN1_INTEGER
*errorCode
;
353 OSSL_CMP_PKIFREETEXT
*errorDetails
;
354 } OSSL_CMP_ERRORMSGCONTENT
;
355 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ERRORMSGCONTENT
)
358 * CertConfirmContent ::= SEQUENCE OF CertStatus
360 * CertStatus ::= SEQUENCE {
361 * certHash OCTET STRING,
362 * -- the hash of the certificate, using the same hash algorithm
363 * -- as is used to create and verify the certificate signature
365 * -- to match this confirmation with the corresponding req/rep
366 * statusInfo PKIStatusInfo OPTIONAL
369 struct ossl_cmp_certstatus_st
{
370 ASN1_OCTET_STRING
*certHash
;
371 ASN1_INTEGER
*certReqId
;
372 OSSL_CMP_PKISI
*statusInfo
;
373 } /* OSSL_CMP_CERTSTATUS */;
374 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTSTATUS
)
375 typedef STACK_OF(OSSL_CMP_CERTSTATUS
) OSSL_CMP_CERTCONFIRMCONTENT
;
376 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTCONFIRMCONTENT
)
379 * CertResponse ::= SEQUENCE {
381 * -- to match this response with corresponding request (a value
382 * -- of -1 is to be used if certReqId is not specified in the
383 * -- corresponding request)
384 * status PKIStatusInfo,
385 * certifiedKeyPair CertifiedKeyPair OPTIONAL,
386 * rspInfo OCTET STRING OPTIONAL
387 * -- analogous to the id-regInfo-utf8Pairs string defined
388 * -- for regInfo in CertReqMsg [CRMF]
391 struct ossl_cmp_certresponse_st
{
392 ASN1_INTEGER
*certReqId
;
393 OSSL_CMP_PKISI
*status
;
394 OSSL_CMP_CERTIFIEDKEYPAIR
*certifiedKeyPair
;
395 ASN1_OCTET_STRING
*rspInfo
;
396 } /* OSSL_CMP_CERTRESPONSE */;
397 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTRESPONSE
)
400 * CertRepMessage ::= SEQUENCE {
401 * caPubs [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
403 * response SEQUENCE OF CertResponse
406 struct ossl_cmp_certrepmessage_st
{
407 STACK_OF(X509
) *caPubs
;
408 STACK_OF(OSSL_CMP_CERTRESPONSE
) *response
;
409 } /* OSSL_CMP_CERTREPMESSAGE */;
410 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTREPMESSAGE
)
413 * PollReqContent ::= SEQUENCE OF SEQUENCE {
417 typedef struct ossl_cmp_pollreq_st
{
418 ASN1_INTEGER
*certReqId
;
420 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREQ
)
421 DEFINE_STACK_OF(OSSL_CMP_POLLREQ
)
422 typedef STACK_OF(OSSL_CMP_POLLREQ
) OSSL_CMP_POLLREQCONTENT
;
423 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREQCONTENT
)
426 * PollRepContent ::= SEQUENCE OF SEQUENCE {
428 * checkAfter INTEGER, -- time in seconds
429 * reason PKIFreeText OPTIONAL
432 struct ossl_cmp_pollrep_st
{
433 ASN1_INTEGER
*certReqId
;
434 ASN1_INTEGER
*checkAfter
;
435 OSSL_CMP_PKIFREETEXT
*reason
;
436 } /* OSSL_CMP_POLLREP */;
437 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREP
)
438 DEFINE_STACK_OF(OSSL_CMP_POLLREP
)
439 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREPCONTENT
)
442 * PKIHeader ::= SEQUENCE {
443 * pvno INTEGER { cmp1999(1), cmp2000(2) },
444 * sender GeneralName,
445 * -- identifies the sender
446 * recipient GeneralName,
447 * -- identifies the intended recipient
448 * messageTime [0] GeneralizedTime OPTIONAL,
449 * -- time of production of this message (used when sender
450 * -- believes that the transport will be "suitable"; i.e.,
451 * -- that the time will still be meaningful upon receipt)
452 * protectionAlg [1] AlgorithmIdentifier OPTIONAL,
453 * -- algorithm used for calculation of protection bits
454 * senderKID [2] KeyIdentifier OPTIONAL,
455 * recipKID [3] KeyIdentifier OPTIONAL,
456 * -- to identify specific keys used for protection
457 * transactionID [4] OCTET STRING OPTIONAL,
458 * -- identifies the transaction; i.e., this will be the same in
459 * -- corresponding request, response, certConf, and PKIConf
461 * senderNonce [5] OCTET STRING OPTIONAL,
462 * recipNonce [6] OCTET STRING OPTIONAL,
463 * -- nonces used to provide replay protection, senderNonce
464 * -- is inserted by the creator of this message; recipNonce
465 * -- is a nonce previously inserted in a related message by
466 * -- the intended recipient of this message
467 * freeText [7] PKIFreeText OPTIONAL,
468 * -- this may be used to indicate context-specific instructions
469 * -- (this field is intended for human consumption)
470 * generalInfo [8] SEQUENCE SIZE (1..MAX) OF
471 * InfoTypeAndValue OPTIONAL
472 * -- this may be used to convey context-specific information
473 * -- (this field not primarily intended for human consumption)
476 struct ossl_cmp_pkiheader_st
{
478 GENERAL_NAME
*sender
;
479 GENERAL_NAME
*recipient
;
480 ASN1_GENERALIZEDTIME
*messageTime
; /* 0 */
481 X509_ALGOR
*protectionAlg
; /* 1 */
482 ASN1_OCTET_STRING
*senderKID
; /* 2 */
483 ASN1_OCTET_STRING
*recipKID
; /* 3 */
484 ASN1_OCTET_STRING
*transactionID
; /* 4 */
485 ASN1_OCTET_STRING
*senderNonce
; /* 5 */
486 ASN1_OCTET_STRING
*recipNonce
; /* 6 */
487 OSSL_CMP_PKIFREETEXT
*freeText
; /* 7 */
488 STACK_OF(OSSL_CMP_ITAV
) *generalInfo
; /* 8 */
489 } /* OSSL_CMP_PKIHEADER */;
491 typedef STACK_OF(OSSL_CMP_CHALLENGE
) OSSL_CMP_POPODECKEYCHALLCONTENT
;
492 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POPODECKEYCHALLCONTENT
)
493 typedef STACK_OF(ASN1_INTEGER
) OSSL_CMP_POPODECKEYRESPCONTENT
;
494 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POPODECKEYRESPCONTENT
)
495 typedef STACK_OF(OSSL_CMP_REVDETAILS
) OSSL_CMP_REVREQCONTENT
;
496 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVREQCONTENT
)
497 typedef STACK_OF(X509_CRL
) OSSL_CMP_CRLANNCONTENT
;
498 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CRLANNCONTENT
)
499 typedef STACK_OF(OSSL_CMP_ITAV
) OSSL_CMP_GENMSGCONTENT
;
500 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_GENMSGCONTENT
)
501 typedef STACK_OF(OSSL_CMP_ITAV
) OSSL_CMP_GENREPCONTENT
;
502 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_GENREPCONTENT
)
505 * PKIBody ::= CHOICE { -- message-specific body elements
506 * ir [0] CertReqMessages, --Initialization Request
507 * ip [1] CertRepMessage, --Initialization Response
508 * cr [2] CertReqMessages, --Certification Request
509 * cp [3] CertRepMessage, --Certification Response
510 * p10cr [4] CertificationRequest, --imported from [PKCS10]
511 * popdecc [5] POPODecKeyChallContent, --pop Challenge
512 * popdecr [6] POPODecKeyRespContent, --pop Response
513 * kur [7] CertReqMessages, --Key Update Request
514 * kup [8] CertRepMessage, --Key Update Response
515 * krr [9] CertReqMessages, --Key Recovery Request
516 * krp [10] KeyRecRepContent, --Key Recovery Response
517 * rr [11] RevReqContent, --Revocation Request
518 * rp [12] RevRepContent, --Revocation Response
519 * ccr [13] CertReqMessages, --Cross-Cert. Request
520 * ccp [14] CertRepMessage, --Cross-Cert. Response
521 * ckuann [15] CAKeyUpdAnnContent, --CA Key Update Ann.
522 * cann [16] CertAnnContent, --Certificate Ann.
523 * rann [17] RevAnnContent, --Revocation Ann.
524 * crlann [18] CRLAnnContent, --CRL Announcement
525 * pkiconf [19] PKIConfirmContent, --Confirmation
526 * nested [20] NestedMessageContent, --Nested Message
527 * genm [21] GenMsgContent, --General Message
528 * genp [22] GenRepContent, --General Response
529 * error [23] ErrorMsgContent, --Error Message
530 * certConf [24] CertConfirmContent, --Certificate confirm
531 * pollReq [25] PollReqContent, --Polling request
532 * pollRep [26] PollRepContent --Polling response
535 typedef struct ossl_cmp_pkibody_st
{
538 OSSL_CRMF_MSGS
*ir
; /* 0 */
539 OSSL_CMP_CERTREPMESSAGE
*ip
; /* 1 */
540 OSSL_CRMF_MSGS
*cr
; /* 2 */
541 OSSL_CMP_CERTREPMESSAGE
*cp
; /* 3 */
543 * p10cr [4] CertificationRequest, --imported from [PKCS10]
545 * PKCS10_CERTIFICATIONREQUEST is effectively X509_REQ
546 * so it is used directly
548 X509_REQ
*p10cr
; /* 4 */
550 * popdecc [5] POPODecKeyChallContent, --pop Challenge
552 * POPODecKeyChallContent ::= SEQUENCE OF Challenge
554 OSSL_CMP_POPODECKEYCHALLCONTENT
*popdecc
; /* 5 */
556 * popdecr [6] POPODecKeyRespContent, --pop Response
558 * POPODecKeyRespContent ::= SEQUENCE OF INTEGER
560 OSSL_CMP_POPODECKEYRESPCONTENT
*popdecr
; /* 6 */
561 OSSL_CRMF_MSGS
*kur
; /* 7 */
562 OSSL_CMP_CERTREPMESSAGE
*kup
; /* 8 */
563 OSSL_CRMF_MSGS
*krr
; /* 9 */
566 * krp [10] KeyRecRepContent, --Key Recovery Response
568 OSSL_CMP_KEYRECREPCONTENT
*krp
; /* 10 */
570 * rr [11] RevReqContent, --Revocation Request
572 OSSL_CMP_REVREQCONTENT
*rr
; /* 11 */
574 * rp [12] RevRepContent, --Revocation Response
576 OSSL_CMP_REVREPCONTENT
*rp
; /* 12 */
578 * ccr [13] CertReqMessages, --Cross-Cert. Request
580 OSSL_CRMF_MSGS
*ccr
; /* 13 */
582 * ccp [14] CertRepMessage, --Cross-Cert. Response
584 OSSL_CMP_CERTREPMESSAGE
*ccp
; /* 14 */
586 * ckuann [15] CAKeyUpdAnnContent, --CA Key Update Ann.
588 OSSL_CMP_CAKEYUPDANNCONTENT
*ckuann
; /* 15 */
590 * cann [16] CertAnnContent, --Certificate Ann.
591 * OSSL_CMP_CMPCERTIFICATE is effectively X509 so it is used directly
595 * rann [17] RevAnnContent, --Revocation Ann.
597 OSSL_CMP_REVANNCONTENT
*rann
; /* 17 */
599 * crlann [18] CRLAnnContent, --CRL Announcement
600 * CRLAnnContent ::= SEQUENCE OF CertificateList
602 OSSL_CMP_CRLANNCONTENT
*crlann
; /* 18 */
604 * PKIConfirmContent ::= NULL
605 * pkiconf [19] PKIConfirmContent, --Confirmation
606 * OSSL_CMP_PKICONFIRMCONTENT would be only a typedef of ASN1_NULL
607 * OSSL_CMP_CONFIRMCONTENT *pkiconf;
609 * NOTE: this should ASN1_NULL according to the RFC
610 * but there might be a struct in it when sent from faulty servers...
612 ASN1_TYPE
*pkiconf
; /* 19 */
614 * nested [20] NestedMessageContent, --Nested Message
615 * NestedMessageContent ::= PKIMessages
617 OSSL_CMP_MSGS
*nested
; /* 20 */
619 * genm [21] GenMsgContent, --General Message
620 * GenMsgContent ::= SEQUENCE OF InfoTypeAndValue
622 OSSL_CMP_GENMSGCONTENT
*genm
; /* 21 */
624 * genp [22] GenRepContent, --General Response
625 * GenRepContent ::= SEQUENCE OF InfoTypeAndValue
627 OSSL_CMP_GENREPCONTENT
*genp
; /* 22 */
629 * error [23] ErrorMsgContent, --Error Message
631 OSSL_CMP_ERRORMSGCONTENT
*error
; /* 23 */
633 * certConf [24] CertConfirmContent, --Certificate confirm
635 OSSL_CMP_CERTCONFIRMCONTENT
*certConf
; /* 24 */
637 * pollReq [25] PollReqContent, --Polling request
639 OSSL_CMP_POLLREQCONTENT
*pollReq
; /* 25 */
641 * pollRep [26] PollRepContent --Polling response
643 OSSL_CMP_POLLREPCONTENT
*pollRep
; /* 26 */
646 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_PKIBODY
)
649 * PKIProtection ::= BIT STRING
651 * PKIMessages ::= SEQUENCE SIZE (1..MAX) OF PKIMessage
653 * PKIMessage ::= SEQUENCE {
656 * protection [0] PKIProtection OPTIONAL,
657 * extraCerts [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
661 struct ossl_cmp_msg_st
{
662 OSSL_CMP_PKIHEADER
*header
;
663 OSSL_CMP_PKIBODY
*body
;
664 ASN1_BIT_STRING
*protection
; /* 0 */
665 /* OSSL_CMP_CMPCERTIFICATE is effectively X509 so it is used directly */
666 STACK_OF(X509
) *extraCerts
; /* 1 */
667 } /* OSSL_CMP_MSG */;
668 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_MSG
)
671 * ProtectedPart ::= SEQUENCE {
676 typedef struct ossl_cmp_protectedpart_st
{
677 OSSL_CMP_PKIHEADER
*header
;
678 OSSL_CMP_PKIBODY
*body
;
679 } OSSL_CMP_PROTECTEDPART
;
680 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_PROTECTEDPART
)
683 * this is not defined here as it is already in CRMF:
684 * id-PasswordBasedMac OBJECT IDENTIFIER ::= {1 2 840 113533 7 66 13}
685 * PBMParameter ::= SEQUENCE {
687 * -- note: implementations MAY wish to limit acceptable sizes
688 * -- of this string to values appropriate for their environment
689 * -- in order to reduce the risk of denial-of-service attacks
690 * owf AlgorithmIdentifier,
691 * -- AlgId for a One-Way Function (SHA-1 recommended)
692 * iterationCount INTEGER,
693 * -- number of times the OWF is applied
694 * -- note: implementations MAY wish to limit acceptable sizes
695 * -- of this integer to values appropriate for their environment
696 * -- in order to reduce the risk of denial-of-service attacks
697 * mac AlgorithmIdentifier
698 * -- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11],
699 * } -- or HMAC [RFC2104, RFC2202])
702 * TODO: this is not yet defined here - but DH is anyway not used yet
704 * id-DHBasedMac OBJECT IDENTIFIER ::= {1 2 840 113533 7 66 30}
705 * DHBMParameter ::= SEQUENCE {
706 * owf AlgorithmIdentifier,
707 * -- AlgId for a One-Way Function (SHA-1 recommended)
708 * mac AlgorithmIdentifier
709 * -- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11],
710 * } -- or HMAC [RFC2104, RFC2202])
713 * The following is not cared for, because it is described in section 5.2.5
714 * that this is beyond the scope of CMP
715 * OOBCert ::= CMPCertificate
717 * OOBCertHash ::= SEQUENCE {
718 * hashAlg [0] AlgorithmIdentifier OPTIONAL,
719 * certId [1] CertId OPTIONAL,
721 * -- hashVal is calculated over the DER encoding of the
722 * -- self-signed certificate with the identifier certID.
727 int ossl_cmp_asn1_get_int(const ASN1_INTEGER
*a
);
729 /* from cmp_util.c */
730 const char *ossl_cmp_log_parse_metadata(const char *buf
,
731 OSSL_CMP_severity
*level
, char **func
,
732 char **file
, int *line
);
733 # define ossl_cmp_add_error_data(txt) ERR_add_error_txt(" : ", txt)
734 # define ossl_cmp_add_error_line(txt) ERR_add_error_txt("\n", txt)
735 /* The two functions manipulating X509_STORE could be generally useful */
736 int ossl_cmp_X509_STORE_add1_certs(X509_STORE
*store
, STACK_OF(X509
) *certs
,
737 int only_self_issued
);
738 STACK_OF(X509
) *ossl_cmp_X509_STORE_get1_certs(X509_STORE
*store
);
739 int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING
) *sk
,
741 int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING
**tgt
,
742 const ASN1_OCTET_STRING
*src
);
743 int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING
**tgt
,
744 const unsigned char *bytes
, int len
);
745 STACK_OF(X509
) *ossl_cmp_build_cert_chain(STACK_OF(X509
) *certs
, X509
*cert
);
748 int ossl_cmp_print_log(OSSL_CMP_severity level
, const OSSL_CMP_CTX
*ctx
,
749 const char *func
, const char *file
, int line
,
750 const char *level_str
, const char *format
, ...);
751 # define ossl_cmp_log(level, ctx, msg) \
752 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
753 OPENSSL_LINE, #level, "%s", msg)
754 # define ossl_cmp_log1(level, ctx, fmt, arg1) \
755 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
756 OPENSSL_LINE, #level, fmt, arg1)
757 # define ossl_cmp_log2(level, ctx, fmt, arg1, arg2) \
758 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
759 OPENSSL_LINE, #level, fmt, arg1, arg2)
760 # define ossl_cmp_log3(level, ctx, fmt, arg1, arg2, arg3) \
761 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
762 OPENSSL_LINE, #level, fmt, arg1, arg2, arg3)
763 # define ossl_cmp_log4(level, ctx, fmt, arg1, arg2, arg3, arg4) \
764 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
765 OPENSSL_LINE, #level, fmt, arg1, arg2, arg3, arg4)
766 # define OSSL_CMP_LOG_ERROR OSSL_CMP_LOG_ERR
767 # define OSSL_CMP_LOG_WARN OSSL_CMP_LOG_WARNING
768 # define ossl_cmp_alert(ctx, msg) ossl_cmp_log(ALERT, ctx, msg)
769 # define ossl_cmp_err(ctx, msg) ossl_cmp_log(ERROR, ctx, msg)
770 # define ossl_cmp_warn(ctx, msg) ossl_cmp_log(WARN, ctx, msg)
771 # define ossl_cmp_info(ctx, msg) ossl_cmp_log(INFO, ctx, msg)
772 # define ossl_cmp_debug(ctx, msg) ossl_cmp_log(DEBUG, ctx, msg)
773 int ossl_cmp_ctx_set0_validatedSrvCert(OSSL_CMP_CTX
*ctx
, X509
*cert
);
774 int ossl_cmp_ctx_set_status(OSSL_CMP_CTX
*ctx
, int status
);
775 int ossl_cmp_ctx_set0_statusString(OSSL_CMP_CTX
*ctx
,
776 OSSL_CMP_PKIFREETEXT
*text
);
777 int ossl_cmp_ctx_set_failInfoCode(OSSL_CMP_CTX
*ctx
, int fail_info
);
778 int ossl_cmp_ctx_set0_newCert(OSSL_CMP_CTX
*ctx
, X509
*cert
);
779 int ossl_cmp_ctx_set1_caPubs(OSSL_CMP_CTX
*ctx
, STACK_OF(X509
) *caPubs
);
780 int ossl_cmp_ctx_set1_extraCertsIn(OSSL_CMP_CTX
*ctx
,
781 STACK_OF(X509
) *extraCertsIn
);
782 int ossl_cmp_ctx_set1_recipNonce(OSSL_CMP_CTX
*ctx
,
783 const ASN1_OCTET_STRING
*nonce
);
785 /* from cmp_status.c */
786 int ossl_cmp_pkisi_get_status(const OSSL_CMP_PKISI
*si
);
787 const char *ossl_cmp_PKIStatus_to_string(int status
);
788 OSSL_CMP_PKIFREETEXT
*ossl_cmp_pkisi_get0_statusString(const OSSL_CMP_PKISI
*s
);
789 int ossl_cmp_pkisi_get_pkifailureinfo(const OSSL_CMP_PKISI
*si
);
790 int ossl_cmp_pkisi_check_pkifailureinfo(const OSSL_CMP_PKISI
*si
, int index
);
793 int ossl_cmp_hdr_set_pvno(OSSL_CMP_PKIHEADER
*hdr
, int pvno
);
794 int ossl_cmp_hdr_get_pvno(const OSSL_CMP_PKIHEADER
*hdr
);
795 int ossl_cmp_hdr_get_protection_nid(const OSSL_CMP_PKIHEADER
*hdr
);
796 ASN1_OCTET_STRING
*ossl_cmp_hdr_get0_senderNonce(const OSSL_CMP_PKIHEADER
*hdr
);
797 int ossl_cmp_general_name_is_NULL_DN(GENERAL_NAME
*name
);
798 int ossl_cmp_hdr_set1_sender(OSSL_CMP_PKIHEADER
*hdr
, const X509_NAME
*nm
);
799 int ossl_cmp_hdr_set1_recipient(OSSL_CMP_PKIHEADER
*hdr
, const X509_NAME
*nm
);
800 int ossl_cmp_hdr_update_messageTime(OSSL_CMP_PKIHEADER
*hdr
);
801 int ossl_cmp_hdr_set1_senderKID(OSSL_CMP_PKIHEADER
*hdr
,
802 const ASN1_OCTET_STRING
*senderKID
);
803 int ossl_cmp_hdr_push0_freeText(OSSL_CMP_PKIHEADER
*hdr
, ASN1_UTF8STRING
*text
);
804 int ossl_cmp_hdr_push1_freeText(OSSL_CMP_PKIHEADER
*hdr
, ASN1_UTF8STRING
*text
);
805 int ossl_cmp_hdr_generalInfo_push0_item(OSSL_CMP_PKIHEADER
*hdr
,
806 OSSL_CMP_ITAV
*itav
);
807 int ossl_cmp_hdr_generalInfo_push1_items(OSSL_CMP_PKIHEADER
*hdr
,
808 const STACK_OF(OSSL_CMP_ITAV
) *itavs
);
809 int ossl_cmp_hdr_set_implicitConfirm(OSSL_CMP_PKIHEADER
*hdr
);
810 int ossl_cmp_hdr_has_implicitConfirm(const OSSL_CMP_PKIHEADER
*hdr
);
811 # define OSSL_CMP_TRANSACTIONID_LENGTH 16
812 # define OSSL_CMP_SENDERNONCE_LENGTH 16
813 int ossl_cmp_hdr_set_transactionID(OSSL_CMP_CTX
*ctx
, OSSL_CMP_PKIHEADER
*hdr
);
814 int ossl_cmp_hdr_init(OSSL_CMP_CTX
*ctx
, OSSL_CMP_PKIHEADER
*hdr
);
817 /* OSSL_CMP_MSG bodytype ASN.1 choice IDs */
818 # define OSSL_CMP_PKIBODY_IR 0
819 # define OSSL_CMP_PKIBODY_IP 1
820 # define OSSL_CMP_PKIBODY_CR 2
821 # define OSSL_CMP_PKIBODY_CP 3
822 # define OSSL_CMP_PKIBODY_P10CR 4
823 # define OSSL_CMP_PKIBODY_POPDECC 5
824 # define OSSL_CMP_PKIBODY_POPDECR 6
825 # define OSSL_CMP_PKIBODY_KUR 7
826 # define OSSL_CMP_PKIBODY_KUP 8
827 # define OSSL_CMP_PKIBODY_KRR 9
828 # define OSSL_CMP_PKIBODY_KRP 10
829 # define OSSL_CMP_PKIBODY_RR 11
830 # define OSSL_CMP_PKIBODY_RP 12
831 # define OSSL_CMP_PKIBODY_CCR 13
832 # define OSSL_CMP_PKIBODY_CCP 14
833 # define OSSL_CMP_PKIBODY_CKUANN 15
834 # define OSSL_CMP_PKIBODY_CANN 16
835 # define OSSL_CMP_PKIBODY_RANN 17
836 # define OSSL_CMP_PKIBODY_CRLANN 18
837 # define OSSL_CMP_PKIBODY_PKICONF 19
838 # define OSSL_CMP_PKIBODY_NESTED 20
839 # define OSSL_CMP_PKIBODY_GENM 21
840 # define OSSL_CMP_PKIBODY_GENP 22
841 # define OSSL_CMP_PKIBODY_ERROR 23
842 # define OSSL_CMP_PKIBODY_CERTCONF 24
843 # define OSSL_CMP_PKIBODY_POLLREQ 25
844 # define OSSL_CMP_PKIBODY_POLLREP 26
845 # define OSSL_CMP_PKIBODY_TYPE_MAX OSSL_CMP_PKIBODY_POLLREP
846 /* certReqId for the first - and so far only - certificate request */
847 # define OSSL_CMP_CERTREQID 0
848 /* sequence id for the first - and so far only - revocation request */
849 # define OSSL_CMP_REVREQSID 0
850 const char *ossl_cmp_bodytype_to_string(int type
);
851 int ossl_cmp_msg_set_bodytype(OSSL_CMP_MSG
*msg
, int type
);
852 int ossl_cmp_msg_get_bodytype(const OSSL_CMP_MSG
*msg
);
853 OSSL_CMP_MSG
*ossl_cmp_msg_create(OSSL_CMP_CTX
*ctx
, int bodytype
);
854 OSSL_CMP_MSG
*ossl_cmp_certreq_new(OSSL_CMP_CTX
*ctx
, int bodytype
,
855 const OSSL_CRMF_MSG
*crm
);
856 OSSL_CMP_MSG
*ossl_cmp_certrep_new(OSSL_CMP_CTX
*ctx
, int bodytype
,
857 int certReqId
, OSSL_CMP_PKISI
*si
,
858 X509
*cert
, STACK_OF(X509
) *chain
,
859 STACK_OF(X509
) *caPubs
, int encrypted
,
860 int unprotectedErrors
);
861 OSSL_CMP_MSG
*ossl_cmp_rr_new(OSSL_CMP_CTX
*ctx
);
862 OSSL_CMP_MSG
*ossl_cmp_rp_new(OSSL_CMP_CTX
*ctx
, OSSL_CMP_PKISI
*si
,
863 OSSL_CRMF_CERTID
*certId
, int unprot_err
);
864 OSSL_CMP_MSG
*ossl_cmp_pkiconf_new(OSSL_CMP_CTX
*ctx
);
865 OSSL_CMP_MSG
*ossl_cmp_pollRep_new(OSSL_CMP_CTX
*ctx
, int crid
,
867 int ossl_cmp_msg_gen_push0_ITAV(OSSL_CMP_MSG
*msg
, OSSL_CMP_ITAV
*itav
);
868 int ossl_cmp_msg_gen_push1_ITAVs(OSSL_CMP_MSG
*msg
,
869 const STACK_OF(OSSL_CMP_ITAV
) *itavs
);
870 OSSL_CMP_MSG
*ossl_cmp_genm_new(OSSL_CMP_CTX
*ctx
);
871 OSSL_CMP_MSG
*ossl_cmp_genp_new(OSSL_CMP_CTX
*ctx
,
872 const STACK_OF(OSSL_CMP_ITAV
) *itavs
);
873 OSSL_CMP_MSG
*ossl_cmp_error_new(OSSL_CMP_CTX
*ctx
, OSSL_CMP_PKISI
*si
,
875 const char *details
, int unprotected
);
876 int ossl_cmp_certstatus_set0_certHash(OSSL_CMP_CERTSTATUS
*certStatus
,
877 ASN1_OCTET_STRING
*hash
);
878 OSSL_CMP_MSG
*ossl_cmp_certConf_new(OSSL_CMP_CTX
*ctx
, int fail_info
,
880 OSSL_CMP_MSG
*ossl_cmp_pollReq_new(OSSL_CMP_CTX
*ctx
, int crid
);
881 OSSL_CMP_MSG
*ossl_cmp_pollRep_new(OSSL_CMP_CTX
*ctx
, int crid
,
884 ossl_cmp_revrepcontent_get_pkisi(OSSL_CMP_REVREPCONTENT
*rrep
, int rsid
);
885 OSSL_CRMF_CERTID
*ossl_cmp_revrepcontent_get_CertId(OSSL_CMP_REVREPCONTENT
*rc
,
888 ossl_cmp_pollrepcontent_get0_pollrep(const OSSL_CMP_POLLREPCONTENT
*prc
,
890 OSSL_CMP_CERTRESPONSE
*
891 ossl_cmp_certrepmessage_get0_certresponse(const OSSL_CMP_CERTREPMESSAGE
*crm
,
893 X509
*ossl_cmp_certresponse_get1_certificate(EVP_PKEY
*privkey
,
894 const OSSL_CMP_CERTRESPONSE
*crep
);
896 /* from cmp_protect.c */
897 ASN1_BIT_STRING
*ossl_cmp_calc_protection(const OSSL_CMP_MSG
*msg
,
898 const ASN1_OCTET_STRING
*secret
,
900 int ossl_cmp_msg_add_extraCerts(OSSL_CMP_CTX
*ctx
, OSSL_CMP_MSG
*msg
);
901 int ossl_cmp_msg_protect(OSSL_CMP_CTX
*ctx
, OSSL_CMP_MSG
*msg
);
904 typedef int (*ossl_cmp_allow_unprotected_cb_t
)(const OSSL_CMP_CTX
*ctx
,
905 const OSSL_CMP_MSG
*msg
,
906 int invalid_protection
, int arg
);
907 int ossl_cmp_msg_check_update(OSSL_CMP_CTX
*ctx
, const OSSL_CMP_MSG
*msg
,
908 ossl_cmp_allow_unprotected_cb_t cb
, int cb_arg
);
909 int ossl_cmp_verify_popo(const OSSL_CMP_MSG
*msg
, int accept_RAVerified
);
911 /* from cmp_client.c */
912 int ossl_cmp_exchange_certConf(OSSL_CMP_CTX
*ctx
, int fail_info
,
914 int ossl_cmp_exchange_error(OSSL_CMP_CTX
*ctx
, int status
, int fail_info
,
915 const char *txt
, int errorCode
, const char *detail
);
917 #endif /* !defined(OSSL_CRYPTO_CMP_LOCAL_H) */