cipher-crypt 0.18.0

//! One of the oldest cryptography tools was a scytale, which was used to perform
//! transposition encryption. It consisted of a cylinder with a strip of parchment (containing a
//! message) wound around it.
//!
//! The ancient Greeks used this cipher to communicate during military campaigns. Sender and
//! recipient each had a cylinder of exactly the same radius. The sender wound a narrow ribbon of
//! parchment around their cylinder. Then they wrote on it lengthwise. After the ribbon is unwound,
//! the writing could be read only by a person who had a cylinder of exactly the same
//! circumference.
//!
//! Scytale encryption is only keyed by the number of letters that fit on each roll
//! around the scytale. Therefore, it can be trivially cracked.
//!
use crate::common::cipher::Cipher;

/// A Scytale cipher.
///
/// This struct is created by the `new()` method. See its documentation for more.
pub struct Scytale {
    height: usize,
}

impl Cipher for Scytale {
    type Key = usize;
    type Algorithm = Scytale;

    /// Initialize a Scytale cipher with a specific cylinder height.
    ///
    /// # Panics
    /// * The `key` is 0.
    ///
    fn new(key: usize) -> Scytale {
        if key == 0 {
            panic!("Invalid key, height cannot be zero.");
        }

        Scytale { height: key }
    }

    /// Encrypt a message using a Scytale cipher.
    ///
    /// Whilst all characters (including utf8) can be encrypted during the transposition process,
    /// it is important to note that the space character is also treated as padding. As such,
    /// whitespace characters at the end of a message are not preserved during the decryption
    /// process.
    ///
    /// # Examples
    /// Basic usage:
    ///
    /// ```
    /// use cipher_crypt::{Cipher, Scytale};
    ///
    /// let s = Scytale::new(6);
    /// assert_eq!("Pegr lefoporaryr !", s.encrypt("Prepare for glory!").unwrap());
    /// ```
    ///
    fn encrypt(&self, message: &str) -> Result<String, &'static str> {
        // In both these cases the message is not altered
        if self.height >= message.chars().count() || self.height == 1 {
            return Ok(message.to_string());
        }

        // Create the smallest table that fits the message
        let width = (message.chars().count() as f64 / self.height as f64).ceil() as usize;
        let mut table = vec![vec![' '; width]; self.height];

        // Iterate over message and insert into the table, along rows
        for (pos, element) in message.chars().enumerate() {
            let col = pos % self.height;
            let row = pos / self.height;

            table[col][row] = element;
        }

        // Construct the ciphertext out of each row
        // Trim off any trailing whitespace added
        Ok(table
            .iter()
            .flatten()
            .collect::<String>()
            .trim_end()
            .to_string())
    }

    /// Decrypt a message using a Scytale cipher.
    ///
    /// # Examples
    /// Basic usage:
    ///
    /// ```
    /// use cipher_crypt::{Cipher, Scytale};
    ///
    /// let ct = Scytale::new(6);
    /// assert_eq!("Prepare for glory!", ct.decrypt("Pegr lefoporaryr !").unwrap());
    /// ```
    ///
    fn decrypt(&self, ciphertext: &str) -> Result<String, &'static str> {
        // In both these cases the ciphertext has not been altered
        if self.height >= ciphertext.chars().count() || self.height == 1 {
            return Ok(ciphertext.to_string());
        }

        // Create the smallest table that fits the ciphertext
        let width = (ciphertext.chars().count() as f64 / self.height as f64).ceil() as usize;
        let mut table = vec![vec![' '; width]; self.height];

        // Iterate over ciphertext and insert into the table, along columns
        for (pos, element) in ciphertext.chars().enumerate() {
            let col = pos / width;
            let row = pos % width;

            table[col][row] = element;
        }

        // Traverse each column and construct the plaintext
        let mut plaintext = String::new();
        while table.iter().filter(|v| !v.is_empty()).count() > 0 {
            // Continously pop from the top of each column until all are empty
            for column in table.iter_mut() {
                plaintext.push(column.remove(0));
            }
        }

        //Make sure to strip any padding characters
        Ok(plaintext.trim_end().to_string())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn simple_encrypt() {
        let s = Scytale::new(6);
        assert_eq!("aatttdaacwkn", s.encrypt("attackatdawn").unwrap());
    }

    #[test]
    fn simple_decrypt() {
        let s = Scytale::new(6);
        assert_eq!("attackatdawn", s.decrypt("aatttdaacwkn").unwrap());
    }

    #[test]
    fn padding_required() {
        let s = Scytale::new(5);
        let m = "attackatdawn";
        assert_eq!(m, s.decrypt(&s.encrypt(m).unwrap()).unwrap());
    }

    #[test]
    #[should_panic]
    fn invalid_height() {
        Scytale::new(0);
    }

    #[test]
    fn with_utf8() {
        let s = Scytale::new(5);
        let m = "Attack 🗡️ at once.";
        assert_eq!(m, s.decrypt(&s.encrypt(m).unwrap()).unwrap());
    }

    #[test]
    fn with_spaces() {
        //Spaces at the end of a message are not preserved
        let s = Scytale::new(5);
        let m = "Attack At Dawn comrades!  ";
        assert_eq!(
            "Attack At Dawn comrades!",
            s.decrypt(&s.encrypt(m).unwrap()).unwrap()
        );
    }

    #[test]
    fn longer_height() {
        let s = Scytale::new(20);
        let m = "attackatdawn";
        assert_eq!(m, s.decrypt(&s.encrypt(m).unwrap()).unwrap());
    }

    #[test]
    fn longer_msg() {
        let s = Scytale::new(7);
        let m = concat!(
            "We attack at dawn, not later when it is light, ",
            "or at some strange time of the clock. Only at dawn. ",
            "Why do we like to attack at dawn, actually, I don\'t ",
            "get it. I hate getting up that early, it puts me in ",
            "a bad mood. Can\'t we do it a bit later, say nine-thirty?"
        );
        assert_eq!(m, s.decrypt(&s.encrypt(m).unwrap()).unwrap());
    }
}