doc/man3/OSSL_CRMF_MSG_set1_regInfo_certReq.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CRMF_MSG_get0_regInfo_utf8Pairs,
   6 OSSL_CRMF_MSG_set1_regInfo_utf8Pairs,
   7 OSSL_CRMF_MSG_get0_regInfo_certReq,
   8 OSSL_CRMF_MSG_set1_regInfo_certReq
   9 - functions getting or setting CRMF Registration Info
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/crmf.h>
  14
  15  ASN1_UTF8STRING
  16      *OSSL_CRMF_MSG_get0_regInfo_utf8Pairs(const OSSL_CRMF_MSG *msg);
  17  int OSSL_CRMF_MSG_set1_regInfo_utf8Pairs(OSSL_CRMF_MSG *msg,
  18                                           const ASN1_UTF8STRING *utf8pairs);
  19  OSSL_CRMF_CERTREQUEST
  20      *OSSL_CRMF_MSG_get0_regInfo_certReq(const OSSL_CRMF_MSG *msg);
  21  int OSSL_CRMF_MSG_set1_regInfo_certReq(OSSL_CRMF_MSG *msg,
  22                                         const OSSL_CRMF_CERTREQUEST *cr);
  23
  24 =head1 DESCRIPTION
  25
  26 OSSL_CRMF_MSG_get0_regInfo_utf8Pairs() returns the first utf8Pairs regInfo
  27 in the given I<msg>, if present.
  28
  29 OSSL_CRMF_MSG_set1_regInfo_utf8Pairs() adds a copy of the given I<utf8pairs>
  30 value as utf8Pairs regInfo to the given I<msg>. See RFC 4211 section 7.1.
  31
  32 OSSL_CRMF_MSG_get0_regInfo_certReq() returns the first certReq regInfo
  33 in the given I<msg>, if present.
  34
  35 OSSL_CRMF_MSG_set1_regInfo_certReq() adds a copy of the given I<cr> value
  36 as certReq regInfo to the given I<msg>. See RFC 4211 section 7.2.
  37
  38 =head1 RETURN VALUES
  39
  40 All get0_*() functions return the respective pointer value, NULL if not present.
  41
  42 All set1_*() functions return 1 on success, 0 on error.
  43
  44 =head1 NOTES
  45
  46 Calling the set1_*() functions multiple times
  47 adds multiple instances of the respective
  48 control to the regInfo structure of the given I<msg>. While RFC 4211 expects
  49 multiple utf8Pairs in one regInfo structure, it does not allow multiple certReq.
  50
  51 =head1 SEE ALSO
  52
  53 RFC 4211
  54
  55 =head1 HISTORY
  56
  57 The OpenSSL CRMF support was added in OpenSSL 3.0.
  58
  59 =head1 COPYRIGHT
  60
  61 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
  62
  63 Licensed under the Apache License 2.0 (the "License").  You may not use
  64 this file except in compliance with the License.  You can obtain a copy
  65 in the file LICENSE in the source distribution or at
  66 L<https://www.openssl.org/source/license.html>.
  67
  68 =cut