doc/man3/OSSL_CMP_MSG_get0_header.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CMP_MSG_get0_header,
   6 d2i_OSSL_CMP_MSG_bio,
   7 i2d_OSSL_CMP_MSG_bio
   8 - function(s) manipulating CMP messages
   9
  10 =head1 SYNOPSIS
  11
  12   #include <openssl/cmp.h>
  13
  14   OSSL_CMP_PKIHEADER *OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG *msg);
  15   OSSL_CMP_MSG *d2i_OSSL_CMP_MSG_bio(BIO *bio, OSSL_CMP_MSG **msg);
  16   int i2d_OSSL_CMP_MSG_bio(BIO *bio, const OSSL_CMP_MSG *msg);
  17
  18 =head1 DESCRIPTION
  19
  20 OSSL_CMP_MSG_get0_header returns the header of the given CMP message.
  21
  22 d2i_OSSL_CMP_MSG_bio parses an ASN.1-encoded OSSL_CMP_MSG from the BIO I<bio>.
  23 It assigns a pointer to the new structure to I<*msg> if I<msg> is not NULL.
  24
  25 i2d_OSSL_CMP_MSG_bio writes the OSSL_CMP_MSG I<msg> in ASN.1 encoding
  26 to BIO I<bio>.
  27
  28 =head1 NOTES
  29
  30 CMP is defined in RFC 4210.
  31
  32 =head1 RETURN VALUES
  33
  34 OSSL_CMP_MSG_get0_header() returns the intended pointer value as described above
  35 or NULL if the respective entry does not exist and on error.
  36
  37 d2i_OSSL_CMP_MSG_bio() returns the parsed message or NULL on error.
  38
  39 i2d_OSSL_CMP_MSG_bio() returns 1 on success or 0 on error.
  40
  41 =head1 HISTORY
  42
  43 The OpenSSL CMP support was added in OpenSSL 3.0.
  44
  45 =head1 COPYRIGHT
  46
  47 Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
  48
  49 Licensed under the Apache License 2.0 (the "License").  You may not use
  50 this file except in compliance with the License.  You can obtain a copy
  51 in the file LICENSE in the source distribution or at
  52 L<https://www.openssl.org/source/license.html>.
  53
  54 =cut