ic-bn-lib 0.3.1

Internet Computer Boundary Nodes shared modules
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

use std::{str::FromStr, sync::Arc};

use candid::Principal;
use derive_new::new;
use fqdn::FQDN;

use super::models::{ApiError, ValidationStatus};
use crate::custom_domains::base::{
    traits::{repository::Repository, validation::ValidatesDomains},
    types::{
        domain::DomainStatus,
        task::{InputTask, TaskKind},
    },
};

/// Backend service that orchestrates domain validation, task submission, and registration status retrieval.
///
/// This service acts as the logical layer between user and the repository (data storage).
#[derive(Clone, new)]
pub struct BackendService {
    /// Repository for storing domain data (e.g. certificates) and tasks
    pub repository: Arc<dyn Repository>,
    /// Domain validator for DNS and canister ownership checks
    pub validator: Arc<dyn ValidatesDomains>,
}

impl BackendService {
    /// Validates domain configuration and submits a task for further processing.
    ///
    /// `wildcard` requests that the issued certificate also covers `*.domain`. It is
    /// only meaningful for `Issue`; other task kinds should pass `false`.
    pub async fn submit_task(
        &self,
        domain: &str,
        task: TaskKind,
        wildcard: bool,
    ) -> Result<Principal, ApiError> {
        let fqdn = parse_domain(domain)?;
        let canister_id = self.validator.validate(&fqdn).await?;
        let task = InputTask::new(task, fqdn, wildcard);

        match self.repository.try_add_task(task).await {
            Ok(()) => Ok(canister_id),
            Err(err) => Err(err.into()),
        }
    }

    /// Validates domain can be deleted and submits a delete task
    pub async fn submit_delete_task(&self, domain: &str) -> Result<(), ApiError> {
        let fqdn = parse_domain(domain)?;
        self.validator.validate_deletion(&fqdn).await?;
        let task = InputTask::new(TaskKind::Delete, fqdn, false);

        match self.repository.try_add_task(task).await {
            Ok(()) => Ok(()),
            Err(err) => Err(err.into()),
        }
    }

    /// Retrieves the current status of a domain registration
    pub async fn get_domain_status(&self, domain: &str) -> Result<DomainStatus, ApiError> {
        let fqdn = parse_domain(domain)?;

        match self.repository.get_domain_status(&fqdn).await {
            Ok(Some(entry)) => Ok(entry),
            Ok(None) => Err(ApiError::NotFound(format!("Domain {domain} not found"))),
            Err(_) => Err(ApiError::InternalServerError("".to_string())),
        }
    }

    /// Validates that the domain is eligible for registration without submitting a task
    pub async fn validate(&self, domain: &str) -> Result<(Principal, ValidationStatus), ApiError> {
        let fqdn = parse_domain(domain)?;

        match self.validator.validate(&fqdn).await {
            Ok(canister_id) => Ok((canister_id, ValidationStatus::Valid)),
            Err(err) => Err(ApiError::UnprocessableEntity(err.to_string())),
        }
    }
}

/// Parses a domain string into a validated FQDN
fn parse_domain(domain: &str) -> Result<FQDN, ApiError> {
    if domain.is_empty() {
        return Err(ApiError::BadRequest("Domain cannot be empty".to_string()));
    } else if domain.len() > 255 {
        return Err(ApiError::BadRequest("Domain is too long".to_string()));
    }

    FQDN::from_str(domain)
        .map_err(|e| ApiError::BadRequest(format!("Invalid domain format: {e:#}")))
}