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

use std::path::PathBuf;

use url::Url;

/// The configuration required to run the application.
#[derive(Debug, Clone)]
pub struct PotreeAuthConfiguration {
    /// The parent directory to all the projects being served.
    pub data_dir: PathBuf,

    /// Populated to use an IdP for authentication.
    pub idp: Option<IdpConfiguration>,
}

/// The configuration required to use an OIDC IdP for authentication.
#[derive(Debug, Clone)]
pub struct IdpConfiguration {
    /// The URL to the IdP service.
    pub idp_url: Url,

    /// The `id` of the `potree-auth` application on the IdP.
    pub client_id: String,

    /// The Authorization Code Flow client secret shared between the IdP and the
    /// application.
    pub client_secret: String,

    /// The name of the OIDC claim containing and array of groups that a user is
    /// part of.
    pub groups_claim: String,

    /// The URL on which the application is publicly accessible (the OIDC
    /// callback URL is calculated from this).
    pub external_url: Url,
}