authly_client/
access_control.rs

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
//! Access control functionality.

use std::sync::Arc;

use authly_common::{
    id::{Eid, ObjId},
    proto::service::{self as proto, authly_service_client::AuthlyServiceClient},
    service::PropertyMapping,
};
use fnv::FnvHashSet;
use http::header::AUTHORIZATION;
use tonic::{transport::Channel, Request};

use crate::{error, id_codec_error, token::AccessToken, Client, Error};

/// A builder for making an access control request.
///
// TODO: Include peer service(s) in the access control request.
// For that to work locally, there are two options:
// 1. The service verifies each incoming peer with a call to authly, to retrieve entity attributes.
// 2. The service is conscious about its mesh, and is allowed to keep an in-memory map of incoming service entity attributes.
pub struct AccessControlRequestBuilder<'c> {
    client: &'c Client,
    property_mapping: Arc<PropertyMapping>,
    access_token: Option<Arc<AccessToken>>,
    resource_attributes: FnvHashSet<ObjId>,
    peer_entity_ids: FnvHashSet<Eid>,
}

impl<'c> AccessControlRequestBuilder<'c> {
    pub(crate) fn new(client: &'c Client) -> Self {
        Self {
            client,
            property_mapping: client.state.resource_property_mapping.load_full(),
            access_token: None,
            resource_attributes: Default::default(),
            peer_entity_ids: Default::default(),
        }
    }

    /// Define a labelled resource attribute to be included in the access control request.
    ///
    /// The property and attribute labels should be available to this service through authly document manifests.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use authly_client::*;
    /// # async fn test() -> anyhow::Result<()> {
    /// // note: Client is not properly built here.
    /// let client = Client::builder().connect().await?;
    ///
    /// client.access_control_request()
    ///     .resource_attribute("type", "orders")?
    ///     .resource_attribute("action", "read")?
    ///     .send()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    pub fn resource_attribute(
        mut self,
        property_label: &str,
        attribute_label: &str,
    ) -> Result<Self, Error> {
        let obj_id = self
            .property_mapping
            .attribute_object_id(property_label, attribute_label)
            .ok_or(Error::InvalidPropertyAttributeLabel)?;

        self.resource_attributes.insert(obj_id);
        Ok(self)
    }

    /// Include an access token in the request.
    ///
    /// The access token is used as subject properties in the access control request.
    pub fn access_token(mut self, token: Arc<AccessToken>) -> Self {
        self.access_token = Some(token);
        self
    }

    /// Add a peer entity ID, which represents a client acting as a subject in the access control request.
    pub fn peer_entity_id(mut self, entity_id: Eid) -> Self {
        self.peer_entity_ids.insert(entity_id);
        self
    }

    /// Send the access control request to the remote Authly service for evaluation.
    ///
    /// The return value represents whether access was granted.
    pub async fn send(self) -> Result<bool, Error> {
        let mut request = Request::new(proto::AccessControlRequest {
            resource_attributes: self
                .resource_attributes
                .into_iter()
                .map(|attr| attr.to_bytes().to_vec())
                .collect(),
            // Peer entity attributes are currently not known to the service:
            peer_entity_attributes: vec![],
            peer_entity_ids: self
                .peer_entity_ids
                .into_iter()
                .map(|eid| eid.to_bytes().to_vec())
                .collect(),
        });
        if let Some(access_token) = self.access_token {
            request.metadata_mut().append(
                AUTHORIZATION.as_str(),
                format!("Bearer {}", access_token.token)
                    .parse()
                    .map_err(error::unclassified)?,
            );
        }

        let access_control_response = self
            .client
            .current_service()
            .access_control(request)
            .await
            .map_err(error::tonic)?
            .into_inner();

        Ok(access_control_response.outcome > 0)
    }
}

pub(crate) async fn get_resource_property_mapping(
    mut service: AuthlyServiceClient<Channel>,
) -> Result<Arc<PropertyMapping>, Error> {
    let response = service
        .get_resource_property_mappings(proto::Empty::default())
        .await
        .map_err(error::tonic)?;

    let mut property_mapping = PropertyMapping::default();

    for property in response.into_inner().properties {
        for attribute in property.attributes {
            property_mapping.add(
                property.label.clone(),
                attribute.label,
                ObjId::from_bytes(&attribute.obj_id).ok_or_else(id_codec_error)?,
            );
        }
    }

    Ok(Arc::new(property_mapping))
}