xref: /illumos-gate/usr/src/man/man3nsl/rpc_clnt_auth.3nsl (revision dd72704bd9e794056c558153663c739e2012d721)
te
Copyright 2015 Nexenta Systems, Inc. All rights reserved.
Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
Copyright 1989 AT&T
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
RPC_CLNT_AUTH 3NSL "Feb 18, 2015"
NAME
rpc_clnt_auth, auth_destroy, authnone_create, authsys_create, authsys_create_default - library routines for client side remote procedure call authentication
SYNOPSIS

#include <rpc/rpc.h>

void auth_destroy(AUTH *auth);

AUTH *authnone_create(void);

AUTH *authsys_create(const char *host, const uid_t uid, const gid_t gid,
 const int len, const gid_t *aup_gids);

AUTH *authsys_create_default(void);
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.

These routines are normally called after creating the CLIENT handle. The cl_auth field of the CLIENT structure should be initialized by the 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.

Only the NULL and the SYS style of authentication is discussed here. For the DES style authentication, please refer to secure_rpc(3NSL).

The NULL and SYS style of authentication are safe in multithreaded applications. For the MT-level of the DES style, see its pages.

"Routines"

Note: See rpc(3NSL) for the definition of the AUTH data structure. auth_destroy()

A function macro that destroys the authentication information associated with auth. Destruction usually involves deallocation of private data structures. The use of auth is undefined after calling auth_destroy().

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.

authsys_create()

Create and return an RPC authentication handle that contains AUTH_SYS authentication information. The parameter host is the name of the machine on which the information was created; uid is the user's user ID; gid is the user's current group ID; len and aup_gids refer to a counted array of groups to which the user belongs.

authsys_create_default()

Call authsys_create() with the appropriate parameters.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

rpc (3NSL), rpc_clnt_calls (3NSL), rpc_clnt_create (3NSL), secure_rpc (3NSL), attributes (7)