/* * Copyright 2007-2023 The OpenSSL Project Authors. All Rights Reserved. * Copyright Nokia 2007-2019 * Copyright Siemens AG 2015-2019 * * Licensed under the Apache License 2.0 (the "License"). You may not use * this file except in compliance with the License. You can obtain a copy * in the file LICENSE in the source distribution or at * https://www.openssl.org/source/license.html */ #ifndef OSSL_CRYPTO_CMP_LOCAL_H # define OSSL_CRYPTO_CMP_LOCAL_H # include "internal/cryptlib.h" # include # include /* explicit #includes not strictly needed since implied by the above: */ # include # include # include # include # include # include "crypto/x509.h" # define IS_NULL_DN(name) (X509_NAME_get_entry(name, 0) == NULL) /* * this structure is used to store the context for CMP sessions */ struct ossl_cmp_ctx_st { OSSL_LIB_CTX *libctx; char *propq; OSSL_CMP_log_cb_t log_cb; /* log callback for error/debug/etc. output */ OSSL_CMP_severity log_verbosity; /* level of verbosity of log output */ /* message transfer */ OSSL_CMP_transfer_cb_t transfer_cb; /* default: OSSL_CMP_MSG_http_perform */ void *transfer_cb_arg; /* allows to store optional argument to cb */ /* HTTP-based transfer */ OSSL_HTTP_REQ_CTX *http_ctx; char *serverPath; char *server; int serverPort; char *proxy; char *no_proxy; int keep_alive; /* persistent connection: 0=no, 1=prefer, 2=require */ int msg_timeout; /* max seconds to wait for each CMP message round trip */ int total_timeout; /* max number of seconds an enrollment may take, incl. */ /* attempts polling for a response if a 'waiting' PKIStatus is received */ time_t end_time; /* session start time + totaltimeout */ # ifndef OPENSSL_NO_HTTP OSSL_HTTP_bio_cb_t http_cb; void *http_cb_arg; /* allows to store optional argument to cb */ # endif /* server authentication */ /* * unprotectedErrors may be set as workaround for broken server responses: * accept missing or invalid protection of regular error messages, negative * certificate responses (ip/cp/kup), revocation responses (rp), and PKIConf */ int unprotectedErrors; X509 *srvCert; /* certificate used to identify the server */ X509 *validatedSrvCert; /* caches any already validated server cert */ X509_NAME *expected_sender; /* expected sender in header of response */ X509_STORE *trusted; /* trust store maybe w CRLs and cert verify callback */ STACK_OF(X509) *untrusted; /* untrusted (intermediate CA) certs */ int ignore_keyusage; /* ignore key usage entry when validating certs */ /* * permitTAInExtraCertsForIR allows use of root certs in extracerts * when validating message protection; this is used for 3GPP-style E.7 */ int permitTAInExtraCertsForIR; /* client authentication */ int unprotectedSend; /* send unprotected PKI messages */ X509 *cert; /* protection cert used to identify and sign for MSG_SIG_ALG */ STACK_OF(X509) *chain; /* (cached) chain of protection cert including it */ EVP_PKEY *pkey; /* the key pair corresponding to cert */ ASN1_OCTET_STRING *referenceValue; /* optional username for MSG_MAC_ALG */ ASN1_OCTET_STRING *secretValue; /* password/shared secret for MSG_MAC_ALG */ /* PBMParameters for MSG_MAC_ALG */ size_t pbm_slen; /* salt length, currently fixed to 16 */ EVP_MD *pbm_owf; /* one-way function (OWF), default: SHA256 */ int pbm_itercnt; /* OWF iteration count, currently fixed to 500 */ int pbm_mac; /* NID of MAC algorithm, default: HMAC-SHA1 as per RFC 4210 */ /* CMP message header and extra certificates */ X509_NAME *recipient; /* to set in recipient in pkiheader */ EVP_MD *digest; /* digest used in MSG_SIG_ALG and POPO, default SHA256 */ ASN1_OCTET_STRING *transactionID; /* the current transaction ID */ ASN1_OCTET_STRING *senderNonce; /* last nonce sent */ ASN1_OCTET_STRING *recipNonce; /* last nonce received */ ASN1_UTF8STRING *freeText; /* optional string to include each msg */ STACK_OF(OSSL_CMP_ITAV) *geninfo_ITAVs; int implicitConfirm; /* set implicitConfirm in IR/KUR/CR messages */ int disableConfirm; /* disable certConf in IR/KUR/CR for broken servers */ STACK_OF(X509) *extraCertsOut; /* to be included in request messages */ /* certificate template */ EVP_PKEY *newPkey; /* explicit new private/public key for cert enrollment */ int newPkey_priv; /* flag indicating if newPkey contains private key */ X509_NAME *issuer; /* issuer name to used in cert template, also in rr */ ASN1_INTEGER *serialNumber; /* certificate serial number to use in rr */ int days; /* Number of days new certificates are asked to be valid for */ X509_NAME *subjectName; /* subject name to be used in cert template */ STACK_OF(GENERAL_NAME) *subjectAltNames; /* to add to the cert template */ int SubjectAltName_nodefault; int setSubjectAltNameCritical; X509_EXTENSIONS *reqExtensions; /* exts to be added to cert template */ CERTIFICATEPOLICIES *policies; /* policies to be included in extensions */ int setPoliciesCritical; int popoMethod; /* Proof-of-possession mechanism; default: signature */ X509 *oldCert; /* cert to be updated (via KUR) or to be revoked (via RR) */ X509_REQ *p10CSR; /* for P10CR: PKCS#10 CSR to be sent */ /* misc body contents */ int revocationReason; /* revocation reason code to be included in RR */ STACK_OF(OSSL_CMP_ITAV) *genm_ITAVs; /* content of general message */ /* result returned in responses, so far supporting only one certResponse */ int status; /* PKIStatus of last received IP/CP/KUP/RP/error or -1 */ OSSL_CMP_PKIFREETEXT *statusString; /* of last IP/CP/KUP/RP/error */ int failInfoCode; /* failInfoCode of last received IP/CP/KUP/error, or -1 */ X509 *newCert; /* newly enrolled cert received from the CA */ STACK_OF(X509) *newChain; /* chain of newly enrolled cert received */ STACK_OF(X509) *caPubs; /* CA certs received from server (in IP message) */ STACK_OF(X509) *extraCertsIn; /* extraCerts received from server */ /* certificate confirmation */ OSSL_CMP_certConf_cb_t certConf_cb; /* callback for app checking new cert */ void *certConf_cb_arg; /* allows to store an argument individual to cb */ } /* OSSL_CMP_CTX */; /* * ########################################################################## * ASN.1 DECLARATIONS * ########################################################################## */ /*- * RevAnnContent ::= SEQUENCE { * status PKIStatus, * certId CertId, * willBeRevokedAt GeneralizedTime, * badSinceDate GeneralizedTime, * crlDetails Extensions OPTIONAL * -- extra CRL details (e.g., crl number, reason, location, etc.) * } */ typedef struct ossl_cmp_revanncontent_st { ASN1_INTEGER *status; OSSL_CRMF_CERTID *certId; ASN1_GENERALIZEDTIME *willBeRevokedAt; ASN1_GENERALIZEDTIME *badSinceDate; X509_EXTENSIONS *crlDetails; } OSSL_CMP_REVANNCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVANNCONTENT) /*- * Challenge ::= SEQUENCE { * owf AlgorithmIdentifier OPTIONAL, * * -- MUST be present in the first Challenge; MAY be omitted in * -- any subsequent Challenge in POPODecKeyChallContent (if * -- omitted, then the owf used in the immediately preceding * -- Challenge is to be used). * * witness OCTET STRING, * -- the result of applying the one-way function (owf) to a * -- randomly-generated INTEGER, A. [Note that a different * -- INTEGER MUST be used for each Challenge.] * challenge OCTET STRING * -- the encryption (under the public key for which the cert. * -- request is being made) of Rand, where Rand is specified as * -- Rand ::= SEQUENCE { * -- int INTEGER, * -- - the randomly-generated INTEGER A (above) * -- sender GeneralName * -- - the sender's name (as included in PKIHeader) * -- } * } */ typedef struct ossl_cmp_challenge_st { X509_ALGOR *owf; ASN1_OCTET_STRING *witness; ASN1_OCTET_STRING *challenge; } OSSL_CMP_CHALLENGE; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CHALLENGE) /*- * CAKeyUpdAnnContent ::= SEQUENCE { * oldWithNew Certificate, * newWithOld Certificate, * newWithNew Certificate * } */ typedef struct ossl_cmp_cakeyupdanncontent_st { X509 *oldWithNew; X509 *newWithOld; X509 *newWithNew; } OSSL_CMP_CAKEYUPDANNCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CAKEYUPDANNCONTENT) typedef struct ossl_cmp_rootcakeyupdate_st OSSL_CMP_ROOTCAKEYUPDATE; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ROOTCAKEYUPDATE) /*- * declared already here as it will be used in OSSL_CMP_MSG (nested) and * infoType and infoValue */ typedef STACK_OF(OSSL_CMP_MSG) OSSL_CMP_MSGS; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_MSGS) /*- * InfoTypeAndValue ::= SEQUENCE { * infoType OBJECT IDENTIFIER, * infoValue ANY DEFINED BY infoType OPTIONAL * } */ struct ossl_cmp_itav_st { ASN1_OBJECT *infoType; union { char *ptr; /* NID_id_it_caProtEncCert - CA Protocol Encryption Certificate */ X509 *caProtEncCert; /* NID_id_it_signKeyPairTypes - Signing Key Pair Types */ STACK_OF(X509_ALGOR) *signKeyPairTypes; /* NID_id_it_encKeyPairTypes - Encryption/Key Agreement Key Pair Types */ STACK_OF(X509_ALGOR) *encKeyPairTypes; /* NID_id_it_preferredSymmAlg - Preferred Symmetric Algorithm */ X509_ALGOR *preferredSymmAlg; /* NID_id_it_caKeyUpdateInfo - Updated CA Key Pair */ OSSL_CMP_CAKEYUPDANNCONTENT *caKeyUpdateInfo; /* NID_id_it_currentCRL - CRL */ X509_CRL *currentCRL; /* NID_id_it_unsupportedOIDs - Unsupported Object Identifiers */ STACK_OF(ASN1_OBJECT) *unsupportedOIDs; /* NID_id_it_keyPairParamReq - Key Pair Parameters Request */ ASN1_OBJECT *keyPairParamReq; /* NID_id_it_keyPairParamRep - Key Pair Parameters Response */ X509_ALGOR *keyPairParamRep; /* NID_id_it_revPassphrase - Revocation Passphrase */ OSSL_CRMF_ENCRYPTEDVALUE *revPassphrase; /* NID_id_it_implicitConfirm - ImplicitConfirm */ ASN1_NULL *implicitConfirm; /* NID_id_it_confirmWaitTime - ConfirmWaitTime */ ASN1_GENERALIZEDTIME *confirmWaitTime; /* NID_id_it_origPKIMessage - origPKIMessage */ OSSL_CMP_MSGS *origPKIMessage; /* NID_id_it_suppLangTags - Supported Language Tags */ STACK_OF(ASN1_UTF8STRING) *suppLangTagsValue; /* NID_id_it_caCerts - CA Certificates */ STACK_OF(X509) *caCerts; /* NID_id_it_rootCaCert - Root CA Certificate */ X509 *rootCaCert; /* NID_id_it_rootCaKeyUpdate - Root CA Certificate Update */ OSSL_CMP_ROOTCAKEYUPDATE *rootCaKeyUpdate; /* this is to be used for so far undeclared objects */ ASN1_TYPE *other; } infoValue; } /* OSSL_CMP_ITAV */; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ITAV) typedef struct ossl_cmp_certorenccert_st { int type; union { X509 *certificate; OSSL_CRMF_ENCRYPTEDVALUE *encryptedCert; } value; } OSSL_CMP_CERTORENCCERT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTORENCCERT) /*- * CertifiedKeyPair ::= SEQUENCE { * certOrEncCert CertOrEncCert, * privateKey [0] EncryptedValue OPTIONAL, * -- see [CRMF] for comment on encoding * publicationInfo [1] PKIPublicationInfo OPTIONAL * } */ typedef struct ossl_cmp_certifiedkeypair_st { OSSL_CMP_CERTORENCCERT *certOrEncCert; OSSL_CRMF_ENCRYPTEDVALUE *privateKey; OSSL_CRMF_PKIPUBLICATIONINFO *publicationInfo; } OSSL_CMP_CERTIFIEDKEYPAIR; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTIFIEDKEYPAIR) /*- * PKIStatusInfo ::= SEQUENCE { * status PKIStatus, * statusString PKIFreeText OPTIONAL, * failInfo PKIFailureInfo OPTIONAL * } */ struct ossl_cmp_pkisi_st { OSSL_CMP_PKISTATUS *status; OSSL_CMP_PKIFREETEXT *statusString; OSSL_CMP_PKIFAILUREINFO *failInfo; } /* OSSL_CMP_PKISI */; /*- * RevReqContent ::= SEQUENCE OF RevDetails * * RevDetails ::= SEQUENCE { * certDetails CertTemplate, * crlEntryDetails Extensions OPTIONAL * } */ struct ossl_cmp_revdetails_st { OSSL_CRMF_CERTTEMPLATE *certDetails; X509_EXTENSIONS *crlEntryDetails; } /* OSSL_CMP_REVDETAILS */; typedef struct ossl_cmp_revdetails_st OSSL_CMP_REVDETAILS; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVDETAILS) DEFINE_STACK_OF(OSSL_CMP_REVDETAILS) /*- * RevRepContent ::= SEQUENCE { * status SEQUENCE SIZE (1..MAX) OF PKIStatusInfo, * -- in same order as was sent in RevReqContent * revCerts [0] SEQUENCE SIZE (1..MAX) OF CertId * OPTIONAL, * -- IDs for which revocation was requested * -- (same order as status) * crls [1] SEQUENCE SIZE (1..MAX) OF CertificateList * OPTIONAL * -- the resulting CRLs (there may be more than one) * } */ struct ossl_cmp_revrepcontent_st { STACK_OF(OSSL_CMP_PKISI) *status; STACK_OF(OSSL_CRMF_CERTID) *revCerts; STACK_OF(X509_CRL) *crls; } /* OSSL_CMP_REVREPCONTENT */; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVREPCONTENT) /*- * KeyRecRepContent ::= SEQUENCE { * status PKIStatusInfo, * newSigCert [0] Certificate OPTIONAL, * caCerts [1] SEQUENCE SIZE (1..MAX) OF * Certificate OPTIONAL, * keyPairHist [2] SEQUENCE SIZE (1..MAX) OF * CertifiedKeyPair OPTIONAL * } */ typedef struct ossl_cmp_keyrecrepcontent_st { OSSL_CMP_PKISI *status; X509 *newSigCert; STACK_OF(X509) *caCerts; STACK_OF(OSSL_CMP_CERTIFIEDKEYPAIR) *keyPairHist; } OSSL_CMP_KEYRECREPCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_KEYRECREPCONTENT) /*- * ErrorMsgContent ::= SEQUENCE { * pKIStatusInfo PKIStatusInfo, * errorCode INTEGER OPTIONAL, * -- implementation-specific error codes * errorDetails PKIFreeText OPTIONAL * -- implementation-specific error details * } */ typedef struct ossl_cmp_errormsgcontent_st { OSSL_CMP_PKISI *pKIStatusInfo; ASN1_INTEGER *errorCode; OSSL_CMP_PKIFREETEXT *errorDetails; } OSSL_CMP_ERRORMSGCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ERRORMSGCONTENT) /*- * CertConfirmContent ::= SEQUENCE OF CertStatus * * CertStatus ::= SEQUENCE { * certHash OCTET STRING, * -- the hash of the certificate, using the same hash algorithm * -- as is used to create and verify the certificate signature * certReqId INTEGER, * -- to match this confirmation with the corresponding req/rep * statusInfo PKIStatusInfo OPTIONAL, * hashAlg [0] AlgorithmIdentifier OPTIONAL * } */ struct ossl_cmp_certstatus_st { ASN1_OCTET_STRING *certHash; ASN1_INTEGER *certReqId; OSSL_CMP_PKISI *statusInfo; X509_ALGOR *hashAlg; /* 0 */ } /* OSSL_CMP_CERTSTATUS */; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTSTATUS) typedef STACK_OF(OSSL_CMP_CERTSTATUS) OSSL_CMP_CERTCONFIRMCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTCONFIRMCONTENT) /*- * CertResponse ::= SEQUENCE { * certReqId INTEGER, * -- to match this response with corresponding request (a value * -- of -1 is to be used if certReqId is not specified in the * -- corresponding request) * status PKIStatusInfo, * certifiedKeyPair CertifiedKeyPair OPTIONAL, * rspInfo OCTET STRING OPTIONAL * -- analogous to the id-regInfo-utf8Pairs string defined * -- for regInfo in CertReqMsg [CRMF] * } */ struct ossl_cmp_certresponse_st { ASN1_INTEGER *certReqId; OSSL_CMP_PKISI *status; OSSL_CMP_CERTIFIEDKEYPAIR *certifiedKeyPair; ASN1_OCTET_STRING *rspInfo; } /* OSSL_CMP_CERTRESPONSE */; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTRESPONSE) /*- * CertRepMessage ::= SEQUENCE { * caPubs [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate * OPTIONAL, * response SEQUENCE OF CertResponse * } */ struct ossl_cmp_certrepmessage_st { STACK_OF(X509) *caPubs; STACK_OF(OSSL_CMP_CERTRESPONSE) *response; } /* OSSL_CMP_CERTREPMESSAGE */; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTREPMESSAGE) /*- * PollReqContent ::= SEQUENCE OF SEQUENCE { * certReqId INTEGER * } */ typedef struct ossl_cmp_pollreq_st { ASN1_INTEGER *certReqId; } OSSL_CMP_POLLREQ; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREQ) DEFINE_STACK_OF(OSSL_CMP_POLLREQ) typedef STACK_OF(OSSL_CMP_POLLREQ) OSSL_CMP_POLLREQCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREQCONTENT) /*- * PollRepContent ::= SEQUENCE OF SEQUENCE { * certReqId INTEGER, * checkAfter INTEGER, -- time in seconds * reason PKIFreeText OPTIONAL * } */ struct ossl_cmp_pollrep_st { ASN1_INTEGER *certReqId; ASN1_INTEGER *checkAfter; OSSL_CMP_PKIFREETEXT *reason; } /* OSSL_CMP_POLLREP */; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREP) DEFINE_STACK_OF(OSSL_CMP_POLLREP) DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREPCONTENT) /*- * PKIHeader ::= SEQUENCE { * pvno INTEGER { cmp1999(1), cmp2000(2), cmp2021(3) }, * sender GeneralName, * -- identifies the sender * recipient GeneralName, * -- identifies the intended recipient * messageTime [0] GeneralizedTime OPTIONAL, * -- time of production of this message (used when sender * -- believes that the transport will be "suitable"; i.e., * -- that the time will still be meaningful upon receipt) * protectionAlg [1] AlgorithmIdentifier OPTIONAL, * -- algorithm used for calculation of protection bits * senderKID [2] KeyIdentifier OPTIONAL, * recipKID [3] KeyIdentifier OPTIONAL, * -- to identify specific keys used for protection * transactionID [4] OCTET STRING OPTIONAL, * -- identifies the transaction; i.e., this will be the same in * -- corresponding request, response, certConf, and PKIConf * -- messages * senderNonce [5] OCTET STRING OPTIONAL, * recipNonce [6] OCTET STRING OPTIONAL, * -- nonces used to provide replay protection, senderNonce * -- is inserted by the creator of this message; recipNonce * -- is a nonce previously inserted in a related message by * -- the intended recipient of this message * freeText [7] PKIFreeText OPTIONAL, * -- this may be used to indicate context-specific instructions * -- (this field is intended for human consumption) * generalInfo [8] SEQUENCE SIZE (1..MAX) OF * InfoTypeAndValue OPTIONAL * -- this may be used to convey context-specific information * -- (this field not primarily intended for human consumption) * } */ struct ossl_cmp_pkiheader_st { ASN1_INTEGER *pvno; GENERAL_NAME *sender; GENERAL_NAME *recipient; ASN1_GENERALIZEDTIME *messageTime; /* 0 */ X509_ALGOR *protectionAlg; /* 1 */ ASN1_OCTET_STRING *senderKID; /* 2 */ ASN1_OCTET_STRING *recipKID; /* 3 */ ASN1_OCTET_STRING *transactionID; /* 4 */ ASN1_OCTET_STRING *senderNonce; /* 5 */ ASN1_OCTET_STRING *recipNonce; /* 6 */ OSSL_CMP_PKIFREETEXT *freeText; /* 7 */ STACK_OF(OSSL_CMP_ITAV) *generalInfo; /* 8 */ } /* OSSL_CMP_PKIHEADER */; typedef STACK_OF(OSSL_CMP_CHALLENGE) OSSL_CMP_POPODECKEYCHALLCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POPODECKEYCHALLCONTENT) typedef STACK_OF(ASN1_INTEGER) OSSL_CMP_POPODECKEYRESPCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POPODECKEYRESPCONTENT) typedef STACK_OF(OSSL_CMP_REVDETAILS) OSSL_CMP_REVREQCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVREQCONTENT) typedef STACK_OF(X509_CRL) OSSL_CMP_CRLANNCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CRLANNCONTENT) typedef STACK_OF(OSSL_CMP_ITAV) OSSL_CMP_GENMSGCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_GENMSGCONTENT) typedef STACK_OF(OSSL_CMP_ITAV) OSSL_CMP_GENREPCONTENT; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_GENREPCONTENT) /*- * PKIBody ::= CHOICE { -- message-specific body elements * ir [0] CertReqMessages, --Initialization Request * ip [1] CertRepMessage, --Initialization Response * cr [2] CertReqMessages, --Certification Request * cp [3] CertRepMessage, --Certification Response * p10cr [4] CertificationRequest, --imported from [PKCS10] * popdecc [5] POPODecKeyChallContent, --pop Challenge * popdecr [6] POPODecKeyRespContent, --pop Response * kur [7] CertReqMessages, --Key Update Request * kup [8] CertRepMessage, --Key Update Response * krr [9] CertReqMessages, --Key Recovery Request * krp [10] KeyRecRepContent, --Key Recovery Response * rr [11] RevReqContent, --Revocation Request * rp [12] RevRepContent, --Revocation Response * ccr [13] CertReqMessages, --Cross-Cert. Request * ccp [14] CertRepMessage, --Cross-Cert. Response * ckuann [15] CAKeyUpdAnnContent, --CA Key Update Ann. * cann [16] CertAnnContent, --Certificate Ann. * rann [17] RevAnnContent, --Revocation Ann. * crlann [18] CRLAnnContent, --CRL Announcement * pkiconf [19] PKIConfirmContent, --Confirmation * nested [20] NestedMessageContent, --Nested Message * genm [21] GenMsgContent, --General Message * genp [22] GenRepContent, --General Response * error [23] ErrorMsgContent, --Error Message * certConf [24] CertConfirmContent, --Certificate confirm * pollReq [25] PollReqContent, --Polling request * pollRep [26] PollRepContent --Polling response * } */ typedef struct ossl_cmp_pkibody_st { int type; union { OSSL_CRMF_MSGS *ir; /* 0 */ OSSL_CMP_CERTREPMESSAGE *ip; /* 1 */ OSSL_CRMF_MSGS *cr; /* 2 */ OSSL_CMP_CERTREPMESSAGE *cp; /* 3 */ /*- * p10cr [4] CertificationRequest, --imported from [PKCS10] * * PKCS10_CERTIFICATIONREQUEST is effectively X509_REQ * so it is used directly */ X509_REQ *p10cr; /* 4 */ /*- * popdecc [5] POPODecKeyChallContent, --pop Challenge * * POPODecKeyChallContent ::= SEQUENCE OF Challenge */ OSSL_CMP_POPODECKEYCHALLCONTENT *popdecc; /* 5 */ /*- * popdecr [6] POPODecKeyRespContent, --pop Response * * POPODecKeyRespContent ::= SEQUENCE OF INTEGER */ OSSL_CMP_POPODECKEYRESPCONTENT *popdecr; /* 6 */ OSSL_CRMF_MSGS *kur; /* 7 */ OSSL_CMP_CERTREPMESSAGE *kup; /* 8 */ OSSL_CRMF_MSGS *krr; /* 9 */ /*- * krp [10] KeyRecRepContent, --Key Recovery Response */ OSSL_CMP_KEYRECREPCONTENT *krp; /* 10 */ /*- * rr [11] RevReqContent, --Revocation Request */ OSSL_CMP_REVREQCONTENT *rr; /* 11 */ /*- * rp [12] RevRepContent, --Revocation Response */ OSSL_CMP_REVREPCONTENT *rp; /* 12 */ /*- * ccr [13] CertReqMessages, --Cross-Cert. Request */ OSSL_CRMF_MSGS *ccr; /* 13 */ /*- * ccp [14] CertRepMessage, --Cross-Cert. Response */ OSSL_CMP_CERTREPMESSAGE *ccp; /* 14 */ /*- * ckuann [15] CAKeyUpdAnnContent, --CA Key Update Ann. */ OSSL_CMP_CAKEYUPDANNCONTENT *ckuann; /* 15 */ /*- * cann [16] CertAnnContent, --Certificate Ann. * OSSL_CMP_CMPCERTIFICATE is effectively X509 so it is used directly */ X509 *cann; /* 16 */ /*- * rann [17] RevAnnContent, --Revocation Ann. */ OSSL_CMP_REVANNCONTENT *rann; /* 17 */ /*- * crlann [18] CRLAnnContent, --CRL Announcement * CRLAnnContent ::= SEQUENCE OF CertificateList */ OSSL_CMP_CRLANNCONTENT *crlann; /* 18 */ /*- * PKIConfirmContent ::= NULL * pkiconf [19] PKIConfirmContent, --Confirmation * OSSL_CMP_PKICONFIRMCONTENT would be only a typedef of ASN1_NULL * OSSL_CMP_CONFIRMCONTENT *pkiconf; * * NOTE: this should ASN1_NULL according to the RFC * but there might be a struct in it when sent from faulty servers... */ ASN1_TYPE *pkiconf; /* 19 */ /*- * nested [20] NestedMessageContent, --Nested Message * NestedMessageContent ::= PKIMessages */ OSSL_CMP_MSGS *nested; /* 20 */ /*- * genm [21] GenMsgContent, --General Message * GenMsgContent ::= SEQUENCE OF InfoTypeAndValue */ OSSL_CMP_GENMSGCONTENT *genm; /* 21 */ /*- * genp [22] GenRepContent, --General Response * GenRepContent ::= SEQUENCE OF InfoTypeAndValue */ OSSL_CMP_GENREPCONTENT *genp; /* 22 */ /*- * error [23] ErrorMsgContent, --Error Message */ OSSL_CMP_ERRORMSGCONTENT *error; /* 23 */ /*- * certConf [24] CertConfirmContent, --Certificate confirm */ OSSL_CMP_CERTCONFIRMCONTENT *certConf; /* 24 */ /*- * pollReq [25] PollReqContent, --Polling request */ OSSL_CMP_POLLREQCONTENT *pollReq; /* 25 */ /*- * pollRep [26] PollRepContent --Polling response */ OSSL_CMP_POLLREPCONTENT *pollRep; /* 26 */ } value; } OSSL_CMP_PKIBODY; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_PKIBODY) /*- * PKIProtection ::= BIT STRING * * PKIMessages ::= SEQUENCE SIZE (1..MAX) OF PKIMessage * * PKIMessage ::= SEQUENCE { * header PKIHeader, * body PKIBody, * protection [0] PKIProtection OPTIONAL, * extraCerts [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate * OPTIONAL * } */ struct ossl_cmp_msg_st { OSSL_CMP_PKIHEADER *header; OSSL_CMP_PKIBODY *body; ASN1_BIT_STRING *protection; /* 0 */ /* OSSL_CMP_CMPCERTIFICATE is effectively X509 so it is used directly */ STACK_OF(X509) *extraCerts; /* 1 */ OSSL_LIB_CTX *libctx; char *propq; } /* OSSL_CMP_MSG */; OSSL_CMP_MSG *OSSL_CMP_MSG_new(OSSL_LIB_CTX *libctx, const char *propq); void OSSL_CMP_MSG_free(OSSL_CMP_MSG *msg); /*- * ProtectedPart ::= SEQUENCE { * header PKIHeader, * body PKIBody * } */ typedef struct ossl_cmp_protectedpart_st { OSSL_CMP_PKIHEADER *header; OSSL_CMP_PKIBODY *body; } OSSL_CMP_PROTECTEDPART; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_PROTECTEDPART) /*- * this is not defined here as it is already in CRMF: * id-PasswordBasedMac OBJECT IDENTIFIER ::= {1 2 840 113533 7 66 13} * PBMParameter ::= SEQUENCE { * salt OCTET STRING, * -- note: implementations MAY wish to limit acceptable sizes * -- of this string to values appropriate for their environment * -- in order to reduce the risk of denial-of-service attacks * owf AlgorithmIdentifier, * -- AlgId for a One-Way Function (SHA-1 recommended) * iterationCount INTEGER, * -- number of times the OWF is applied * -- note: implementations MAY wish to limit acceptable sizes * -- of this integer to values appropriate for their environment * -- in order to reduce the risk of denial-of-service attacks * mac AlgorithmIdentifier * -- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11], * } -- or HMAC [RFC2104, RFC2202]) */ /*- * Not supported: * id-DHBasedMac OBJECT IDENTIFIER ::= {1 2 840 113533 7 66 30} * DHBMParameter ::= SEQUENCE { * owf AlgorithmIdentifier, * -- AlgId for a One-Way Function (SHA-1 recommended) * mac AlgorithmIdentifier * -- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11], * } -- or HMAC [RFC2104, RFC2202]) */ /*- * The following is not cared for, because it is described in section 5.2.5 * that this is beyond the scope of CMP * OOBCert ::= CMPCertificate * * OOBCertHash ::= SEQUENCE { * hashAlg [0] AlgorithmIdentifier OPTIONAL, * certId [1] CertId OPTIONAL, * hashVal BIT STRING * -- hashVal is calculated over the DER encoding of the * -- self-signed certificate with the identifier certID. * } */ /* * RootCaKeyUpdateContent ::= SEQUENCE { * newWithNew CMPCertificate, * newWithOld [0] CMPCertificate OPTIONAL, * oldWithNew [1] CMPCertificate OPTIONAL * } */ struct ossl_cmp_rootcakeyupdate_st { X509 *newWithNew; X509 *newWithOld; X509 *oldWithNew; } /* OSSL_CMP_ROOTCAKEYUPDATE */; DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ROOTCAKEYUPDATE) /* from cmp_asn.c */ int ossl_cmp_asn1_get_int(const ASN1_INTEGER *a); /* from cmp_util.c */ const char *ossl_cmp_log_parse_metadata(const char *buf, OSSL_CMP_severity *level, char **func, char **file, int *line); # define ossl_cmp_add_error_data(txt) ERR_add_error_txt(" : ", txt) # define ossl_cmp_add_error_line(txt) ERR_add_error_txt("\n", txt) /* The two functions manipulating X509_STORE could be generally useful */ int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs, int only_self_issued); STACK_OF(X509) *ossl_cmp_X509_STORE_get1_certs(X509_STORE *store); int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk, const char *text, int len); int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt, const ASN1_OCTET_STRING *src); int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt, const unsigned char *bytes, int len); /* from cmp_ctx.c */ int ossl_cmp_print_log(OSSL_CMP_severity level, const OSSL_CMP_CTX *ctx, const char *func, const char *file, int line, const char *level_str, const char *format, ...); # define ossl_cmp_log(level, ctx, msg) \ ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \ OPENSSL_LINE, #level, "%s", msg) # define ossl_cmp_log1(level, ctx, fmt, arg1) \ ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \ OPENSSL_LINE, #level, fmt, arg1) # define ossl_cmp_log2(level, ctx, fmt, arg1, arg2) \ ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \ OPENSSL_LINE, #level, fmt, arg1, arg2) # define ossl_cmp_log3(level, ctx, fmt, arg1, arg2, arg3) \ ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \ OPENSSL_LINE, #level, fmt, arg1, arg2, arg3) # define ossl_cmp_log4(level, ctx, fmt, arg1, arg2, arg3, arg4) \ ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \ OPENSSL_LINE, #level, fmt, arg1, arg2, arg3, arg4) # define OSSL_CMP_LOG_ERROR OSSL_CMP_LOG_ERR # define OSSL_CMP_LOG_WARN OSSL_CMP_LOG_WARNING # define ossl_cmp_alert(ctx, msg) ossl_cmp_log(ALERT, ctx, msg) # define ossl_cmp_err(ctx, msg) ossl_cmp_log(ERROR, ctx, msg) # define ossl_cmp_warn(ctx, msg) ossl_cmp_log(WARN, ctx, msg) # define ossl_cmp_info(ctx, msg) ossl_cmp_log(INFO, ctx, msg) # define ossl_cmp_debug(ctx, msg) ossl_cmp_log(DEBUG, ctx, msg) # define ossl_cmp_trace(ctx, msg) ossl_cmp_log(TRACE, ctx, msg) int ossl_cmp_ctx_set1_validatedSrvCert(OSSL_CMP_CTX *ctx, X509 *cert); int ossl_cmp_ctx_set_status(OSSL_CMP_CTX *ctx, int status); int ossl_cmp_ctx_set0_statusString(OSSL_CMP_CTX *ctx, OSSL_CMP_PKIFREETEXT *text); int ossl_cmp_ctx_set_failInfoCode(OSSL_CMP_CTX *ctx, int fail_info); int ossl_cmp_ctx_set0_newCert(OSSL_CMP_CTX *ctx, X509 *cert); int ossl_cmp_ctx_set1_newChain(OSSL_CMP_CTX *ctx, STACK_OF(X509) *newChain); int ossl_cmp_ctx_set1_caPubs(OSSL_CMP_CTX *ctx, STACK_OF(X509) *caPubs); int ossl_cmp_ctx_set1_extraCertsIn(OSSL_CMP_CTX *ctx, STACK_OF(X509) *extraCertsIn); int ossl_cmp_ctx_set1_recipNonce(OSSL_CMP_CTX *ctx, const ASN1_OCTET_STRING *nonce); EVP_PKEY *ossl_cmp_ctx_get0_newPubkey(const OSSL_CMP_CTX *ctx); /* from cmp_status.c */ int ossl_cmp_pkisi_get_status(const OSSL_CMP_PKISI *si); const char *ossl_cmp_PKIStatus_to_string(int status); OSSL_CMP_PKIFREETEXT *ossl_cmp_pkisi_get0_statusString(const OSSL_CMP_PKISI *s); int ossl_cmp_pkisi_get_pkifailureinfo(const OSSL_CMP_PKISI *si); int ossl_cmp_pkisi_check_pkifailureinfo(const OSSL_CMP_PKISI *si, int index); /* from cmp_hdr.c */ int ossl_cmp_hdr_set_pvno(OSSL_CMP_PKIHEADER *hdr, int pvno); int ossl_cmp_hdr_get_pvno(const OSSL_CMP_PKIHEADER *hdr); int ossl_cmp_hdr_get_protection_nid(const OSSL_CMP_PKIHEADER *hdr); ASN1_OCTET_STRING *ossl_cmp_hdr_get0_senderNonce(const OSSL_CMP_PKIHEADER *hdr); int ossl_cmp_general_name_is_NULL_DN(GENERAL_NAME *name); int ossl_cmp_hdr_set1_sender(OSSL_CMP_PKIHEADER *hdr, const X509_NAME *nm); int ossl_cmp_hdr_set1_recipient(OSSL_CMP_PKIHEADER *hdr, const X509_NAME *nm); int ossl_cmp_hdr_update_messageTime(OSSL_CMP_PKIHEADER *hdr); int ossl_cmp_hdr_set1_senderKID(OSSL_CMP_PKIHEADER *hdr, const ASN1_OCTET_STRING *senderKID); int ossl_cmp_hdr_push0_freeText(OSSL_CMP_PKIHEADER *hdr, ASN1_UTF8STRING *text); int ossl_cmp_hdr_push1_freeText(OSSL_CMP_PKIHEADER *hdr, ASN1_UTF8STRING *text); int ossl_cmp_hdr_generalInfo_push0_item(OSSL_CMP_PKIHEADER *hdr, OSSL_CMP_ITAV *itav); int ossl_cmp_hdr_generalInfo_push1_items(OSSL_CMP_PKIHEADER *hdr, const STACK_OF(OSSL_CMP_ITAV) *itavs); int ossl_cmp_hdr_set_implicitConfirm(OSSL_CMP_PKIHEADER *hdr); int ossl_cmp_hdr_has_implicitConfirm(const OSSL_CMP_PKIHEADER *hdr); # define OSSL_CMP_TRANSACTIONID_LENGTH 16 # define OSSL_CMP_SENDERNONCE_LENGTH 16 int ossl_cmp_hdr_set_transactionID(OSSL_CMP_CTX *ctx, OSSL_CMP_PKIHEADER *hdr); int ossl_cmp_hdr_init(OSSL_CMP_CTX *ctx, OSSL_CMP_PKIHEADER *hdr); /* from cmp_msg.c */ /* OSSL_CMP_MSG bodytype ASN.1 choice IDs */ # define OSSL_CMP_PKIBODY_IR 0 # define OSSL_CMP_PKIBODY_IP 1 # define OSSL_CMP_PKIBODY_CR 2 # define OSSL_CMP_PKIBODY_CP 3 # define OSSL_CMP_PKIBODY_P10CR 4 # define OSSL_CMP_PKIBODY_POPDECC 5 # define OSSL_CMP_PKIBODY_POPDECR 6 # define OSSL_CMP_PKIBODY_KUR 7 # define OSSL_CMP_PKIBODY_KUP 8 # define OSSL_CMP_PKIBODY_KRR 9 # define OSSL_CMP_PKIBODY_KRP 10 # define OSSL_CMP_PKIBODY_RR 11 # define OSSL_CMP_PKIBODY_RP 12 # define OSSL_CMP_PKIBODY_CCR 13 # define OSSL_CMP_PKIBODY_CCP 14 # define OSSL_CMP_PKIBODY_CKUANN 15 # define OSSL_CMP_PKIBODY_CANN 16 # define OSSL_CMP_PKIBODY_RANN 17 # define OSSL_CMP_PKIBODY_CRLANN 18 # define OSSL_CMP_PKIBODY_PKICONF 19 # define OSSL_CMP_PKIBODY_NESTED 20 # define OSSL_CMP_PKIBODY_GENM 21 # define OSSL_CMP_PKIBODY_GENP 22 # define OSSL_CMP_PKIBODY_ERROR 23 # define OSSL_CMP_PKIBODY_CERTCONF 24 # define OSSL_CMP_PKIBODY_POLLREQ 25 # define OSSL_CMP_PKIBODY_POLLREP 26 # define OSSL_CMP_PKIBODY_TYPE_MAX OSSL_CMP_PKIBODY_POLLREP /* certReqId for the first - and so far only - certificate request */ # define OSSL_CMP_CERTREQID 0 # define OSSL_CMP_CERTREQID_NONE -1 # define OSSL_CMP_CERTREQID_INVALID -2 /* sequence id for the first - and so far only - revocation request */ # define OSSL_CMP_REVREQSID 0 int ossl_cmp_msg_set0_libctx(OSSL_CMP_MSG *msg, OSSL_LIB_CTX *libctx, const char *propq); const char *ossl_cmp_bodytype_to_string(int type); int ossl_cmp_msg_set_bodytype(OSSL_CMP_MSG *msg, int type); OSSL_CMP_MSG *ossl_cmp_msg_create(OSSL_CMP_CTX *ctx, int bodytype); OSSL_CMP_MSG *ossl_cmp_certreq_new(OSSL_CMP_CTX *ctx, int bodytype, const OSSL_CRMF_MSG *crm); OSSL_CMP_MSG *ossl_cmp_certrep_new(OSSL_CMP_CTX *ctx, int bodytype, int certReqId, const OSSL_CMP_PKISI *si, X509 *cert, const X509 *encryption_recip, STACK_OF(X509) *chain, STACK_OF(X509) *caPubs, int unprotectedErrors); OSSL_CMP_MSG *ossl_cmp_rr_new(OSSL_CMP_CTX *ctx); OSSL_CMP_MSG *ossl_cmp_rp_new(OSSL_CMP_CTX *ctx, const OSSL_CMP_PKISI *si, const OSSL_CRMF_CERTID *cid, int unprotectedErrors); OSSL_CMP_MSG *ossl_cmp_pkiconf_new(OSSL_CMP_CTX *ctx); OSSL_CMP_MSG *ossl_cmp_pollRep_new(OSSL_CMP_CTX *ctx, int crid, int64_t poll_after); int ossl_cmp_msg_gen_push0_ITAV(OSSL_CMP_MSG *msg, OSSL_CMP_ITAV *itav); int ossl_cmp_msg_gen_push1_ITAVs(OSSL_CMP_MSG *msg, const STACK_OF(OSSL_CMP_ITAV) *itavs); OSSL_CMP_MSG *ossl_cmp_genm_new(OSSL_CMP_CTX *ctx); OSSL_CMP_MSG *ossl_cmp_genp_new(OSSL_CMP_CTX *ctx, const STACK_OF(OSSL_CMP_ITAV) *itavs); OSSL_CMP_MSG *ossl_cmp_error_new(OSSL_CMP_CTX *ctx, const OSSL_CMP_PKISI *si, int64_t errorCode, const char *details, int unprotected); int ossl_cmp_certstatus_set0_certHash(OSSL_CMP_CERTSTATUS *certStatus, ASN1_OCTET_STRING *hash); OSSL_CMP_MSG *ossl_cmp_certConf_new(OSSL_CMP_CTX *ctx, int certReqId, int fail_info, const char *text); OSSL_CMP_MSG *ossl_cmp_pollReq_new(OSSL_CMP_CTX *ctx, int crid); OSSL_CMP_MSG *ossl_cmp_pollRep_new(OSSL_CMP_CTX *ctx, int crid, int64_t poll_after); OSSL_CMP_PKISI * ossl_cmp_revrepcontent_get_pkisi(OSSL_CMP_REVREPCONTENT *rrep, int rsid); OSSL_CRMF_CERTID *ossl_cmp_revrepcontent_get_CertId(OSSL_CMP_REVREPCONTENT *rc, int rsid); OSSL_CMP_POLLREP * ossl_cmp_pollrepcontent_get0_pollrep(const OSSL_CMP_POLLREPCONTENT *prc, int rid); OSSL_CMP_CERTRESPONSE * ossl_cmp_certrepmessage_get0_certresponse(const OSSL_CMP_CERTREPMESSAGE *crm, int rid); X509 *ossl_cmp_certresponse_get1_cert(const OSSL_CMP_CTX *ctx, const OSSL_CMP_CERTRESPONSE *crep); OSSL_CMP_MSG *ossl_cmp_msg_load(const char *file); /* from cmp_protect.c */ int ossl_cmp_msg_add_extraCerts(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg); ASN1_BIT_STRING *ossl_cmp_calc_protection(const OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg); int ossl_cmp_msg_protect(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg); /* from cmp_vfy.c */ typedef int (*ossl_cmp_allow_unprotected_cb_t)(const OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg, int invalid_protection, int arg); int ossl_cmp_msg_check_update(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg, ossl_cmp_allow_unprotected_cb_t cb, int cb_arg); int ossl_cmp_msg_check_received(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg, ossl_cmp_allow_unprotected_cb_t cb, int cb_arg); int ossl_cmp_verify_popo(const OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg, int accept_RAVerified); /* from cmp_client.c */ int ossl_cmp_exchange_certConf(OSSL_CMP_CTX *ctx, int certReqId, int fail_info, const char *txt); int ossl_cmp_exchange_error(OSSL_CMP_CTX *ctx, int status, int fail_info, const char *txt, int errorCode, const char *detail); #endif /* !defined(OSSL_CRYPTO_CMP_LOCAL_H) */