xref: /dflybsd-src/lib/libc/rpc/rpc_clnt_auth.3 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" @(#)rpc_clnt_auth.3n 1.21 93/05/07 SMI; from SVr4
286d7f5d3SJohn Marino.\" Copyright 1989 AT&T
386d7f5d3SJohn Marino.\" @(#)rpc_clnt_auth 1.4 89/07/20 SMI;
486d7f5d3SJohn Marino.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
586d7f5d3SJohn Marino.\"	$NetBSD: rpc_clnt_auth.3,v 1.1 2000/06/03 09:29:50 fvdl Exp $
686d7f5d3SJohn Marino.\" $FreeBSD: src/lib/libc/rpc/rpc_clnt_auth.3,v 1.6 2005/02/09 18:03:14 ru Exp $
786d7f5d3SJohn Marino.Dd May 7, 1993
886d7f5d3SJohn Marino.Dt RPC_CLNT_AUTH 3
986d7f5d3SJohn Marino.Os
1086d7f5d3SJohn Marino.Sh NAME
1186d7f5d3SJohn Marino.Nm auth_destroy ,
1286d7f5d3SJohn Marino.Nm authnone_create ,
1386d7f5d3SJohn Marino.Nm authsys_create ,
1486d7f5d3SJohn Marino.Nm authsys_create_default
1586d7f5d3SJohn Marino.Nd library routines for client side remote procedure call authentication
1686d7f5d3SJohn Marino.Sh LIBRARY
1786d7f5d3SJohn Marino.Lb libc
1886d7f5d3SJohn Marino.Sh SYNOPSIS
1986d7f5d3SJohn Marino.In rpc/rpc.h
2086d7f5d3SJohn Marino.Ft "void"
2186d7f5d3SJohn Marino.Fn auth_destroy "AUTH *auth"
2286d7f5d3SJohn Marino.Ft "AUTH *"
2386d7f5d3SJohn Marino.Fn authnone_create "void"
2486d7f5d3SJohn Marino.Ft "AUTH *"
2586d7f5d3SJohn Marino.Fn authsys_create "const char *host" "const uid_t uid" "const gid_t gid" "const int len" "const gid_t *aup_gids"
2686d7f5d3SJohn Marino.Ft "AUTH *"
2786d7f5d3SJohn Marino.Fn authsys_create_default "void"
2886d7f5d3SJohn Marino.Sh DESCRIPTION
2986d7f5d3SJohn MarinoThese routines are part of the
3086d7f5d3SJohn MarinoRPC library that allows C language programs to make procedure
3186d7f5d3SJohn Marinocalls on other machines across the network,
3286d7f5d3SJohn Marinowith desired authentication.
3386d7f5d3SJohn Marino.Pp
3486d7f5d3SJohn MarinoThese routines are normally called after creating the
3586d7f5d3SJohn Marino.Vt CLIENT
3686d7f5d3SJohn Marinohandle.
3786d7f5d3SJohn MarinoThe
3886d7f5d3SJohn Marino.Va cl_auth
3986d7f5d3SJohn Marinofield of the
4086d7f5d3SJohn Marino.Vt CLIENT
4186d7f5d3SJohn Marinostructure should be initialized by the
4286d7f5d3SJohn Marino.Vt AUTH
4386d7f5d3SJohn Marinostructure returned by some of the following routines.
4486d7f5d3SJohn MarinoThe client's authentication information
4586d7f5d3SJohn Marinois passed to the server when the
4686d7f5d3SJohn MarinoRPC
4786d7f5d3SJohn Marinocall is made.
4886d7f5d3SJohn Marino.Pp
4986d7f5d3SJohn MarinoOnly the
5086d7f5d3SJohn Marino.Dv NULL
5186d7f5d3SJohn Marinoand the
5286d7f5d3SJohn Marino.Dv SYS
5386d7f5d3SJohn Marinostyle of authentication is discussed here.
5486d7f5d3SJohn Marino.Sh Routines
5586d7f5d3SJohn Marino.Bl -tag -width authsys_create_default()
5686d7f5d3SJohn Marino.It Fn auth_destroy
5786d7f5d3SJohn MarinoA function macro that destroys the authentication
5886d7f5d3SJohn Marinoinformation associated with
5986d7f5d3SJohn Marino.Fa auth .
6086d7f5d3SJohn MarinoDestruction usually involves deallocation
6186d7f5d3SJohn Marinoof private data structures.
6286d7f5d3SJohn MarinoThe use of
6386d7f5d3SJohn Marino.Fa auth
6486d7f5d3SJohn Marinois undefined after calling
6586d7f5d3SJohn Marino.Fn auth_destroy .
6686d7f5d3SJohn Marino.It Fn authnone_create
6786d7f5d3SJohn MarinoCreate and return an RPC
6886d7f5d3SJohn Marinoauthentication handle that passes nonusable
6986d7f5d3SJohn Marinoauthentication information with each remote procedure call.
7086d7f5d3SJohn MarinoThis is the default authentication used by RPC.
7186d7f5d3SJohn Marino.It Fn authsys_create
7286d7f5d3SJohn MarinoCreate and return an RPC authentication handle that contains
7386d7f5d3SJohn Marino.Dv AUTH_SYS
7486d7f5d3SJohn Marinoauthentication information.
7586d7f5d3SJohn MarinoThe
7686d7f5d3SJohn Marino.Fa host
7786d7f5d3SJohn Marinoargument
7886d7f5d3SJohn Marinois the name of the machine on which the information was
7986d7f5d3SJohn Marinocreated;
8086d7f5d3SJohn Marino.Fa uid
8186d7f5d3SJohn Marinois the user's user ID;
8286d7f5d3SJohn Marino.Fa gid
8386d7f5d3SJohn Marinois the user's current group ID;
8486d7f5d3SJohn Marino.Fa len
8586d7f5d3SJohn Marinoand
8686d7f5d3SJohn Marino.Fa aup_gids
8786d7f5d3SJohn Marinorefer to a counted array of groups to which the user belongs.
8886d7f5d3SJohn Marino.It Fn authsys_create_default
8986d7f5d3SJohn MarinoCall
9086d7f5d3SJohn Marino.Fn authsys_create
9186d7f5d3SJohn Marinowith the appropriate arguments.
9286d7f5d3SJohn Marino.El
9386d7f5d3SJohn Marino.Sh SEE ALSO
9486d7f5d3SJohn Marino.Xr rpc 3 ,
9586d7f5d3SJohn Marino.Xr rpc_clnt_calls 3 ,
9686d7f5d3SJohn Marino.Xr rpc_clnt_create 3
97