🎨 Move struct definition to a proper place

src/bin/totp.rs

@@ -4,7 +4,8 @@ extern crate rpassword;
 extern crate rustotpony;
 
 use clap::{App, Arg, SubCommand};
-use rustotpony::*;
+use rustotpony::databases::json::JsonDatabase;
+use rustotpony::RusTOTPony;
 use std::collections::HashMap;
 use std::path::{Path, PathBuf};
 use std::thread;

src/databases/json.rs

@@ -0,0 +1,237 @@
+use crypto::buffer::{BufferResult, ReadBuffer, WriteBuffer};
+use crypto::digest::Digest;
+use crypto::sha2::Sha256;
+use crypto::{aes, blockmodes, buffer, symmetriccipher};
+use databases::Database;
+use generators::TOTP;
+use std::collections::HashMap;
+use std::fs::{create_dir_all, File, OpenOptions};
+use std::io::ErrorKind;
+use std::io::Write;
+use std::path::{Path, PathBuf};
+
+use rand::{OsRng, Rng};
+
+const DATABASE_VERSION: u8 = 1;
+
+pub struct JsonDatabase {
+    file_path: PathBuf,
+    secret_fn: &'static Fn() -> String,
+}
+
+// Database implementation for JSON database
+impl Database for JsonDatabase {
+    fn get_applications(&self) -> HashMap<String, TOTP> {
+        let db_content = self.read_database_file();
+        db_content.content.applications
+    }
+
+    fn save_applications(&self, applications: &HashMap<String, TOTP>) {
+        let mut db_content = Self::get_empty_schema();
+        db_content.content.applications = applications.clone();
+        self.save_database_file(db_content);
+    }
+}
+
+#[derive(Serialize, Deserialize)]
+struct JsonDatabaseSchema {
+    version: u8,
+    content: DatabaseContentSchema,
+}
+
+#[derive(Serialize, Deserialize)]
+struct DatabaseContentSchema {
+    applications: HashMap<String, TOTP>,
+}
+
+const IV_SIZE: usize = 16;
+const KEY_SIZE: usize = 32;
+impl JsonDatabase {
+    pub fn new(path: PathBuf, secret_fn: &'static Fn() -> String) -> JsonDatabase {
+        JsonDatabase {
+            file_path: path,
+            secret_fn: secret_fn,
+        }
+    }
+
+    fn form_secret_key(input: &str) -> [u8; KEY_SIZE] {
+        let mut sha = Sha256::new();
+        sha.input_str(input);
+        let mut res: [u8; KEY_SIZE] = [0; KEY_SIZE];
+        sha.result(&mut res);
+        return res;
+    }
+
+    fn read_database_file(&self) -> JsonDatabaseSchema {
+        let data = match std::fs::read(&self.file_path) {
+            Ok(d) => d,
+            Err(ref err) if err.kind() == ErrorKind::NotFound => return Self::get_empty_schema(),
+            Err(err) => panic!("There was a problem opening file: {:?}", err),
+        };
+        let decrypted_data =
+            Self::decrypt_data(&data, &Self::form_secret_key((self.secret_fn)().as_str()));
+        serde_json::from_str(decrypted_data.as_str())
+            .expect("Couldn't parse JSON from database file")
+    }
+
+    fn decrypt_data(data: &[u8], key: &[u8]) -> String {
+        let iv = &data[..IV_SIZE];
+        String::from_utf8(Self::decrypt(&data[IV_SIZE..], key, iv).expect("Couldn't decrypt data"))
+            .ok()
+            .unwrap()
+    }
+
+    fn encrypt_data(data: &str, key: &[u8]) -> Vec<u8> {
+        let iv = Self::create_iv();
+        let encrypted_data =
+            Self::encrypt(data.as_bytes(), key, &iv).expect("Couldn't encrypt data");
+        [&iv, &encrypted_data[..]].concat()
+    }
+
+    fn create_iv() -> Vec<u8> {
+        let mut iv = vec![0; IV_SIZE];
+        let mut rng = OsRng::new().ok().unwrap();
+        rng.fill_bytes(&mut iv);
+        iv
+    }
+
+    fn save_database_file(&self, content: JsonDatabaseSchema) {
+        let mut file = match self.open_database_file_for_write() {
+            Ok(f) => f,
+            Err(ref err) if err.kind() == ErrorKind::NotFound => self
+                .create_database_file()
+                .expect("Couldn't create database file"),
+            Err(err) => panic!("Couldn't open database file: {:?}", err),
+        };
+        let data = serde_json::to_string(&content).expect("Couldn't serialize data to JSON");
+        let encrypted_data =
+            Self::encrypt_data(&data, &Self::form_secret_key((self.secret_fn)().as_str()));
+        file.write_all(&encrypted_data)
+            .expect("Couldn't write data to database file");
+    }
+
+    // Encrypt a buffer with the given key and iv using
+    // AES-256/CBC/Pkcs encryption.
+    fn encrypt(
+        data: &[u8],
+        key: &[u8],
+        iv: &[u8],
+    ) -> Result<Vec<u8>, symmetriccipher::SymmetricCipherError> {
+        // Create an encryptor instance of the best performing
+        // type available for the platform.
+        let mut encryptor =
+            aes::cbc_encryptor(aes::KeySize::KeySize256, key, iv, blockmodes::PkcsPadding);
+
+        // Each encryption operation encrypts some data from
+        // an input buffer into an output buffer. Those buffers
+        // must be instances of RefReaderBuffer and RefWriteBuffer
+        // (respectively) which keep track of how much data has been
+        // read from or written to them.
+        let mut final_result = Vec::<u8>::new();
+        let mut read_buffer = buffer::RefReadBuffer::new(data);
+        let mut buffer = [0; 4096];
+        let mut write_buffer = buffer::RefWriteBuffer::new(&mut buffer);
+
+        // Each encryption operation will "make progress". "Making progress"
+        // is a bit loosely defined, but basically, at the end of each operation
+        // either BufferUnderflow or BufferOverflow will be returned (unless
+        // there was an error). If the return value is BufferUnderflow, it means
+        // that the operation ended while wanting more input data. If the return
+        // value is BufferOverflow, it means that the operation ended because it
+        // needed more space to output data. As long as the next call to the encryption
+        // operation provides the space that was requested (either more input data
+        // or more output space), the operation is guaranteed to get closer to
+        // completing the full operation - ie: "make progress".
+        //
+        // Here, we pass the data to encrypt to the enryptor along with a fixed-size
+        // output buffer. The 'true' flag indicates that the end of the data that
+        // is to be encrypted is included in the input buffer (which is true, since
+        // the input data includes all the data to encrypt). After each call, we copy
+        // any output data to our result Vec. If we get a BufferOverflow, we keep
+        // going in the loop since it means that there is more work to do. We can
+        // complete as soon as we get a BufferUnderflow since the encryptor is telling
+        // us that it stopped processing data due to not having any more data in the
+        // input buffer.
+        loop {
+            let result = try!(encryptor.encrypt(&mut read_buffer, &mut write_buffer, true));
+
+            // "write_buffer.take_read_buffer().take_remaining()" means:
+            // from the writable buffer, create a new readable buffer which
+            // contains all data that has been written, and then access all
+            // of that data as a slice.
+            final_result.extend(
+                write_buffer
+                    .take_read_buffer()
+                    .take_remaining()
+                    .iter()
+                    .map(|&i| i),
+            );
+
+            match result {
+                BufferResult::BufferUnderflow => break,
+                BufferResult::BufferOverflow => {}
+            }
+        }
+
+        Ok(final_result)
+    }
+
+    // Decrypts a buffer with the given key and iv using
+    // AES-256/CBC/Pkcs encryption.
+    fn decrypt(
+        encrypted_data: &[u8],
+        key: &[u8],
+        iv: &[u8],
+    ) -> Result<Vec<u8>, symmetriccipher::SymmetricCipherError> {
+        let mut decryptor =
+            aes::cbc_decryptor(aes::KeySize::KeySize256, key, iv, blockmodes::PkcsPadding);
+
+        let mut final_result = Vec::<u8>::new();
+        let mut read_buffer = buffer::RefReadBuffer::new(encrypted_data);
+        let mut buffer = [0; 4096];
+        let mut write_buffer = buffer::RefWriteBuffer::new(&mut buffer);
+
+        loop {
+            let result = try!(decryptor.decrypt(&mut read_buffer, &mut write_buffer, true));
+            final_result.extend(
+                write_buffer
+                    .take_read_buffer()
+                    .take_remaining()
+                    .iter()
+                    .map(|&i| i),
+            );
+            match result {
+                BufferResult::BufferUnderflow => break,
+                BufferResult::BufferOverflow => {}
+            }
+        }
+
+        Ok(final_result)
+    }
+
+    fn create_database_file(&self) -> Result<File, std::io::Error> {
+        let dir = std::env::home_dir().unwrap_or(PathBuf::from("."));
+        if let Some(parent_dir) = Path::new(&self.file_path).parent() {
+            let dir = dir.join(parent_dir);
+            create_dir_all(dir)?;
+        }
+        self.open_database_file_for_write()
+    }
+
+    fn open_database_file_for_write(&self) -> Result<File, std::io::Error> {
+        OpenOptions::new()
+            .write(true)
+            .truncate(true)
+            .create(true)
+            .open(&self.file_path)
+    }
+
+    fn get_empty_schema() -> JsonDatabaseSchema {
+        JsonDatabaseSchema {
+            version: DATABASE_VERSION,
+            content: DatabaseContentSchema {
+                applications: HashMap::new(),
+            },
+        }
+    }
+}

src/databases/mod.rs

@@ -0,0 +1,12 @@
+pub mod encrypted;
+pub mod json;
+
+use generators::TOTP;
+
+use std::collections::HashMap;
+
+// Database trait
+pub trait Database {
+    fn get_applications(&self) -> HashMap<String, TOTP>;
+    fn save_applications(&self, applications: &HashMap<String, TOTP>);
+}

src/generators.rs

@@ -0,0 +1,62 @@
+extern crate base32;
+extern crate oath;
+
+// Generator application struct
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct TOTP {
+    name: String,
+    secret: String,
+    username: String,
+    secret_bytes: Vec<u8>,
+}
+
+impl TOTP {
+    pub fn new(name: &str, username: &str, secret: &str, secret_bytes: Vec<u8>) -> Self {
+        TOTP {
+            name: String::from(name),
+            secret: String::from(secret),
+            username: String::from(username),
+            secret_bytes: secret_bytes,
+        }
+    }
+
+    pub fn new_base32(
+        name: &str,
+        username: &str,
+        base32_secret: &str,
+    ) -> Result<TOTP, String> {
+        if let Some(secret_bytes) = TOTP::base32_to_bytes(base32_secret) {
+            Ok(TOTP::new(name, username, base32_secret, secret_bytes))
+        } else {
+            Err(String::from("Couldn't decode secret key"))
+        }
+    }
+
+    pub fn get_name(&self) -> &str {
+        self.name.as_str()
+    }
+
+    pub fn set_name(&mut self, name: &str) {
+        self.name = String::from(name);
+    }
+
+    pub fn get_secret(&self) -> &str {
+        self.secret.as_str()
+    }
+
+    pub fn get_username(&self) -> &str {
+        self.username.as_str()
+    }
+
+    pub fn get_code(&self) -> u64 {
+        Self::totp(&self.secret_bytes)
+    }
+
+    fn base32_to_bytes(secret: &str) -> Option<Vec<u8>> {
+        base32::decode(base32::Alphabet::RFC4648 { padding: false }, secret)
+    }
+
+    fn totp(secret_bytes: &[u8]) -> u64 {
+        oath::totp_raw_now(&secret_bytes, 6, 0, 30, &oath::HashType::SHA1)
+    }
+}

src/lib.rs

@@ -1,32 +1,27 @@
 #![feature(fs_read_write)]
+#![feature(extern_prelude)]
 
-extern crate base32;
 extern crate crypto;
-extern crate oath;
 extern crate rand;
 extern crate serde_json;
 
 #[macro_use]
 extern crate serde_derive;
 
-use crypto::buffer::{BufferResult, ReadBuffer, WriteBuffer};
-use crypto::digest::Digest;
-use crypto::sha2::Sha256;
-use crypto::{aes, blockmodes, buffer, symmetriccipher};
+pub mod databases;
+mod generators;
 
-use rand::{OsRng, Rng};
+use databases::Database;
+use generators::TOTP;
 
 use std::collections::HashMap;
-use std::fs::{create_dir_all, File, OpenOptions};
-use std::io::ErrorKind;
-use std::io::Write;
-use std::path::{Path, PathBuf};
 
-const DATABASE_VERSION: u8 = 1;
 
+// Application struct
+// Contains database reference and in-memory generators (called «applications»)
 pub struct RusTOTPony<DB: Database> {
     database: DB,
-    applications: HashMap<String, GenApp>,
+    applications: HashMap<String, TOTP>,
 }
 
 impl<DB: Database> RusTOTPony<DB> {
@@ -43,17 +38,13 @@ impl<DB: Database> RusTOTPony<DB> {
         username: &str,
         secret: &str,
     ) -> Result<(), String> {
-        if let Some(secret_bytes) = GenApp::base32_to_bytes(secret) {
-            let new_app = GenApp::new(name, username, secret, secret_bytes);
+        let new_app = TOTP::new_base32(name, username, secret)?;
         if self.applications.contains_key(name) {
             Err(format!("Application with name '{}' already exists!", name))
         } else {
             &self.applications.insert(String::from(name), new_app);
             Ok(())
         }
-        } else {
-            return Err(String::from("Couldn't decode secret key"));
-        }
     }
 
     pub fn delete_application(&mut self, name: &str) -> Result<(), String> {
@@ -69,14 +60,14 @@ impl<DB: Database> RusTOTPony<DB> {
 
     pub fn rename_application(&mut self, name: &str, newname: &str) -> Result<(), String> {
         if let Some(app) = self.applications.get_mut(name) {
-            app.name = String::from(newname);
+            app.set_name(newname);
             Ok(())
         } else {
             Err(format!("Application '{}' wasn't found", name))
         }
     }
 
-    pub fn get_applications(&self) -> Result<&HashMap<String, GenApp>, String> {
+    pub fn get_applications(&self) -> Result<&HashMap<String, TOTP>, String> {
         if self.applications.len() == 0 {
             Err(String::from("There are no applications"))
         } else {
@@ -84,7 +75,7 @@ impl<DB: Database> RusTOTPony<DB> {
         }
     }
 
-    pub fn get_application(&self, name: &str) -> Result<&GenApp, String> {
+    pub fn get_application(&self, name: &str) -> Result<&TOTP, String> {
         if let Some(app) = self.applications.get(name) {
             Ok(app)
         } else {
@@ -101,270 +92,6 @@ impl<DB: Database> RusTOTPony<DB> {
     }
 }
 
-pub trait Database {
-    fn get_applications(&self) -> HashMap<String, GenApp>;
-    fn save_applications(&self, applications: &HashMap<String, GenApp>);
-}
-
-impl Database for JsonDatabase {
-    fn get_applications(&self) -> HashMap<String, GenApp> {
-        let db_content = self.read_database_file();
-        db_content.content.applications
-    }
-
-    fn save_applications(&self, applications: &HashMap<String, GenApp>) {
-        let mut db_content = Self::get_empty_schema();
-        db_content.content.applications = applications.clone();
-        self.save_database_file(db_content);
-    }
-}
-
-#[derive(Serialize, Deserialize)]
-struct JsonDatabaseSchema {
-    version: u8,
-    content: DatabaseContentSchema,
-}
-
-#[derive(Serialize, Deserialize)]
-struct DatabaseContentSchema {
-    applications: HashMap<String, GenApp>,
-}
-
-pub struct JsonDatabase {
-    file_path: PathBuf,
-    secret_fn: &'static Fn() -> String,
-}
-
-const IV_SIZE: usize = 16;
-const KEY_SIZE: usize = 32;
-impl JsonDatabase {
-    pub fn new(path: PathBuf, secret_fn: &'static Fn() -> String) -> JsonDatabase {
-        JsonDatabase {
-            file_path: path,
-            secret_fn: secret_fn,
-        }
-    }
-
-    fn form_secret_key(input: &str) -> [u8; KEY_SIZE] {
-        let mut sha = Sha256::new();
-        sha.input_str(input);
-        let mut res: [u8; KEY_SIZE] = [0; KEY_SIZE];
-        sha.result(&mut res);
-        return res;
-    }
-
-    fn read_database_file(&self) -> JsonDatabaseSchema {
-        let data = match std::fs::read(&self.file_path) {
-            Ok(d) => d,
-            Err(ref err) if err.kind() == ErrorKind::NotFound => return Self::get_empty_schema(),
-            Err(err) => panic!("There was a problem opening file: {:?}", err),
-        };
-        let decrypted_data =
-            Self::decrypt_data(&data, &Self::form_secret_key((self.secret_fn)().as_str()));
-        serde_json::from_str(decrypted_data.as_str())
-            .expect("Couldn't parse JSON from database file")
-    }
-
-    fn decrypt_data(data: &[u8], key: &[u8]) -> String {
-        let iv = &data[..IV_SIZE];
-        String::from_utf8(Self::decrypt(&data[IV_SIZE..], key, iv).expect("Couldn't decrypt data"))
-            .ok()
-            .unwrap()
-    }
-
-    fn encrypt_data(data: &str, key: &[u8]) -> Vec<u8> {
-        let iv = Self::create_iv();
-        let encrypted_data =
-            Self::encrypt(data.as_bytes(), key, &iv).expect("Couldn't encrypt data");
-        [&iv, &encrypted_data[..]].concat()
-    }
-
-    fn create_iv() -> Vec<u8> {
-        let mut iv = vec![0; IV_SIZE];
-        let mut rng = OsRng::new().ok().unwrap();
-        rng.fill_bytes(&mut iv);
-        iv
-    }
-
-    fn save_database_file(&self, content: JsonDatabaseSchema) {
-        let mut file = match self.open_database_file_for_write() {
-            Ok(f) => f,
-            Err(ref err) if err.kind() == ErrorKind::NotFound => self.create_database_file()
-                .expect("Couldn't create database file"),
-            Err(err) => panic!("Couldn't open database file: {:?}", err),
-        };
-        let data = serde_json::to_string(&content).expect("Couldn't serialize data to JSON");
-        let encrypted_data =
-            Self::encrypt_data(&data, &Self::form_secret_key((self.secret_fn)().as_str()));
-        file.write_all(&encrypted_data)
-            .expect("Couldn't write data to database file");
-    }
-
-    // Encrypt a buffer with the given key and iv using
-    // AES-256/CBC/Pkcs encryption.
-    fn encrypt(
-        data: &[u8],
-        key: &[u8],
-        iv: &[u8],
-    ) -> Result<Vec<u8>, symmetriccipher::SymmetricCipherError> {
-        // Create an encryptor instance of the best performing
-        // type available for the platform.
-        let mut encryptor =
-            aes::cbc_encryptor(aes::KeySize::KeySize256, key, iv, blockmodes::PkcsPadding);
-
-        // Each encryption operation encrypts some data from
-        // an input buffer into an output buffer. Those buffers
-        // must be instances of RefReaderBuffer and RefWriteBuffer
-        // (respectively) which keep track of how much data has been
-        // read from or written to them.
-        let mut final_result = Vec::<u8>::new();
-        let mut read_buffer = buffer::RefReadBuffer::new(data);
-        let mut buffer = [0; 4096];
-        let mut write_buffer = buffer::RefWriteBuffer::new(&mut buffer);
-
-        // Each encryption operation will "make progress". "Making progress"
-        // is a bit loosely defined, but basically, at the end of each operation
-        // either BufferUnderflow or BufferOverflow will be returned (unless
-        // there was an error). If the return value is BufferUnderflow, it means
-        // that the operation ended while wanting more input data. If the return
-        // value is BufferOverflow, it means that the operation ended because it
-        // needed more space to output data. As long as the next call to the encryption
-        // operation provides the space that was requested (either more input data
-        // or more output space), the operation is guaranteed to get closer to
-        // completing the full operation - ie: "make progress".
-        //
-        // Here, we pass the data to encrypt to the enryptor along with a fixed-size
-        // output buffer. The 'true' flag indicates that the end of the data that
-        // is to be encrypted is included in the input buffer (which is true, since
-        // the input data includes all the data to encrypt). After each call, we copy
-        // any output data to our result Vec. If we get a BufferOverflow, we keep
-        // going in the loop since it means that there is more work to do. We can
-        // complete as soon as we get a BufferUnderflow since the encryptor is telling
-        // us that it stopped processing data due to not having any more data in the
-        // input buffer.
-        loop {
-            let result = try!(encryptor.encrypt(&mut read_buffer, &mut write_buffer, true));
-
-            // "write_buffer.take_read_buffer().take_remaining()" means:
-            // from the writable buffer, create a new readable buffer which
-            // contains all data that has been written, and then access all
-            // of that data as a slice.
-            final_result.extend(
-                write_buffer
-                    .take_read_buffer()
-                    .take_remaining()
-                    .iter()
-                    .map(|&i| i),
-            );
-
-            match result {
-                BufferResult::BufferUnderflow => break,
-                BufferResult::BufferOverflow => {}
-            }
-        }
-
-        Ok(final_result)
-    }
-
-    // Decrypts a buffer with the given key and iv using
-    // AES-256/CBC/Pkcs encryption.
-    fn decrypt(
-        encrypted_data: &[u8],
-        key: &[u8],
-        iv: &[u8],
-    ) -> Result<Vec<u8>, symmetriccipher::SymmetricCipherError> {
-        let mut decryptor =
-            aes::cbc_decryptor(aes::KeySize::KeySize256, key, iv, blockmodes::PkcsPadding);
-
-        let mut final_result = Vec::<u8>::new();
-        let mut read_buffer = buffer::RefReadBuffer::new(encrypted_data);
-        let mut buffer = [0; 4096];
-        let mut write_buffer = buffer::RefWriteBuffer::new(&mut buffer);
-
-        loop {
-            let result = try!(decryptor.decrypt(&mut read_buffer, &mut write_buffer, true));
-            final_result.extend(
-                write_buffer
-                    .take_read_buffer()
-                    .take_remaining()
-                    .iter()
-                    .map(|&i| i),
-            );
-            match result {
-                BufferResult::BufferUnderflow => break,
-                BufferResult::BufferOverflow => {}
-            }
-        }
-
-        Ok(final_result)
-    }
-
-    fn create_database_file(&self) -> Result<File, std::io::Error> {
-        let dir = std::env::home_dir().unwrap_or(PathBuf::from("."));
-        if let Some(parent_dir) = Path::new(&self.file_path).parent() {
-            let dir = dir.join(parent_dir);
-            create_dir_all(dir)?;
-        }
-        self.open_database_file_for_write()
-    }
-
-    fn open_database_file_for_write(&self) -> Result<File, std::io::Error> {
-        OpenOptions::new()
-            .write(true)
-            .truncate(true)
-            .create(true)
-            .open(&self.file_path)
-    }
-
-    fn get_empty_schema() -> JsonDatabaseSchema {
-        JsonDatabaseSchema {
-            version: DATABASE_VERSION,
-            content: DatabaseContentSchema {
-                applications: HashMap::new(),
-            },
-        }
-    }
-}
-
-#[derive(Serialize, Deserialize, Debug, Clone)]
-pub struct GenApp {
-    name: String,
-    secret: String,
-    username: String,
-    secret_bytes: Vec<u8>,
-}
-
-impl GenApp {
-    fn new(name: &str, username: &str, secret: &str, secret_bytes: Vec<u8>) -> Self {
-        GenApp {
-            name: String::from(name),
-            secret: String::from(secret),
-            username: String::from(username),
-            secret_bytes: secret_bytes,
-        }
-    }
-
-    pub fn get_name(&self) -> &str {
-        self.name.as_str()
-    }
-
-    pub fn get_secret(&self) -> &str {
-        self.secret.as_str()
-    }
-
-    pub fn get_username(&self) -> &str {
-        self.username.as_str()
-    }
-
-    pub fn get_code(&self) -> u64 {
-        Self::totp(&self.secret_bytes)
-    }
-
-    fn base32_to_bytes(secret: &str) -> Option<Vec<u8>> {
-        base32::decode(base32::Alphabet::RFC4648 { padding: false }, secret)
-    }
-
-    fn totp(secret_bytes: &[u8]) -> u64 {
-        oath::totp_raw_now(&secret_bytes, 6, 0, 30, &oath::HashType::SHA1)
-    }
-}
+// Application → Database (JsonDatabase, EncryptedDatabase)
+//     ↓            ↓
+//  GeneratorApplication