covert-types 0.1.3

Covert type definitions
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

use std::time::Duration;

use http::StatusCode;
use serde::{de::DeserializeOwned, Serialize};
use serde_json::Value;
use tracing_error::SpanTrace;

use crate::error::ApiError;

/// Response from the backend
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub enum Response {
    /// Raw response. The data will be returned as is to the client.
    Raw(Value),
    /// Authentication response. The client will receive a token for the
    /// given alias.
    Auth(AuthResponse),
    /// Register a lease for the payload. Useful for returning dynamic
    /// secrets that can be revoked and renewed.
    Lease(LeaseResponse),
}

// TODO: add renew fields as well
#[derive(Debug, Serialize)]
pub struct LeaseResponse {
    pub revoke: LeaseRenewRevokeEndpoint,
    pub renew: LeaseRenewRevokeEndpoint,
    pub data: Value,
    #[serde(with = "humantime_serde")]
    pub ttl: Option<Duration>,
}

#[derive(Debug, Serialize)]
pub struct LeaseRenewRevokeEndpoint {
    pub path: String,
    pub data: Value,
}

#[derive(Debug, Serialize)]
pub struct AuthResponse {
    pub alias: String,
    #[serde(with = "humantime_serde")]
    pub ttl: Option<Duration>,
}

impl Response {
    #[must_use]
    pub fn ok() -> Self {
        Self::Raw(Value::default())
    }

    /// Construct a response with data that will be returned as is to the client.
    ///
    /// # Errors
    ///
    /// Returns an error if it fails to serialize the payload.
    pub fn raw<T: Serialize>(data: T) -> Result<Self, serde_json::Error> {
        serde_json::to_value(data).map(Self::Raw)
    }

    /// Try to deserialize the raw data payload from the response.
    ///
    /// # Errors
    ///
    /// Returns an error if it fails to deserialize the raw payload or if the
    /// response is not a raw payload.
    pub fn data<T: DeserializeOwned>(self) -> Result<T, ApiError> {
        match self {
            Response::Raw(data) => serde_json::from_value(data).map_err(|err| ApiError {
                error: err.into(),
                status_code: StatusCode::BAD_REQUEST,
                span_trace: Some(SpanTrace::capture()),
            }),
            Response::Auth(_data) => Err(ApiError {
                error: anyhow::Error::msg("expected raw data, found auth data"),
                status_code: StatusCode::BAD_REQUEST,
                span_trace: Some(SpanTrace::capture()),
            }),
            Response::Lease(_data) => Err(ApiError {
                error: anyhow::Error::msg("expected raw data, found lease data"),
                status_code: StatusCode::BAD_REQUEST,
                span_trace: Some(SpanTrace::capture()),
            }),
        }
    }
}