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