Allow vendor-specific PB-TNC messages
[strongswan.git] / src / libtnccs / plugins / tnccs_20 / messages / pb_tnc_msg.h
1 /*
2 * Copyright (C) 2010-213 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 #include <pen/pen.h>
30
31 #define PB_TNC_VERSION 2
32
33 /**
34 * PB-TNC Message Types as defined in section 4.3 of RFC 5793
35 */
36 enum pb_tnc_msg_type_t {
37 PB_MSG_EXPERIMENTAL = 0,
38 PB_MSG_PA = 1,
39 PB_MSG_ASSESSMENT_RESULT = 2,
40 PB_MSG_ACCESS_RECOMMENDATION = 3,
41 PB_MSG_REMEDIATION_PARAMETERS = 4,
42 PB_MSG_ERROR = 5,
43 PB_MSG_LANGUAGE_PREFERENCE = 6,
44 PB_MSG_REASON_STRING = 7,
45 PB_MSG_ROOF = 7
46 };
47
48 /**
49 * enum name for pb_tnc_msg_type_t.
50 */
51 extern enum_name_t *pb_tnc_msg_type_names;
52
53 /**
54 * PB-TNC Message Type defined in the TCG namespace
55 */
56 enum pb_tnc_tcg_msg_type_t {
57 PB_TCG_MSG_PDP_REFERRAL = 1,
58 PB_TCG_MSG_ROOF = 1
59 };
60
61 /**
62 * enum name for pb_tnc_tcg_msg_type_t.
63 */
64 extern enum_name_t *pb_tnc_tcg_msg_type_names;
65
66 /**
67 * Information entry describing a PB-TNC Message Type
68 */
69 struct pb_tnc_msg_info_t {
70 u_int32_t min_size;
71 bool exact_size;
72 bool in_result_batch;
73 signed char has_noskip_flag;
74 };
75
76 #define TRUE_OR_FALSE 2
77
78 /**
79 * Information on PB-TNC Message Types
80 */
81 extern pb_tnc_msg_info_t pb_tnc_msg_infos[];
82
83 /**
84 * Information on PB-TNC TCG Message Types
85 */
86 extern pb_tnc_msg_info_t pb_tnc_tcg_msg_infos[];
87
88 /**
89 * Generic interface for all PB-TNC message types.
90 *
91 * To handle all messages in a generic way, this interface
92 * must be implemented by each message type.
93 */
94 struct pb_tnc_msg_t {
95
96 /**
97 * Get the PB-TNC Message Type
98 *
99 * @return PB-TNC Message Type
100 */
101 pen_type_t (*get_type)(pb_tnc_msg_t *this);
102
103 /**
104 * Get the encoding of the PB-TNC Message Value
105 *
106 * @return encoded PB-TNC Message Value
107 */
108 chunk_t (*get_encoding)(pb_tnc_msg_t *this);
109
110 /**
111 * Build the PB-TNC Message Value
112 */
113 void (*build)(pb_tnc_msg_t *this);
114
115 /**
116 * Process the PB-TNC Message Value
117 *
118 * @param relative offset where an error occurred
119 * @return return processing status
120 */
121 status_t (*process)(pb_tnc_msg_t *this, u_int32_t *offset);
122
123 /**
124 * Get a new reference to the message.
125 *
126 * @return this, with an increased refcount
127 */
128 pb_tnc_msg_t* (*get_ref)(pb_tnc_msg_t *this);
129
130 /**
131 * Destroys a pb_tnc_msg_t object.
132 */
133 void (*destroy)(pb_tnc_msg_t *this);
134 };
135
136 /**
137 * Create an unprocessed PB-TNC message
138 *
139 * Useful for the parser which wants a generic constructor for all
140 * pb_tnc_message_t types.
141 *
142 * @param vendor_id PB-TNC vendor ID
143 * @param type PB-TNC message type
144 * @param value PB-TNC message value
145 */
146 pb_tnc_msg_t* pb_tnc_msg_create_from_data(pen_type_t msg_type, chunk_t value);
147
148 #endif /** PB_TNC_MSG_H_ @}*/