cipher 0.5.1

Traits for describing block ciphers and stream ciphers
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

//! Traits used to define functionality of [tweakable block ciphers][1].
//!
//! [1]: https://people.eecs.berkeley.edu/~daw/papers/tweak-crypto02.pdf
use common::{
    Block, BlockSizeUser,
    array::{Array, ArraySize},
};
use inout::InOut;

mod ctx;
mod zero;

pub use zero::ZeroTweak;

/// Tweak used by a [`TweakSizeUser`] implementor.
pub type Tweak<C> = Array<u8, <C as TweakSizeUser>::TweakSize>;

/// Trait which contains tweak size used by the tweak cipher traits.
pub trait TweakSizeUser {
    /// Size of the tweak in bytes.
    type TweakSize: ArraySize;
}

/// Encrypt-only functionality for tweakable block ciphers.
pub trait TweakBlockCipherEncrypt: BlockSizeUser + TweakSizeUser + Sized {
    /// Encrypt data using backend provided to the rank-2 closure.
    fn encrypt_with_backend(
        &self,
        f: impl TweakBlockCipherEncClosure<BlockSize = Self::BlockSize, TweakSize = Self::TweakSize>,
    );

    /// Encrypt single `inout` block.
    #[inline]
    fn encrypt_block_inout(&self, tweak: &Tweak<Self>, block: InOut<'_, '_, Block<Self>>) {
        self.encrypt_with_backend(ctx::BlockCtx { tweak, block });
    }

    /// Encrypt single block in-place.
    #[inline]
    fn encrypt_block(&self, tweak: &Tweak<Self>, block: &mut Block<Self>) {
        self.encrypt_block_inout(tweak, block.into());
    }

    /// Encrypt `in_block` and write result to `out_block`.
    #[inline]
    fn encrypt_block_b2b(
        &self,
        tweak: &Tweak<Self>,
        in_block: &Block<Self>,
        out_block: &mut Block<Self>,
    ) {
        self.encrypt_block_inout(tweak, (in_block, out_block).into());
    }
}

/// Decrypt-only functionality for tweakable block ciphers.
pub trait TweakBlockCipherDecrypt: BlockSizeUser + TweakSizeUser + Sized {
    /// Decrypt data using backend provided to the rank-2 closure.
    fn decrypt_with_backend(
        &self,
        f: impl TweakBlockCipherDecClosure<BlockSize = Self::BlockSize, TweakSize = Self::TweakSize>,
    );

    /// Decrypt single `inout` block.
    #[inline]
    fn decrypt_block_inout(&self, tweak: &Tweak<Self>, block: InOut<'_, '_, Block<Self>>) {
        self.decrypt_with_backend(ctx::BlockCtx { tweak, block });
    }

    /// Decrypt single block in-place.
    #[inline]
    fn decrypt_block(&self, tweak: &Tweak<Self>, block: &mut Block<Self>) {
        self.decrypt_block_inout(tweak, block.into());
    }

    /// Decrypt `in_block` and write result to `out_block`.
    #[inline]
    fn decrypt_block_b2b(
        &self,
        tweak: &Tweak<Self>,
        in_block: &Block<Self>,
        out_block: &mut Block<Self>,
    ) {
        self.decrypt_block_inout(tweak, (in_block, out_block).into());
    }
}

/// Trait for [`TweakBlockCipherEncBackend`] users.
///
/// This trait is used to define rank-2 closures.
pub trait TweakBlockCipherEncClosure: BlockSizeUser + TweakSizeUser {
    /// Execute closure with the provided block cipher backend.
    fn call<B>(self, backend: &B)
    where
        B: TweakBlockCipherEncBackend<BlockSize = Self::BlockSize, TweakSize = Self::TweakSize>;
}

/// Trait for [`TweakBlockCipherDecBackend`] users.
///
/// This trait is used to define rank-2 closures.
pub trait TweakBlockCipherDecClosure: BlockSizeUser + TweakSizeUser {
    /// Execute closure with the provided block cipher backend.
    fn call<B>(self, backend: &B)
    where
        B: TweakBlockCipherDecBackend<BlockSize = Self::BlockSize, TweakSize = Self::TweakSize>;
}

/// Trait implemented by block cipher mode encryption backends.
pub trait TweakBlockCipherEncBackend: BlockSizeUser + TweakSizeUser {
    /// Encrypt single inout block.
    fn encrypt_block_inout(&self, tweak: &Tweak<Self>, block: InOut<'_, '_, Block<Self>>);

    /// Encrypt single block in-place.
    #[inline]
    fn encrypt_block(&self, tweak: &Tweak<Self>, block: &mut Block<Self>) {
        self.encrypt_block_inout(tweak, block.into());
    }

    /// Encrypt `in_block` and write result to `out_block`.
    #[inline]
    fn encrypt_block_b2b(
        &self,
        tweak: &Tweak<Self>,
        in_block: &Block<Self>,
        out_block: &mut Block<Self>,
    ) {
        self.encrypt_block_inout(tweak, (in_block, out_block).into());
    }
}

/// Trait implemented by block cipher mode decryption backends.
pub trait TweakBlockCipherDecBackend: BlockSizeUser + TweakSizeUser {
    /// Decrypt single inout block.
    fn decrypt_block_inout(&self, tweak: &Tweak<Self>, block: InOut<'_, '_, Block<Self>>);

    /// Decrypt single block in-place.
    #[inline]
    fn decrypt_block(&self, tweak: &Tweak<Self>, block: &mut Block<Self>) {
        self.decrypt_block_inout(tweak, block.into());
    }

    /// Decrypt `in_block` and write result to `out_block`.
    #[inline]
    fn decrypt_block_b2b(
        &self,
        tweak: &Tweak<Self>,
        in_block: &Block<Self>,
        out_block: &mut Block<Self>,
    ) {
        self.decrypt_block_inout(tweak, (in_block, out_block).into());
    }
}