proto_pdk_api 0.31.11

Core APIs for creating proto WASM plugins.
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

use serde::{Deserialize, Serialize};
use std::fmt::{self, Debug};
use std::str::FromStr;
use thiserror::Error;

/// Errors that may occur from within a plugin.
#[derive(Error, Debug)]
pub enum ChecksumError {
    #[error("Checksum algorithm is not defined.")]
    MissingAlgorithm,

    #[error("Unknown or unsupported checksum algorithm {kind}.")]
    UnsupportedAlgorithm { kind: String },
}

/// Supported checksum algorithms.
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum ChecksumAlgorithm {
    Minisign,
    Sha256,
    Sha512,
}

/// Represents a checksum for a specific algorithm.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(into = "String", try_from = "String")]
pub struct Checksum {
    /// Algorithm.
    pub algo: ChecksumAlgorithm,

    /// Public key.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,

    /// File hash / private key.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub hash: Option<String>,
}

impl Checksum {
    pub fn minisign(key: String) -> Self {
        Self {
            algo: ChecksumAlgorithm::Minisign,
            key: Some(key),
            hash: None,
        }
    }

    pub fn sha256(hash: String) -> Self {
        Self {
            algo: ChecksumAlgorithm::Sha256,
            key: None,
            hash: Some(hash),
        }
    }

    pub fn sha512(hash: String) -> Self {
        Self {
            algo: ChecksumAlgorithm::Sha512,
            key: None,
            hash: Some(hash),
        }
    }
}

impl FromStr for Checksum {
    type Err = ChecksumError;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        if !value.contains(':') {
            if value.len() == 64 {
                return Ok(Self::sha256(value.to_owned()));
            } else if value.len() == 128 {
                return Ok(Self::sha512(value.to_owned()));
            }
        }

        match value.split_once(':') {
            Some((tag, hash)) => match tag {
                "minisign" => Ok(Self::minisign(hash.to_owned())),
                "sha256" => Ok(Self::sha256(hash.to_owned())),
                "sha512" => Ok(Self::sha512(hash.to_owned())),
                _ => Err(ChecksumError::UnsupportedAlgorithm {
                    kind: tag.to_owned(),
                }),
            },
            None => Err(ChecksumError::MissingAlgorithm),
        }
    }
}

impl TryFrom<String> for Checksum {
    type Error = ChecksumError;

    fn try_from(value: String) -> Result<Self, Self::Error> {
        Self::from_str(&value)
    }
}

impl fmt::Display for Checksum {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self.algo {
            ChecksumAlgorithm::Minisign => {
                write!(f, "minisign:{}", self.key.as_deref().unwrap_or_default())
            }
            ChecksumAlgorithm::Sha256 => {
                write!(f, "sha256:{}", self.hash.as_deref().unwrap_or_default())
            }
            ChecksumAlgorithm::Sha512 => {
                write!(f, "sha512:{}", self.hash.as_deref().unwrap_or_default())
            }
        }
    }
}

#[allow(clippy::from_over_into)]
impl Into<String> for Checksum {
    fn into(self) -> String {
        self.to_string()
    }
}

#[cfg(feature = "schematic")]
impl schematic::Schematic for Checksum {
    fn schema_name() -> Option<String> {
        Some("Checksum".into())
    }

    fn build_schema(mut schema: schematic::SchemaBuilder) -> schematic::Schema {
        schema.string_default()
    }
}