Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_generate_session_id.3
index d5dfdd4..99824d9 100644 (file)
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .    rr F
 .\}
 .\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .    \" fudge factors for nroff and troff
 .\" ========================================================================
 .\"
 .IX Title "SSL_CTX_set_generate_session_id 3"
-.TH SSL_CTX_set_generate_session_id 3 "2007-10-24" "0.9.8g" "OpenSSL"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.if n .ad l
-.nh
+.TH SSL_CTX_set_generate_session_id 3 "2008-09-06" "0.9.8h" "OpenSSL"
 .SH "NAME"
 SSL_CTX_set_generate_session_id, SSL_set_generate_session_id, SSL_has_matching_session_id \- manipulate generation of SSL session IDs (server only)
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
 \& #include <openssl/ssl.h>
-\&
+.Ve
+.PP
+.Vb 2
 \& typedef int (*GEN_SESSION_CB)(const SSL *ssl, unsigned char *id,
 \&                               unsigned int *id_len);
-\&
+.Ve
+.PP
+.Vb 4
 \& int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb);
 \& int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB, cb);
 \& int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
@@ -224,23 +229,29 @@ The callback function listed will generate a session id with the
 server id given, and will fill the rest with pseudo random bytes:
 .PP
 .Vb 1
-\& const char session_id_prefix = "www\-18";
-\&
+\& const char session_id_prefix = "www-18";
+.Ve
+.PP
+.Vb 6
 \& #define MAX_SESSION_ID_ATTEMPTS 10
 \& static int generate_session_id(const SSL *ssl, unsigned char *id,
 \&                              unsigned int *id_len)
 \&      {
 \&      unsigned int count = 0;
 \&      const char *version;
-\&
+.Ve
+.PP
+.Vb 3
 \&      version = SSL_get_version(ssl);
 \&      if (!strcmp(version, "SSLv2"))
 \&          /* we must not change id_len */;
-\&
+.Ve
+.PP
+.Vb 17
 \&      do      {
 \&              RAND_pseudo_bytes(id, *id_len);
 \&              /* Prefix the session_id with the required prefix. NB: If our
-\&               * prefix is too long, clip it \- but there will be worse effects
+\&               * prefix is too long, clip it - but there will be worse effects
 \&               * anyway, eg. the server could only possibly create 1 session
 \&               * ID (ie. the prefix!) so all future session negotiations will
 \&               * fail due to conflicts. */