Trait App

Source

pub trait App<S: Server>: Deref<Target = AppBase<S>> + 'static {
    // Required methods
    fn configure_actix_app(self: &Rc<Self>, sc: &mut ServiceConfig);
    fn check_constellation(&self, constellation: &Constellation) -> bool;
    async fn discover(
        self: &Rc<Self>,
        phc_inf: DiscoveryInfoResp,
    ) -> Result<DiscoverVerdict<S::RunningStateSeed>>;

    // Provided methods
    async fn discover_as_non_phc(
        self: &Rc<Self>,
        phc_inf: DiscoveryInfoResp,
    ) -> Result<DiscoverVerdict<()>> { ... }
    fn master_enc_key_part(&self) -> Option<&PrivateKey> { ... }
    fn encap_key(&self) -> Option<&EncapKeyBytes> { ... }
    fn master_enc_key_part_sealing_key(&self) -> Option<&SealingKey> { ... }
    async fn local_task(_weak: Weak<Self>) { ... }
    async fn global_task(_app: Rc<Self>) -> Result<Infallible> { ... }
}

Expand description

What’s common between the actix_web::Apps used by the different PubHubs servers.

Each actix_web::App gets access to an instance of the appropriate implementation of App..

Required Methods§

Source

fn configure_actix_app(self: &Rc<Self>, sc: &mut ServiceConfig)

Allows App to add server-specific endpoints. Non-server specific endpoints are added by AppBase::configure_actix_app.

Source

fn check_constellation(&self, constellation: &Constellation) -> bool

Checks whether the given constellation properly reflects this server’s configuration.

Source

async fn discover( self: &Rc<Self>, phc_inf: DiscoveryInfoResp, ) -> Result<DiscoverVerdict<S::RunningStateSeed>>

Runs the discovery routine for this server given api::DiscoveryInfoResp already obtained from Pubhubs Central. If the server is not PHC itself, the Constellation in this api::DiscoveryInfoResp must be set.

If one of the other servers is not up-to-date according to this server, discovery of that server is invoked and api::ErrorCode::PleaseRetry is returned.

PHC implements this directly; the transcryptor and authentication server delegate to discover_as_non_phc.

Provided Methods§

Source

async fn discover_as_non_phc( self: &Rc<Self>, phc_inf: DiscoveryInfoResp, ) -> Result<DiscoverVerdict<()>>

Shared discovery routine for the non-PHC servers (transcryptor, authentication server), whose running state needs no seed (RunningStateSeed = ()).

Source

fn master_enc_key_part(&self) -> Option<&PrivateKey>

Should return the master encryption key part for PHC and the transcryption.

Source

fn encap_key(&self) -> Option<&EncapKeyBytes>

This server’s published kem::EncapKeyBytes, if any. Overridden by T/AS.

Source

fn master_enc_key_part_sealing_key(&self) -> Option<&SealingKey>

The sealing key (shared with PHC) under which this server seals its master encryption key part in its discovery info, when available (it requires a running state, so it is None before discovery completes). Only invoked on, and overridden by, the transcryptor.

Source