[thirdparty/openssl.git] / doc / man3 / OSSL_CMP_CTX_snprint_PKIStatus.pod

=pod

=head1 NAME

OSSL_CMP_CTX_snprint_PKIStatus
- function(s) for managing the CMP PKIStatus

=head1 SYNOPSIS

 #include <openssl/cmp.h>

 char *OSSL_CMP_CTX_snprint_PKIStatus(OSSL_CMP_CTX *ctx, char *buf, int bufsize);

=head1 DESCRIPTION

This is the PKIStatus API for using CMP (Certificate Management Protocol) with
OpenSSL.

OSSL_CMP_CTX_snprint_PKIStatus() takes the PKIStatusInfo components contained
in the given CMP context and places a human-readable string created from them
in the given buffer, with the given maximal length.
On success it returns a copy of the buffer pointer containing the string.

=head1 NOTES

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

=head1 RETURN VALUES

OSSL_CMP_CTX_snprint_PKIStatus()
returns the intended pointer value as described above or NULL on error.

=head1 HISTORY

The OpenSSL CMP support was added in OpenSSL 3.0.

=head1 COPYRIGHT

Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
4dde554c DDO	1	=pod
	2
	3	=head1 NAME
	4
	5	OSSL_CMP_CTX_snprint_PKIStatus
	6	- function(s) for managing the CMP PKIStatus
	7
	8	=head1 SYNOPSIS
	9
	10	#include <openssl/cmp.h>
	11
	12	char OSSL_CMP_CTX_snprint_PKIStatus(OSSL_CMP_CTX ctx, char *buf, int bufsize);
	13
	14	=head1 DESCRIPTION
	15
	16	This is the PKIStatus API for using CMP (Certificate Management Protocol) with
	17	OpenSSL.
	18
	19	OSSL_CMP_CTX_snprint_PKIStatus() takes the PKIStatusInfo components contained
	20	in the given CMP context and places a human-readable string created from them
	21	in the given buffer, with the given maximal length.
	22	On success it returns a copy of the buffer pointer containing the string.
	23
	24	=head1 NOTES
	25
	26	CMP is defined in RFC 4210 (and CRMF in RFC 4211).
	27
	28	=head1 RETURN VALUES
	29
	30	OSSL_CMP_CTX_snprint_PKIStatus()
	31	returns the intended pointer value as described above or NULL on error.
	32
	33	=head1 HISTORY
	34
	35	The OpenSSL CMP support was added in OpenSSL 3.0.
	36
	37	=head1 COPYRIGHT
	38
	39	Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
	40
	41	Licensed under the Apache License 2.0 (the "License"). You may not use
	42	this file except in compliance with the License. You can obtain a copy
	43	in the file LICENSE in the source distribution or at
	44	L<https://www.openssl.org/source/license.html>.
	45
	46	=cut