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
#![allow(unused_imports)]
#![allow(dead_code)]
use crate::error::GoogleResponse;
/// The `HmacKey` resource represents an HMAC key within Cloud Storage. The resource consists of a
/// secret and `HmacMeta`. HMAC keys can be used as credentials for service accounts. For more
/// information, see HMAC Keys.
///
/// Note that the `HmacKey` resource is only returned when you use `HmacKey::create`. Other
/// methods, such as `HmacKey::read`, return the metadata portion of the HMAC key resource.
#[derive(Debug, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct HmacKey {
/// The kind of item this is. For HMAC keys, this is always `storage#hmacKey`.
pub kind: String,
/// HMAC key metadata.
pub metadata: HmacMeta,
/// HMAC secret key material.
pub secret: String,
}
/// Contains information about an Hmac Key.
#[derive(Debug, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct HmacMeta {
/// The kind of item this is. For HMAC key metadata, this is always `storage#hmacKeyMetadata`.
pub kind: String,
/// The ID of the HMAC key, including the Project ID and the Access ID.
pub id: String,
/// The link to this resource.
pub self_link: String,
/// The access ID of the HMAC Key.
pub access_id: String,
/// The Project ID of the project that owns the service account to which the key authenticates.
pub project_id: String,
/// The email address of the key's associated service account.
pub service_account_email: String,
/// The state of the key.
pub state: HmacState,
/// The creation time of the HMAC key.
pub time_created: chrono::DateTime<chrono::Utc>,
/// The last modification time of the HMAC key metadata.
pub updated: chrono::DateTime<chrono::Utc>,
/// HTTP 1.1 Entity tag for the HMAC key.
pub etag: String,
}
/// The state of an Hmac Key.
#[derive(Debug, Clone, Copy, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "UPPERCASE")]
pub enum HmacState {
/// This Hmac key is currently used.
Active,
/// This Hmac key has been set to inactive.
Inactive,
/// This Hmac key has been permanently deleted.
Deleted,
}
#[derive(Debug, serde::Deserialize)]
pub(crate) struct ListResponse {
pub(crate) items: Vec<HmacMeta>,
}
#[derive(serde::Serialize)]
struct UpdateRequest {
secret: String,
metadata: UpdateMeta,
}
#[derive(serde::Serialize)]
pub(crate) struct UpdateMeta {
pub(crate) state: HmacState,
}
impl HmacKey {
/// Creates a new HMAC key for the specified service account.
///
/// The authenticated user must have `storage.hmacKeys.create` permission for the project in
/// which the key will be created.
///
/// For general information about HMAC keys in Cloud Storage, see
/// [HMAC Keys](https://cloud.google.com/storage/docs/authentication/hmackeys).
/// ### Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::hmac_key::HmacKey;
///
/// let hmac_key = HmacKey::create().await?;
/// # use cloud_storage::hmac_key::HmacState;
/// # HmacKey::update(&hmac_key.metadata.access_id, HmacState::Inactive).await?;
/// # HmacKey::delete(&hmac_key.metadata.access_id).await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn create() -> crate::Result<Self> {
crate::CLOUD_CLIENT.hmac_key().create().await
}
/// The synchronous equivalent of `HmacKey::create`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn create_sync() -> crate::Result<Self> {
crate::runtime()?.block_on(Self::create())
}
/// Retrieves a list of HMAC keys matching the criteria. Since the HmacKey is secret, this does
/// not return a `HmacKey`, but a `HmacMeta`. This is a redacted version of a `HmacKey`, but
/// with the secret data omitted.
///
/// The authenticated user must have `storage.hmacKeys.list` permission for the project in which
/// the key exists.
///
/// For general information about HMAC keys in Cloud Storage, see
/// [HMAC Keys](https://cloud.google.com/storage/docs/authentication/hmackeys).
/// ### Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::hmac_key::HmacKey;
///
/// let all_hmac_keys = HmacKey::list().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn list() -> crate::Result<Vec<HmacMeta>> {
crate::CLOUD_CLIENT.hmac_key().list().await
}
/// The synchronous equivalent of `HmacKey::list`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn list_sync() -> crate::Result<Vec<HmacMeta>> {
crate::runtime()?.block_on(Self::list())
}
/// Retrieves an HMAC key's metadata. Since the HmacKey is secret, this does not return a
/// `HmacKey`, but a `HmacMeta`. This is a redacted version of a `HmacKey`, but with the secret
/// data omitted.
///
/// The authenticated user must have `storage.hmacKeys.get` permission for the project in which
/// the key exists.
///
/// For general information about HMAC keys in Cloud Storage, see
/// [HMAC Keys](https://cloud.google.com/storage/docs/authentication/hmackeys).
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::hmac_key::HmacKey;
///
/// let key = HmacKey::read("some identifier").await?;
/// # Ok(())
/// # }
#[cfg(feature = "global-client")]
pub async fn read(access_id: &str) -> crate::Result<HmacMeta> {
crate::CLOUD_CLIENT.hmac_key().read(access_id).await
}
/// The synchronous equivalent of `HmacKey::read`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn read_sync(access_id: &str) -> crate::Result<HmacMeta> {
crate::runtime()?.block_on(Self::read(access_id))
}
/// Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.
/// Since the HmacKey is secret, this does not return a `HmacKey`, but a `HmacMeta`. This is a
/// redacted version of a `HmacKey`, but with the secret data omitted.
///
/// The authenticated user must have `storage.hmacKeys.update` permission for the project in
/// which the key exists.
///
/// For general information about HMAC keys in Cloud Storage, see
/// [HMAC Keys](https://cloud.google.com/storage/docs/authentication/hmackeys).
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::hmac_key::{HmacKey, HmacState};
///
/// let key = HmacKey::update("your key", HmacState::Active).await?;
/// # Ok(())
/// # }
#[cfg(feature = "global-client")]
pub async fn update(access_id: &str, state: HmacState) -> crate::Result<HmacMeta> {
crate::CLOUD_CLIENT
.hmac_key()
.update(access_id, state)
.await
}
/// The synchronous equivalent of `HmacKey::update`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn update_sync(access_id: &str, state: HmacState) -> crate::Result<HmacMeta> {
crate::runtime()?.block_on(Self::update(access_id, state))
}
/// Deletes an HMAC key. Note that a key must be set to `Inactive` first.
///
/// The authenticated user must have storage.hmacKeys.delete permission for the project in which
/// the key exists.
///
/// For general information about HMAC keys in Cloud Storage, see
/// [HMAC Keys](https://cloud.google.com/storage/docs/authentication/hmackeys).
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::hmac_key::{HmacKey, HmacState};
///
/// let key = HmacKey::update("your key", HmacState::Inactive).await?; // this is required.
/// HmacKey::delete(&key.access_id).await?;
/// # Ok(())
/// # }
#[cfg(feature = "global-client")]
pub async fn delete(access_id: &str) -> crate::Result<()> {
crate::CLOUD_CLIENT.hmac_key().delete(access_id).await
}
/// The synchronous equivalent of `HmacKey::delete`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn delete_sync(access_id: &str) -> crate::Result<()> {
crate::runtime()?.block_on(Self::delete(access_id))
}
}
#[cfg(all(test, feature = "global-client"))]
mod tests {
use super::*;
async fn get_test_hmac() -> HmacMeta {
match HmacKey::create().await {
Ok(key) => key.metadata,
Err(_) => HmacKey::list().await.unwrap().pop().unwrap(),
}
}
async fn remove_test_hmac(access_id: &str) {
HmacKey::update(access_id, HmacState::Inactive)
.await
.unwrap();
HmacKey::delete(access_id).await.unwrap();
}
#[tokio::test]
async fn create() -> Result<(), Box<dyn std::error::Error>> {
let key = HmacKey::create().await?;
remove_test_hmac(&key.metadata.access_id).await;
Ok(())
}
#[tokio::test]
async fn list() -> Result<(), Box<dyn std::error::Error>> {
HmacKey::list().await?;
Ok(())
}
#[tokio::test]
async fn read() -> Result<(), Box<dyn std::error::Error>> {
let key = get_test_hmac().await;
HmacKey::read(&key.access_id).await?;
remove_test_hmac(&key.access_id).await;
Ok(())
}
#[tokio::test]
async fn update() -> Result<(), Box<dyn std::error::Error>> {
let key = get_test_hmac().await;
HmacKey::update(&key.access_id, HmacState::Inactive).await?;
HmacKey::delete(&key.access_id).await?;
Ok(())
}
#[tokio::test]
async fn delete() -> Result<(), Box<dyn std::error::Error>> {
let key = get_test_hmac().await;
HmacKey::update(&key.access_id, HmacState::Inactive).await?;
HmacKey::delete(&key.access_id).await?;
Ok(())
}
#[tokio::test]
async fn clear_keys() -> Result<(), Box<dyn std::error::Error>> {
let keys = HmacKey::list().await?;
for key in &keys {
if key.state != HmacState::Inactive {
HmacKey::update(&key.access_id, HmacState::Inactive).await?;
}
HmacKey::delete(&key.access_id).await?;
}
Ok(())
}
#[cfg(all(feature = "global-client", feature = "sync"))]
mod sync {
use super::*;
fn get_test_hmac() -> HmacMeta {
match HmacKey::create_sync() {
Ok(key) => key.metadata,
Err(_) => HmacKey::list_sync().unwrap().pop().unwrap(),
}
}
fn remove_test_hmac(access_id: &str) {
HmacKey::update_sync(access_id, HmacState::Inactive).unwrap();
HmacKey::delete_sync(access_id).unwrap();
}
#[test]
fn create() -> Result<(), Box<dyn std::error::Error>> {
let key = HmacKey::create_sync()?;
remove_test_hmac(&key.metadata.access_id);
Ok(())
}
#[test]
fn list() -> Result<(), Box<dyn std::error::Error>> {
HmacKey::list_sync()?;
Ok(())
}
#[test]
fn read() -> Result<(), Box<dyn std::error::Error>> {
let key = get_test_hmac();
HmacKey::read_sync(&key.access_id)?;
remove_test_hmac(&key.access_id);
Ok(())
}
#[test]
fn update() -> Result<(), Box<dyn std::error::Error>> {
let key = get_test_hmac();
HmacKey::update_sync(&key.access_id, HmacState::Inactive)?;
HmacKey::delete_sync(&key.access_id)?;
Ok(())
}
#[test]
fn delete() -> Result<(), Box<dyn std::error::Error>> {
let key = get_test_hmac();
HmacKey::update_sync(&key.access_id, HmacState::Inactive)?;
HmacKey::delete_sync(&key.access_id)?;
Ok(())
}
}
}