]> git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/cmp/cmp_local.h
Copyright year updates
[thirdparty/openssl.git] / crypto / cmp / cmp_local.h
1 /*
2 * Copyright 2007-2024 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
5 *
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
10 */
11
12 #ifndef OSSL_CRYPTO_CMP_LOCAL_H
13 # define OSSL_CRYPTO_CMP_LOCAL_H
14
15 # include "internal/cryptlib.h"
16
17 # include <openssl/cmp.h>
18 # include <openssl/err.h>
19
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>
26 # include "crypto/x509.h"
27
28 # define IS_NULL_DN(name) (X509_NAME_get_entry(name, 0) == NULL)
29
30 /*
31 * this structure is used to store the context for CMP sessions
32 */
33 struct ossl_cmp_ctx_st {
34 OSSL_LIB_CTX *libctx;
35 char *propq;
36 OSSL_CMP_log_cb_t log_cb; /* log callback for error/debug/etc. output */
37 OSSL_CMP_severity log_verbosity; /* level of verbosity of log output */
38
39 /* message transfer */
40 OSSL_CMP_transfer_cb_t transfer_cb; /* default: OSSL_CMP_MSG_http_perform */
41 void *transfer_cb_arg; /* allows to store optional argument to cb */
42 /* HTTP-based transfer */
43 OSSL_HTTP_REQ_CTX *http_ctx;
44 char *serverPath;
45 char *server;
46 int serverPort;
47 char *proxy;
48 char *no_proxy;
49 int keep_alive; /* persistent connection: 0=no, 1=prefer, 2=require */
50 int msg_timeout; /* max seconds to wait for each CMP message round trip */
51 int total_timeout; /* max number of seconds an enrollment may take, incl. */
52 int tls_used; /* whether to use TLS for client-side HTTP connections */
53 /* attempts polling for a response if a 'waiting' PKIStatus is received */
54 time_t end_time; /* session start time + totaltimeout */
55 # ifndef OPENSSL_NO_HTTP
56 OSSL_HTTP_bio_cb_t http_cb;
57 void *http_cb_arg; /* allows to store optional argument to cb */
58 # endif
59
60 /* server authentication */
61 /*
62 * unprotectedErrors may be set as workaround for broken server responses:
63 * accept missing or invalid protection of regular error messages, negative
64 * certificate responses (ip/cp/kup), revocation responses (rp), and PKIConf
65 */
66 int unprotectedErrors;
67 int noCacheExtraCerts;
68 X509 *srvCert; /* certificate used to identify the server */
69 X509 *validatedSrvCert; /* caches any already validated server cert */
70 X509_NAME *expected_sender; /* expected sender in header of response */
71 X509_STORE *trusted; /* trust store maybe w CRLs and cert verify callback */
72 STACK_OF(X509) *untrusted; /* untrusted (intermediate CA) certs */
73 int ignore_keyusage; /* ignore key usage entry when validating certs */
74 /*
75 * permitTAInExtraCertsForIR allows use of root certs in extracerts
76 * when validating message protection; this is used for 3GPP-style E.7
77 */
78 int permitTAInExtraCertsForIR;
79
80 /* client authentication */
81 int unprotectedSend; /* send unprotected PKI messages */
82 X509 *cert; /* protection cert used to identify and sign for MSG_SIG_ALG */
83 STACK_OF(X509) *chain; /* (cached) chain of protection cert including it */
84 EVP_PKEY *pkey; /* the key pair corresponding to cert */
85 ASN1_OCTET_STRING *referenceValue; /* optional username for MSG_MAC_ALG */
86 ASN1_OCTET_STRING *secretValue; /* password/shared secret for MSG_MAC_ALG */
87 /* PBMParameters for MSG_MAC_ALG */
88 size_t pbm_slen; /* salt length, currently fixed to 16 */
89 EVP_MD *pbm_owf; /* one-way function (OWF), default: SHA256 */
90 int pbm_itercnt; /* OWF iteration count, currently fixed to 500 */
91 int pbm_mac; /* NID of MAC algorithm, default: HMAC-SHA1 as per RFC 4210 */
92
93 /* CMP message header and extra certificates */
94 X509_NAME *recipient; /* to set in recipient in pkiheader */
95 EVP_MD *digest; /* digest used in MSG_SIG_ALG and POPO, default SHA256 */
96 ASN1_OCTET_STRING *transactionID; /* the current transaction ID */
97 ASN1_OCTET_STRING *senderNonce; /* last nonce sent */
98 ASN1_OCTET_STRING *recipNonce; /* last nonce received */
99 ASN1_OCTET_STRING *first_senderNonce; /* sender nonce when starting to poll */
100 ASN1_UTF8STRING *freeText; /* optional string to include each msg */
101 STACK_OF(OSSL_CMP_ITAV) *geninfo_ITAVs;
102 int implicitConfirm; /* set implicitConfirm in IR/KUR/CR messages */
103 int disableConfirm; /* disable certConf in IR/KUR/CR for broken servers */
104 STACK_OF(X509) *extraCertsOut; /* to be included in request messages */
105
106 /* certificate template */
107 EVP_PKEY *newPkey; /* explicit new private/public key for cert enrollment */
108 int newPkey_priv; /* flag indicating if newPkey contains private key */
109 X509_NAME *issuer; /* issuer name to used in cert template, also in rr */
110 ASN1_INTEGER *serialNumber; /* certificate serial number to use in rr */
111 int days; /* Number of days new certificates are asked to be valid for */
112 X509_NAME *subjectName; /* subject name to be used in cert template */
113 STACK_OF(GENERAL_NAME) *subjectAltNames; /* to add to the cert template */
114 int SubjectAltName_nodefault;
115 int setSubjectAltNameCritical;
116 X509_EXTENSIONS *reqExtensions; /* exts to be added to cert template */
117 CERTIFICATEPOLICIES *policies; /* policies to be included in extensions */
118 int setPoliciesCritical;
119 int popoMethod; /* Proof-of-possession mechanism; default: signature */
120 X509 *oldCert; /* cert to be updated (via KUR) or to be revoked (via RR) */
121 X509_REQ *p10CSR; /* for P10CR: PKCS#10 CSR to be sent */
122
123 /* misc body contents */
124 int revocationReason; /* revocation reason code to be included in RR */
125 STACK_OF(OSSL_CMP_ITAV) *genm_ITAVs; /* content of general message */
126
127 /* result returned in responses, so far supporting only one certResponse */
128 int status; /* PKIStatus of last received IP/CP/KUP/RP/error or -1 */
129 OSSL_CMP_PKIFREETEXT *statusString; /* of last IP/CP/KUP/RP/error */
130 int failInfoCode; /* failInfoCode of last received IP/CP/KUP/error, or -1 */
131 X509 *newCert; /* newly enrolled cert received from the CA */
132 STACK_OF(X509) *newChain; /* chain of newly enrolled cert received */
133 STACK_OF(X509) *caPubs; /* CA certs received from server (in IP message) */
134 STACK_OF(X509) *extraCertsIn; /* extraCerts received from server */
135
136 /* certificate confirmation */
137 OSSL_CMP_certConf_cb_t certConf_cb; /* callback for app checking new cert */
138 void *certConf_cb_arg; /* allows to store an argument individual to cb */
139 } /* OSSL_CMP_CTX */;
140
141 /*
142 * ##########################################################################
143 * ASN.1 DECLARATIONS
144 * ##########################################################################
145 */
146
147 /*-
148 * RevAnnContent ::= SEQUENCE {
149 * status PKIStatus,
150 * certId CertId,
151 * willBeRevokedAt GeneralizedTime,
152 * badSinceDate GeneralizedTime,
153 * crlDetails Extensions OPTIONAL
154 * -- extra CRL details (e.g., crl number, reason, location, etc.)
155 * }
156 */
157 typedef struct ossl_cmp_revanncontent_st {
158 ASN1_INTEGER *status;
159 OSSL_CRMF_CERTID *certId;
160 ASN1_GENERALIZEDTIME *willBeRevokedAt;
161 ASN1_GENERALIZEDTIME *badSinceDate;
162 X509_EXTENSIONS *crlDetails;
163 } OSSL_CMP_REVANNCONTENT;
164 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVANNCONTENT)
165
166 /*-
167 * Challenge ::= SEQUENCE {
168 * owf AlgorithmIdentifier OPTIONAL,
169 *
170 * -- MUST be present in the first Challenge; MAY be omitted in
171 * -- any subsequent Challenge in POPODecKeyChallContent (if
172 * -- omitted, then the owf used in the immediately preceding
173 * -- Challenge is to be used).
174 *
175 * witness OCTET STRING,
176 * -- the result of applying the one-way function (owf) to a
177 * -- randomly-generated INTEGER, A. [Note that a different
178 * -- INTEGER MUST be used for each Challenge.]
179 * challenge OCTET STRING
180 * -- the encryption (under the public key for which the cert.
181 * -- request is being made) of Rand, where Rand is specified as
182 * -- Rand ::= SEQUENCE {
183 * -- int INTEGER,
184 * -- - the randomly-generated INTEGER A (above)
185 * -- sender GeneralName
186 * -- - the sender's name (as included in PKIHeader)
187 * -- }
188 * }
189 */
190 typedef struct ossl_cmp_challenge_st {
191 X509_ALGOR *owf;
192 ASN1_OCTET_STRING *witness;
193 ASN1_OCTET_STRING *challenge;
194 } OSSL_CMP_CHALLENGE;
195 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CHALLENGE)
196
197 /*-
198 * CAKeyUpdAnnContent ::= SEQUENCE {
199 * oldWithNew Certificate,
200 * newWithOld Certificate,
201 * newWithNew Certificate
202 * }
203 */
204 typedef struct ossl_cmp_cakeyupdanncontent_st {
205 X509 *oldWithNew;
206 X509 *newWithOld;
207 X509 *newWithNew;
208 } OSSL_CMP_CAKEYUPDANNCONTENT;
209 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CAKEYUPDANNCONTENT)
210
211 typedef struct ossl_cmp_rootcakeyupdate_st OSSL_CMP_ROOTCAKEYUPDATE;
212 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ROOTCAKEYUPDATE)
213
214 /*-
215 * declared already here as it will be used in OSSL_CMP_MSG (nested) and
216 * infoType and infoValue
217 */
218 typedef STACK_OF(OSSL_CMP_MSG) OSSL_CMP_MSGS;
219 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_MSGS)
220
221 /*-
222 * InfoTypeAndValue ::= SEQUENCE {
223 * infoType OBJECT IDENTIFIER,
224 * infoValue ANY DEFINED BY infoType OPTIONAL
225 * }
226 */
227 struct ossl_cmp_itav_st {
228 ASN1_OBJECT *infoType;
229 union {
230 char *ptr;
231 /* NID_id_it_caProtEncCert - CA Protocol Encryption Certificate */
232 X509 *caProtEncCert;
233 /* NID_id_it_signKeyPairTypes - Signing Key Pair Types */
234 STACK_OF(X509_ALGOR) *signKeyPairTypes;
235 /* NID_id_it_encKeyPairTypes - Encryption/Key Agreement Key Pair Types */
236 STACK_OF(X509_ALGOR) *encKeyPairTypes;
237 /* NID_id_it_preferredSymmAlg - Preferred Symmetric Algorithm */
238 X509_ALGOR *preferredSymmAlg;
239 /* NID_id_it_caKeyUpdateInfo - Updated CA Key Pair */
240 OSSL_CMP_CAKEYUPDANNCONTENT *caKeyUpdateInfo;
241 /* NID_id_it_currentCRL - CRL */
242 X509_CRL *currentCRL;
243 /* NID_id_it_unsupportedOIDs - Unsupported Object Identifiers */
244 STACK_OF(ASN1_OBJECT) *unsupportedOIDs;
245 /* NID_id_it_keyPairParamReq - Key Pair Parameters Request */
246 ASN1_OBJECT *keyPairParamReq;
247 /* NID_id_it_keyPairParamRep - Key Pair Parameters Response */
248 X509_ALGOR *keyPairParamRep;
249 /* NID_id_it_revPassphrase - Revocation Passphrase */
250 OSSL_CRMF_ENCRYPTEDVALUE *revPassphrase;
251 /* NID_id_it_implicitConfirm - ImplicitConfirm */
252 ASN1_NULL *implicitConfirm;
253 /* NID_id_it_confirmWaitTime - ConfirmWaitTime */
254 ASN1_GENERALIZEDTIME *confirmWaitTime;
255 /* NID_id_it_origPKIMessage - origPKIMessage */
256 OSSL_CMP_MSGS *origPKIMessage;
257 /* NID_id_it_suppLangTags - Supported Language Tags */
258 STACK_OF(ASN1_UTF8STRING) *suppLangTagsValue;
259 /* NID_id_it_certProfile - Certificate Profile */
260 STACK_OF(ASN1_UTF8STRING) *certProfile;
261 /* NID_id_it_caCerts - CA Certificates */
262 STACK_OF(X509) *caCerts;
263 /* NID_id_it_rootCaCert - Root CA Certificate */
264 X509 *rootCaCert;
265 /* NID_id_it_rootCaKeyUpdate - Root CA Certificate Update */
266 OSSL_CMP_ROOTCAKEYUPDATE *rootCaKeyUpdate;
267 /* this is to be used for so far undeclared objects */
268 ASN1_TYPE *other;
269 } infoValue;
270 } /* OSSL_CMP_ITAV */;
271 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ITAV)
272
273 typedef struct ossl_cmp_certorenccert_st {
274 int type;
275 union {
276 X509 *certificate;
277 OSSL_CRMF_ENCRYPTEDVALUE *encryptedCert;
278 } value;
279 } OSSL_CMP_CERTORENCCERT;
280 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTORENCCERT)
281
282 /*-
283 * CertifiedKeyPair ::= SEQUENCE {
284 * certOrEncCert CertOrEncCert,
285 * privateKey [0] EncryptedValue OPTIONAL,
286 * -- see [CRMF] for comment on encoding
287 * publicationInfo [1] PKIPublicationInfo OPTIONAL
288 * }
289 */
290 typedef struct ossl_cmp_certifiedkeypair_st {
291 OSSL_CMP_CERTORENCCERT *certOrEncCert;
292 OSSL_CRMF_ENCRYPTEDVALUE *privateKey;
293 OSSL_CRMF_PKIPUBLICATIONINFO *publicationInfo;
294 } OSSL_CMP_CERTIFIEDKEYPAIR;
295 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTIFIEDKEYPAIR)
296
297 /*-
298 * PKIStatusInfo ::= SEQUENCE {
299 * status PKIStatus,
300 * statusString PKIFreeText OPTIONAL,
301 * failInfo PKIFailureInfo OPTIONAL
302 * }
303 */
304 struct ossl_cmp_pkisi_st {
305 OSSL_CMP_PKISTATUS *status;
306 OSSL_CMP_PKIFREETEXT *statusString;
307 OSSL_CMP_PKIFAILUREINFO *failInfo;
308 } /* OSSL_CMP_PKISI */;
309
310 /*-
311 * RevReqContent ::= SEQUENCE OF RevDetails
312 *
313 * RevDetails ::= SEQUENCE {
314 * certDetails CertTemplate,
315 * crlEntryDetails Extensions OPTIONAL
316 * }
317 */
318 struct ossl_cmp_revdetails_st {
319 OSSL_CRMF_CERTTEMPLATE *certDetails;
320 X509_EXTENSIONS *crlEntryDetails;
321 } /* OSSL_CMP_REVDETAILS */;
322 typedef struct ossl_cmp_revdetails_st OSSL_CMP_REVDETAILS;
323 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVDETAILS)
324 DEFINE_STACK_OF(OSSL_CMP_REVDETAILS)
325
326 /*-
327 * RevRepContent ::= SEQUENCE {
328 * status SEQUENCE SIZE (1..MAX) OF PKIStatusInfo,
329 * -- in same order as was sent in RevReqContent
330 * revCerts [0] SEQUENCE SIZE (1..MAX) OF CertId
331 * OPTIONAL,
332 * -- IDs for which revocation was requested
333 * -- (same order as status)
334 * crls [1] SEQUENCE SIZE (1..MAX) OF CertificateList
335 * OPTIONAL
336 * -- the resulting CRLs (there may be more than one)
337 * }
338 */
339 struct ossl_cmp_revrepcontent_st {
340 STACK_OF(OSSL_CMP_PKISI) *status;
341 STACK_OF(OSSL_CRMF_CERTID) *revCerts;
342 STACK_OF(X509_CRL) *crls;
343 } /* OSSL_CMP_REVREPCONTENT */;
344 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVREPCONTENT)
345
346 /*-
347 * KeyRecRepContent ::= SEQUENCE {
348 * status PKIStatusInfo,
349 * newSigCert [0] Certificate OPTIONAL,
350 * caCerts [1] SEQUENCE SIZE (1..MAX) OF
351 * Certificate OPTIONAL,
352 * keyPairHist [2] SEQUENCE SIZE (1..MAX) OF
353 * CertifiedKeyPair OPTIONAL
354 * }
355 */
356 typedef struct ossl_cmp_keyrecrepcontent_st {
357 OSSL_CMP_PKISI *status;
358 X509 *newSigCert;
359 STACK_OF(X509) *caCerts;
360 STACK_OF(OSSL_CMP_CERTIFIEDKEYPAIR) *keyPairHist;
361 } OSSL_CMP_KEYRECREPCONTENT;
362 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_KEYRECREPCONTENT)
363
364 /*-
365 * ErrorMsgContent ::= SEQUENCE {
366 * pKIStatusInfo PKIStatusInfo,
367 * errorCode INTEGER OPTIONAL,
368 * -- implementation-specific error codes
369 * errorDetails PKIFreeText OPTIONAL
370 * -- implementation-specific error details
371 * }
372 */
373 typedef struct ossl_cmp_errormsgcontent_st {
374 OSSL_CMP_PKISI *pKIStatusInfo;
375 ASN1_INTEGER *errorCode;
376 OSSL_CMP_PKIFREETEXT *errorDetails;
377 } OSSL_CMP_ERRORMSGCONTENT;
378 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ERRORMSGCONTENT)
379
380 /*-
381 * CertConfirmContent ::= SEQUENCE OF CertStatus
382 *
383 * CertStatus ::= SEQUENCE {
384 * certHash OCTET STRING,
385 * -- the hash of the certificate, using the same hash algorithm
386 * -- as is used to create and verify the certificate signature
387 * certReqId INTEGER,
388 * -- to match this confirmation with the corresponding req/rep
389 * statusInfo PKIStatusInfo OPTIONAL,
390 * hashAlg [0] AlgorithmIdentifier OPTIONAL
391 * }
392 */
393 struct ossl_cmp_certstatus_st {
394 ASN1_OCTET_STRING *certHash;
395 ASN1_INTEGER *certReqId;
396 OSSL_CMP_PKISI *statusInfo;
397 X509_ALGOR *hashAlg; /* 0 */
398 } /* OSSL_CMP_CERTSTATUS */;
399 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTSTATUS)
400 typedef STACK_OF(OSSL_CMP_CERTSTATUS) OSSL_CMP_CERTCONFIRMCONTENT;
401 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTCONFIRMCONTENT)
402
403 /*-
404 * CertResponse ::= SEQUENCE {
405 * certReqId INTEGER,
406 * -- to match this response with corresponding request (a value
407 * -- of -1 is to be used if certReqId is not specified in the
408 * -- corresponding request)
409 * status PKIStatusInfo,
410 * certifiedKeyPair CertifiedKeyPair OPTIONAL,
411 * rspInfo OCTET STRING OPTIONAL
412 * -- analogous to the id-regInfo-utf8Pairs string defined
413 * -- for regInfo in CertReqMsg [CRMF]
414 * }
415 */
416 struct ossl_cmp_certresponse_st {
417 ASN1_INTEGER *certReqId;
418 OSSL_CMP_PKISI *status;
419 OSSL_CMP_CERTIFIEDKEYPAIR *certifiedKeyPair;
420 ASN1_OCTET_STRING *rspInfo;
421 } /* OSSL_CMP_CERTRESPONSE */;
422 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTRESPONSE)
423
424 /*-
425 * CertRepMessage ::= SEQUENCE {
426 * caPubs [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
427 * OPTIONAL,
428 * response SEQUENCE OF CertResponse
429 * }
430 */
431 struct ossl_cmp_certrepmessage_st {
432 STACK_OF(X509) *caPubs;
433 STACK_OF(OSSL_CMP_CERTRESPONSE) *response;
434 } /* OSSL_CMP_CERTREPMESSAGE */;
435 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CERTREPMESSAGE)
436
437 /*-
438 * PollReqContent ::= SEQUENCE OF SEQUENCE {
439 * certReqId INTEGER
440 * }
441 */
442 typedef struct ossl_cmp_pollreq_st {
443 ASN1_INTEGER *certReqId;
444 } OSSL_CMP_POLLREQ;
445 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREQ)
446 DEFINE_STACK_OF(OSSL_CMP_POLLREQ)
447 typedef STACK_OF(OSSL_CMP_POLLREQ) OSSL_CMP_POLLREQCONTENT;
448 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREQCONTENT)
449
450 /*-
451 * PollRepContent ::= SEQUENCE OF SEQUENCE {
452 * certReqId INTEGER,
453 * checkAfter INTEGER, -- time in seconds
454 * reason PKIFreeText OPTIONAL
455 * }
456 */
457 struct ossl_cmp_pollrep_st {
458 ASN1_INTEGER *certReqId;
459 ASN1_INTEGER *checkAfter;
460 OSSL_CMP_PKIFREETEXT *reason;
461 } /* OSSL_CMP_POLLREP */;
462 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREP)
463 DEFINE_STACK_OF(OSSL_CMP_POLLREP)
464 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POLLREPCONTENT)
465
466 /*-
467 * PKIHeader ::= SEQUENCE {
468 * pvno INTEGER { cmp1999(1), cmp2000(2), cmp2021(3) },
469 * sender GeneralName,
470 * -- identifies the sender
471 * recipient GeneralName,
472 * -- identifies the intended recipient
473 * messageTime [0] GeneralizedTime OPTIONAL,
474 * -- time of production of this message (used when sender
475 * -- believes that the transport will be "suitable"; i.e.,
476 * -- that the time will still be meaningful upon receipt)
477 * protectionAlg [1] AlgorithmIdentifier OPTIONAL,
478 * -- algorithm used for calculation of protection bits
479 * senderKID [2] KeyIdentifier OPTIONAL,
480 * recipKID [3] KeyIdentifier OPTIONAL,
481 * -- to identify specific keys used for protection
482 * transactionID [4] OCTET STRING OPTIONAL,
483 * -- identifies the transaction; i.e., this will be the same in
484 * -- corresponding request, response, certConf, and PKIConf
485 * -- messages
486 * senderNonce [5] OCTET STRING OPTIONAL,
487 * recipNonce [6] OCTET STRING OPTIONAL,
488 * -- nonces used to provide replay protection, senderNonce
489 * -- is inserted by the creator of this message; recipNonce
490 * -- is a nonce previously inserted in a related message by
491 * -- the intended recipient of this message
492 * freeText [7] PKIFreeText OPTIONAL,
493 * -- this may be used to indicate context-specific instructions
494 * -- (this field is intended for human consumption)
495 * generalInfo [8] SEQUENCE SIZE (1..MAX) OF
496 * InfoTypeAndValue OPTIONAL
497 * -- this may be used to convey context-specific information
498 * -- (this field not primarily intended for human consumption)
499 * }
500 */
501 struct ossl_cmp_pkiheader_st {
502 ASN1_INTEGER *pvno;
503 GENERAL_NAME *sender;
504 GENERAL_NAME *recipient;
505 ASN1_GENERALIZEDTIME *messageTime; /* 0 */
506 X509_ALGOR *protectionAlg; /* 1 */
507 ASN1_OCTET_STRING *senderKID; /* 2 */
508 ASN1_OCTET_STRING *recipKID; /* 3 */
509 ASN1_OCTET_STRING *transactionID; /* 4 */
510 ASN1_OCTET_STRING *senderNonce; /* 5 */
511 ASN1_OCTET_STRING *recipNonce; /* 6 */
512 OSSL_CMP_PKIFREETEXT *freeText; /* 7 */
513 STACK_OF(OSSL_CMP_ITAV) *generalInfo; /* 8 */
514 } /* OSSL_CMP_PKIHEADER */;
515
516 typedef STACK_OF(OSSL_CMP_CHALLENGE) OSSL_CMP_POPODECKEYCHALLCONTENT;
517 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POPODECKEYCHALLCONTENT)
518 typedef STACK_OF(ASN1_INTEGER) OSSL_CMP_POPODECKEYRESPCONTENT;
519 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_POPODECKEYRESPCONTENT)
520 typedef STACK_OF(OSSL_CMP_REVDETAILS) OSSL_CMP_REVREQCONTENT;
521 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_REVREQCONTENT)
522 typedef STACK_OF(X509_CRL) OSSL_CMP_CRLANNCONTENT;
523 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_CRLANNCONTENT)
524 typedef STACK_OF(OSSL_CMP_ITAV) OSSL_CMP_GENMSGCONTENT;
525 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_GENMSGCONTENT)
526 typedef STACK_OF(OSSL_CMP_ITAV) OSSL_CMP_GENREPCONTENT;
527 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_GENREPCONTENT)
528
529 /*-
530 * PKIBody ::= CHOICE { -- message-specific body elements
531 * ir [0] CertReqMessages, --Initialization Request
532 * ip [1] CertRepMessage, --Initialization Response
533 * cr [2] CertReqMessages, --Certification Request
534 * cp [3] CertRepMessage, --Certification Response
535 * p10cr [4] CertificationRequest, --imported from [PKCS10]
536 * popdecc [5] POPODecKeyChallContent, --pop Challenge
537 * popdecr [6] POPODecKeyRespContent, --pop Response
538 * kur [7] CertReqMessages, --Key Update Request
539 * kup [8] CertRepMessage, --Key Update Response
540 * krr [9] CertReqMessages, --Key Recovery Request
541 * krp [10] KeyRecRepContent, --Key Recovery Response
542 * rr [11] RevReqContent, --Revocation Request
543 * rp [12] RevRepContent, --Revocation Response
544 * ccr [13] CertReqMessages, --Cross-Cert. Request
545 * ccp [14] CertRepMessage, --Cross-Cert. Response
546 * ckuann [15] CAKeyUpdAnnContent, --CA Key Update Ann.
547 * cann [16] CertAnnContent, --Certificate Ann.
548 * rann [17] RevAnnContent, --Revocation Ann.
549 * crlann [18] CRLAnnContent, --CRL Announcement
550 * pkiconf [19] PKIConfirmContent, --Confirmation
551 * nested [20] NestedMessageContent, --Nested Message
552 * genm [21] GenMsgContent, --General Message
553 * genp [22] GenRepContent, --General Response
554 * error [23] ErrorMsgContent, --Error Message
555 * certConf [24] CertConfirmContent, --Certificate confirm
556 * pollReq [25] PollReqContent, --Polling request
557 * pollRep [26] PollRepContent --Polling response
558 * }
559 */
560 typedef struct ossl_cmp_pkibody_st {
561 int type;
562 union {
563 OSSL_CRMF_MSGS *ir; /* 0 */
564 OSSL_CMP_CERTREPMESSAGE *ip; /* 1 */
565 OSSL_CRMF_MSGS *cr; /* 2 */
566 OSSL_CMP_CERTREPMESSAGE *cp; /* 3 */
567 /*-
568 * p10cr [4] CertificationRequest, --imported from [PKCS10]
569 *
570 * PKCS10_CERTIFICATIONREQUEST is effectively X509_REQ
571 * so it is used directly
572 */
573 X509_REQ *p10cr; /* 4 */
574 /*-
575 * popdecc [5] POPODecKeyChallContent, --pop Challenge
576 *
577 * POPODecKeyChallContent ::= SEQUENCE OF Challenge
578 */
579 OSSL_CMP_POPODECKEYCHALLCONTENT *popdecc; /* 5 */
580 /*-
581 * popdecr [6] POPODecKeyRespContent, --pop Response
582 *
583 * POPODecKeyRespContent ::= SEQUENCE OF INTEGER
584 */
585 OSSL_CMP_POPODECKEYRESPCONTENT *popdecr; /* 6 */
586 OSSL_CRMF_MSGS *kur; /* 7 */
587 OSSL_CMP_CERTREPMESSAGE *kup; /* 8 */
588 OSSL_CRMF_MSGS *krr; /* 9 */
589
590 /*-
591 * krp [10] KeyRecRepContent, --Key Recovery Response
592 */
593 OSSL_CMP_KEYRECREPCONTENT *krp; /* 10 */
594 /*-
595 * rr [11] RevReqContent, --Revocation Request
596 */
597 OSSL_CMP_REVREQCONTENT *rr; /* 11 */
598 /*-
599 * rp [12] RevRepContent, --Revocation Response
600 */
601 OSSL_CMP_REVREPCONTENT *rp; /* 12 */
602 /*-
603 * ccr [13] CertReqMessages, --Cross-Cert. Request
604 */
605 OSSL_CRMF_MSGS *ccr; /* 13 */
606 /*-
607 * ccp [14] CertRepMessage, --Cross-Cert. Response
608 */
609 OSSL_CMP_CERTREPMESSAGE *ccp; /* 14 */
610 /*-
611 * ckuann [15] CAKeyUpdAnnContent, --CA Key Update Ann.
612 */
613 OSSL_CMP_CAKEYUPDANNCONTENT *ckuann; /* 15 */
614 /*-
615 * cann [16] CertAnnContent, --Certificate Ann.
616 * OSSL_CMP_CMPCERTIFICATE is effectively X509 so it is used directly
617 */
618 X509 *cann; /* 16 */
619 /*-
620 * rann [17] RevAnnContent, --Revocation Ann.
621 */
622 OSSL_CMP_REVANNCONTENT *rann; /* 17 */
623 /*-
624 * crlann [18] CRLAnnContent, --CRL Announcement
625 * CRLAnnContent ::= SEQUENCE OF CertificateList
626 */
627 OSSL_CMP_CRLANNCONTENT *crlann; /* 18 */
628 /*-
629 * PKIConfirmContent ::= NULL
630 * pkiconf [19] PKIConfirmContent, --Confirmation
631 * OSSL_CMP_PKICONFIRMCONTENT would be only a typedef of ASN1_NULL
632 * OSSL_CMP_CONFIRMCONTENT *pkiconf;
633 *
634 * NOTE: this should ASN1_NULL according to the RFC
635 * but there might be a struct in it when sent from faulty servers...
636 */
637 ASN1_TYPE *pkiconf; /* 19 */
638 /*-
639 * nested [20] NestedMessageContent, --Nested Message
640 * NestedMessageContent ::= PKIMessages
641 */
642 OSSL_CMP_MSGS *nested; /* 20 */
643 /*-
644 * genm [21] GenMsgContent, --General Message
645 * GenMsgContent ::= SEQUENCE OF InfoTypeAndValue
646 */
647 OSSL_CMP_GENMSGCONTENT *genm; /* 21 */
648 /*-
649 * genp [22] GenRepContent, --General Response
650 * GenRepContent ::= SEQUENCE OF InfoTypeAndValue
651 */
652 OSSL_CMP_GENREPCONTENT *genp; /* 22 */
653 /*-
654 * error [23] ErrorMsgContent, --Error Message
655 */
656 OSSL_CMP_ERRORMSGCONTENT *error; /* 23 */
657 /*-
658 * certConf [24] CertConfirmContent, --Certificate confirm
659 */
660 OSSL_CMP_CERTCONFIRMCONTENT *certConf; /* 24 */
661 /*-
662 * pollReq [25] PollReqContent, --Polling request
663 */
664 OSSL_CMP_POLLREQCONTENT *pollReq; /* 25 */
665 /*-
666 * pollRep [26] PollRepContent --Polling response
667 */
668 OSSL_CMP_POLLREPCONTENT *pollRep; /* 26 */
669 } value;
670 } OSSL_CMP_PKIBODY;
671 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_PKIBODY)
672
673 /*-
674 * PKIProtection ::= BIT STRING
675 *
676 * PKIMessages ::= SEQUENCE SIZE (1..MAX) OF PKIMessage
677 *
678 * PKIMessage ::= SEQUENCE {
679 * header PKIHeader,
680 * body PKIBody,
681 * protection [0] PKIProtection OPTIONAL,
682 * extraCerts [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
683 * OPTIONAL
684 * }
685 */
686 struct ossl_cmp_msg_st {
687 OSSL_CMP_PKIHEADER *header;
688 OSSL_CMP_PKIBODY *body;
689 ASN1_BIT_STRING *protection; /* 0 */
690 /* OSSL_CMP_CMPCERTIFICATE is effectively X509 so it is used directly */
691 STACK_OF(X509) *extraCerts; /* 1 */
692 OSSL_LIB_CTX *libctx;
693 char *propq;
694 } /* OSSL_CMP_MSG */;
695 OSSL_CMP_MSG *OSSL_CMP_MSG_new(OSSL_LIB_CTX *libctx, const char *propq);
696 void OSSL_CMP_MSG_free(OSSL_CMP_MSG *msg);
697
698 /*-
699 * ProtectedPart ::= SEQUENCE {
700 * header PKIHeader,
701 * body PKIBody
702 * }
703 */
704 typedef struct ossl_cmp_protectedpart_st {
705 OSSL_CMP_PKIHEADER *header;
706 OSSL_CMP_PKIBODY *body;
707 } OSSL_CMP_PROTECTEDPART;
708 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_PROTECTEDPART)
709
710 /*-
711 * this is not defined here as it is already in CRMF:
712 * id-PasswordBasedMac OBJECT IDENTIFIER ::= {1 2 840 113533 7 66 13}
713 * PBMParameter ::= SEQUENCE {
714 * salt OCTET STRING,
715 * -- note: implementations MAY wish to limit acceptable sizes
716 * -- of this string to values appropriate for their environment
717 * -- in order to reduce the risk of denial-of-service attacks
718 * owf AlgorithmIdentifier,
719 * -- AlgId for a One-Way Function (SHA-1 recommended)
720 * iterationCount INTEGER,
721 * -- number of times the OWF is applied
722 * -- note: implementations MAY wish to limit acceptable sizes
723 * -- of this integer to values appropriate for their environment
724 * -- in order to reduce the risk of denial-of-service attacks
725 * mac AlgorithmIdentifier
726 * -- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11],
727 * } -- or HMAC [RFC2104, RFC2202])
728 */
729 /*-
730 * Not supported:
731 * id-DHBasedMac OBJECT IDENTIFIER ::= {1 2 840 113533 7 66 30}
732 * DHBMParameter ::= SEQUENCE {
733 * owf AlgorithmIdentifier,
734 * -- AlgId for a One-Way Function (SHA-1 recommended)
735 * mac AlgorithmIdentifier
736 * -- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11],
737 * } -- or HMAC [RFC2104, RFC2202])
738 */
739 /*-
740 * The following is not cared for, because it is described in section 5.2.5
741 * that this is beyond the scope of CMP
742 * OOBCert ::= CMPCertificate
743 *
744 * OOBCertHash ::= SEQUENCE {
745 * hashAlg [0] AlgorithmIdentifier OPTIONAL,
746 * certId [1] CertId OPTIONAL,
747 * hashVal BIT STRING
748 * -- hashVal is calculated over the DER encoding of the
749 * -- self-signed certificate with the identifier certID.
750 * }
751 */
752
753 /*
754 * RootCaKeyUpdateContent ::= SEQUENCE {
755 * newWithNew CMPCertificate,
756 * newWithOld [0] CMPCertificate OPTIONAL,
757 * oldWithNew [1] CMPCertificate OPTIONAL
758 * }
759 */
760
761 struct ossl_cmp_rootcakeyupdate_st {
762 X509 *newWithNew;
763 X509 *newWithOld;
764 X509 *oldWithNew;
765 } /* OSSL_CMP_ROOTCAKEYUPDATE */;
766 DECLARE_ASN1_FUNCTIONS(OSSL_CMP_ROOTCAKEYUPDATE)
767
768 /* from cmp_asn.c */
769 int ossl_cmp_asn1_get_int(const ASN1_INTEGER *a);
770
771 /* from cmp_util.c */
772 const char *ossl_cmp_log_parse_metadata(const char *buf,
773 OSSL_CMP_severity *level, char **func,
774 char **file, int *line);
775 # define ossl_cmp_add_error_data(txt) ERR_add_error_txt(" : ", txt)
776 # define ossl_cmp_add_error_line(txt) ERR_add_error_txt("\n", txt)
777 /* The two functions manipulating X509_STORE could be generally useful */
778 int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
779 int only_self_issued);
780 STACK_OF(X509) *ossl_cmp_X509_STORE_get1_certs(X509_STORE *store);
781 int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
782 const char *text, int len);
783 int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
784 const ASN1_OCTET_STRING *src);
785 int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
786 const unsigned char *bytes, int len);
787
788 /* from cmp_ctx.c */
789 int ossl_cmp_print_log(OSSL_CMP_severity level, const OSSL_CMP_CTX *ctx,
790 const char *func, const char *file, int line,
791 const char *level_str, const char *format, ...);
792 # define ossl_cmp_log(level, ctx, msg) \
793 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
794 OPENSSL_LINE, #level, "%s", msg)
795 # define ossl_cmp_log1(level, ctx, fmt, arg1) \
796 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
797 OPENSSL_LINE, #level, fmt, arg1)
798 # define ossl_cmp_log2(level, ctx, fmt, arg1, arg2) \
799 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
800 OPENSSL_LINE, #level, fmt, arg1, arg2)
801 # define ossl_cmp_log3(level, ctx, fmt, arg1, arg2, arg3) \
802 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
803 OPENSSL_LINE, #level, fmt, arg1, arg2, arg3)
804 # define ossl_cmp_log4(level, ctx, fmt, arg1, arg2, arg3, arg4) \
805 ossl_cmp_print_log(OSSL_CMP_LOG_##level, ctx, OPENSSL_FUNC, OPENSSL_FILE, \
806 OPENSSL_LINE, #level, fmt, arg1, arg2, arg3, arg4)
807 # define OSSL_CMP_LOG_ERROR OSSL_CMP_LOG_ERR
808 # define OSSL_CMP_LOG_WARN OSSL_CMP_LOG_WARNING
809 # define ossl_cmp_alert(ctx, msg) ossl_cmp_log(ALERT, ctx, msg)
810 # define ossl_cmp_err(ctx, msg) ossl_cmp_log(ERROR, ctx, msg)
811 # define ossl_cmp_warn(ctx, msg) ossl_cmp_log(WARN, ctx, msg)
812 # define ossl_cmp_info(ctx, msg) ossl_cmp_log(INFO, ctx, msg)
813 # define ossl_cmp_debug(ctx, msg) ossl_cmp_log(DEBUG, ctx, msg)
814 # define ossl_cmp_trace(ctx, msg) ossl_cmp_log(TRACE, ctx, msg)
815 int ossl_cmp_ctx_set1_validatedSrvCert(OSSL_CMP_CTX *ctx, X509 *cert);
816 int ossl_cmp_ctx_set_status(OSSL_CMP_CTX *ctx, int status);
817 int ossl_cmp_ctx_set0_statusString(OSSL_CMP_CTX *ctx,
818 OSSL_CMP_PKIFREETEXT *text);
819 int ossl_cmp_ctx_set_failInfoCode(OSSL_CMP_CTX *ctx, int fail_info);
820 int ossl_cmp_ctx_set0_newCert(OSSL_CMP_CTX *ctx, X509 *cert);
821 int ossl_cmp_ctx_set1_newChain(OSSL_CMP_CTX *ctx, STACK_OF(X509) *newChain);
822 int ossl_cmp_ctx_set1_caPubs(OSSL_CMP_CTX *ctx, STACK_OF(X509) *caPubs);
823 int ossl_cmp_ctx_set1_extraCertsIn(OSSL_CMP_CTX *ctx,
824 STACK_OF(X509) *extraCertsIn);
825 int ossl_cmp_ctx_set1_recipNonce(OSSL_CMP_CTX *ctx,
826 const ASN1_OCTET_STRING *nonce);
827 EVP_PKEY *ossl_cmp_ctx_get0_newPubkey(const OSSL_CMP_CTX *ctx);
828 int ossl_cmp_ctx_set1_first_senderNonce(OSSL_CMP_CTX *ctx,
829 const ASN1_OCTET_STRING *nonce);
830
831 /* from cmp_status.c */
832 int ossl_cmp_pkisi_get_status(const OSSL_CMP_PKISI *si);
833 const char *ossl_cmp_PKIStatus_to_string(int status);
834 OSSL_CMP_PKIFREETEXT *ossl_cmp_pkisi_get0_statusString(const OSSL_CMP_PKISI *s);
835 int ossl_cmp_pkisi_get_pkifailureinfo(const OSSL_CMP_PKISI *si);
836 int ossl_cmp_pkisi_check_pkifailureinfo(const OSSL_CMP_PKISI *si, int index);
837
838 /* from cmp_hdr.c */
839 int ossl_cmp_hdr_set_pvno(OSSL_CMP_PKIHEADER *hdr, int pvno);
840 int ossl_cmp_hdr_get_pvno(const OSSL_CMP_PKIHEADER *hdr);
841 int ossl_cmp_hdr_get_protection_nid(const OSSL_CMP_PKIHEADER *hdr);
842 ASN1_OCTET_STRING *ossl_cmp_hdr_get0_senderNonce(const OSSL_CMP_PKIHEADER *hdr);
843 int ossl_cmp_general_name_is_NULL_DN(GENERAL_NAME *name);
844 int ossl_cmp_hdr_set1_sender(OSSL_CMP_PKIHEADER *hdr, const X509_NAME *nm);
845 int ossl_cmp_hdr_set1_recipient(OSSL_CMP_PKIHEADER *hdr, const X509_NAME *nm);
846 int ossl_cmp_hdr_update_messageTime(OSSL_CMP_PKIHEADER *hdr);
847 int ossl_cmp_hdr_set1_senderKID(OSSL_CMP_PKIHEADER *hdr,
848 const ASN1_OCTET_STRING *senderKID);
849 int ossl_cmp_hdr_push0_freeText(OSSL_CMP_PKIHEADER *hdr, ASN1_UTF8STRING *text);
850 int ossl_cmp_hdr_push1_freeText(OSSL_CMP_PKIHEADER *hdr, ASN1_UTF8STRING *text);
851 int ossl_cmp_hdr_generalInfo_push0_item(OSSL_CMP_PKIHEADER *hdr,
852 OSSL_CMP_ITAV *itav);
853 int ossl_cmp_hdr_generalInfo_push1_items(OSSL_CMP_PKIHEADER *hdr,
854 const STACK_OF(OSSL_CMP_ITAV) *itavs);
855 int ossl_cmp_hdr_set_implicitConfirm(OSSL_CMP_PKIHEADER *hdr);
856 int ossl_cmp_hdr_has_implicitConfirm(const OSSL_CMP_PKIHEADER *hdr);
857 # define OSSL_CMP_TRANSACTIONID_LENGTH 16
858 # define OSSL_CMP_SENDERNONCE_LENGTH 16
859 int ossl_cmp_hdr_set_transactionID(OSSL_CMP_CTX *ctx, OSSL_CMP_PKIHEADER *hdr);
860 int ossl_cmp_hdr_init(OSSL_CMP_CTX *ctx, OSSL_CMP_PKIHEADER *hdr);
861
862 /* from cmp_msg.c */
863 /* OSSL_CMP_MSG bodytype ASN.1 choice IDs */
864 # define OSSL_CMP_PKIBODY_IR 0
865 # define OSSL_CMP_PKIBODY_IP 1
866 # define OSSL_CMP_PKIBODY_CR 2
867 # define OSSL_CMP_PKIBODY_CP 3
868 # define OSSL_CMP_PKIBODY_P10CR 4
869 # define OSSL_CMP_PKIBODY_POPDECC 5
870 # define OSSL_CMP_PKIBODY_POPDECR 6
871 # define OSSL_CMP_PKIBODY_KUR 7
872 # define OSSL_CMP_PKIBODY_KUP 8
873 # define OSSL_CMP_PKIBODY_KRR 9
874 # define OSSL_CMP_PKIBODY_KRP 10
875 # define OSSL_CMP_PKIBODY_RR 11
876 # define OSSL_CMP_PKIBODY_RP 12
877 # define OSSL_CMP_PKIBODY_CCR 13
878 # define OSSL_CMP_PKIBODY_CCP 14
879 # define OSSL_CMP_PKIBODY_CKUANN 15
880 # define OSSL_CMP_PKIBODY_CANN 16
881 # define OSSL_CMP_PKIBODY_RANN 17
882 # define OSSL_CMP_PKIBODY_CRLANN 18
883 # define OSSL_CMP_PKIBODY_PKICONF 19
884 # define OSSL_CMP_PKIBODY_NESTED 20
885 # define OSSL_CMP_PKIBODY_GENM 21
886 # define OSSL_CMP_PKIBODY_GENP 22
887 # define OSSL_CMP_PKIBODY_ERROR 23
888 # define OSSL_CMP_PKIBODY_CERTCONF 24
889 # define OSSL_CMP_PKIBODY_POLLREQ 25
890 # define OSSL_CMP_PKIBODY_POLLREP 26
891 # define OSSL_CMP_PKIBODY_TYPE_MAX OSSL_CMP_PKIBODY_POLLREP
892 /* certReqId for the first - and so far only - certificate request */
893 # define OSSL_CMP_CERTREQID 0
894 # define OSSL_CMP_CERTREQID_NONE -1
895 # define OSSL_CMP_CERTREQID_INVALID -2
896 /* sequence id for the first - and so far only - revocation request */
897 # define OSSL_CMP_REVREQSID 0
898 int ossl_cmp_msg_set0_libctx(OSSL_CMP_MSG *msg, OSSL_LIB_CTX *libctx,
899 const char *propq);
900 const char *ossl_cmp_bodytype_to_string(int type);
901 int ossl_cmp_msg_set_bodytype(OSSL_CMP_MSG *msg, int type);
902 OSSL_CMP_MSG *ossl_cmp_msg_create(OSSL_CMP_CTX *ctx, int bodytype);
903 OSSL_CMP_MSG *ossl_cmp_certreq_new(OSSL_CMP_CTX *ctx, int bodytype,
904 const OSSL_CRMF_MSG *crm);
905 OSSL_CMP_MSG *ossl_cmp_certrep_new(OSSL_CMP_CTX *ctx, int bodytype,
906 int certReqId, const OSSL_CMP_PKISI *si,
907 X509 *cert, const X509 *encryption_recip,
908 STACK_OF(X509) *chain, STACK_OF(X509) *caPubs,
909 int unprotectedErrors);
910 OSSL_CMP_MSG *ossl_cmp_rr_new(OSSL_CMP_CTX *ctx);
911 OSSL_CMP_MSG *ossl_cmp_rp_new(OSSL_CMP_CTX *ctx, const OSSL_CMP_PKISI *si,
912 const OSSL_CRMF_CERTID *cid,
913 int unprotectedErrors);
914 OSSL_CMP_MSG *ossl_cmp_pkiconf_new(OSSL_CMP_CTX *ctx);
915 OSSL_CMP_MSG *ossl_cmp_pollRep_new(OSSL_CMP_CTX *ctx, int crid,
916 int64_t poll_after);
917 int ossl_cmp_msg_gen_push0_ITAV(OSSL_CMP_MSG *msg, OSSL_CMP_ITAV *itav);
918 int ossl_cmp_msg_gen_push1_ITAVs(OSSL_CMP_MSG *msg,
919 const STACK_OF(OSSL_CMP_ITAV) *itavs);
920 OSSL_CMP_MSG *ossl_cmp_genm_new(OSSL_CMP_CTX *ctx);
921 OSSL_CMP_MSG *ossl_cmp_genp_new(OSSL_CMP_CTX *ctx,
922 const STACK_OF(OSSL_CMP_ITAV) *itavs);
923 OSSL_CMP_MSG *ossl_cmp_error_new(OSSL_CMP_CTX *ctx, const OSSL_CMP_PKISI *si,
924 int64_t errorCode, const char *details,
925 int unprotected);
926 int ossl_cmp_certstatus_set0_certHash(OSSL_CMP_CERTSTATUS *certStatus,
927 ASN1_OCTET_STRING *hash);
928 OSSL_CMP_MSG *ossl_cmp_certConf_new(OSSL_CMP_CTX *ctx, int certReqId,
929 int fail_info, const char *text);
930 OSSL_CMP_MSG *ossl_cmp_pollReq_new(OSSL_CMP_CTX *ctx, int crid);
931 OSSL_CMP_MSG *ossl_cmp_pollRep_new(OSSL_CMP_CTX *ctx, int crid,
932 int64_t poll_after);
933 OSSL_CMP_PKISI *
934 ossl_cmp_revrepcontent_get_pkisi(OSSL_CMP_REVREPCONTENT *rrep, int rsid);
935 OSSL_CRMF_CERTID *ossl_cmp_revrepcontent_get_CertId(OSSL_CMP_REVREPCONTENT *rc,
936 int rsid);
937 OSSL_CMP_POLLREP *
938 ossl_cmp_pollrepcontent_get0_pollrep(const OSSL_CMP_POLLREPCONTENT *prc,
939 int rid);
940 OSSL_CMP_CERTRESPONSE *
941 ossl_cmp_certrepmessage_get0_certresponse(const OSSL_CMP_CERTREPMESSAGE *crm,
942 int rid);
943 X509 *ossl_cmp_certresponse_get1_cert(const OSSL_CMP_CTX *ctx,
944 const OSSL_CMP_CERTRESPONSE *crep);
945 OSSL_CMP_MSG *ossl_cmp_msg_load(const char *file);
946 int ossl_cmp_is_error_with_waiting(const OSSL_CMP_MSG *msg);
947
948 /* from cmp_protect.c */
949 int ossl_cmp_msg_add_extraCerts(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg);
950 ASN1_BIT_STRING *ossl_cmp_calc_protection(const OSSL_CMP_CTX *ctx,
951 const OSSL_CMP_MSG *msg);
952 int ossl_cmp_msg_protect(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg);
953
954 /* from cmp_vfy.c */
955 typedef int (*ossl_cmp_allow_unprotected_cb_t)(const OSSL_CMP_CTX *ctx,
956 const OSSL_CMP_MSG *msg,
957 int invalid_protection, int arg);
958 int ossl_cmp_msg_check_update(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg,
959 ossl_cmp_allow_unprotected_cb_t cb, int cb_arg);
960 int ossl_cmp_msg_check_received(OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *msg,
961 ossl_cmp_allow_unprotected_cb_t cb, int cb_arg);
962 int ossl_cmp_verify_popo(const OSSL_CMP_CTX *ctx,
963 const OSSL_CMP_MSG *msg, int accept_RAVerified);
964
965 /* from cmp_client.c */
966 /* expected max time per msg round trip, used for last try during polling: */
967 # define OSSL_CMP_EXPECTED_RESP_TIME 2
968 int ossl_cmp_exchange_certConf(OSSL_CMP_CTX *ctx, int certReqId,
969 int fail_info, const char *txt);
970 int ossl_cmp_exchange_error(OSSL_CMP_CTX *ctx, int status, int fail_info,
971 const char *txt, int errorCode, const char *detail);
972
973 #endif /* !defined(OSSL_CRYPTO_CMP_LOCAL_H) */