97ebed27f9d694287d9b6a90c4b07f4744578f2f
[strongswan.git] / src / libtnccs / plugins / tnccs_20 / messages / pb_tnc_msg.h
1 /*
2 * Copyright (C) 2010 Andreas Steffen
3 * HSR Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup pb_tnc_msg pb_tnc_msg
18 * @{ @ingroup tnccs_20
19 */
20
21 #ifndef PB_TNC_MSG_H_
22 #define PB_TNC_MSG_H_
23
24 typedef enum pb_tnc_msg_type_t pb_tnc_msg_type_t;
25 typedef struct pb_tnc_msg_info_t pb_tnc_msg_info_t;
26 typedef struct pb_tnc_msg_t pb_tnc_msg_t;
27
28 #include <library.h>
29
30 #define PB_TNC_VERSION 2
31
32 /**
33 * PB-TNC Message Types as defined in section 4.3 of RFC 5793
34 */
35 enum pb_tnc_msg_type_t {
36 PB_MSG_EXPERIMENTAL = 0,
37 PB_MSG_PA = 1,
38 PB_MSG_ASSESSMENT_RESULT = 2,
39 PB_MSG_ACCESS_RECOMMENDATION = 3,
40 PB_MSG_REMEDIATION_PARAMETERS = 4,
41 PB_MSG_ERROR = 5,
42 PB_MSG_LANGUAGE_PREFERENCE = 6,
43 PB_MSG_REASON_STRING = 7,
44 PB_MSG_ROOF = 7
45 };
46
47 /**
48 * enum name for pb_tnc_msg_type_t.
49 */
50 extern enum_name_t *pb_tnc_msg_type_names;
51
52 /**
53 * Information entry describing a PB-TNC Message Type
54 */
55 struct pb_tnc_msg_info_t {
56 u_int32_t min_size;
57 bool exact_size;
58 bool in_result_batch;
59 signed char has_noskip_flag;
60 };
61
62 #define TRUE_OR_FALSE 2
63
64 /**
65 * Information on PB-TNC Message Types
66 */
67 extern pb_tnc_msg_info_t pb_tnc_msg_infos[];
68
69 /**
70 * Generic interface for all PB-TNC message types.
71 *
72 * To handle all messages in a generic way, this interface
73 * must be implemented by each message type.
74 */
75 struct pb_tnc_msg_t {
76
77 /**
78 * Get the PB-TNC Message Type
79 *
80 * @return PB-TNC Message Type
81 */
82 pb_tnc_msg_type_t (*get_type)(pb_tnc_msg_t *this);
83
84 /**
85 * Get the encoding of the PB-TNC Message Value
86 *
87 * @return encoded PB-TNC Message Value
88 */
89 chunk_t (*get_encoding)(pb_tnc_msg_t *this);
90
91 /**
92 * Build the PB-TNC Message Value
93 */
94 void (*build)(pb_tnc_msg_t *this);
95
96 /**
97 * Process the PB-TNC Message Value
98 *
99 * @param relative offset where an error occurred
100 * @return return processing status
101 */
102 status_t (*process)(pb_tnc_msg_t *this, u_int32_t *offset);
103
104 /**
105 * Get a new reference to the message.
106 *
107 * @return this, with an increased refcount
108 */
109 pb_tnc_msg_t* (*get_ref)(pb_tnc_msg_t *this);
110
111 /**
112 * Destroys a pb_tnc_msg_t object.
113 */
114 void (*destroy)(pb_tnc_msg_t *this);
115 };
116
117 /**
118 * Create an unprocessed PB-TNC message
119 *
120 * Useful for the parser which wants a generic constructor for all
121 * pb_tnc_message_t types.
122 *
123 * @param type PB-TNC message type
124 * @param value PB-TNC message value
125 */
126 pb_tnc_msg_t* pb_tnc_msg_create_from_data(pb_tnc_msg_type_t type, chunk_t value);
127
128 #endif /** PB_TNC_MSG_H_ @}*/