usr/src/man/man3nsl/rpc_gss_max_data_length.3nsl

   1 '\" te
   2 .\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH RPC_GSS_MAX_DATA_LENGTH 3NSL "Feb 5, 2002"
   7 .SH NAME
   8 rpc_gss_max_data_length, rpc_gss_svc_max_data_length \- get maximum data length
   9 for  transmission
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <rpc/rpcsec_gss.h>
  14
  15 \fBint\fR \fBrpc_gss_max_data_length\fR(\fBAUTH\fR \fI*handle\fR, \fBint\fR \fImax_tp_unit_len\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBrpc_gss_svc_max_data_length\fR(\fBstruct svc_req\fR \fI*req\fR, \fBint\fR \fImax_tp_unit_len\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 Performing a security transformation on a piece of data generally produces
  27 data with a different (usually greater) length.  For some transports, such as
  28 UDP, there is a maximum length of data which can be sent out in one data unit.
  29 Applications need to know the maximum size a piece of data can be before it's
  30 transformed, so that the resulting data will still "fit" on the transport.
  31 These two functions return that maximum size.
  32 .sp
  33 .LP
  34 \fBrpc_gss_max_data_length()\fR is the client-side version;
  35 \fBrpc_gss_svc_max_data_length()\fR is the server-side version.
  36 .SH PARAMETERS
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIhandle\fR \fR
  41 .ad
  42 .RS 20n
  43 An RPC context handle of type \fBAUTH,\fR returned when a context is created
  44 (for example, by \fBrpc_gss_seccreate()\fR. Security service and QOP are bound
  45 to this handle, eliminating any need to specify them.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fImax_tp_unit_len\fR \fR
  52 .ad
  53 .RS 20n
  54 The maximum size of a piece of data allowed by the transport.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIreq\fR \fR
  61 .ad
  62 .RS 20n
  63 A pointer to an RPC \fBsvc_req\fR structure, containing information on the
  64 context (for example, program number and credentials).
  65 .RE
  66
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 Both functions return the maximum size of untransformed data allowed, as an
  71 \fBint\fR.
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5) for descriptions of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 _
  85 MT-Level        MT-Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBrpc\fR(3NSL), \fBrpcsec_gss\fR(3NSL), \fBattributes\fR(5)
  92 .sp
  93 .LP
  94 \fIONC+ Developer\&'s Guide\fR
  95 .sp