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(OSSL_CRMF_CERTTEMPLATE *tmpl);
  21  X509_NAME *OSSL_CRMF_CERTTEMPLATE_get0_issuer(OSSL_CRMF_CERTTEMPLATE *tmpl);
  22
  23  ASN1_INTEGER *OSSL_CRMF_CERTID_get0_serialNumber(const OSSL_CRMF_CERTID *cid);
  24  X509_NAME *OSSL_CRMF_CERTID_get0_issuer(const OSSL_CRMF_CERTID *cid);
  25
  26  X509 *OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(OSSL_CRMF_ENCRYPTEDVALUE *ecert,
  27                                              EVP_PKEY *pkey);
  28
  29  int OSSL_CRMF_MSG_get_certReqId(OSSL_CRMF_MSG *crm);
  30
  31
  32 =head1 DESCRIPTION
  33
  34 OSSL_CRMF_MSG_get0_tmpl() retrieves the certificate template of B<crm>.
  35
  36 OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() retrieves the serialNumber of the
  37 given certificate template B<tmpl>.
  38
  39 OSSL_CRMF_CERTTEMPLATE_get0_issuer() retrieves the issuer name of the
  40 given certificate template B<tmpl>.
  41
  42 OSSL_CRMF_CERTID_get0_serialNumber retrieves the serialNumber
  43 of the given CertId B<cid>.
  44
  45 OSSL_CRMF_CERTID_get0_issuer retrieves the issuer name
  46 of the given CertId B<cid>, which must be of ASN.1 type GEN_DIRNAME.
  47
  48 OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() decrypts the certificate in the given
  49 encryptedValue B<ecert>, using the private key B<pkey>.
  50 This is needed for the indirect PoP method as in RFC 4210 section 5.2.8.2.
  51 The function returns the decrypted certificate as a copy, leaving its ownership
  52 with the caller, who is responsible for freeing it.
  53
  54 OSSL_CRMF_MSG_get_certReqId() retrieves the certReqId of B<crm>.
  55
  56
  57 =head1 RETURN VALUES
  58
  59 OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a
  60 non-negative integer or -1 on error.
  61
  62 All other functions return a pointer with the intended result or NULL on error.
  63
  64 =head1 SEE ALSO
  65
  66 B<RFC 4211>
  67
  68 =head1 HISTORY
  69
  70 The OpenSSL CRMF support was added in OpenSSL 3.0.
  71
  72 =head1 COPYRIGHT
  73
  74 Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
  75
  76 Licensed under the Apache License 2.0 (the "License").  You may not use
  77 this file except in compliance with the License.  You can obtain a copy
  78 in the file LICENSE in the source distribution or at
  79 L<https://www.openssl.org/source/license.html>.
  80
  81 =cut