krill 0.16.0

Resource Public Key Infrastructure (RPKI) daemon
Documentation
//! Manage the publication server.

use std::{error, fmt, io};
use std::fs::File;
use std::io::BufReader;
use std::str::FromStr;
use rpki::uri;
use rpki::ca::idexchange;
use crate::cli::client::KrillClient;
use crate::cli::report::Report;
use crate::api;
use crate::commons::httpclient;


//------------ PubserverCommand ----------------------------------------------

#[derive(clap::Subcommand)]
pub enum Command {
    /// Manage the publishers of the publication server
    #[command(subcommand)]
    Publishers(Publishers),

    /// Delete specific files from the publication server
    Delete(DeleteFiles),

    /// Manage the publication server
    #[command(subcommand)]
    Server(ServerCommand),
}

impl Command {
    pub async fn run(self, client: &KrillClient) -> Report {
        match self {
            Self::Publishers(cmd) => cmd.run(client).await,
            Self::Delete(cmd) => cmd.run(client).await.into(),
            Self::Server(cmd) => cmd.run(client).await,
        }
    }
}


//------------ Publishers ----------------------------------------------------

#[derive(clap::Subcommand)]
pub enum Publishers {
    /// List all publishers
    List(List),

    /// List all publishers which have not published in a while
    Stale(Stale),

    /// Add a publisher
    Add(Add),

    /// Show RFC 8183 Repository Response XML
    Response(Response),

    /// Show details for a publisher
    Show(Show),

    /// Remove a publisher
    Remove(Remove),
}

impl Publishers {
    async fn run(self, client: &KrillClient) -> Report {
        match self {
            Self::List(cmd) => cmd.run(client).await.into(),
            Self::Stale(cmd) => cmd.run(client).await.into(),
            Self::Add(cmd) => cmd.run(client).await.into(),
            Self::Response(cmd) => cmd.run(client).await.into(),
            Self::Show(cmd) => cmd.run(client).await.into(),
            Self::Remove(cmd) => cmd.run(client).await.into(),
        }
    }
}


//------------ List ----------------------------------------------------------

#[derive(clap::Parser)]
pub struct List;

impl List {
    pub async fn run(
        self, client: &KrillClient
    ) -> Result<api::admin::PublisherList, httpclient::Error> {
        client.publishers_list().await
    }
}


//------------ Stale --------------------------------------------------------

#[derive(clap::Parser)]
pub struct Stale {
    /// Number of seconds since last publication
    #[arg(long)]
    seconds: u64,
}

impl Stale {
    pub async fn run(
        self, client: &KrillClient
    ) -> Result<api::admin::PublisherList, httpclient::Error> {
        client.publishers_stale(self.seconds).await
    }
}


//------------ Add -----------------------------------------------------------

#[derive(clap::Parser)]
pub struct Add {
    /// Path to the RFC 8183 Publisher Request XML file
    #[arg(long, value_name = "path")]
    request: PublisherRequestFile,

    /// Override the publisher handle in the XML
    #[arg(long, short, value_name = "handle")]
    publisher: Option<idexchange::PublisherHandle>,
}

impl Add {
    async fn run(
        mut self, client: &KrillClient
    ) -> Result<idexchange::RepositoryResponse, httpclient::Error> {
        if let Some(handle) = self.publisher {
            self.request.0.set_publisher_handle(handle)
        }
        client.publishers_add(self.request.0).await
    }
}


//------------ PublisherHandle -----------------------------------------------

#[derive(clap::Args)]
pub struct PublisherHandle {
    /// Name of the publisher
    #[arg(long, short, value_name = "handle")]
    publisher: idexchange::PublisherHandle,
}


//------------ Response ------------------------------------------------------

#[derive(clap::Parser)]
pub struct Response {
    #[command(flatten)]
    handle: PublisherHandle,
}

impl Response {
    async fn run(
        self, client: &KrillClient
    ) -> Result<idexchange::RepositoryResponse, httpclient::Error> {
        client.publisher_response(&self.handle.publisher).await
    }
}


//------------ Show ------------------------------------------------------

#[derive(clap::Parser)]
pub struct Show {
    #[command(flatten)]
    handle: PublisherHandle,
}

impl Show {
    async fn run(
        self, client: &KrillClient
    ) -> Result<api::admin::PublisherDetails, httpclient::Error> {
        client.publisher_details(&self.handle.publisher).await
    }
}


//------------ Remove ----------------------------------------------------

#[derive(clap::Parser)]
pub struct Remove {
    #[command(flatten)]
    handle: PublisherHandle,
}

impl Remove {
    async fn run(
        self, client: &KrillClient
    ) -> Result<api::status::Success, httpclient::Error> {
        client.publisher_delete(&self.handle.publisher).await
    }
}


//-------- pubserver::DeleteFiles ----------------------------------------

#[derive(clap::Parser)]
pub struct DeleteFiles {
    base_uri: uri::Rsync,
}

impl DeleteFiles {
    async fn run(
        self, client: &KrillClient
    ) -> Result<api::status::Success, httpclient::Error> {
        client.pubserver_delete_files(self.base_uri).await
    }
}


//------------ ServerCommand ------------------------------------------------

#[derive(clap::Subcommand)]
pub enum ServerCommand {
    /// Initialize the publication server
    Init(Init),

    /// Show publication server statistics
    Stats(Stats),

    /// Reset the RRDP session
    #[command(name = "session-reset")]
    SessionReset(SessionReset),

    /// Clear the publication server so it can re-initialized
    Clear(Clear),
}

impl ServerCommand {
    pub async fn run(self, client: &KrillClient) -> Report {
        match self {
            Self::Init(cmd) => cmd.run(client).await.into(),
            Self::Stats(cmd) => cmd.run(client).await.into(),
            Self::SessionReset(cmd) => cmd.run(client).await.into(),
            Self::Clear(cmd) => cmd.run(client).await.into(),
        }
    }
}


//------------ Init ------------------------------------------------------

#[derive(clap::Parser)]
pub struct Init {
    /// The RRDP base URI for the repository (excluding notification.xml)
    #[arg(long, value_name = "https URI")]
    rrdp: uri::Https,

    /// The rsync base URI for the repository
    #[arg(long, value_name = "rsync URI")]
    rsync: uri::Rsync,
}

impl Init {
    pub async fn run(
        mut self, client: &KrillClient
    ) -> Result<api::status::Success, httpclient::Error> {
        // Ensure URIs end in a slash.
        self.rrdp.path_into_dir();
        self.rsync.path_into_dir();

        client.pubserver_init(self.rrdp, self.rsync).await
    }
}


//------------ Stats ---------------------------------------------------------

#[derive(clap::Parser)]
pub struct Stats;

impl Stats {
    pub async fn run(
        self, client: &KrillClient
    ) -> Result<api::pubd::RepoStats, httpclient::Error> {
        client.pubserver_stats().await
    }
}


//------------ SessionReset --------------------------------------------------

#[derive(clap::Parser)]
pub struct SessionReset;

impl SessionReset {
    pub async fn run(
        self, client: &KrillClient
    ) -> Result<api::status::Success, httpclient::Error> {
        client.pubserver_session_reset().await
    }
}


//------------ Clear ---------------------------------------------------------

#[derive(clap::Parser)]
pub struct Clear;

impl Clear {
    pub async fn run(
        self, client: &KrillClient
    ) -> Result<api::status::Success, httpclient::Error> {
        client.pubserver_clear().await
    }
}



//============ Argument Parser Types =========================================

//------------ PublisherRequestFile ------------------------------------------

#[derive(Clone, Debug)]
pub struct PublisherRequestFile(idexchange::PublisherRequest);

impl FromStr for PublisherRequestFile {
    type Err = PublisherRequestFileError;

    fn from_str(path: &str) -> Result<Self, Self::Err> {
        let req = idexchange::PublisherRequest::parse(
            BufReader::new(
                File::open(path).map_err(|err| {
                    PublisherRequestFileError::Io(path.into(), err)
                })?
            )
        ).map_err(|err| {
            PublisherRequestFileError::Parse(path.into(), err)
        })?;
        req.validate().map_err(|err| {
            PublisherRequestFileError::Parse(path.into(), err)
        })?;
        Ok(Self(req))
    }
}



//============ ErrorTypes ====================================================

//------------ PublisherResponseFileError ------------------------------------

#[derive(Debug)]
pub enum PublisherRequestFileError {
    Io(String, io::Error),
    Parse(String, idexchange::Error),
}

impl fmt::Display for PublisherRequestFileError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::Io(path, err) => {
                write!(
                    f, "Failed to read publisher request file '{path}': {err}'"
                )
            }
            Self::Parse(path, err) => {
                write!(
                    f, "Failed to parse publisher request file '{path}': {err}'"
                )
            }
        }
    }
}

impl error::Error for PublisherRequestFileError { }