vault-client-rs 0.8.0

A Rust client for the HashiCorp Vault HTTP API
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

use std::fmt;

use secrecy::{ExposeSecret, SecretString};
use serde::{Deserialize, Serialize};
use zeroize::{Zeroize, ZeroizeOnDrop};

use super::redaction::redact;

#[derive(Debug, Serialize, Default, Zeroize, ZeroizeOnDrop)]
pub struct TotpKeyRequest {
    pub generate: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exported: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub key_size: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
    #[serde(
        serialize_with = "super::serde_secret::serialize_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub key: Option<SecretString>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub issuer: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub account_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub period: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub algorithm: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub digits: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub skew: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub qr_size: Option<u32>,
}

impl Clone for TotpKeyRequest {
    fn clone(&self) -> Self {
        Self {
            generate: self.generate,
            exported: self.exported,
            key_size: self.key_size,
            url: self.url.clone(),
            key: self.key.clone(),
            issuer: self.issuer.clone(),
            account_name: self.account_name.clone(),
            period: self.period,
            algorithm: self.algorithm.clone(),
            digits: self.digits,
            skew: self.skew,
            qr_size: self.qr_size,
        }
    }
}

#[derive(Debug, Deserialize, Clone)]
#[non_exhaustive]
pub struct TotpKeyInfo {
    #[serde(default)]
    pub account_name: String,
    #[serde(default)]
    pub algorithm: String,
    #[serde(default)]
    pub digits: u32,
    #[serde(default)]
    pub issuer: String,
    #[serde(default)]
    pub period: u32,
}

#[derive(Deserialize, Zeroize, ZeroizeOnDrop)]
#[non_exhaustive]
pub struct TotpGenerateResponse {
    pub barcode: Option<SecretString>,
    pub url: Option<SecretString>,
}

impl Clone for TotpGenerateResponse {
    fn clone(&self) -> Self {
        Self {
            barcode: self.barcode.clone(),
            url: self.url.clone(),
        }
    }
}

impl fmt::Debug for TotpGenerateResponse {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("TotpGenerateResponse")
            .field(
                "barcode",
                &self.barcode.as_ref().map(|s| redact(s.expose_secret())),
            )
            .field("url", &self.url.as_ref().map(|s| redact(s.expose_secret())))
            .finish()
    }
}

#[derive(Deserialize, Zeroize, ZeroizeOnDrop)]
#[non_exhaustive]
pub struct TotpCode {
    pub code: SecretString,
}

impl Clone for TotpCode {
    fn clone(&self) -> Self {
        Self {
            code: self.code.clone(),
        }
    }
}

impl From<SecretString> for TotpCode {
    fn from(code: SecretString) -> Self {
        Self { code }
    }
}

impl From<&str> for TotpCode {
    fn from(code: &str) -> Self {
        Self {
            code: SecretString::from(code.to_owned()),
        }
    }
}

impl fmt::Debug for TotpCode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("TotpCode")
            .field("code", &redact(self.code.expose_secret()))
            .finish()
    }
}

#[derive(Debug, Deserialize, Clone)]
#[non_exhaustive]
pub struct TotpValidation {
    pub valid: bool,
}