Add max cache entries and options.

Signed-off-by: Elizabeth Myers <[email protected]>

env_example

@@ -66,6 +66,26 @@ REDIS_POOL_SIZE=3
 # For production, it's recommended to keep this at warn or error.
 RUST_LOG="warn"
 
+# URL cache parameters.
+# The URL cache is used to cache if a URL matches a banned regex.
+# If it does, it is disallowed for shadifying.
+#     - URL_CACHE_TTL: maximum time a URL can live in the cache. (default: 3 days)
+#     - URL_CACHE_IDLE: maximum time a URL can be idle in the cache. (default: 1 day)
+#     - URL_CACHE_MAX_ENTRIES: maximum cache entries allowed (default: 5000)
+URL_CACHE_TTL="3d"
+URL_CACHE_IDLE="1d"
+URL_CACHE_MAX_ENTRIES=5000
+
+# Ban cache parameters.
+# The ban cache is used to cache if a given IP is in a banned IP block.
+# If it is, the user cannot shadify their URL.
+#     - BAN_CACHE_TTL: maximum time an IP can live in the cache. (default: 3 days)
+#     - BAN_CACHE_IDLE: maximum time an IP can be idle in the cache. (default: 1 day)
+#     - BAN_CACHE_MAX_ENTRIES: maximum cache entries allowed (default: 5000)
+BAN_CACHE_TTL="3d"
+BAN_CACHE_IDLE="1d"
+BAN_CACHE_MAX_ENTRIES=5000
+
 # Set the CSRF encryption key.
 # If unset, a random one will be generated each application start (invalidating all previous sessions).
 # This default MUST be changed. Generate a new one with:

src/cli/subcommands.rs

@@ -25,7 +25,7 @@ use proctitle::set_title;
 use crate::env::{EnvError, Vars};
 
 // Re-exported
-pub(crate) use crate::cli::parser::UsernameArgument;
+pub use crate::cli::parser::UsernameArgument;
 
 #[async_trait::async_trait]
 pub trait CliSubcommand {

src/env.rs

@@ -40,6 +40,10 @@ mod defaults {
         2
     }
 
+    pub(super) const fn max_cache_entries() -> u64 {
+        5000
+    }
+
     pub(super) fn sitename() -> String {
         "ShadyURL".to_string()
     }
@@ -50,11 +54,11 @@ mod defaults {
         ret
     }
 
-    pub(super) fn duration_1d() -> Duration {
+    pub(super) const fn duration_1d() -> Duration {
         Duration::days(1)
     }
 
-    pub(super) fn duration_3d() -> Duration {
+    pub(super) const fn duration_3d() -> Duration {
         Duration::days(3)
     }
 }
@@ -147,6 +151,11 @@ pub struct Vars {
     )]
     pub(crate) url_cache_idle: Duration,
 
+    #[serde(default = "defaults::max_cache_entries")]
+    pub(crate) ban_cache_max_entries: u64,
+    #[serde(default = "defaults::max_cache_entries")]
+    pub(crate) url_cache_max_entries: u64,
+
     // FIXME: encrypt entire session with this, but axum-login isn't ready
     #[serde(
         deserialize_with = "deserializers::csrf_key",

src/web/app.rs

@@ -93,9 +93,19 @@ impl App {
         let db = Arc::new(Database::get_with_connect_options(opt).await?);
 
         // TODO: configurable
-        let bancache = BanCache::new(db.clone(), 5000, env.ban_cache_ttl, env.ban_cache_idle);
-        let urlcache =
-            UrlCache::new(db.clone(), 5000, env.url_cache_ttl, env.url_cache_idle).await?;
+        let bancache = BanCache::new(
+            db.clone(),
+            env.ban_cache_max_entries,
+            env.ban_cache_ttl,
+            env.ban_cache_idle,
+        );
+        let urlcache = UrlCache::new(
+            db.clone(),
+            env.url_cache_max_entries,
+            env.url_cache_ttl,
+            env.url_cache_idle,
+        )
+        .await?;
 
         let csrf_crypto_engine = CryptoEngine::new(&env.csrf_key.into());