lib/libssl/man/SSL_set_max_send_fragment.3

   1 .\"     $OpenBSD: SSL_set_max_send_fragment.3,v 1.2 2016/12/16 15:39:08 jmc Exp $
   2 .\"     OpenSSL doc/man3/SSL_CTX_set_split_send_fragment.pod
   3 .\"     OpenSSL 6782e5fd Oct 21 16:16:20 2016 +0100
   4 .\"
   5 .\" This file was written by Matt Caswell <matt@openssl.org>.
   6 .\" Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\"
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\"
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in
  17 .\"    the documentation and/or other materials provided with the
  18 .\"    distribution.
  19 .\"
  20 .\" 3. All advertising materials mentioning features or use of this
  21 .\"    software must display the following acknowledgment:
  22 .\"    "This product includes software developed by the OpenSSL Project
  23 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24 .\"
  25 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26 .\"    endorse or promote products derived from this software without
  27 .\"    prior written permission. For written permission, please contact
  28 .\"    openssl-core@openssl.org.
  29 .\"
  30 .\" 5. Products derived from this software may not be called "OpenSSL"
  31 .\"    nor may "OpenSSL" appear in their names without prior written
  32 .\"    permission of the OpenSSL Project.
  33 .\"
  34 .\" 6. Redistributions of any form whatsoever must retain the following
  35 .\"    acknowledgment:
  36 .\"    "This product includes software developed by the OpenSSL Project
  37 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38 .\"
  39 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  51 .\"
  52 .Dd $Mdocdate: December 16 2016 $
  53 .Dt SSL_SET_MAX_SEND_FRAGMENT 3
  54 .Os
  55 .Sh NAME
  56 .Nm SSL_CTX_set_max_send_fragment ,
  57 .Nm SSL_set_max_send_fragment
  58 .Nd control fragment sizes
  59 .Sh SYNOPSIS
  60 .In openssl/ssl.h
  61 .Ft long
  62 .Fo SSL_CTX_set_max_send_fragment
  63 .Fa "SSL_CTX *ctx"
  64 .Fa "long m"
  65 .Fc
  66 .Ft long
  67 .Fo SSL_set_max_send_fragment
  68 .Fa "SSL *ssl"
  69 .Fa "long m"
  70 .Fc
  71 .Sh DESCRIPTION
  72 .Fn SSL_CTX_set_max_send_fragment
  73 and
  74 .Fn SSL_set_max_send_fragment
  75 set the
  76 .Sy max_send_fragment
  77 parameter for SSL_CTX and SSL objects respectively.
  78 This value restricts the amount of plaintext bytes that will be sent in
  79 any one SSL/TLS record.
  80 By default its value is SSL3_RT_MAX_PLAIN_LENGTH (16384).
  81 These functions will only accept a value in the range 512 -
  82 SSL3_RT_MAX_PLAIN_LENGTH.
  83 .Pp
  84 These functions are implemented using macros.
  85 .Sh RETURN VALUES
  86 These functions return 1 on success or 0 on failure.
  87 .Sh SEE ALSO
  88 .Xr SSL_CTX_set_read_ahead 3 ,
  89 .Xr SSL_pending 3