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
517
518
519
520
use attribute::AttributeId;
use basic_types::*;
use byte_string::ByteString;
use data_types::*;
use data_value::DataValue;
use date_time::DateTime;
use encoding::*;
use node_id::NodeId;
use node_ids::ObjectId;
use profiles;
use service_types::{AnonymousIdentityToken, ApplicationType, DataChangeFilter, DataChangeTrigger, EndpointDescription, ReadValueId, ServiceFault, SignatureData, UserNameIdentityToken, UserTokenType};
use service_types::{MonitoredItemCreateRequest, MonitoringParameters};
use service_types::ApplicationDescription;
use status_codes::StatusCode;
use status_codes::StatusCode::*;
use std;
use std::io::{Read, Write};
use string::UAString;
use supported_message::SupportedMessage;
use variant::Variant;
pub trait MessageInfo {
fn object_id(&self) -> ObjectId;
}
impl Into<SupportedMessage> for ServiceFault {
fn into(self) -> SupportedMessage {
SupportedMessage::ServiceFault(self)
}
}
impl ServiceFault {
pub fn new(request_header: &RequestHeader, service_result: StatusCode) -> ServiceFault {
ServiceFault {
response_header: ResponseHeader::new_service_result(request_header, service_result)
}
}
pub fn new_supported_message(request_header: &RequestHeader, service_result: StatusCode) -> SupportedMessage {
ServiceFault::new(request_header, service_result).into()
}
}
#[derive(Debug, Clone, PartialEq)]
pub struct RequestHeader {
pub authentication_token: NodeId,
pub timestamp: UtcTime,
pub request_handle: IntegerId,
pub return_diagnostics: UInt32,
pub audit_entry_id: UAString,
pub timeout_hint: UInt32,
pub additional_header: ExtensionObject,
}
impl BinaryEncoder<RequestHeader> for RequestHeader {
fn byte_len(&self) -> usize {
let mut size: usize = 0;
size += self.authentication_token.byte_len();
size += self.timestamp.byte_len();
size += self.request_handle.byte_len();
size += self.return_diagnostics.byte_len();
size += self.audit_entry_id.byte_len();
size += self.timeout_hint.byte_len();
size += self.additional_header.byte_len();
size
}
fn encode<S: Write>(&self, stream: &mut S) -> EncodingResult<usize> {
let mut size: usize = 0;
size += self.authentication_token.encode(stream)?;
size += self.timestamp.encode(stream)?;
size += self.request_handle.encode(stream)?;
size += self.return_diagnostics.encode(stream)?;
size += self.audit_entry_id.encode(stream)?;
size += self.timeout_hint.encode(stream)?;
size += self.additional_header.encode(stream)?;
Ok(size)
}
fn decode<S: Read>(stream: &mut S) -> EncodingResult<Self> {
let authentication_token = NodeId::decode(stream)?;
let timestamp = UtcTime::decode(stream)?;
let request_handle = IntegerId::decode(stream)?;
let return_diagnostics = UInt32::decode(stream)?;
let audit_entry_id = UAString::decode(stream)?;
let timeout_hint = UInt32::decode(stream)?;
let additional_header = ExtensionObject::decode(stream)?;
Ok(RequestHeader {
authentication_token,
timestamp,
request_handle,
return_diagnostics,
audit_entry_id,
timeout_hint,
additional_header,
})
}
}
impl RequestHeader {
pub fn new(authentication_token: &NodeId, timestamp: &DateTime, request_handle: IntegerId) -> RequestHeader {
RequestHeader {
authentication_token: authentication_token.clone(),
timestamp: timestamp.clone(),
request_handle,
return_diagnostics: 0,
audit_entry_id: UAString::null(),
timeout_hint: 0,
additional_header: ExtensionObject::null(),
}
}
}
#[derive(Debug, Clone, PartialEq)]
pub struct ResponseHeader {
pub timestamp: UtcTime,
pub request_handle: IntegerId,
pub service_result: StatusCode,
pub service_diagnostics: DiagnosticInfo,
pub string_table: Option<Vec<UAString>>,
pub additional_header: ExtensionObject,
}
impl BinaryEncoder<ResponseHeader> for ResponseHeader {
fn byte_len(&self) -> usize {
let mut size = 0;
size += self.timestamp.byte_len();
size += self.request_handle.byte_len();
size += self.service_result.byte_len();
size += self.service_diagnostics.byte_len();
size += byte_len_array(&self.string_table);
size += self.additional_header.byte_len();
size
}
fn encode<S: Write>(&self, stream: &mut S) -> EncodingResult<usize> {
let mut size = 0;
size += self.timestamp.encode(stream)?;
size += self.request_handle.encode(stream)?;
size += self.service_result.encode(stream)?;
size += self.service_diagnostics.encode(stream)?;
size += write_array(stream, &self.string_table)?;
size += self.additional_header.encode(stream)?;
assert_eq!(size, self.byte_len());
Ok(size)
}
fn decode<S: Read>(stream: &mut S) -> EncodingResult<Self> {
let timestamp = UtcTime::decode(stream)?;
let request_handle = IntegerId::decode(stream)?;
let service_result = StatusCode::decode(stream)?;
let service_diagnostics = DiagnosticInfo::decode(stream)?;
let string_table: Option<Vec<UAString>> = read_array(stream)?;
let additional_header = ExtensionObject::decode(stream)?;
Ok(ResponseHeader {
timestamp,
request_handle,
service_result,
service_diagnostics,
string_table,
additional_header,
})
}
}
impl ResponseHeader {
pub fn new_good(request_header: &RequestHeader) -> ResponseHeader {
ResponseHeader::new_service_result(request_header, Good)
}
pub fn new_service_result(request_header: &RequestHeader, service_result: StatusCode) -> ResponseHeader {
ResponseHeader::new_timestamped_service_result(DateTime::now(), request_header, service_result)
}
pub fn new_timestamped_service_result(timestamp: DateTime, request_header: &RequestHeader, service_result: StatusCode) -> ResponseHeader {
ResponseHeader {
timestamp,
request_handle: request_header.request_handle,
service_result,
service_diagnostics: DiagnosticInfo::new(),
string_table: None,
additional_header: ExtensionObject::null(),
}
}
pub fn null() -> ResponseHeader {
ResponseHeader {
timestamp: DateTime::now(),
request_handle: 0,
service_result: Good,
service_diagnostics: DiagnosticInfo::new(),
string_table: None,
additional_header: ExtensionObject::null(),
}
}
}
pub struct ValueChangeFilter {}
impl ValueChangeFilter {
pub fn compare(&self, v1: &DataValue, v2: &DataValue) -> bool {
v1.value == v2.value
}
}
impl DataChangeFilter {
pub fn compare(&self, v1: &DataValue, v2: &DataValue, eu_range: Option<(f64, f64)>) -> bool {
match self.trigger {
DataChangeTrigger::Status => {
v1.status == v2.status
}
DataChangeTrigger::StatusValue => {
v1.status == v2.status &&
self.compare_value_option(&v1.value, &v2.value, eu_range)
}
DataChangeTrigger::StatusValueTimestamp => {
v1.status == v2.status &&
self.compare_value_option(&v1.value, &v2.value, eu_range) &&
v1.server_timestamp == v2.server_timestamp
}
}
}
pub fn compare_value_option(&self, v1: &Option<Variant>, v2: &Option<Variant>, eu_range: Option<(f64, f64)>) -> bool {
if (v1.is_some() && v2.is_none()) ||
(v1.is_none() && v2.is_some()) {
false
} else if v1.is_none() && v2.is_none() {
true
} else {
let v1 = v1.as_ref().unwrap();
let v2 = v2.as_ref().unwrap();
let result = self.compare_value(v1, v2, eu_range);
if let Ok(result) = result {
result
} else {
true
}
}
}
pub fn compare_value(&self, v1: &Variant, v2: &Variant, eu_range: Option<(f64, f64)>) -> std::result::Result<bool, StatusCode> {
if self.deadband_type == 0 {
Ok(v1 == v2)
} else {
let v1 = v1.as_f64();
let v2 = v2.as_f64();
if v1.is_none() || v2.is_none() {
return Ok(false);
}
let v1 = v1.unwrap();
let v2 = v2.unwrap();
if self.deadband_value < 0f64 {
return Err(BadDeadbandFilterInvalid);
}
if self.deadband_type == 1 {
Ok(DataChangeFilter::abs_compare(v1, v2, self.deadband_value))
} else if self.deadband_type == 2 {
if eu_range.is_none() {
return Err(BadDeadbandFilterInvalid);
}
let (low, high) = eu_range.unwrap();
if low >= high {
return Err(BadDeadbandFilterInvalid);
}
Ok(DataChangeFilter::pct_compare(v1, v2, low, high, self.deadband_value))
} else {
return Err(BadDeadbandFilterInvalid);
}
}
}
pub fn abs_compare(v1: f64, v2: f64, threshold_diff: f64) -> bool {
let diff = (v1 - v2).abs();
diff <= threshold_diff
}
pub fn pct_compare(v1: f64, v2: f64, low: f64, high: f64, threshold_pct_change: f64) -> bool {
let v1_pct = 100f64 * (v1 - low) / (high - low);
let v2_pct = 100f64 * (v2 - low) / (high - low);
let pct_change = (v1_pct - v2_pct).abs();
pct_change <= threshold_pct_change
}
}
impl EndpointDescription {
pub fn find_policy_id(&self, token_type: UserTokenType) -> Option<UAString> {
if let Some(ref tokens) = self.user_identity_tokens {
if let Some(token) = tokens.iter().find(|t| t.token_type == token_type) {
Some(token.policy_id.clone())
} else {
None
}
} else {
None
}
}
}
impl UserNameIdentityToken {
pub fn is_valid(&self) -> bool {
!self.user_name.is_null() && !self.password.is_null()
}
pub fn authenticate(&self, username: &str, password: &[u8]) -> Result<(), StatusCode> {
let valid = if self.is_valid() {
if self.encryption_algorithm.is_null() {
let id_user = self.user_name.as_ref();
let id_pass = self.password.value.as_ref().unwrap();
if username == id_user {
if password == id_pass.as_slice() {
true
} else {
error!("Authentication error: User name {} supplied by client is recognised but password is not", username);
false
}
} else {
error!("Authentication error: User name supplied by client is unrecognised");
false
}
} else {
error!("Authentication error: Unsupported encryption algorithm {}", self.encryption_algorithm.as_ref());
false
}
} else {
error!("Authentication error: User / pass credentials not supplied in token");
false
};
if valid {
Ok(())
} else {
Err(BadIdentityTokenRejected)
}
}
}
impl<'a> From<&'a NodeId> for ReadValueId {
fn from(node_id: &'a NodeId) -> Self {
Self::from(node_id.clone())
}
}
impl From<NodeId> for ReadValueId {
fn from(node_id: NodeId) -> Self {
ReadValueId {
node_id,
attribute_id: AttributeId::Value as UInt32,
index_range: UAString::null(),
data_encoding: QualifiedName::null(),
}
}
}
impl<'a> From<(UInt16, &'a str)> for ReadValueId {
fn from(v: (UInt16, &'a str)) -> Self {
Self::from(NodeId::from(v))
}
}
impl AnonymousIdentityToken {
pub fn new() -> AnonymousIdentityToken {
AnonymousIdentityToken {
policy_id: UAString::from(profiles::SECURITY_USER_TOKEN_POLICY_ANONYMOUS)
}
}
}
impl SignatureData {
pub fn null() -> SignatureData {
SignatureData {
algorithm: UAString::null(),
signature: ByteString::null(),
}
}
}
impl MonitoredItemCreateRequest {
pub fn new(item_to_monitor: ReadValueId, monitoring_mode: MonitoringMode, requested_parameters: MonitoringParameters) -> MonitoredItemCreateRequest {
MonitoredItemCreateRequest {
item_to_monitor,
monitoring_mode,
requested_parameters,
}
}
}
impl ApplicationDescription {
pub fn null() -> ApplicationDescription {
ApplicationDescription {
application_uri: UAString::null(),
product_uri: UAString::null(),
application_name: LocalizedText::null(),
application_type: ApplicationType::Server,
gateway_server_uri: UAString::null(),
discovery_profile_uri: UAString::null(),
discovery_urls: None,
}
}
}
impl Default for MonitoringParameters {
fn default() -> Self {
MonitoringParameters {
client_handle: 0,
sampling_interval: -1f64,
filter: ExtensionObject::null(),
queue_size: 1,
discard_oldest: true,
}
}
}