ockam_api 0.93.0

Ockam's request-response API
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
use std::time::Duration;

use crate::nodes::models::secure_channel::CreateSecureChannelRequest;
use crate::nodes::models::secure_channel::DeleteSecureChannelListenerRequest;
use crate::nodes::models::secure_channel::DeleteSecureChannelRequest;
use crate::nodes::models::secure_channel::ShowSecureChannelListenerRequest;
use crate::nodes::models::secure_channel::ShowSecureChannelRequest;
use crate::nodes::models::secure_channel::{CreateSecureChannelListenerRequest, SecureChannelList};
use crate::nodes::models::secure_channel::{
    CreateSecureChannelResponse, DeleteSecureChannelListenerResponse, DeleteSecureChannelResponse,
    ShowSecureChannelResponse,
};
use crate::nodes::registry::SecureChannelInfo;
use crate::nodes::service::default_address::DefaultAddress;
use crate::nodes::{NodeManager, NodeManagerWorker};
use ockam::identity::models::CredentialAndPurposeKey;
use ockam::identity::{
    Identifier, Identities, SecureChannelListenerOptions, SecureChannelOptions, SecureChannels,
    TrustMultiIdentifiersPolicy,
};
use ockam::identity::{SecureChannel, SecureChannelListener};
use ockam::identity::{SecureChannelListenerList, Vault};
use ockam::identity::{SecureChannelSqlxDatabase, TrustEveryonePolicy};
use ockam::{Address, Result, Route};
use ockam_core::api::{Error, Response};
use ockam_core::compat::sync::Arc;
use ockam_core::errcode::{Kind, Origin};
use ockam_multiaddr::MultiAddr;
use ockam_node::Context;

#[derive(PartialOrd, PartialEq, Debug)]
pub enum SecureChannelType {
    KeyExchangeAndMessages,
    KeyExchangeOnly,
}

/// SECURE CHANNELS
impl NodeManagerWorker {
    pub fn list_secure_channels(&self) -> Result<Response<SecureChannelList>, Response<Error>> {
        Ok(Response::ok().body(SecureChannelList(self.node_manager.list_secure_channels())))
    }

    pub(super) async fn create_secure_channel(
        &mut self,
        create_secure_channel: CreateSecureChannelRequest,
        ctx: &Context,
    ) -> Result<Response<CreateSecureChannelResponse>, Response<Error>> {
        let CreateSecureChannelRequest {
            addr,
            authorized_identifiers,
            timeout,
            identity_name: identity,
            credential,
            ..
        } = create_secure_channel;

        let response = self
            .node_manager
            .create_secure_channel(
                ctx,
                addr,
                identity,
                authorized_identifiers,
                credential,
                timeout,
                SecureChannelType::KeyExchangeAndMessages,
            )
            .await
            .map(|secure_channel| {
                Response::ok().body(CreateSecureChannelResponse::new(secure_channel))
            })?;
        Ok(response)
    }

    pub fn delete_secure_channel(
        &self,
        delete_secure_channel: DeleteSecureChannelRequest,
        ctx: &Context,
    ) -> Result<Response<DeleteSecureChannelResponse>, Response<Error>> {
        let DeleteSecureChannelRequest {
            channel: address, ..
        } = delete_secure_channel;

        let response = self
            .node_manager
            .delete_secure_channel(ctx, &address)
            .map(|_| Response::ok().body(DeleteSecureChannelResponse::new(Some(address))))?;
        Ok(response)
    }

    pub async fn show_secure_channel(
        &self,
        show_secure_channel: ShowSecureChannelRequest,
    ) -> Result<Response<ShowSecureChannelResponse>, Response<Error>> {
        let ShowSecureChannelRequest { channel: address } = show_secure_channel;
        let secure_channel = self.node_manager.get_secure_channel(&address)?;
        let change_history = self
            .node_manager
            .secure_channels()
            .identities()
            .get_change_history(secure_channel.sc().their_identifier())
            .await?;
        let res = ShowSecureChannelResponse::new(secure_channel)?
            .with_their_change_history(change_history)?;
        Ok(Response::ok().body(res))
    }
}

/// SECURE CHANNEL LISTENERS
impl NodeManagerWorker {
    pub async fn create_secure_channel_listener(
        &self,
        create_secure_channel_listener: CreateSecureChannelListenerRequest,
        ctx: &Context,
    ) -> Result<Response<()>, Response<Error>> {
        let CreateSecureChannelListenerRequest {
            addr,
            authorized_identifiers,
            identity_name,
            ..
        } = create_secure_channel_listener;

        let response = self
            .node_manager
            .create_secure_channel_listener(
                addr,
                authorized_identifiers,
                identity_name,
                ctx,
                SecureChannelType::KeyExchangeAndMessages,
            )
            .await
            .map(|_| Response::ok())?;
        Ok(response)
    }

    pub fn delete_secure_channel_listener(
        &self,
        delete_secure_channel_listener: DeleteSecureChannelListenerRequest,
        ctx: &Context,
    ) -> Result<Response<DeleteSecureChannelListenerResponse>, Response<Error>> {
        let DeleteSecureChannelListenerRequest { addr } = delete_secure_channel_listener;

        let response = self
            .node_manager
            .delete_secure_channel_listener(ctx, &addr)
            .map(|_| Response::ok().body(DeleteSecureChannelListenerResponse::new(addr)))?;
        Ok(response)
    }

    pub fn show_secure_channel_listener(
        &self,
        show_secure_channel_listener: ShowSecureChannelListenerRequest,
    ) -> Result<Response<SecureChannelListener>, Response<Error>> {
        let ShowSecureChannelListenerRequest { addr } = show_secure_channel_listener;
        Ok(Response::ok().body(self.node_manager.get_secure_channel_listener(&addr)?))
    }

    pub fn list_secure_channel_listener(
        &self,
    ) -> Result<Response<SecureChannelListenerList>, Response<Error>> {
        Ok(Response::ok().body(SecureChannelListenerList(
            self.node_manager.list_secure_channel_listeners(),
        )))
    }
}

/// SECURE CHANNELS
impl NodeManager {
    #[allow(clippy::too_many_arguments)]
    pub async fn create_secure_channel(
        &self,
        ctx: &Context,
        addr: MultiAddr,
        identity_name: Option<String>,
        authorized_identifiers: Option<Vec<Identifier>>,
        credential: Option<CredentialAndPurposeKey>,
        timeout: Option<Duration>,
        secure_channel_type: SecureChannelType,
    ) -> Result<SecureChannel> {
        let identifier = self.get_identifier_by_name(identity_name.clone()).await?;

        let connection = self
            .make_connection(ctx, &addr, identifier.clone(), None, timeout)
            .await?;
        let sc = self
            .create_secure_channel_internal(
                ctx,
                connection.route()?,
                &identifier,
                authorized_identifiers,
                credential,
                timeout,
                secure_channel_type,
            )
            .await?;

        // Return secure channel
        Ok(sc)
    }

    #[allow(clippy::too_many_arguments)]
    pub(crate) async fn create_secure_channel_internal(
        &self,
        ctx: &Context,
        sc_route: Route,
        identifier: &Identifier,
        authorized_identifiers: Option<Vec<Identifier>>,
        credential: Option<CredentialAndPurposeKey>,
        timeout: Option<Duration>,
        secure_channel_type: SecureChannelType,
    ) -> Result<SecureChannel> {
        debug!(route = %sc_route, %identifier, "initiating secure channel");
        let options = SecureChannelOptions::new();

        let options = if let Some(timeout) = timeout {
            options.with_timeout(timeout)
        } else {
            options
        };

        let options = match self.project_authority() {
            Some(project_authority) => options.with_authority(project_authority),
            None => options,
        };

        let options = if let Some(credential) = credential.as_ref() {
            options.with_credential(credential.clone())?
        } else {
            match self.credential_retriever_creators.project_member.as_ref() {
                None => options,
                Some(credential_retriever_creator) => options
                    .with_credential_retriever_creator(credential_retriever_creator.clone())?,
            }
        };

        let options = match authorized_identifiers.clone() {
            Some(ids) => options.with_trust_policy(TrustMultiIdentifiersPolicy::new(ids)),
            None => options.with_trust_policy(TrustEveryonePolicy),
        };

        let options = if secure_channel_type == SecureChannelType::KeyExchangeOnly {
            // TODO: Should key exchange channels be persisted automatically?
            options.key_exchange_only().persist()?
        } else {
            options
        };

        let sc = self
            .secure_channels
            .create_secure_channel(ctx, identifier, sc_route.clone(), options)
            .await?;

        info!(route = %sc_route, %identifier, "secure channel initiated");

        self.registry
            .secure_channels
            .insert(sc_route, sc.clone(), authorized_identifiers);

        Ok(sc)
    }

    pub fn delete_secure_channel(&self, ctx: &Context, addr: &Address) -> Result<()> {
        debug!(%addr, "deleting secure channel");
        if self.registry.secure_channels.get_by_addr(addr).is_none() {
            return Err(ockam_core::Error::new(
                Origin::Api,
                Kind::NotFound,
                format!("Secure channel with address, {}, not found", addr),
            ));
        }
        self.secure_channels.stop_secure_channel(ctx, addr)?;
        self.registry.secure_channels.remove_by_addr(addr);
        Ok(())
    }

    pub fn get_secure_channel(&self, addr: &Address) -> Result<SecureChannelInfo> {
        debug!(%addr, "On show secure channel");
        self.registry
            .secure_channels
            .get_by_addr(addr)
            .ok_or_else(|| {
                ockam_core::Error::new(
                    Origin::Api,
                    Kind::NotFound,
                    format!("Secure channel with address, {}, not found", addr),
                )
            })
    }

    pub fn list_secure_channels(&self) -> Vec<Address> {
        let registry = &self.registry.secure_channels;
        let secure_channel_list = registry.list();
        secure_channel_list
            .into_iter()
            .map(|secure_channel| secure_channel.sc().encryptor_address().clone())
            .collect()
    }
}

/// SECURE CHANNEL LISTENERS
impl NodeManager {
    pub(super) async fn start_key_exchanger_service(
        &self,
        context: &Context,
        address: Address,
    ) -> Result<SecureChannelListener> {
        // skip creation if it already exists
        if let Some(listener) = self.registry.secure_channel_listeners.get(&address) {
            return Ok(listener);
        }

        self.create_secure_channel_listener(
            address.clone(),
            None,
            None,
            context,
            SecureChannelType::KeyExchangeOnly,
        )
        .await
    }

    pub async fn create_secure_channel_listener(
        &self,
        address: Address,
        authorized_identifiers: Option<Vec<Identifier>>,
        identity_name: Option<String>,
        ctx: &Context,
        secure_channel_type: SecureChannelType,
    ) -> Result<SecureChannelListener> {
        debug!(
            "Handling request to create a new secure channel listener: {}",
            address
        );

        let named_identity = match identity_name {
            Some(identity_name) => self.cli_state.get_named_identity(&identity_name).await?,
            None => {
                self.cli_state
                    .get_named_identity_by_identifier(&self.identifier())
                    .await?
            }
        };
        let identifier = named_identity.identifier();
        let named_vault = self
            .cli_state
            .get_named_vault(&named_identity.vault_name())
            .await?;
        let vault = self.cli_state.make_vault(named_vault).await?;
        let secure_channels = self.build_secure_channels(vault).await?;

        let mut options = SecureChannelListenerOptions::new();

        for api_flow_control_id in &self.api_transport_flow_control_ids {
            options = options.as_consumer(api_flow_control_id);
        }

        let options = match authorized_identifiers {
            Some(ids) => options.with_trust_policy(TrustMultiIdentifiersPolicy::new(ids)),
            None => options.with_trust_policy(TrustEveryonePolicy),
        };

        let options = match self.project_authority() {
            Some(project_authority) => options.with_authority(project_authority),
            None => options,
        };

        let options = match self.credential_retriever_creators.project_member.as_ref() {
            None => options,
            Some(credential_retriever_creator) => {
                options.with_credential_retriever_creator(credential_retriever_creator.clone())?
            }
        };

        let options = if secure_channel_type == SecureChannelType::KeyExchangeOnly {
            // TODO: Should key exchange channels be persisted automatically?
            options.key_exchange_only().persist()?
        } else {
            options
        };

        let listener = secure_channels.create_secure_channel_listener(
            ctx,
            &identifier,
            address.clone(),
            options,
        )?;

        info!("Secure channel listener was initialized at {address}");

        self.registry
            .secure_channel_listeners
            .insert(address.clone(), listener.clone());

        if secure_channel_type == SecureChannelType::KeyExchangeAndMessages {
            // TODO: Clean
            // Add Echoer as a consumer by default
            ctx.flow_controls().add_consumer(
                &DefaultAddress::ECHO_SERVICE.into(),
                listener.flow_control_id(),
            );

            // TODO: PUNCTURE Make optional?
            ctx.flow_controls().add_consumer(
                &DefaultAddress::UDP_PUNCTURE_NEGOTIATION_LISTENER.into(),
                listener.flow_control_id(),
            );

            // Add ourselves to allow tunneling
            ctx.flow_controls()
                .add_consumer(&address, listener.flow_control_id());

            ctx.flow_controls().add_consumer(
                &DefaultAddress::UPPERCASE_SERVICE.into(),
                listener.flow_control_id(),
            );
        }

        Ok(listener)
    }

    pub fn delete_secure_channel_listener(
        &self,
        ctx: &Context,
        addr: &Address,
    ) -> Result<SecureChannelListener> {
        debug!("deleting secure channel listener: {addr}");
        ctx.stop_address(addr)?;
        self.registry
            .secure_channel_listeners
            .remove(addr)
            .ok_or_else(|| {
                ockam_core::Error::new(
                    Origin::Api,
                    Kind::Internal,
                    format!("Error while deleting secure channel with addrress {}", addr,),
                )
            })
    }

    pub fn get_secure_channel_listener(&self, addr: &Address) -> Result<SecureChannelListener> {
        debug!(%addr, "On show secure channel listener");
        self.registry
            .secure_channel_listeners
            .get(addr)
            .ok_or_else(|| {
                ockam_core::Error::new(
                    Origin::Api,
                    Kind::NotFound,
                    format!("Secure channel with address, {}, not found", addr),
                )
            })
    }

    pub fn list_secure_channel_listeners(&self) -> Vec<SecureChannelListener> {
        self.registry.secure_channel_listeners.values()
    }
}

impl NodeManager {
    /// Build a SecureChannels struct for a specific vault
    pub(crate) async fn build_secure_channels(&self, vault: Vault) -> Result<Arc<SecureChannels>> {
        let identities = Identities::create_with_node(self.cli_state.database(), &self.node_name)
            .with_vault(vault)
            .build();
        Ok(Arc::new(SecureChannels::new(
            identities,
            self.secure_channels.secure_channel_registry(),
            SecureChannelSqlxDatabase::make_repository(self.cli_state.database()),
        )))
    }
}