1OSSL_CMP_STATUSINFO_NEW(3ossl)      OpenSSL     OSSL_CMP_STATUSINFO_NEW(3ossl)
2
3
4

NAME

6       OSSL_CMP_STATUSINFO_new, OSSL_CMP_snprint_PKIStatusInfo,
7       OSSL_CMP_CTX_snprint_PKIStatus - function(s) for managing the CMP
8       PKIStatus
9

SYNOPSIS

11        #include <openssl/cmp.h>
12
13        OSSL_CMP_PKISI *OSSL_CMP_STATUSINFO_new(int status, int fail_info,
14                                                const char *text);
15        char *OSSL_CMP_snprint_PKIStatusInfo(const OSSL_CMP_PKISI *statusInfo,
16                                             char *buf, size_t bufsize);
17        char *OSSL_CMP_CTX_snprint_PKIStatus(const OSSL_CMP_CTX *ctx, char *buf,
18                                             size_t bufsize);
19

DESCRIPTION

21       This is the PKIStatus API for using CMP (Certificate Management
22       Protocol) with OpenSSL.
23
24       OSSL_CMP_STATUSINFO_new() creates a new PKIStatusInfo structure and
25       fills in the given values.  It sets the status field to status, copies
26       text (unless it is NULL) to statusString, and interprets fail_info as
27       bit pattern for the failInfo field.
28
29       OSSL_CMP_snprint_PKIStatusInfo() places a human-readable string
30       representing the given statusInfo in the given buffer, with the given
31       maximal length.
32
33       OSSL_CMP_CTX_snprint_PKIStatus() places a human-readable string
34       representing the PKIStatusInfo components of the CMP context ctx in the
35       given buffer, with the given maximal length.
36

NOTES

38       CMP is defined in RFC 4210 (and CRMF in RFC 4211).
39

RETURN VALUES

41       OSSL_CMP_STATUSINFO_new() returns a pointer to the structure on
42       success, or NULL on error.
43
44       OSSL_CMP_snprint_PKIStatusInfo() and OSSL_CMP_CTX_snprint_PKIStatus()
45       return a copy of the buffer pointer containing the string or NULL on
46       error.
47

HISTORY

49       The OpenSSL CMP support was added in OpenSSL 3.0.
50

52       Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
53
54       Licensed under the Apache License 2.0 (the "License").  You may not use
55       this file except in compliance with the License.  You can obtain a copy
56       in the file LICENSE in the source distribution or at
57       <https://www.openssl.org/source/license.html>.
58
59
60
613.1.1                             2023-08-31    OSSL_CMP_STATUSINFO_NEW(3ossl)
Impressum