xref: /minix3/lib/libc/rpc/rpc_clnt_auth.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\" @(#)rpc_clnt_auth.3n 1.21 93/05/07 SMI; from SVr4
2*2fe8fb19SBen Gras.\" Copyright 1989 AT&T
3*2fe8fb19SBen Gras.\" @(#)rpc_clnt_auth 1.4 89/07/20 SMI;
4*2fe8fb19SBen Gras.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
5*2fe8fb19SBen Gras.\"	$NetBSD: rpc_clnt_auth.3,v 1.6 2003/04/16 13:34:43 wiz Exp $
6*2fe8fb19SBen Gras.Dd May 7, 1993
7*2fe8fb19SBen Gras.Dt RPC_CLNT_AUTH 3
8*2fe8fb19SBen Gras.Os
9*2fe8fb19SBen Gras.Sh NAME
10*2fe8fb19SBen Gras.Nm auth_destroy ,
11*2fe8fb19SBen Gras.Nm authnone_create ,
12*2fe8fb19SBen Gras.Nm authsys_create ,
13*2fe8fb19SBen Gras.Nm authsys_create_default
14*2fe8fb19SBen Gras.Nd library routines for client side remote procedure call authentication
15*2fe8fb19SBen Gras.Sh LIBRARY
16*2fe8fb19SBen Gras.Lb libc
17*2fe8fb19SBen Gras.Sh SYNOPSIS
18*2fe8fb19SBen Gras.In rpc/rpc.h
19*2fe8fb19SBen Gras.Ft "void"
20*2fe8fb19SBen Gras.Fn auth_destroy "AUTH *auth"
21*2fe8fb19SBen Gras.Ft "AUTH *"
22*2fe8fb19SBen Gras.Fn authnone_create "void"
23*2fe8fb19SBen Gras.Ft "AUTH *"
24*2fe8fb19SBen Gras.Fn authsys_create "const char *host" "const uid_t uid" "const gid_t gid" "const int len" "const gid_t *aup_gids"
25*2fe8fb19SBen Gras.Ft "AUTH *"
26*2fe8fb19SBen Gras.Fn authsys_create_default "void"
27*2fe8fb19SBen Gras.Sh DESCRIPTION
28*2fe8fb19SBen GrasThese routines are part of the
29*2fe8fb19SBen GrasRPC library that allows C language programs to make procedure
30*2fe8fb19SBen Grascalls on other machines across the network,
31*2fe8fb19SBen Graswith desired authentication.
32*2fe8fb19SBen Gras.Pp
33*2fe8fb19SBen GrasThese routines are normally called after creating the
34*2fe8fb19SBen Gras.Dv CLIENT
35*2fe8fb19SBen Grashandle.
36*2fe8fb19SBen GrasThe
37*2fe8fb19SBen Gras.Fa cl_auth
38*2fe8fb19SBen Grasfield of the
39*2fe8fb19SBen Gras.Dv CLIENT
40*2fe8fb19SBen Grasstructure should be initialized by the
41*2fe8fb19SBen Gras.Dv AUTH
42*2fe8fb19SBen Grasstructure returned by some of the following routines.
43*2fe8fb19SBen GrasThe client's authentication information
44*2fe8fb19SBen Grasis passed to the server when the
45*2fe8fb19SBen GrasRPC
46*2fe8fb19SBen Grascall is made.
47*2fe8fb19SBen Gras.Pp
48*2fe8fb19SBen GrasOnly the
49*2fe8fb19SBen Gras.Dv NULL
50*2fe8fb19SBen Grasand the
51*2fe8fb19SBen Gras.Dv SYS
52*2fe8fb19SBen Grasstyle of authentication is discussed here.
53*2fe8fb19SBen Gras.Sh ROUTINES
54*2fe8fb19SBen Gras.Bl -tag -width authsys_create_default()
55*2fe8fb19SBen Gras.It Fn auth_destroy
56*2fe8fb19SBen GrasA function macro that destroys the authentication
57*2fe8fb19SBen Grasinformation associated with
58*2fe8fb19SBen Gras.Fa auth .
59*2fe8fb19SBen GrasDestruction usually involves deallocation
60*2fe8fb19SBen Grasof private data structures.
61*2fe8fb19SBen GrasThe use of
62*2fe8fb19SBen Gras.Fn auth
63*2fe8fb19SBen Grasis undefined after calling
64*2fe8fb19SBen Gras.Fn auth_destroy .
65*2fe8fb19SBen Gras.Pp
66*2fe8fb19SBen Gras.It Fn authnone_create
67*2fe8fb19SBen GrasCreate and return an RPC
68*2fe8fb19SBen Grasauthentication handle that passes nonusable
69*2fe8fb19SBen Grasauthentication information with each remote procedure call.
70*2fe8fb19SBen GrasThis is the default authentication used by RPC.
71*2fe8fb19SBen Gras.Pp
72*2fe8fb19SBen Gras.It Fn authsys_create
73*2fe8fb19SBen GrasCreate and return an RPC authentication handle that contains
74*2fe8fb19SBen Gras.Dv AUTH_SYS
75*2fe8fb19SBen Grasauthentication information.
76*2fe8fb19SBen GrasThe parameter
77*2fe8fb19SBen Gras.Fa host
78*2fe8fb19SBen Grasis the name of the machine on which the information was
79*2fe8fb19SBen Grascreated;
80*2fe8fb19SBen Gras.Fa uid
81*2fe8fb19SBen Grasis the user's user ID;
82*2fe8fb19SBen Gras.Fa gid
83*2fe8fb19SBen Grasis the user's current group ID;
84*2fe8fb19SBen Gras.Fa len
85*2fe8fb19SBen Grasand
86*2fe8fb19SBen Gras.Fa aup_gids
87*2fe8fb19SBen Grasrefer to a counted array of groups to which the user belongs.
88*2fe8fb19SBen Gras.Pp
89*2fe8fb19SBen Gras.It Fn authsys_create_default
90*2fe8fb19SBen GrasCall
91*2fe8fb19SBen Gras.Fn authsys_create
92*2fe8fb19SBen Graswith the appropriate parameters.
93*2fe8fb19SBen Gras.El
94*2fe8fb19SBen Gras.Sh SEE ALSO
95*2fe8fb19SBen Gras.Xr rpc 3 ,
96*2fe8fb19SBen Gras.Xr rpc_clnt_calls 3 ,
97*2fe8fb19SBen Gras.Xr rpc_clnt_create 3
98