xref: /illumos-gate/usr/src/man/man3nsl/rpc_gss_get_mechanisms.3nsl (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright (C) 2001, 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_GET_MECHANISMS 3NSL "Jun 29, 2001"
NAME
rpc_gss_get_mechanisms, rpc_gss_get_mech_info, rpc_gss_get_versions, rpc_gss_is_installed - get information on mechanisms and RPC version
SYNOPSIS

#include <rpc/rpcsec_gss.h>

char **rpc_gss_get_mechanisms();

char **rpc_gss_get_mech_info(char *mech, rpc_gss_service_t *service);

bool_t rpc_gss_get_versions(u_int *vers_hi, u_int *vers_lo);

bool_t rpc_gss_is installed(char *mech);
DESCRIPTION

These "convenience functions" return information on available security mechanisms and versions of RPCSEC_GSS . rpc_gss_get_mechanisms()

Returns a list of supported security mechanisms as a null-terminated list of character strings.

rpc_gss_get_mech_info()

Takes two arguments: an ASCII string representing a mechanism type, for example, kerberosv5, and a pointer to a rpc_gss_service_t enum. rpc_gss_get_mech_info() will return NULL upon error or if no /etc/gss/qop file is present. Otherwise, it returns a null-terminated list of character strings of supported Quality of Protections (QOPs) for this mechanism. NULL or empty list implies only that the default QOP is available and can be specified to routines that need to take a QOP string parameter as NULL or as an empty string.

rpc_gss_get_versions()

Returns the highest and lowest versions of RPCSEC_GSS supported.

rpc_gss_is_installed()

Takes an ASCII string representing a mechanism, and returns TRUE if the mechanism is installed.

PARAMETERS

Information on RPCSEC_GSS data types for parameters may be found on the rpcsec_gss(3NSL) man page. mech

An ASCII string representing the security mechanism in use. Valid strings may also be found in the /etc/gss/mech file.

service

A pointer to a rpc_gss_service_t enum, representing the current security service (privacy, integrity, or none).

vers_hi

vers_lo

The highest and lowest versions of RPCSEC_GSS supported.

FILES
/etc/gss/mech

File containing valid security mechanisms

/etc/gss/qop

File containing valid QOP values

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), mech (5), qop (5), attributes (7)

ONC+ Developer's Guide

Linn, J. RFC 2743, Generic Security Service Application Program Interface Version 2, Update 1. Network Working Group. January 2000.

NOTES