potree-auth 0.1.0

Authentication and project management for `potree` point clouds.
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

use std::fmt::Debug;

use crate::common::domain::Group;
use crate::common::domain::utils::new_type::new_type;
use crate::user::domain::EmailAddress;

/// Defines a resource type that can be authorized against.
pub trait Resource: Debug {
    fn resource_type(&self) -> ResourceType;
}

/// Defines the functionality required for fine grained access to a particular
/// resource (instance-level authZ).
pub trait ResourceInstance: Resource {
    /// Identifies the specific resource instance.
    fn resource_identifier(&self) -> ResourceIdentifier;

    /// The groups that the resource belongs to. Some resource types won't be
    /// associated with groups, in this case this should return None. Currently,
    /// if a user is part of the same group they are allowed do action the
    /// resource.
    fn groups(&self) -> Option<Vec<Group>>;

    ///The email addresses of the users that have access to the resource. Some
    /// resource types won't be associated with users, in this case this
    /// should return None.
    fn user_emails(&self) -> Option<Vec<EmailAddress>>;
}

new_type![
    /// The identifier of a resource type (type-level). E.g. a "user", a "group",
    /// a "file", etc.
    ResourceType(String)
];

new_type![
    /// The identifier of a specific resource instance (instance-level). E.g. a
    /// user id, a group id, a file id, etc.
    ResourceIdentifier(String)
];

/// A super basic struct implementing the [`Resource`] and [`ResourceInstance`]
/// traits for testing purposes.
///
/// I was struggling to get mockall to deal with the supertrait mocking.
#[cfg(any(test, feature = "mock"))]
pub mod mocked_resource {
    use super::EmailAddress;
    use super::Group;
    use super::Resource;
    use super::ResourceIdentifier;
    use super::ResourceInstance;
    use super::ResourceType;

    #[derive(Debug, fake::Dummy)]
    pub struct MockedResource {
        pub resource_type: ResourceType,
        pub resource_identifier: ResourceIdentifier,
        pub groups: Option<Vec<Group>>,
        pub user_emails: Option<Vec<EmailAddress>>,
    }

    impl Resource for MockedResource {
        fn resource_type(&self) -> ResourceType {
            self.resource_type.clone()
        }
    }

    impl ResourceInstance for MockedResource {
        fn resource_identifier(&self) -> ResourceIdentifier {
            self.resource_identifier.clone()
        }

        fn groups(&self) -> Option<Vec<Group>> {
            self.groups.clone()
        }

        fn user_emails(&self) -> Option<Vec<EmailAddress>> {
            self.user_emails.clone()
        }
    }
}