xref: /illumos-gate/usr/src/man/man3nsl/rpc_gss_max_data_length.3nsl (revision 0245b61fd282e95735b173b8d95be0d6688163b4)
te
Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
RPC_GSS_MAX_DATA_LENGTH 3NSL "Feb 5, 2002"
NAME
rpc_gss_max_data_length, rpc_gss_svc_max_data_length - get maximum data length for transmission
SYNOPSIS

#include <rpc/rpcsec_gss.h>

int rpc_gss_max_data_length(AUTH *handle, int max_tp_unit_len);

int rpc_gss_svc_max_data_length(struct svc_req *req, int max_tp_unit_len);
DESCRIPTION

Performing a security transformation on a piece of data generally produces data with a different (usually greater) length. For some transports, such as UDP, there is a maximum length of data which can be sent out in one data unit. Applications need to know the maximum size a piece of data can be before it's transformed, so that the resulting data will still "fit" on the transport. These two functions return that maximum size.

rpc_gss_max_data_length() is the client-side version; rpc_gss_svc_max_data_length() is the server-side version.

PARAMETERS
handle

An RPC context handle of type AUTH, returned when a context is created (for example, by rpc_gss_seccreate(). Security service and QOP are bound to this handle, eliminating any need to specify them.

max_tp_unit_len

The maximum size of a piece of data allowed by the transport.

req

A pointer to an RPC svc_req structure, containing information on the context (for example, program number and credentials).

RETURN VALUES

Both functions return the maximum size of untransformed data allowed, as an int.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

rpc (3NSL), rpcsec_gss (3NSL), attributes (7)

ONC+ Developer's Guide