1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre Proncheryossl_cmp_mock_srv_new,
6*b077aed3SPierre Proncheryossl_cmp_mock_srv_free,
7*b077aed3SPierre Proncheryossl_cmp_mock_srv_set1_certOut,
8*b077aed3SPierre Proncheryossl_cmp_mock_srv_set1_chainOut,
9*b077aed3SPierre Proncheryossl_cmp_mock_srv_set1_caPubsOut,
10*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_statusInfo,
11*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_sendError,
12*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_pollCount,
13*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_checkAfterTime
14*b077aed3SPierre Pronchery- functions used for testing with CMP mock server
15*b077aed3SPierre Pronchery
16*b077aed3SPierre Pronchery=head1 SYNOPSIS
17*b077aed3SPierre Pronchery
18*b077aed3SPierre Pronchery #include "apps/cmp_mock_srv.h"
19*b077aed3SPierre Pronchery
20*b077aed3SPierre Pronchery OSSL_CMP_SRV_CTX *ossl_cmp_mock_srv_new(OSSL_LIB_CTX *libctx, const char *propq);
21*b077aed3SPierre Pronchery void ossl_cmp_mock_srv_free(OSSL_CMP_SRV_CTX *srv_ctx);
22*b077aed3SPierre Pronchery
23*b077aed3SPierre Pronchery int ossl_cmp_mock_srv_set1_certOut(OSSL_CMP_SRV_CTX *srv_ctx, X509 *cert);
24*b077aed3SPierre Pronchery int ossl_cmp_mock_srv_set1_chainOut(OSSL_CMP_SRV_CTX *srv_ctx,
25*b077aed3SPierre Pronchery                                     STACK_OF(X509) *chain);
26*b077aed3SPierre Pronchery int ossl_cmp_mock_srv_set1_caPubsOut(OSSL_CMP_SRV_CTX *srv_ctx,
27*b077aed3SPierre Pronchery                                      STACK_OF(X509) *caPubs);
28*b077aed3SPierre Pronchery int ossl_cmp_mock_srv_set_statusInfo(OSSL_CMP_SRV_CTX *srv_ctx, int status,
29*b077aed3SPierre Pronchery                                      int fail_info, const char *text);
30*b077aed3SPierre Pronchery int ossl_cmp_mock_srv_set_sendError(OSSL_CMP_SRV_CTX *srv_ctx, int bodytype);
31*b077aed3SPierre Pronchery int ossl_cmp_mock_srv_set_pollCount(OSSL_CMP_SRV_CTX *srv_ctx, int count);
32*b077aed3SPierre Pronchery int ossl_cmp_mock_srv_set_checkAfterTime(OSSL_CMP_SRV_CTX *srv_ctx, int sec);
33*b077aed3SPierre Pronchery
34*b077aed3SPierre Pronchery=head1 DESCRIPTION
35*b077aed3SPierre Pronchery
36*b077aed3SPierre Proncheryossl_cmp_mock_srv_new() allocates the contexts for the CMP mock server
37*b077aed3SPierre Proncheryassociated with the library context I<libctx> and property query string
38*b077aed3SPierre ProncheryI<propq>, both of which may be NULL to select the defaults.
39*b077aed3SPierre Pronchery
40*b077aed3SPierre Proncheryossl_cmp_mock_srv_free() deallocates the contexts for the CMP mock server.
41*b077aed3SPierre Pronchery
42*b077aed3SPierre Proncheryossl_cmp_mock_srv_set1_certOut() sets the certificate to be returned in
43*b077aed3SPierre Proncherycp/ip/kup.
44*b077aed3SPierre Pronchery
45*b077aed3SPierre Proncheryossl_cmp_mock_srv_set1_chainOut() sets the certificate chain to be added to
46*b077aed3SPierre Proncherythe extraCerts in a cp/ip/kup.
47*b077aed3SPierre ProncheryIt should be useful for the validation of the certificate given via
48*b077aed3SPierre Proncheryossl_cmp_mock_srv_set1_certOut().
49*b077aed3SPierre Pronchery
50*b077aed3SPierre Proncheryossl_cmp_mock_srv_set1_caPubsOut() sets the caPubs to be returned in an ip.
51*b077aed3SPierre Pronchery
52*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_statusInfo() sets the status info to be returned.
53*b077aed3SPierre Pronchery
54*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_sendError() enables enforcement of error responses
55*b077aed3SPierre Proncheryfor requests of the given I<bodytype>, or for all requests if I<bodytype> is 1.
56*b077aed3SPierre ProncheryA I<bodytype> of -1 can be used to disable this feature, which is the default.
57*b077aed3SPierre Pronchery
58*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_pollCount() sets the number of polls before cert response.
59*b077aed3SPierre Pronchery
60*b077aed3SPierre Proncheryossl_cmp_mock_srv_set_checkAfterTime() sets the number of seconds
61*b077aed3SPierre Proncherythe client should wait for the next poll.
62*b077aed3SPierre Pronchery
63*b077aed3SPierre Pronchery=head1 NOTES
64*b077aed3SPierre Pronchery
65*b077aed3SPierre ProncheryCMP is defined in RFC 4210 (and CRMF in RFC 4211).
66*b077aed3SPierre Pronchery
67*b077aed3SPierre Pronchery=head1 RETURN VALUES
68*b077aed3SPierre Pronchery
69*b077aed3SPierre Proncheryossl_cmp_mock_srv() returns a B<OSSL_CMP_SRV_CTX> structure on success,
70*b077aed3SPierre ProncheryNULL on error.
71*b077aed3SPierre Pronchery
72*b077aed3SPierre Proncheryossl_cmp_mock_srv_free() does not return a value.
73*b077aed3SPierre Pronchery
74*b077aed3SPierre ProncheryAll other functions return 1 on success, 0 on error.
75*b077aed3SPierre Pronchery
76*b077aed3SPierre Pronchery=head1 HISTORY
77*b077aed3SPierre Pronchery
78*b077aed3SPierre ProncheryThe OpenSSL CMP support was added in OpenSSL 3.0.
79*b077aed3SPierre Pronchery
80*b077aed3SPierre Pronchery=head1 COPYRIGHT
81*b077aed3SPierre Pronchery
82*b077aed3SPierre ProncheryCopyright 2007-2023 The OpenSSL Project Authors. All Rights Reserved.
83*b077aed3SPierre Pronchery
84*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
85*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
86*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
87*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
88*b077aed3SPierre Pronchery
89*b077aed3SPierre Pronchery=cut
90