Debian Codegraph @

upstream/debian-unstable/man3/OSSL_CMP_STATUSINFO_new.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_CMP_STATUSINFO_NEW 3SSL"
58 .TH OSSL_CMP_STATUSINFO_NEW 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_CMP_STATUSINFO_new,
65 OSSL_CMP_snprint_PKIStatusInfo,
66 OSSL_CMP_CTX_snprint_PKIStatus
67 \&\- function(s) for managing the CMP PKIStatus
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& #include <openssl/cmp.h>
72 \&
73 \& OSSL_CMP_PKISI *OSSL_CMP_STATUSINFO_new(int status, int fail_info,
74 \& const char *text);
75 \& char *OSSL_CMP_snprint_PKIStatusInfo(const OSSL_CMP_PKISI *statusInfo,
76 \& char *buf, size_t bufsize);
77 \& char *OSSL_CMP_CTX_snprint_PKIStatus(const OSSL_CMP_CTX *ctx, char *buf,
78 \& size_t bufsize);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 This is the PKIStatus API for using CMP (Certificate Management Protocol) with
83 OpenSSL.
84 .PP
85 \&\fBOSSL_CMP_STATUSINFO_new()\fR creates a new PKIStatusInfo structure
86 and fills in the given values.
87 It sets the status field to \fIstatus\fR,
88 copies \fItext\fR (unless it is NULL) to statusString,
89 and interprets \fIfail_info\fR as bit pattern for the failInfo field.
90 .PP
91 \&\fBOSSL_CMP_snprint_PKIStatusInfo()\fR places a human-readable string
92 representing the given statusInfo
93 in the given buffer, with the given maximal length.
94 .PP
95 \&\fBOSSL_CMP_CTX_snprint_PKIStatus()\fR places a human-readable string
96 representing the PKIStatusInfo components of the CMP context \fIctx\fR
97 in the given buffer, with the given maximal length.
98 .SH NOTES
99 .IX Header "NOTES"
100 CMP is defined in RFC 9810.
101 .SH "RETURN VALUES"
102 .IX Header "RETURN VALUES"
103 \&\fBOSSL_CMP_STATUSINFO_new()\fR
104 returns a pointer to the structure on success, or NULL on error.
105 .PP
106 \&\fBOSSL_CMP_snprint_PKIStatusInfo()\fR and
107 \&\fBOSSL_CMP_CTX_snprint_PKIStatus()\fR
108 return a copy of the buffer pointer containing the string or NULL on error.
109 .SH HISTORY
110 .IX Header "HISTORY"
111 The OpenSSL CMP support was added in OpenSSL 3.0.
112 .SH COPYRIGHT
113 .IX Header "COPYRIGHT"
114 Copyright 2007\-2021 The OpenSSL Project Authors. All Rights Reserved.
115 .PP
116 Licensed under the Apache License 2.0 (the "License"). You may not use
117 this file except in compliance with the License. You can obtain a copy
118 in the file LICENSE in the source distribution or at
119 <https://www.openssl.org/source/license.html>.