OXYGENHUB
◆ v0.11.0 oxygen / crates / oxy-strata / src / gcp.rs
2.8 KiB · Rust · last changed Cloud stores take credentials handed over 1 month ago source blame history raw
1
//! Google Cloud Storage: `gs://BUCKET/PREFIX`.
2
//!
3
//! Credentials, in Google's own order: a service account key file named
4
//! by `?credentials=PATH` or `GOOGLE_APPLICATION_CREDENTIALS` (which may
5
//! also hold application default credentials), the key or path in
6
//! `GOOGLE_SERVICE_ACCOUNT*`, then the application default credentials
7
//! `gcloud auth application-default login` wrote, then the instance's
8
//! service account. `?endpoint=URL` points at another endpoint.
9
10
use crate::StoreUrl;
11
use object_store::gcp::{GoogleCloudStorage, GoogleCloudStorageBuilder};
12
use oxy_core::strata::{Error, Result};
13
14
pub const HINT: &str = "run `gcloud auth application-default login`, or set GOOGLE_APPLICATION_CREDENTIALS (or add ?credentials=PATH to the remote URL) to a service account key file";
15
16
/// Whether a credentials file is a service account key, as opposed to
17
/// application default credentials.
18
fn is_service_account_key(path: &str) -> bool {
19
    std::fs::read_to_string(path)
20
        .ok()
21
        .and_then(|t| serde_json::from_str::<serde_json::Value>(&t).ok())
22
        .and_then(|v| {
23
            v.get("type")
24
                .and_then(|t| t.as_str())
25
                .map(|t| t == "service_account")
26
        })
27
        .unwrap_or(false)
28
}
29
30
/// With `key` (a service account key's JSON) given, only it is used.
31
pub fn open(url: &StoreUrl, key: Option<&str>) -> Result<GoogleCloudStorage> {
32
    if let Some(key) = key {
33
        let mut b = GoogleCloudStorageBuilder::new()
34
            .with_bucket_name(&url.host)
35
            .with_http_connector(crate::http::UreqConnector)
36
            .with_service_account_key(key);
37
        if let Some(endpoint) = url.param("endpoint") {
38
            b = b.with_base_url(endpoint);
39
        }
40
        return b
41
            .build()
42
            .map_err(|e| Error::Backend(format!("{}: {e}", url.plain())));
43
    }
44
    let mut b = GoogleCloudStorageBuilder::from_env()
45
        .with_bucket_name(&url.host)
46
        .with_http_connector(crate::http::UreqConnector);
47
    let file = url.param("credentials").map(str::to_string).or_else(|| {
48
        std::env::var("GOOGLE_APPLICATION_CREDENTIALS")
49
            .ok()
50
            .filter(|v| !v.is_empty())
51
    });
52
    if let Some(path) = file {
53
        if !std::path::Path::new(&path).is_file() {
54
            return Err(Error::Backend(format!(
55
                "{}: the credentials file {path} does not exist: {HINT}",
56
                url.plain()
57
            )));
58
        }
59
        b = if is_service_account_key(&path) {
60
            b.with_service_account_path(path)
61
        } else {
62
            b.with_application_credentials(path)
63
        };
64
    }
65
    if let Some(endpoint) = url.param("endpoint") {
66
        b = b.with_base_url(endpoint);
67
    }
68
    b.build()
69
        .map_err(|e| Error::Backend(format!("{}: {e}: {HINT}", url.plain())))
70
}