rustdds 0.11.8

Native Rust DDS implementation with RTPS
Documentation 
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

use std::fmt;

use serde::{Deserialize, Serialize};
use speedy::{Readable, Writable};

use crate::{
  messages::submessages::submessage::{InterpreterSubmessage, ReaderSubmessage, WriterSubmessage},
  rtps::Submessage,
  security::types::DataHolder,
  structure::guid::GuidPrefix,
};

// Crypto related message class IDs for GenericMessageClassId:
// See section 7.4.4.5 of the security spec
pub const GMCLASSID_SECURITY_PARTICIPANT_CRYPTO_TOKENS: &str = "dds.sec.participant_crypto_tokens";
pub const GMCLASSID_SECURITY_DATAWRITER_CRYPTO_TOKENS: &str = "dds.sec.datawriter_crypto_tokens";
pub const GMCLASSID_SECURITY_DATAREADER_CRYPTO_TOKENS: &str = "dds.sec.datareader_crypto_tokens";

/// CryptoToken: sections 7.2.4.2 and 8.5.1.1 of the Security specification (v.
/// 1.1)
#[derive(Clone)]
pub struct CryptoToken {
  pub data_holder: DataHolder,
}
impl From<DataHolder> for CryptoToken {
  fn from(value: DataHolder) -> Self {
    CryptoToken { data_holder: value }
  }
}
pub type ParticipantCryptoToken = CryptoToken;
pub type DatawriterCryptoToken = CryptoToken;
pub type DatareaderCryptoToken = CryptoToken;

/// CryptoHandles are supposed to be opaque references to key material that can
/// only be interpreted inside the plugin implementation (8.5.1.2–4).
pub type CryptoHandle = u32;

/// ParticipantCryptoHandle: section 8.5.1.2 of the Security specification
/// (v. 1.1)
pub type ParticipantCryptoHandle = CryptoHandle;

pub type EndpointCryptoHandle = CryptoHandle;

/// DatawriterCryptoHandle: section 8.5.1.3 of the Security specification
/// (v. 1.1)
pub type DatawriterCryptoHandle = EndpointCryptoHandle;

/// DatareaderCryptoHandle: section 8.5.1.4 of the Security specification
/// (v. 1.1)
pub type DatareaderCryptoHandle = EndpointCryptoHandle;

/// CryptoTransformIdentifier: section 8.5.1.5 of the Security specification (v.
/// 1.1)
#[derive(Debug, PartialEq, Eq, Clone, Readable, Writable)]
pub struct CryptoTransformIdentifier {
  pub transformation_kind: CryptoTransformKind,
  pub transformation_key_id: CryptoTransformKeyId,
}
/// transformation_kind: section 8.5.1.5.1 of the Security specification (v.
/// 1.1)
pub type CryptoTransformKind = [u8; 4];
/// transformation_key_id: section 8.5.1.5.2 of the Security specification (v.
/// 1.1)
#[derive(Debug, Clone, Copy, Eq, PartialEq, Readable, Writable, Serialize, Deserialize, Hash)]
pub struct CryptoTransformKeyId([u8; 4]);

impl CryptoTransformKeyId {
  pub const ZERO: Self = CryptoTransformKeyId([0, 0, 0, 0]);

  pub fn is_zero(&self) -> bool {
    *self == Self::ZERO
  }

  pub fn random() -> Self {
    let random_array: [u8; 4] = rand::random();
    Self(random_array)
  }
}

impl From<[u8; 4]> for CryptoTransformKeyId {
  fn from(b: [u8; 4]) -> Self {
    Self(b)
  }
}

impl fmt::Display for CryptoTransformKeyId {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    write!(f, "{:02x?}", self.0)
  }
}

/// [super::cryptographic_plugin::CryptoTransform::encode_datawriter_submessage]
/// and [super::cryptographic_plugin::CryptoTransform::encode_datareader_submessage]
/// may return the unencoded input or an encoded message between a
/// `SecurePrefix` and `SecurePostfix`. See 7.3.6.4.4 and 8.5.1.9.2 in DDS
/// Security v1.1.
#[allow(clippy::large_enum_variant)]
pub enum EncodedSubmessage {
  Unencoded(Submessage),
  Encoded(Submessage, Submessage, Submessage),
}
// 2025-04-08: Latest clippy warns about too unequal variant sizes
// (large_enum_variant). TODO: Improve the situation by making submessage
// handling more pointer-based, e.g. use Box, Arc, or similar to reduce copying.

impl From<EncodedSubmessage> for Vec<Submessage> {
  fn from(value: EncodedSubmessage) -> Self {
    match value {
      EncodedSubmessage::Unencoded(submessage) => vec![submessage],
      EncodedSubmessage::Encoded(prefix, submessage, postfix) => vec![prefix, submessage, postfix],
    }
  }
}

/// Result of submessage decoding. Contains the decoded submessage body and a
/// list of endpoint crypto handles, the decode keys of which match the one used
/// for decoding, i.e. which are approved to receive the submessage by access
/// control.
pub enum DecodedSubmessage {
  // TODO: Should we support interpreter submessages here? The specification is unclear on this.
  // See 8.5.1.6
  Interpreter(InterpreterSubmessage),
  Writer(WriterSubmessage, Vec<EndpointCryptoHandle>),
  Reader(ReaderSubmessage, Vec<EndpointCryptoHandle>),
}

pub enum DecodeOutcome<T> {
  Success(T),
  /// It is normal to receive encoded communication that is meant for another
  /// participant, in which case the keys are missing and we cannot decode, but
  /// we cannot distinguish this case without searching through the available
  /// keys. In other words, not finding keys is not necessarily erroneous
  /// behavior, and such communication should just be ignored.
  KeysNotFound(CryptoTransformKeyId),
  /// It is normal to receive messages or submessages that are missing the
  /// required receiver-specific MAC due to multicasting.
  ValidatingReceiverSpecificMACFailed,
  /// It is normal to receive encoded messages from participants that have
  /// not been matched with.
  ParticipantCryptoHandleNotFound(GuidPrefix),
}