lib/libssl/man/SSL_set_connect_state.3

   1 .\"     $OpenBSD: SSL_set_connect_state.3,v 1.2 2016/12/04 12:20:54 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   5 .\" Copyright (c) 2001, 2002 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: December 4 2016 $
  52 .Dt SSL_SET_CONNECT_STATE 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_set_connect_state ,
  56 .Nm SSL_set_accept_state
  57 .Nd prepare SSL object to work in client or server mode
  58 .Sh SYNOPSIS
  59 .In openssl/ssl.h
  60 .Ft void
  61 .Fn SSL_set_connect_state "SSL *ssl"
  62 .Ft void
  63 .Fn SSL_set_accept_state "SSL *ssl"
  64 .Sh DESCRIPTION
  65 .Fn SSL_set_connect_state
  66 sets
  67 .Fa ssl
  68 to work in client mode.
  69 .Pp
  70 .Fn SSL_set_accept_state
  71 sets
  72 .Fa ssl
  73 to work in server mode.
  74 .Pp
  75 When the
  76 .Vt SSL_CTX
  77 object was created with
  78 .Xr SSL_CTX_new 3 ,
  79 it was either assigned a dedicated client method, a dedicated server method, or
  80 a generic method, that can be used for both client and server connections.
  81 (The method might have been changed with
  82 .Xr SSL_CTX_set_ssl_version 3
  83 or
  84 .Xr SSL_set_ssl_method 3 . )
  85 .Pp
  86 When beginning a new handshake, the SSL engine must know whether it must call
  87 the connect (client) or accept (server) routines.
  88 Even though it may be clear from the method chosen whether client or server
  89 mode was requested, the handshake routines must be explicitly set.
  90 .Pp
  91 When using the
  92 .Xr SSL_connect 3
  93 or
  94 .Xr SSL_accept 3
  95 routines, the correct handshake routines are automatically set.
  96 When performing a transparent negotiation using
  97 .Xr SSL_write 3
  98 or
  99 .Xr SSL_read 3 ,
 100 the handshake routines must be explicitly set in advance using either
 101 .Fn SSL_set_connect_state
 102 or
 103 .Fn SSL_set_accept_state .
 104 .Sh RETURN VALUES
 105 .Fn SSL_set_connect_state
 106 and
 107 .Fn SSL_set_accept_state
 108 do not return diagnostic information.
 109 .Sh SEE ALSO
 110 .Xr ssl 3 ,
 111 .Xr SSL_accept 3 ,
 112 .Xr SSL_connect 3 ,
 113 .Xr SSL_CTX_new 3 ,
 114 .Xr SSL_CTX_set_ssl_version 3 ,
 115 .Xr SSL_do_handshake 3 ,
 116 .Xr SSL_new 3 ,
 117 .Xr SSL_read 3 ,
 118 .Xr SSL_write 3