Merge pull request #19 from Power2All/v3.1.2

v3.1.2

Author: Power2All

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "torrust-axum"
-version = "3.1.1"
+version = "3.1.2"
 edition = "2021"
 license = "AGPL-3.0"
 authors = [
@@ -22,8 +22,8 @@ rpath = false
 
 [dependencies]
 async-trait = "0.1.57"
-axum = { version = "0.5.16" }
-axum-client-ip = "0.2.0"
+axum = { version = "0.6.1" }
+axum-client-ip = "0.3.0"
 axum-server = { version = "0.4.1", features = ["tls-rustls"] }
 binascii = "0.1.4"
 bip_bencode = "0.4.4"
@@ -39,7 +39,7 @@ log = "0.4.17"
 mime_guess = "2.0.4"
 percent-encoding = "2.1.0"
 rustls = "0.20.6"
-scc = "0.8.3"
+scc = "0.12.3"
 serde = { version = "1.0.141", features = ["derive"] }
 serde_json = "1.0.82"
 sqlx = { version = "0.6.0", features = ["mysql", "postgres", "sqlite", "runtime-tokio-rustls"] }

Cargo.toml

@@ -13,7 +13,8 @@ This project originated from Torrust Tracker code originally developed by Mick v
 * [X] Multiple UDP server and HTTP(S) server blocks for socket binding possibilities
 * [X] Full IPv4 and IPv6 support for both UDP and HTTP(S)
 * [X] Built-in API on a separate port in HTTP
-* [X] Persistence saving supported using SQLite3, MySQL or PostgreSQL database
+* [X] Toggle maintenance mode through API and WebGUI
+* [X] Persistence saving supported using SQLite3, MySQL or PostgresSQL database
 * [X] Customize table and database names in the configuration file for persistence
 * [X] Whitelist system, which can be used to make the tracker private
 * [X] Blacklist system, to block and ban hashes
@@ -70,6 +71,7 @@ whitelist = false
 blacklist = false
 keys = true
 keys_cleanup_interval = 10
+maintenance_mode_enabled = false
 interval = 1800
 interval_minimum = 1800
 interval_cleanup = 900
@@ -152,6 +154,7 @@ This will show statistics of the tracker in JSON format.
   "torrents":0,
   "torrents_updates":0,
   "torrents_shadow":0,
+  "maintenance_mode":false,
   "seeds":0,
   "peers":0,
   "completed":0,
@@ -336,6 +339,39 @@ This will remove a key from the keys list, and returns status if successful or f
 }
 ```
 
+### ChangeLog
+
+#### v3.1.2
+* Bumped library versions.
+* Added a Code of Conduct file, as some open source projects need this.
+* Added a Maintenance toggle function to API and WebGUI.
+* Configuration file is not generated when it doesn't exist, or has invalid data, unless forced with a '--create-config' argument.
+* Fixed various small bugs.
+
+#### v3.1.1
+* Bumped library versions.
+* Database for SQLite3, MySQL and PostgreSQL now works properly with all the tables, and will be used if enabled.
+* UDP had a problem in IPv4, fixed the code for correctly parsing byte array.
+* Cleanup and refactoring of some redundant code.
+* Added some small checks where needed to prevent errors.
+
+#### v3.1.0
+* Whitelist System: You can enable this to only allow torrent hashes to be used you specify in the database, or add them through the API.
+* Blacklist System: You can enable this to disallow torrent hashes to be used you specify in the database, or add them through the API.
+* Keys System: You can enable this to only allow tracking when an activated "key" hash (same as an info_hash, 20 bytes or 40 characters hex) is given. Keys with a timeout of zero "0" will be permanent and won't be purged by the cleanup.
+* WebGUI: The API has an available web interface, which can be accessed through https://your.api:8080/webgui/ and giving the correct API Key, which you configure in the configuration file.
+* Customizable database structure can be given in the configuration file.
+* The system is also now available through Docker Hub at https://hub.docker.com/r/power2all/torrust-axum
+
+#### v3.0.1
+* Bugfixes
+* SQLite3 support added
+* MySQL support added
+* PostgresSQL support added
+
+#### v3.0.0
+Initial version of Torrust-Axum.
+
 ### Credits
 This Torrust-Tracker was a joint effort by [Nautilus Cyberneering GmbH](https://nautilus-cyberneering.de/), [Dutch Bits](https://dutchbits.nl) and [Power2All](https://power2all.com).
 Also thanks to [Naim A.](https://github.com/naim94a/udpt) and [greatest-ape](https://github.com/greatest-ape/aquatic) for some parts in the Torrust-Tracker code.

README.md

@@ -1,4 +1,7 @@
-FROM rust:alpine3.16
+FROM rust:alpine3.17
+
+ARG FULL_CONFIG=""
+ENV FULL_CONFIG=$FULL_CONFIG
 
 ARG LOG_LEVEL="info"
 ARG LOG_CONSOLE_INTERVAL=10

bin/torrust-axum.exe

@@ -1,6 +1,12 @@
 #!/bin/sh
 
-cat << EOF > /root/torrust-axum/target/release/config.toml
+if [ ! -z "${FULL_CONFIG}" ]
+then
+  cat << EOF > /root/torrust-axum/target/release/config.toml
+${FULL_CONFIG}
+EOF
+else
+  cat << EOF > /root/torrust-axum/target/release/config.toml
 log_level = "${LOG_LEVEL}"
 log_console_interval = ${LOG_CONSOLE_INTERVAL}
 statistics_enabled = ${STATISTICS_ENABLED}
@@ -67,6 +73,7 @@ db_keys = "${DB_STRUCTURE_DB_KEYS}"
 table_keys_hash = "${DB_STRUCTURE_TABLE_KEYS_HASH}"
 table_keys_timeout = "${DB_STRUCTURE_TABLE_KEYS_TIMEOUT}"
 EOF
+fi
 
 echo "Configuration:"
 echo ""

bin/torrust-axum_x86_64-unknown-linux-gnu.bin

@@ -2,13 +2,15 @@ use std::error::Error;
 use std::fmt;
 use std::fmt::Formatter;
 use std::net::{IpAddr, SocketAddr};
+use scc::ebr::Arc;
 use scc::HashIndex;
 use serde::{Deserialize, Serialize};
+use crate::tracker::TorrentTracker;
 use crate::udp_common;
 use crate::udp_common::AnnounceRequest;
 
 pub fn parse_query(query: Option<String>) -> Result<HashIndex<String, Vec<Vec<u8>>>, CustomError> {
-    let queries: HashIndex<String, Vec<Vec<u8>>> = HashIndex::new(0, Default::default());
+    let queries: HashIndex<String, Vec<Vec<u8>>> = HashIndex::new();
     match query {
         None => {}
         Some(result) => {
@@ -463,3 +465,12 @@ fn bin2hex(data: &[u8; 20], f: &mut Formatter) -> fmt::Result {
     binascii::bin2hex(data, &mut chars).expect("failed to hexlify");
     write!(f, "{}", std::str::from_utf8(&chars).unwrap())
 }
+
+pub async fn maintenance_mode(tracker: Arc<TorrentTracker>) -> bool
+{
+    let stats = tracker.clone().get_stats().await;
+    if stats.maintenance_mode != 0 {
+        return true;
+    }
+    false
+}

docker/Dockerfile

@@ -76,6 +76,7 @@ pub struct Configuration {
     pub keys: bool,
     pub keys_cleanup_interval: Option<u64>,
 
+    pub maintenance_mode_enabled: bool,
     pub interval: Option<u64>,
     pub interval_minimum: Option<u64>,
     pub interval_cleanup: Option<u64>,
@@ -131,6 +132,7 @@ impl Configuration {
             keys: false,
             keys_cleanup_interval: Some(60),
 
+            maintenance_mode_enabled: false,
             interval: Some(1800),
             interval_minimum: Some(1800),
             interval_cleanup: Some(900),
@@ -186,12 +188,17 @@ impl Configuration {
         }
     }
 
-    pub fn load_from_file() -> Result<Configuration, CustomError> {
+    pub fn load_from_file(create: bool) -> Result<Configuration, CustomError> {
         let mut config = Configuration::default();
         match Configuration::load_file("config.toml") {
             Ok(c) => { config = c; }
             Err(_) => {
                 eprintln!("No config file found.");
+
+                if !create {
+                    eprintln!("You can either create your own config.toml file, or start this app using '--create-config' as parameter.");
+                    return Err(CustomError::new("will not create automatically config.toml file"));
+                }
                 eprintln!("Creating config file..");
 
                 let config_toml = toml::to_string(&config).unwrap();

docker/init.sh

@@ -561,7 +561,7 @@ impl DatabaseConnector {
                             "INSERT OR REPLACE INTO {} ({}) VALUES ('{}')",
                             self.config.db_structure.db_whitelist,
                             self.config.db_structure.table_whitelist_info_hash,
-                            info_hash.to_string()
+                            info_hash
                         ))
                             .execute(&mut whitelist_transaction)
                             .await {
@@ -598,7 +598,7 @@ impl DatabaseConnector {
                             "INSERT INTO {} ({}) VALUES (UNHEX('{}'))",
                             self.config.db_structure.db_whitelist,
                             self.config.db_structure.table_whitelist_info_hash,
-                            info_hash.to_string()
+                            info_hash
                         ))
                             .execute(&mut whitelist_transaction)
                             .await {
@@ -641,7 +641,7 @@ impl DatabaseConnector {
                             "INSERT INTO {} ({}) VALUES (decode('{}','hex'))",
                             self.config.db_structure.db_whitelist,
                             self.config.db_structure.table_whitelist_info_hash,
-                            info_hash.to_string()
+                            info_hash
                         ))
                             .execute(&mut whitelist_transaction)
                             .await {
@@ -687,7 +687,7 @@ impl DatabaseConnector {
                             "INSERT OR REPLACE INTO {} ({}) VALUES ('{}')",
                             self.config.db_structure.db_blacklist,
                             self.config.db_structure.table_blacklist_info_hash,
-                            info_hash.to_string()
+                            info_hash
                         ))
                             .execute(&mut blacklist_transaction)
                             .await {
@@ -724,7 +724,7 @@ impl DatabaseConnector {
                             "INSERT INTO {} ({}) VALUES (UNHEX('{}'))",
                             self.config.db_structure.db_blacklist,
                             self.config.db_structure.table_blacklist_info_hash,
-                            info_hash.to_string()
+                            info_hash
                         ))
                             .execute(&mut blacklist_transaction)
                             .await {
@@ -761,7 +761,7 @@ impl DatabaseConnector {
                             "INSERT INTO {} ({}) VALUES (decode('{}','hex'))",
                             self.config.db_structure.db_blacklist,
                             self.config.db_structure.table_blacklist_info_hash,
-                            info_hash.to_string()
+                            info_hash
                         ))
                             .execute(&mut blacklist_transaction)
                             .await {
@@ -808,7 +808,7 @@ impl DatabaseConnector {
                             self.config.db_structure.db_keys,
                             self.config.db_structure.table_keys_hash,
                             self.config.db_structure.table_keys_timeout,
-                            hash.to_string(),
+                            hash,
                             timeout.clone()
                         ))
                             .execute(&mut keys_transaction)
@@ -846,7 +846,7 @@ impl DatabaseConnector {
                             self.config.db_structure.db_keys,
                             self.config.db_structure.table_keys_hash,
                             self.config.db_structure.table_keys_timeout,
-                            hash.to_string(),
+                            hash,
                             timeout.clone(),
                             self.config.db_structure.table_keys_timeout,
                             self.config.db_structure.table_keys_timeout
@@ -886,7 +886,7 @@ impl DatabaseConnector {
                             self.config.db_structure.db_keys,
                             self.config.db_structure.table_keys_hash,
                             self.config.db_structure.table_keys_timeout,
-                            hash.to_string(),
+                            hash,
                             timeout.clone(),
                             self.config.db_structure.table_keys_hash,
                             self.config.db_structure.table_keys_timeout,
@@ -937,7 +937,7 @@ impl DatabaseConnector {
                             self.config.db_structure.db_torrents,
                             self.config.db_structure.table_torrents_info_hash,
                             self.config.db_structure.table_torrents_completed,
-                            info_hash.to_string(),
+                            info_hash,
                             completed.clone()
                         ))
                             .execute(&mut torrents_transaction)
@@ -975,7 +975,7 @@ impl DatabaseConnector {
                             self.config.db_structure.db_torrents,
                             self.config.db_structure.table_torrents_info_hash,
                             self.config.db_structure.table_torrents_completed,
-                            info_hash.to_string(),
+                            info_hash,
                             completed.clone(),
                             self.config.db_structure.table_torrents_completed,
                             self.config.db_structure.table_torrents_completed
@@ -1015,7 +1015,7 @@ impl DatabaseConnector {
                             self.config.db_structure.db_torrents,
                             self.config.db_structure.table_torrents_info_hash,
                             self.config.db_structure.table_torrents_completed,
-                            info_hash.to_string(),
+                            info_hash,
                             completed.clone(),
                             self.config.db_structure.table_torrents_info_hash,
                             self.config.db_structure.table_torrents_completed,

src/common.rs

@@ -42,6 +42,8 @@ pub async fn http_api(handle: Handle, addr: SocketAddr, data: Arc<TorrentTracker
             .route("/api/keys/reload", get(http_api_keys_reload))
             .route("/api/keys/:key", get(http_api_keys_get).delete(http_api_keys_delete))
             .route("/api/keys/:key/:seconds_valid", post(http_api_keys_post).patch(http_api_keys_patch))
+            .route("/api/maintenance/enable", get(http_api_maintenance_enable))
+            .route("/api/maintenance/disable", get(http_api_maintenance_disable))
             .layer(CorsLayer::new()
                 .allow_methods([Method::GET, Method::POST, Method::DELETE, Method::PATCH])
                 .allow_origin(Any)
@@ -76,6 +78,8 @@ pub async fn https_api(handle: Handle, addr: SocketAddr, data: Arc<TorrentTracke
             .route("/api/keys/reload", get(http_api_keys_reload))
             .route("/api/keys/:key", get(http_api_keys_get).delete(http_api_keys_delete))
             .route("/api/keys/:key/:seconds_valid", post(http_api_keys_post).patch(http_api_keys_patch))
+            .route("/api/maintenance/enable", get(http_api_maintenance_enable))
+            .route("/api/maintenance/disable", get(http_api_maintenance_disable))
             .layer(CorsLayer::new()
                 .allow_methods([Method::GET, Method::POST, Method::DELETE, Method::PATCH])
                 .allow_origin(Any)
@@ -822,6 +826,54 @@ pub async fn http_api_keys_delete(ClientIp(ip): ClientIp, axum::extract::RawQuer
     (StatusCode::OK, headers, serde_json::to_string(&return_data).unwrap())
 }
 
+pub async fn http_api_maintenance_enable(ClientIp(ip): ClientIp, axum::extract::RawQuery(params): axum::extract::RawQuery, Extension(state): Extension<Arc<TorrentTracker>>) -> (StatusCode, HeaderMap, String)
+{
+    http_api_stats_log(ip, state.clone()).await;
+
+    let mut headers = HeaderMap::new();
+    headers.insert(HeaderName::from_static("content-type"), HeaderValue::from_static("text/plain"));
+
+    let query_map_result = parse_query(params);
+    let query_map = match api_query_hashing(query_map_result, headers.clone()) {
+        Ok(result) => { result }
+        Err(err) => { return err; }
+    };
+
+    let check_token = check_api_token(state.clone().config.clone(), ip, query_map.clone(), headers.clone()).await;
+    if check_token.is_some() {
+        return check_token.unwrap();
+    }
+
+    state.clone().set_stats(StatsEvent::MaintenanceMode, 1).await;
+
+    let return_data = json!({ "status": "ok"});
+    (StatusCode::OK, headers, serde_json::to_string(&return_data).unwrap())
+}
+
+pub async fn http_api_maintenance_disable(ClientIp(ip): ClientIp, axum::extract::RawQuery(params): axum::extract::RawQuery, Extension(state): Extension<Arc<TorrentTracker>>) -> (StatusCode, HeaderMap, String)
+{
+    http_api_stats_log(ip, state.clone()).await;
+
+    let mut headers = HeaderMap::new();
+    headers.insert(HeaderName::from_static("content-type"), HeaderValue::from_static("text/plain"));
+
+    let query_map_result = parse_query(params);
+    let query_map = match api_query_hashing(query_map_result, headers.clone()) {
+        Ok(result) => { result }
+        Err(err) => { return err; }
+    };
+
+    let check_token = check_api_token(state.clone().config.clone(), ip, query_map.clone(), headers.clone()).await;
+    if check_token.is_some() {
+        return check_token.unwrap();
+    }
+
+    state.clone().set_stats(StatsEvent::MaintenanceMode, 0).await;
+
+    let return_data = json!({ "status": "ok"});
+    (StatusCode::OK, headers, serde_json::to_string(&return_data).unwrap())
+}
+
 pub async fn http_api_stats_log(ip: IpAddr, tracker: Arc<TorrentTracker>)
 {
     if ip.is_ipv4() {