Support authentication in WebDAV storage (#1608)

It brings ability to provide the following type of credentials:
- username/password
- token

Author: dtretyakov

Cargo.lock

@@ -31,7 +31,7 @@ bincode = "1"
 blake3 = "1"
 byteorder = "1.0"
 bytes = "1"
-opendal = { version= "0.27.1", optional=true }
+opendal = { version= "0.29.1", optional=true }
 reqsign = {version="0.8.5", optional=true}
 clap = { version = "4.1.11", features = ["derive", "env", "wrap_help"] }
 directories = "4.0.1"

Cargo.toml

@@ -1,6 +1,6 @@
 # WebDAV
 
-Set `SCCACHE_WEBDAV_ENDPOINT` to a wevdav service endpoint to store cache in a webdav service. Set `SCCACHE_WEBDAV_KEY_PREFIX` to specify the key prefix of cache.
+Set `SCCACHE_WEBDAV_ENDPOINT` to a webdav service endpoint to store cache in a webdav service. Set `SCCACHE_WEBDAV_KEY_PREFIX` to specify the key prefix of cache.
 
 The webdav cache is compatible with:
 
@@ -9,3 +9,9 @@ The webdav cache is compatible with:
 - [Gradle Build Cache](https://docs.gradle.org/current/userguide/build_cache.html)
 
 Users can set `SCCACHE_WEBDAV_ENDPOINT` to those services directly.
+
+## Credentials
+
+Sccache is able to load credentials from the following sources:
+- Set `SCCACHE_WEBDAV_USERNAME`/`SCCACHE_WEBDAV_PASSWORD` to specify the username/password pair for basic authentication.
+- Set `SCCACHE_WEBDAV_TOKEN` to specify the token value for bearer token authentication.

docs/Webdav.md

@@ -557,8 +557,16 @@ pub fn storage_from_config(
             #[cfg(feature = "webdav")]
             CacheType::Webdav(ref c) => {
                 debug!("Init webdav cache with endpoint {}", c.endpoint);
-                let storage = WebdavCache::build(&c.endpoint, &c.key_prefix)
-                    .map_err(|err| anyhow!("create webdav cache failed: {err:?}"))?;
+
+                let storage = WebdavCache::build(
+                    &c.endpoint,
+                    &c.key_prefix,
+                    c.username.as_deref(),
+                    c.password.as_deref(),
+                    c.token.as_deref(),
+                )
+                .map_err(|err| anyhow!("create webdav cache failed: {err:?}"))?;
+
                 return Ok(Arc::new(storage));
             }
             #[allow(unreachable_patterns)]

src/cache/cache.rs

@@ -20,10 +20,25 @@ pub struct WebdavCache;
 
 impl WebdavCache {
     /// Create a new `WebdavCache`.
-    pub fn build(endpoint: &str, key_prefix: &str) -> Result<Operator> {
+    pub fn build(
+        endpoint: &str,
+        key_prefix: &str,
+        username: Option<&str>,
+        password: Option<&str>,
+        token: Option<&str>,
+    ) -> Result<Operator> {
         let mut builder = Webdav::default();
         builder.endpoint(endpoint);
         builder.root(key_prefix);
+        if let Some(username) = username {
+            builder.username(username);
+        }
+        if let Some(password) = password {
+            builder.password(password);
+        }
+        if let Some(token) = token {
+            builder.token(token);
+        }
 
         let op = Operator::create(builder)?
             .layer(LoggingLayer::default())

src/cache/webdav.rs

@@ -233,6 +233,9 @@ pub struct RedisCacheConfig {
 pub struct WebdavCacheConfig {
     pub endpoint: String,
     pub key_prefix: String,
+    pub username: Option<String>,
+    pub password: Option<String>,
+    pub token: Option<String>,
 }
 
 #[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
@@ -665,10 +668,16 @@ fn config_from_env() -> Result<EnvConfig> {
             .filter(|s| !s.is_empty())
             .unwrap_or_default()
             .to_owned();
+        let username = env::var("SCCACHE_WEBDAV_USERNAME").ok();
+        let password = env::var("SCCACHE_WEBDAV_PASSWORD").ok();
+        let token = env::var("SCCACHE_WEBDAV_TOKEN").ok();
 
         Some(WebdavCacheConfig {
             endpoint,
             key_prefix,
+            username,
+            password,
+            token,
         })
     } else {
         None
@@ -1171,6 +1180,9 @@ no_credentials = true
 [cache.webdav]
 endpoint = "http://127.0.0.1:8080"
 key_prefix = "webdavprefix"
+username = "webdavusername"
+password = "webdavpassword"
+token = "webdavtoken"
 "#;
 
     let file_config: FileConfig = toml::from_str(CONFIG_STR).expect("Is valid toml.");
@@ -1213,6 +1225,9 @@ key_prefix = "webdavprefix"
                 webdav: Some(WebdavCacheConfig {
                     endpoint: "http://127.0.0.1:8080".to_string(),
                     key_prefix: "webdavprefix".into(),
+                    username: Some("webdavusername".to_string()),
+                    password: Some("webdavpassword".to_string()),
+                    token: Some("webdavtoken".to_string()),
                 })
             },
             dist: DistConfig {