Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libssl / man / d2i_SSL_SESSION.3
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
e056f0e0
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
e056f0e0 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
e056f0e0 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
e056f0e0 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
e056f0e0
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
e056f0e0 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
e056f0e0
JR
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
984263bc
MD
35'br\}
36.el\{\
e056f0e0
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
984263bc 41'br\}
e056f0e0 42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
e056f0e0 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
e056f0e0
JR
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
e056f0e0
JR
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 54..
e056f0e0
JR
55. nr % 0
56. rr F
984263bc 57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 62.\"
e056f0e0
JR
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
984263bc 66.if n \{\
e056f0e0
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
e056f0e0
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
e056f0e0 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
e056f0e0
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
e056f0e0
JR
90. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 96.\}
e056f0e0 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
e056f0e0 107. \" corrections for vroff
984263bc
MD
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
e056f0e0 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
e056f0e0
JR
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
e056f0e0
JR
124.\" ========================================================================
125.\"
126.IX Title "d2i_SSL_SESSION 3"
e3261593 127.TH d2i_SSL_SESSION 3 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
984263bc 132.SH "NAME"
a7d27d5a 133d2i_SSL_SESSION, i2d_SSL_SESSION \- convert SSL_SESSION object from/to ASN1 representation
984263bc 134.SH "SYNOPSIS"
e056f0e0 135.IX Header "SYNOPSIS"
984263bc
MD
136.Vb 1
137\& #include <openssl/ssl.h>
e257b235 138\&
a561f9ff 139\& SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp, long length);
984263bc
MD
140\& int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp);
141.Ve
142.SH "DESCRIPTION"
e056f0e0
JR
143.IX Header "DESCRIPTION"
144\&\fId2i_SSL_SESSION()\fR transforms the external \s-1ASN1\s0 representation of an \s-1SSL/TLS\s0
984263bc 145session, stored as binary data at location \fBpp\fR with length \fBlength\fR, into
e056f0e0 146an \s-1SSL_SESSION\s0 object.
984263bc 147.PP
e056f0e0 148\&\fIi2d_SSL_SESSION()\fR transforms the \s-1SSL_SESSION\s0 object \fBin\fR into the \s-1ASN1\s0
984263bc 149representation and stores it into the memory location pointed to by \fBpp\fR.
e056f0e0
JR
150The length of the resulting \s-1ASN1\s0 representation is returned. If \fBpp\fR is
151the \s-1NULL\s0 pointer, only the length is calculated and returned.
984263bc 152.SH "NOTES"
e056f0e0
JR
153.IX Header "NOTES"
154The \s-1SSL_SESSION\s0 object is built from several \fImalloc()\fRed parts, it can
984263bc
MD
155therefore not be moved, copied or stored directly. In order to store
156session data on disk or into a database, it must be transformed into
e056f0e0 157a binary \s-1ASN1\s0 representation.
984263bc 158.PP
e056f0e0 159When using \fId2i_SSL_SESSION()\fR, the \s-1SSL_SESSION\s0 object is automatically
984263bc 160allocated. The reference count is 1, so that the session must be
e056f0e0
JR
161explicitly removed using \fISSL_SESSION_free\fR\|(3),
162unless the \s-1SSL_SESSION\s0 object is completely taken over, when being called
984263bc 163inside the \fIget_session_cb()\fR (see
e056f0e0 164\&\fISSL_CTX_sess_set_get_cb\fR\|(3)).
984263bc 165.PP
e056f0e0
JR
166\&\s-1SSL_SESSION\s0 objects keep internal link information about the session cache
167list, when being inserted into one \s-1SSL_CTX\s0 object's session cache.
168One \s-1SSL_SESSION\s0 object, regardless of its reference count, must therefore
169only be used with one \s-1SSL_CTX\s0 object (and the \s-1SSL\s0 objects created
170from this \s-1SSL_CTX\s0 object).
984263bc
MD
171.PP
172When using \fIi2d_SSL_SESSION()\fR, the memory location pointed to by \fBpp\fR must be
173large enough to hold the binary representation of the session. There is no
e056f0e0 174known limit on the size of the created \s-1ASN1\s0 representation, so the necessary
984263bc 175amount of space should be obtained by first calling \fIi2d_SSL_SESSION()\fR with
e056f0e0 176\&\fBpp=NULL\fR, and obtain the size needed, then allocate the memory and
984263bc
MD
177call \fIi2d_SSL_SESSION()\fR again.
178.SH "RETURN VALUES"
e056f0e0
JR
179.IX Header "RETURN VALUES"
180\&\fId2i_SSL_SESSION()\fR returns a pointer to the newly allocated \s-1SSL_SESSION\s0
181object. In case of failure the NULL-pointer is returned and the error message
984263bc
MD
182can be retrieved from the error stack.
183.PP
e056f0e0 184\&\fIi2d_SSL_SESSION()\fR returns the size of the \s-1ASN1\s0 representation in bytes.
984263bc
MD
185When the session is not valid, \fB0\fR is returned and no operation is performed.
186.SH "SEE ALSO"
a7d27d5a 187.IX Header "SEE ALSO"
e056f0e0
JR
188\&\fIssl\fR\|(3), \fISSL_SESSION_free\fR\|(3),
189\&\fISSL_CTX_sess_set_get_cb\fR\|(3)