gcp-lite-rs 0.1.1

Lightweight HTTP client for Google Cloud Platform APIs
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
//! Workload Identity Federation credential implementation.

use async_trait::async_trait;
use std::sync::Arc;

use crate::auth::external_account::{
    ExternalAccountConfig, ExternalAccountError, extract_sa_email,
};
use crate::auth::oidc_providers::{
    AwsWebIdentityProvider, AzureWorkloadIdentityProvider, GitHubActionsProvider, OidcError,
    OidcTokenProvider, auto_detect_provider,
};
use crate::token::{TokenError, TokenProvider};
use std::path::Path;

/// Errors specific to Workload Identity Federation.
#[derive(Debug, thiserror::Error)]
pub enum WifError {
    /// OIDC provider error.
    #[error("OIDC error: {0}")]
    Oidc(#[from] OidcError),

    /// Missing environment variable.
    #[error("Environment variable missing: {0}")]
    MissingEnvVar(String),

    /// Invalid audience format.
    #[error("Invalid audience format: {0}")]
    InvalidAudience(String),
}

/// Workload Identity Federation credential.
///
/// Authenticates using OIDC tokens from GitHub Actions, AWS, or Azure,
/// exchanging them for GCP access tokens via Workload Identity Federation.
pub struct WorkloadIdentityCredential {
    oidc_provider: Box<dyn OidcTokenProvider>,
    /// Workload Identity Pool audience URL.
    pub(crate) audience: String,
    /// Service account email to impersonate.
    pub(crate) service_account_email: String,
    http_client: Arc<reqwest::Client>,
    sts_endpoint: Option<String>,
    impersonation_endpoint: Option<String>,
}

impl WorkloadIdentityCredential {
    /// Create a new Workload Identity credential.
    ///
    /// # Arguments
    ///
    /// * `oidc_provider` - Provider for fetching OIDC tokens
    /// * `audience` - Workload Identity Pool audience URL
    /// * `service_account_email` - Service account to impersonate
    pub fn new(
        oidc_provider: Box<dyn OidcTokenProvider>,
        audience: String,
        service_account_email: String,
    ) -> Self {
        Self {
            oidc_provider,
            audience,
            service_account_email,
            http_client: Arc::new(reqwest::Client::new()),
            sts_endpoint: None,
            impersonation_endpoint: None,
        }
    }

    /// Exchange OIDC token for STS token.
    ///
    /// # Arguments
    ///
    /// * `oidc_token` - OIDC token from provider
    ///
    /// # Errors
    ///
    /// Returns an error if the STS exchange fails.
    pub async fn exchange_sts_token(&self, oidc_token: &str) -> Result<String, TokenError> {
        let endpoint = self
            .sts_endpoint
            .as_deref()
            .unwrap_or("https://sts.googleapis.com/v1/token");

        let body = serde_json::json!({
            "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
            "audience": self.audience,
            "scope": "https://www.googleapis.com/auth/cloud-platform",
            "requested_token_type": "urn:ietf:params:oauth:token-type:access_token",
            "subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
            "subject_token": oidc_token,
        });

        let response = self
            .http_client
            .post(endpoint)
            .json(&body)
            .send()
            .await
            .map_err(|e| TokenError::RefreshFailed {
                message: format!("STS token exchange failed: {}", e),
            })?;

        let json: serde_json::Value =
            response
                .json()
                .await
                .map_err(|e| TokenError::InvalidCredentials {
                    message: format!("Failed to parse STS response: {}", e),
                })?;

        json["access_token"]
            .as_str()
            .ok_or(TokenError::InvalidCredentials {
                message: "No access_token in STS response".into(),
            })
            .map(String::from)
    }

    /// Impersonate service account with STS token.
    ///
    /// # Arguments
    ///
    /// * `sts_token` - STS token from exchange
    /// * `scopes` - OAuth scopes to request
    ///
    /// # Errors
    ///
    /// Returns an error if impersonation fails.
    pub async fn impersonate_service_account(
        &self,
        sts_token: &str,
        scopes: &[&str],
    ) -> Result<String, TokenError> {
        let base_url = self
            .impersonation_endpoint
            .as_deref()
            .unwrap_or("https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/");

        let url = format!(
            "{}{}:generateAccessToken",
            base_url, self.service_account_email
        );

        let body = serde_json::json!({
            "scope": scopes,
            "lifetime": "3600s",
        });

        let response = self
            .http_client
            .post(&url)
            .bearer_auth(sts_token)
            .json(&body)
            .send()
            .await
            .map_err(|e| TokenError::RefreshFailed {
                message: format!("Service account impersonation failed: {}", e),
            })?;

        let json: serde_json::Value =
            response
                .json()
                .await
                .map_err(|e| TokenError::InvalidCredentials {
                    message: format!("Failed to parse impersonation response: {}", e),
                })?;

        json["accessToken"]
            .as_str()
            .ok_or(TokenError::InvalidCredentials {
                message: "No accessToken in impersonation response".into(),
            })
            .map(String::from)
    }

    /// Get OIDC token from provider (exposed for advanced use).
    ///
    /// # Errors
    ///
    /// Returns an error if OIDC token fetch fails.
    pub async fn get_oidc_token(&self) -> Result<String, OidcError> {
        self.oidc_provider.get_token().await
    }

    /// Create from environment variables.
    ///
    /// Detects OIDC provider automatically and builds credential.
    ///
    /// # Environment Variables
    ///
    /// - `GCP_WORKLOAD_IDENTITY_AUDIENCE` or `GCP_PROJECT_NUMBER` + `GCP_WORKLOAD_IDENTITY_POOL_ID` + `GCP_WORKLOAD_IDENTITY_PROVIDER_ID`
    /// - `GCP_SERVICE_ACCOUNT_EMAIL`
    /// - Provider-specific vars (see individual providers)
    ///
    /// # Errors
    ///
    /// Returns an error if required environment variables are missing or provider detection fails.
    pub fn from_environment() -> Result<Self, WifError> {
        let audience = std::env::var("GCP_WORKLOAD_IDENTITY_AUDIENCE")
            .or_else(|_| build_audience_from_parts())?;

        let service_account_email = std::env::var("GCP_SERVICE_ACCOUNT_EMAIL")
            .map_err(|_| WifError::MissingEnvVar("GCP_SERVICE_ACCOUNT_EMAIL".into()))?;

        let provider = auto_detect_provider()?;

        Ok(Self::new(provider, audience, service_account_email))
    }

    /// Create from external account JSON string.
    ///
    /// # Arguments
    ///
    /// * `json` - External account JSON configuration
    ///
    /// # Errors
    ///
    /// Returns an error if JSON is invalid or provider cannot be created.
    pub fn from_json(json: &str) -> Result<Self, ExternalAccountError> {
        let config: ExternalAccountConfig = serde_json::from_str(json)?;

        if config.credential_type != "external_account" {
            return Err(ExternalAccountError::UnsupportedType(
                config.credential_type,
            ));
        }

        // Determine provider from credential_source
        let provider: Box<dyn OidcTokenProvider> =
            if let Some(env_id) = &config.credential_source.environment_id {
                match env_id.as_str() {
                    "github" => Box::new(GitHubActionsProvider::new()?),
                    "aws1" => Box::new(AwsWebIdentityProvider::from_env()?),
                    "azure" => Box::new(AzureWorkloadIdentityProvider::new()?),
                    _ => return Err(ExternalAccountError::UnsupportedEnvironment(env_id.clone())),
                }
            } else if let Some(_file_path) = &config.credential_source.file {
                // TODO: Implement FileTokenProvider if needed
                return Err(ExternalAccountError::MissingCredentialSource);
            } else {
                return Err(ExternalAccountError::MissingCredentialSource);
            };

        // Extract service account email from impersonation URL
        let impersonation_url = config
            .service_account_impersonation_url
            .ok_or(ExternalAccountError::MissingImpersonationUrl)?;
        let sa_email = extract_sa_email(&impersonation_url)?;

        Ok(Self::new(provider, config.audience, sa_email))
    }

    /// Create from external account JSON file.
    ///
    /// # Arguments
    ///
    /// * `path` - Path to external account JSON file
    ///
    /// # Errors
    ///
    /// Returns an error if file cannot be read or JSON is invalid.
    pub fn from_file(path: &Path) -> Result<Self, ExternalAccountError> {
        let json = std::fs::read_to_string(path)
            .map_err(|e| ExternalAccountError::InvalidJson(serde_json::Error::io(e)))?;
        Self::from_json(&json)
    }
}

fn build_audience_from_parts() -> Result<String, WifError> {
    let project = std::env::var("GCP_PROJECT_NUMBER").map_err(|_| {
        WifError::MissingEnvVar("GCP_PROJECT_NUMBER or GCP_WORKLOAD_IDENTITY_AUDIENCE".into())
    })?;
    let pool = std::env::var("GCP_WORKLOAD_IDENTITY_POOL_ID")
        .map_err(|_| WifError::MissingEnvVar("GCP_WORKLOAD_IDENTITY_POOL_ID".into()))?;
    let provider = std::env::var("GCP_WORKLOAD_IDENTITY_PROVIDER_ID")
        .map_err(|_| WifError::MissingEnvVar("GCP_WORKLOAD_IDENTITY_PROVIDER_ID".into()))?;

    Ok(format!(
        "//iam.googleapis.com/projects/{}/locations/global/workloadIdentityPools/{}/providers/{}",
        project, pool, provider
    ))
}

#[async_trait]
impl TokenProvider for WorkloadIdentityCredential {
    async fn get_token(&self, scopes: &[&str]) -> Result<String, TokenError> {
        // Step 1: Get OIDC token
        let oidc_token =
            self.oidc_provider
                .get_token()
                .await
                .map_err(|e| TokenError::RefreshFailed {
                    message: format!("OIDC token fetch failed: {}", e),
                })?;

        // Step 2: Exchange for STS token
        let sts_token = self.exchange_sts_token(&oidc_token).await?;

        // Step 3: Impersonate service account
        let sa_token = self.impersonate_service_account(&sts_token, scopes).await?;

        Ok(sa_token)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use async_trait::async_trait;
    use serial_test::serial;
    use wiremock::matchers::{body_json, method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    struct MockOidcProvider(String);

    #[async_trait]
    impl OidcTokenProvider for MockOidcProvider {
        async fn get_token(&self) -> Result<String, OidcError> {
            Ok(self.0.clone())
        }
    }

    #[test]
    fn test_workload_identity_credential_new() {
        let provider = Box::new(MockOidcProvider("mock-oidc-token".into()));
        let cred = WorkloadIdentityCredential::new(
            provider,
            "//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/pool/providers/provider".into(),
            "sa@project.iam.gserviceaccount.com".into(),
        );

        assert_eq!(
            cred.audience,
            "//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/pool/providers/provider"
        );
        assert_eq!(
            cred.service_account_email,
            "sa@project.iam.gserviceaccount.com"
        );
    }

    #[tokio::test]
    async fn test_exchange_sts_token_success() {
        let mock_server = MockServer::start().await;

        Mock::given(method("POST"))
            .and(path("/v1/token"))
            .and(body_json(serde_json::json!({
                "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
                "audience": "//iam.googleapis.com/test-audience",
                "scope": "https://www.googleapis.com/auth/cloud-platform",
                "requested_token_type": "urn:ietf:params:oauth:token-type:access_token",
                "subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
                "subject_token": "mock-oidc-token",
            })))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "access_token": "mock-sts-token",
                "expires_in": 3600,
            })))
            .mount(&mock_server)
            .await;

        let provider = Box::new(MockOidcProvider("mock-oidc-token".into()));
        let mut cred = WorkloadIdentityCredential::new(
            provider,
            "//iam.googleapis.com/test-audience".into(),
            "sa@project.iam.gserviceaccount.com".into(),
        );
        cred.sts_endpoint = Some(format!("{}/v1/token", mock_server.uri()));

        let sts_token = cred.exchange_sts_token("mock-oidc-token").await.unwrap();
        assert_eq!(sts_token, "mock-sts-token");
    }

    #[tokio::test]
    async fn test_impersonate_service_account_success() {
        use wiremock::matchers::{bearer_token, path};

        let mock_server = MockServer::start().await;

        Mock::given(method("POST"))
            .and(path(
                "/v1/projects/-/serviceAccounts/sa@project.iam.gserviceaccount.com:generateAccessToken",
            ))
            .and(bearer_token("mock-sts-token"))
            .and(body_json(serde_json::json!({
                "scope": ["https://www.googleapis.com/auth/cloud-platform"],
                "lifetime": "3600s",
            })))
            .respond_with(
                ResponseTemplate::new(200).set_body_json(serde_json::json!({
                    "accessToken": "mock-sa-token",
                })),
            )
            .mount(&mock_server)
            .await;

        let provider = Box::new(MockOidcProvider("mock-oidc-token".into()));
        let mut cred = WorkloadIdentityCredential::new(
            provider,
            "//iam.googleapis.com/test-audience".into(),
            "sa@project.iam.gserviceaccount.com".into(),
        );
        cred.impersonation_endpoint = Some(format!(
            "{}/v1/projects/-/serviceAccounts/",
            mock_server.uri()
        ));

        let sa_token = cred
            .impersonate_service_account(
                "mock-sts-token",
                &["https://www.googleapis.com/auth/cloud-platform"],
            )
            .await
            .unwrap();

        assert_eq!(sa_token, "mock-sa-token");
    }

    #[tokio::test]
    async fn test_get_token_full_flow() {
        use wiremock::matchers::path_regex;

        let mock_server = MockServer::start().await;

        // Mock STS endpoint
        Mock::given(method("POST"))
            .and(path("/v1/token"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "access_token": "mock-sts-token",
                "expires_in": 3600,
            })))
            .mount(&mock_server)
            .await;

        // Mock impersonation endpoint
        Mock::given(method("POST"))
            .and(path_regex(
                r"/v1/projects/-/serviceAccounts/.*:generateAccessToken",
            ))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "accessToken": "final-access-token",
            })))
            .mount(&mock_server)
            .await;

        let provider = Box::new(MockOidcProvider("mock-oidc-token".into()));
        let mut cred = WorkloadIdentityCredential::new(
            provider,
            "//iam.googleapis.com/test-audience".into(),
            "sa@project.iam.gserviceaccount.com".into(),
        );
        cred.sts_endpoint = Some(format!("{}/v1/token", mock_server.uri()));
        cred.impersonation_endpoint = Some(format!(
            "{}/v1/projects/-/serviceAccounts/",
            mock_server.uri()
        ));

        let token = cred
            .get_token(&["https://www.googleapis.com/auth/cloud-platform"])
            .await
            .unwrap();

        assert_eq!(token, "final-access-token");
    }

    #[test]
    #[serial]
    fn test_from_environment_with_full_audience() {
        // SAFETY: Test is single-threaded for env vars
        unsafe {
            std::env::set_var(
                "GCP_WORKLOAD_IDENTITY_AUDIENCE",
                "//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/pool/providers/provider",
            );
            std::env::set_var(
                "GCP_SERVICE_ACCOUNT_EMAIL",
                "sa@project.iam.gserviceaccount.com",
            );
            std::env::set_var("ACTIONS_ID_TOKEN_REQUEST_TOKEN", "token");
            std::env::set_var("ACTIONS_ID_TOKEN_REQUEST_URL", "http://localhost");
        }

        let cred = WorkloadIdentityCredential::from_environment().unwrap();
        assert_eq!(
            cred.audience,
            "//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/pool/providers/provider"
        );
        assert_eq!(
            cred.service_account_email,
            "sa@project.iam.gserviceaccount.com"
        );

        // SAFETY: Test cleanup
        unsafe {
            std::env::remove_var("GCP_WORKLOAD_IDENTITY_AUDIENCE");
            std::env::remove_var("GCP_SERVICE_ACCOUNT_EMAIL");
            std::env::remove_var("ACTIONS_ID_TOKEN_REQUEST_TOKEN");
            std::env::remove_var("ACTIONS_ID_TOKEN_REQUEST_URL");
        }
    }

    #[test]
    #[serial]
    fn test_from_environment_build_audience_from_parts() {
        // SAFETY: Test is single-threaded for env vars
        unsafe {
            std::env::remove_var("GCP_WORKLOAD_IDENTITY_AUDIENCE");
            std::env::set_var("GCP_PROJECT_NUMBER", "123");
            std::env::set_var("GCP_WORKLOAD_IDENTITY_POOL_ID", "my-pool");
            std::env::set_var("GCP_WORKLOAD_IDENTITY_PROVIDER_ID", "github-provider");
            std::env::set_var(
                "GCP_SERVICE_ACCOUNT_EMAIL",
                "sa@project.iam.gserviceaccount.com",
            );
            std::env::set_var("ACTIONS_ID_TOKEN_REQUEST_TOKEN", "token");
            std::env::set_var("ACTIONS_ID_TOKEN_REQUEST_URL", "http://localhost");
        }

        let cred = WorkloadIdentityCredential::from_environment().unwrap();
        assert_eq!(
            cred.audience,
            "//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/github-provider"
        );

        // SAFETY: Test cleanup
        unsafe {
            std::env::remove_var("GCP_PROJECT_NUMBER");
            std::env::remove_var("GCP_WORKLOAD_IDENTITY_POOL_ID");
            std::env::remove_var("GCP_WORKLOAD_IDENTITY_PROVIDER_ID");
            std::env::remove_var("GCP_SERVICE_ACCOUNT_EMAIL");
            std::env::remove_var("ACTIONS_ID_TOKEN_REQUEST_TOKEN");
            std::env::remove_var("ACTIONS_ID_TOKEN_REQUEST_URL");
        }
    }

    #[test]
    #[serial]
    fn test_from_json_github() {
        let json = r#"{
            "type": "external_account",
            "audience": "//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/pool/providers/provider",
            "subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
            "token_url": "https://sts.googleapis.com/v1/token",
            "credential_source": {
                "environment_id": "github"
            },
            "service_account_impersonation_url": "https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/sa@project.iam.gserviceaccount.com:generateAccessToken"
        }"#;

        // SAFETY: Test is single-threaded for env vars
        unsafe {
            std::env::set_var("ACTIONS_ID_TOKEN_REQUEST_TOKEN", "token");
            std::env::set_var("ACTIONS_ID_TOKEN_REQUEST_URL", "http://localhost");
        }

        let cred = WorkloadIdentityCredential::from_json(json).unwrap();
        assert_eq!(
            cred.audience,
            "//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/pool/providers/provider"
        );
        assert_eq!(
            cred.service_account_email,
            "sa@project.iam.gserviceaccount.com"
        );

        // SAFETY: Test cleanup
        unsafe {
            std::env::remove_var("ACTIONS_ID_TOKEN_REQUEST_TOKEN");
            std::env::remove_var("ACTIONS_ID_TOKEN_REQUEST_URL");
        }
    }
}