xdas.h

Go to the documentation of this file.

/*----------------------------------------------------------------------------
 * Copyright (c) 2006, Novell, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are 
 * met:
 * 
 *     * Redistributions of source code must retain the above copyright 
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Novell nor the names of its contributors 
 *       may be used to endorse or promote products derived from this 
 *       software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *--------------------------------------------------------------------------*/

#ifndef XDAS_H_INCLUDED
#define XDAS_H_INCLUDED

#include <xdasapi.h>
#include <stddef.h>

#define XDAS_RECORD_VERSION "0"

#define XDAS_S_COMPLETE                   0
#define XDAS_S_AUTHORIZATION_FAILURE      1
#define XDAS_S_BUFF_TOO_SMALL             2
#define XDAS_S_END                        3
#define XDAS_S_FAILURE                    4
#define XDAS_S_INCOMPLETE_RECORD          5
#define XDAS_S_INVALID_ACTION_LIST        6
#define XDAS_S_INVALID_AUDIT_STREAM       7
#define XDAS_S_INVALID_DAS_REF            8
#define XDAS_S_INVALID_EVENT_INFO         9
#define XDAS_S_INVALID_EVENT_NO           10
#define XDAS_S_INVALID_FILTER             11
#define XDAS_S_INVALID_FILTER_EXPR        12
#define XDAS_S_INVALID_FILTER_LIST        13
#define XDAS_S_INVALID_FILTER_TYPE        14
#define XDAS_S_INVALID_INITIATOR_INFO     15
#define XDAS_S_INVALID_ORIG_INFO          16
#define XDAS_S_INVALID_OUTCOME            17
#define XDAS_S_INVALID_RECORD_DESCRIPTOR  18
#define XDAS_S_INVALID_RECORD_NUMBER      19
#define XDAS_S_INVALID_SECURITY_CONTEXT   20
#define XDAS_S_INVALID_TARGET_INFO        21
#define XDAS_S_NO_AUDIT                   22
#define XDAS_S_NO_DECISION_YET            23
#define XDAS_S_RECORD_SYNTAX_ERROR        24
#define XDAS_S_STORAGE_FAILURE            25
#define XDAS_S_SERVICE_FAILURE            26
#define XDAS_S_NOT_SUPPORTED              27
#define XDAS_S_INVALID_FILTER_ACTION      28
/* @} */

#define OXDAS_MS_NO_ERROR                 0
#define OXDAS_MS_UNKNOWN_ERROR            1
#define OXDAS_MS_OUT_OF_MEMORY            2
#define OXDAS_MS_NET_INIT_FAILED          3
#define OXDAS_MS_NET_GENERAL_ERROR        4
#define OXDAS_MS_NET_BAD_SOCKET           5
#define OXDAS_MS_NET_CONN_ABORTED         6
#define OXDAS_MS_NET_CONN_RESET           7
#define OXDAS_MS_NET_NOT_CONNECTED        8
#define OXDAS_MS_NET_SHUTDOWN             9
#define OXDAS_MS_NET_TIMEDOUT             10
#define OXDAS_MS_NET_CONN_REFUSED         11
#define OXDAS_MS_PROTOCOL                 12
/* @} */

#define XDAS_S_CALL_INACCESSIBLE_READ     (1 << 16)
#define XDAS_S_CALL_INACCESSIBLE_WRITE    (2 << 16)
#define XDAS_S_CALL_BAD_STRUCTURE         (3 << 16)
/* @} */

#define XDAS_ROUTINE_ERROR(e) ((e) & 0x0000FFFF)
#define XDAS_CALLING_ERROR(e) ((e) & 0xFFFF0000)
#define XDAS_ERROR(e)         ((e) ? 1 : 0)
/* @} */

#define XDAS_AE_CREATE_ACCOUNT                  0x01000001
#define XDAS_AE_DELETE_ACCOUNT                  0x01000002
#define XDAS_AE_DISABLE_ACCOUNT                 0x01000003
#define XDAS_AE_ENABLE_ACCOUNT                  0x01000004
#define XDAS_AE_QUERY_ACCOUNT                   0x01000005
#define XDAS_AE_MODIFY_ACCOUNT                  0x01000006
#define XDAS_AE_CREATE_SESSION                  0x01000007
#define XDAS_AE_TERMINATE_SESSION               0x01000008
#define XDAS_AE_QUERY_SESSION                   0x01000009
#define XDAS_AE_MODIFY_SESSION                  0x0100000A
#define XDAS_AE_CREATE_DATA_ITEM                0x0100000B
#define XDAS_AE_DELETE_DATA_ITEM                0x0100000C
#define XDAS_AE_QUERY_DATA_ITEM_ATT             0x0100000D
#define XDAS_AE_MODIFY_DATA_ITEM_ATT            0x0100000E
#define XDAS_AE_INSTALL_SERVICE                 0x0100000F
#define XDAS_AE_REMOVE_SERVICE                  0x01000010
#define XDAS_AE_QUERY_SERVICE_CONFIG            0x01000011
#define XDAS_AE_MODIFY_SERVICE_CONFIG           0x01000012
#define XDAS_AE_DISABLE_SERVICE                 0x01000013
#define XDAS_AE_ENABLE_SERVICE                  0x01000014
#define XDAS_AE_INVOKE_SERVICE                  0x01000015
#define XDAS_AE_TERMINATE_SERVICE               0x01000016
#define XDAS_AE_QUERY_PROCESS_CONTEXT           0x01000017
#define XDAS_AE_MODIFY_PROCESS_CONTEXT          0x01000018
#define XDAS_AE_CREATE_PEER_ASSOC               0x01000019
#define XDAS_AE_TERMINATE_PEER_ASSOC            0x0100001A
#define XDAS_AE_QUERY_ASSOC_CONTEXT             0x0100001B
#define XDAS_AE_MODIFY_ASSOC_CONTEXT            0x0100001C
#define XDAS_AE_RECEIVE_DATA_VIA_ASSOC          0x0100001D
#define XDAS_AE_SEND_DATA_VIA_ASSOC             0x0100001E
#define XDAS_AE_CREATE_DATA_ITEM_ASSOC          0x0100001F
#define XDAS_AE_TERMINATE_DATA_ITEM_ASSOC       0x01000020
#define XDAS_AE_QUERY_DATA_ITEM_ASSOC_CONTEXT   0x01000021
#define XDAS_AE_MODIFY_DATA_ITEM_ASSOC_CONTEXT  0x01000022
#define XDAS_AE_QUERY_DATA_ITEM_CONTENTS        0x01000023
#define XDAS_AE_MODIFY_DATA_ITEM_CONTENTS       0x01000024
#define XDAS_AE_START_SYS                       0x01000025
#define XDAS_AE_SHUTDOWN_SYS                    0x01000026
#define XDAS_AE_RESOURCE_EXHAUST                0x01000027
#define XDAS_AE_RESOURCE_CORRUPT                0x01000028
#define XDAS_AE_BACKUP_DATASTORE                0x01000029
#define XDAS_AE_RECOVER_DATASTORE               0x0100002A
#define XDAS_AE_AUD_CONFIG                      0x0100002B
#define XDAS_AE_AUD_DS_FULL                     0x0100002C
#define XDAS_AE_AUD_DS_CORR                     0x0100002D

/* The following are added to the standard by OpenXDAS */
#define XDAS_AE_MODIFY_AUTH_TOKEN               0x02000001
#define XDAS_AE_APPROVAL_RECEIVED               0x02000002
#define XDAS_AE_APPROVAL_REQUESTED              0x02000003
#define XDAS_AE_REQUEST_ESCALATED               0x02000004
#define XDAS_AE_NOTIFICATION_SENT               0x02000005
#define XDAS_AE_CREATE_ROLE                     0x02000006
#define XDAS_AE_DELETE_ROLE                     0x02000007
#define XDAS_AE_DISABLE_ROLE                    0x02000008
#define XDAS_AE_ENABLE_ROLE                     0x02000009
#define XDAS_AE_QUERY_ROLE                      0x0200000A
#define XDAS_AE_MODIFY_ROLE                     0x0200000B
/* @} */

#define XDAS_AEC_ACCOUNT_MANAGEMENT             0x01000001
#define XDAS_AEC_USER_SESSION                   0x01000002
#define XDAS_AEC_DATA_ITEM_MANAGEMENT           0x01000003
#define XDAS_AEC_SERVICE_MANAGEMENT             0x01000004
#define XDAS_AEC_SERVICE_UTILIZE                0x01000005
#define XDAS_AEC_PEER_ASSOC_MANAGEMENT          0x01000006
#define XDAS_AEC_DATA_ITEM_CONTENT_ACCESS       0x01000007
#define XDAS_AEC_EXCEPTIONAL                    0x01000008
#define XDAS_AEC_AUDIT_SERVICE                  0x01000009
/* @} */

#define XDAS_OUT_NOT_SPECIFIED                  0xFFFFFFFF

#define XDAS_OUT_SUCCESS                        0x00000000
#define XDAS_OUT_PRIV_USED                      0x00000100
#define XDAS_OUT_PRIV_GRANTED                   0x00000200
#define XDAS_OUT_PRIV_REVOKED                   0x00000400
#define XDAS_OUT_PRESELECT_CRITERIA_SET         0x00000800
#define XDAS_OUT_THRESHOLDS_SET                 0x00001000
#define XDAS_OUT_ACTIONS_SET                    0x00002000

#define XDAS_OUT_FAILURE                        0x00000001
#define XDAS_OUT_SERVICE_UNAVAILABLE            0x00000101
#define XDAS_OUT_SERVICE_FAILURE                0x00000201
#define XDAS_OUT_HARDWARE_FAILURE               0x00000401
#define XDAS_OUT_LOST_ASSOCIATION               0x00000801
#define XDAS_OUT_ALREADY_ENABLED                0x00001001
#define XDAS_OUT_ALREADY_DISABLED               0x00002001
#define XDAS_OUT_SERVICE_ERROR                  0x00004001
#define XDAS_OUT_BUSY                           0x00008001
#define XDAS_OUT_DISABLED                       0x00010001
#define XDAS_OUT_INVALID_INPUT                  0x00020001
#define XDAS_OUT_ENTITY_EXISTS                  0x00040001
#define XDAS_OUT_ENTITY_NON_EXISTENT            0x00080001

#define XDAS_OUT_DENIAL                         0x00000002
#define XDAS_OUT_INSUFFICIENT_PRIVILEGE         0x00000102
#define XDAS_OUT_INVALID_IDENTITY               0x00000202
#define XDAS_OUT_INVALID_CREDENTIALS            0x00000402
/* @} */

#define XDAS_C_SUBMIT   1
#define XDAS_C_IMPORT   2
/* @} */

#define XDAS_C_INCLUDE  1
#define XDAS_C_EXCLUDE  2
/* @} */

#define XDAS_VERSION                1
#define XDAS_TIME_OFFSET            2
#define XDAS_TIME_UNCERT_INTER      3
#define XDAS_TIME_UNCERT_INDIC      4
#define XDAS_TIME_SOURCE            5
#define XDAS_TIME_TIME_ZONE         6
#define XDAS_EVENT_NUMBER           7
#define XDAS_OUTCOME                8
#define XDAS_ORG_LOC_NAME           9
#define XDAS_ORG_LOC_ADD            10
#define XDAS_ORG_SERV_TYPE          11
#define XDAS_ORG_AUTH_AUTH          12
#define XDAS_ORG_PRINC_NAME         13
#define XDAS_ORG_PRINC_IDENTITY     14
#define XDAS_INT_AUTH_AUTH          15
#define XDAS_INT_PRINC_NAME         16
#define XDAS_INT_PRINC_IDENTITY     17
#define XDAS_TGT_LOC_NAME           18
#define XDAS_TGT_LOC_ADD            19
#define XDAS_TGT_SERV_TYPE          20
#define XDAS_TGT_AUTH_AUTH          21
#define XDAS_TGT_PRINC_NAME         22
#define XDAS_TGT_PRINC_IDENTITY     23
/* @} */

#define XDAS_O_EQ    1  
#define XDAS_O_NE    2  
#define XDAS_O_GT    3  
#define XDAS_O_LT    4  
#define XDAS_O_GE    5  
#define XDAS_O_LE    6  
#define XDAS_O_BT    7  
#define XDAS_O_SS    8  
/* @} */

#define XDAS_ACT_LOG    1
#define XDAS_ACT_ALARM  2
#define XDAS_ACT_ACTION 4
/* @} */

typedef struct xdas_buffer_desc_struct
{
   size_t length;    
   char * value;     
} xdas_buffer_desc, * xdas_buffer_t;

typedef struct xdas_audit_record_desc_struct
{
   unsigned record_number;
   size_t length;
   unsigned time_offset;
   unsigned time_uncertainty_interval;
   unsigned time_uncertainty_indicator;
   xdas_buffer_t time_source;
   xdas_buffer_t time_zone;
   unsigned event_number;
   unsigned outcome;
   xdas_buffer_t org_location_name;
   xdas_buffer_t org_location_address;
   xdas_buffer_t org_service_type;
   xdas_buffer_t org_auth_authority;
   xdas_buffer_t org_principal_name;
   xdas_buffer_t org_principal_identity;
   xdas_buffer_t int_auth_authority;
   xdas_buffer_t int_principal_name;
   xdas_buffer_t int_principal_identity;
   xdas_buffer_t tgt_location_name;
   xdas_buffer_t tgt_location_address;
   xdas_buffer_t tgt_service_type;
   xdas_buffer_t tgt_auth_authority;
   xdas_buffer_t tgt_principal_name;
   xdas_buffer_t tgt_principal_identity;
   xdas_buffer_t source_reference;
   xdas_buffer_t event_info;
} xdas_audit_record_desc, * xdas_audit_record_t;

typedef void * xdas_audit_ref_t;

typedef void * xdas_audit_stream_t;

typedef void * xdas_audit_rec_desc_t;

XDASXPC int XDASAPI xdas_initialize_session(
      int * minor_status,
      const char * org_info,
      xdas_audit_ref_t * das_ref);

XDASXPC int XDASAPI xdas_terminate_session(
      int * minor_status,
      xdas_audit_ref_t * das_ref);

/* @} */

XDASXPC int XDASAPI xdas_close_audit_stream(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_stream_t * audit_stream_ref);

XDASXPC int XDASAPI xdas_get_next(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_stream_t audit_stream_ref,
      unsigned max_records,
      xdas_buffer_t audit_record_buffer,
      unsigned * no_of_records);

XDASXPC int XDASAPI xdas_open_audit_stream(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_stream_t * audit_stream_ref);

XDASXPC int XDASAPI xdas_parse_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_buffer_t audit_record_buffer,
      unsigned record_number,
      xdas_audit_record_t audit_record);

XDASXPC int XDASAPI xdas_rewind_audit_stream(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_stream_t audit_stream_ref);

/* @} */

XDASXPC int XDASAPI xdas_import_event_records(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_buffer_t audit_record_buffer,
      size_t * position_in_buffer);

/* @} */

XDASXPC int XDASAPI xdas_commit_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t * audit_record_descriptor);

XDASXPC int XDASAPI xdas_discard_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t * audit_record_descriptor);

XDASXPC int XDASAPI xdas_put_event_info(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t * audit_record_descriptor,
      unsigned event_number,
      unsigned outcome,
      const char * initiator_information,
      const char * target_information,
      const char * event_information);

XDASXPC int XDASAPI xdas_start_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t * audit_record_descriptor,
      unsigned event_number,
      unsigned outcome,
      const char * initiator_information,
      const char * target_information,
      const char * event_information);

XDASXPC int XDASAPI xdas_timestamp_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t audit_record_descriptor);

/* @} */

XDASXPC int XDASAPI xdas_create_filter(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      const char * name,
      unsigned filter_type,
      const char * filter_exp,
      const char * filter_act);

XDASXPC int XDASAPI xdas_delete_filter(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      const char * name);

XDASXPC int XDASAPI xdas_disable_filter(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      const char * name);

XDASXPC int XDASAPI xdas_enable_filter(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      const char * name);

XDASXPC int XDASAPI xdas_get_filter(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      const char * name,
      unsigned * filter_type,
      xdas_buffer_t filter_exp,
      xdas_buffer_t filter_act,
      unsigned * filter_status);

XDASXPC int XDASAPI xdas_list_filters(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      char ** filter_name_list,
      size_t * buffer_size);

/* @} */

#endif   /* XDAS_H_INCLUDED */