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
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
use ed25519::Signature;
use ed25519_dalek::{VerifyingKey, PUBLIC_KEY_LENGTH, SIGNATURE_LENGTH};
use rlp::DecoderError;
use url::Url;

use crate::db::documents::package_document::PackageDocument;

use super::{
    package::{Package, PackageStatus},
    package_integrity::PackageIntegrity,
    package_integrity_builder::PackageIntegrityBuilder,
};

#[derive(Default)]
pub struct PackageBuilder {
    /**
     * Package name
     */
    name: Option<String>,
    /**
     * Package version
     */
    version: Option<String>,

    /**
     * Package status
     */
    status: Option<PackageStatus>,

    /**
     * Package maintainer
     */
    maintainer: Option<VerifyingKey>,

    /**
     * Pacakge archive url
     */
    archive_url: Option<Url>,

    /**
     * Package integrity
     */
    integrity: Option<PackageIntegrity>,

    /**
     * Package signature
     */
    sig: Option<Signature>,
}

impl PackageBuilder {
    /**
     * Build from document
     */
    pub fn from_document(document: &PackageDocument) -> PackageBuilder {
        // Package status
        let package_status_integer = document.status as u8;
        let package_status = PackageStatus::try_from(package_status_integer)
            .expect("Could not convert package status from integer to enum");

        // Package maintainer
        let package_maintainer_decoded =
            hex::decode(document.maintainer.clone()).expect("Could not decode package maintainer");

        let mut package_maintainer_buf: [u8; PUBLIC_KEY_LENGTH] = [0; PUBLIC_KEY_LENGTH];

        package_maintainer_buf.copy_from_slice(package_maintainer_decoded.as_slice());

        let package_maintainer = VerifyingKey::from_bytes(&package_maintainer_buf)
            .expect("Could not build key from decoded maintainer key");

        // Package archive url
        let archive_url = Url::parse(&document.archive_url.as_str()).unwrap();

        // Package integrity

        let package_integrity = PackageIntegrityBuilder::from_document(&document.integrity).build();

        // Package signature

        let mut package_signature_buf: [u8; SIGNATURE_LENGTH] = [0; SIGNATURE_LENGTH];

        let decoded_sig = hex::decode(&document.sig).unwrap();
        package_signature_buf.copy_from_slice(&decoded_sig);

        let package_signature = Signature::from_bytes(&package_signature_buf);

        Self {
            name: Some(document.name.clone()),
            version: Some(document.version.clone()),
            status: Some(package_status),
            maintainer: Some(package_maintainer),
            archive_url: Some(archive_url),
            integrity: Some(package_integrity),
            sig: Some(package_signature),
        }
    }

    /**
     * Create new package builder instance
     */
    pub fn new() -> Self {
        Self {
            name: None,
            version: None,
            status: None,
            maintainer: None,
            archive_url: None,
            integrity: None,
            sig: None,
        }
    }

    /**
     * Reset builder instance
     */
    pub fn reset(&mut self) -> &Self {
        self.name = None;
        self.version = None;
        self.status = None;
        self.maintainer = None;
        self.archive_url = None;
        self.integrity = None;
        self.sig = None;
        self
    }

    /**
     * Build from other package
     */
    pub fn from_package(package: &Package) -> Self {
        let instance = Self {
            name: Some(package.name.clone()),
            version: Some(package.version.clone()),
            status: Some(package.status.clone()),
            maintainer: Some(package.maintainer),
            archive_url: Some(package.archive_url.clone()),
            integrity: Some(package.integrity.clone()),
            sig: package.sig,
        };

        instance
    }

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

        let instance = Self {
            name: Some(package.name),
            version: Some(package.version),
            status: Some(package.status),
            maintainer: Some(package.maintainer),
            archive_url: Some(package.archive_url),
            integrity: Some(package.integrity),
            sig: package.sig,
        };

        Ok(instance)
    }

    /**
     * Set package name
     */
    pub fn set_name(&mut self, name: &String) -> &mut Self {
        self.name = Some(name.clone());
        self
    }

    /**
     * Set package version
     */
    pub fn set_version(&mut self, version: &String) -> &mut Self {
        self.version = Some(version.clone());
        self
    }

    /**
     * Set package status
     */
    pub fn set_status(&mut self, status: &PackageStatus) -> &mut Self {
        self.status = Some(status.clone());
        self
    }

    /**
     * Set package maitainer
     */
    pub fn set_maintainer(&mut self, maintainer: &VerifyingKey) -> &mut Self {
        self.maintainer = Some(maintainer.clone());
        self
    }

    /**
     * Set archive url
     */
    pub fn set_archive_url(&mut self, archive_url: &Url) -> &mut Self {
        self.archive_url = Some(archive_url.clone());
        self
    }

    /**
     * Set package integrity data
     */
    pub fn set_integrity(&mut self, integrity_alg: &String, archive_hash: &[u8]) -> &mut Self {
        let integrity = PackageIntegrity {
            algorithm: integrity_alg.clone(),
            archive_hash: Vec::from(archive_hash),
        };

        self.integrity = Some(integrity);

        self
    }

    /**
     * Set package signature
     */
    pub fn set_signature(&mut self, sig: &Signature) -> &mut Self {
        self.sig = Some(sig.clone());
        self
    }

    /**
     * Build package
     */
    pub fn build(&mut self) -> Package {
        let package = Package {
            name: self.name.clone().expect("Package name must be set"),
            version: self.version.clone().expect("Package version must be set"),
            status: self.status.clone().expect("Package status must be set"),
            maintainer: self
                .maintainer
                .clone()
                .expect("Package maintainer must be set"),
            archive_url: self
                .archive_url
                .clone()
                .expect("Package archive url must be set"),
            integrity: self
                .integrity
                .clone()
                .expect("Package integrity must be set"),

            sig: self.sig.clone(),
        };

        self.reset();

        package
    }
}

#[cfg(test)]
mod tests {

    use ed25519::signature::{rand_core::OsRng, SignerMut};
    use ed25519_dalek::SigningKey;
    use sha2::{Digest, Sha256};

    use super::*;

    #[test]
    fn test_package_build() -> Result<(), Box<dyn std::error::Error>> {
        let mut builder = PackageBuilder::new();

        let expected_name = "foo".to_string();
        let expected_version = "1.2.3".to_string();
        let expected_status = PackageStatus::Fine;

        let mut csprng = OsRng;
        let mut key = SigningKey::generate(&mut csprng);

        let expected_maintainer = key.verifying_key();

        let expected_archive_url = Url::parse(
            "https://archive.archlinux.org/packages/f/foo/foo-1.2.3-1-x86_64.pkg.tar.zst",
        )?;

        // Pkg integrity
        let expected_integrity_algorithm = "SHA256";

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

        // Pkg sig
        let package_info_hash_data = format!(
            "{expected_name}{expected_version}{}{}{expected_archive_url}{}{}",
            expected_status,
            hex::encode(expected_maintainer),
            expected_integrity_algorithm,
            hex::encode(expected_archive_hash.clone())
        );

        let mut package_sig_hasher = Sha256::new();

        package_sig_hasher.update(package_info_hash_data);

        let package_data_hash = package_sig_hasher.finalize();

        let expected_sig = key.sign(&package_data_hash);

        let package = builder
            .set_name(&expected_name)
            .set_version(&expected_version)
            .set_status(&expected_status)
            .set_maintainer(&expected_maintainer)
            .set_archive_url(&expected_archive_url)
            .set_integrity(
                &expected_integrity_algorithm.to_string(),
                &expected_archive_hash,
            )
            .set_signature(&expected_sig)
            .build();

        assert_eq!(package.name, expected_name);
        assert_eq!(package.version, expected_version);
        assert_eq!(package.status, expected_status);
        assert_eq!(package.maintainer, expected_maintainer);
        assert_eq!(package.archive_url, expected_archive_url);
        assert_eq!(package.sig.unwrap(), expected_sig);

        Ok(())
    }

    #[test]
    fn test_package_build_from_package() -> Result<(), Box<dyn std::error::Error>> {
        let mut builder = PackageBuilder::new();

        let expected_name = "foo".to_string();
        let expected_version = "1.2.3".to_string();
        let expected_status = PackageStatus::Fine;

        let mut csprng = OsRng;
        let mut key = SigningKey::generate(&mut csprng);

        let expected_maintainer = key.verifying_key();

        let expected_archive_url = Url::parse(
            "https://archive.archlinux.org/packages/f/foo/foo-1.2.3-1-x86_64.pkg.tar.zst",
        )?;

        // Pkg integrity
        let expected_integrity_algorithm = "SHA256";

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

        // Pkg sig
        let package_info_hash_data = format!(
            "{expected_name}{expected_version}{}{}{expected_archive_url}{}{}",
            expected_status,
            hex::encode(expected_maintainer),
            expected_integrity_algorithm,
            hex::encode(expected_archive_hash.clone())
        );

        let mut package_sig_hasher = Sha256::new();

        package_sig_hasher.update(package_info_hash_data);

        let package_data_hash = package_sig_hasher.finalize();

        let expected_sig = key.sign(&package_data_hash);

        let package = builder
            .set_name(&expected_name)
            .set_version(&expected_version)
            .set_status(&expected_status)
            .set_maintainer(&expected_maintainer)
            .set_archive_url(&expected_archive_url)
            .set_integrity(
                &expected_integrity_algorithm.to_string(),
                &expected_archive_hash,
            )
            .set_signature(&expected_sig)
            .build();

        let copied_package = PackageBuilder::from_package(&package).build();

        assert_eq!(copied_package.name, package.name);
        assert_eq!(copied_package.version, package.version);
        assert_eq!(copied_package.status, package.status);
        assert_eq!(copied_package.maintainer, package.maintainer);
        assert_eq!(copied_package.archive_url, package.archive_url);
        assert_eq!(copied_package.sig.unwrap(), package.sig.unwrap());

        Ok(())
    }

    #[test]
    fn test_package_reset() -> Result<(), Box<dyn std::error::Error>> {
        let mut builder = PackageBuilder::new();

        let expected_name = "foo".to_string();
        let expected_version = "1.2.3".to_string();
        let expected_status = PackageStatus::Fine;

        let mut csprng = OsRng;
        let mut key = SigningKey::generate(&mut csprng);

        let expected_maintainer = key.verifying_key();

        let expected_archive_url = Url::parse(
            "https://archive.archlinux.org/packages/f/foo/foo-1.2.3-1-x86_64.pkg.tar.zst",
        )?;

        // Pkg integrity
        let expected_integrity_algorithm = "SHA256";

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

        // Pkg sig
        let package_info_hash_data = format!(
            "{expected_name}{expected_version}{}{}{expected_archive_url}{}{}",
            expected_status,
            hex::encode(expected_maintainer),
            expected_integrity_algorithm,
            hex::encode(expected_archive_hash.clone())
        );

        let mut package_sig_hasher = Sha256::new();

        package_sig_hasher.update(package_info_hash_data);

        let package_data_hash = package_sig_hasher.finalize();

        let expected_sig = key.sign(&package_data_hash);

        let package = builder
            .set_name(&expected_name)
            .set_version(&expected_version)
            .set_status(&expected_status)
            .set_maintainer(&expected_maintainer)
            .set_archive_url(&expected_archive_url)
            .set_integrity(
                &expected_integrity_algorithm.to_string(),
                &expected_archive_hash,
            )
            .set_signature(&expected_sig)
            .build();

        assert_eq!(builder.name, None);
        assert_eq!(builder.version, None);
        assert_eq!(builder.status, None);
        assert_eq!(builder.maintainer, None);
        assert_eq!(builder.archive_url, None);
        assert_eq!(builder.sig, None);

        Ok(())
    }
}