doc/man3/OSSL_CRMF_MSG_get0_tmpl.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CRMF_MSG_get0_tmpl,
   6 OSSL_CRMF_CERTTEMPLATE_get0_serialNumber,
   7 OSSL_CRMF_CERTTEMPLATE_get0_issuer,
   8 OSSL_CRMF_CERTID_get0_serialNumber,
   9 OSSL_CRMF_CERTID_get0_issuer,
  10 OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert,
  11 OSSL_CRMF_MSG_get_certReqId
  12 - functions reading from CRMF CertReqMsg structures
  13
  14 =head1 SYNOPSIS
  15
  16  #include <openssl/crmf.h>
  17
  18  OSSL_CRMF_CERTTEMPLATE *OSSL_CRMF_MSG_get0_tmpl(const OSSL_CRMF_MSG *crm);
  19  ASN1_INTEGER
  20  *OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(const OSSL_CRMF_CERTTEMPLATE *tmpl);
  21  X509_NAME
  22  *OSSL_CRMF_CERTTEMPLATE_get0_issuer(const OSSL_CRMF_CERTTEMPLATE *tmpl);
  23
  24  ASN1_INTEGER *OSSL_CRMF_CERTID_get0_serialNumber(const OSSL_CRMF_CERTID *cid);
  25  const X509_NAME *OSSL_CRMF_CERTID_get0_issuer(const OSSL_CRMF_CERTID *cid);
  26
  27  X509
  28  *OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(const OSSL_CRMF_ENCRYPTEDVALUE *ecert,
  29                                         OPENSSL_CTX *libctx, const char *propq,
  30                                         EVP_PKEY *pkey);
  31
  32  int OSSL_CRMF_MSG_get_certReqId(const OSSL_CRMF_MSG *crm);
  33
  34
  35 =head1 DESCRIPTION
  36
  37 OSSL_CRMF_MSG_get0_tmpl() retrieves the certificate template of I<crm>.
  38
  39 OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() retrieves the serialNumber of the
  40 given certificate template I<tmpl>.
  41
  42 OSSL_CRMF_CERTTEMPLATE_get0_issuer() retrieves the issuer name of the
  43 given certificate template I<tmpl>.
  44
  45 OSSL_CRMF_CERTID_get0_serialNumber retrieves the serialNumber
  46 of the given CertId I<cid>.
  47
  48 OSSL_CRMF_CERTID_get0_issuer retrieves the issuer name
  49 of the given CertId I<cid>, which must be of ASN.1 type GEN_DIRNAME.
  50
  51 OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() decrypts the certificate in the given
  52 encryptedValue I<ecert>, using the private key I<pkey>, library context
  53 I<libctx> and property query string I<propq> (see L<OPENSSL_CTX(3)>).
  54 This is needed for the indirect POPO method as in RFC 4210 section 5.2.8.2.
  55 The function returns the decrypted certificate as a copy, leaving its ownership
  56 with the caller, who is responsible for freeing it.
  57
  58 OSSL_CRMF_MSG_get_certReqId() retrieves the certReqId of I<crm>.
  59
  60
  61 =head1 RETURN VALUES
  62
  63 OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a
  64 nonnegative integer or -1 on error.
  65
  66 All other functions return a pointer with the intended result or NULL on error.
  67
  68 =head1 SEE ALSO
  69
  70 RFC 4211
  71
  72 =head1 HISTORY
  73
  74 The OpenSSL CRMF support was added in OpenSSL 3.0.
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
  79
  80 Licensed under the Apache License 2.0 (the "License").  You may not use
  81 this file except in compliance with the License.  You can obtain a copy
  82 in the file LICENSE in the source distribution or at
  83 L<https://www.openssl.org/source/license.html>.
  84
  85 =cut