ipsecmsgchannel.h

ipsec PNE 3.3 source code, running at more than vxworks6.x version.

/* ipsecMsgChannel.h - WindNet IPsec and IKE: IPsec Message Channel Header File */

/* 
 * Copyright (c) 2000-2005 Wind River Systems, Inc. 
 * 
 * The right to copy, distribute, modify or otherwise make use 
 * of this software may be licensed only pursuant to the terms 
 * of an applicable Wind River license agreement. 
 */

/*
modification history
------------------------------------------
01d,26oct05,djp  Moved generic portions to common directory
01c,28sep05,ewh  Resolved SPR112465
01b,12apr05,djp  Fixed include paths
01a,11apr05,djp  added index to BOOL operation to support BOOL arrays
*/


/************************************************************************/
#if !defined (__IPSECMSGCHANNEL_H__)
#define __IPSECMSGCHANNEL_H__

/* Provides global definitions for IPsec message channel operations */

#include "../msgCLib/msgCLib.h"
#include "../msgCLib/shMemLib.h"
#include "../common/wrSecMsgChannel.h"

/*
 * IPSEC specific subtypes for message channel operations
 */

typedef enum IPSEC_SUBTYPE
{
    GENERIC_REQUEST = WRSEC_SUBTYPE_LAST,
    IPSEC_STATS,            /* IPsec statistics requests                    */
    IPSEC_SUBTYPE_LAST = IPSEC_STATS        /* Always set to last enum      */
}
IPSEC_SUBTYPE;

/* 
 * The following enumerates the various IPSEC TSI requests that require a 
 * configuration string. 
 */

typedef enum IPSEC_CONFIG_OPCODE
{
    IPSEC_ATTACH_IF,
    IPSEC_DETACH_IF,
    IPSEC_DFBIT,
    IPSEC_SET_PMTU_AGE,
    IPSEC_MON,
    IPSEC_DEBUG
}
IPSEC_CONFIG_OPCODE;

/* The following enumerates IPSEC API operations that do not require a
 * parameter string.
 */

typedef enum IPSEC_NO_PARAMS_OPCODE
{
    IPSEC_SHOW_VER,
    IPSEC_SHOW,
    IPSEC_SHOW_IF
}
IPSEC_NO_PARAMS_OPCODE;

/*
 * Opcodes for boolean get/set operations
 */

typedef enum IPSEC_BOOL_GET_SET_PARAM
{
    IPSEC_BOOL_RESERVED = 0,
    IPSEC_LOGGER_EVENT_ENABLED    /* ipsecLoggerLogEventEnabled[Get|Set]() */
}
IPSEC_BOOL_GET_SET_PARAM;

#ifdef INCLUDE_COUNTERS_IPSEC

#include <vxWorks.h> 
#include <wrn/ipsec/ipsecStats.h>

/* Defines the various operation codes associated with IPSEC Stats */

typedef enum IPSEC_STATS_OPCODE
{
    IPSEC_IF_STATS_GET,               /* ipsecIfStatsGet()              */
    IPSEC_POLICY_STATS_GET,           /* ipsecPolicyStatsGet()          */
    PROTECTION_SUITE_STATS_GET,       /* protectionSuiteStatsGet()      */
    PROTECTION_SUITE_STATS_GET_BY_SPI /* protectionSuiteStatsGetBySPI() */
}
IPSEC_STATS_OPCODE;

/* Format for requests to retrieve statistics */

#ifdef INCLUDE_COUNTERS_POLICIES
typedef struct POLICY_COUNTS_PARAMS
{
    SECURITY_POLICY_COUNTS inboundStats;
    SECURITY_POLICY_COUNTS outboundStats;
}
POLICY_COUNTS_PARAMS;
#endif


#ifdef INCLUDE_COUNTERS_PROTECTION_SUITES
typedef struct PS_COUNTS_PARAMS
{
    int                     spi;
    PROTECTION_SUITE_COUNTS psCounts;
}
PS_COUNTS_PARAMS;
#endif

typedef union IPSEC_COUNTS_PARAMS
{
#ifdef INCLUDE_COUNTERS_NETWORK_INTERFACE
    NETWORK_INTERFACE_COUNTS netIfParams;
#endif
#ifdef INCLUDE_COUNTERS_POLICIES
    POLICY_COUNTS_PARAMS     policyParams;
#endif
#ifdef INCLUDE_COUNTERS_PROTECTION_SUITES
    PS_COUNTS_PARAMS         psCountParams;
#endif
}
IPSEC_COUNTS_PARAMS;

typedef struct IPSEC_STATS_OPERATION
{
    WRSEC_REQUEST       request;          /* IPsec request preamble   */
    IPSEC_STATS_OPCODE  opCode;           /* Stats operation code     */
    BOOL		        shMemValid;	  /* True If shared memory is used */
    SHMEM_ID            shMem;            /* Shared memory identifier */
    IPSEC_COUNTS_PARAMS params;           /* Operation parameters     */      
}
IPSEC_STATS_OPERATION;

#endif /* INCLUDE_COUNTERS_IPSEC */

/*
 * Super union defining IPSEC messages of the base subtypes
 */

typedef union IPSEC_MSGC_MSG_UNION
{
    WRSEC_MSGC_MSG_UNION  wrSecMsg;
#ifdef INCLUDE_COUNTERS_IPSEC
    IPSEC_STATS_OPERATION ipsecStats;
#endif
} 
IPSEC_MSGC_MSG_UNION;


#endif /* __IPSECMSGCHANNEL_H__ */