Current File : //usr/share/man/man3nsl/rpc_gss_mech_to_oid.3nsl

'\" te
.\" Copyright (c) 2002, 2011, Oracle and/or its affiliates. All rights reserved.
.TH rpc_gss_mech_to_oid 3NSL "22 Aug 2011" "SunOS 5.11" "Networking Services Library Functions"
.SH NAME
rpc_gss_mech_to_oid, rpc_gss_qop_to_num \- map mechanism, QOP strings to non-string values
.SH SYNOPSIS
.LP
.nf
#include <rpc/rpcsec_gss.h> 

\fBbool_t\fR \fBrpc_gss_mech_to_oid\fR(\fBcharc\fR\fI*mech\fR, \fBrpc_gss_OIDc\fR\fI*oid\fR);
.fi

.LP
.nf
\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);
.fi

.SH DESCRIPTION
.sp
.LP
Because in-kernel RPC routines use non-string values for mechanism and Quality of Protection (QOP), these routines exist to map strings for these attributes to their non-string counterparts.   (The non-string values for QOP and mechanism are also found in the \fB/etc/gss/qop\fR and \fB/etc/gss/mech\fR files, respectively.) \fBrpc_gss_mech_to_oid()\fR takes a string representing a mechanism, as well as a pointer to a \fBrpc_gss_OID\fR object identifier structure.  It then gives this structure values corresponding to the indicated mechanism, so that the application can now use the OID directly with RPC routines. \fBrpc_gss_qop_to_num()\fR does much the same thing, taking strings for QOP and mechanism and returning a number.
.SH PARAMETERS
.sp
.LP
Information on \fBRPCSEC_GSS\fR data types for parameters may be found on the \fBrpcsec_gss\fR(3NSL) man page.
.sp
.ne 2
.mk
.na
\fB\fImech\fR \fR
.ad
.RS 9n
.rt  
An ASCII string representing the security mechanism in use.  Valid strings may be found in the \fB/etc/gss/mech\fR file.
.RE

.sp
.ne 2
.mk
.na
\fB\fIoid\fR \fR
.ad
.RS 9n
.rt  
An object identifier of type \fBrpc_gss_OID\fR, whose elements are usable by kernel-level RPC routines.
.RE

.sp
.ne 2
.mk
.na
\fB\fIqop\fR \fR
.ad
.RS 9n
.rt  
This is an ASCII string which sets the quality of protection (QOP) for the session. Appropriate values for this string may be found in the file \fB/etc/gss/qop\fR. 
.RE

.sp
.ne 2
.mk
.na
\fB\fInum\fR \fR
.ad
.RS 9n
.rt  
The non-string value for the QOP.
.RE

.SH RETURN VALUES
.sp
.LP
Both functions return TRUE if they are successful, FALSE otherwise.
.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/etc/gss/mech\fR \fR
.ad
.RS 18n
.rt  
File containing valid security mechanisms
.RE

.sp
.ne 2
.mk
.na
\fB\fB/etc/gss/qop\fR \fR
.ad
.RS 18n
.rt  
File containing valid QOP values
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/library/security/rpcsec
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\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) 
.sp
.LP
\fIONC+ RPC Developer\&'s Guide\fR
.sp
.LP
Linn, J. \fIRFC 2078, Generic Security Service Application Program Interface, Version 2\fR. Network Working Group. January 1997.