Merge #1196: Overhaul core Tracker: refactor authentication module

dff6bca refactor: [#1195] remove authentication::Facade service (Jose Celano)
77eccdc fix: [#1195] format (Jose Celano)
661fe6a refactor: [#1195] remove AuthenticationService from authentication Facade (Jose Celano)
747b608 refactor: [#1195] use AuthenticationService directy (Jose Celano)
457d01b refactor: [#1195] rename service to AuthenticationService (Jose Celano)
965e911 refactor: [#1195] inject dependencies into authenticattion::Facade (Jose Celano)
504357c refactor: [#1195] inject dependencies in authenticatio::Facade (Jose Celano)
663250b refactor: [#1195] rename methods (Jose Celano)
9c61b26 refactor: [#1195] move tests to KeysHandler (Jose Celano)
c06da07 refactor: [#1195] more authentication tests to authentication service (Jose Celano)
bb2f9e0 refactor: [#1195] extract core::authentication::handler::KeysHandler (Jose Celano)
23590e7 refactor: [#1195] make method private (Jose Celano)
81b4b3c refactor: [#1195] extract and move method (Jose Celano)
cd542dc refactor: [#1195] extract authentication::Service (Jose Celano)
a93a79c refactor: [#1195] remove deprecated context section in docs (Jose Celano)
12a62ce refactor: [#1195] extract InMemoryKeyRepository (Jose Celano)
f4c7b97 refactor: [#1195] extract DatabaseKeyRepository (Jose Celano)
44255e2 refactor: [#1195] create dir for mod (Jose Celano)

Pull request description:

  Overhaul core Tracker: refactor authentication module.

ACKs for top commit:
  josecelano:
    ACK dff6bca

Tree-SHA512: 6f0fb0c9c97a9bb2056e293d1774bcbcf507e2a922eccb2c97675ac0963efcfe4848b53c45b88b512ae5a73e394f368e9bb9c4c6ee0af3b900a008eeddba02b9

Author: josecelano

src/app.rs

@@ -52,8 +52,7 @@ pub async fn start(config: &Configuration, app_container: &AppContainer) -> Vec<
     // Load peer keys
     if app_container.tracker.is_private() {
         app_container
-            .tracker
-            .authentication
+            .keys_handler
             .load_keys_from_database()
             .await
             .expect("Could not retrieve keys from database.");
@@ -100,6 +99,7 @@ pub async fn start(config: &Configuration, app_container: &AppContainer) -> Vec<
             if let Some(job) = http_tracker::start_job(
                 http_tracker_config,
                 app_container.tracker.clone(),
+                app_container.authentication_service.clone(),
                 app_container.whitelist_authorization.clone(),
                 app_container.stats_event_sender.clone(),
                 registar.give_form(),
@@ -119,6 +119,7 @@ pub async fn start(config: &Configuration, app_container: &AppContainer) -> Vec<
         if let Some(job) = tracker_apis::start_job(
             http_api_config,
             app_container.tracker.clone(),
+            app_container.keys_handler.clone(),
             app_container.whitelist_manager.clone(),
             app_container.ban_service.clone(),
             app_container.stats_event_sender.clone(),

src/app_test.rs

@@ -3,10 +3,14 @@ use std::sync::Arc;
 
 use torrust_tracker_configuration::Configuration;
 
+use crate::core::authentication::handler::KeysHandler;
+use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
+use crate::core::authentication::key::repository::persisted::DatabaseKeyRepository;
+use crate::core::authentication::service::{self, AuthenticationService};
 use crate::core::databases::Database;
 use crate::core::services::initialize_database;
+use crate::core::whitelist;
 use crate::core::whitelist::repository::in_memory::InMemoryWhitelist;
-use crate::core::{authentication, whitelist};
 
 /// Initialize the tracker dependencies.
 #[allow(clippy::type_complexity)]
@@ -17,15 +21,21 @@ pub fn initialize_tracker_dependencies(
     Arc<Box<dyn Database>>,
     Arc<InMemoryWhitelist>,
     Arc<whitelist::authorization::Authorization>,
-    Arc<authentication::Facade>,
+    Arc<AuthenticationService>,
 ) {
     let database = initialize_database(config);
     let in_memory_whitelist = Arc::new(InMemoryWhitelist::default());
     let whitelist_authorization = Arc::new(whitelist::authorization::Authorization::new(
         &config.core,
         &in_memory_whitelist.clone(),
     ));
-    let authentication = Arc::new(authentication::Facade::new(&config.core, &database.clone()));
+    let db_key_repository = Arc::new(DatabaseKeyRepository::new(&database));
+    let in_memory_key_repository = Arc::new(InMemoryKeyRepository::default());
+    let authentication_service = Arc::new(service::AuthenticationService::new(&config.core, &in_memory_key_repository));
+    let _keys_handler = Arc::new(KeysHandler::new(
+        &db_key_repository.clone(),
+        &in_memory_key_repository.clone(),
+    ));
 
-    (database, in_memory_whitelist, whitelist_authorization, authentication)
+    (database, in_memory_whitelist, whitelist_authorization, authentication_service)
 }

src/bootstrap/app.rs

@@ -22,9 +22,13 @@ use tracing::instrument;
 use super::config::initialize_configuration;
 use crate::bootstrap;
 use crate::container::AppContainer;
+use crate::core::authentication::handler::KeysHandler;
+use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
+use crate::core::authentication::key::repository::persisted::DatabaseKeyRepository;
+use crate::core::authentication::service;
 use crate::core::services::{initialize_database, initialize_tracker, initialize_whitelist_manager, statistics};
+use crate::core::whitelist;
 use crate::core::whitelist::repository::in_memory::InMemoryWhitelist;
-use crate::core::{authentication, whitelist};
 use crate::servers::udp::server::banning::BanService;
 use crate::servers::udp::server::launcher::MAX_CONNECTION_ID_ERRORS_PER_IP;
 use crate::shared::crypto::ephemeral_instance_keys;
@@ -89,23 +93,28 @@ pub fn initialize_app_container(configuration: &Configuration) -> AppContainer {
         &in_memory_whitelist.clone(),
     ));
     let whitelist_manager = initialize_whitelist_manager(database.clone(), in_memory_whitelist.clone());
-    let authentication = Arc::new(authentication::Facade::new(&configuration.core, &database.clone()));
-
-    let tracker = Arc::new(initialize_tracker(
-        configuration,
-        &database,
-        &whitelist_authorization,
-        &authentication,
+    let db_key_repository = Arc::new(DatabaseKeyRepository::new(&database));
+    let in_memory_key_repository = Arc::new(InMemoryKeyRepository::default());
+    let authentication_service = Arc::new(service::AuthenticationService::new(
+        &configuration.core,
+        &in_memory_key_repository,
     ));
+    let keys_handler = Arc::new(KeysHandler::new(
+        &db_key_repository.clone(),
+        &in_memory_key_repository.clone(),
+    ));
+
+    let tracker = Arc::new(initialize_tracker(configuration, &database, &whitelist_authorization));
 
     AppContainer {
         tracker,
+        keys_handler,
+        authentication_service,
         whitelist_authorization,
         ban_service,
         stats_event_sender,
         stats_repository,
         whitelist_manager,
-        authentication,
     }
 }
 

src/bootstrap/jobs/http_tracker.rs

@@ -19,6 +19,7 @@ use torrust_tracker_configuration::HttpTracker;
 use tracing::instrument;
 
 use super::make_rust_tls;
+use crate::core::authentication::service::AuthenticationService;
 use crate::core::statistics::event::sender::Sender;
 use crate::core::{self, statistics, whitelist};
 use crate::servers::http::server::{HttpServer, Launcher};
@@ -34,10 +35,11 @@ use crate::servers::registar::ServiceRegistrationForm;
 ///
 /// It would panic if the `config::HttpTracker` struct would contain inappropriate values.
 ///
-#[instrument(skip(config, tracker, whitelist_authorization, stats_event_sender, form))]
+#[instrument(skip(config, tracker, authentication_service, whitelist_authorization, stats_event_sender, form))]
 pub async fn start_job(
     config: &HttpTracker,
     tracker: Arc<core::Tracker>,
+    authentication_service: Arc<AuthenticationService>,
     whitelist_authorization: Arc<whitelist::authorization::Authorization>,
     stats_event_sender: Arc<Option<Box<dyn Sender>>>,
     form: ServiceRegistrationForm,
@@ -55,6 +57,7 @@ pub async fn start_job(
                 socket,
                 tls,
                 tracker.clone(),
+                authentication_service.clone(),
                 whitelist_authorization.clone(),
                 stats_event_sender.clone(),
                 form,
@@ -70,12 +73,19 @@ async fn start_v1(
     socket: SocketAddr,
     tls: Option<RustlsConfig>,
     tracker: Arc<core::Tracker>,
+    authentication_service: Arc<AuthenticationService>,
     whitelist_authorization: Arc<whitelist::authorization::Authorization>,
     stats_event_sender: Arc<Option<Box<dyn statistics::event::sender::Sender>>>,
     form: ServiceRegistrationForm,
 ) -> JoinHandle<()> {
     let server = HttpServer::new(Launcher::new(socket, tls))
-        .start(tracker, whitelist_authorization, stats_event_sender, form)
+        .start(
+            tracker,
+            authentication_service,
+            whitelist_authorization,
+            stats_event_sender,
+            form,
+        )
         .await
         .expect("it should be able to start to the http tracker");
 
@@ -100,9 +110,13 @@ mod tests {
 
     use crate::bootstrap::app::initialize_global_services;
     use crate::bootstrap::jobs::http_tracker::start_job;
+    use crate::core::authentication::handler::KeysHandler;
+    use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
+    use crate::core::authentication::key::repository::persisted::DatabaseKeyRepository;
+    use crate::core::authentication::service;
     use crate::core::services::{initialize_database, initialize_tracker, statistics};
+    use crate::core::whitelist;
     use crate::core::whitelist::repository::in_memory::InMemoryWhitelist;
-    use crate::core::{authentication, whitelist};
     use crate::servers::http::Version;
     use crate::servers::registar::Registar;
 
@@ -123,15 +137,22 @@ mod tests {
             &cfg.core,
             &in_memory_whitelist.clone(),
         ));
-        let authentication = Arc::new(authentication::Facade::new(&cfg.core, &database.clone()));
+        let db_key_repository = Arc::new(DatabaseKeyRepository::new(&database));
+        let in_memory_key_repository = Arc::new(InMemoryKeyRepository::default());
+        let authentication_service = Arc::new(service::AuthenticationService::new(&cfg.core, &in_memory_key_repository));
+        let _keys_handler = Arc::new(KeysHandler::new(
+            &db_key_repository.clone(),
+            &in_memory_key_repository.clone(),
+        ));
 
-        let tracker = Arc::new(initialize_tracker(&cfg, &database, &whitelist_authorization, &authentication));
+        let tracker = Arc::new(initialize_tracker(&cfg, &database, &whitelist_authorization));
 
         let version = Version::V1;
 
         start_job(
             config,
             tracker,
+            authentication_service,
             whitelist_authorization,
             stats_event_sender,
             Registar::default().give_form(),

src/bootstrap/jobs/tracker_apis.rs

@@ -30,6 +30,7 @@ use torrust_tracker_configuration::{AccessTokens, HttpApi};
 use tracing::instrument;
 
 use super::make_rust_tls;
+use crate::core::authentication::handler::KeysHandler;
 use crate::core::statistics::event::sender::Sender;
 use crate::core::statistics::repository::Repository;
 use crate::core::whitelist::manager::WhiteListManager;
@@ -60,10 +61,20 @@ pub struct ApiServerJobStarted();
 ///
 ///
 #[allow(clippy::too_many_arguments)]
-#[instrument(skip(config, tracker, whitelist_manager, ban_service, stats_event_sender, stats_repository, form))]
+#[instrument(skip(
+    config,
+    tracker,
+    keys_handler,
+    whitelist_manager,
+    ban_service,
+    stats_event_sender,
+    stats_repository,
+    form
+))]
 pub async fn start_job(
     config: &HttpApi,
     tracker: Arc<core::Tracker>,
+    keys_handler: Arc<KeysHandler>,
     whitelist_manager: Arc<WhiteListManager>,
     ban_service: Arc<RwLock<BanService>>,
     stats_event_sender: Arc<Option<Box<dyn Sender>>>,
@@ -85,6 +96,7 @@ pub async fn start_job(
                 bind_to,
                 tls,
                 tracker.clone(),
+                keys_handler.clone(),
                 whitelist_manager.clone(),
                 ban_service.clone(),
                 stats_event_sender.clone(),
@@ -103,6 +115,7 @@ pub async fn start_job(
     socket,
     tls,
     tracker,
+    keys_handler,
     whitelist_manager,
     ban_service,
     stats_event_sender,
@@ -114,6 +127,7 @@ async fn start_v1(
     socket: SocketAddr,
     tls: Option<RustlsConfig>,
     tracker: Arc<core::Tracker>,
+    keys_handler: Arc<KeysHandler>,
     whitelist_manager: Arc<WhiteListManager>,
     ban_service: Arc<RwLock<BanService>>,
     stats_event_sender: Arc<Option<Box<dyn Sender>>>,
@@ -124,6 +138,7 @@ async fn start_v1(
     let server = ApiServer::new(Launcher::new(socket, tls))
         .start(
             tracker,
+            keys_handler,
             whitelist_manager,
             stats_event_sender,
             stats_repository,
@@ -149,9 +164,13 @@ mod tests {
 
     use crate::bootstrap::app::initialize_global_services;
     use crate::bootstrap::jobs::tracker_apis::start_job;
+    use crate::core::authentication::handler::KeysHandler;
+    use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
+    use crate::core::authentication::key::repository::persisted::DatabaseKeyRepository;
+    use crate::core::authentication::service;
     use crate::core::services::{initialize_database, initialize_tracker, initialize_whitelist_manager, statistics};
+    use crate::core::whitelist;
     use crate::core::whitelist::repository::in_memory::InMemoryWhitelist;
-    use crate::core::{authentication, whitelist};
     use crate::servers::apis::Version;
     use crate::servers::registar::Registar;
     use crate::servers::udp::server::banning::BanService;
@@ -176,15 +195,22 @@ mod tests {
             &in_memory_whitelist.clone(),
         ));
         let whitelist_manager = initialize_whitelist_manager(database.clone(), in_memory_whitelist.clone());
-        let authentication = Arc::new(authentication::Facade::new(&cfg.core, &database.clone()));
+        let db_key_repository = Arc::new(DatabaseKeyRepository::new(&database));
+        let in_memory_key_repository = Arc::new(InMemoryKeyRepository::default());
+        let _authentication_service = Arc::new(service::AuthenticationService::new(&cfg.core, &in_memory_key_repository));
+        let keys_handler = Arc::new(KeysHandler::new(
+            &db_key_repository.clone(),
+            &in_memory_key_repository.clone(),
+        ));
 
-        let tracker = Arc::new(initialize_tracker(&cfg, &database, &whitelist_authorization, &authentication));
+        let tracker = Arc::new(initialize_tracker(&cfg, &database, &whitelist_authorization));
 
         let version = Version::V1;
 
         start_job(
             config,
             tracker,
+            keys_handler,
             whitelist_manager,
             ban_service,
             stats_event_sender,

src/container.rs

@@ -2,18 +2,21 @@ use std::sync::Arc;
 
 use tokio::sync::RwLock;
 
+use crate::core::authentication::handler::KeysHandler;
+use crate::core::authentication::service::AuthenticationService;
 use crate::core::statistics::event::sender::Sender;
 use crate::core::statistics::repository::Repository;
 use crate::core::whitelist::manager::WhiteListManager;
-use crate::core::{authentication, whitelist, Tracker};
+use crate::core::{whitelist, Tracker};
 use crate::servers::udp::server::banning::BanService;
 
 pub struct AppContainer {
     pub tracker: Arc<Tracker>,
+    pub keys_handler: Arc<KeysHandler>,
+    pub authentication_service: Arc<AuthenticationService>,
     pub whitelist_authorization: Arc<whitelist::authorization::Authorization>,
     pub ban_service: Arc<RwLock<BanService>>,
     pub stats_event_sender: Arc<Option<Box<dyn Sender>>>,
     pub stats_repository: Arc<Repository>,
     pub whitelist_manager: Arc<WhiteListManager>,
-    pub authentication: Arc<authentication::Facade>,
 }