xdas_initialise_session(3xdas)

Synopsis

#include <sys/xdas.h>

OM_uint32 xdas_initialise_session(
	OM_uint32 *minor_status,
	const xdas_buffer_t *security_context,
	const xdas_buffer_t *org_info,
	xdas_audit_ref_t *das_ref);

Description

xdas_initialise_session(3xdas) initiates a session between the caller identified by org_info and the distributed audit service. The XDAS service inserts an org_info into every audit record submitted by the caller via subsequent calls to XDAS functions within the XDAS session. xdas_initialise_session(3xdas) validates the security_context provided to ensure that the caller has been authenticated and is authorized to use the XDAS.

If successful, the function returns das_ref, a handle to the XDAS server. This handle may be used by both the XDAS functions and by the generic logging functions described in the Section 3eels manual pages in Section 3eels manual pages.

The caller must possess the XDAS_AUDIT_SERVICE authority.

On success, xdas_initialise_session(3xdas) returns XDAS_S_COMPLETE.

The use of this function must itself be audited by the XDAS service.

Arguments

minor_status

(Output) Provides additional information when the function returns XDAS_S_FAILURE.

security_context

(Optional input) An optional opaque structure defining the security context of the caller requesting use of the audit service. This is used to authenticate the caller to XDAS and to establish the caller's XDAS authorizations. If this parameter is set to XDAS_NO_BUF, XDAS retrieves default security context from the process environment.

org_info

(Input) This buffer includes the originator information that is to be included with each audit event subsequently submitted by this caller. The XDAS service uses this information to populate the originator information of an audit record when xdas_start_record(3xdas) is invoked.

das_ref

(Output) A handle to the XDAS server.

Return values

XDAS_S_AUTHORISATION_FAILURE

The caller does not possess the correct authority.

XDAS_S_COMPLETE

Successful completion.

XDAS_S_FAILURE

An implementation-specific error or failure has occurred, such as missing required parameters, or a malloc failure.

XDAS_S_INVALID_ORIG_INFO

The originator information supplied has a syntax error.

XDAS_S_INVALID_SECURITY_CONTEXT

The security context supplied is invalid.

References