feat: UI login and password management

Author: dpc

CONVENTIONS.md

@@ -2,7 +2,7 @@
 
 ## Conventions
 
-> When writing code, follow this conventions
+> When writing code, follow these conventions
 
 
 - Do NOT add comments explaining what is each line/expression doing.

Cargo.lock

@@ -97,6 +97,7 @@ time = "0.3.41"
 tokio = { version = "1.0", features = ["full"] }
 tokio-test = "0.4.4"
 tower-http = "0.5"
+tower-sessions = "0.14.0"
 tracing = "0.1.41"
 tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
 

Cargo.toml

@@ -2,8 +2,10 @@ mod opts;
 
 use std::io;
 use std::str::FromStr as _;
+use std::sync::Arc;
 
 use bfte_derive_secret::DeriveableSecret;
+use bfte_node::Node;
 use bfte_node::derive_secret_ext::DeriveSecretExt as _;
 use bfte_util_error::{Whatever, WhateverResult};
 use clap::Parser as _;
@@ -48,7 +50,7 @@ impl Bfte {
             None
         };
 
-        match opts.command {
+        let db = match opts.command {
             Commands::GenSecret => {
                 let root_seckey = DeriveableSecret::generate();
                 let peer_seckey = root_seckey.get_peer_seckey().expect("Just generated");
@@ -62,39 +64,67 @@ impl Bfte {
                 return Ok(());
             }
 
-            Commands::Join { invite } => bfte_node::Node::join(
-                db_path
-                    .whatever_context("Database path must be set to persist created federation")?,
-                &invite,
-            )
-            .await
-            .whatever_context("Failed to join consensus")?,
+            Commands::Join { invite, run } => {
+                let db = Arc::new(
+                    Node::open_db(db_path)
+                        .await
+                        .whatever_context("Failed to open database")?,
+                );
 
-            Commands::Create { extra_peers } => bfte_node::Node::create(
-                db_path
-                    .whatever_context("Database path must be set to persist created federation")?,
-                secret.whatever_context("Secret must be provided to create a new federation")?,
-                extra_peers,
-            )
-            .await
-            .whatever_context("Failed to create consensus")?,
-
-            Commands::Run { bind_ui } => {
-                bfte_node::Node::builder()
-                    .maybe_root_secret(secret)
-                    .maybe_db_path(db_path)
-                    .ui(Box::new(move |api| {
-                        Box::pin(async move { bfte_node_ui_axum::run(api, bind_ui).await })
-                    }))
-                    .build()
+                bfte_node::Node::join(db.clone(), &invite)
                     .await
-                    .whatever_context("Failed to build node")?
-                    .run()
-                    .await
-                    .whatever_context("Failed to run node")?;
+                    .whatever_context("Failed to join consensus")?;
+
+                if !run {
+                    return Ok(());
+                }
+
+                db
             }
+
+            Commands::Create { extra_peers, run } => {
+                let db = Arc::new(
+                    Node::open_db(db_path)
+                        .await
+                        .whatever_context("Failed to open database")?,
+                );
+
+                bfte_node::Node::create(
+                    db.clone(),
+                    secret
+                        .whatever_context("Secret must be provided to create a new federation")?,
+                    extra_peers,
+                )
+                .await
+                .whatever_context("Failed to create consensus")?;
+
+                if !run {
+                    return Ok(());
+                }
+
+                db
+            }
+
+            Commands::Run => Arc::new(
+                Node::open_db(db_path)
+                    .await
+                    .whatever_context("Failed to open database")?,
+            ),
         };
 
+        bfte_node::Node::builder()
+            .maybe_root_secret(secret)
+            .db(db)
+            .ui(Box::new(move |api| {
+                Box::pin(async move { bfte_node_ui_axum::run(api, opts.bind_ui).await })
+            }))
+            .build()
+            .await
+            .whatever_context("Failed to build node")?
+            .run()
+            .await
+            .whatever_context("Failed to run node")?;
+
         Ok(())
     }
 }

crates/bfte/src/lib.rs

@@ -10,6 +10,14 @@ pub(crate) struct Opts {
     #[arg(long, env = "BFTE_DATA_DIR", global = true)]
     pub data_dir: Option<PathBuf>,
 
+    #[arg(
+        long,
+        env = "BFTE_DATA_DIR",
+        default_value = "[::1]:6910",
+        global = true
+    )]
+    pub bind_ui: SocketAddr,
+
     #[arg(long, env = "BFTE_SECRET_PATH", global = true)]
     pub secret_path: Option<PathBuf>,
 
@@ -21,20 +29,18 @@ pub(crate) struct Opts {
 pub(crate) enum Commands {
     GenSecret,
     Create {
+        #[arg(long, default_value = "false")]
+        run: bool,
+
         #[arg(long = "extra-peer")]
         extra_peers: Vec<PeerPubkey>,
     },
     Join {
+        #[arg(long, default_value = "false")]
+        run: bool,
+
         #[arg(long)]
         invite: Invite,
     },
-    Run {
-        #[arg(
-            long,
-            env = "BFTE_DATA_DIR",
-            default_value = "[::1]:6910",
-            global = true
-        )]
-        bind_ui: SocketAddr,
-    },
+    Run,
 }

crates/bfte/src/opts.rs

@@ -65,6 +65,7 @@ pub(crate) trait ConsensusReadDbOps {
             .get_consensus_params_opt(round)?
             .expect("Initialized consensus database must set consensus params for round 0"))
     }
+    fn get_consensus_params_opt(&self, round: BlockRound) -> DbResult<Option<ConsensusParams>>;
     fn get_finality_consensus(&self) -> DbResult<Option<BlockRound>>;
 
     fn get_vote_dummy(&self, round: BlockRound, peer_idx: PeerIdx) -> DbResult<Option<Signature>>;
@@ -76,7 +77,6 @@ pub(crate) trait ConsensusReadDbOps {
 
     fn get_payload(&self, payload_hash: BlockPayloadHash) -> DbResult<Option<BlockPayloadRaw>>;
     fn get_finality_vote(&self, peer_pubkey: PeerPubkey) -> DbResult<Option<BlockRound>>;
-    fn get_consensus_params_opt(&self, round: BlockRound) -> DbResult<Option<ConsensusParams>>;
     fn get_peers_with_proposal_votes(&self, round: BlockRound) -> DbResult<VoteSet>;
     fn get_peers_with_dummy_votes(&self, round: BlockRound) -> DbResult<VoteSet>;
     fn get_proposal(&self, round: BlockRound) -> DbResult<Option<BlockHeader>>;

crates/consensus/src/consensus.rs

@@ -16,13 +16,14 @@ use crate::tables::{
 
 #[derive(Debug, Snafu)]
 pub enum InitError {
-    AlreadyJoined,
+    AlreadyInitialized,
 }
+
 type InitResult<T> = Result<T, InitError>;
 
 #[derive(Debug, Snafu)]
 pub enum OpenError {
-    NotJoined,
+    NotInitialized,
 }
 type OpenResult<T> = Result<T, OpenError>;
 
@@ -46,9 +47,7 @@ impl Consensus {
     pub async fn open(db: Arc<Database>, our_peer_pubkey: Option<PeerPubkey>) -> OpenResult<Self> {
         let cur_round = db.write_with_expect_falliable(Self::open_tx).await?;
 
-        let s = Self::open_internal(cur_round, db, our_peer_pubkey).await;
-
-        Ok(s)
+        Ok(Self::open_internal(cur_round, db, our_peer_pubkey).await)
     }
 
     async fn open_internal(
@@ -97,7 +96,7 @@ impl Consensus {
             ctx.insert_consensus_params(BlockRound::ZERO, params)?
         {
             if existing != params.hash() {
-                return AlreadyJoinedSnafu.fail().context(TxSnafu);
+                return AlreadyInitializedSnafu.fail().context(TxSnafu);
             }
         }
         if let Some((round, hash)) = pinned {
@@ -114,7 +113,7 @@ impl Consensus {
 
     fn open_tx(ctx: &WriteTransactionCtx) -> Result<BlockRound, DbTxError<OpenError>> {
         let Some(_) = ctx.get_consensus_params_opt(BlockRound::ZERO)? else {
-            return NotJoinedSnafu.fail().context(TxSnafu);
+            return NotInitializedSnafu.fail().context(TxSnafu);
         };
 
         Self::init_tables_tx(ctx)?;