xref: /freebsd/lib/libc/rpc/rpc_clnt_auth.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
18360efbdSAlfred Perlstein.\" Copyright 1989 AT&T
28360efbdSAlfred Perlstein.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
38360efbdSAlfred Perlstein.\"	$NetBSD: rpc_clnt_auth.3,v 1.1 2000/06/03 09:29:50 fvdl Exp $
48360efbdSAlfred Perlstein.Dd May 7, 1993
58360efbdSAlfred Perlstein.Dt RPC_CLNT_AUTH 3
68360efbdSAlfred Perlstein.Os
78360efbdSAlfred Perlstein.Sh NAME
88360efbdSAlfred Perlstein.Nm auth_destroy ,
98360efbdSAlfred Perlstein.Nm authnone_create ,
108360efbdSAlfred Perlstein.Nm authsys_create ,
118360efbdSAlfred Perlstein.Nm authsys_create_default
128360efbdSAlfred Perlstein.Nd library routines for client side remote procedure call authentication
138360efbdSAlfred Perlstein.Sh LIBRARY
148360efbdSAlfred Perlstein.Lb libc
158360efbdSAlfred Perlstein.Sh SYNOPSIS
1632eef9aeSRuslan Ermilov.In rpc/rpc.h
178360efbdSAlfred Perlstein.Ft "void"
188360efbdSAlfred Perlstein.Fn auth_destroy "AUTH *auth"
198360efbdSAlfred Perlstein.Ft "AUTH *"
208360efbdSAlfred Perlstein.Fn authnone_create "void"
218360efbdSAlfred Perlstein.Ft "AUTH *"
228360efbdSAlfred Perlstein.Fn authsys_create "const char *host" "const uid_t uid" "const gid_t gid" "const int len" "const gid_t *aup_gids"
238360efbdSAlfred Perlstein.Ft "AUTH *"
248360efbdSAlfred Perlstein.Fn authsys_create_default "void"
258360efbdSAlfred Perlstein.Sh DESCRIPTION
268360efbdSAlfred PerlsteinThese routines are part of the
278360efbdSAlfred PerlsteinRPC library that allows C language programs to make procedure
288360efbdSAlfred Perlsteincalls on other machines across the network,
298360efbdSAlfred Perlsteinwith desired authentication.
308360efbdSAlfred Perlstein.Pp
318360efbdSAlfred PerlsteinThese routines are normally called after creating the
328360efbdSAlfred Perlstein.Vt CLIENT
338360efbdSAlfred Perlsteinhandle.
348360efbdSAlfred PerlsteinThe
358360efbdSAlfred Perlstein.Va cl_auth
368360efbdSAlfred Perlsteinfield of the
378360efbdSAlfred Perlstein.Vt CLIENT
388360efbdSAlfred Perlsteinstructure should be initialized by the
398360efbdSAlfred Perlstein.Vt AUTH
408360efbdSAlfred Perlsteinstructure returned by some of the following routines.
418360efbdSAlfred PerlsteinThe client's authentication information
428360efbdSAlfred Perlsteinis passed to the server when the
438360efbdSAlfred PerlsteinRPC
448360efbdSAlfred Perlsteincall is made.
458360efbdSAlfred Perlstein.Pp
468360efbdSAlfred PerlsteinOnly the
478360efbdSAlfred Perlstein.Dv NULL
488360efbdSAlfred Perlsteinand the
498360efbdSAlfred Perlstein.Dv SYS
508360efbdSAlfred Perlsteinstyle of authentication is discussed here.
518360efbdSAlfred Perlstein.Sh Routines
528360efbdSAlfred Perlstein.Bl -tag -width authsys_create_default()
538360efbdSAlfred Perlstein.It Fn auth_destroy
548360efbdSAlfred PerlsteinA function macro that destroys the authentication
558360efbdSAlfred Perlsteininformation associated with
568360efbdSAlfred Perlstein.Fa auth .
578360efbdSAlfred PerlsteinDestruction usually involves deallocation
588360efbdSAlfred Perlsteinof private data structures.
598360efbdSAlfred PerlsteinThe use of
6011d84435SRuslan Ermilov.Fa auth
618360efbdSAlfred Perlsteinis undefined after calling
628360efbdSAlfred Perlstein.Fn auth_destroy .
638360efbdSAlfred Perlstein.It Fn authnone_create
648360efbdSAlfred PerlsteinCreate and return an RPC
658360efbdSAlfred Perlsteinauthentication handle that passes nonusable
668360efbdSAlfred Perlsteinauthentication information with each remote procedure call.
678360efbdSAlfred PerlsteinThis is the default authentication used by RPC.
688360efbdSAlfred Perlstein.It Fn authsys_create
698360efbdSAlfred PerlsteinCreate and return an RPC authentication handle that contains
708360efbdSAlfred Perlstein.Dv AUTH_SYS
718360efbdSAlfred Perlsteinauthentication information.
722efeeba5SRuslan ErmilovThe
738360efbdSAlfred Perlstein.Fa host
742efeeba5SRuslan Ermilovargument
758360efbdSAlfred Perlsteinis the name of the machine on which the information was
768360efbdSAlfred Perlsteincreated;
778360efbdSAlfred Perlstein.Fa uid
788360efbdSAlfred Perlsteinis the user's user ID;
798360efbdSAlfred Perlstein.Fa gid
808360efbdSAlfred Perlsteinis the user's current group ID;
818360efbdSAlfred Perlstein.Fa len
828360efbdSAlfred Perlsteinand
838360efbdSAlfred Perlstein.Fa aup_gids
848360efbdSAlfred Perlsteinrefer to a counted array of groups to which the user belongs.
858360efbdSAlfred Perlstein.It Fn authsys_create_default
868360efbdSAlfred PerlsteinCall
878360efbdSAlfred Perlstein.Fn authsys_create
882efeeba5SRuslan Ermilovwith the appropriate arguments.
898360efbdSAlfred Perlstein.El
908360efbdSAlfred Perlstein.Sh SEE ALSO
918360efbdSAlfred Perlstein.Xr rpc 3 ,
928360efbdSAlfred Perlstein.Xr rpc_clnt_calls 3 ,
938360efbdSAlfred Perlstein.Xr rpc_clnt_create 3
94