OSSL_CMP_CTX_new.pod 39 KB

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