NAME

rpc_binding_inq_auth_client- returns authentication, authorisation and protection information from a client binding handle

Note:

This routine is deprecated at DCE Version 1.1 in favor of the rpc_binding_inq_auth_caller() routine. Its use is discouraged, and it should be replaced by rpc_binding_inq_auth_caller() in all instances.

SYNOPSIS

#include <dce/rpc.h>
#include <dce/id_base.h>

void rpc_binding_inq_auth_client(
	rpc_binding_handle_t binding,
	rpc_authz_handle_t *privs,
	unsigned_char_t **server_princ_name,
	unsigned32 *protect_level,
	unsigned32 *authn_svc,
	unsigned32 *authz_svc,
	unsigned32 *status);

PARAMETERS

Input

binding

Specifies the client binding handle from which to return information.

Input/Output

server_princ_name

Returns the server principal name referenced by binding. The content of the returned name and its syntax depend on the value of authn_svc. (See Authentication, Authorisation and Protection-level Arguments for authentication service-specific syntax.)

Specifying NULL prevents the routine from returning this argument.

Unless NULL is specified, the application should call the rpc_string_free() routine to free the storage used by this argument.

protect_level

Returns the protection level referenced by binding. (See Authentication, Authorisation and Protection-level Arguments for possible values of this argument.)

Specifying NULL prevents the routine from returning this argument.

authn_svc

Returns the authentication service referenced by binding. (See Authentication, Authorisation and Protection-level Arguments for possible values of this argument.)

Specifying NULL prevents the routine from returning this argument.

authz_svc

Returns the authorisation service referenced by binding. (See Authentication, Authorisation and Protection-level Arguments for possible values of this argument.)

Specifying NULL prevents the routine from returning this argument.

Output

privs

Returns a handle to the authorisation or privilege information referenced by binding.

The server must cast this handle to a data type that depends on authz_svc. (See Authentication, Authorisation and Protection-level Arguments for information about the data types appropriate to each authorisation service.)

The lifetime of the data referenced by this argument is one invocation of a server manager routine. If an application wants to preserve any of the returned data beyond this lifetime, it must copy the data into application-allocated memory.

Specifying NULL prevents the routine from returning this parameter.

status

Returns the status code from this routine. The status code indicates whether the routine completed successfully, or if not, why not.

Possible status codes and their meanings include:

rpc_s_ok

Success.

rpc_s_binding_has_no_auth

Binding has no authentication information.

DESCRIPTION

The rpc_binding_inq_auth_client() routine is deprecated at DCE Version 1.1 in favor of the rpc_binding_inq_auth_caller() routine. Its use is discouraged, and it should be replaced by rpc_binding_inq_auth_caller() in all instances.

The rpc_binding_inq_auth_client() routine returns authentication, authorisation and privilege information referenced by the client binding handle, binding. Servers obtain client binding handles as the first argument of a remote procedure call. (See RPC Data Types and Introduction to the RPC API for more detailed information on how client binding handles are created and obtained.) The client binding handle references authentication, authorisation and privilege information for the client that made the remote procedure call.

A client establishes this information by calling rpc_binding_set_auth_info(), which associates a set of authentication, authorisation and privilege information with a server binding handle. When the client makes an RPC call on this server binding handle, the client binding handle received by the server references the same authentication, authorisation and privilege information.

No server memory is allocated for the data referenced by privs. The lifetime of this data is the current invocation of the manager routine that was called with the binding argument. An application that wishes to preserve any privileges information beyond this invocation must copy the information into server memory.

RETURN VALUE

None.

SEE ALSO

rpc_binding_inq_auth_info()

rpc_binding_inq_auth_caller()

rpc_binding_set_auth_info()
rpc_string_free().

Please note that the html version of this specification may contain formatting aberrations. The definitive version is available as an electronic publication on CD-ROM from The Open Group.