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

use axum::response::IntoResponse;
use http::StatusCode;

use crate::authorization::domain::action::Action;
use crate::authorization::domain::resource::ResourceIdentifier;
use crate::authorization::domain::resource::ResourceType;
use crate::user::domain::User;

/// Errors that can be experienced by a rendering (e.g. HTML) `axum` route
/// handler.
///
/// All rendering route handlers should return this error. All domain specific
/// errors should be marshalled into an [`RenderError`] to ensure consistent
/// HTTP responses.
///
/// > A [`RenderError`] is different to an
/// > [`ApiError`][`super::api_error::ApiError`] in that it responds with a user
/// > facing error (i.e. HTML).
#[derive(Debug, Clone, thiserror::Error)]
pub enum RenderError {
    #[error("unable to extract router state")]
    StateExtraction,

    #[error("unable to find resource: {resource_name}")]
    ResourceNotFound { resource_name: String },

    #[error("{} is not authorized to {} the {:?}: {:?}", user.name, action, resource_type, resource_identifier)]
    NotAuthorized {
        user: Box<User>,
        action: Action,
        resource_identifier: Option<ResourceIdentifier>,
        resource_type: ResourceType,
    },

    #[error("user is not authenticated")]
    NotAuthenticated,

    #[error("the server is not configured correctly: {message}")]
    ServerConfiguration { message: String },

    #[error("a generic server error: {message}")]
    ServerError { message: String },

    #[error("an error was experienced during authentication: {message}")]
    AuthenticationFlow { message: String },

    #[error("there is an issue with the the server infrastructure: {message}")]
    Infrastucture { message: String },
}

/// This should really be updated to redirect the user to an error page.
impl IntoResponse for RenderError {
    fn into_response(self) -> axum::response::Response {
        // Log the error.
        tracing::error!("{self}");

        // Generate a response to send to the client.
        match self {
            RenderError::StateExtraction
            | RenderError::ServerConfiguration { .. }
            | RenderError::ServerError { .. }
            | RenderError::Infrastucture { .. } => {
                (StatusCode::INTERNAL_SERVER_ERROR).into_response()
            }
            RenderError::ResourceNotFound { .. } => {
                (StatusCode::NOT_FOUND, self.to_string()).into_response()
            }
            RenderError::NotAuthorized { .. } => {
                (StatusCode::FORBIDDEN, self.to_string()).into_response()
            }
            RenderError::NotAuthenticated | RenderError::AuthenticationFlow { .. } => {
                (StatusCode::UNAUTHORIZED).into_response()
            }
        }
    }
}