Bring in a transport-independent RPC (TI-RPC).
[dragonfly.git] / lib / libc / rpc / rpc_clnt_auth.3
1 .\" @(#)rpc_clnt_auth.3n 1.21 93/05/07 SMI; from SVr4
2 .\" Copyright 1989 AT&T
3 .\" @(#)rpc_clnt_auth 1.4 89/07/20 SMI;
4 .\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
5 .\"     $NetBSD: rpc_clnt_auth.3,v 1.1 2000/06/03 09:29:50 fvdl Exp $
6 .\" $FreeBSD: src/lib/libc/rpc/rpc_clnt_auth.3,v 1.6 2005/02/09 18:03:14 ru Exp $
7 .\" $DragonFly$
8 .Dd May 7, 1993
9 .Dt RPC_CLNT_AUTH 3
10 .Os
11 .Sh NAME
12 .Nm auth_destroy ,
13 .Nm authnone_create ,
14 .Nm authsys_create ,
15 .Nm authsys_create_default
16 .Nd library routines for client side remote procedure call authentication
17 .Sh LIBRARY
18 .Lb libc
19 .Sh SYNOPSIS
20 .In rpc/rpc.h
21 .Ft "void"
22 .Fn auth_destroy "AUTH *auth"
23 .Ft "AUTH *"
24 .Fn authnone_create "void"
25 .Ft "AUTH *"
26 .Fn authsys_create "const char *host" "const uid_t uid" "const gid_t gid" "const int len" "const gid_t *aup_gids"
27 .Ft "AUTH *"
28 .Fn authsys_create_default "void"
29 .Sh DESCRIPTION
30 These routines are part of the
31 RPC library that allows C language programs to make procedure
32 calls on other machines across the network,
33 with desired authentication.
34 .Pp
35 These routines are normally called after creating the
36 .Vt CLIENT
37 handle.
38 The
39 .Va cl_auth
40 field of the
41 .Vt CLIENT
42 structure should be initialized by the
43 .Vt AUTH
44 structure returned by some of the following routines.
45 The client's authentication information
46 is passed to the server when the
47 RPC
48 call is made.
49 .Pp
50 Only the
51 .Dv NULL
52 and the
53 .Dv SYS
54 style of authentication is discussed here.
55 .Sh Routines
56 .Bl -tag -width authsys_create_default()
57 .It Fn auth_destroy
58 A function macro that destroys the authentication
59 information associated with
60 .Fa auth .
61 Destruction usually involves deallocation
62 of private data structures.
63 The use of
64 .Fa auth
65 is undefined after calling
66 .Fn auth_destroy .
67 .It Fn authnone_create
68 Create and return an RPC
69 authentication handle that passes nonusable
70 authentication information with each remote procedure call.
71 This is the default authentication used by RPC.
72 .It Fn authsys_create
73 Create and return an RPC authentication handle that contains
74 .Dv AUTH_SYS
75 authentication information.
76 The
77 .Fa host
78 argument
79 is the name of the machine on which the information was
80 created;
81 .Fa uid
82 is the user's user ID;
83 .Fa gid
84 is the user's current group ID;
85 .Fa len
86 and
87 .Fa aup_gids
88 refer to a counted array of groups to which the user belongs.
89 .It Fn authsys_create_default
90 Call
91 .Fn authsys_create
92 with the appropriate arguments.
93 .El
94 .Sh SEE ALSO
95 .Xr rpc 3 ,
96 .Xr rpc_clnt_calls 3 ,
97 .Xr rpc_clnt_create 3