lib/libssl/man/SSL_SESSION_set1_id_context.3

   1 .\"     $OpenBSD: SSL_SESSION_set1_id_context.3,v 1.1 2017/04/10 15:37:55 schwarze Exp $
   2 .\"     OpenSSL SSL_SESSION_get0_id_context.pod b31db505 Mar 24 16:01:50 2017
   3 .\"
   4 .\" This file was written by Matt Caswell <matt@openssl.org>
   5 .\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: April 10 2017 $
  52 .Dt SSL_SESSION_SET1_ID_CONTEXT 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_SESSION_set1_id_context
  56 .Nd set the SSL ID context associated with a session
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft int
  60 .Fo SSL_SESSION_set1_id_context
  61 .Fa "SSL_SESSION *s"
  62 .Fa "const unsigned char *sid_ctx"
  63 .Fa "unsigned int sid_ctx_len"
  64 .Fc
  65 .Sh DESCRIPTION
  66 .Fn SSL_SESSION_set1_id_context
  67 takes a copy of the provided ID context given in
  68 .Fa sid_ctx
  69 and associates it with the session
  70 .Fa s .
  71 The length of the ID context is given by
  72 .Fa sid_ctx_len
  73 which must not exceed
  74 .Dv SSL_MAX_SID_CTX_LENGTH
  75 bytes.
  76 .Sh RETURN VALUES
  77 .Fn SSL_SESSION_set1_id_context
  78 returns 1 on success or 0 on error.
  79 .Sh SEE ALSO
  80 .Xr ssl 3 ,
  81 .Xr SSL_CTX_set_session_id_context 3 ,
  82 .Xr SSL_get_session 3 ,
  83 .Xr SSL_SESSION_new 3