xref: /freebsd/lib/librpcsec_gss/rpc_gss_max_data_length.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
18f55a568SDoug Rabson.\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
28f55a568SDoug Rabson.\" Authors: Doug Rabson <dfr@rabson.org>
362486687SUlrich Spörlein.\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
48f55a568SDoug Rabson.\"
58f55a568SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
68f55a568SDoug Rabson.\" modification, are permitted provided that the following conditions
78f55a568SDoug Rabson.\" are met:
88f55a568SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
98f55a568SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
108f55a568SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
118f55a568SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
128f55a568SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
138f55a568SDoug Rabson.\"
148f55a568SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
158f55a568SDoug Rabson.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
168f55a568SDoug Rabson.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
178f55a568SDoug Rabson.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
188f55a568SDoug Rabson.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
198f55a568SDoug Rabson.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
208f55a568SDoug Rabson.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
218f55a568SDoug Rabson.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
228f55a568SDoug Rabson.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
238f55a568SDoug Rabson.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
248f55a568SDoug Rabson.\" SUCH DAMAGE.
25621d0bd3SGavin Atkinson.Dd January 26, 2010
268f55a568SDoug Rabson.Dt RPC_GSS_MAX_DATA_LENGTH 3
278f55a568SDoug Rabson.Os
288f55a568SDoug Rabson.Sh NAME
298f55a568SDoug Rabson.Nm rpc_gss_max_data_length
308f55a568SDoug Rabson.Nd "calculate maximum data size"
318f55a568SDoug Rabson.Sh LIBRARY
328f55a568SDoug Rabson.Lb librpcsec_gss
338f55a568SDoug Rabson.Sh SYNOPSIS
348f55a568SDoug Rabson.In rpc/rpcsec_gss.h
358f55a568SDoug Rabson.Ft int
368f55a568SDoug Rabson.Fn rpc_gss_max_data_length "AUTH *auth" "int max_tp_unit_len"
378f55a568SDoug Rabson.Sh DESCRIPTION
388f55a568SDoug RabsonCalculate the maximum message size that will fit into a packet of size
398f55a568SDoug Rabson.Fa max_tp_unit_len ,
408f55a568SDoug Rabsongiven the current service and QoP setting.
418f55a568SDoug Rabson.Sh PARAMETERS
425d53fe39SJoel Dahl.Bl -tag -width ".It max_tp_unit_len"
438f55a568SDoug Rabson.It auth
4412613c1aSJens SchweikhardtA handle to a RPCSEC_GSS security context
458f55a568SDoug Rabson.It max_tp_unit_len
468f55a568SDoug RabsonMaximum packet size of the underlying transport protocol
478f55a568SDoug Rabson.El
488f55a568SDoug Rabson.Sh RETURN VALUES
498f55a568SDoug RabsonThe maximum message size that can be encoded
508f55a568SDoug Rabson.Sh SEE ALSO
518f55a568SDoug Rabson.Xr gssapi 3 ,
525e4517a4SJoel Dahl.Xr rpc 3 ,
53*a09bb0edSJens Schweikhardt.Xr rpcsec_gss 3
548f55a568SDoug Rabson.Sh HISTORY
558f55a568SDoug RabsonThe
568f55a568SDoug Rabson.Nm
57ffae047bSGavin Atkinsonfunction first appeared in
588f55a568SDoug Rabson.Fx 8.0 .
598f55a568SDoug Rabson.Sh AUTHORS
608f55a568SDoug RabsonThis
618f55a568SDoug Rabsonmanual page was written by
622b7af31cSBaptiste Daroussin.An Doug Rabson Aq Mt dfr@FreeBSD.org .
63