forked from cisagov/icsnpp-opcua-binary
-
Notifications
You must be signed in to change notification settings - Fork 0
/
opcua_binary-browse_analyzer.pac
270 lines (208 loc) · 17.1 KB
/
opcua_binary-browse_analyzer.pac
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
## opcua_binary-browse_analyzer.pac
##
## OPCUA Binary Protocol Analyzer
##
## Analyzer code for processing the browse service.
##
## Author: Melanie Pierce
## Contact: [email protected]
##
## Copyright (c) 2022 Battelle Energy Alliance, LLC. All rights reserved.
refine flow OPCUA_Binary_Flow += {
#
# BrowseRequest
#
function deliver_Svc_BrowseReq(msg: Browse_Req): bool
%{
// Debug printf("deliver_Svc_BrowseReq - begin\n");
// Debug printBrowseReq(msg);
// Debug printf("deliver_Svc_BrowseReq - end\n");
zeek::RecordValPtr info = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::Info);
info = assignMsgHeader(info, msg->service()->msg_body()->header());
info = assignMsgType(info, msg->service()->msg_body()->header());
info = assignReqHdr(info, msg->req_hdr());
info = assignService(info, msg->service());
zeek::BifEvent::enqueue_opcua_binary_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
info);
zeek::RecordValPtr browse_req = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::Browse);
// OpcUA_id
browse_req->Assign(BROWSE_OPCUA_LINK_ID_DST_IDX, info->GetField(OPCUA_LINK_ID_SRC_IDX));
// Include if Service is Browse or BrowseNext
browse_req->Assign(BROWSE_SERVICE_TYPE_IDX, zeek::make_intrusive<zeek::StringVal>(NODE_IDENTIFIER_MAP.find(msg->service()->identifier())->second));
// View Description Flattening
flattenOpcUA_NodeId(browse_req, msg->view_description()->view_id(), BROWSE_VIEW_ID_ENCODING_MASK_IDX);
browse_req->Assign(BROWSE_VIEW_DESCRIPTION_TIMESTAMP_IDX, zeek::make_intrusive<zeek::TimeVal>(msg->view_description()->timestamp()));
browse_req->Assign(BROWSE_VIEW_DESCRIPTION_VIEW_VERSION_IDX, zeek::val_mgr->Count(msg->view_description()->view_version()));
browse_req->Assign(BROWSE_REQ_MAX_REFS_IDX, zeek::val_mgr->Count(msg->req_max_refs_per_node()));
int32_t num_nodes_to_browse = (msg->num_nodes_to_browse());
if (num_nodes_to_browse > 0){
std::string browse_description_idx = generateId();
browse_req->Assign(BROWSE_DESCRTIPTION_LINK_ID_SRC_IDX, zeek::make_intrusive<zeek::StringVal>(browse_description_idx));
// Flatten each browse request
for (int32_t i=0; i < num_nodes_to_browse; i++){
zeek::RecordValPtr browse_description = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::BrowseDescription);
browse_description->Assign(BROWSE_DESCRIPTION_LINK_ID_DST_IDX, zeek::make_intrusive<zeek::StringVal>(browse_description_idx));
flattenOpcUA_NodeId(browse_description, msg->nodes_to_browse()->at(i)->node_id(), BROWSE_DESCRIPTION_ID_ENCODING_MASK_IDX);
if ((msg->nodes_to_browse()->at(i)->browse_direction_id()) == 0){
browse_description->Assign(BROWSE_DIRECTION_ID_IDX, zeek::make_intrusive<zeek::StringVal>("FWD"));
} else if ((msg->nodes_to_browse()->at(i)->browse_direction_id()) == 1){
browse_description->Assign(BROWSE_DIRECTION_ID_IDX, zeek::make_intrusive<zeek::StringVal>("INVERSE"));
} else if ((msg->nodes_to_browse()->at(i)->browse_direction_id()) == 2){
browse_description->Assign(BROWSE_DIRECTION_ID_IDX, zeek::make_intrusive<zeek::StringVal>("BOTH"));
}
flattenOpcUA_NodeId(browse_description, msg->nodes_to_browse()->at(i)->ref_type_id(), BROWSE_DESCRIPTION_REF_ID_ENCODING_MASK_IDX);
browse_description->Assign(BROWSE_DESCRIPTION_INCLUDE_SUBTYPES_IDX, zeek::val_mgr->Bool(msg->nodes_to_browse()->at(i)->include_subtypes()));
browse_description->Assign(BROWSE_DESCRIPTION_NODE_CLASS_MASK_IDX, zeek::make_intrusive<zeek::StringVal>(NODE_CLASSES_MAP.find(msg->nodes_to_browse()->at(i)->node_class_mask())->second));
browse_description->Assign(BROWSE_DESCRIPTION_RESULT_MASK_IDX, zeek::make_intrusive<zeek::StringVal>(uint32ToHexstring(msg->nodes_to_browse()->at(i)->result_mask())));
zeek::BifEvent::enqueue_opcua_binary_browse_description_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_description);
}
}
zeek::BifEvent::enqueue_opcua_binary_browse_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_req);
return true;
%}
#
# BrowseResponse and BrowseNextResponse
#
function deliver_Svc_BrowseRes(msg: Browse_Res): bool
%{
// Debug printf("deliver_Svc_BrowseRes - begin\n");
// Debug printBrowseRes(msg);
// Debug printf("deliver_Svc_BrowseRes - end\n");
zeek::RecordValPtr info = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::Info);
info = assignMsgHeader(info, msg->service()->msg_body()->header());
info = assignMsgType(info, msg->service()->msg_body()->header());
info = assignResHdr(connection(), info, msg->res_hdr());
info = assignService(info, msg->service());
zeek::BifEvent::enqueue_opcua_binary_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
info);
int32_t num_results = msg->results_table_size();
zeek::RecordValPtr browse_res = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::Browse);
browse_res->Assign(BROWSE_OPCUA_LINK_ID_DST_IDX, info->GetField(OPCUA_LINK_ID_SRC_IDX));
// Include if Service is Browse or BrowseNext
browse_res->Assign(BROWSE_SERVICE_TYPE_IDX, zeek::make_intrusive<zeek::StringVal>(NODE_IDENTIFIER_MAP.find(msg->service()->identifier())->second));
if (num_results > 0){
std::string browse_res_id = generateId();
browse_res->Assign(BROWSE_RESPONSE_LINK_ID_SRC_IDX, zeek::make_intrusive<zeek::StringVal>(browse_res_id));
// Loop through the Reference Description Array
for (int32_t i=0; i < num_results; i++){
zeek::RecordValPtr browse_result = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::BrowseResult);
browse_result->Assign(BROWSE_RESPONSE_LINK_ID_DST_IDX, zeek::make_intrusive<zeek::StringVal>(browse_res_id));
// Status Code
uint32_t status_code_level = 0;
std::string status_code_id = generateId();
browse_result->Assign(BROWSE_RESPONSE_STATUS_CODE_LINK_ID_SRC_IDX, zeek::make_intrusive<zeek::StringVal>(status_code_id));
generateStatusCodeEvent(connection(), browse_result->GetField(BROWSE_RESPONSE_STATUS_CODE_LINK_ID_SRC_IDX), StatusCode_Browse_Key, msg->results()->at(i)->status_code(), status_code_level);
if (msg->results()->at(i)->continuation_point()->length() > 0){
browse_result->Assign(BROWSE_RESPONSE_CONTINUATION_POINT_IDX, zeek::make_intrusive<zeek::StringVal>(bytestringToHexstring(msg->results()->at(i)->continuation_point()->byteString())));
}
int32_t num_references = msg->results()->at(i)->num_references();
if (num_references > 0){
std::string browse_reference_id = generateId();
browse_result->Assign(BROWSE_RESPONSE_REFERENCE_LINK_ID_SRC_IDX, zeek::make_intrusive<zeek::StringVal>(browse_reference_id));
// References are logged in a separate file for clarity
for (int32_t j=0; j < num_references; j++){
zeek::RecordValPtr browse_ref = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::BrowseReference);
browse_ref->Assign(BROWSE_RESPONSE_REFERENCE_LINK_ID_DST_IDX, zeek::make_intrusive<zeek::StringVal>(browse_reference_id));
flattenOpcUA_NodeId(browse_ref, msg->results()->at(i)->references()->at(j)->ref_type_id(), BROWSE_RESPONSE_REFERENCE_TYPE_ID_ENCODING_MASK_IDX);
browse_ref->Assign(BROWSE_RESPONSE_IS_FWD_IDX, zeek::val_mgr->Bool(msg->results()->at(i)->references()->at(j)->is_forward()));
flattenOpcUA_ExpandedNodeId(browse_ref, msg->results()->at(i)->references()->at(j)->target_node_id(), BROWSE_RESPONSE_TARGET_ID_ENCODING_MASK_IDX);
if (msg->results()->at(i)->references()->at(j)->browse_name()->namespace_index()!= 0){
browse_ref->Assign(BROWSE_RESPONSE_BROWSE_NAMESPACE_IDX_IDX, zeek::val_mgr->Count(msg->results()->at(i)->references()->at(j)->browse_name()->namespace_index()));
}
if (msg->results()->at(i)->references()->at(j)->browse_name()->name()->length() > 0){
browse_ref->Assign(BROWSE_RESPONSE_BROWSE_NAME_IDX, zeek::make_intrusive<zeek::StringVal>(std_str(msg->results()->at(i)->references()->at(j)->browse_name()->name()->string())));
}
browse_ref->Assign(BROWSE_RESPONSE_DISPLAY_NAME_ENCODING_IDX, zeek::make_intrusive<zeek::StringVal>(uint8ToHexstring(msg->results()->at(i)->references()->at(j)->display_name()->encoding_mask())));
if (isBitSet(msg->results()->at(i)->references()->at(j)->display_name()->encoding_mask(), localizedTextHasLocale) && msg->results()->at(i)->references()->at(j)->display_name()->locale()->length() > 0) {
browse_ref->Assign(BROWSE_RESPONSE_DISPLAY_NAME_LOCALE_IDX, zeek::make_intrusive<zeek::StringVal>(std_str(msg->results()->at(i)->references()->at(j)->display_name()->locale()->string())));
}
if (isBitSet(msg->results()->at(i)->references()->at(j)->display_name()->encoding_mask(), localizedTextHasText) && msg->results()->at(i)->references()->at(j)->display_name()->text()->length() > 0) {
browse_ref->Assign(BROWSE_RESPONSE_DISPLAY_NAME_TEXT_IDX, zeek::make_intrusive<zeek::StringVal>(std_str(msg->results()->at(i)->references()->at(j)->display_name()->text()->string())));
}
if (msg->results()->at(i)->references()->at(j)->node_class() != 0){
browse_ref->Assign(BROWSE_RESPONSE_NODE_CLASS_IDX, zeek::make_intrusive<zeek::StringVal>(NODE_CLASSES_MAP.find(msg->results()->at(i)->references()->at(j)->node_class())->second));
}
flattenOpcUA_ExpandedNodeId(browse_ref, msg->results()->at(i)->references()->at(j)->type_definition(), BROWSE_RESPONSE_TYPE_DEF_ENCODING_MASK_IDX);
zeek::BifEvent::enqueue_opcua_binary_browse_reference_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_ref);
}
}
zeek::BifEvent::enqueue_opcua_binary_browse_result_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_result);
}
}
zeek::BifEvent::enqueue_opcua_binary_browse_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_res);
// Diagnostic Information
if (msg->diag_info_size() > 0) {
string diagnostic_info_link_id = generateId(); // Link to tie OCPUA_Binary::BrowseSession and OPCUA_Binary::BrowseDiagnosticInfo together
string diagnostic_info_id = generateId(); // Link to tie OCPUA_Binary::BrowseDiagnosticInfo and OPCUA_Binary::DiagnosticInfoDetail together
// Assign the linkage in the OCPUA_Binary::Browse
browse_res->Assign(BROWSE_RESPONSE_DIAG_INFO_LINK_ID_SRC_IDX, zeek::make_intrusive<zeek::StringVal>(diagnostic_info_link_id));
uint32 innerDiagLevel = 0;
vector<OpcUA_String *> *stringTable = NULL;
for (int i = 0; i < msg->diag_info_size(); i++) {
// Assign the linkage in the OCPUA_Binary::BrowseDiagnosticInfo and enqueue the logging event
zeek::RecordValPtr browse_res_diagnostic_info = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::BrowseDiagnosticInfo);
browse_res_diagnostic_info->Assign(BROWSE_RESPONSE_DIAG_INFO_LINK_ID_DST_IDX, zeek::make_intrusive<zeek::StringVal>(diagnostic_info_link_id));
browse_res_diagnostic_info->Assign(BROWSE_DIAG_INFO_LINK_ID_SRC_IDX, zeek::make_intrusive<zeek::StringVal>(diagnostic_info_id));
zeek::BifEvent::enqueue_opcua_binary_browse_diagnostic_info_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_res_diagnostic_info);
// Process the details of the Diagnostic Information
generateDiagInfoEvent(connection(), browse_res_diagnostic_info->GetField(BROWSE_DIAG_INFO_LINK_ID_SRC_IDX), msg->diag_info()->at(i), stringTable, innerDiagLevel, StatusCode_Browse_DiagInfo_Key, DiagInfo_Browse_Key);
// Generate an new link to tie OCPUA_Binary::BrowseDiagnosticInfo and OPCUA_Binary::DiagnosticInfoDetail together
diagnostic_info_id = generateId();
}
}
return true;
%}
#
# BrowseNextRequest
#
function deliver_Svc_BrowseNextReq(msg: Browse_Next_Req): bool
%{
// Debug printf("deliver_Svc_BrowseNextReq - begin\n");
// Debug printBrowseNextReq(msg);
// Debug printf("deliver_Svc_BrowseNextReq - end\n");
zeek::RecordValPtr info = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::Info);
info = assignMsgHeader(info, msg->service()->msg_body()->header());
info = assignMsgType(info, msg->service()->msg_body()->header());
info = assignReqHdr(info, msg->req_hdr());
info = assignService(info, msg->service());
zeek::BifEvent::enqueue_opcua_binary_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
info);
int32_t num_continuation_points = msg->num_continuation_points();
zeek::RecordValPtr browse_next_req = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::Browse);
browse_next_req->Assign(BROWSE_OPCUA_LINK_ID_DST_IDX, info->GetField(OPCUA_LINK_ID_SRC_IDX));
// Include if Service is Browse or BrowseNext
browse_next_req->Assign(BROWSE_SERVICE_TYPE_IDX, zeek::make_intrusive<zeek::StringVal>(NODE_IDENTIFIER_MAP.find(msg->service()->identifier())->second));
browse_next_req->Assign(BROWSE_NEXT_RELEASE_CONTINUATION_POINTS_IDX, zeek::val_mgr->Bool(msg->release_continuation_points()));
if (num_continuation_points > 0){
std::string browse_continuation_points_id = generateId();
browse_next_req->Assign(BROWSE_NEXT_LINK_ID_SRC_IDX, zeek::make_intrusive<zeek::StringVal>(browse_continuation_points_id));
for (int32_t i=0; i < num_continuation_points; i++){
zeek::RecordValPtr browse_continuation_point = zeek::make_intrusive<zeek::RecordVal>(zeek::BifType::Record::OPCUA_Binary::BrowseRequestContinuationPoint);
browse_continuation_point->Assign(BROWSE_NEXT_LINK_ID_DST_IDX, zeek::make_intrusive<zeek::StringVal>(browse_continuation_points_id));
browse_continuation_point->Assign(BROWSE_CONTINUATION_POINT_IDX, zeek::make_intrusive<zeek::StringVal>(bytestringToHexstring(msg->continuation_points()->at(i)->byteString())));
zeek::BifEvent::enqueue_opcua_binary_browse_request_continuation_point_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_continuation_point);
}
}
zeek::BifEvent::enqueue_opcua_binary_browse_event(connection()->bro_analyzer(),
connection()->bro_analyzer()->Conn(),
browse_next_req);
return true;
%}
};