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

// MIT License
//
// Copyright (c) 2022-2024 Robin Doer
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

use nuts_backend::Backend;

use crate::cipher::Cipher;
use crate::kdf::Kdf;

/// Information from the container.
#[derive(Debug, PartialEq)]
pub struct Info<B: Backend> {
    /// Information from the lower backend.
    pub backend: B::Info,

    /// The revision of the header.
    pub revision: u32,

    /// The cipher used for encryption.
    pub cipher: Cipher,

    /// The key derivation function.
    pub kdf: Kdf,

    /// The gross block size is the block size specified by the
    /// [backend](Backend::block_size).
    ///
    /// This is the actual size of a block in the backend. Note that the number
    /// of userdata bytes per block can be smaller! This is the net block size
    /// ([`Info::bsize_net`]).
    pub bsize_gross: u32,

    /// The (net) block size of the container.
    ///
    /// The net block size is the number of bytes you can store in a block. It
    /// can be less than the gross block size ([`Info::bsize_gross`]).
    ///
    /// Depending on the selected cipher, you need to store additional data in
    /// a block. I.e. an AE-cipher results into a tag, which needs to be stored
    /// additionally. Such data must be substracted from the gross block size
    /// and results into the net block size.
    pub bsize_net: u32,
}