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

   1 '\" te
   2 .\" Copyright 2015 Nexenta Systems, Inc.  All rights reserved.
   3 .\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
   4 .\" Copyright 1989 AT&T
   5 .\" 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.
   6 .\" 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.
   7 .\" 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]
   8 .TH RPC_CLNT_AUTH 3NSL "Feb 18, 2015"
   9 .SH NAME
  10 rpc_clnt_auth, auth_destroy, authnone_create, authsys_create,
  11 authsys_create_default \- library routines for client side remote procedure
  12 call authentication
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <rpc/rpc.h>
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fBauth_destroy\fR(\fBAUTH *\fR\fIauth\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBAUTH *\fR\fBauthnone_create\fR(void);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBAUTH *\fR\fBauthsys_create\fR(\fBconst char *\fR\fIhost\fR, \fBconst uid_t\fR \fIuid\fR, \fBconst gid_t\fR \fIgid\fR,
  32      \fBconst int\fR \fIlen\fR, \fBconst gid_t *\fR\fIaup_gids\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBAUTH *\fR\fBauthsys_create_default\fR(void);
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .LP
  42 These routines are part of the \fBRPC\fR library that allows C language
  43 programs to make procedure calls on other machines across the network, with
  44 desired authentication.
  45 .sp
  46 .LP
  47 These routines are normally called after creating the \fBCLIENT\fR handle. The
  48 \fBcl_auth\fR field of the \fBCLIENT\fR structure should be initialized by the
  49 \fBAUTH\fR structure returned by some of the following routines. The client's
  50 authentication information is passed to the server when the \fBRPC\fR call is
  51 made.
  52 .sp
  53 .LP
  54 Only the \fBNULL\fR and the \fBSYS\fR style of authentication is discussed
  55 here. For the \fBDES\fR style authentication, please refer to
  56 \fBsecure_rpc\fR(3NSL).
  57 .sp
  58 .LP
  59 The \fBNULL\fR and \fBSYS\fR style of authentication are safe in multithreaded
  60 applications. For the MT-level of the \fBDES\fR style, see its pages.
  61 .SS "Routines"
  62 .LP
  63 Note: See \fBrpc\fR(3NSL) for the definition of the \fBAUTH\fR data structure.
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBauth_destroy()\fR\fR
  69 .ad
  70 .RS 26n
  71 A function macro that destroys the authentication information associated with
  72 \fIauth\fR. Destruction usually involves deallocation of private data
  73 structures. The use of \fIauth\fR is undefined after calling
  74 \fBauth_destroy()\fR.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBauthnone_create()\fR\fR
  81 .ad
  82 .RS 26n
  83 Create and return an RPC authentication handle that passes nonusable
  84 authentication information with each remote procedure call. This is the default
  85 authentication used by RPC.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBauthsys_create()\fR\fR
  92 .ad
  93 .RS 26n
  94 Create and return an \fBRPC\fR authentication handle that contains
  95 \fBAUTH_SYS\fR authentication information. The parameter \fIhost\fR is the name
  96 of the machine on which the information was created; \fIuid\fR is the user's
  97 user \fBID;\fR \fIgid\fR is the user's current group \fBID;\fR \fIlen\fR and
  98 \fIaup_gids\fR refer to a counted array of groups to which the user belongs.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fBauthsys_create_default()\fR
 105 .ad
 106 .RS 26n
 107 Call \fBauthsys_create()\fR with the appropriate parameters.
 108 .RE
 109
 110 .SH ATTRIBUTES
 111 .LP
 112 See \fBattributes\fR(5) for descriptions of the following attributes:
 113 .sp
 114
 115 .sp
 116 .TS
 117 box;
 118 c | c
 119 l | l .
 120 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 121 _
 122 MT-Level        MT-Safe
 123 .TE
 124
 125 .SH SEE ALSO
 126 .LP
 127 \fBrpc\fR(3NSL), \fBrpc_clnt_calls\fR(3NSL), \fBrpc_clnt_create\fR(3NSL),
 128 \fBsecure_rpc\fR(3NSL), \fBattributes\fR(5)