016d851ddce1873bbe6af775cc870d03c954e181
[openssl.git] / doc / man3 / OSSL_CMP_CTX_new.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_CMP_CTX_new,
6 OSSL_CMP_CTX_free,
7 OSSL_CMP_CTX_reinit,
8 OSSL_CMP_CTX_set_option,
9 OSSL_CMP_CTX_get_option,
10 OSSL_CMP_CTX_set_log_cb,
11 OSSL_CMP_CTX_set_log_verbosity,
12 OSSL_CMP_CTX_print_errors,
13 OSSL_CMP_CTX_set1_serverPath,
14 OSSL_CMP_CTX_set1_serverName,
15 OSSL_CMP_CTX_set_serverPort,
16 OSSL_CMP_CTX_set1_proxyName,
17 OSSL_CMP_CTX_set_proxyPort,
18 OSSL_CMP_DEFAULT_PORT,
19 OSSL_CMP_CTX_set_http_cb,
20 OSSL_CMP_CTX_set_http_cb_arg,
21 OSSL_CMP_CTX_get_http_cb_arg,
22 OSSL_CMP_transfer_cb_t,
23 OSSL_CMP_CTX_set_transfer_cb,
24 OSSL_CMP_CTX_set_transfer_cb_arg,
25 OSSL_CMP_CTX_get_transfer_cb_arg,
26 OSSL_CMP_CTX_set1_srvCert,
27 OSSL_CMP_CTX_set1_expected_sender,
28 OSSL_CMP_CTX_set0_trustedStore,
29 OSSL_CMP_CTX_get0_trustedStore,
30 OSSL_CMP_CTX_set1_untrusted_certs,
31 OSSL_CMP_CTX_get0_untrusted_certs,
32 OSSL_CMP_CTX_set1_clCert,
33 OSSL_CMP_CTX_set1_pkey,
34 OSSL_CMP_CTX_set1_referenceValue,
35 OSSL_CMP_CTX_set1_secretValue,
36 OSSL_CMP_CTX_set1_recipient,
37 OSSL_CMP_CTX_push0_geninfo_ITAV,
38 OSSL_CMP_CTX_set1_extraCertsOut,
39 OSSL_CMP_CTX_set0_newPkey,
40 OSSL_CMP_CTX_get0_newPkey,
41 OSSL_CMP_CTX_set1_issuer,
42 OSSL_CMP_CTX_set1_subjectName,
43 OSSL_CMP_CTX_push1_subjectAltName,
44 OSSL_CMP_CTX_set0_reqExtensions,
45 OSSL_CMP_CTX_reqExtensions_have_SAN,
46 OSSL_CMP_CTX_push0_policy,
47 OSSL_CMP_CTX_set1_oldCert,
48 OSSL_CMP_CTX_set1_p10CSR,
49 OSSL_CMP_CTX_push0_genm_ITAV,
50 OSSL_CMP_certConf_cb_t,
51 OSSL_CMP_CTX_set_certConf_cb,
52 OSSL_CMP_CTX_set_certConf_cb_arg,
53 OSSL_CMP_CTX_get_certConf_cb_arg,
54 OSSL_CMP_CTX_get_status,
55 OSSL_CMP_CTX_get0_statusString,
56 OSSL_CMP_CTX_get_failInfoCode,
57 OSSL_CMP_CTX_get0_newCert,
58 OSSL_CMP_CTX_get1_caPubs,
59 OSSL_CMP_CTX_get1_extraCertsIn,
60 OSSL_CMP_CTX_set1_transactionID,
61 OSSL_CMP_CTX_set1_senderNonce
62 - functions for managing the CMP client context data structure
63
64 =head1 SYNOPSIS
65
66  #include <openssl/cmp.h>
67
68  OSSL_CMP_CTX *OSSL_CMP_CTX_new(void);
69  void OSSL_CMP_CTX_free(OSSL_CMP_CTX *ctx);
70  int OSSL_CMP_CTX_reinit(OSSL_CMP_CTX *ctx);
71  int OSSL_CMP_CTX_set_option(OSSL_CMP_CTX *ctx, int opt, int val);
72  int OSSL_CMP_CTX_get_option(const OSSL_CMP_CTX *ctx, int opt);
73
74  /* logging and error reporting: */
75  int OSSL_CMP_CTX_set_log_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_log_cb_t cb);
76  #define OSSL_CMP_CTX_set_log_verbosity(ctx, level)
77  void OSSL_CMP_CTX_print_errors(OSSL_CMP_CTX *ctx);
78
79  /* message transfer: */
80  int OSSL_CMP_CTX_set1_serverPath(OSSL_CMP_CTX *ctx, const char *path);
81  int OSSL_CMP_CTX_set1_serverName(OSSL_CMP_CTX *ctx, const char *name);
82  int OSSL_CMP_CTX_set_serverPort(OSSL_CMP_CTX *ctx, int port);
83  int OSSL_CMP_CTX_set1_proxyName(OSSL_CMP_CTX *ctx, const char *name);
84  int OSSL_CMP_CTX_set_proxyPort(OSSL_CMP_CTX *ctx, int port);
85  #define OSSL_CMP_DEFAULT_PORT 80
86  int OSSL_CMP_CTX_set_http_cb(OSSL_CMP_CTX *ctx, HTTP_bio_cb_t cb);
87  int OSSL_CMP_CTX_set_http_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
88  void *OSSL_CMP_CTX_get_http_cb_arg(const OSSL_CMP_CTX *ctx);
89  typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t)(OSSL_CMP_CTX *ctx,
90                                                  const OSSL_CMP_MSG *req);
91  int OSSL_CMP_CTX_set_transfer_cb(OSSL_CMP_CTX *ctx,
92                                   OSSL_CMP_transfer_cb_t cb);
93  int OSSL_CMP_CTX_set_transfer_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
94  void *OSSL_CMP_CTX_get_transfer_cb_arg(const OSSL_CMP_CTX *ctx);
95
96  /* server authentication: */
97  int OSSL_CMP_CTX_set1_srvCert(OSSL_CMP_CTX *ctx, X509 *cert);
98  int OSSL_CMP_CTX_set1_expected_sender(OSSL_CMP_CTX *ctx,
99                                       const X509_NAME *name);
100  int OSSL_CMP_CTX_set0_trustedStore(OSSL_CMP_CTX *ctx, X509_STORE *store);
101  X509_STORE *OSSL_CMP_CTX_get0_trustedStore(const OSSL_CMP_CTX *ctx);
102  int OSSL_CMP_CTX_set1_untrusted_certs(OSSL_CMP_CTX *ctx,
103                                        STACK_OF(X509) *certs);
104  STACK_OF(X509) *OSSL_CMP_CTX_get0_untrusted_certs(const OSSL_CMP_CTX *ctx);
105
106  /* client authentication: */
107  int OSSL_CMP_CTX_set1_clCert(OSSL_CMP_CTX *ctx, X509 *cert);
108  int OSSL_CMP_CTX_set1_pkey(OSSL_CMP_CTX *ctx, EVP_PKEY *pkey);
109  int OSSL_CMP_CTX_set1_referenceValue(OSSL_CMP_CTX *ctx,
110                                       const unsigned char *ref, int len);
111  int OSSL_CMP_CTX_set1_secretValue(OSSL_CMP_CTX *ctx, const unsigned char *sec,
112                                    const int len);
113
114  /* CMP message header and extra certificates: */
115  int OSSL_CMP_CTX_set1_recipient(OSSL_CMP_CTX *ctx, const X509_NAME *name);
116  int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
117  int OSSL_CMP_CTX_set1_extraCertsOut(OSSL_CMP_CTX *ctx,
118                                      STACK_OF(X509) *extraCertsOut);
119
120  /* certificate template: */
121  int OSSL_CMP_CTX_set0_newPkey(OSSL_CMP_CTX *ctx, int priv, EVP_PKEY *pkey);
122  EVP_PKEY *OSSL_CMP_CTX_get0_newPkey(const OSSL_CMP_CTX *ctx, int priv);
123  int OSSL_CMP_CTX_set1_issuer(OSSL_CMP_CTX *ctx, const X509_NAME *name);
124  int OSSL_CMP_CTX_set1_subjectName(OSSL_CMP_CTX *ctx, const X509_NAME *name);
125  int OSSL_CMP_CTX_push1_subjectAltName(OSSL_CMP_CTX *ctx,
126                                        const GENERAL_NAME *name);
127  int OSSL_CMP_CTX_set0_reqExtensions(OSSL_CMP_CTX *ctx, X509_EXTENSIONS *exts);
128  int OSSL_CMP_CTX_reqExtensions_have_SAN(OSSL_CMP_CTX *ctx);
129  int OSSL_CMP_CTX_push0_policy(OSSL_CMP_CTX *ctx, POLICYINFO *pinfo);
130  int OSSL_CMP_CTX_set1_oldCert(OSSL_CMP_CTX *ctx, X509 *cert);
131  int OSSL_CMP_CTX_set1_p10CSR(OSSL_CMP_CTX *ctx, const X509_REQ *csr);
132
133  /* misc body contents: */
134  int OSSL_CMP_CTX_push0_genm_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
135
136  /* certificate confirmation: */
137  typedef int (*OSSL_CMP_certConf_cb_t)(OSSL_CMP_CTX *ctx, X509 *cert,
138                                        int fail_info, const char **txt);
139  int OSSL_CMP_CTX_set_certConf_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_certConf_cb_t cb);
140  int OSSL_CMP_CTX_set_certConf_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
141  void *OSSL_CMP_CTX_get_certConf_cb_arg(const OSSL_CMP_CTX *ctx);
142
143  /* result fetching: */
144  int OSSL_CMP_CTX_get_status(const OSSL_CMP_CTX *ctx);
145  OSSL_CMP_PKIFREETEXT *OSSL_CMP_CTX_get0_statusString(const OSSL_CMP_CTX *ctx);
146  int OSSL_CMP_CTX_get_failInfoCode(const OSSL_CMP_CTX *ctx);
147
148  X509 *OSSL_CMP_CTX_get0_newCert(const OSSL_CMP_CTX *ctx);
149  STACK_OF(X509) *OSSL_CMP_CTX_get1_caPubs(const OSSL_CMP_CTX *ctx);
150  STACK_OF(X509) *OSSL_CMP_CTX_get1_extraCertsIn(const OSSL_CMP_CTX *ctx);
151
152  /* for testing and debugging purposes: */
153  int OSSL_CMP_CTX_set1_transactionID(OSSL_CMP_CTX *ctx,
154                                      const ASN1_OCTET_STRING *id);
155  int OSSL_CMP_CTX_set1_senderNonce(OSSL_CMP_CTX *ctx,
156                                    const ASN1_OCTET_STRING *nonce);
157
158 =head1 DESCRIPTION
159
160 This is the context API for using CMP (Certificate Management Protocol) with
161 OpenSSL.
162
163 OSSL_CMP_CTX_new() allocates and initializes an OSSL_CMP_CTX structure to
164 default values, e.g., proof-of-possession method is set to POPOSigningKey.
165
166 OSSL_CMP_CTX_free() deallocates an OSSL_CMP_CTX structure.
167
168 OSSL_CMP_CTX_reinit() prepares the given B<ctx> for a further transaction by
169 clearing the internal CMP transaction (aka session) status, PKIStatusInfo,
170 and any previous results (newCert, caPubs, and extraCertsIn)
171 from the last executed transaction.
172 All other field values (i.e., CMP options) are retained for potential re-use.
173
174 OSSL_CMP_CTX_set_option() sets the given value for the given option
175 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) in the given OSSL_CMP_CTX structure.
176
177 The following options can be set:
178
179 =over 4
180
181 =item B<OSSL_CMP_OPT_LOG_VERBOSITY>
182
183         The level of severity needed for actually outputting log messages
184         due to errors, warnings, general info, debugging, etc.
185         Default is OSSL_CMP_LOG_INFO. See also L<OSSL_CMP_log_open(3)>.
186
187 =item B<OSSL_CMP_OPT_MSG_TIMEOUT>
188
189         Number of seconds (or 0 for infinite) a CMP message round trip is
190         allowed to take before a timeout error is returned. Default is 120.
191
192 =item B<OSSL_CMP_OPT_TOTAL_TIMEOUT>
193
194         Maximum total number of seconds an enrollment (including polling)
195         may take. Default is 0 (infinite).
196
197 =item B<OSSL_CMP_OPT_VALIDITY_DAYS>
198
199         Number of days new certificates are asked to be valid for.
200
201 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT>
202
203         Do not take default Subject Alternative Names
204         from the reference certificate.
205
206 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL>
207
208         Demand that the given Subject Alternative Names are flagged as critical.
209
210 =item B<OSSL_CMP_OPT_POLICIES_CRITICAL>
211
212         Demand that the given policies are flagged as critical.
213
214 =item B<OSSL_CMP_OPT_POPO_METHOD>
215
216         Select the proof of possession method to use. Possible values are:
217
218             OSSL_CRMF_POPO_NONE       - ProofOfPossession field omitted
219             OSSL_CRMF_POPO_RAVERIFIED - assert that the RA has already
220                                         verified the PoPo
221             OSSL_CRMF_POPO_SIGNATURE  - sign a value with private key,
222                                         which is the default.
223             OSSL_CRMF_POPO_KEYENC     - decrypt the encrypted certificate
224                                         ("indirect method")
225
226         Note that a signature-based POPO can only be produced if a private key
227         is provided as the newPkey or client pkey component of the CMP context.
228
229 =item B<OSSL_CMP_OPT_DIGEST_ALGNID>
230
231         The digest algorithm NID to be used in RFC 4210's MSG_SIG_ALG,
232         if applicable used for message protection and Proof-of-Possession.
233         Default is SHA256.
234
235     OSSL_CMP_OPT_OWF_ALGNID
236         The digest algorithm NID to be used as one-way function (OWF)
237         in RFC 4210's MSG_MAC_ALG, if applicable used for message protection.
238         Default is SHA256.
239
240     OSSL_CMP_OPT_MAC_ALGNID
241         The MAC algorithm NID to be used in RFC 4210's MSG_MAC_ALG,
242         if applicable used for message protection.
243         Default is HMAC-SHA1 as per RFC 4210.
244
245 =item B<OSSL_CMP_OPT_REVOCATION_REASON>
246
247         The reason code to be included in a Revocation Request (RR);
248         values: 0..10 (RFC 5210, 5.3.1) or -1 for none, which is the default.
249
250 =item B<OSSL_CMP_OPT_IMPLICIT_CONFIRM>
251
252         Request server to enable implicit confirm mode, where the client
253         does not need to send confirmation upon receiving the
254         certificate. If the server does not enable implicit confirmation
255         in the return message, then confirmation is sent anyway.
256
257 =item B<OSSL_CMP_OPT_DISABLE_CONFIRM>
258
259         Do not confirm enrolled certificates, to cope with broken servers
260         not supporting implicit confirmation correctly.
261 B<WARNING:> This setting leads to unspecified behavior and it is meant
262 exclusively to allow interoperability with server implementations violating
263 RFC 4210.
264
265 =item B<OSSL_CMP_OPT_UNPROTECTED_SEND>
266
267         Send messages without CMP-level protection.
268
269 =item B<OSSL_CMP_OPT_UNPROTECTED_ERRORS>
270
271         Accept unprotected error responses which are either explicitly
272         unprotected or where protection verification failed. Applies to regular
273         error messages as well as certificate responses (IP/CP/KUP) and
274         revocation responses (RP) with rejection.
275 B<WARNING:> This setting leads to unspecified behavior and it is meant
276 exclusively to allow interoperability with server implementations violating
277 RFC 4210.
278
279 =item B<OSSL_CMP_OPT_IGNORE_KEYUSAGE>
280
281         Ignore key usage restrictions in signer certificate when
282         validating signature-based protection in received CMP messages.
283         Else, 'digitalSignature' must be allowed by CMP signer certificates.
284
285 =item B<OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR>
286
287         Allow retrieving a trust anchor from extraCerts and using that
288         to validate the certificate chain of an IP message.
289
290 =back
291
292 OSSL_CMP_CTX_get_option() reads the current value of the given option
293 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) from the given OSSL_CMP_CTX structure.
294
295 OSSL_CMP_CTX_set_log_cb() sets in B<ctx> the callback function C<cb>
296 for handling error queue entries and logging messages.
297 When C<cb> is NULL errors are printed to STDERR (if available, else ignored)
298 any log messages are ignored.
299 Alternatively, L<OSSL_CMP_log_open(3)> may be used to direct logging to STDOUT.
300
301 OSSL_CMP_CTX_set_log_verbosity() is a macro setting the
302 OSSL_CMP_OPT_LOG_VERBOSITY context option to the given level.
303
304 OSSL_CMP_CTX_print_errors() outputs any entries in the OpenSSL error queue.
305 It is similar to B<ERR_print_errors_cb()> but uses the CMP log callback function
306 if set in the C<ctx> for uniformity with CMP logging if given. Otherwise it uses
307 B<ERR_print_errors(3)> to print to STDERR (unless OPENSSL_NO_STDIO is defined).
308
309 OSSL_CMP_CTX_set1_serverPath() sets the HTTP path of the CMP server on the host.
310
311 OSSL_CMP_CTX_set1_serverName() sets the given server Address (as IP or name)
312 in the given OSSL_CMP_CTX structure.
313
314 OSSL_CMP_CTX_set_serverPort() sets the port of the CMP server to connect to.
315 Port defaults to OSSL_CMP_DEFAULT_PORT = 80 if not set explicitly.
316
317 OSSL_CMP_CTX_set1_proxyName() sets the hostname of the HTTP proxy to be used
318 for connecting to the CA server.
319
320 OSSL_CMP_CTX_set_proxyPort() sets the port of the HTTP proxy.
321 Port defaults to OSSL_CMP_DEFAULT_PORT = 80 if not set explicitly.
322
323 OSSL_CMP_CTX_set_http_cb() sets the optional BIO connect/disconnect callback
324 function, which has the prototype
325
326  typedef BIO *(*HTTP_bio_cb_t) (BIO *bio, void *ctx, int connect, int detail);
327
328 The callback may modify the BIO B<bio> provided by OSSL_CMP_MSG_http_perform(),
329 whereby it may make use of a custom defined argument B<ctx>
330 stored in the OSSL_CMP_CTX by means of OSSL_CMP_CTX_set_http_cb_arg().
331 During connection establishment, just after calling BIO_connect_retry(),
332 the function is invoked with the B<connect> argument being 1 and the B<detail>
333 argument being 1 if HTTPS is requested, i.e., SSL/TLS should be enabled. On
334 disconnect B<connect> is 0 and B<detail> is 1 in case no error occurred, else 0.
335 For instance, on connect the function may prepend a TLS BIO to implement HTTPS;
336 after disconnect it may do some diagnostic output and/or specific cleanup.
337 The function should return NULL to indicate failure.
338 After disconnect the modified BIO will be deallocated using BIO_free_all().
339
340 OSSL_CMP_CTX_set_http_cb_arg() sets an argument, respectively a pointer to
341 a structure containing arguments,
342 optionally to be used by the http connect/disconnect callback function.
343 B<arg> is not consumed, and it must therefore explicitly be freed when not
344 needed any more. B<arg> may be NULL to clear the entry.
345
346 OSSL_CMP_CTX_get_http_cb_arg() gets the argument, respectively the pointer to a
347 structure containing arguments, previously set by
348 OSSL_CMP_CTX_set_http_cb_arg() or NULL if unset.
349
350 OSSL_CMP_CTX_set_transfer_cb() sets the message transfer callback function,
351 which has the type
352
353  typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t) (OSSL_CMP_CTX *ctx,
354                                                   const OSSL_CMP_MSG *req);
355
356 Returns 1 on success, 0 on error.
357
358 Default is NULL, which implies the use of L<OSSL_CMP_MSG_http_perform(3)>.
359 The callback should send the CMP request message it obtains via the B<req>
360 parameter and on success return the response, else it must return NULL.
361 The transfer callback may make use of a custom defined argument stored in
362 the ctx by means of OSSL_CMP_CTX_set_transfer_cb_arg(), which may be retrieved
363 again through OSSL_CMP_CTX_get_transfer_cb_arg().
364
365 OSSL_CMP_CTX_set_transfer_cb_arg() sets an argument, respectively a pointer to a
366 structure containing arguments, optionally to be used by the transfer callback.
367 B<arg> is not consumed, and it must therefore explicitly be freed when not
368 needed any more. B<arg> may be NULL to clear the entry.
369
370 OSSL_CMP_CTX_get_transfer_cb_arg() gets the argument, respectively the pointer
371 to a structure containing arguments, previously set by
372 OSSL_CMP_CTX_set_transfer_cb_arg() or NULL if unset.
373
374 OSSL_CMP_CTX_set1_srvCert() pins the given server certificate B<srvCert>
375 directly trusts it (even if it is expired) for verifying response messages.
376 The B<cert> argument may be NULL to clear the entry.
377
378 OSSL_CMP_CTX_set1_expected_sender() sets the Distinguished Name (DN) expected to
379 be given in the sender response for messages protected with MSG_SIG_ALG. This
380 may be used to enforce that during validation of received messages the given DN
381 matches the sender field of the PKIMessage header, which in turn is used to
382 identify the server certificate.
383 This can be used to ensure that only a particular entity is accepted to act as
384 CMP server, and attackers are not able to use arbitrary certificates of a
385 trusted PKI hierarchy to fraudulently pose as server.
386 This defaults to the subject of the B<srvCert>, if any.
387
388 OSSL_CMP_CTX_set0_trustedStore() sets the X509_STORE type certificate store
389 containing trusted (root) CA certificates. The certificate store may also hold
390 CRLs and a certificate verification callback function used for CMP server
391 authentication. Any already existing store entry is freed. When given a NULL
392 parameter the entry is cleared.
393
394 OSSL_CMP_CTX_get0_trustedStore() returns a pointer to the certificate store
395 containing trusted root CA certificates, which may be empty if unset.
396
397 OSSL_CMP_CTX_set1_untrusted_certs() takes over a list of certificates containing
398 non-trusted intermediate certs used for path construction in authentication
399 of the CMP server and potentially others (TLS server, newly enrolled cert).
400 The reference counts of those certificates handled successfully are increased.
401
402 OSSL_CMP_CTX_get0_untrusted_certs(OSSL_CMP_CTX *ctx) returns a pointer to the
403 list of untrusted certs, which my be empty if unset.
404
405 OSSL_CMP_CTX_set1_clCert() sets the client certificate in the given B<ctx>.
406 The public key of this B<clCert> must correspond to
407 the private key set via B<OSSL_CMP_CTX_set1_pkey()>.
408 When using signature-based protection of CMP request messages
409 this "protection certificate" will be included first in the extraCerts field.
410 The subject of this B<clCert> will be used as the "sender" field
411 of outgoing CMP messages, with the fallback being
412 the B<subjectName> set via B<OSSL_CMP_CTX_set1_subjectName()>.
413 The B<cert> argument may be NULL to clear the entry.
414
415 OSSL_CMP_CTX_set1_pkey() sets the private key corresponding to
416 the client certificate B<clCert> set via B<OSSL_CMP_CTX_set1_clCert()>.
417 This key is used create signature-based protection (protectionAlg = MSG_SIG_ALG)
418 of outgoing messages
419 unless a PBM secret has been set via  B<OSSL_CMP_CTX_set1_secretValue()>.
420 The B<pkey> argument may be NULL to clear the entry.
421
422 OSSL_CMP_CTX_set1_secretValue() sets the byte string B<sec> with length B<len>
423 as PBM secret in the given B<ctx> or clears it if the B<sec> argument is NULL.
424 If present, this secret is used to create PBM-based protection of outgoing
425 messages and to verify any PBM-based protection of incoming messages
426 (protectionAlg = MSG_MAC_ALG). PBM stands for Password-Based MAC.
427 PBM-based protection takes precedence over signature-based protection.
428
429 OSSL_CMP_CTX_set1_referenceValue() sets the given referenceValue B<ref> with
430 length B<len> in the given B<ctx> or clears it if the B<ref> argument is NULL.
431 According to RFC 4210 section 5.1.1, if no value for the "sender" field in
432 CMP message headers can be determined (i.e., no B<clCert> and no B<subjectName>
433 is given) then the "sender" field will contain the NULL-DN
434 and the senderKID field of the CMP message header must be set.
435 When signature-based protection is used the senderKID will be set to
436 the subjectKeyIdentifier of the <clCert> as far as present.
437 If not present or when PBM-based protection is used
438 the B<ref> value is taken as the fallback value for the senderKID.
439
440 OSSL_CMP_CTX_set1_recipient() sets the recipient name that will be used in the
441 PKIHeader of a request message, i.e. the X509 name of the (CA) server.
442 Setting is overruled by subject of B<srvCert> if set.
443 If neither B<srvCert> nor recipient are set, the recipient of the PKI message is
444 determined in the following order: issuer, issuer of old cert (oldCert),
445 issuer of client cert (B<clCert>), else NULL-DN.
446 When a response is received, its sender must match the recipient of the request.
447
448 OSSL_CMP_CTX_push0_geninfo_ITAV() adds B<itav> to the stack in the B<ctx> to be
449 added to the GeneralInfo field of the CMP PKIMessage header of a request
450 message sent with this context.
451
452 OSSL_CMP_CTX_set1_extraCertsOut() sets the stack of extraCerts that will be
453 sent to remote.
454
455 OSSL_CMP_CTX_set0_newPkey() can be used to explicitly set the given EVP_PKEY
456 structure as the private or public key to be certified in the CMP context.
457 The B<priv> parameter must be 0 if and only if the given key is a public key.
458
459 OSSL_CMP_CTX_get0_newPkey() gives the key to use for certificate enrollment
460 dependent on fields of the CMP context structure:
461 the newPkey (which may be a private or public key) if present,
462 else the public key in the p10CSR if present, else the client private key.
463 If the B<priv> parameter is not 0 and the selected key does not have a
464 private component then NULL is returned.
465
466 OSSL_CMP_CTX_set1_issuer() sets the name of the intended issuer that
467 will be set in the CertTemplate, i.e., the X509 name of the CA server.
468
469 OSSL_CMP_CTX_set1_subjectName() sets the subject DN that will be used in
470 the CertTemplate structure when requesting a new cert. For Key Update Requests
471 (KUR), it defaults to the subject DN of the B<reference certificate>,
472 see B<OSSL_CMP_CTX_set1_oldCert()>. This default is used for Initialization
473 Requests (IR) and Certification Requests (CR) only if no SANs are set.
474 The B<subjectName> is also used as the "sender" field for outgoing CMP messages
475 if no B<clCert> has been set (e.g., in case requests are protected using PBM).
476
477 OSSL_CMP_CTX_push1_subjectAltName() adds the given X509 name to the list of
478 alternate names on the certificate template request. This cannot be used if
479 any Subject Alternative Name extension is set via
480 OSSL_CMP_CTX_set0_reqExtensions().
481 By default, unless OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT has been set,
482 the Subject Alternative Names are copied from the B<reference certificate>,
483 see B<OSSL_CMP_CTX_set1_oldCert()>.
484 If set and the subject DN is not set with OSSL_CMP_CTX_set1_subjectName(), then
485 the certificate template of an IR and CR will not be filled with the default
486 subject DN from the B<reference certificate>.
487 If a subject DN is desired it needs to be set explicitly with
488 OSSL_CMP_CTX_set1_subjectName().
489
490 OSSL_CMP_CTX_set0_reqExtensions() sets the X.509v3 extensions to be used in
491 IR/CR/KUR.
492
493 OSSL_CMP_CTX_reqExtensions_have_SAN() returns 1 if the context contains
494 a Subject Alternative Name extension, else 0 or -1 on error.
495
496 OSSL_CMP_CTX_push0_policy() adds the certificate policy info object
497 to the X509_EXTENSIONS of the requested certificate template.
498
499 OSSL_CMP_CTX_set1_oldCert() sets the old certificate to be updated in
500 Key Update Requests (KUR) or to be revoked in Revocation Requests (RR).
501 It must be given for RR, else it defaults to B<clCert>.
502 The B<reference certificate> determined in this way, if any, is also used for
503 deriving default subject DN and Subject Alternative Names for IR, CR, and KUR.
504 Its issuer, if any, is used as default recipient in the CMP message header.
505
506 OSSL_CMP_CTX_set1_p10CSR() sets the PKCS#10 CSR to be used in P10CR.
507
508 OSSL_CMP_CTX_push0_genm_ITAV() adds B<itav> to the stack in the B<ctx> which
509 will be the body of a General Message sent with this context.
510
511 OSSL_CMP_CTX_set_certConf_cb() sets the callback used for evaluating the newly
512 enrolled certificate before the library sends, depending on its result,
513 a positive or negative certConf message to the server. The callback has type
514
515  typedef int (*OSSL_CMP_certConf_cb_t) (OSSL_CMP_CTX *ctx, X509 *cert,
516                                         int fail_info, const char **txt);
517
518 and should inspect the certificate it obtains via the B<cert> parameter and may
519 overrule the pre-decision given in the B<fail_info> and B<*txt> parameters.
520 If it accepts the certificate it must return 0, indicating success. Else it must
521 return a bit field reflecting PKIFailureInfo with at least one failure bit and
522 may set the B<*txt> output parameter to point to a string constant with more
523 detail.  The transfer callback may make use of a custom defined argument stored
524 in the B<ctx> by means of OSSL_CMP_CTX_set_certConf_cb_arg(), which may be
525 retrieved again through OSSL_CMP_CTX_get_certConf_cb_arg().
526 Typically, the callback will check at least that the certificate can be verified
527 using a set of trusted certificates.
528 It also could compare the subject DN and other fields of the newly
529 enrolled certificate with the certificate template of the request.
530
531 OSSL_CMP_CTX_set_certConf_cb_arg() sets an argument, respectively a pointer to a
532 structure containing arguments, optionally to be used by the certConf callback.
533 B<arg> is not consumed, and it must therefore explicitly be freed when not
534 needed any more. B<arg> may be NULL to clear the entry.
535
536 OSSL_CMP_CTX_get_certConf_cb_arg() gets the argument, respectively the pointer
537 to a structure containing arguments, previously set by
538 OSSL_CMP_CTX_set_certConf_cb_arg(), or NULL if unset.
539
540 OSSL_CMP_CTX_get_status() returns the PKIstatus from the last received
541 CertRepMessage or Revocation Response or error message, or -1 if unset.
542
543 OSSL_CMP_CTX_get0_statusString() returns the statusString from the last received
544 CertRepMessage or Revocation Response or error message, or NULL if unset.
545
546 OSSL_CMP_CTX_get_failInfoCode() returns the error code from the failInfo field
547 of the last received CertRepMessage or Revocation Response or error message.
548 This is a bit field and the flags for it are specified in the header file
549 F<< <openssl/cmp.h> >>.
550 The flags start with OSSL_CMP_CTX_FAILINFO, for example:
551 OSSL_CMP_CTX_FAILINFO_badAlg. Returns -1 if the failInfoCode field is unset.
552
553 OSSL_CMP_CTX_get0_newCert() returns the pointer to the newly obtained
554 certificate in case it is available, else NULL.
555
556 OSSL_CMP_CTX_get1_caPubs() returns a pointer to a duplicate of the stack of
557 X.509 certificates received in the caPubs field of last received certificate
558 response message IP/CP/KUP.
559
560 OSSL_CMP_CTX_get1_extraCertsIn() returns a pointer to a duplicate of the stack
561 of X.509 certificates received in the last received non-empty extraCerts field.
562 Returns an empty stack if no extraCerts have been received in the current
563 transaction.
564
565 OSSL_CMP_CTX_set1_transactionID() sets the given transaction ID in the given
566 OSSL_CMP_CTX structure.
567
568 OSSL_CMP_CTX_set1_senderNonce() stores the last sent sender B<nonce> in
569 the B<ctx>. This will be used to validate the recipNonce in incoming messages.
570
571 =head1 NOTES
572
573 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
574
575 =head1 RETURN VALUES
576
577 OSSL_CMP_CTX_free() and OSSL_CMP_CTX_print_errors() do not return anything.
578
579 OSSL_CMP_CTX_new(),
580 OSSL_CMP_CTX_get_http_cb_arg(),
581 OSSL_CMP_CTX_get_transfer_cb_arg(),
582 OSSL_CMP_CTX_get0_trustedStore(),
583 OSSL_CMP_CTX_get0_untrusted_certs(),
584 OSSL_CMP_CTX_get0_newPkey(),
585 OSSL_CMP_CTX_get_certConf_cb_arg(),
586 OSSL_CMP_CTX_get0_statusString(),
587 OSSL_CMP_CTX_get0_newCert(),
588 OSSL_CMP_CTX_get1_caPubs(), and
589 OSSL_CMP_CTX_get1_extraCertsIn()
590 return the intended pointer value as described above or NULL on error.
591
592 OSSL_CMP_CTX_get_option(),
593 OSSL_CMP_CTX_reqExtensions_have_SAN(),
594 OSSL_CMP_CTX_get_status(), and
595 OSSL_CMP_CTX_get_failInfoCode()
596 return the intended value as described above or -1 on error.
597
598 All other functions return 1 on success, 0 on error.
599
600 =head1 EXAMPLES
601
602 The following code does an Initialization Request:
603
604         cmp_ctx = OSSL_CMP_CTX_new();
605         OSSL_CMP_CTX_set1_serverName(cmp_ctx, opt_serverName);
606         OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, ref, ref_len);
607         OSSL_CMP_CTX_set1_secretValue(cmp_ctx, sec, sec_len);
608         OSSL_CMP_CTX_set0_newPkey(cmp_ctx, new_pkey, 1);
609         OSSL_CMP_CTX_set1_caCert(cmp_ctx, ca_cert);
610
611         initialClCert = OSSL_CMP_exec_IR_ses(cmp_ctx);
612
613 The following code does an Initialization Request using an
614 external identity certificate (RFC 4210, Appendix E.7):
615
616         cmp_ctx = OSSL_CMP_CTX_new();
617         OSSL_CMP_CTX_set1_serverName(cmp_ctx, sname);
618         OSSL_CMP_CTX_set1_clCert(cmp_ctx, cl_cert);
619         OSSL_CMP_CTX_set1_pkey(cmp_ctx, pkey);
620         OSSL_CMP_CTX_set0_newPkey(cmp_ctx, new_pkey, 1);
621         OSSL_CMP_CTX_set1_caCert(cmp_ctx, ca_cert);
622
623         initialClCert = OSSL_CMP_exec_IR_ses(cmp_ctx);
624
625 Here externalCert is an X509 certificate granted to the EE by another CA
626 which is trusted by the current CA the code will connect to.
627
628
629 The following code does a Key Update Request:
630
631         cmp_ctx = OSSL_CMP_CTX_new();
632         OSSL_CMP_CTX_set1_serverName(cmp_ctx, sname);
633         OSSL_CMP_CTX_set1_pkey(cmp_ctx, pkey);
634         OSSL_CMP_CTX_set0_newPkey(cmp_ctx, new_pkey, 1);
635         OSSL_CMP_CTX_set1_clCert(cmp_ctx, cl_cert);
636         OSSL_CMP_CTX_set1_caCert(cmp_ctx, ca_cert);
637
638         updatedClCert = OSSL_CMP_exec_KUR_ses(cmp_ctx);
639
640 The following code (which omits error handling) sends a General Message
641 including, as an example, the id-it-signKeyPairTypes OID and prints info on
642 the General Response contents.
643
644     cmp_ctx = OSSL_CMP_CTX_new();
645     OSSL_CMP_CTX_set1_serverName(cmp_ctx, sname);
646     OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, ref, ref_len);
647     OSSL_CMP_CTX_set1_secretValue(cmp_ctx, sec, sec_len);
648
649     ASN1_OBJECT *type = OBJ_txt2obj("1.3.6.1.5.5.7.4.2", 1);
650     OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_new(type, NULL);
651     OSSL_CMP_CTX_push0_genm_ITAV(cmp_ctx, itav);
652
653     STACK_OF(OSSL_CMP_ITAV) *itavs;
654     itavs = OSSL_CMP_exec_GENM_ses(cmp_ctx);
655     print_itavs(itavs);
656     sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
657
658 =head1 SEE ALSO
659
660 L<OSSL_CMP_exec_IR_ses(3)>, L<OSSL_CMP_exec_KUR_ses(3)>,
661 L<OSSL_CMP_exec_GENM_ses(3)>
662
663 =head1 HISTORY
664
665 The OpenSSL CMP support was added in OpenSSL 3.0.
666
667 =head1 COPYRIGHT
668
669 Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
670
671 Licensed under the Apache License 2.0 (the "License").  You may not use
672 this file except in compliance with the License.  You can obtain a copy
673 in the file LICENSE in the source distribution or at
674 L<https://www.openssl.org/source/license.html>.
675
676 =cut