phar 0.0.3

Rust library for PHP phar format
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

use std::io::{Result, Write};

use auto_enums::auto_enum;
use digest::Digest;
use smallvec::SmallVec;

/// A possible phar signature
#[derive(Debug)]
pub enum Signature {
    /// Signature corresponding to `Phar::MD5`
    #[cfg(feature = "sig-md5")]
    #[cfg_attr(feature = "docsrs", doc(cfg(feature = "sig-md5")))]
    Md5(md5::Md5),
    /// Signature corresponding to `Phar::SHA1`
    #[cfg(feature = "sig-sha1")]
    #[cfg_attr(feature = "docsrs", doc(cfg(feature = "sig-sha1")))]
    Sha1(sha1::Sha1),
    /// Signature corresponding to `Phar::SHA256`
    #[cfg(feature = "sig-sha2")]
    #[cfg_attr(feature = "docsrs", doc(cfg(feature = "sig-sha2")))]
    Sha256(sha2::Sha256),
    /// Signature corresponding to `Phar::SHA512`
    #[cfg(feature = "sig-sha2")]
    #[cfg_attr(feature = "docsrs", doc(cfg(feature = "sig-sha2")))]
    Sha512(sha2::Sha512),
}

impl Signature {
    /// Creates an md5 signature
    #[cfg(feature = "sig-md5")]
    pub fn md5() -> Self {
        Self::Md5(Digest::new())
    }

    /// Creates a sha1 signature
    #[cfg(feature = "sig-sha1")]
    pub fn sha1() -> Self {
        Self::Sha1(Digest::new())
    }

    /// Creates a sha256 signature
    #[cfg(feature = "sig-sha2")]
    pub fn sha256() -> Self {
        Self::Sha256(Digest::new())
    }

    /// Creates a sha512 signature
    #[cfg(feature = "sig-sha2")]
    pub fn sha512() -> Self {
        Self::Sha512(Digest::new())
    }

    /// Creates a signature from the phar format flag
    pub fn from_u32(discrim: u32) -> Option<Self> {
        Some(match discrim {
            #[cfg(feature = "sig-md5")]
            1 => Self::Md5(Digest::new()),
            #[cfg(feature = "sig-sha1")]
            2 => Self::Sha1(Digest::new()),
            #[cfg(feature = "sig-sha2")]
            3 => Self::Sha256(Digest::new()),
            #[cfg(feature = "sig-sha2")]
            4 => Self::Sha512(Digest::new()),
            _ => return None,
        })
    }

    /// Returns the phar format flag of the signature type
    pub fn to_u32(&self) -> u32 {
        match self {
            #[cfg(feature = "sig-md5")]
            Self::Md5(_) => 1,
            #[cfg(feature = "sig-sha1")]
            Self::Sha1(_) => 2,
            #[cfg(feature = "sig-sha2")]
            Self::Sha256(_) => 3,
            #[cfg(feature = "sig-sha2")]
            Self::Sha512(_) => 4,
        }
    }

    /// The number of bytes used for this signature
    pub fn size(&self) -> u8 {
        match self {
            #[cfg(feature = "sig-md5")]
            Self::Md5(_) => 16,
            #[cfg(feature = "sig-sha1")]
            Self::Sha1(_) => 20,
            #[cfg(feature = "sig-sha2")]
            Self::Sha256(_) => 32,
            #[cfg(feature = "sig-sha2")]
            Self::Sha512(_) => 64,
        }
    }

    /// Returns a `Write` that writes to the underlying digest
    pub fn write(&mut self) -> impl Write + '_ {
        #[allow(clippy::as_conversions)]
        match self {
            #[cfg(feature = "sig-md5")]
            Self::Md5(digest) => digest as &mut dyn Write,
            #[cfg(feature = "sig-sha1")]
            Self::Sha1(digest) => digest as &mut dyn Write,
            #[cfg(feature = "sig-sha2")]
            Self::Sha256(digest) => digest as &mut dyn Write,
            #[cfg(feature = "sig-sha2")]
            Self::Sha512(digest) => digest as &mut dyn Write,
        }
    }

    /// Returns the memory allocated by the underlying signature implementation
    pub fn finalize(self) -> SmallVec<[u8; 64]> {
        let mut ret = SmallVec::new();
        match self {
            #[cfg(feature = "sig-md5")]
            Self::Md5(digest) => ret.extend(digest.finalize()[..].iter().copied()),
            #[cfg(feature = "sig-sha1")]
            Self::Sha1(digest) => ret.extend(digest.finalize()[..].iter().copied()),
            #[cfg(feature = "sig-sha2")]
            Self::Sha256(digest) => ret.extend(digest.finalize()[..].iter().copied()),
            #[cfg(feature = "sig-sha2")]
            Self::Sha512(digest) => ret.extend(digest.finalize()[..].iter().copied()),
        };
        ret
    }
}

pub enum MaybeDummy {
    Real(Signature),
    Dummy(NullDevice),
}

impl MaybeDummy {
    #[auto_enum(io::Write)]
    pub fn write(&mut self) -> impl Write + '_ {
        match self {
            Self::Real(sig) => sig.write(),
            Self::Dummy(dev) => dev,
        }
    }
}

pub struct NullDevice;

impl Write for NullDevice {
    #[inline]
    fn write(&mut self, buf: &[u8]) -> Result<usize> {
        Ok(buf.len())
    }

    fn flush(&mut self) -> Result<()> {
        Ok(())
    }
}