bpm_core 0.1.0

Cross-platform software helping to verify, prove and secure package compilation, building, fetching, and deployment. Core package.
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

use rlp::DecoderError;

use crate::db::documents::package_integrity_document::PackageIntegrityDocument;

use super::package_integrity::PackageIntegrity;

#[derive(Default)]
pub struct PackageIntegrityBuilder {
    algorithm: Option<String>,
    archive_hash: Option<Vec<u8>>,
}

impl PackageIntegrityBuilder {
    /**
     * Build from document
     */
    pub fn from_document(document: &PackageIntegrityDocument) -> PackageIntegrityBuilder {
        let decoded_archive_hash = hex::decode(&document.archive_hash).unwrap();
        Self {
            algorithm: Some(document.algorithm.clone()),
            archive_hash: Some(decoded_archive_hash),
        }
    }

    /**
     * Create new package builder instance
     */
    pub fn new() -> Self {
        Self {
            algorithm: None,
            archive_hash: None,
        }
    }

    /**
     * Reset builder instance
     */
    pub fn reset(&mut self) -> &Self {
        self.algorithm = None;
        self.archive_hash = None;
        self
    }

    /**
     * Build from other package integrity
     */
    pub fn from_package_integrity(package_integrity: &PackageIntegrity) -> Self {
        let instance = Self {
            algorithm: Some(package_integrity.algorithm.clone()),
            archive_hash: Some(package_integrity.archive_hash.clone()),
        };

        instance
    }

    /**
     * Parse rpl and extract package integer information
     */
    pub fn from_rpl(raw_package_integrity: &[u8]) -> Result<Self, DecoderError> {
        let package_integrity: PackageIntegrity = rlp::decode(&raw_package_integrity)?;

        let instance = Self {
            algorithm: Some(package_integrity.algorithm),
            archive_hash: Some(package_integrity.archive_hash),
        };

        Ok(instance)
    }

    /**
     * Set algorithm
     */
    pub fn set_algorithm(&mut self, algorithm: &String) -> &mut Self {
        self.algorithm = Some(algorithm.clone());

        self
    }

    /**
     * Set archive hash
     */
    pub fn set_archive_hash(&mut self, archive_hash: &Vec<u8>) -> &mut Self {
        self.archive_hash = Some(archive_hash.clone());

        self
    }

    /**
     * Build package integrity
     */
    pub fn build(&mut self) -> PackageIntegrity {
        let package_integrity = PackageIntegrity {
            algorithm: self
                .algorithm
                .clone()
                .expect("Package algorithm must be set"),
            archive_hash: self
                .archive_hash
                .clone()
                .expect("Package archive hash must be set"),
        };

        self.reset();

        package_integrity
    }
}

mod tests {
    use sha2::{Digest, Sha256};

    use super::PackageIntegrityBuilder;

    use super::*;

    #[test]
    fn test_package_integrity_build() {
        let expected_algorithm = "SHA256".to_string();

        let mut package_archive_hasher = Sha256::new();
        package_archive_hasher.update("foo");
        let expected_archive_hash = package_archive_hasher.finalize().to_vec();

        let package_integrity = PackageIntegrityBuilder::new()
            .set_algorithm(&expected_algorithm)
            .set_archive_hash(&expected_archive_hash)
            .build();

        assert_eq!(package_integrity.algorithm, expected_algorithm);
        assert_eq!(package_integrity.archive_hash, expected_archive_hash);
    }

    #[test]
    fn test_package_integrity_reset() {
        let expected_algorithm = "SHA256".to_string();

        let mut builder = PackageIntegrityBuilder::new();
        let package_integrity = builder.set_algorithm(&expected_algorithm).reset();

        assert_eq!(package_integrity.algorithm, None);
    }

    #[test]
    fn test_package_integrity_build_from_package_integrity() {
        let expected_algorithm = "SHA256".to_string();

        let mut package_archive_hasher = Sha256::new();
        package_archive_hasher.update("foo");
        let expected_archive_hash = package_archive_hasher.finalize().to_vec();

        let package_integrity = PackageIntegrityBuilder::new()
            .set_algorithm(&expected_algorithm)
            .set_archive_hash(&expected_archive_hash)
            .build();

        assert_eq!(package_integrity.algorithm, expected_algorithm);
        assert_eq!(package_integrity.archive_hash, expected_archive_hash);

        let copied_package_integrity =
            PackageIntegrityBuilder::from_package_integrity(&package_integrity).build();
        assert_eq!(
            copied_package_integrity.algorithm,
            package_integrity.algorithm
        );
        assert_eq!(
            copied_package_integrity.archive_hash,
            package_integrity.archive_hash
        );
    }
}