doc/man3/OSSL_CMP_MSG_get0_header.pod

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