usr/src/man/man3nsl/rpc_gss_getcred.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_GETCRED 3NSL "Feb 5, 2002"
   7 .SH NAME
   8 rpc_gss_getcred \- get credentials of client
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <rpc/rpcsec_gss.h>
  13
  14 \fBbool_t\fR \fBrpc_gss_getcred\fR(\fBstruct svc_req\fR \fI*req\fR, \fBrpc_gss_rawcred_ t\fR \fI**rcred\fR,
  15      \fBrpc_gss_ucred\fR \fI**ucred\fR, \fBvoid\fR \fI**cookie\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 \fBrpc_gss_getcred()\fR is used by a server to fetch the credentials of a
  22 client.  These credentials may either be network credentials (in the form of a
  23 \fBrpc_gss_rawcred_t\fR structure) or UNIX credentials.
  24 .sp
  25 .LP
  26 For more information on \fBRPCSEC_GSS\fR data types, see the
  27 \fBrpcsec_gss\fR(3NSL) man page.
  28 .SH PARAMETERS
  29 .sp
  30 .LP
  31 Essentially,  \fBrpc_gss_getcred()\fR passes a pointer to a request
  32 (\fBsvc_req\fR) as well as pointers to two credential structures and a
  33 user-defined cookie; if \fBrpc_gss_getcred()\fR is successful, at least one
  34 credential structure is "filled out" with values, as is, optionally, the
  35 cookie.
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIreq\fR \fR
  40 .ad
  41 .RS 11n
  42 Pointer to the received service request.   \fBsvc_req\fR is an RPC structure
  43 containing information on the context of an RPC invocation, such as program,
  44 version, and transport information.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIrcred\fR \fR
  51 .ad
  52 .RS 11n
  53 A pointer to an \fBrpc_gss_rawcred_t\fR structure pointer. This structure
  54 contains the version number of the \fBRPCSEC_GSS\fR protocol being used; the
  55 security mechanism and QOPs for this session (as strings); principal names for
  56 the client (as a \fBrpc_gss_principal_t\fR structure) and server (as a string);
  57 and the security service (integrity, privacy, etc., as an enum).  If an
  58 application is not interested in these values, it may pass \fINULL\fR for this
  59 parameter.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIucred\fR \fR
  66 .ad
  67 .RS 11n
  68 The caller's UNIX credentials, in the form of a pointer to a pointer to a
  69 \fBrpc_gss_ucred_t\fR structure, which includes the client's uid and gids.  If
  70 an application is not interested in these values, it may pass \fINULL\fR for
  71 this parameter.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIcookie\fR \fR
  78 .ad
  79 .RS 11n
  80 A four-byte quantity that an application may use in any manner it wants to; RPC
  81 does not interpret it.  (For example, a cookie may be a pointer or index to a
  82 structure that represents a context initiator.) See also
  83 \fBrpc_gss_set_callback\fR(3NSL).
  84 .RE
  85
  86 .SH RETURN VALUES
  87 .sp
  88 .LP
  89 \fBrpc_gss_getcred()\fR returns  TRUE if it is successful; otherwise, use
  90 \fBrpc_gss_get_error()\fR to get the error associated with the failure.
  91 .SH ATTRIBUTES
  92 .sp
  93 .LP
  94 See  \fBattributes\fR(5) for descriptions of the following attributes:
  95 .sp
  96
  97 .sp
  98 .TS
  99 box;
 100 c | c
 101 l | l .
 102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 103 _
 104 MT-Level        MT-Safe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBrpc\fR(3NSL), \fBrpc_gss_set_callback\fR(3NSL), \fBrpc_gss_set_svc_name\fR(3NSL), \fBrpcsec_gss\fR(3NSL), \fBattributes\fR(5)
 111 .sp
 112 .LP
 113 \fIONC+ Developer\&'s Guide\fR
 114 .sp