.\"	$OpenBSD: PEM_read_SSL_SESSION.3,v 1.4 2019/06/12 09:36:30 schwarze Exp $
.\"	OpenSSL doc/man3/PEM_read_CMS.pod b97fdb57 Nov 11 09:33:09 2016 +0100
.\"
.\" This file was written by Rich Salz <rsalz@openssl.org>.
.\" Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For written permission, please contact
.\"    openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\"    nor may "OpenSSL" appear in their names without prior written
.\"    permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: June 12 2019 $
.Dt PEM_READ_SSL_SESSION 3
.Os
.Sh NAME
.Nm PEM_read_SSL_SESSION ,
.Nm PEM_read_bio_SSL_SESSION ,
.Nm PEM_write_SSL_SESSION ,
.Nm PEM_write_bio_SSL_SESSION
.Nd encode and decode SSL session objects in PEM format
.Sh SYNOPSIS
.In openssl/ssl.h
.Ft SSL_SESSION *
.Fo PEM_read_SSL_SESSION
.Fa "FILE *fp"
.Fa "SSL_SESSION **a"
.Fa "pem_password_cb *cb"
.Fa "void *u"
.Fc
.Ft SSL_SESSION *
.Fo PEM_read_bio_SSL_SESSION
.Fa "BIO *bp"
.Fa "SSL_SESSION **a"
.Fa "pem_password_cb *cb"
.Fa "void *u"
.Fc
.Ft int
.Fo PEM_write_SSL_SESSION
.Fa "FILE *fp"
.Fa "const SSL_SESSION *a"
.Fc
.Ft int
.Fo PEM_write_bio_SSL_SESSION
.Fa "BIO *bp"
.Fa "const SSL_SESSION *a"
.Fc
.Sh DESCRIPTION
These routines convert between local instances of ASN.1
.Vt SSL_SESSION
objects and the PEM encoding.
.Pp
.Fn PEM_read_SSL_SESSION
reads a PEM-encoded
.Vt SSL_SESSION
object from the file
.Fa fp
and returns it.
The
.Fa cb
and
.Fa u
parameters are as described in
.Xr PEM_read_bio_PrivateKey 3 .
.Pp
.Fn PEM_read_bio_SSL_SESSION
is similar to
.Fn PEM_read_SSL_SESSION
but reads from the BIO
.Fa bp .
.Pp
.Fn PEM_write_SSL_SESSION
writes the PEM encoding of the object
.Fa a
to the file
.Fa fp .
.Pp
.Fn PEM_write_bio_SSL_SESSION
similarly writes to the BIO
.Fa bp .
.Sh RETURN VALUES
.Fn PEM_read_SSL_SESSION
and
.Fn PEM_read_bio_SSL_SESSION
return a pointer to an allocated object, which should be released by
calling
.Xr SSL_SESSION_free 3 ,
or
.Dv NULL
on error.
.Pp
.Fn PEM_write_SSL_SESSION
and
.Fn PEM_write_bio_SSL_SESSION
return the number of bytes written or 0 on error.
.Sh SEE ALSO
.Xr PEM_read 3 ,
.Xr ssl 3
.Sh HISTORY
.Fn PEM_read_SSL_SESSION
and
.Fn PEM_write_SSL_SESSION
first appeared in SSLeay 0.5.2.
.Fn PEM_read_bio_SSL_SESSION
and
.Fn PEM_write_bio_SSL_SESSION
first appeared in SSLeay 0.6.0.
These functions have been available since
.Ox 2.4 .