[thirdparty/openssl.git] / doc / man3 / PEM_read_CMS.pod

=pod

=head1 NAME

DECLARE_PEM_rw,
PEM_read_CMS,
PEM_read_bio_CMS,
PEM_write_CMS,
PEM_write_bio_CMS,
PEM_write_DHxparams,
PEM_write_bio_DHxparams,
PEM_read_ECPKParameters,
PEM_read_bio_ECPKParameters,
PEM_write_ECPKParameters,
PEM_write_bio_ECPKParameters,
PEM_read_ECPrivateKey,
PEM_write_ECPrivateKey,
PEM_write_bio_ECPrivateKey,
PEM_read_EC_PUBKEY,
PEM_read_bio_EC_PUBKEY,
PEM_write_EC_PUBKEY,
PEM_write_bio_EC_PUBKEY,
PEM_read_NETSCAPE_CERT_SEQUENCE,
PEM_read_bio_NETSCAPE_CERT_SEQUENCE,
PEM_write_NETSCAPE_CERT_SEQUENCE,
PEM_write_bio_NETSCAPE_CERT_SEQUENCE,
PEM_read_PKCS8,
PEM_read_bio_PKCS8,
PEM_write_PKCS8,
PEM_write_bio_PKCS8,
PEM_write_PKCS8_PRIV_KEY_INFO,
PEM_read_bio_PKCS8_PRIV_KEY_INFO,
PEM_read_PKCS8_PRIV_KEY_INFO,
PEM_write_bio_PKCS8_PRIV_KEY_INFO,
PEM_read_SSL_SESSION,
PEM_read_bio_SSL_SESSION,
PEM_write_SSL_SESSION,
PEM_write_bio_SSL_SESSION
- PEM object encoding routines

=head1 SYNOPSIS

=for openssl generic

 #include <openssl/pem.h>

 DECLARE_PEM_rw(name, TYPE)

 TYPE *PEM_read_TYPE(FILE *fp, TYPE **a, pem_password_cb *cb, void *u);
 TYPE *PEM_read_bio_TYPE(BIO *bp, TYPE **a, pem_password_cb *cb, void *u);
 int PEM_write_TYPE(FILE *fp, const TYPE *a);
 int PEM_write_bio_TYPE(BIO *bp, const TYPE *a);

=head1 DESCRIPTION

In the description below, B<I<TYPE>> is used
as a placeholder for any of the OpenSSL datatypes, such as B<X509>.
The macro B<DECLARE_PEM_rw> expands to the set of declarations shown in
the next four lines of the synopsis.

These routines convert between local instances of ASN1 datatypes and
the PEM encoding.  For more information on the templates, see
L<ASN1_ITEM(3)>.  For more information on the lower-level routines used
by the functions here, see L<PEM_read(3)>.

B<PEM_read_I<TYPE>>() reads a PEM-encoded object of B<I<TYPE>> from the file
I<fp> and returns it.  The I<cb> and I<u> parameters are as described in
L<pem_password_cb(3)>.

B<PEM_read_bio_I<TYPE>>() is similar to B<PEM_read_I<TYPE>>() but reads from
the BIO I<bp>.

B<PEM_write_I<TYPE>>() writes the PEM encoding of the object I<a> to the file
I<fp>.

B<PEM_write_bio_I<TYPE>>() similarly writes to the BIO I<bp>.

=head1 NOTES

These functions make no assumption regarding the pass phrase received from the
password callback.
It will simply be treated as a byte sequence.

=head1 RETURN VALUES

B<PEM_read_I<TYPE>>() and B<PEM_read_bio_I<TYPE>>() return a pointer to an
allocated object, which should be released by calling B<I<TYPE>_free>(), or
NULL on error.

B<PEM_write_I<TYPE>>() and B<PEM_write_bio_I<TYPE>>() return the number of bytes
written or zero on error.

=head1 SEE ALSO

L<PEM_read(3)>,
L<passphrase-encoding(7)>

=head1 COPYRIGHT

Copyright 1998-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

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