\" @(#)rpc_clnt_auth.3n 1.21 93/05/07 SMI; from SVr4
\" Copyright 1989 AT&T
\" @(#)rpc_clnt_auth 1.4 89/07/20 SMI;
\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
\" $NetBSD: rpc_clnt_auth.3,v 1.7 2020/10/03 18:31:29 christos Exp $
Dd October 3, 2020
Dt RPC_CLNT_AUTH 3
Os
Sh NAME
Nm auth_destroy ,
Nm authnone_create ,
Nm authsys_create ,
Nm authsys_create_default ,
Nm set_rpc_maxgrouplist
Nd library routines for client side remote procedure call authentication
Sh LIBRARY
Lb libc
Sh SYNOPSIS
In rpc/rpc.h
Ft "void"
Fn auth_destroy "AUTH *auth"
Ft "AUTH *"
Fn authnone_create "void"
Ft "AUTH *"
Fn authsys_create "const char *host" "const uid_t uid" "const gid_t gid" "const int len" "const gid_t *aup_gids"
Ft "AUTH *"
Fn authsys_create_default "void"
Ft "void"
Fn set_rpc_maxgrouplist "int num"
Sh DESCRIPTION
These routines are part of the
RPC library that allows C language programs to make procedure
calls on other machines across the network,
with desired authentication.
Pp
These routines are normally called after creating the
Dv CLIENT
handle.
The
Fa cl_auth
field of the
Dv CLIENT
structure should be initialized by the
Dv AUTH
structure returned by some of the following routines.
The client's authentication information
is passed to the server when the
RPC
call is made.
Pp
Only the
Dv NULL
and the
Dv SYS
style of authentication is discussed here.
Sh ROUTINES
Bl -tag -width authsys_create_default()
It Fn auth_destroy
A function macro that destroys the authentication
information associated with
Fa auth .
Destruction usually involves deallocation
of private data structures.
The use of
Fn auth
is undefined after calling
Fn auth_destroy .
Pp
It Fn authnone_create
Create and return an RPC
authentication handle that passes nonusable
authentication information with each remote procedure call.
This is the default authentication used by RPC.
Pp
It Fn authsys_create
Create and return an RPC authentication handle that contains
Dv AUTH_SYS
authentication information.
The parameter
Fa host
is the name of the machine on which the information was
created;
Fa uid
is the user's user ID;
Fa gid
is the user's current group ID;
Fa len
and
Fa aup_gids
refer to a counted array of groups to which the user belongs.
Pp
It Fn authsys_create_default
Call
Fn authsys_create
with the appropriate parameters.
Pp
It Fn set_rpc_maxgrouplist
Allow the application to set the maximum size of the group list
that will be used in
Fn authunix_create_default to
Fa num .
Some servers will refuse mounts if the group list is larger than it expects
(like 8).
El
Sh SEE ALSO
Xr rpc 3 ,
Xr rpc_clnt_calls 3 ,
Xr rpc_clnt_create 3
