]>
Commit | Line | Data |
---|---|---|
4dde554c DDO |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
62dcd2aa DDO |
5 | ossl_cmp_pkisi_get_status, |
6 | ossl_cmp_PKIStatus_to_string, | |
7 | ossl_cmp_pkisi_get0_statusString, | |
8 | ossl_cmp_pkisi_get_pkifailureinfo, | |
9 | ossl_cmp_pkisi_check_pkifailureinfo | |
4dde554c DDO |
10 | - functions for managing PKI status information |
11 | ||
12 | =head1 SYNOPSIS | |
13 | ||
14 | #include "cmp.h" | |
15 | ||
16 | # define OSSL_CMP_PKIFAILUREINFO_badAlg 0 | |
17 | # define OSSL_CMP_PKIFAILUREINFO_badMessageCheck 1 | |
18 | # define OSSL_CMP_PKIFAILUREINFO_badRequest 2 | |
19 | # define OSSL_CMP_PKIFAILUREINFO_badTime 3 | |
20 | # define OSSL_CMP_PKIFAILUREINFO_badCertId 4 | |
21 | # define OSSL_CMP_PKIFAILUREINFO_badDataFormat 5 | |
22 | # define OSSL_CMP_PKIFAILUREINFO_wrongAuthority 6 | |
23 | # define OSSL_CMP_PKIFAILUREINFO_incorrectData 7 | |
24 | # define OSSL_CMP_PKIFAILUREINFO_missingTimeStamp 8 | |
25 | # define OSSL_CMP_PKIFAILUREINFO_badPOP 9 | |
26 | # define OSSL_CMP_PKIFAILUREINFO_certRevoked 10 | |
27 | # define OSSL_CMP_PKIFAILUREINFO_certConfirmed 11 | |
28 | # define OSSL_CMP_PKIFAILUREINFO_wrongIntegrity 12 | |
29 | # define OSSL_CMP_PKIFAILUREINFO_badRecipientNonce 13 | |
30 | # define OSSL_CMP_PKIFAILUREINFO_timeNotAvailable 14 | |
31 | # define OSSL_CMP_PKIFAILUREINFO_unacceptedPolicy 15 | |
32 | # define OSSL_CMP_PKIFAILUREINFO_unacceptedExtension 16 | |
33 | # define OSSL_CMP_PKIFAILUREINFO_addInfoNotAvailable 17 | |
34 | # define OSSL_CMP_PKIFAILUREINFO_badSenderNonce 18 | |
35 | # define OSSL_CMP_PKIFAILUREINFO_badCertTemplate 19 | |
36 | # define OSSL_CMP_PKIFAILUREINFO_signerNotTrusted 20 | |
37 | # define OSSL_CMP_PKIFAILUREINFO_transactionIdInUse 21 | |
38 | # define OSSL_CMP_PKIFAILUREINFO_unsupportedVersion 22 | |
39 | # define OSSL_CMP_PKIFAILUREINFO_notAuthorized 23 | |
40 | # define OSSL_CMP_PKIFAILUREINFO_systemUnavail 24 | |
41 | # define OSSL_CMP_PKIFAILUREINFO_systemFailure 25 | |
42 | # define OSSL_CMP_PKIFAILUREINFO_duplicateCertReq 26 | |
43 | # define OSSL_CMP_PKIFAILUREINFO_MAX 26 | |
44 | ||
62dcd2aa DDO |
45 | int ossl_cmp_pkisi_get_status(const OSSL_CMP_PKISI *si); |
46 | const char *ossl_cmp_PKIStatus_to_string(int status); | |
47 | OSSL_CMP_PKIFREETEXT *ossl_cmp_pkisi_get0_statusString(const OSSL_CMP_PKISI *si); | |
48 | int ossl_cmp_pkisi_get_pkifailureinfo(const OSSL_CMP_PKISI *si); | |
49 | int ossl_cmp_pkisi_check_pkifailureinfo(const OSSL_CMP_PKISI *si, int index); | |
4dde554c DDO |
50 | |
51 | =head1 DESCRIPTION | |
52 | ||
62dcd2aa | 53 | ossl_cmp_pkisi_get_status() returns the PKIStatus of B<si>, or -1 on error. |
4dde554c | 54 | |
62dcd2aa DDO |
55 | ossl_cmp_PKIStatus_to_string() returns a human-readable string representing |
56 | the PKIStatus values as specified in RFC 4210, Appendix F. | |
4dde554c | 57 | |
62dcd2aa | 58 | ossl_cmp_pkisi_get0_statusString() returns a direct pointer to the statusString |
4dde554c DDO |
59 | field contained in B<si>. |
60 | ||
62dcd2aa DDO |
61 | ossl_cmp_pkisi_get_pkifailureinfo() returns the PKIFailureInfo bits |
62 | of B<si>, encoded as integer, or -1 on error. | |
63 | ||
64 | ossl_cmp_pkisi_check_pkifailureinfo() returns the state of the bit (0 or 1) | |
65 | with index B<index> in the PKIFailureInfo of the B<si>, or -1 on error. | |
4dde554c DDO |
66 | |
67 | =head1 NOTES | |
68 | ||
69 | CMP is defined in RFC 4210 (and CRMF in RFC 4211). | |
70 | ||
71 | =head1 RETURN VALUES | |
72 | ||
73 | See the individual functions above. | |
74 | ||
75 | =head1 SEE ALSO | |
76 | ||
fadb57e5 | 77 | L<OSSL_CMP_CTX_new(3)>, L<ossl_cmp_certReq_new(3)> |
4dde554c DDO |
78 | |
79 | =head1 HISTORY | |
80 | ||
81 | The OpenSSL CMP support was added in OpenSSL 3.0. | |
82 | ||
83 | =head1 COPYRIGHT | |
84 | ||
33388b44 | 85 | Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved. |
4dde554c DDO |
86 | |
87 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
88 | this file except in compliance with the License. You can obtain a copy | |
89 | in the file LICENSE in the source distribution or at | |
90 | L<https://www.openssl.org/source/license.html>. | |
91 | ||
92 | =cut |