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
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

use crate::{
  dds::qos::QosPolicies,
  discovery::{sedp_messages::TopicBuiltinTopicData, SpdpDiscoveredParticipantData},
  security::{authentication::*, *},
};
use super::*;

/// Access control plugin interface: section 8.4.2.9 of the Security
/// specification (v. 1.1).
///
/// To make use of Rust's features, the trait functions deviate a bit from the
/// specification. The main difference is that the functions return a Result
/// type. With this, there is no need to provide a pointer to a
/// SecurityException type which the function would fill in case of a failure.
/// Instead, the Err-variant of the result contains the error information. Also,
/// if a function has a single return value, it is returned inside the
/// Ok-variant. When a function returns a boolean according to the
/// specification, the Ok-variant is interpreted as true and Err-variant as
/// false.
///
/// We split the plugin interface to 3 parts according to the 5 groups described
/// in 8.8.3
pub trait AccessControl:
  ParticipantAccessControl + LocalEntityAccessControl + RemoteEntityAccessControl
{
}

/// Group1 in 8.8.3
pub trait ParticipantAccessControl: Send {
  /// validate_local_permissions: section 8.4.2.9.1 of the Security
  /// specification
  fn validate_local_permissions(
    &mut self,
    auth_plugin: &dyn Authentication,
    identity: IdentityHandle,
    domain_id: u16,
    participant_qos: &QosPolicies,
  ) -> SecurityResult<PermissionsHandle>;

  /// validate_remote_permissions: section 8.4.2.9.2 of the Security
  /// specification
  fn validate_remote_permissions(
    &mut self,
    auth_plugin: &dyn Authentication,
    local_identity_handle: IdentityHandle,
    remote_identity_handle: IdentityHandle,
    remote_permissions_token: &PermissionsToken,
    remote_credential_token: &AuthenticatedPeerCredentialToken,
  ) -> SecurityResult<PermissionsHandle>;

  /// check_create_participant: section 8.4.2.9.3 of the Security
  /// specification
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  fn check_create_participant(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    qos: &QosPolicies,
  ) -> SecurityResult<bool>;

  /// check_remote_participant: section 8.4.2.9.9 of the Security
  /// specification.
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  fn check_remote_participant(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    participant_data: Option<&SpdpDiscoveredParticipantData>,
  ) -> SecurityResult<bool>;

  /// get_permissions_token: section 8.4.2.9.17 of the Security
  /// specification.
  fn get_permissions_token(&self, handle: PermissionsHandle) -> SecurityResult<PermissionsToken>;

  /// get_permissions_credential_token: section 8.4.2.9.18 of the Security
  /// specification.
  fn get_permissions_credential_token(
    &self,
    handle: PermissionsHandle,
  ) -> SecurityResult<PermissionsCredentialToken>;

  /// set_listener: section 8.4.2.9.19 of the Security
  /// specification.
  /// TODO: we do not need this as listeners are not used in RustDDS, but which
  /// async mechanism to use?
  fn set_listener(&self) -> SecurityResult<()>;

  /// get_participant_sec_attributes: section 8.4.2.9.22 of the Security
  /// specification.
  fn get_participant_sec_attributes(
    &self,
    permissions_handle: PermissionsHandle,
  ) -> SecurityResult<ParticipantSecurityAttributes>;
}

/// Group2 and Group3 in 8.8.3
pub trait LocalEntityAccessControl: Send {
  /// check_create_datawriter: section 8.4.2.9.4 of the Security
  /// specification. The parameters partition and data_tag have been left out,
  /// since RustDDS does not yet support PartitionQoS or data tagging
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  fn check_create_datawriter(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    topic_name: String,
    qos: &QosPolicies,
  ) -> SecurityResult<bool>;

  /// check_create_datareader: section 8.4.2.9.5 of the Security
  /// specification. The parameters partition and data_tag have been left out,
  /// since RustDDS does not yet support PartitionQoS or data tagging
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  fn check_create_datareader(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    topic_name: String,
    qos: &QosPolicies,
  ) -> SecurityResult<bool>;

  /// check_create_topic: section 8.4.2.9.6 of the Security
  /// specification
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  fn check_create_topic(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    topic_name: String,
    qos: &QosPolicies,
  ) -> SecurityResult<bool>;

  /*
  /// check_local_datawriter_register_instance: section 8.4.2.9.7 of the
  /// Security specification.
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  // Support for this is not yet implemented as the builtin plugin does not need it
  fn check_local_datawriter_register_instance(
    &self,
    permissions_handle: PermissionsHandle,
    writer: DataWriter,// Needs actual type definition
    key: DynamicData,// Needs actual type definition
  ) -> SecurityResult<bool>;
  */

  /*
  /// check_local_datawriter_register_instance: section 8.4.2.9.8 of the
  /// Security specification.
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  // Support for this is not yet implemented as the builtin plugin does not need it
  fn check_local_datawriter_dispose_instance(
    &self,
    permissions_handle: PermissionsHandle,
    writer: DataWriter,// Needs actual type definition
    key: DynamicData,// Needs actual type definition
  ) -> SecurityResult<bool>;
  */

  /// get_topic_sec_attributes: section 8.4.2.9.23 of the Security
  /// specification.
  fn get_topic_sec_attributes(
    &self,
    permissions_handle: PermissionsHandle,
    topic_name: &str,
  ) -> SecurityResult<TopicSecurityAttributes>;

  /// get_datawriter_sec_attributes: section 8.4.2.9.24 of the Security
  /// specification.
  /// The parameters partition and data_tag have been left out,
  /// since RustDDS does not yet support PartitionQoS or data tagging
  fn get_datawriter_sec_attributes(
    &self,
    permissions_handle: PermissionsHandle,
    topic_name: String,
  ) -> SecurityResult<EndpointSecurityAttributes>;

  /// get_datareader_sec_attributes: section 8.4.2.9.25 of the Security
  /// specification.
  /// The parameters partition and data_tag have been left out,
  /// since RustDDS does not yet support PartitionQoS or data tagging
  fn get_datareader_sec_attributes(
    &self,
    permissions_handle: PermissionsHandle,
    topic_name: String,
  ) -> SecurityResult<EndpointSecurityAttributes>;
}

/// Group4 and Group5 in 8.8.3
pub trait RemoteEntityAccessControl: Send {
  /// check_remote_datawriter: section 8.4.2.9.10 of the Security
  /// specification.
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  fn check_remote_datawriter(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    publication_data: &PublicationBuiltinTopicDataSecure,
  ) -> SecurityResult<bool>;

  /// check_remote_datareader: section 8.4.2.9.11 of the Security
  /// specification.
  /// In the returned Ok-variant, the first boolean tells if the remote
  /// DataReader passed the permission check. The second boolean is the
  /// relay_only value (see the spec)
  fn check_remote_datareader(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    subscription_data: &SubscriptionBuiltinTopicDataSecure,
  ) -> SecurityResult<(bool, bool)>;

  /// check_remote_topic: section 8.4.2.9.12 of the Security
  /// specification.
  /// In the returned Ok-variant, the boolean tells if the participant passed
  /// the permission check.
  fn check_remote_topic(
    &self,
    permissions_handle: PermissionsHandle,
    domain_id: u16,
    topic_data: &TopicBuiltinTopicData,
  ) -> SecurityResult<bool>;

  /*
  /// check_local_datawriter_match: section 8.4.2.9.13 of the Security
  /// specification.
  // Support for this is not yet implemented as the builtin plugin does not need it
  fn check_local_datawriter_match(
    &self,
    writer_permissions_handle: PermissionsHandle,
    reader_permissions_handle: PermissionsHandle,
    publication_data: &PublicationBuiltinTopicDataSecure,
    subscription_data: &SubscriptionBuiltinTopicDataSecure,
  ) -> SecurityResult<()>;
  */

  /*
   /// check_local_datareader_match: section 8.4.2.9.14 of the Security
   /// specification.
   /// The parameter subscriber_partition is omitted since RustDDS does not yet
   /// support PartitionQoS.
   // Support for this is not yet implemented as the builtin plugin does not need it
   fn check_local_datareader_match(
     &self,
     reader_permissions_handle: PermissionsHandle,
     writer_permissions_handle: PermissionsHandle,
     subscription_data: &SubscriptionBuiltinTopicDataSecure,
     publication_data: &PublicationBuiltinTopicDataSecure,
   ) -> SecurityResult<()>;
  */

  /*
  /// check_remote_datawriter_register_instance: section 8.4.2.9.15 of the
  /// Security specification.
  // Support for this is not yet implemented as the builtin plugin does not need
  // it
  fn check_remote_datawriter_register_instance(
    &self,
    permissions_handle: PermissionsHandle,
    reader: DataReader,                   // Needs actual type definition
    publication_handle: InstanceHandle_t, // Needs actual type definition
    key: DynamicData,                     // Needs actual type definition
    instance_handle: InstanceHandle_t,    // Needs actual type definition
  ) -> SecurityResult<()>;
  */

  /*
  /// check_remote_datawriter_dispose_instance: section 8.4.2.9.16 of the
  /// Security specification.
  // Support for this is not yet implemented as the builtin plugin does not need
  // it
  fn check_remote_datawriter_dispose_instance(
    &self,
    permissions_handle: PermissionsHandle,
    reader: DataReader,                   // Needs actual type definition
    publication_handle: InstanceHandle_t, // Needs actual type definition
    key: DynamicData,                     // Needs actual type definition
  ) -> SecurityResult<()>;
  */
}

// TODO: Can the different return methods (e.g. return_permissions_token) be
// left out, since Rust manages memory for us?