doc/man3/OSSL_CMP_STATUSINFO_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CMP_STATUSINFO_new,
   6 OSSL_CMP_snprint_PKIStatusInfo,
   7 OSSL_CMP_CTX_snprint_PKIStatus
   8 - function(s) for managing the CMP PKIStatus
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/cmp.h>
  13
  14  OSSL_CMP_PKISI *OSSL_CMP_STATUSINFO_new(int status, int fail_info,
  15                                          const char *text);
  16  char *OSSL_CMP_snprint_PKIStatusInfo(const OSSL_CMP_PKISI *statusInfo,
  17                                       char *buf, size_t bufsize);
  18  char *OSSL_CMP_CTX_snprint_PKIStatus(const OSSL_CMP_CTX *ctx, char *buf,
  19                                       size_t bufsize);
  20
  21 =head1 DESCRIPTION
  22
  23 This is the PKIStatus API for using CMP (Certificate Management Protocol) with
  24 OpenSSL.
  25
  26 OSSL_CMP_STATUSINFO_new() creates a new PKIStatusInfo structure
  27 and fills in the given values.
  28 It sets the status field to B<status>,
  29 copies B<text> (unless it is NULL) to statusString,
  30 and interprets B<fail_info> as bit pattern for the failInfo field.
  31
  32 OSSL_CMP_snprint_PKIStatusInfo() places a human-readable string
  33 representing the given statusInfo
  34 in the given buffer, with the given maximal length.
  35
  36 OSSL_CMP_CTX_snprint_PKIStatus() places a human-readable string
  37 representing the PKIStatusInfo components of the CMP context B<ctx>
  38 in the given buffer, with the given maximal length.
  39
  40 =head1 NOTES
  41
  42 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
  43
  44 =head1 RETURN VALUES
  45
  46 OSSL_CMP_STATUSINFO_new()
  47 returns a pointer to the structure on success, or NULL on error.
  48
  49 OSSL_CMP_snprint_PKIStatusInfo() and
  50 OSSL_CMP_CTX_snprint_PKIStatus()
  51 return a copy of the buffer pointer containing the string or NULL on error.
  52
  53 =head1 HISTORY
  54
  55 The OpenSSL CMP support was added in OpenSSL 3.0.
  56
  57 =head1 COPYRIGHT
  58
  59 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
  60
  61 Licensed under the Apache License 2.0 (the "License").  You may not use
  62 this file except in compliance with the License.  You can obtain a copy
  63 in the file LICENSE in the source distribution or at
  64 L<https://www.openssl.org/source/license.html>.
  65
  66 =cut