treetop-client 0.0.1

Typed async Rust client for Treetop policy authorization servers
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

//! Action type for Cedar authorization requests.

use serde::{Deserialize, Serialize};

use super::validation::{EntityId, Namespace, ValidationError};

/// A Cedar action identifier with optional namespace.
///
/// Represents the action being performed in an authorization request
/// (e.g. `"view"`, `"delete"`, `"create_host"`).
///
/// # Wire format
/// ```json
/// { "id": "view", "namespace": ["Admin"] }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub struct Action {
    /// The action identifier (e.g. `"view"`, `"delete"`).
    id: EntityId,
    /// Optional Cedar namespace path (e.g. `["Admin", "Core"]`).
    #[serde(default)]
    namespace: Namespace,
}

impl Action {
    /// Creates a new action with no namespace.
    pub fn new(id: impl Into<String>) -> Self {
        Self {
            id: EntityId::new(id),
            namespace: Namespace::default(),
        }
    }

    /// Creates and validates a new action with no namespace.
    pub fn try_new(id: impl Into<String>) -> Result<Self, ValidationError> {
        let action = Self::new(id);
        action.validate()?;
        Ok(action)
    }

    /// Sets the Cedar namespace for this action.
    pub fn with_namespace(mut self, namespace: Vec<String>) -> Self {
        self.namespace = Namespace::new(namespace);
        self
    }

    /// Sets and validates the Cedar namespace for this action.
    pub fn try_with_namespace(self, namespace: Vec<String>) -> Result<Self, ValidationError> {
        let action = self.with_namespace(namespace);
        action.validate()?;
        Ok(action)
    }

    /// Returns the action entity identifier.
    pub fn id(&self) -> &str {
        self.id.as_str()
    }

    /// Returns the Cedar namespace path.
    pub fn namespace(&self) -> &[String] {
        self.namespace.as_slice()
    }

    /// Validates this action against Cedar and Treetop request invariants.
    pub fn validate(&self) -> Result<(), ValidationError> {
        self.id.validate("action.id")?;
        self.namespace.validate("action.namespace")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn action_serialization() {
        let action = Action::new("create");
        let json = serde_json::to_value(&action).unwrap();
        assert_eq!(json["id"], "create");
        assert_eq!(json["namespace"], serde_json::json!([]));
    }

    #[test]
    fn action_with_namespace() {
        let action = Action::new("delete").with_namespace(vec!["Admin".to_string()]);
        let json = serde_json::to_value(&action).unwrap();
        assert_eq!(json["namespace"], serde_json::json!(["Admin"]));
    }

    #[test]
    fn action_roundtrip() {
        let action =
            Action::new("view").with_namespace(vec!["App".to_string(), "Core".to_string()]);
        let json = serde_json::to_value(&action).unwrap();
        let deserialized: Action = serde_json::from_value(json).unwrap();
        assert_eq!(action, deserialized);
    }
}