Merge #202: Axum HTTP tracker: announce request in listed mode

cd14c6b feat(http): [#200] announce request in listed mode (Jose Celano)
ea24973 refactor(http): [#200] move function to Tracker (Jose Celano)

Pull request description:

  For the new Auxm HTTP tracker implementation.

Top commit has no ACKs.

Tree-SHA512: 37bd2c98c8ab1a016e9fb1945b032c4811496e36a7d73c78645663a0a62c048d8dc3e954e4c4297faacb2f7d164f3a9cc13a0e76a0f1c75f75d654c4320eac8f

src/http/axum_implementation/handlers/announce.rs

@@ -28,7 +28,7 @@ pub async fn handle_without_key(
 ) -> Response {
     debug!("http announce request: {:#?}", announce_request);
 
-    if tracker.is_private() {
+    if tracker.requires_authentication() {
         return responses::error::Error::from(auth::Error::MissingAuthKey {
             location: Location::caller(),
         })
@@ -47,6 +47,7 @@ pub async fn handle_with_key(
 ) -> Response {
     debug!("http announce request: {:#?}", announce_request);
 
+    // todo: extract to Axum extractor. Duplicate code in `scrape` handler.
     let Ok(key_id) = key_id_param.value().parse::<KeyId>() else {
         return responses::error::Error::from(
             auth::Error::InvalidKeyFormat {
@@ -55,7 +56,7 @@ pub async fn handle_with_key(
         .into_response()
     };
 
-    match auth::authenticate(&key_id, &tracker).await {
+    match tracker.authenticate(&key_id).await {
         Ok(_) => (),
         Err(error) => return responses::error::Error::from(error).into_response(),
     }
@@ -64,6 +65,11 @@ pub async fn handle_with_key(
 }
 
 async fn handle(tracker: &Arc<Tracker>, announce_request: &Announce, remote_client_ip: &RemoteClientIp) -> Response {
+    match tracker.authorize(&announce_request.info_hash).await {
+        Ok(_) => (),
+        Err(error) => return responses::error::Error::from(error).into_response(),
+    }
+
     let peer_ip = match peer_ip::resolve(tracker.config.on_reverse_proxy, remote_client_ip) {
         Ok(peer_ip) => peer_ip,
         Err(err) => return err,

src/http/axum_implementation/handlers/auth.rs

@@ -1,12 +1,10 @@
 use std::panic::Location;
-use std::sync::Arc;
 
 use serde::Deserialize;
 use thiserror::Error;
 
 use crate::http::axum_implementation::responses;
-use crate::tracker::auth::{self, KeyId};
-use crate::tracker::Tracker;
+use crate::tracker::auth;
 
 #[derive(Deserialize)]
 pub struct KeyIdParam(String);
@@ -26,17 +24,6 @@ pub enum Error {
     InvalidKeyFormat { location: &'static Location<'static> },
 }
 
-/// # Errors
-///
-/// Will return an error if the the authentication key cannot be verified.
-pub async fn authenticate(key_id: &KeyId, tracker: &Arc<Tracker>) -> Result<(), auth::Error> {
-    if tracker.is_private() {
-        tracker.verify_auth_key(key_id).await
-    } else {
-        Ok(())
-    }
-}
-
 impl From<Error> for responses::error::Error {
     fn from(err: Error) -> Self {
         responses::error::Error {

src/http/axum_implementation/handlers/mod.rs

@@ -1,4 +1,15 @@
+use super::responses;
+use crate::tracker::error::Error;
+
 pub mod announce;
 pub mod auth;
 pub mod scrape;
 pub mod status;
+
+impl From<Error> for responses::error::Error {
+    fn from(err: Error) -> Self {
+        responses::error::Error {
+            failure_reason: format!("Tracker error: {err}"),
+        }
+    }
+}

src/http/axum_implementation/handlers/scrape.rs

@@ -23,7 +23,7 @@ pub async fn handle_without_key(
 ) -> Response {
     debug!("http scrape request: {:#?}", &scrape_request);
 
-    if tracker.is_private() {
+    if tracker.requires_authentication() {
         return handle_fake_scrape(&tracker, &scrape_request, &remote_client_ip).await;
     }
 
@@ -39,6 +39,7 @@ pub async fn handle_with_key(
 ) -> Response {
     debug!("http scrape request: {:#?}", &scrape_request);
 
+    // todo: extract to Axum extractor. Duplicate code in `announce` handler.
     let Ok(key_id) = key_id_param.value().parse::<KeyId>() else {
         return responses::error::Error::from(
             auth::Error::InvalidKeyFormat {
@@ -47,7 +48,7 @@ pub async fn handle_with_key(
         .into_response()
     };
 
-    match auth::authenticate(&key_id, &tracker).await {
+    match tracker.authenticate(&key_id).await {
         Ok(_) => (),
         Err(_) => return handle_fake_scrape(&tracker, &scrape_request, &remote_client_ip).await,
     }

src/tracker/mod.rs

@@ -107,6 +107,10 @@ impl Tracker {
         self.mode == mode::Mode::Listed || self.mode == mode::Mode::PrivateListed
     }
 
+    pub fn requires_authentication(&self) -> bool {
+        self.is_private()
+    }
+
     /// It handles an announce request.
     ///
     /// BEP 03: [The `BitTorrent` Protocol Specification](https://www.bittorrent.org/beps/bep_0003.html).
@@ -334,6 +338,38 @@ impl Tracker {
         Ok(())
     }
 
+    /// # Errors
+    ///
+    /// Will return an error if the the authentication key cannot be verified.
+    pub async fn authenticate(&self, key_id: &KeyId) -> Result<(), auth::Error> {
+        if self.is_private() {
+            self.verify_auth_key(key_id).await
+        } else {
+            Ok(())
+        }
+    }
+
+    /// The only authorization process is the whitelist.
+    ///
+    /// # Errors
+    ///
+    /// Will return an error if the tracker is running in `listed` mode
+    /// and the infohash is not whitelisted.
+    pub async fn authorize(&self, info_hash: &InfoHash) -> Result<(), Error> {
+        if !self.is_whitelisted() {
+            return Ok(());
+        }
+
+        if self.is_info_hash_whitelisted(info_hash).await {
+            return Ok(());
+        }
+
+        return Err(Error::TorrentNotWhitelisted {
+            info_hash: *info_hash,
+            location: Location::caller(),
+        });
+    }
+
     /// Loading the torrents from database into memory
     ///
     /// # Errors

tests/http_tracker.rs

@@ -2403,8 +2403,7 @@ mod axum_http_tracker_server {
             use crate::http::requests::announce::QueryBuilder;
             use crate::http::server::start_whitelisted_http_tracker;
 
-            //#[tokio::test]
-            #[allow(dead_code)]
+            #[tokio::test]
             async fn should_fail_if_the_torrent_is_not_in_the_whitelist() {
                 let http_tracker_server = start_whitelisted_http_tracker(Version::Axum).await;
 
@@ -2417,8 +2416,7 @@ mod axum_http_tracker_server {
                 assert_torrent_not_in_whitelist_error_response(response).await;
             }
 
-            //#[tokio::test]
-            #[allow(dead_code)]
+            #[tokio::test]
             async fn should_allow_announcing_a_whitelisted_torrent() {
                 let http_tracker_server = start_whitelisted_http_tracker(Version::Axum).await;