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

   1 '\" te
   2 .\" Copyright (C) 2001, 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_GET_MECHANISMS 3NSL "Jun 29, 2001"
   7 .SH NAME
   8 rpc_gss_get_mechanisms, rpc_gss_get_mech_info, rpc_gss_get_versions,
   9 rpc_gss_is_installed \- get information on mechanisms and RPC version
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <rpc/rpcsec_gss.h>
  14
  15 \fBchar **\fR\fBrpc_gss_get_mechanisms\fR(\fB\fR\fI\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBchar **\fR\fBrpc_gss_get_mech_info\fR(\fBchar *\fR\fImech\fR, \fBrpc_gss_service_t *\fR\fIservice\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBbool_t\fR \fBrpc_gss_get_versions\fR(\fBu_int *\fR\fIvers_hi\fR, \fBu_int *\fR\fIvers_lo\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBbool_t rpc_gss_is\fR \fBinstalled\fR(\fBchar *\fR\fImech\fR);
  31 .fi
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 These "convenience functions" return information on available security
  37 mechanisms and versions of  \fBRPCSEC_GSS\fR .
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBrpc_gss_get_mechanisms()\fR \fR
  42 .ad
  43 .RS 29n
  44 Returns a list of supported security mechanisms as a null-terminated list of
  45 character strings.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBrpc_gss_get_mech_info()\fR \fR
  52 .ad
  53 .RS 29n
  54 Takes two arguments:  an ASCII string representing a mechanism type, for
  55 example, \fBkerberosv5\fR, and a pointer to a \fBrpc_gss_service_t\fR enum.
  56 \fBrpc_gss_get_mech_info()\fR will return \fBNULL\fR upon error or if no
  57 \fB/etc/gss/qop\fR file is present. Otherwise, it returns a null-terminated
  58 list of character strings of supported Quality of Protections (QOPs) for this
  59 mechanism. \fBNULL\fR or empty list implies only that the default QOP is
  60 available and can be specified to routines that need to take a QOP string
  61 parameter as NULL or as an empty string.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBrpc_gss_get_versions()\fR \fR
  68 .ad
  69 .RS 29n
  70 Returns the highest and lowest versions of  \fBRPCSEC_GSS\fR supported.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBrpc_gss_is_installed()\fR \fR
  77 .ad
  78 .RS 29n
  79 Takes an ASCII string representing a mechanism, and returns \fBTRUE\fR if the
  80 mechanism is installed.
  81 .RE
  82
  83 .SH PARAMETERS
  84 .sp
  85 .LP
  86 Information on \fBRPCSEC_GSS\fR data types for parameters may be found on the
  87 \fBrpcsec_gss\fR(3NSL) man page.
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fImech\fR \fR
  92 .ad
  93 .RS 12n
  94 An ASCII string representing the security mechanism in use.  Valid strings may
  95 also be found in the \fB/etc/gss/mech\fR file.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fIservice\fR \fR
 102 .ad
 103 .RS 12n
 104 A pointer to a \fBrpc_gss_service_t\fR enum, representing the current security
 105 service (privacy, integrity, or none).
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fIvers_hi\fR\fR
 112 .ad
 113 .br
 114 .na
 115 \fB\fIvers_lo\fR \fR
 116 .ad
 117 .RS 12n
 118 The highest and lowest versions of \fBRPCSEC_GSS\fR supported.
 119 .RE
 120
 121 .SH FILES
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fB/etc/gss/mech\fR \fR
 126 .ad
 127 .RS 18n
 128 File containing valid security mechanisms
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fB/etc/gss/qop\fR \fR
 135 .ad
 136 .RS 18n
 137 File containing valid QOP values
 138 .RE
 139
 140 .SH ATTRIBUTES
 141 .sp
 142 .LP
 143 See \fBattributes\fR(5) for descriptions of the following attributes:
 144 .sp
 145
 146 .sp
 147 .TS
 148 box;
 149 c | c
 150 l | l .
 151 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 152 _
 153 MT-Level        MT-Safe
 154 .TE
 155
 156 .SH SEE ALSO
 157 .sp
 158 .LP
 159 \fBrpc\fR(3NSL),\fBrpcsec_gss\fR(3NSL), \fBmech\fR(4), \fBqop\fR(4), \fBattributes\fR(5)
 160 .sp
 161 .LP
 162 \fIONC+ Developer\&'s Guide\fR
 163 .sp
 164 .LP
 165 Linn, J. \fIRFC 2743, Generic Security Service Application Program Interface Version 2, Update 1\fR. Network Working Group. January 2000.
 166 .SH NOTES
 167 .sp