doc/man3/OSSL_CRMF_MSG_set1_regCtrl_regToken.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CRMF_MSG_set1_regCtrl_regToken,
   6 OSSL_CRMF_MSG_set1_regCtrl_authenticator,
   7 OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo,
   8 OSSL_CRMF_MSG_set0_SinglePubInfo,
   9 OSSL_CRMF_MSG_set_PKIPublicationInfo_action,
  10 OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo,
  11 OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey,
  12 OSSL_CRMF_MSG_set1_regCtrl_oldCertID,
  13 OSSL_CRMF_CERTID_gen
  14 - functions setting CRMF Registration Controls
  15
  16 =head1 SYNOPSIS
  17
  18  #include <openssl/crmf.h>
  19
  20  int OSSL_CRMF_MSG_set1_regCtrl_regToken(OSSL_CRMF_MSG *msg,
  21                                          const ASN1_UTF8STRING *tok);
  22  int OSSL_CRMF_MSG_set1_regCtrl_authenticator(OSSL_CRMF_MSG *msg,
  23                                               const ASN1_UTF8STRING *auth);
  24  int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo(
  25                                   OSSL_CRMF_PKIPUBLICATIONINFO *pi,
  26                                   OSSL_CRMF_SINGLEPUBINFO *spi);
  27  int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi,
  28                                       int method, GENERAL_NAME *nm);
  29  int OSSL_CRMF_MSG_set_PKIPublicationInfo_action(
  30                                   OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action);
  31  int OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo(OSSL_CRMF_MSG *msg,
  32                                         const OSSL_CRMF_PKIPUBLICATIONINFO *pi);
  33  int OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey(OSSL_CRMF_MSG *msg,
  34                                                 const X509_PUBKEY *pubkey);
  35  int OSSL_CRMF_MSG_set1_regCtrl_oldCertID(OSSL_CRMF_MSG *msg,
  36                                           const OSSL_CRMF_CERTID *cid);
  37  OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer,
  38                                         const ASN1_INTEGER *serial);
  39
  40 =head1 DESCRIPTION
  41
  42 OSSL_CRMF_MSG_set1_regCtrl_regToken() sets the regToken control in the given
  43 I<msg> copying the given I<tok> as value. See RFC 4211, section 6.1.
  44
  45 OSSL_CRMF_MSG_set1_regCtrl_authenticator() sets the authenticator control in
  46 the given I<msg> copying the given I<auth> as value. See RFC 4211, section 6.2.
  47
  48 OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo() pushes the given I<spi>
  49 to I<si>. Consumes the I<spi> pointer.
  50
  51 OSSL_CRMF_MSG_set0_SinglePubInfo() sets in the given SinglePubInfo I<spi>
  52 the I<method> and publication location, in the form of a GeneralName, I<nm>.
  53 The publication location is optional, and therefore I<nm> may be NULL.
  54 The function consumes the I<nm> pointer if present.
  55 Available methods are:
  56  # define OSSL_CRMF_PUB_METHOD_DONTCARE 0
  57  # define OSSL_CRMF_PUB_METHOD_X500     1
  58  # define OSSL_CRMF_PUB_METHOD_WEB      2
  59  # define OSSL_CRMF_PUB_METHOD_LDAP     3
  60
  61 OSSL_CRMF_MSG_set_PKIPublicationInfo_action() sets the action in the given I<pi>
  62 using the given I<action> as value. See RFC 4211, section 6.3.
  63 Available actions are:
  64  # define OSSL_CRMF_PUB_ACTION_DONTPUBLISH   0
  65  # define OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH 1
  66
  67 OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo() sets the pkiPublicationInfo
  68 control in the given I<msg> copying the given I<tok> as value. See RFC 4211,
  69 section 6.3.
  70
  71 OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey() sets the protocolEncrKey control in
  72 the given I<msg> copying the given I<pubkey> as value. See RFC 4211 section 6.6.
  73
  74 OSSL_CRMF_MSG_set1_regCtrl_oldCertID() sets the oldCertID control in the given
  75 I<msg> copying the given I<cid> as value. See RFC 4211, section 6.5.
  76
  77 OSSL_CRMF_CERTID_gen produces an OSSL_CRMF_CERTID_gen structure copying the
  78 given I<issuer> name and I<serial> number.
  79
  80 =head1 RETURN VALUES
  81
  82 OSSL_CRMF_CERTID_gen returns a pointer to the resulting structure
  83 or NULL on error.
  84
  85 All other functions return 1 on success, 0 on error.
  86
  87 =head1 NOTES
  88
  89 A function OSSL_CRMF_MSG_set1_regCtrl_pkiArchiveOptions() for setting an
  90 Archive Options Control is not yet implemented due to missing features to
  91 create the needed OSSL_CRMF_PKIARCHIVEOPTINS content.
  92
  93 =head1 SEE ALSO
  94
  95 RFC 4211
  96
  97 =head1 HISTORY
  98
  99 The OpenSSL CRMF support was added in OpenSSL 3.0.
 100
 101 =head1 COPYRIGHT
 102
 103 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
 104
 105 Licensed under the Apache License 2.0 (the "License").  You may not use
 106 this file except in compliance with the License.  You can obtain a copy
 107 in the file LICENSE in the source distribution or at
 108 L<https://www.openssl.org/source/license.html>.
 109
 110 =cut