OSP Toolkit Code

/**************************************************************************
*** COPYRIGHT (c) 2002 by TransNexus, Inc.                              ***
***                                                                     ***
*** This software is property of TransNexus, Inc.                       ***
*** This software is freely available under license from TransNexus.    ***
*** The license terms and conditions for free use of this software by   ***
*** third parties are defined in the OSP Toolkit Software License       ***
*** Agreement (LICENSE.txt).  Any use of this software by third         ***
*** parties, which does not comply with the terms and conditions of the ***
*** OSP Toolkit Software License Agreement is prohibited without        ***
*** the prior, express, written consent of TransNexus, Inc.             ***
***                                                                     ***
*** Thank you for using the OSP ToolKit(TM).  Please report any bugs,   ***
*** suggestions or feedback to support@transnexus.com                   ***
***                                                                     ***
**************************************************************************/







/*
 * ospaudit.c - OSP audit functions
 */

#include "osp.h"
#include "ospaudit.h"
#include "ospconfig.h"
#include "ospmime.h"
#include "ospxml.h"
#include "ospxmldoc.h"
#include "osputils.h"

/* copy message data into audit buffer */
int
OSPPAuditAddMessageToBuffer(
    OSPTAUDIT       *ospvAudit, 
    unsigned char   *ospvAuditData,
    unsigned        ospvAuditDataSz)
{
    int             errorcode       = OSPC_ERR_NO_ERROR;
    unsigned        numbyteswritten = 0;
    unsigned char   *dataptr        = ospvAuditData;
    unsigned char   *endptr         = OSPC_OSNULL;
    unsigned char   *begptr         = OSPC_OSNULL;
    OSPTCOMPONENTID *compid         = OSPC_OSNULL;

    if((ospvAudit != OSPC_OSNULL) && (dataptr != OSPC_OSNULL) && (ospvAuditDataSz > 0))
    {
        /* Clean buffer up */
        if(OSPM_STRSTR((const char *)dataptr, OSPC_AUDIT_XML_HEADER) != OSPC_OSNULL)
        {
            dataptr += OSPC_AUDIT_XML_HDR_LEN;
            ospvAuditDataSz -= OSPC_AUDIT_XML_HDR_LEN;
        }

        if(OSPM_STRSTR((const char *)dataptr, OSPC_AUDIT_MSG_HEADER) != OSPC_OSNULL)
        {
            dataptr += OSPC_AUDIT_MSG_HDR_LEN;
            ospvAuditDataSz -= OSPC_AUDIT_MSG_HDR_LEN;                
        }

        if((endptr = (unsigned char *)OSPM_STRSTR((const char *)dataptr, "<")) != OSPC_OSNULL)
        {
            ospvAuditDataSz -= (endptr - dataptr);
            dataptr = endptr;
        }

        if((endptr = (unsigned char *)OSPM_STRSTR((const char *)dataptr, OSPC_AUDIT_BFR_END)) != OSPC_OSNULL)
        {
            ospvAuditDataSz -= (OSPC_AUDIT_BFR_END_LEN + 1);
        }

        /* get access to buffer */
        OSPM_MUTEX_LOCK(ospvAudit->ospmAuditAccessMutex, errorcode);

        if(errorcode == OSPC_ERR_NO_ERROR)
        {

            if(((ospvAudit->ospmAuditUsedSpace + ospvAuditDataSz) <=
                                                ospvAudit->ospmAuditMaxSpace) &&
                ((ospvAudit->ospmAuditNumMessages + 1) <= ospvAudit->ospmAuditMaxMessages))
            {

                if(errorcode == OSPC_ERR_NO_ERROR)
                {
                    /* add data to buffer */
                    numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                                        dataptr, ospvAuditDataSz);
                    /* increment used space */
                    OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);

                    /* increment nummessages */
                    ospvAudit->ospmAuditNumMessages++;

                    /* Find componentId and save it */
                    if((endptr = (unsigned char *)OSPM_STRSTR((const char *)dataptr, "componentId")) != OSPC_OSNULL)
                    {
                        if((endptr = (unsigned char *)OSPM_STRSTR((const char *)endptr, "=")) != OSPC_OSNULL)
                        {
                            begptr = endptr+1;
                            while(!isalnum(*begptr) && ispunct(*begptr))
                                begptr++;

                            if((endptr = (unsigned char *)OSPM_STRSTR((const char *)begptr, "\"")) != OSPC_OSNULL)
                            {
                                compid = OSPPAuditComponentIdNew(begptr, (endptr -begptr));
                                if(compid != OSPC_OSNULL)
                                {
                                    OSPPListAppend(&(ospvAudit)->ospmAuditComponentIdList, 
                                                    compid);
                                }
                            }
                        }
                    }
                }
            }
            else
            {
                /* signal worker thread to flush buffer */
                OSPM_MUTEX_LOCK(ospvAudit->ospmAuditWorkerMutex, errorcode);

                if(errorcode == OSPC_ERR_NO_ERROR)
                {
                    /* signal condvar to send data */
                    ospvAudit->ospmAuditFlags |= OSPC_AUDIT_FLUSH_BUFFER_NOW;

                    OSPM_CONDVAR_SIGNAL(ospvAudit->ospmAuditWorkerCondVar, errorcode);
                    OSPM_MUTEX_UNLOCK(ospvAudit->ospmAuditWorkerMutex, errorcode);
                }
            }

            /* release mutex */
            OSPM_MUTEX_UNLOCK(ospvAudit->ospmAuditAccessMutex, errorcode);
        }
    }

    return errorcode;
}

/*
 * check audit structure. If new data found, replace data in audit structure.
 * If state indicates some action, start that action. If some error occurs, just 
 * produce some debug.
 */
void            
OSPPAuditCheck(
    OSPTAUDIT           *ospvAudit,
    void                *ospvResponse, 
    OSPE_MSG_DATATYPES  ospvMsgType
)
{
    OSPTTNAUDIT     *tnaudit    = OSPC_OSNULL;
    int             errorcode   = OSPC_ERR_NO_ERROR;
    OSPTCSAUDIT     *csaudit    = OSPC_OSNULL;
    unsigned char   *trigger    = OSPC_OSNULL;

    if((ospvAudit != OSPC_OSNULL) && (ospvResponse != OSPC_OSNULL))
    {
        /* set up audit structure pointer */
        switch(ospvMsgType)
        {
            case OSPC_MSG_ARESP:
                if(((OSPTAUTHRSP *)ospvResponse)->ospmAuthRspTNAudit != OSPC_OSNULL)
                {
                    tnaudit = OSPPAuthRspGetTNAudit((OSPTAUTHRSP *)ospvResponse);
                }
                
                if(((OSPTAUTHRSP *)ospvResponse)->ospmAuthRspCSAudit != OSPC_OSNULL)
                {
                    csaudit = OSPPAuthRspGetCSAudit((OSPTAUTHRSP *)ospvResponse);
                }
            break;

            case OSPC_MSG_UCNF:
                if(((OSPTUSAGECNF *)ospvResponse)->ospmUsageCnfTNAudit != OSPC_OSNULL)
                {
                    tnaudit = OSPPUsageCnfGetTNAudit((OSPTUSAGECNF *)ospvResponse);
                }

                if(((OSPTUSAGECNF *)ospvResponse)->ospmUsageCnfCSAudit != OSPC_OSNULL)
                {
                    csaudit = OSPPUsageCnfGetCSAudit((OSPTUSAGECNF *)ospvResponse);
                }
            break;

            case OSPC_MSG_REARESP:
                if(((OSPTREAUTHRSP *)ospvResponse)->ospmReauthRspTNAudit != OSPC_OSNULL)
                {
                    tnaudit = OSPPReauthRspGetTNAudit((OSPTREAUTHRSP *)ospvResponse);
                }

/*               if(((OSPTREAUTHRSP *)ospvResponse)->ospmReauthRspCSAudit != OSPC_OSNULL)
                {
                    csaudit = OSPPReauthRspGetCSAudit((OSPTREAUTHRSP *)ospvResponse);
                }
                */
            break;

            default:
            break;
        }

        /* check data in structure so we know what to do */
        if(tnaudit != OSPC_OSNULL)
        {
            if(OSPPTNAuditHasURL(tnaudit))
            {
                OSPPAuditSetURL(ospvAudit, (const char *)OSPPTNAuditGetURL(tnaudit));
                OSPPCommSetAuditURL(ospvAudit->ospmAuditComm, (const char *)OSPPTNAuditGetURL(tnaudit));
            }

            if(OSPPTNAuditHasTimeLimit(tnaudit))
            {
                OSPPAuditSetMaxTime(ospvAudit, OSPPTNAuditGetTimeLimit(tnaudit));
            }

            if(OSPPTNAuditHasMaxMessages(tnaudit))
            {
                OSPPAuditSetMaxMessages(ospvAudit, OSPPTNAuditGetMaxMessages(tnaudit));
            }

            if(OSPPTNAuditHasState(tnaudit))
            {
                switch(OSPPTNAuditGetState(tnaudit))
                {
                    case OSPC_AUDIT_INIT:
                        /* If already on, don't turn on again */
                        if(!(ospvAudit->ospmAuditComm->Flags & OSPC_COMM_AUDIT_ON))
                        {
                            errorcode = OSPPAuditInit(ospvAudit);
                            OSPPCommSetAuditFlag(ospvAudit->ospmAuditComm, OSPC_COMM_AUDIT_ON);
                        }
                    break;

                    case OSPC_AUDIT_FLUSH_BUFFER:
                        /* signal worker thread to flush buffer */
                        OSPM_MUTEX_LOCK(ospvAudit->ospmAuditWorkerMutex, errorcode);

                        if(errorcode == OSPC_ERR_NO_ERROR)
                        {
                            /* signal condvar to send data */
                            ospvAudit->ospmAuditFlags |= OSPC_AUDIT_FLUSH_BUFFER_NOW;

                            OSPM_CONDVAR_SIGNAL(ospvAudit->ospmAuditWorkerCondVar, errorcode);
                            OSPM_MUTEX_UNLOCK(ospvAudit->ospmAuditWorkerMutex, errorcode);
                        }

                    break;

                    default:

                    break;
                }
            }
        }

        if(csaudit != OSPC_OSNULL)
        {
            if(OSPPCSAuditHasTrigger(csaudit))
            {
                trigger = OSPPCSAuditGetTrigger(csaudit);
                if(OSPM_STRCMP((const char *)trigger, "stop") == 0)
                {
                    /* Unset auditing flag */
                    OSPPCommSetAuditFlag(ospvAudit->ospmAuditComm, OSPC_COMM_AUDIT_OFF);

                    /* Check for stuff in buffer */
                    if(!(ospvAudit->ospmAuditFlags & OSPC_AUDIT_BUFFER_IS_EMPTY))
                    {

                        /* signal worker thread to flush buffer */
                        OSPM_MUTEX_LOCK(ospvAudit->ospmAuditWorkerMutex, errorcode);

                        if(errorcode == OSPC_ERR_NO_ERROR)
                        {
                            /* signal condvar to send data */
                            ospvAudit->ospmAuditFlags |= OSPC_AUDIT_FLUSH_BUFFER_NOW;

                            OSPM_CONDVAR_SIGNAL(ospvAudit->ospmAuditWorkerCondVar, errorcode);
                            OSPM_MUTEX_UNLOCK(ospvAudit->ospmAuditWorkerMutex, errorcode);
                        }
                        }
                }
                else if(OSPM_STRCMP((const char *)trigger, "start") == 0)
                {
                    /* If already on, don't turn on again */
                    if(!(ospvAudit->ospmAuditComm->Flags & OSPC_COMM_AUDIT_ON))
                    {
                        /* Make sure buffer is clear */
                        if(ospvAudit->ospmAuditFlags & OSPC_AUDIT_BUFFER_IS_EMPTY)
                        {
                            errorcode = OSPPAuditInit(ospvAudit);
                            OSPPCommSetAuditFlag(ospvAudit->ospmAuditComm, OSPC_COMM_AUDIT_ON);
                        }
                    }
                }
            }

        }
    }

    return;
}

/* Delete component id list */
void
OSPPAuditComponentIdDelete(
    OSPTAUDIT   *ospvAudit
)
{
    OSPTCOMPONENTID *compid = OSPC_OSNULL;

    if(ospvAudit != OSPC_OSNULL)
    {
        if(ospvAudit->ospmAuditComponentIdList != OSPC_OSNULL)
        {
            while(!OSPPListEmpty(&(ospvAudit->ospmAuditComponentIdList)))
            {
                compid = (OSPTCOMPONENTID *)OSPPListRemove(&(ospvAudit->ospmAuditComponentIdList));
                if(compid->ospmComponentId != OSPC_OSNULL)
                {
                    OSPM_FREE(compid->ospmComponentId);
                }

                if(compid != OSPC_OSNULL)
                {
                    OSPM_FREE(compid);
                }
            }  

            OSPPListDelete(&(ospvAudit->ospmAuditComponentIdList));
        }
    }

    return;
}

/* Create new component id item */
OSPTCOMPONENTID *
OSPPAuditComponentIdNew(
    unsigned char *ospvComponentId, 
    int           ospvComponentIdLen
)
{
    OSPTCOMPONENTID *compid = OSPC_OSNULL;

    if( ospvComponentId != OSPC_OSNULL)
    {
        OSPM_MALLOC(compid, OSPTCOMPONENTID, sizeof(OSPTCOMPONENTID));
        if (compid != OSPC_OSNULL)
        {
            OSPPListLinkNew (&(compid->ospmComponentIdLink));
            OSPM_MALLOC(compid->ospmComponentId, unsigned char, ospvComponentIdLen + 1);
            OSPM_MEMSET(compid->ospmComponentId, 0, ospvComponentIdLen + 1);
            OSPM_MEMCPY(compid->ospmComponentId, ospvComponentId, ospvComponentIdLen);
        }
    }

    return compid;
}

/* delete audit object and all space allocated within it */
int
OSPPAuditDelete(
    OSPTAUDIT	**ospvAudit)
{
    int         errorcode = OSPC_ERR_NO_ERROR;

    if(*ospvAudit != OSPC_OSNULL)
    {
        
        if((*ospvAudit)->ospmAuditStorage != OSPC_OSNULL)
        {
            OSPPBfrDelete(&((*ospvAudit)->ospmAuditStorage));
        }

        /* free url pointer */
        if((*ospvAudit)->ospmAuditURL != OSPC_OSNULL)
        {
            OSPM_FREE((*ospvAudit)->ospmAuditURL);
        }


        /* destroy mutexes and conditional vars */
        if((*ospvAudit)->ospmAuditAccessHasMutex)
        {
            OSPM_CONDVAR_DESTROY((*ospvAudit)->ospmAuditAccessCondVar, errorcode);

            OSPM_MUTEX_DESTROY((*ospvAudit)->ospmAuditAccessMutex, errorcode);
        }

        if((*ospvAudit)->ospmAuditWorkerHasMutex)
        {
            OSPM_CONDVAR_DESTROY((*ospvAudit)->ospmAuditWorkerCondVar, errorcode);

            OSPM_MUTEX_DESTROY((*ospvAudit)->ospmAuditWorkerMutex, errorcode);
        }

        /* Clean out componentId list */
        OSPPAuditComponentIdDelete(*ospvAudit);

        if(*ospvAudit != OSPC_OSNULL)
        {
            /* free audit block */
            OSPM_FREE(*ospvAudit);
        }
    }

    return errorcode;
}

/* Get buffer access conditional variable */
OSPTCONDVAR 
OSPPAuditGetAccessCondVar(
    OSPTAUDIT *ospvAudit
)
{
    OSPTCONDVAR condvar;
    OSPM_MEMSET(&condvar, 0, sizeof(OSPTCONDVAR));

    if(ospvAudit != OSPC_OSNULL)
    {
        return ospvAudit->ospmAuditAccessCondVar;
    }
    else
    {
        return condvar;
    }
}

unsigned    
OSPPAuditGetMaxMessages(
    OSPTAUDIT *ospvAudit
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        return ospvAudit->ospmAuditMaxMessages;
    }
    else
    {
        return 0;
    }
}

unsigned    
OSPPAuditGetMaxSpace(
    OSPTAUDIT *ospvAudit
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        return ospvAudit->ospmAuditMaxSpace;
    }
    else
    {
        return 0;
    }
}

unsigned   
OSPPAuditGetMaxTime(
    OSPTAUDIT *ospvAudit
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        return ospvAudit->ospmAuditMaxTime;
    }
    else
    {
        return 0;
    }
}

/* Get start time for auditing */
unsigned long  
OSPPAuditGetStartTime(
    OSPTAUDIT *ospvAudit)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        return ospvAudit->ospmAuditStartTime;
    }
    else
    {
        return 0;
    }
}

/* Get the URL for auditing */
const char  *
OSPPAuditGetURL(
    OSPTAUDIT *ospvAudit)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        return ospvAudit->ospmAuditURL;
    }
    else
    {
        return OSPC_OSNULL;
    }
}

/* Get worker conditional variable */
OSPTCONDVAR 
OSPPAuditGetWorkerCondVar(
    OSPTAUDIT *ospvAudit
)
{
    OSPTCONDVAR condvar;
    OSPM_MEMSET(&condvar, 0, sizeof(OSPTCONDVAR));

    if(ospvAudit != OSPC_OSNULL)
    {
        return ospvAudit->ospmAuditWorkerCondVar;
    }
    else
    {
        return condvar;
    }
}

/* Increment used space counter */
void        
OSPPAuditIncrementUsedSpace(
    OSPTAUDIT *ospvAudit, 
    unsigned ospvIncrement
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        ospvAudit->ospmAuditUsedSpace += ospvIncrement;
    }

    return;
}

/* Begin collecting audit data */
int
OSPPAuditInit(
    OSPTAUDIT *ospvAudit)
{
    int errorcode = OSPC_ERR_NO_ERROR;

    if(ospvAudit != OSPC_OSNULL)
    {
        /* Set start time */
        OSPPAuditSetStartTime(ospvAudit, time(NULL));
        OSPPListNew(&(ospvAudit->ospmAuditComponentIdList));

        /* Start worker thread */
        errorcode = OSPPAuditStartWorker(ospvAudit);
        if(errorcode != OSPC_ERR_NO_ERROR)
        {
            OSPM_DBGERRORLOG(errorcode, "error from OSPPAuditStartWorker.");
        }
    }
    else
    {
        errorcode = OSPC_ERR_AUDIT_NOT_FOUND;
        OSPM_DBGERRORLOG(errorcode, "Audit not found.");
    }

    return errorcode;
}

void
OSPPAuditInitializeBuffer(
    OSPTAUDIT   *ospvAudit
)
{
    int     numbyteswritten = 0;
    char    random[OSPC_MAX_RANDOM];

    OSPM_MEMSET(random, 0, OSPC_MAX_RANDOM);

    /* add xml header to buffer */
    numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                        OSPC_AUDIT_XML_HEADER, 
                                        OSPC_AUDIT_XML_HDR_LEN);
    /* increment used space */
    OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);
    numbyteswritten = 0;

    /* add "Message" header to buffer */
    numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                        OSPC_AUDIT_MSG_HEADER, 
                                        OSPC_AUDIT_MSG_HDR_LEN);
    /* increment used space */
    OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);
    numbyteswritten = 0;

    /* add message id string to buffer.
       use the random generator since we have no TransactionID
    */
    numbyteswritten = OSPPUtilGetRandom(random, 0);
    if(numbyteswritten > 0)
    {
        numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                        random, 
                                        numbyteswritten);
        /* increment used space */
        OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);
        numbyteswritten = 0;
        OSPM_MEMSET(random, 0, OSPC_MAX_RANDOM);
    }

    /* add "random" string to buffer */
    numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                        OSPC_AUDIT_MSG_RANDOM, 
                                        OSPC_AUDIT_MSG_RANDOM_LEN);
    /* increment used space */
    OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);
    numbyteswritten = 0;

    /* add random attr string to buffer */
    numbyteswritten = OSPPUtilGetRandom(random, 0);
    if(numbyteswritten > 0)
    {
        numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                        random, 
                                        numbyteswritten);
        /* increment used space */
        OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);
        numbyteswritten = 0;

        /* add end tag to buffer */
        numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                            "\"", 
                                            1);
        /* increment used space */
        OSPPAuditIncrementUsedSpace(ospvAudit, 1);
        numbyteswritten = 0;
    }

    /* add end tag to buffer */
    numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                        OSPC_AUDIT_TAG_END, 
                                        OSPC_AUDIT_TAG_END_LEN);
    /* increment used space */
    OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);
    numbyteswritten = 0;

    return;
}

/* Monitor worker conditional variable in audit and wait for conditions to be met */
static
OSPTTHREADRETURN 
OSPPAuditMonitor(
    void *ospvArg       /* Audit block cast to a void */
)
{
    int         errorcode   = OSPC_ERR_NO_ERROR,
                tmperror    = OSPC_ERR_NO_ERROR;
    OSPTAUDIT   *audit     = OSPC_OSNULL;
    OSPTBOOL    do_forever  = OSPC_TRUE;

    audit = (OSPTAUDIT *)ospvArg;

    while(do_forever)
    {
        /*
         * acquire worker mutex
         */
        OSPM_MUTEX_LOCK(audit->ospmAuditWorkerMutex, errorcode);

        if(errorcode == OSPC_ERR_NO_ERROR)
        {
            /*
             * wait for conditional variable on the flush flag
             */
            while ((errorcode != OSPC_ERR_OS_CONDVAR_TIMEOUT) && 
                   (audit->ospmAuditFlags & OSPC_AUDIT_FLUSH_BUFFER_NOW) == 0) 
            {

                OSPM_CONDVAR_TIMEDWAIT(audit->ospmAuditWorkerCondVar,
                        audit->ospmAuditWorkerMutex, audit->ospmAuditMaxTime, errorcode);

            }

            if((audit->ospmAuditFlags & OSPC_AUDIT_FLUSH_BUFFER_NOW) ||
                (errorcode == OSPC_ERR_OS_CONDVAR_TIMEOUT))
            {
                OSPM_MUTEX_LOCK(audit->ospmAuditAccessMutex, errorcode);

                if(errorcode == OSPC_ERR_NO_ERROR)
                {
                    /*
                     * prepare and send the data to the auditurl
                     */
                    errorcode = OSPPAuditPrepareAndSend(audit);

                    /* If all Usage Indications have been confirmed, clear the buffer */
                    if((audit->ospmAuditNumMessages == 0) && (errorcode == OSPC_ERR_NO_ERROR))
                    {
                        OSPPAuditComponentIdDelete(audit);
                        errorcode = OSPPAuditResetDefaults(audit);
                    }

                    if(errorcode == OSPC_ERR_NO_ERROR)
                    {
                        audit->ospmAuditFlags |= OSPC_AUDIT_BUFFER_IS_EMPTY;
                        /* signal in case this is auditdelete */
                        OSPM_CONDVAR_SIGNAL(audit->ospmAuditAccessCondVar, errorcode);
                    }

                    OSPM_MUTEX_UNLOCK(audit->ospmAuditAccessMutex, errorcode);
                }
 /*               break;*/
            }

            /*
             * release the mutex lock
             */
            OSPM_MUTEX_UNLOCK(audit->ospmAuditWorkerMutex, tmperror);
        }
    }

/*    errorcode = OSPPAuditResetDefaults(audit);
*/

    OSPTTHREADRETURN_NULL();
}

/* Create new audit object */
OSPTAUDIT   *
OSPPAuditNew(
    const char *ospvAuditURL)
{
    OSPTAUDIT   *audit          = OSPC_OSNULL;
    int         errorcode       = OSPC_ERR_NO_ERROR;
    
    OSPM_MALLOC(audit, OSPTAUDIT, sizeof(OSPTAUDIT));
    if (audit != OSPC_OSNULL)
    {   
        OSPM_MEMSET(audit, 0, sizeof(OSPTAUDIT));

        /* set up the audit url */
        if(ospvAuditURL != OSPC_OSNULL)
        {
            OSPPAuditSetURL(audit, ospvAuditURL);

            /*
             * initialize the audit worker mutex
             */
            OSPM_MUTEX_INIT(audit->ospmAuditWorkerMutex, 0, errorcode);

            if(errorcode == OSPC_ERR_NO_ERROR)
            {   
                /*
                 * initialize the audit worker conditional variable
                 */
                audit->ospmAuditWorkerHasMutex = OSPC_TRUE;
                OSPM_CONDVAR_INIT(audit->ospmAuditWorkerCondVar, NULL, errorcode);
            }

            /* set up storage */
            if(errorcode == OSPC_ERR_NO_ERROR)
            {
                audit->ospmAuditStorage = OSPPBfrNew((unsigned)OSPC_AUDIT_MAX_SPACE);
                if(audit->ospmAuditStorage == OSPC_OSNULL)
                {
                    errorcode = OSPC_ERR_AUDIT_MALLOC_FAILED;
                }
            }

            if(errorcode == OSPC_ERR_NO_ERROR)
            {
                /*
                 * initialize the audit access mutex
                 */
                OSPM_MUTEX_INIT(audit->ospmAuditAccessMutex, 0, errorcode);

                if(errorcode == OSPC_ERR_NO_ERROR)
                {   
                    audit->ospmAuditAccessHasMutex = OSPC_TRUE;
                    /*
                     * initialize the audit access conditional variable
                     */
                    OSPM_CONDVAR_INIT(audit->ospmAuditAccessCondVar, NULL, errorcode);
                }
            }

            if(errorcode == OSPC_ERR_NO_ERROR)
            {
                OSPPAuditSetMaxMessages(audit, OSPC_AUDIT_MAX_MESSAGES);
                /* adjust space for space needed for
                 * Message end tag.
                 */
                OSPPAuditSetMaxSpace(audit, OSPC_AUDIT_MAX_SPACE - (OSPC_AUDIT_BFR_END_LEN + 1));
                OSPPAuditSetMaxTime(audit, OSPC_AUDIT_MAX_TIME);
            }

            /* Set up xml and Message tag at beginning of buffer */
            if(errorcode == OSPC_ERR_NO_ERROR)
            {
                OSPPAuditInitializeBuffer(audit);

                /* Set the "buffer is empty" flag */
                audit->ospmAuditFlags |= OSPC_AUDIT_BUFFER_IS_EMPTY;
            }
        }
        else
        {
            errorcode = OSPC_ERR_AUDIT_MALLOC_FAILED;
        }
    }

    if(errorcode != OSPC_ERR_NO_ERROR)
    {
        OSPPAuditDelete(&audit);
    }

    return audit;
}

/* Prepare audit message and send */
int         
OSPPAuditPrepareAndSend(
    OSPTAUDIT *ospvAudit
)
{
    int             errorcode           = OSPC_ERR_NO_ERROR;
    unsigned char   *signature          = OSPC_OSNULL;
    unsigned        sizeofsignature     = 0;
    unsigned char   *auditbuffer        = OSPC_OSNULL;
    unsigned        auditbuffersz       = 0;
    unsigned char   *outgoingmessage    = OSPC_OSNULL;
    unsigned        sizeofoutmsg        = 0;
    OSPTMSGINFO     *msginfo            = OSPC_OSNULL;
    int             numbyteswritten     = 0;

    if(ospvAudit != OSPC_OSNULL)
    {
        if((ospvAudit->ospmAuditSecurity != OSPC_OSNULL) &&
          (ospvAudit->ospmAuditStorage != OSPC_OSNULL))
        {

            /* Add ending "Message" tag */
            numbyteswritten = OSPPBfrWriteBlock(&(ospvAudit->ospmAuditStorage),
                                        OSPC_AUDIT_BFR_END, 
                                        OSPC_AUDIT_BFR_END_LEN);
            /* increment used space */
            OSPPAuditIncrementUsedSpace(ospvAudit, numbyteswritten);
            numbyteswritten = 0;


            auditbuffer = (unsigned char *)OSPPBfrLinearPtr(ospvAudit->ospmAuditStorage);
            auditbuffersz = OSPPBfrSize(ospvAudit->ospmAuditStorage);

            if(auditbuffersz > 0)
            {
                errorcode = OSPPSecSignatureCreate( ospvAudit->ospmAuditSecurity, 
                    auditbuffer, auditbuffersz, 
                    &signature, &sizeofsignature,
                    OSPC_SEC_SIGNATURE_ONLY);

                if((errorcode == OSPC_ERR_NO_ERROR) && (signature == OSPC_OSNULL))
                {
                    OSPM_MALLOC(signature,unsigned char,64);
                    if(signature != OSPC_OSNULL)
                    {
                        OSPM_STRCPY((char *)signature,"Signature placeholder");
                        sizeofsignature=OSPM_STRLEN((char *)signature);
                    }
                    else
                    {
                        errorcode=OSPC_ERR_SEC_NO_MEMORY;
                    }
                }
                if (errorcode == OSPC_ERR_NO_ERROR)
                {
                    errorcode = OSPPMimeMessageCreate(
                        auditbuffer, auditbuffersz,
                        signature, sizeofsignature, 
                        (unsigned char **)&outgoingmessage, 
                        &sizeofoutmsg);
                
                    if(errorcode == OSPC_ERR_NO_ERROR)
                    {

                        errorcode = OSPPMsgInfoNew(&msginfo);

                        if (errorcode == OSPC_ERR_NO_ERROR)
                        {

                            /* set the content type depending on the presence 
                             * or absence of a signature
                             */
                            if(signature != OSPC_OSNULL)
                            {
                                OSPM_MALLOC(msginfo->ContentType, 
                                             unsigned char, 
                                             strlen(OSPC_COMM_MULTI_MSG)+1);
                                if(msginfo->ContentType != OSPC_OSNULL)
                                {
                                    OSPM_MEMSET(msginfo->ContentType,
                                                 0,
                                                 strlen(OSPC_COMM_MULTI_MSG)+1);

                                    OSPM_MEMCPY(msginfo->ContentType,
                                                 OSPC_COMM_MULTI_MSG,
                                                 strlen(OSPC_COMM_MULTI_MSG));
                                }
                            }
                            else
                            {
                                OSPM_MALLOC(msginfo->ContentType, 
                                             unsigned char, 
                                             strlen(OSPC_COMM_TEXT_MSG)+1);
                                if(msginfo->ContentType != OSPC_OSNULL)
                                {
                                    OSPM_MEMSET(msginfo->ContentType,
                                                 0,
                                                 strlen(OSPC_COMM_TEXT_MSG)+1);

                                    OSPM_MEMCPY(msginfo->ContentType,
                                                 OSPC_COMM_TEXT_MSG,
                                                 strlen(OSPC_COMM_TEXT_MSG));
                                }
                            }

                            /* set the audit flag */
                            msginfo->Flags = (unsigned char)(msginfo->Flags | OSPC_MSGINFO_AUDIT_TYPE);
                        }
                        else
                        {   /* msginfo isn't here */
                            errorcode = OSPC_ERR_AUDIT_NOT_FOUND;
                        }
                    } /* end if errorcode = OSPC_ERR_NO_ERROR after mimemessagecreate */

                    if (errorcode == OSPC_ERR_NO_ERROR)
                    {  
                        OSPPMsgInfoAssignRequestMsg(msginfo,
                            outgoingmessage, sizeofoutmsg);

                        errorcode = OSPPCommAddTransaction(ospvAudit->ospmAuditComm,
                                                           msginfo);

                        if (errorcode == OSPC_ERR_NO_ERROR)
                        {
                            errorcode = msginfo->ErrorCode;
                        }

                        if (errorcode == OSPC_ERR_NO_ERROR) 
                        {

                            errorcode = OSPPAuditProcessReturn(ospvAudit, msginfo);
                        }
                    }
                } /* end if errorcode == OSPC_ERR_NO_ERROR before mimemessagecreate */
            } /* end if auditbuffersz > 0 */    
        } /* end if security and storage != OSPC_OSNULL */
    } /* end if ospvAudit != OSPC_OSNULL */

    if (signature != (unsigned char *)OSPC_OSNULL)
    {
        OSPM_FREE(signature);
        signature = OSPC_OSNULL;
    }

    if(msginfo != OSPC_OSNULL)
    {
        OSPPMsgInfoDelete(&msginfo);
    }

    return errorcode;
}

/* Process return from server */
int
OSPPAuditProcessReturn(
    OSPTAUDIT *ospvAudit, 
    OSPTMSGINFO *ospvMsgInfo
)
{
    int             errorcode           = OSPC_ERR_NO_ERROR;
    unsigned char   *incomingmsg        = OSPC_OSNULL;
    unsigned char   *incomingsignature  = OSPC_OSNULL;
    unsigned        sizeofmsg           = 0;
    unsigned        sizeofsig           = 0;
    void            *resultrsp          = OSPC_OSNULL;
    OSPE_MSG_DATATYPES msgtype          = OSPC_MSG_LOWER_BOUND;
    OSPTUSAGECNF    *usagecnf           = (OSPTUSAGECNF *)OSPC_OSNULL;
    
    if(ospvMsgInfo != OSPC_OSNULL)
    {
        errorcode = OSPPMimeMessageParse(
            ospvMsgInfo->ResponseMsg, 
            ospvMsgInfo->ResponseSz,
            ospvMsgInfo->ContentType, 
            ospvMsgInfo->ContentSz,
            &incomingmsg, &sizeofmsg,
            &incomingsignature, &sizeofsig);
    }
    else
    {
        errorcode = OSPC_ERR_AUDIT_NOT_FOUND;
    }

#ifdef ENABLESMIME

    /*
     * Validate the S/MIME signature
     */
    if (errorcode == OSPC_ERR_NO_ERROR)
    {
        if((incomingsignature != OSPC_OSNULL) &&
            (ospvAudit->ospmAuditSecurity != OSPC_OSNULL))
        {
            errorcode = OSPPSecSignatureVerify( ospvAudit->ospmAuditSecurity,
                &incomingmsg, &sizeofmsg,
                incomingsignature, sizeofsig, OSPC_SEC_SIGNATURE_ONLY);
        }
        else
        {
            errorcode = OSPC_ERR_AUDIT_NOT_FOUND;
        }
    }
#endif

    if (errorcode == OSPC_ERR_NO_ERROR)
    {
        /*
         * Send the XML message doc to the XML parser
         */
        errorcode = OSPPXMLMessageParse(incomingmsg, sizeofmsg,
            &resultrsp, &msgtype);

        if (errorcode == OSPC_ERR_NO_ERROR)
        {

            switch (msgtype)
            {
                /*
                 * Authorization Response received
                 */
                
                case OSPC_MSG_ARESP:
                break;

                /*
                 * Usage Confirmation received
                 */

                case OSPC_MSG_UCNF:
                for((usagecnf = (OSPTUSAGECNF *)OSPPListFirst((OSPTLIST *)&(resultrsp)));
                    (usagecnf != OSPC_OSNULL);
                    (usagecnf = (OSPTUSAGECNF *)OSPPListNext((OSPTLIST *)&(resultrsp), usagecnf)))
                {
                    OSPPAuditVerifyUsageCnf(usagecnf, ospvAudit);
                }

                while(!OSPPListEmpty((OSPTLIST*)&resultrsp)) {
                    usagecnf = (OSPTUSAGECNF *)OSPPListRemove((OSPTLIST*)&resultrsp);
                    if(usagecnf != OSPC_OSNULL) {
                        OSPPUsageCnfDelete(&usagecnf);
                    }
                }

                OSPPListDelete((OSPTLIST*)&resultrsp);

                break;

                /*
                 * Authorization Confirmation received
                 */

                case OSPC_MSG_ACNF:

                break;

                /*
                 * Reauthorization Response received
                 */

                case OSPC_MSG_REARESP:
                break;

                /*
                 * The Unknown received
                 */

                default:
                errorcode = OSPC_ERR_DATA_INVALID_TYPE;
                break;
            }
        }
    }

    if (incomingmsg != (unsigned char *)OSPC_OSNULL)
    {
        OSPM_FREE(incomingmsg);
        incomingmsg = OSPC_OSNULL;
    }

    if (incomingsignature != (unsigned char *)OSPC_OSNULL)
    {
        OSPM_FREE(incomingsignature);
        incomingsignature = OSPC_OSNULL;
    }

    return errorcode;
}

/* Subtract Usage Indications from the buffer according to the component ID
 */
void
OSPPAuditRemoveComponentIdFromList(
    unsigned char   *ospvCompid,
    OSPTAUDIT       *ospvAudit
)
{
    OSPTCOMPONENTID *compid     = (OSPTCOMPONENTID *)OSPC_OSNULL;
    
    for(compid = (OSPTCOMPONENTID *)OSPPListFirst(&(ospvAudit->ospmAuditComponentIdList));
       (compid != OSPC_OSNULL);
        compid = (OSPTCOMPONENTID *)OSPPListNext(&(ospvAudit->ospmAuditComponentIdList), compid))
    {
        if(compid != OSPC_OSNULL)
        {
            if(compid->ospmComponentId != OSPC_OSNULL)
            {
                if(OSPM_STRCMP((const char *)(compid->ospmComponentId), (const char *)ospvCompid) == 0)
                {
                    ospvAudit->ospmAuditNumMessages--;
                    break;
                }
            }
        }
    }

    return;
}

/* Reset audit values to current defaults */
int         
OSPPAuditResetDefaults(
    OSPTAUDIT *ospvAudit
)
{
    int     errorcode = OSPC_ERR_NO_ERROR;

    if(ospvAudit != OSPC_OSNULL)
    {
/*        OSPM_MUTEX_LOCK(ospvAudit->ospmAuditAccessMutex, errorcode);
*/
        if(errorcode == OSPC_ERR_NO_ERROR)
        {
            OSPPBfrClear(ospvAudit->ospmAuditStorage);
            /* not sure if we want to worry about an error here MOC*/
/*            OSPM_MUTEX_UNLOCK(ospvAudit->ospmAuditAccessMutex, errorcode);
*/
        }

        OSPPAuditSetStartTime(ospvAudit, 0);
        OSPPAuditSetNumMessages(ospvAudit, 0);
        OSPPAuditSetUsedSpace(ospvAudit, 0);
      
        OSPPAuditSetMaxMessages(ospvAudit, OSPC_AUDIT_MAX_MESSAGES);
        OSPPAuditSetMaxSpace(ospvAudit, OSPC_AUDIT_MAX_SPACE - (OSPC_AUDIT_BFR_END_LEN + 1));
        OSPPAuditSetMaxTime(ospvAudit, OSPC_AUDIT_MAX_TIME);
        OSPPAuditInitializeBuffer(ospvAudit);
        ospvAudit->ospmAuditFlags = (unsigned char)(ospvAudit->ospmAuditFlags & OSPC_AUDIT_BUFFER_CLEAR_FLAGS);
    }
    return errorcode;
}

/* Set the audit comm pointer for sending data */
void        
OSPPAuditSetComm(
    OSPTAUDIT   *ospvAudit, 
    OSPTCOMM    *ospvComm
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        if(ospvComm != OSPC_OSNULL)
        {
            ospvAudit->ospmAuditComm = ospvComm;
        }
    }

    return;
}

void        
OSPPAuditSetMaxMessages(
    OSPTAUDIT *ospvAudit, 
    unsigned ospvNumMessages
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        ospvAudit->ospmAuditMaxMessages = ospvNumMessages;
    }

    return;
}

void        
OSPPAuditSetMaxSpace(
    OSPTAUDIT *ospvAudit, 
    unsigned ospvMaxSpace
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        ospvAudit->ospmAuditMaxSpace = ospvMaxSpace;
    }

    return;
}

void        
OSPPAuditSetMaxTime(
    OSPTAUDIT *ospvAudit, 
    unsigned  ospvMaxTime
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        ospvAudit->ospmAuditMaxTime = ospvMaxTime;
    }

    return;
}

void        
OSPPAuditSetNumMessages(
    OSPTAUDIT *ospvAudit, 
    unsigned ospvNumMsgs
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        ospvAudit->ospmAuditNumMessages = ospvNumMsgs;
    }

    return;
}

/* Set the audit security pointer for signing */
void        
OSPPAuditSetSecurity(
    OSPTAUDIT   *ospvAudit, 
    OSPTSEC     *ospvSecurity
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        if(ospvSecurity != OSPC_OSNULL)
        {
            ospvAudit->ospmAuditSecurity = ospvSecurity;
        }
    }

    return;
}

/* Set the start time for collecting data */
void         
OSPPAuditSetStartTime(
    OSPTAUDIT *ospvAudit, 
    unsigned long ospvTime)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        ospvAudit->ospmAuditStartTime = ospvTime;
    }

    return;
}

/* Set the URL for audit purposes */
void        
OSPPAuditSetURL(
    OSPTAUDIT	*ospvAudit, 
    const char *ospvAuditURL)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        if(ospvAuditURL != (const char *)OSPC_OSNULL)
        {
            if(ospvAudit->ospmAuditURL != OSPC_OSNULL)
            {
                OSPM_FREE(ospvAudit->ospmAuditURL);
            }

            OSPM_MALLOC(ospvAudit->ospmAuditURL,
                        char, 
                        strlen(ospvAuditURL)+1);

            if(ospvAudit->ospmAuditURL != OSPC_OSNULL)
            {
                OSPM_MEMCPY(ospvAudit->ospmAuditURL,
                            ospvAuditURL,
                            strlen(ospvAuditURL)+1);
            }
        }
    }

    return;
}

void        
OSPPAuditSetUsedSpace(
    OSPTAUDIT *ospvAudit, 
    unsigned ospvUsedSpace
)
{
    if(ospvAudit != OSPC_OSNULL)
    {
        ospvAudit->ospmAuditUsedSpace = ospvUsedSpace;
    }

    return;
}

/* Start the worker thread to wait for favorable conditions to send audit */
int         
OSPPAuditStartWorker(
    OSPTAUDIT *ospvAudit
)
{
    int         errorcode   = OSPC_ERR_NO_ERROR;
    OSPTTHRATTR thread_attr;

    if(ospvAudit == OSPC_OSNULL)
    {
        errorcode = OSPC_ERR_AUDIT_NOT_FOUND;
    }
    else
    {
        OSPM_THRATTR_INIT(thread_attr, errorcode);
        if(errorcode == OSPC_ERR_NO_ERROR)
        {
            OSPM_SETDETACHED_STATE(thread_attr, errorcode);
            if (errorcode == OSPC_ERR_NO_ERROR)
            {
                /*
                 * create the new thread which will monitor
                 * the access buffer flag in order to send data
                 */
                OSPM_CREATE_THREAD(ospvAudit->ospmAuditThreadId, &thread_attr,
                    OSPPAuditMonitor, ospvAudit, errorcode);
            }        
            OSPM_THRATTR_DESTROY(thread_attr);
        }

        if (errorcode != OSPC_ERR_NO_ERROR)
        {
            errorcode = OSPC_ERR_AUDIT_THREAD_INIT_FAILED;
            OSPM_DBGERRORLOG(errorcode, "thread initialization failed");
        }
    }

    return errorcode;
}

void
OSPPAuditVerifyUsageCnf(
    OSPTUSAGECNF    *ospvUsageCnf,
    OSPTAUDIT       *ospvAudit
)
{
    /* Get the component Id from the Usage Confirm,
     * remove the associated Usage Indication from the
     * storage buffer.
     */
    unsigned char   *compid = OSPC_OSNULL;

    if (OSPPUsageCnfHasComponentId(ospvUsageCnf))
    {
        compid = OSPPUsageCnfGetComponentId(ospvUsageCnf);
        OSPPAuditRemoveComponentIdFromList(compid, ospvAudit);
    }

    return;
}