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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
use std::io::{Read, Write};
use super::*;
use constants;
const ARRAY_DIMENSIONS_BIT: u8 = 1 << 6;
const ARRAY_VALUES_BIT: u8 = 1 << 7;
#[derive(PartialEq, Debug, Clone)]
pub struct MultiDimensionArray {
pub values: Vec<Variant>,
pub dimensions: Vec<Int32>
}
#[derive(PartialEq, Debug, Clone)]
pub enum Variant {
Empty,
Boolean(Boolean),
SByte(SByte),
Byte(Byte),
Int16(Int16),
UInt16(UInt16),
Int32(Int32),
UInt32(UInt32),
Int64(Int64),
UInt64(UInt64),
Float(Float),
Double(Double),
String(UAString),
DateTime(DateTime),
Guid(Guid),
StatusCode(StatusCode),
ByteString(ByteString),
XmlElement(XmlElement),
QualifiedName(Box<QualifiedName>),
LocalizedText(Box<LocalizedText>),
NodeId(Box<NodeId>),
ExpandedNodeId(Box<ExpandedNodeId>),
ExtensionObject(Box<ExtensionObject>),
DataValue(Box<DataValue>),
Array(Box<Vec<Variant>>),
MultiDimensionArray(Box<MultiDimensionArray>),
}
impl BinaryEncoder<Variant> for Variant {
fn byte_len(&self) -> usize {
let mut size: usize = 0;
size += 1;
size += match self {
&Variant::Empty => 0,
&Variant::Boolean(ref value) => value.byte_len(),
&Variant::SByte(ref value) => value.byte_len(),
&Variant::Byte(ref value) => value.byte_len(),
&Variant::Int16(ref value) => value.byte_len(),
&Variant::UInt16(ref value) => value.byte_len(),
&Variant::Int32(ref value) => value.byte_len(),
&Variant::UInt32(ref value) => value.byte_len(),
&Variant::Int64(ref value) => value.byte_len(),
&Variant::UInt64(ref value) => value.byte_len(),
&Variant::Float(ref value) => value.byte_len(),
&Variant::Double(ref value) => value.byte_len(),
&Variant::String(ref value) => value.byte_len(),
&Variant::DateTime(ref value) => value.byte_len(),
&Variant::Guid(ref value) => value.byte_len(),
&Variant::ByteString(ref value) => value.byte_len(),
&Variant::XmlElement(ref value) => value.byte_len(),
&Variant::NodeId(ref value) => value.byte_len(),
&Variant::ExpandedNodeId(ref value) => value.byte_len(),
&Variant::StatusCode(ref value) => value.byte_len(),
&Variant::QualifiedName(ref value) => value.byte_len(),
&Variant::LocalizedText(ref value) => value.byte_len(),
&Variant::ExtensionObject(ref value) => value.byte_len(),
&Variant::DataValue(ref value) => value.byte_len(),
&Variant::Array(ref values) => {
let mut size = 4;
for value in values.iter() {
size += Variant::byte_len_variant_value(value);
}
size
}
&Variant::MultiDimensionArray(ref mda) => {
let mut size = 4;
for value in mda.values.iter() {
size += Variant::byte_len_variant_value(value);
}
size += 4 + mda.dimensions.len() * 4;
size
}
};
size
}
fn encode<S: Write>(&self, stream: &mut S) -> EncodingResult<usize> {
let mut size: usize = 0;
let encoding_mask = self.get_encoding_mask();
size += write_u8(stream, encoding_mask)?;
size += match self {
&Variant::Empty => 0,
&Variant::Boolean(ref value) => value.encode(stream)?,
&Variant::SByte(ref value) => value.encode(stream)?,
&Variant::Byte(ref value) => value.encode(stream)?,
&Variant::Int16(ref value) => value.encode(stream)?,
&Variant::UInt16(ref value) => value.encode(stream)?,
&Variant::Int32(ref value) => value.encode(stream)?,
&Variant::UInt32(ref value) => value.encode(stream)?,
&Variant::Int64(ref value) => value.encode(stream)?,
&Variant::UInt64(ref value) => value.encode(stream)?,
&Variant::Float(ref value) => value.encode(stream)?,
&Variant::Double(ref value) => value.encode(stream)?,
&Variant::String(ref value) => value.encode(stream)?,
&Variant::DateTime(ref value) => value.encode(stream)?,
&Variant::Guid(ref value) => value.encode(stream)?,
&Variant::ByteString(ref value) => value.encode(stream)?,
&Variant::XmlElement(ref value) => value.encode(stream)?,
&Variant::NodeId(ref value) => value.encode(stream)?,
&Variant::ExpandedNodeId(ref value) => value.encode(stream)?,
&Variant::StatusCode(ref value) => value.encode(stream)?,
&Variant::QualifiedName(ref value) => value.encode(stream)?,
&Variant::LocalizedText(ref value) => value.encode(stream)?,
&Variant::ExtensionObject(ref value) => value.encode(stream)?,
&Variant::DataValue(ref value) => value.encode(stream)?,
&Variant::Array(ref values) => {
let mut size = write_i32(stream, values.len() as i32)?;
for value in values.iter() {
size += Variant::encode_variant_value(stream, value)?;
}
size
}
&Variant::MultiDimensionArray(ref mda) => {
let mut size = write_i32(stream, mda.values.len() as i32)?;
for value in mda.values.iter() {
size += Variant::encode_variant_value(stream, value)?;
}
size += write_i32(stream, mda.dimensions.len() as i32)?;
for d in mda.dimensions.iter() {
size += write_i32(stream, *d)?;
}
size
}
};
assert_eq!(size, self.byte_len());
Ok(size)
}
fn decode<S: Read>(stream: &mut S) -> EncodingResult<Self> {
let encoding_mask = Byte::decode(stream)?;
let element_encoding_mask = encoding_mask & !(ARRAY_DIMENSIONS_BIT | ARRAY_VALUES_BIT);
let array_length = if encoding_mask & ARRAY_VALUES_BIT != 0 {
let array_length = Int32::decode(stream)?;
if array_length <= 0 {
debug!("Invalid array_length {}", array_length);
return Err(BAD_DECODING_ERROR);
}
array_length
} else {
-1
};
let result = if array_length > 0 {
if array_length > constants::MAX_ARRAY_LENGTH as i32 {
return Err(BAD_ENCODING_LIMITS_EXCEEDED);
}
let mut result: Vec<Variant> = Vec::with_capacity(array_length as usize);
for _ in 0..array_length {
result.push(Variant::decode_variant_value(stream, element_encoding_mask)?);
}
if encoding_mask & ARRAY_DIMENSIONS_BIT != 0 {
let dimensions: Option<Vec<Int32>> = read_array(stream)?;
if dimensions.is_none() {
debug!("No array dimensions despite the bit flag being set");
return Err(BAD_DECODING_ERROR);
}
let dimensions = dimensions.unwrap();
let mut array_dimensions_length = 1;
for d in &dimensions {
if *d <= 0 {
debug!("Invalid array dimension {}", *d);
return Err(BAD_DECODING_ERROR);
}
array_dimensions_length *= *d;
}
if array_dimensions_length != array_length {
debug!("Array dimensions does not match array length {}", array_length);
Err(BAD_DECODING_ERROR)
} else {
Ok(Variant::new_multi_dimension_array(result, dimensions))
}
} else {
Ok(Variant::Array(Box::new(result)))
}
} else if encoding_mask & ARRAY_DIMENSIONS_BIT != 0 {
debug!("Array dimensions bit specified without any values");
Err(BAD_DECODING_ERROR)
} else {
Variant::decode_variant_value(stream, element_encoding_mask)
};
result
}
}
impl Variant {
pub fn new_node_id(node_id: NodeId) -> Variant {
Variant::NodeId(Box::new(node_id))
}
pub fn new_expanded_node_id(expanded_node_id: ExpandedNodeId) -> Variant {
Variant::ExpandedNodeId(Box::new(expanded_node_id))
}
pub fn new_qualified_name(qualified_name: QualifiedName) -> Variant {
Variant::QualifiedName(Box::new(qualified_name))
}
pub fn new_localized_text(localized_text: LocalizedText) -> Variant {
Variant::LocalizedText(Box::new(localized_text))
}
pub fn new_extension_object(extension_object: ExtensionObject) -> Variant {
Variant::ExtensionObject(Box::new(extension_object))
}
pub fn test_encoding_flag(encoding_mask: u8, data_type_id: DataTypeId) -> bool {
encoding_mask == data_type_id as u8
}
fn byte_len_variant_value(value: &Variant) -> usize {
let size = match value {
&Variant::Empty => 0,
&Variant::Boolean(ref value) => value.byte_len(),
&Variant::SByte(ref value) => value.byte_len(),
&Variant::Byte(ref value) => value.byte_len(),
&Variant::Int16(ref value) => value.byte_len(),
&Variant::UInt16(ref value) => value.byte_len(),
&Variant::Int32(ref value) => value.byte_len(),
&Variant::UInt32(ref value) => value.byte_len(),
&Variant::Int64(ref value) => value.byte_len(),
&Variant::UInt64(ref value) => value.byte_len(),
&Variant::Float(ref value) => value.byte_len(),
&Variant::Double(ref value) => value.byte_len(),
&Variant::String(ref value) => value.byte_len(),
&Variant::DateTime(ref value) => value.byte_len(),
&Variant::Guid(ref value) => value.byte_len(),
&Variant::ByteString(ref value) => value.byte_len(),
&Variant::XmlElement(ref value) => value.byte_len(),
&Variant::NodeId(ref value) => value.byte_len(),
&Variant::ExpandedNodeId(ref value) => value.byte_len(),
&Variant::StatusCode(ref value) => value.byte_len(),
&Variant::QualifiedName(ref value) => value.byte_len(),
&Variant::LocalizedText(ref value) => value.byte_len(),
&Variant::ExtensionObject(ref value) => value.byte_len(),
&Variant::DataValue(ref value) => value.byte_len(),
_ => {
error!("Cannot compute length of this type (probably nested array)");
0
}
};
size
}
fn encode_variant_value<S: Write>(stream: &mut S, value: &Variant) -> EncodingResult<usize> {
let result = match value {
&Variant::Empty => 0,
&Variant::Boolean(ref value) => value.encode(stream)?,
&Variant::SByte(ref value) => value.encode(stream)?,
&Variant::Byte(ref value) => value.encode(stream)?,
&Variant::Int16(ref value) => value.encode(stream)?,
&Variant::UInt16(ref value) => value.encode(stream)?,
&Variant::Int32(ref value) => value.encode(stream)?,
&Variant::UInt32(ref value) => value.encode(stream)?,
&Variant::Int64(ref value) => value.encode(stream)?,
&Variant::UInt64(ref value) => value.encode(stream)?,
&Variant::Float(ref value) => value.encode(stream)?,
&Variant::Double(ref value) => value.encode(stream)?,
&Variant::String(ref value) => value.encode(stream)?,
&Variant::DateTime(ref value) => value.encode(stream)?,
&Variant::Guid(ref value) => value.encode(stream)?,
&Variant::ByteString(ref value) => value.encode(stream)?,
&Variant::XmlElement(ref value) => value.encode(stream)?,
&Variant::NodeId(ref value) => value.encode(stream)?,
&Variant::ExpandedNodeId(ref value) => value.encode(stream)?,
&Variant::StatusCode(ref value) => value.encode(stream)?,
&Variant::QualifiedName(ref value) => value.encode(stream)?,
&Variant::LocalizedText(ref value) => value.encode(stream)?,
&Variant::ExtensionObject(ref value) => value.encode(stream)?,
&Variant::DataValue(ref value) => value.encode(stream)?,
_ => {
debug!("Cannot encode this variant value type (probably nested array)");
return Err(BAD_ENCODING_ERROR)
}
};
Ok(result)
}
fn decode_variant_value<S: Read>(stream: &mut S, encoding_mask: Byte) -> EncodingResult<Self> {
let result = if encoding_mask == 0 {
Variant::Empty
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Boolean) {
Variant::Boolean(Boolean::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::SByte) {
Variant::SByte(SByte::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Byte) {
Variant::Byte(Byte::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Int16) {
Variant::Int16(Int16::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::UInt16) {
Variant::UInt16(UInt16::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Int32) {
Variant::Int32(Int32::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::UInt32) {
Variant::UInt32(UInt32::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Int64) {
Variant::Int64(Int64::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::UInt64) {
Variant::UInt64(UInt64::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Float) {
Variant::Float(Float::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Double) {
Variant::Double(Double::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::String) {
Variant::String(UAString::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::DateTime) {
Variant::DateTime(DateTime::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::Guid) {
Variant::Guid(Guid::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::ByteString) {
Variant::ByteString(ByteString::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::XmlElement) {
Variant::XmlElement(XmlElement::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::NodeId) {
Variant::new_node_id(NodeId::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::ExpandedNodeId) {
Variant::new_expanded_node_id(ExpandedNodeId::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::StatusCode) {
Variant::StatusCode(StatusCode::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::QualifiedName) {
Variant::new_qualified_name(QualifiedName::decode(stream)?)
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::LocalizedText) {
Variant::new_localized_text(LocalizedText::decode(stream)?)
} else if encoding_mask == 22 {
Variant::ExtensionObject(Box::new(ExtensionObject::decode(stream)?))
} else if Variant::test_encoding_flag(encoding_mask, DataTypeId::DataValue) {
Variant::DataValue(Box::new(DataValue::decode(stream)?))
} else {
Variant::Empty
};
Ok(result)
}
pub fn new_multi_dimension_array(values: Vec<Variant>, dimensions: Vec<Int32>) -> Variant {
Variant::MultiDimensionArray(Box::new(MultiDimensionArray { values: values, dimensions: dimensions }))
}
pub fn new_i32_array(in_values: &[Int32]) -> Variant {
let mut values = Vec::with_capacity(in_values.len());
for v in in_values {
values.push(Variant::Int32(*v));
}
Variant::Array(Box::new(values))
}
pub fn new_string_array(in_values: &[String]) -> Variant {
let mut values = Vec::with_capacity(in_values.len());
for v in in_values {
values.push(Variant::String(UAString::from_str(&v)));
}
Variant::Array(Box::new(values))
}
pub fn is_numeric(&self) -> bool {
match self {
&Variant::SByte(_) | &Variant::Byte(_) |
&Variant::Int16(_) | &Variant::UInt16(_) |
&Variant::Int32(_) | &Variant::UInt32(_) |
&Variant::Int64(_) | &Variant::UInt64(_) |
&Variant::Float(_) | &Variant::Double(_) => true,
_ => false
}
}
pub fn as_f64(&self) -> Option<f64> {
match self {
&Variant::SByte(value) => Some(value as f64),
&Variant::Byte(value) => Some(value as f64),
&Variant::Int16(value) => Some(value as f64),
&Variant::UInt16(value) => Some(value as f64),
&Variant::Int32(value) => Some(value as f64),
&Variant::UInt32(value) => Some(value as f64),
&Variant::Int64(value) => {
Some(value as f64)
}
&Variant::UInt64(value) => {
Some(value as f64)
}
&Variant::Float(value) => Some(value as f64),
&Variant::Double(value) => Some(value),
_ => {
None
}
}
}
fn get_encoding_mask(&self) -> u8 {
let encoding_mask = match self {
&Variant::Empty => 0,
&Variant::Boolean(_) => DataTypeId::Boolean as u8,
&Variant::SByte(_) => DataTypeId::SByte as u8,
&Variant::Byte(_) => DataTypeId::Byte as u8,
&Variant::Int16(_) => DataTypeId::Int16 as u8,
&Variant::UInt16(_) => DataTypeId::UInt16 as u8,
&Variant::Int32(_) => DataTypeId::Int32 as u8,
&Variant::UInt32(_) => DataTypeId::UInt32 as u8,
&Variant::Int64(_) => DataTypeId::Int64 as u8,
&Variant::UInt64(_) => DataTypeId::UInt64 as u8,
&Variant::Float(_) => DataTypeId::Float as u8,
&Variant::Double(_) => DataTypeId::Double as u8,
&Variant::String(_) => DataTypeId::String as u8,
&Variant::DateTime(_) => DataTypeId::DateTime as u8,
&Variant::Guid(_) => DataTypeId::Guid as u8,
&Variant::ByteString(_) => DataTypeId::ByteString as u8,
&Variant::XmlElement(_) => DataTypeId::XmlElement as u8,
&Variant::NodeId(_) => DataTypeId::NodeId as u8,
&Variant::ExpandedNodeId(_) => DataTypeId::ExpandedNodeId as u8,
&Variant::StatusCode(_) => DataTypeId::StatusCode as u8,
&Variant::QualifiedName(_) => DataTypeId::QualifiedName as u8,
&Variant::LocalizedText(_) => DataTypeId::LocalizedText as u8,
&Variant::ExtensionObject(_) => 22,
&Variant::DataValue(_) => DataTypeId::DataValue as u8,
&Variant::Array(ref values) => {
let mut encoding_mask = if values.is_empty() {
0u8
} else {
values[0].get_encoding_mask()
};
encoding_mask |= ARRAY_VALUES_BIT;
encoding_mask
}
&Variant::MultiDimensionArray(ref mda) => {
let mut encoding_mask = if mda.values.is_empty() {
0u8
} else {
mda.values[0].get_encoding_mask()
};
encoding_mask |= ARRAY_VALUES_BIT | ARRAY_DIMENSIONS_BIT;
encoding_mask
}
};
encoding_mask
}
}