usr/src/man/man3nsl/rpc_gss_set_svc_name.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_SET_SVC_NAME 3NSL "Feb 5, 2002"
   7 .SH NAME
   8 rpc_gss_set_svc_name \- send a principal name to a server
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <rpc/rpcsec_gss.h>
  13
  14 \fBbool_t\fR \fBrpc_gss_set_svc_name\fR(\fBchar\fR \fI*principal\fR, \fBchar\fR \fI*mechanism\fR,
  15      \fBu_int\fR \fIreq_time\fR,\fBu_int\fR \fIprogram\fR, \fBu_int\fR \fIversion\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 \fBrpc_gss_set_svc_name()\fR sets the name of a principal the server is to
  22 represent.  If a server is going to act as more than one principal, this
  23 procedure can be invoked for every such principal.
  24 .SH PARAMETERS
  25 .sp
  26 .LP
  27 Information on \fBRPCSEC_GSS\fR data types for parameters may be found on the
  28 \fBrpcsec_gss\fR(3NSL) man page.
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIprincipal\fR\fR
  33 .ad
  34 .RS 13n
  35 An ASCII string representing the server's principal name, given in the form of
  36 \fIservice\fR@\fIhost\fR.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fImech\fR\fR
  43 .ad
  44 .RS 13n
  45 An \fBASCII\fR string representing the security mechanism in use.  Valid
  46 strings may be found in the \fB/etc/gss/mech\fR file, or by using
  47 \fBrpc_gss_get_mechanisms()\fR.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIreq_time\fR\fR
  54 .ad
  55 .RS 13n
  56 The time, in seconds, for which a credential should be valid. Note that the
  57 \fIreq_time\fR is a hint to the underlying mechanism. The actual time that the
  58 credential will remain valid is mechanism dependent. In the case of kerberos
  59 the actual time will be \fBGSS_C_INDEFINITE\fR.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIprogram\fR\fR
  66 .ad
  67 .RS 13n
  68 The \fBRPC\fR program number for this service.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fIversion\fR\fR
  75 .ad
  76 .RS 13n
  77 The \fBRPC\fR version number for this service.
  78 .RE
  79
  80 .SH RETURN VALUES
  81 .sp
  82 .LP
  83 \fBrpc_gss_set_svc_name()\fR returns  \fBTRUE\fR if it is successful;
  84 otherwise, use  \fBrpc_gss_get_error()\fR to get the error associated with the
  85 failure.
  86 .SH FILES
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB/etc/gss/mech\fR\fR
  91 .ad
  92 .RS 17n
  93 File containing valid security mechanisms
  94 .RE
  95
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 MT-Level        MT-Safe
 110 .TE
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBrpc\fR(3NSL), \fBrpc_gss_get_mechanisms\fR(3NSL), \fBrpc_gss_get_principal_name\fR(3NSL), \fBrpcsec_gss\fR(3NSL), \fBmech\fR(4), \fBattributes\fR(5)
 116 .sp
 117 .LP
 118 \fIONC+ Developer\&'s Guide\fR
 119 .sp