merka-vault 0.3.2

Vault provisioning and management crate integrating with merka-core
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
//! Transit secrets engine operations for Vault.
//!
//! This module provides functions for managing the transit secrets engine,
//! which is used for encryption/decryption operations and is a key component
//! for auto-unseal functionality.

use crate::vault::{VaultClient, VaultError};
use serde::{Deserialize, Serialize};
use serde_json::{json, Value};
use tracing::{info, warn};

/// Response structure for token creation
#[derive(Debug, Serialize, Deserialize)]
struct TokenResponse {
    request_id: String,
    lease_id: String,
    renewable: bool,
    lease_duration: u64,
    auth: TokenAuth,
}

/// Auth section of token response
#[derive(Debug, Serialize, Deserialize)]
struct TokenAuth {
    client_token: String,
    accessor: String,
    policies: Vec<String>,
    token_policies: Vec<String>,
    metadata: Option<serde_json::Map<String, Value>>,
    renewable: bool,
    lease_duration: u64,
}

/// Wrapped token response structure
#[derive(Debug, Serialize, Deserialize)]
struct WrappedResponse {
    request_id: String,
    wrap_info: WrapInfo,
}

/// Wrap info section
#[derive(Debug, Serialize, Deserialize)]
struct WrapInfo {
    token: String,
    ttl: u64,
    creation_time: String,
    creation_path: String,
}

/// Sets up the transit secrets engine at the default path.
///
/// # Arguments
///
/// * `vault_addr` - The address of the Vault server
/// * `token` - The authentication token to use
///
/// # Returns
///
/// A Result indicating success or failure
pub async fn setup_transit_engine(vault_addr: &str, token: &str) -> Result<(), VaultError> {
    let client = VaultClient::new(vault_addr, token)?;

    // Try to enable the transit secrets engine
    let response = client
        .post_with_body(
            "/v1/sys/mounts/transit",
            json!({
                "type": "transit"
            }),
        )
        .await;

    // Handle specific error cases - it's OK if transit is already enabled
    match response {
        Ok(_) => Ok(()),
        Err(VaultError::HttpStatus(_status, error_text))
            if error_text.contains("path is already in use") =>
        {
            info!("Transit engine already enabled, continuing");
            Ok(())
        }
        Err(e) => {
            warn!("Failed to enable transit engine: {}", e);
            Err(e)
        }
    }
}

/// Creates a new encryption key in the transit engine.
///
/// # Arguments
///
/// * `vault_addr` - The address of the Vault server
/// * `token` - The authentication token to use
/// * `key_name` - The name of the key to create
///
/// # Returns
///
/// A Result indicating success or failure
pub async fn create_transit_key(
    vault_addr: &str,
    token: &str,
    key_name: &str,
) -> Result<(), VaultError> {
    let client = VaultClient::new(vault_addr, token)?;

    // Try to create a new encryption key
    let response = client
        .put_with_body(
            &format!("/v1/transit/keys/{}", key_name),
            json!({
                "derived": false,
                "exportable": false
            }),
        )
        .await;

    // Handle specific error cases - it's OK if key already exists
    match response {
        Ok(_) => Ok(()),
        Err(VaultError::HttpStatus(_status, error_text))
            if error_text.contains("already exists") =>
        {
            info!("Transit key '{}' already exists, continuing", key_name);
            Ok(())
        }
        Err(e) => {
            warn!("Failed to create transit key '{}': {}", key_name, e);
            Err(e)
        }
    }
}

/// Creates a policy for transit-based auto-unseal.
///
/// # Arguments
///
/// * `vault_addr` - The address of the Vault server
/// * `token` - The authentication token to use
/// * `policy_name` - The name of the policy to create
/// * `key_name` - The name of the transit key to use
///
/// # Returns
///
/// A Result indicating success or failure
pub async fn create_transit_unseal_policy(
    vault_addr: &str,
    token: &str,
    policy_name: &str,
    key_name: &str,
) -> Result<(), VaultError> {
    let client = VaultClient::new(vault_addr, token)?;

    // Create minimal policy for transit key usage
    let policy_hcl = format!(
        r#"
        # Allow token creation
        path "auth/token/create" {{
            capabilities = ["update"]
        }}

        # Allow encryption operations with the key
        path "transit/encrypt/{}" {{
            capabilities = ["update"]
        }}

        # Allow decryption operations with the key
        path "transit/decrypt/{}" {{
            capabilities = ["update"]
        }}
        "#,
        key_name, key_name
    );

    // Attempt to put the policy
    let response = client
        .put_with_body(
            &format!("/v1/sys/policies/acl/{}", policy_name),
            json!({
                "policy": policy_hcl,
            }),
        )
        .await;

    // Handle specific error cases - for policies we generally want to overwrite
    // but we'll log if there were issues
    match response {
        Ok(_) => {
            info!("Created/updated auto-unseal policy: {}", policy_name);
            Ok(())
        }
        Err(e) => {
            warn!("Failed to create/update policy '{}': {}", policy_name, e);
            Err(e)
        }
    }
}

/// Generates a token with transit unseal policy attached.
///
/// # Arguments
///
/// * `vault_addr` - The address of the Vault server
/// * `token` - The authentication token to use
/// * `policy_name` - The name of the policy to attach to the token
///
/// # Returns
///
/// A Result containing the generated token or an error
#[cfg(any(test, feature = "full-api"))]
pub async fn generate_transit_unseal_token(
    vault_addr: &str,
    token: &str,
    policy_name: &str,
) -> Result<String, VaultError> {
    let client = VaultClient::new(vault_addr, token)?;

    let response = client
        .post_with_body(
            "/v1/auth/token/create",
            json!({
                "policies": [policy_name],
                "ttl": "768h",  // Default 32 days TTL
                "display_name": "transit-unseal-token",
                "renewable": true
            }),
        )
        .await?;

    // Extract client token directly from the response value
    let client_token = response
        .get("auth")
        .and_then(|auth| auth.get("client_token"))
        .and_then(|token| token.as_str())
        .ok_or_else(|| VaultError::Api("Failed to extract client token".to_string()))?;

    Ok(client_token.to_string())
}

/// Generates a wrapped token with transit unseal policy attached.
///
/// # Arguments
///
/// * `vault_addr` - The address of the Vault server
/// * `token` - The authentication token to use
/// * `policy_name` - The name of the policy to attach to the token
/// * `wrap_ttl` - The TTL for the response-wrapped token (e.g., "60s", "30m", "1h")
///
/// # Returns
///
/// A Result containing the wrapped token information or an error
pub async fn generate_wrapped_transit_token(
    vault_addr: &str,
    token: &str,
    policy_name: &str,
    wrap_ttl: &str,
) -> Result<String, VaultError> {
    let mut client = VaultClient::new(vault_addr, token)?;

    // Add wrapping header
    client.add_header("X-Vault-Wrap-TTL", wrap_ttl);

    let response = client
        .post_with_body(
            "/v1/auth/token/create-orphan",
            json!({
                "policies": [policy_name],
                "period": "24h",
                "display_name": "transit-unseal-token",
                "renewable": true
            }),
        )
        .await?;

    // Extract the wrapped token directly from the response value
    let wrapped_token = response
        .get("wrap_info")
        .and_then(|wrap| wrap.get("token"))
        .and_then(|token| token.as_str())
        .ok_or_else(|| VaultError::Api("Failed to extract wrapped token".to_string()))?;

    Ok(wrapped_token.to_string())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::init_logging;

    use crate::vault::status::get_vault_status;
    use crate::vault::test_utils::{setup_vault_container, wait_for_vault_ready, VaultMode};

    use tracing::info;

    // Test for transit engine setup error handling with invalid token
    #[tokio::test]
    async fn test_transit_invalid_token() -> Result<(), Box<dyn std::error::Error>> {
        // Any invalid address/token combination will cause an error
        let invalid_token = "invalid-token";
        let result = setup_transit_engine("http://127.0.0.1:8200", invalid_token).await;

        assert!(result.is_err(), "Expected error with invalid token");

        // Error could be Connection/Network if Vault isn't running or HttpStatus if it is
        match result {
            Err(VaultError::HttpStatus(status_code, _)) => {
                assert_eq!(
                    status_code, 403,
                    "Expected 403 Forbidden with invalid token"
                );
            }
            Err(VaultError::Connection(_)) => {
                // This is fine too - means Vault server not running
                println!(
                    "Connection error (Vault not running) - this is expected in standalone tests"
                );
            }
            Err(VaultError::Network(_)) => {
                // This is also fine - means Vault server not running
                println!(
                    "Network error (Vault not running) - this is expected in standalone tests"
                );
            }
            _ => {
                panic!(
                    "Expected VaultError::HttpStatus, VaultError::Connection, or VaultError::Network, got {:?}",
                    result
                );
            }
        }

        Ok(())
    }

    /// Tests the complete transit setup process using a dev Vault instance.
    /// This test verifies that we can:
    /// - Set up a transit engine
    /// - Create a transit key
    /// - Create a transit policy for auto-unseal
    /// - Generate a transit token
    /// - Generate a wrapped transit token
    #[tokio::test]
    async fn test_transit_setup() -> Result<(), Box<dyn std::error::Error>> {
        init_logging();

        let vault_container = setup_vault_container(VaultMode::Dev).await;
        let host = vault_container.get_host().await.unwrap();
        let host_port = vault_container.get_host_port_ipv4(8200).await.unwrap();
        let vault_url = format!("http://{}:{}", host, host_port);

        wait_for_vault_ready(&vault_url, 10, 1000)
            .await
            .map_err(|e| e.to_string())?;

        // In dev mode, the root token is "root"
        let root_token = "root".to_string();

        // 1. Test setting up transit engine
        info!("Setting up transit engine");
        setup_transit_engine(&vault_url, &root_token).await?;
        info!("Transit engine setup successful");

        // 2. Test creating transit key
        let key_name = "test-key";
        info!("Creating transit key: {}", key_name);
        create_transit_key(&vault_url, &root_token, key_name).await?;
        info!("Created transit key: {}", key_name);

        // 3. Test creating transit policy
        let policy_name = "test-policy";
        info!("Creating transit policy: {}", policy_name);
        create_transit_unseal_policy(&vault_url, &root_token, policy_name, key_name).await?;

        // 4. Test generating transit token
        info!("Generating transit token");
        let token = generate_transit_unseal_token(&vault_url, &root_token, policy_name).await?;
        info!("Generated transit token: {}", token);
        assert!(!token.is_empty(), "Token should not be empty");

        // 5. Test generating wrapped transit token
        info!("Generating wrapped transit token");
        let wrapped_token = generate_wrapped_transit_token(
            &vault_url,
            &root_token,
            policy_name,
            "60s", // 60 second TTL
        )
        .await?;
        info!("Generated wrapped transit token");
        assert!(
            !wrapped_token.is_empty(),
            "Wrapped token should not be empty"
        );

        // Verify all steps completed successfully
        assert!(!token.is_empty(), "Transit token should not be empty");
        assert!(
            !wrapped_token.is_empty(),
            "Wrapped transit token should not be empty"
        );

        Ok(())
    }

    // Test using Docker container with auto-configured settings
    // Run with: cargo test -p merka-vault vault::transit::tests::test_transit_with_real_vault
    #[tokio::test]
    async fn test_transit_with_real_vault() -> Result<(), Box<dyn std::error::Error>> {
        init_logging();

        // Set up a test container for Vault in dev mode
        let vault_container = setup_vault_container(VaultMode::Dev).await;
        let port = vault_container.get_host_port_ipv4(8200).await?;
        let vault_addr = format!("http://127.0.0.1:{}", port);

        // Wait for vault to become available
        wait_for_vault_ready(&vault_addr, 10, 500).await?;

        // Check that vault is initialized and unsealed (dev mode default)
        let status = get_vault_status(&vault_addr).await?;
        assert!(
            status.initialized,
            "Vault should be initialized in dev mode"
        );
        assert!(!status.sealed, "Vault should not be sealed in dev mode");

        // In dev mode, the root token is "root"
        let root_token = "root".to_string();

        // 1. Test setting up transit engine
        let setup_result = setup_transit_engine(&vault_addr, &root_token).await;
        assert!(setup_result.is_ok(), "Transit engine setup should succeed");

        // 2. Test creating transit key
        let key_name = "test-key";
        let create_key_result = create_transit_key(&vault_addr, &root_token, key_name).await;
        assert!(
            create_key_result.is_ok(),
            "Transit key creation should succeed"
        );

        // 3. Test creating transit policy
        let policy_name = "test-policy";
        let create_policy_result =
            create_transit_unseal_policy(&vault_addr, &root_token, policy_name, key_name).await;
        assert!(
            create_policy_result.is_ok(),
            "Transit policy creation should succeed"
        );

        // 4. Test generating transit token
        let token_result =
            generate_transit_unseal_token(&vault_addr, &root_token, policy_name).await;
        assert!(
            token_result.is_ok(),
            "Transit token generation should succeed"
        );

        let token = token_result.unwrap();
        assert!(!token.is_empty(), "Token should not be empty");

        // 5. Test generating wrapped transit token
        let wrapped_token_result = generate_wrapped_transit_token(
            &vault_addr,
            &root_token,
            policy_name,
            "60s", // 60 second TTL
        )
        .await;
        assert!(
            wrapped_token_result.is_ok(),
            "Wrapped transit token generation should succeed"
        );

        let wrapped_token = wrapped_token_result.unwrap();
        assert!(
            !wrapped_token.is_empty(),
            "Wrapped token should not be empty"
        );

        Ok(())
    }
}