cryptograph 0.1.6

All you need for encrypthing your messages.
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

use crate::tools::flip_flop::FlipFlop;

/// A Linear Feedback Shift Register (LFSR) generator.
///
/// LFSR produces a sequence of pseudorandom bits using a vector of flip-flops
/// and a feedback function that defines which bits are XORed to produce the next state.
pub struct Lsfr {
    /// The vector of flip-flops representing the current state.
    ff: Vec<FlipFlop>,

    /// The feedback function used to calculate the new input bit.
    fb: Box<dyn Fn(&[FlipFlop]) -> bool>,
}

impl Lsfr {
    /// Creates a new LFSR with the given flip-flops.
    ///
    /// The default feedback function XORs the first and last flip-flops.
    ///
    /// # Example
    /// ```
    /// use cryptograph::tools::flip_flop::FlipFlop;
    /// use cryptograph::pseudorandom_generator::lfsr::Lsfr;
    ///
    /// let ff = vec![
    ///     FlipFlop::new(true),
    ///     FlipFlop::new(false),
    ///     FlipFlop::new(true),
    /// ];
    /// let lfsr = Lsfr::new(ff);
    /// assert_eq!(lfsr.get().len(), 3);
    /// ```
    pub fn new(ff: Vec<FlipFlop>) -> Self {
        Self {
            ff,
            fb: Box::new(|ff| ff[0].get() ^ ff[ff.len() - 1].get()),
        }
    }

    /// Performs one rotation of the LFSR.
    ///
    /// Shifts all flip-flops to the right and sets the first flip-flop
    /// using the feedback function.
    ///
    /// # Example
    /// ```
    ///use cryptograph::tools::flip_flop::FlipFlop;
    ///use cryptograph::pseudorandom_generator::lfsr::Lsfr;
    ///
    /// let mut lfsr = Lsfr::new(vec![
    ///     FlipFlop::new(true),
    ///     FlipFlop::new(false),
    ///     FlipFlop::new(true),
    /// ]);
    /// lfsr.rotate();
    /// ```
    pub fn rotate(&mut self) {
        let fb = (self.fb)(&self.ff);

        for i in (1..self.ff.len()).rev() {
            let val = self.ff[i - 1].get();
            self.ff[i].put(val);
        }

        self.ff[0].put(fb);
    }

    /// Returns a slice of the current flip-flops.
    ///
    /// # Example
    /// ```
    ///use cryptograph::tools::flip_flop::FlipFlop;
    ///use cryptograph::pseudorandom_generator::lfsr::Lsfr;
    ///
    /// let lfsr = Lsfr::new(vec![
    ///     FlipFlop::new(true),
    ///     FlipFlop::new(false),
    /// ]);
    /// let state = lfsr.get();
    /// assert_eq!(state[0].get(), true);
    /// ```
    pub fn get(&self) -> &[FlipFlop] {
        &self.ff
    }

    /// Calculates the total number of possible states for this LFSR.
    ///
    /// For `n` flip-flops, the maximum number of unique states is `2^n - 1`.
    ///
    /// # Example
    /// ```
    ///use cryptograph::tools::flip_flop::FlipFlop;
    ///use cryptograph::pseudorandom_generator::lfsr::Lsfr;
    ///
    /// let lfsr = Lsfr::new(vec![
    ///     FlipFlop::new(true),
    ///     FlipFlop::new(false),
    ///     FlipFlop::new(true),
    /// ]);
    /// assert_eq!(lfsr.calculate_possibilities(), 7); // 2^3 - 1
    /// ```
    pub fn calculate_possibilities(&self) -> usize {
        (1 << self.ff.len()) - 1
    }
}