libxdas_api_submit.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>
#include <xdas_util.h>
#include <xdas_debug.h>

#include "libxdas_impl.h"

#include <malloc.h>
#include <string.h>

/*---------------------------------------------------------------------------
 */
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, 0, 
            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, 0, 
            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, 0, 
            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, 0, 
            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;
}