strongswan/src/libtnccs/plugins/tnccs_20/messages/pb_tnc_msg.h

168 lines
3.7 KiB
C

/*
* Copyright (C) 2010-213 Andreas Steffen
* HSR Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup pb_tnc_msg pb_tnc_msg
* @{ @ingroup tnccs_20
*/
#ifndef PB_TNC_MSG_H_
#define PB_TNC_MSG_H_
typedef enum pb_tnc_msg_type_t pb_tnc_msg_type_t;
typedef struct pb_tnc_msg_info_t pb_tnc_msg_info_t;
typedef struct pb_tnc_msg_t pb_tnc_msg_t;
#include <library.h>
#include <pen/pen.h>
#define PB_TNC_VERSION 2
/**
* PB-TNC Message Types as defined in section 4.3 of RFC 5793
*/
enum pb_tnc_msg_type_t {
PB_MSG_EXPERIMENTAL = 0,
PB_MSG_PA = 1,
PB_MSG_ASSESSMENT_RESULT = 2,
PB_MSG_ACCESS_RECOMMENDATION = 3,
PB_MSG_REMEDIATION_PARAMETERS = 4,
PB_MSG_ERROR = 5,
PB_MSG_LANGUAGE_PREFERENCE = 6,
PB_MSG_REASON_STRING = 7,
PB_MSG_ROOF = 7
};
/**
* enum name for pb_tnc_msg_type_t.
*/
extern enum_name_t *pb_tnc_msg_type_names;
/**
* PB-TNC Message Type defined in the TCG namespace
*/
enum pb_tnc_tcg_msg_type_t {
PB_TCG_MSG_RESERVED = 0,
PB_TCG_MSG_PDP_REFERRAL = 1,
PB_TCG_MSG_ROOF = 1
};
/**
* enum name for pb_tnc_tcg_msg_type_t.
*/
extern enum_name_t *pb_tnc_tcg_msg_type_names;
/**
* PB-TNC Message Type defined in the ITA namespace
*/
enum pb_tnc_ita_msg_type_t {
PB_ITA_MSG_NOSKIP_TEST = 0,
PB_ITA_MSG_MUTUAL_CAPABILITY = 1,
PB_ITA_MSG_ROOF = 1
};
/**
* enum name for pb_tnc_tcg_msg_type_t.
*/
extern enum_name_t *pb_tnc_ita_msg_type_names;
/**
* Information entry describing a PB-TNC Message Type
*/
struct pb_tnc_msg_info_t {
u_int32_t min_size;
bool exact_size;
bool in_result_batch;
signed char has_noskip_flag;
};
#define TRUE_OR_FALSE 2
/**
* Information on PB-TNC Message Types
*/
extern pb_tnc_msg_info_t pb_tnc_msg_infos[];
/**
* Information on PB-TNC TCG Message Types
*/
extern pb_tnc_msg_info_t pb_tnc_tcg_msg_infos[];
/**
* Information on PB-TNC ITA Message Types
*/
extern pb_tnc_msg_info_t pb_tnc_ita_msg_infos[];
/**
* Generic interface for all PB-TNC message types.
*
* To handle all messages in a generic way, this interface
* must be implemented by each message type.
*/
struct pb_tnc_msg_t {
/**
* Get the PB-TNC Message Type
*
* @return PB-TNC Message Type
*/
pen_type_t (*get_type)(pb_tnc_msg_t *this);
/**
* Get the encoding of the PB-TNC Message Value
*
* @return encoded PB-TNC Message Value
*/
chunk_t (*get_encoding)(pb_tnc_msg_t *this);
/**
* Build the PB-TNC Message Value
*/
void (*build)(pb_tnc_msg_t *this);
/**
* Process the PB-TNC Message Value
*
* @param relative offset where an error occurred
* @return return processing status
*/
status_t (*process)(pb_tnc_msg_t *this, u_int32_t *offset);
/**
* Get a new reference to the message.
*
* @return this, with an increased refcount
*/
pb_tnc_msg_t* (*get_ref)(pb_tnc_msg_t *this);
/**
* Destroys a pb_tnc_msg_t object.
*/
void (*destroy)(pb_tnc_msg_t *this);
};
/**
* Create an unprocessed PB-TNC message
*
* Useful for the parser which wants a generic constructor for all
* pb_tnc_message_t types.
*
* @param msg_type PB-TNC message type
* @param value PB-TNC message value
*/
pb_tnc_msg_t* pb_tnc_msg_create_from_data(pen_type_t msg_type, chunk_t value);
#endif /** PB_TNC_MSG_H_ @}*/