crypto/external/bsd/openssl/lib/libcrypto/man/SSL_CTX_add_session.3

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "SSL_CTX_add_session 3"
 137 .TH SSL_CTX_add_session 3 "2002-10-28" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 SSL_CTX_add_session, SSL_add_session, SSL_CTX_remove_session, SSL_remove_session \- manipulate session cache
 144 .SH "LIBRARY"
 145 libcrypto, -lcrypto
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 .Vb 1
 149 \& #include <openssl/ssl.h>
 150 \&
 151 \& int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c);
 152 \& int SSL_add_session(SSL_CTX *ctx, SSL_SESSION *c);
 153 \&
 154 \& int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c);
 155 \& int SSL_remove_session(SSL_CTX *ctx, SSL_SESSION *c);
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fISSL_CTX_add_session()\fR adds the session \fBc\fR to the context \fBctx\fR. The
 160 reference count for session \fBc\fR is incremented by 1. If a session with
 161 the same session id already exists, the old session is removed by calling
 162 \&\fISSL_SESSION_free\fR\|(3).
 163 .PP
 164 \&\fISSL_CTX_remove_session()\fR removes the session \fBc\fR from the context \fBctx\fR.
 165 \&\fISSL_SESSION_free\fR\|(3) is called once for \fBc\fR.
 166 .PP
 167 \&\fISSL_add_session()\fR and \fISSL_remove_session()\fR are synonyms for their
 168 SSL_CTX_*() counterparts.
 169 .SH "NOTES"
 170 .IX Header "NOTES"
 171 When adding a new session to the internal session cache, it is examined
 172 whether a session with the same session id already exists. In this case
 173 it is assumed that both sessions are identical. If the same session is
 174 stored in a different \s-1SSL_SESSION\s0 object, The old session is
 175 removed and replaced by the new session. If the session is actually
 176 identical (the \s-1SSL_SESSION\s0 object is identical), \fISSL_CTX_add_session()\fR
 177 is a no-op, and the return value is 0.
 178 .PP
 179 If a server \s-1SSL_CTX\s0 is configured with the \s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0
 180 flag then the internal cache will not be populated automatically by new
 181 sessions negotiated by the \s-1SSL/TLS\s0 implementation, even though the internal
 182 cache will be searched automatically for session-resume requests (the
 183 latter can be surpressed by \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0). So the
 184 application can use \fISSL_CTX_add_session()\fR directly to have full control
 185 over the sessions that can be resumed if desired.
 186 .SH "RETURN VALUES"
 187 .IX Header "RETURN VALUES"
 188 The following values are returned by all functions:
 189 .IP "0" 4
 190 .Vb 3
 191 \& The operation failed. In case of the add operation, it was tried to add
 192 \& the same (identical) session twice. In case of the remove operation, the
 193 \& session was not found in the cache.
 194 .Ve
 195 .IP "1" 4
 196 .IX Item "1"
 197 .Vb 1
 198 \& The operation succeeded.
 199 .Ve
 200 .SH "SEE ALSO"
 201 .IX Header "SEE ALSO"
 202 \&\fIssl\fR\|(3),
 203 \&\fISSL_CTX_set_session_cache_mode\fR\|(3),
 204 \&\fISSL_SESSION_free\fR\|(3)