1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre Proncheryossl_cmp_ctx_set1_caPubs,
6*b077aed3SPierre Proncheryossl_cmp_ctx_set0_validatedSrvCert,
7*b077aed3SPierre Proncheryossl_cmp_ctx_set_status,
8*b077aed3SPierre Proncheryossl_cmp_ctx_set0_statusString,
9*b077aed3SPierre Proncheryossl_cmp_ctx_set_failInfoCode,
10*b077aed3SPierre Proncheryossl_cmp_ctx_set0_newCert,
11*b077aed3SPierre Proncheryossl_cmp_ctx_set1_extraCertsIn,
12*b077aed3SPierre Proncheryossl_cmp_ctx_set1_recipNonce
13*b077aed3SPierre Pronchery- internal functions for managing the CMP client context datastructure
14*b077aed3SPierre Pronchery
15*b077aed3SPierre Pronchery=head1 SYNOPSIS
16*b077aed3SPierre Pronchery
17*b077aed3SPierre Pronchery #include <openssl/cmp.h>
18*b077aed3SPierre Pronchery
19*b077aed3SPierre Pronchery int ossl_cmp_ctx_set1_caPubs(OSSL_CMP_CTX *ctx, STACK_OF(X509) *caPubs);
20*b077aed3SPierre Pronchery int ossl_cmp_ctx_set0_validatedSrvCert(OSSL_CMP_CTX *ctx, X509 *cert);
21*b077aed3SPierre Pronchery int ossl_cmp_ctx_set_status(OSSL_CMP_CTX *ctx, int status);
22*b077aed3SPierre Pronchery int ossl_cmp_ctx_set0_statusString(OSSL_CMP_CTX *ctx,
23*b077aed3SPierre Pronchery                                    OSSL_CMP_PKIFREETEXT *text);
24*b077aed3SPierre Pronchery int ossl_cmp_ctx_set_failInfoCode(OSSL_CMP_CTX *ctx, int fail_info);
25*b077aed3SPierre Pronchery int ossl_cmp_ctx_set0_newCert(OSSL_CMP_CTX *ctx, X509 *cert);
26*b077aed3SPierre Pronchery int ossl_cmp_ctx_set1_extraCertsIn(OSSL_CMP_CTX *ctx,
27*b077aed3SPierre Pronchery                                    STACK_OF(X509) *extraCertsIn);
28*b077aed3SPierre Pronchery int ossl_cmp_ctx_set1_recipNonce(OSSL_CMP_CTX *ctx,
29*b077aed3SPierre Pronchery                                  const ASN1_OCTET_STRING *nonce);
30*b077aed3SPierre Pronchery
31*b077aed3SPierre Pronchery=head1 DESCRIPTION
32*b077aed3SPierre Pronchery
33*b077aed3SPierre Proncheryossl_cmp_ctx_set1_caPubs() copies the given stack of CA certificates
34*b077aed3SPierre Proncheryto the caPubs field of the context.
35*b077aed3SPierre ProncheryThe reference counts of those certificates handled successfully are increased.
36*b077aed3SPierre Pronchery
37*b077aed3SPierre Proncheryossl_cmp_ctx_set0_validatedSrvCert() sets the validatedSrvCert of the context,
38*b077aed3SPierre Proncherywhich caches any already validated server cert, or NULL if not available.
39*b077aed3SPierre Pronchery
40*b077aed3SPierre Proncheryossl_cmp_ctx_set_status() sets the status field of the context.
41*b077aed3SPierre Pronchery
42*b077aed3SPierre Proncheryossl_cmp_ctx_set0_statusString() sets the statusString field of the context.
43*b077aed3SPierre Pronchery
44*b077aed3SPierre Proncheryossl_cmp_ctx_set_failInfoCode() sets the error code bits in the failInfoCode
45*b077aed3SPierre Proncheryfield of the context based on the given OSSL_CMP_PKIFAILUREINFO structure.
46*b077aed3SPierre Pronchery
47*b077aed3SPierre Proncheryossl_cmp_ctx_set0_newCert() sets the given (newly enrolled) certificate
48*b077aed3SPierre Proncheryin the context.
49*b077aed3SPierre Pronchery
50*b077aed3SPierre Proncheryossl_cmp_ctx_set1_extraCertsIn() sets the extraCertsIn field of the context.
51*b077aed3SPierre ProncheryThe reference counts of those certificates handled successfully are increased.
52*b077aed3SPierre Pronchery
53*b077aed3SPierre Proncheryossl_cmp_ctx_set1_recipNonce() sets the given recipient nonce in the context.
54*b077aed3SPierre Pronchery
55*b077aed3SPierre Pronchery=head1 NOTES
56*b077aed3SPierre Pronchery
57*b077aed3SPierre ProncheryCMP is defined in RFC 4210 (and CRMF in RFC 4211).
58*b077aed3SPierre Pronchery
59*b077aed3SPierre Pronchery=head1 RETURN VALUES
60*b077aed3SPierre Pronchery
61*b077aed3SPierre ProncheryAll functions return 1 on success, 0 on error.
62*b077aed3SPierre Pronchery
63*b077aed3SPierre Pronchery=head1 HISTORY
64*b077aed3SPierre Pronchery
65*b077aed3SPierre ProncheryThe OpenSSL CMP support was added in OpenSSL 3.0.
66*b077aed3SPierre Pronchery
67*b077aed3SPierre Pronchery=head1 COPYRIGHT
68*b077aed3SPierre Pronchery
69*b077aed3SPierre ProncheryCopyright 2007-2018 The OpenSSL Project Authors. All Rights Reserved.
70*b077aed3SPierre Pronchery
71*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
72*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
73*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
74*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
75*b077aed3SPierre Pronchery
76*b077aed3SPierre Pronchery=cut
77