usr/src/man/man3nsl/rpc_gss_mech_to_oid.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_MECH_TO_OID 3NSL "Feb 5, 2002"
   7 .SH NAME
   8 rpc_gss_mech_to_oid, rpc_gss_qop_to_num \- map mechanism, QOP strings to
   9 non-string values
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <rpc/rpcsec_gss.h>
  14
  15 \fBbool_t\fR \fBrpc_gss_mech_to_oid\fR(\fBcharc\fR\fI*mech\fR, \fBrpc_gss_OIDc\fR\fI*oid\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBbool_t\fR \fBrpc_gss_qop_to_num\fR(\fBchar\fR \fI*qop\fR, \fBchar\fR \fI*mech\fR, \fBu_int\fR \fI*num\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 Because in-kernel RPC routines use non-string values for mechanism and Quality
  27 of Protection (QOP), these routines exist to map strings for these attributes
  28 to their non-string counterparts.   (The non-string values for QOP and
  29 mechanism are also found in the \fB/etc/gss/qop\fR and \fB/etc/gss/mech\fR
  30 files, respectively.) \fBrpc_gss_mech_to_oid()\fR takes a string representing a
  31 mechanism, as well as a pointer to a \fBrpc_gss_OID\fR object identifier
  32 structure.  It then gives this structure values corresponding to the indicated
  33 mechanism, so that the application can now use the OID directly with RPC
  34 routines. \fBrpc_gss_qop_to_num()\fR does much the same thing, taking strings
  35 for QOP and mechanism and returning a number.
  36 .SH PARAMETERS
  37 .sp
  38 .LP
  39 Information on \fBRPCSEC_GSS\fR data types for parameters may be found on the
  40 \fBrpcsec_gss\fR(3NSL) man page.
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fImech\fR \fR
  45 .ad
  46 .RS 9n
  47 An ASCII string representing the security mechanism in use.  Valid strings may
  48 be found in the \fB/etc/gss/mech\fR file.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIoid\fR \fR
  55 .ad
  56 .RS 9n
  57 An object identifier of type \fBrpc_gss_OID\fR, whose elements are usable by
  58 kernel-level RPC routines.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIqop\fR \fR
  65 .ad
  66 .RS 9n
  67 This is an ASCII string which sets the quality of protection (QOP) for the
  68 session. Appropriate values for this string may be found in the file
  69 \fB/etc/gss/qop\fR.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fInum\fR \fR
  76 .ad
  77 .RS 9n
  78 The non-string value for the QOP.
  79 .RE
  80
  81 .SH RETURN VALUES
  82 .sp
  83 .LP
  84 Both functions return TRUE if they are successful, FALSE otherwise.
  85 .SH FILES
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB/etc/gss/mech\fR \fR
  90 .ad
  91 .RS 18n
  92 File containing valid security mechanisms
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB/etc/gss/qop\fR \fR
  99 .ad
 100 .RS 18n
 101 File containing valid QOP values
 102 .RE
 103
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 MT-Level        MT-Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBrpc\fR(3NSL), \fBrpc_gss_get_error\fR(3NSL), \fBrpc_gss_get_mechanisms\fR(3NSL), \fBrpcsec_gss\fR(3NSL), \fBmech\fR(4), \fBqop\fR(4), \fBattributes\fR(5)
 124 .sp
 125 .LP
 126 \fIONC+ Developer\&'s Guide\fR
 127 .sp