xdas_initialise_session(D3xdas)

xdas_initialise_session -- initialize a session with the distributed audit service

Synopsis

#include <sys/xdas.h>

OM_uint32 xdas_initialise_session(
	OM_uint32 *minor_status,
	const char *location_name,
	const char *location_address,
	const char *service_type,
	xdas_audit_ref_t *das_ref);

Description

The xdas_initialise_session(D3xdas) function is a member of the Basic XDAS Conformance class.

xdas_initialise_session(D3xdas) 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(D3xdas) 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(D3xdas) 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.

location_name

(Optional input) The name of the driver initializing the session. The driver name must be terminated with a ``:'', for example, ``xdas_driver_ab:''.

location_address

(Optional input) The IP address of the local host on which the driver initializing this session resides. The address must be terminated with a ``:'', for example, ``172.16.0.17:''.

NOTE: You must always specify at least location_name or location_address when you use this call. These parameters are used to construct the originator information associated with the XDAS connection. Information not specified by these parameters is filled in automatically by xdas_initialise_session(D3xdas) and is opaque to the caller.

service_type

(Optional input) A free form description of the driver initializing the session. The description must be terminated with a ``:'', for example, ``Example_ab:''.

das_ref

(Output) A handle to the XDAS server.

Return values

XDAS_S_COMPLETE: Successful completion.
XDAS_S_FAILURE: An implementation specific error or failure has occurred, such as missing required parameters, or a kernel allocated memory 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

xdas_initialise_session, xdas_commit_record(D3xdas), xdas_discard_record(D3xdas), xdas_put_event_info(D3xdas), xdas_start_record(D3xdas), xdas_terminate_session(D3xdas), xdas_timestamp_record(D3xdas)