doc/crypto/PEM_read_CMS.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 PEM_read_CMS,
   6 PEM_read_bio_CMS,
   7 PEM_write_CMS,
   8 PEM_write_bio_CMS,
   9 PEM_write_DHxparams,
  10 PEM_write_bio_DHxparams,
  11 PEM_read_ECPKParameters,
  12 PEM_read_bio_ECPKParameters,
  13 PEM_write_ECPKParameters,
  14 PEM_write_bio_ECPKParameters,
  15 PEM_read_ECPrivateKey,
  16 PEM_write_ECPrivateKey,
  17 PEM_write_bio_ECPrivateKey,
  18 PEM_read_EC_PUBKEY,
  19 PEM_read_bio_EC_PUBKEY,
  20 PEM_write_EC_PUBKEY,
  21 PEM_write_bio_EC_PUBKEY,
  22 PEM_read_NETSCAPE_CERT_SEQUENCE,
  23 PEM_read_bio_NETSCAPE_CERT_SEQUENCE,
  24 PEM_write_NETSCAPE_CERT_SEQUENCE,
  25 PEM_write_bio_NETSCAPE_CERT_SEQUENCE,
  26 PEM_read_PKCS8,
  27 PEM_read_bio_PKCS8,
  28 PEM_write_PKCS8,
  29 PEM_write_bio_PKCS8,
  30 PEM_write_PKCS8_PRIV_KEY_INFO,
  31 PEM_read_bio_PKCS8_PRIV_KEY_INFO,
  32 PEM_read_PKCS8_PRIV_KEY_INFO,
  33 PEM_write_bio_PKCS8_PRIV_KEY_INFO,
  34 PEM_read_SSL_SESSION,
  35 PEM_read_bio_SSL_SESSION,
  36 PEM_write_SSL_SESSION,
  37 PEM_write_bio_SSL_SESSION
  38 - PEM object encoding routines
  39
  40 =for comment generic
  41
  42 =head1 SYNOPSIS
  43
  44  #include <openssl/pem.h>
  45
  46  #define DECLARE_PEM_rw(name, TYPE) ...
  47
  48  TYPE *PEM_read_TYPE(FILE *fp, TYPE **a, pem_password_cb *cb, void *u);
  49  TYPE *PEM_read_bio_TYPE(BIO *bp, TYPE **a, pem_password_cb *cb, void *u);
  50  int PEM_write_TYPE(FILE *fp, const TYPE *a);
  51  int PEM_write_bio_TYPE(BIO *bp, const TYPE *a);
  52
  53 =head1 DESCRIPTION
  54
  55 In the description below, I<TYPE> is used
  56 as a placeholder for any of the OpenSSL datatypes, such as I<X509>.
  57
  58 These routines convert between local instances of ASN1 datatypes and
  59 the PEM encoding.  For more information on the templates, see
  60 L<ASN1_ITEM(3)>.  For more information on the lower-level routines used
  61 by the functions here, see L<PEM_read(3)>.
  62
  63 PEM_read_TYPE() reads a PEM-encoded object of I<TYPE> from the file B<fp>
  64 and returns it.  The B<cb> and B<u> parameters are as described in
  65 L<pem_password_cb(3)>.
  66
  67 PEM_read_bio_TYPE() is similar to PEM_read_TYPE() but reads from the BIO B<bp>.
  68
  69 PEM_write_TYPE() writes the PEM encoding of the object B<a> to the file B<fp>.
  70
  71 PEM_write_bio_TYPE() similarly writes to the BIO B<bp>.
  72
  73 =head1 RETURN VALUES
  74
  75 PEM_read_TYPE() and PEM_read_bio_TYPE() return a pointer to an allocated
  76 object, which should be released by calling TYPE_free(), or NULL on error.
  77
  78 PEM_write_TYPE() and PEM_write_bio_TYPE() return the number of bytes written
  79 or zero on error.
  80
  81 =head1 SEE ALSO
  82
  83 L<PEM_read(3)>
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright 1998-2016 The OpenSSL Project Authors. All Rights Reserved.
  88
  89 Licensed under the OpenSSL license (the "License").  You may not use
  90 this file except in compliance with the License.  You can obtain a copy
  91 in the file LICENSE in the source distribution or at
  92 L<https://www.openssl.org/source/license.html>.
  93
  94 =cut