xdas.c

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.
 *--------------------------------------------------------------------------*/

#include <xdas.h>

#ifdef LINUX_KERNEL
# include <linux/kernel.h>
# include <linux/module.h>
# include <linux/gfp.h>
# include <linux/slab.h>
# include <linux/string.h>
# include <linux/audit.h>
# include <linux/time.h>

MODULE_LICENSE("Dual BSD/GPL");
MODULE_AUTHOR("John Calcote <jcalcote@novell.com>");
MODULE_DESCRIPTION("OpenXDAS Submission API for the 2.6 SUSE Linux Kernel");

#endif

#define XDAS_AUDIT_SERVICE 0x00000001
#define XDAS_AUDIT_SUBMIT  0x00000002
#define XDAS_AUDIT_IMPORT  0x00000004
#define XDAS_AUDIT_CONTROL 0x00000008
#define XDAS_AUDIT_READ    0x00000010

#define malloc(x) kmalloc(GFP_ATOMIC,(x))
#define free(x)   kfree(x)

#define xdas_assert(x)     (void)0
#define xdas_elemcount(x)  (sizeof(x)/sizeof(*(x)))

#define ORG_FLD_COUNT      6
#define INT_FLD_COUNT      3
#define TGT_FLD_COUNT      6

#define MAX_TIME_SOURCE    1024
#define MAX_TIME_ZONE      128

typedef struct xdas_session_tag
{
#define XDAS_SESSION_SIG   0x58444153  /* 'XDAS' */
   unsigned signature;
   unsigned security;
   unsigned time_uncert_int;
   unsigned time_uncert_ind;
   char time_source[MAX_TIME_SOURCE];
   char time_zone[MAX_TIME_ZONE];
   struct audit_buffer * ab;
   char * org_info[ORG_FLD_COUNT];
} xdas_session;

typedef struct xdas_record_tag
{
#define XDAS_RECORD_SIG    0x52435244  /* 'RCRD' */
   unsigned signature;
   unsigned record_number;
   unsigned event_number;
   unsigned outcome;
   unsigned time_offset;
   char * int_info[INT_FLD_COUNT];
   char * tgt_info[TGT_FLD_COUNT];
   char * src_ref;
   char * evt_info;
   unsigned fmtlen;
   char * fmt;
   int last_status;
   int fmt_cache_dirty;
} xdas_record;


static int __init xdas_module_init(void)
{
   return 0;
}
#ifdef LINUX_KERNEL
module_init(xdas_module_init);
#endif

static void __exit xdas_module_exit(void)
{
}
#ifdef LINUX_KERNEL
module_exit(xdas_module_exit);
#endif

static char * strdup(const char * s)
{
   size_t ssz = s? strlen(s) + 1: 0;
   if (ssz)
   {
      char * s2 = (char *)malloc(ssz);
      if (s2 != 0)
         memcpy(s2, s, ssz);
      return s2;
   }
   return 0;
}

static xdas_session * xdas_validate_session(xdas_audit_ref_t das_ref)
{
   xdas_session * xs = (xdas_session *)das_ref;
   return (xs && xs->signature == XDAS_SESSION_SIG)? xs: 0;
}

static void xdas_set_session_rights(xdas_session * xs)
{
   xs->security = XDAS_AUDIT_SERVICE | XDAS_AUDIT_SUBMIT 
         | XDAS_AUDIT_IMPORT | XDAS_AUDIT_CONTROL | XDAS_AUDIT_READ;
}

static int xdas_session_has_rights(xdas_session * xs, unsigned rights)
{
   return (xs->security & rights) == rights? 1: 0;
}

static int xdas_set_time_info(xdas_session * xs)
{
   *xs->time_source = 0;

   *xs->time_zone = 0;

   xs->time_uncert_int = 0;
   xs->time_uncert_ind = 0;
   return 0;
}

static void xdas_exit_laf(xdas_session * xs)
{
   if (xs->ab != 0)
   {
      audit_log_end(xs->ab);
      xs->ab = 0;
   }
}

static int xdas_service_connect(int * minor, xdas_session * xs)
{
#define XDAS_LAF_TYPE 7000 
   struct audit_context * ctx = 0;
   gfp_t gfp_mask = 0;
   int type = XDAS_LAF_TYPE;

   if ((xs->ab = audit_log_start(ctx, gfp_mask, type)) == 0)
      return (*minor = OXDAS_MS_UNKNOWN_ERROR), XDAS_S_FAILURE;

   return 0;
}

static void xdas_internal_terminate_session(xdas_session * xs)
{
   xdas_exit_laf(xs);
   free(xs->org_info[0]);
   free(xs);
}

static size_t xdas_calc_max_record_len(xdas_session * xs, xdas_record * xr)
{
   unsigned i;
   size_t fmtsz;

   fmtsz = 4   /* HDR: */
         + 5   /* <hex_4_character_zero_padded_length_in_bytes>: */
         + sizeof(XDAS_RECORD_VERSION)
               /* <decimal_record_format_version>: */
         + 9   /* <hex_time_offset>: */
         + 9   /* <hex_time_uncertainty_interval>: */
         + 9   /* <hex_time_uncertainty_indicator>: */
         + strlen(xs->time_source) + 1   
               /* <str_time_source>: */
         + strlen(xs->time_zone) + 1       
               /* <str_time_zone>: */
         + 9   /* <hex_event_number>: */
         + 9;  /* <hex_outcome>: */

   fmtsz += 4; /* ORG:
                * <org_location_name>:
                * <org_location_address>:
                * <org_service-type>:
                * <org_auth_authority>:
                * <org_principal_name>:
                * <org_principal_id>:
                */
   for (i = 0; i < xdas_elemcount(xs->org_info) && xs->org_info[i]; i++)
      fmtsz += strlen(xs->org_info[i]) + 1;
   for (; i< xdas_elemcount(xs->org_info); i++)
      fmtsz++;

   fmtsz += 4; /* INT:
                * <int_auth_authority>:
                * <int_domain_specific_name>:
                * <int_domain_specific_id>:
                */
   for (i = 0; i < xdas_elemcount(xr->int_info) && xr->int_info[i]; i++)
      fmtsz += strlen(xr->int_info[i]) + 1;
   for (; i< xdas_elemcount(xr->int_info); i++)
      fmtsz++;

   fmtsz += 4; /* TGT:
                * <tgt_location_name>:
                * <tgt_location_address>:
                * <tgt_service-type>:
                * <tgt_auth_authority>:
                * <tgt_principal_name>:
                * <tgt_principal_id>:
                */
   for (i = 0; i < xdas_elemcount(xr->tgt_info) && xr->tgt_info[i]; i++)
      fmtsz += strlen(xr->tgt_info[i]) + 1;
   for (; i< xdas_elemcount(xr->tgt_info); i++)
      fmtsz++;

   fmtsz += 4  /* SRC: */
         + (xr->src_ref? strlen(xr->src_ref): 0) + 1; 
               /* <pointer_to_source_domain>: */

   fmtsz +=4   /* EVT: */
         + (xr->evt_info? strlen(xr->evt_info): 0) + 1   
               /* <event_specific_information>: */
         + 4;  /* END\0 */

   return fmtsz;
}

static int xdas_format_record(xdas_session * xs, xdas_record * xr)
{
   char * fmt;
   unsigned fmtlen, i, ccnt;
   size_t fmtsz = xdas_calc_max_record_len(xs, xr);

   /* allocate buffer for record string */
   if ((fmt = (char *)malloc(fmtsz)) == 0)
      return -1;

   /* HDR:
    * <hex_4_character_zero_padded_length_in_bytes>:
    * <max_16_char_version_str>:
    * <str_version>:
    * <hex_time_offset>:
    * <hex_time_uncertainty_interval>:
    * <hex_time_uncertainty_indicator>:
    * <str_time_source>:
    * <str_time_zone>:
    * <hex_event_number>:
    * <hex_outcome>:
    */
   ccnt = sprintf(fmt, "HDR:0000:" XDAS_RECORD_VERSION ":%x:%x:%x:%s:%s:%x:%x:", 
         xr->time_offset, xs->time_uncert_int, xs->time_uncert_ind, 
         xs->time_source, xs->time_zone, xr->event_number, xr->outcome);

   /* ORG:
    * <org_location_name>:
    * <org_location_address>:
    * <org_service-type>:
    * <org_auth_authority>:
    * <org_principal_name>:
    * <org_principal_id>:
    */
   ccnt += sprintf(fmt + ccnt, "ORG:");
   for (i = 0; i < xdas_elemcount(xs->org_info) && xs->org_info[i]; i++)
      ccnt += sprintf(fmt + ccnt, "%s:", xs->org_info[i]);
   for (; i < xdas_elemcount(xs->org_info); i++)
      fmt[ccnt++] = ':';

   /* INT:
    * <int_auth_authority>:
    * <int_domain_specific_name>:
    * <int_domain_specific_id>:
    */
   ccnt += sprintf(fmt + ccnt, "INT:");
   for (i = 0; i < xdas_elemcount(xr->int_info) && xr->int_info[i]; i++)
      ccnt += sprintf(fmt + ccnt, "%s:", xr->int_info[i]);
   for (; i < xdas_elemcount(xr->int_info); i++)
      fmt[ccnt++] = ':';

   /* TGT:
    * <tgt_location_name>:
    * <tgt_location_address>:
    * <tgt_service-type>:
    * <tgt_auth_authority>:
    * <tgt_principal_name>:
    * <tgt_principal_id>:
    */
   ccnt += sprintf(fmt + ccnt, "TGT:");
   for (i = 0; i < xdas_elemcount(xr->tgt_info) && xr->tgt_info[i]; i++)
      ccnt += sprintf(fmt + ccnt, "%s:", xr->tgt_info[i]);
   for (; i < xdas_elemcount(xr->tgt_info); i++)
      fmt[ccnt++] = ':';

   /* SRC:
    * <pointer_to_source_domain>:
    * EVT:
    * <event_specific_information>:
    * "END\0"
    */
   ccnt += sprintf(fmt + ccnt, "SRC:%s:EVT:%s:END", 
         xr->src_ref? xr->src_ref: "", xr->evt_info? xr->evt_info: "");

   /* put the record length, and replace the colon character */
   fmtlen = ccnt;
   sprintf(fmt + 4, "%04hx", (unsigned short)ccnt);
   fmt[4 + 4] = ':';

   /* is data different? */
   if (fmtlen == xr->fmtlen && strcmp(fmt, xr->fmt) == 0)
   {
      free(fmt);  /* no, free temp buffer, return "no change" */
      return 1;
   }

   /* yes, free existing, set new */
   free(xr->fmt);
   xr->fmt = fmt;
   xr->fmtlen = fmtlen;
   return 0;
}

static xdas_record * xdas_validate_record(xdas_audit_rec_desc_t record_ref) 
{
   xdas_record * xr = (xdas_record *)record_ref;
   return (xr && xr->signature == XDAS_RECORD_SIG)? xr: 0;
}

static unsigned xdas_get_next_record_number(void)
{
   static unsigned g_recnum = 0;
   return ++g_recnum;
}

static void xdas_set_record_timestamp(xdas_record * xr)
{
#ifdef LINUX_KERNEL
   unsigned long seq;
   do {
      seq = read_seqbegin(&xtime_lock);
      xr->time_offset = xtime.tv_sec;
   } while (read_seqretry(&xtime_lock, seq));
#else
   xr->time_offset = (unsigned)time(0);
#endif
}

static int xdas_is_valid_outcome(unsigned outcome)
{
   switch(outcome & 0x000000FF)
   {
      case XDAS_OUT_SUCCESS:  return !(outcome & ~0x00003FFF);
      case XDAS_OUT_FAILURE:  return !(outcome & ~0x000FFFFF);
      case XDAS_OUT_DENIAL :  return !(outcome & ~0x000007FF);
   }
   return 0;   /* no outcome class matched */
}

static void xdas_internal_discard_record(xdas_record * xr)
{
   free(xr->int_info[0]);
   free(xr->tgt_info[0]);
   free(xr->src_ref);
   free(xr->evt_info);
   free(xr->fmt);
   free(xr);
}

static int xdas_send_record(int * minorp, xdas_session * xs, 
      xdas_record * xr, int eval, int import)
{
   int rv;

   /* format record to add in string and length */
   if ((rv = xdas_format_record(xs, xr)) < 0)
      return (*minorp = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;

   audit_log_format(xs->ab, "%s", xr->fmt);

   return XDAS_S_COMPLETE;
}

static char * xdas_tokenize(char * str, const char * delims, 
      char esc, char ** nextok)
{
   char * thistok;
   if (str) 
      *nextok = str;
   thistok = *nextok;
   if (thistok)
   {
      while ((*nextok = strpbrk(*nextok, delims)) != 0 
            && *nextok != str && (*nextok)[-1] == esc) 
         (*nextok)++;
      if (*nextok != 0)
         *(*nextok)++ = 0;
   }
   return thistok;
}

static int xdas_parse_info(const char * info, char ** fields, unsigned maxflds)
{
   unsigned i;
   char * info_copy, * saveptr;

#define FLD_DELIMS   ":"
#define ESC_CHAR     '%'

   /* make a working copy */
   if ((info_copy = strdup(info)) == 0)
      return -1;

   /* tokenize the working copy */
   fields[0] = xdas_tokenize(info_copy, FLD_DELIMS, ESC_CHAR, &saveptr);
   for (i = 1; i < maxflds && fields[i-1]; i++)
      fields[i] = xdas_tokenize(0, FLD_DELIMS, ESC_CHAR, &saveptr);

   return saveptr? -2: 0;
}

/*---------------------------------------------------------------------------
 */
XDASXPC int XDASAPI xdas_initialize_session(
      int * minor_status,
      const char * org_info,
      xdas_audit_ref_t * das_ref)
{
   int err;
   xdas_session * xs;
   int bit_bucket;

   /* check parameters */
   if (!minor_status)
      minor_status = &bit_bucket;
   *minor_status = 0;

   xdas_assert(org_info != 0);
   if (org_info == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_ORIG_INFO;

   xdas_assert(das_ref != 0);
   if (das_ref == 0)
      return XDAS_S_CALL_INACCESSIBLE_WRITE | XDAS_S_INVALID_DAS_REF;

#ifndef LINUX_KERNEL
   /* ensure xdas library is initialized */
   if ((err = xdas_library_init(minor_status)) != 0)
      return err;
#endif

   /* create a new session structure */
   if ((xs = (xdas_session *)malloc(sizeof(*xs))) == 0)
      return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
   memset(xs, 0, sizeof(*xs));
   xs->signature = XDAS_SESSION_SIG;

#ifndef LINUX_KERNEL
   xs->s = BAD_SOCKET;
#endif

   /* populate and check caller's rights */
   xdas_set_session_rights(xs);
   if (!xdas_session_has_rights(xs, XDAS_AUDIT_SERVICE))
   {
      xdas_internal_terminate_session(xs);
      return XDAS_S_AUTHORIZATION_FAILURE;
   }

   /* parse originator info */
   if ((err = xdas_parse_info(org_info, 
         xs->org_info, xdas_elemcount(xs->org_info))) < 0)
   {
      xdas_internal_terminate_session(xs);
      switch(err)
      {
         case -1: return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
         case -2: return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_ORIG_INFO;
         default: return (*minor_status = OXDAS_MS_UNKNOWN_ERROR), XDAS_S_FAILURE;
      }
   }

   /* retreive system time information */
   if (xdas_set_time_info(xs) < 0)
   {
      xdas_internal_terminate_session(xs);
      return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
   }

   /* establish connection with the xdas daemon/service */
   if ((err = xdas_service_connect(minor_status, xs)) != 0)
   {
      xdas_internal_terminate_session(xs);
      return err;
   }

   /* return session pointer as a handle */
   *das_ref = (xdas_audit_ref_t)xs;

   return XDAS_S_COMPLETE;
}

/*---------------------------------------------------------------------------
 */
XDASXPC int XDASAPI xdas_terminate_session(
      int * minor_status,
      xdas_audit_ref_t * das_ref)
{
   xdas_session * xs;
   int bit_bucket;

   /* check parameters */
   if (!minor_status)
      minor_status = &bit_bucket;
   *minor_status = 0;

   xdas_assert(das_ref != 0 && *das_ref != 0);
   if (das_ref == 0 || *das_ref == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_DAS_REF;

   xs = xdas_validate_session(*das_ref);
   xdas_assert(xs != 0);
   if (xs == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_DAS_REF;

   xdas_internal_terminate_session(xs);
   *das_ref = 0;
   return XDAS_S_COMPLETE;
}

/*---------------------------------------------------------------------------
 */
XDASXPC int XDASAPI xdas_commit_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t * audit_record_descriptor)
{
   xdas_session * xs;
   xdas_record * xr;
   int rv, bit_bucket;

   /* check parameters */
   if (!minor_status)
      minor_status = &bit_bucket;
   *minor_status = 0;

   xdas_assert(das_ref != 0);
   if (das_ref == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_DAS_REF;

   xs = xdas_validate_session(das_ref);
   xdas_assert(xs != 0);
   if (xs == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_DAS_REF;

   if (!xdas_session_has_rights(xs, XDAS_AUDIT_SERVICE | XDAS_AUDIT_SUBMIT))
      return XDAS_S_AUTHORIZATION_FAILURE;

   xdas_assert(audit_record_descriptor != 0 && *audit_record_descriptor != 0);
   if (audit_record_descriptor == 0 || *audit_record_descriptor == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   xr = xdas_validate_record(*audit_record_descriptor);
   xdas_assert(xr != 0);
   if (xr == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   /* ensure all required event fields have at least been set */
   if (xr->event_number == 0 || xr->outcome == XDAS_OUT_NOT_SPECIFIED 
         || xr->int_info[0] == 0 || xr->tgt_info[0] == 0 || xr->evt_info == 0)
      return XDAS_S_INCOMPLETE_RECORD;

   /* timestamp record if not already set */
   if (xr->time_offset == 0)
      xdas_set_record_timestamp(xr);

   /* send and delete if successfully sent */
   if ((rv = xdas_send_record(minor_status, xs, xr, 0, 0)) == 0)
   {
      xdas_internal_discard_record(xr);
      *audit_record_descriptor = 0;
   }
   return rv;
}

/*---------------------------------------------------------------------------
 */
XDASXPC int XDASAPI xdas_discard_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t * audit_record_descriptor)
{
   xdas_session * xs;
   xdas_record * xr;
   int bit_bucket;

   /* check parameters */
   if (!minor_status)
      minor_status = &bit_bucket;
   *minor_status = 0;

   xdas_assert(das_ref != 0);
   if (das_ref == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_DAS_REF;

   xs = xdas_validate_session(das_ref);
   xdas_assert(xs != 0);
   if (xs == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_DAS_REF;

   if (!xdas_session_has_rights(xs, XDAS_AUDIT_SERVICE | XDAS_AUDIT_SUBMIT))
      return XDAS_S_AUTHORIZATION_FAILURE;

   xdas_assert(audit_record_descriptor != 0 && *audit_record_descriptor != 0);
   if (audit_record_descriptor == 0 || *audit_record_descriptor == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   xr = xdas_validate_record(*audit_record_descriptor);
   xdas_assert(xr != 0);
   if (xr == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   xdas_internal_discard_record(xr);
   *audit_record_descriptor = 0;
   return XDAS_S_COMPLETE;
}

/*---------------------------------------------------------------------------
 */
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)
{
   xdas_session * xs;
   xdas_record * xr;
   int bit_bucket;
   char * int_info[xdas_elemcount(xr->int_info)];
   char * tgt_info[xdas_elemcount(xr->tgt_info)];
   char * evt_info;

   /* check parameters */
   if (!minor_status)
      minor_status = &bit_bucket;
   *minor_status = 0;

   xdas_assert(das_ref != 0);
   if (das_ref == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_DAS_REF;

   xs = xdas_validate_session(das_ref);
   xdas_assert(xs != 0);
   if (xs == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_DAS_REF;

   if (!xdas_session_has_rights(xs, XDAS_AUDIT_SERVICE | XDAS_AUDIT_SUBMIT))
      return XDAS_S_AUTHORIZATION_FAILURE;

   xdas_assert(audit_record_descriptor != 0 && *audit_record_descriptor != 0);
   if (audit_record_descriptor == 0 || *audit_record_descriptor == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   xr = xdas_validate_record(*audit_record_descriptor);
   xdas_assert(xr != 0);
   if (xr == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   /* initialize before attempted free (later during error cases) */
   int_info[0] = tgt_info[0] = evt_info = 0;

   /* validate outcome value if specified */
   if (outcome != XDAS_OUT_NOT_SPECIFIED
         && !xdas_is_valid_outcome(outcome))
      return XDAS_S_INVALID_OUTCOME;

   /* parse initiator info into temp array */
   if (initiator_information)
   {
      int rv;
      if ((rv = xdas_parse_info(initiator_information, 
            int_info, xdas_elemcount(int_info))) < 0)
      {
         switch(rv)
         {
            case -1: return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
            case -2: return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_INITIATOR_INFO;
            default: return (*minor_status = OXDAS_MS_UNKNOWN_ERROR), XDAS_S_FAILURE;
         }
      }
   }

   /* parse target info into temp array */
   if (target_information)
   {
      int rv;
      if ((rv = xdas_parse_info(target_information, 
            tgt_info, xdas_elemcount(tgt_info))) < 0)
      {
         free(int_info[0]);
         switch(rv)
         {
            case -1: return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
            case -2: return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_TARGET_INFO;
            default: return (*minor_status = OXDAS_MS_UNKNOWN_ERROR), XDAS_S_FAILURE;
         }
      }
   }

   /* copy event-specific info into temp pointer */
   if (event_information)
   {
      if ((evt_info = strdup(event_information)) == 0)
      {
         free(int_info[0]);
         free(tgt_info[0]);
         return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
      }
   }

   /* all resources parsed and allocated - now set field values */

   /* overwrite original and set event number from parameter */
   if (event_number != 0 && event_number != xr->event_number)
   {
      xr->event_number = event_number;
      xr->fmt_cache_dirty = 1;
   }

   /* overwrite original and set outcome from parameter */
   if (outcome != XDAS_OUT_NOT_SPECIFIED && outcome != xr->outcome)
   {
      xr->outcome = outcome;
      xr->fmt_cache_dirty = 1;
   }

   /* free original and copy initiator info from temp array */
   if (initiator_information)
   {
      free(xr->int_info[0]);
      memcpy(xr->int_info, int_info, sizeof(xr->int_info));
      xr->fmt_cache_dirty = 1;
   }

   /* free original and copy target info from temp array */
   if (target_information)
   {
      free(xr->tgt_info[0]);
      memcpy(xr->tgt_info, tgt_info, sizeof(xr->tgt_info));
      xr->fmt_cache_dirty = 1;
   }

   /* free original and reset event info from temp pointer */
   if (event_information)
   {
      if (xr->evt_info && strcmp(event_information, xr->evt_info) == 0)
         free(evt_info);
      else
      {
         free(xr->evt_info);
         xr->evt_info = evt_info;
         xr->fmt_cache_dirty = 1;
      }
   }

#ifndef LINUX_KERNEL
   /* Evaluate - if no audit required, free record */
   if (xr->fmt_cache_dirty)
   {
      int rv;
      if ((rv = xdas_send_record(
            minor_status, xs, xr, 1, 0)) == XDAS_S_NO_AUDIT)
      {
         xdas_internal_discard_record(xr); 
         *audit_record_descriptor = 0;
      }
      xr->fmt_cache_dirty = 0;
      return rv;
   }
   return xr->last_status;
#else
   return XDAS_S_COMPLETE;
#endif
}

/*---------------------------------------------------------------------------
 */
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)
{
   xdas_record * xr;
   xdas_session * xs;
   int bit_bucket, rv = XDAS_S_COMPLETE;

   /* check parameters */
   if (!minor_status)
      minor_status = &bit_bucket;
   *minor_status = 0;

   xdas_assert(das_ref != 0);
   if (das_ref == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_DAS_REF;

   xs = xdas_validate_session(das_ref);
   xdas_assert(xs != 0);
   if (xs == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_DAS_REF;

   if (!xdas_session_has_rights(xs, XDAS_AUDIT_SERVICE | XDAS_AUDIT_SUBMIT))
      return XDAS_S_AUTHORIZATION_FAILURE;

   xdas_assert(audit_record_descriptor != 0);
   if (audit_record_descriptor == 0)
      return XDAS_S_CALL_INACCESSIBLE_WRITE | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   /* create a new audit record context structure */
   *audit_record_descriptor = 0;
   if ((xr = (xdas_record *)malloc(sizeof(*xr))) == 0)
      return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
   memset(xr, 0, sizeof(*xr));
   xr->signature = XDAS_RECORD_SIG;

   /* preinitialize all fields to "not set" */
   xr->outcome = XDAS_OUT_NOT_SPECIFIED;

   xr->record_number = xdas_get_next_record_number();

   /* set event number */
   if (event_number != 0)
      xr->event_number = event_number;

   /* set outcome */
   if (outcome != XDAS_OUT_NOT_SPECIFIED)
   {
      if (!xdas_is_valid_outcome(outcome))
         return XDAS_S_INVALID_OUTCOME;
      xr->outcome = outcome;
   }

   /* set initiator info */
   if (initiator_information)
   {
      if ((rv = xdas_parse_info(initiator_information, 
            xr->int_info, xdas_elemcount(xr->int_info))) < 0)
      {
         xdas_internal_discard_record(xr); 
         switch(rv)
         {
            case -1: return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
            case -2: return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_INITIATOR_INFO;
            default: return (*minor_status = OXDAS_MS_UNKNOWN_ERROR), XDAS_S_FAILURE;
         }
      }
   }

   /* set target info */
   if (target_information)
   {
      if ((rv = xdas_parse_info(target_information, 
            xr->tgt_info, xdas_elemcount(xr->tgt_info))) < 0)
      {
         xdas_internal_discard_record(xr); 
         switch(rv)
         {
            case -1: return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
            case -2: return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_TARGET_INFO;
            default: return (*minor_status = OXDAS_MS_UNKNOWN_ERROR), XDAS_S_FAILURE;
         }
      }
   }

   /* set event-specific info */
   if (event_information && (xr->evt_info = strdup(event_information)) == 0)
   {
      xdas_internal_discard_record(xr); 
      return (*minor_status = OXDAS_MS_OUT_OF_MEMORY), XDAS_S_FAILURE;
   }
   
#ifndef LINUX_KERNEL
   /* Evaluate - if no audit return null handle, else return new record */
   if ((rv = xdas_send_record(minor_status, xs, xr, 1, 0)) == XDAS_S_NO_AUDIT)
   {
      xdas_internal_discard_record(xr); 
      xr = 0;
   }
#endif

   /* return record pointer as handle */
   *audit_record_descriptor = (xdas_audit_rec_desc_t)xr;

   return rv;
}

/*---------------------------------------------------------------------------
 */
XDASXPC int XDASAPI xdas_timestamp_record(
      int * minor_status,
      xdas_audit_ref_t das_ref,
      xdas_audit_rec_desc_t audit_record_descriptor)
{
   xdas_session * xs;
   xdas_record * xr;
   int bit_bucket;

   /* check parameters */
   if (!minor_status)
      minor_status = &bit_bucket;
   *minor_status = 0;

   xdas_assert(das_ref != 0);
   if (das_ref == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_DAS_REF;

   xs = xdas_validate_session(das_ref);
   xdas_assert(xs != 0);
   if (xs == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_DAS_REF;

   if (!xdas_session_has_rights(xs, XDAS_AUDIT_SERVICE | XDAS_AUDIT_SUBMIT))
      return XDAS_S_AUTHORIZATION_FAILURE;

   xdas_assert(audit_record_descriptor != 0);
   if (audit_record_descriptor == 0)
      return XDAS_S_CALL_INACCESSIBLE_READ | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   xr = xdas_validate_record(audit_record_descriptor);
   xdas_assert(xr != 0);
   if (xr == 0)
      return XDAS_S_CALL_BAD_STRUCTURE | XDAS_S_INVALID_RECORD_DESCRIPTOR;

   xdas_set_record_timestamp(xr);
   xr->fmt_cache_dirty = 1;

   return XDAS_S_COMPLETE;
}