lib/libssl/man/SSL_rstate_string.3

   1 .\"     $OpenBSD: SSL_rstate_string.3,v 1.3 2018/03/21 05:07:04 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 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: March 21 2018 $
  52 .Dt SSL_RSTATE_STRING 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_rstate_string ,
  56 .Nm SSL_rstate_string_long
  57 .Nd get textual description of state of an SSL object during read operation
  58 .Sh SYNOPSIS
  59 .In openssl/ssl.h
  60 .Ft const char *
  61 .Fn SSL_rstate_string "SSL *ssl"
  62 .Ft const char *
  63 .Fn SSL_rstate_string_long "SSL *ssl"
  64 .Sh DESCRIPTION
  65 .Fn SSL_rstate_string
  66 returns a 2-letter string indicating the current read state of the
  67 .Vt SSL
  68 object
  69 .Fa ssl .
  70 .Pp
  71 .Fn SSL_rstate_string_long
  72 returns a string indicating the current read state of the
  73 .Vt SSL
  74 object
  75 .Fa ssl .
  76 .Pp
  77 When performing a read operation, the SSL/TLS engine must parse the record,
  78 consisting of header and body.
  79 When working in a blocking environment,
  80 .Fn SSL_rstate_string[_long]
  81 should always return
  82 .Qo RD Qc Ns / Ns Qo read done Qc .
  83 .Pp
  84 This function should only seldom be needed in applications.
  85 .Sh RETURN VALUES
  86 .Fn SSL_rstate_string
  87 and
  88 .Fn SSL_rstate_string_long
  89 can return the following values:
  90 .Bl -tag -width Ds
  91 .It Qo RH Qc Ns / Ns Qo read header Qc
  92 The header of the record is being evaluated.
  93 .It Qo RB Qc Ns / Ns Qo read body Qc
  94 The body of the record is being evaluated.
  95 .It Qo RD Qc Ns / Ns Qo read done Qc
  96 The record has been completely processed.
  97 .It Qo unknown Qc Ns / Ns Qo unknown Qc
  98 The read state is unknown.
  99 This should never happen.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr ssl 3
 103 .Sh HISTORY
 104 .Fn SSL_rstate_string
 105 and
 106 .Fn SSL_rstate_string_long
 107 appeared before SSLeay 0.8 and have been available since
 108 .Ox 2.4 .