Struct oramfs::ORAMManager

pub struct ORAMManager;

Implementations

impl ORAMManager

pub fn config_path() -> String

pub fn list_orams(oneline: bool)

List ORAMs

pub fn add_oram(oram_name: String, cmd: CLISubCommand)

Add an ORAM

pub fn remove_oram(oram_name: String)

Remove an ORAM

pub fn get_config() -> ORAMFSConfig

Get global configuration

pub fn get_oram_config(name: String) -> ORAMConfig

Get a specific ORAM’s configuration

pub fn save_config(config: &ORAMFSConfig)

Save configuration to disk

pub fn mark_init(name: String)

Mark ORAM with name name as init=true and save configuration to disk

pub fn generate_encryption_key(
    name: String,
    passphrase: String,
    salt: String,
    cipher: String
) -> String

Generate an encryption key and save it (encrypted) in the ORAM’s configuration

pub fn serialize_key(encrypted_key: Vec<u8>, nonce: Vec<u8>) -> String

Serialize encrypted key and nonce

pub fn deserialize_key(serialized_key: String) -> (Vec<u8>, Vec<u8>)

Deserialize encrypted key and nonce

pub fn encrypt_key(
    key: Vec<u8>,
    cleartext: Vec<u8>
) -> Result<(Vec<u8>, Vec<u8>), Error>

Encrypt encryption key using AES256-GCM and return ciphertext and nonce

pub fn decrypt_key(
    key: Vec<u8>,
    ciphertext: Vec<u8>,
    nonce: Vec<u8>
) -> Result<Vec<u8>, Error>

Decrypt encryption key

pub fn derive_key(passphrase: &str, salt: &str) -> (Vec<u8>, String)

Derive a key from the given passphrase and salt

pub fn is_passphrase_valid(
    passphrase: String,
    salt: String,
    encrypted_encryption_key: String
) -> bool

Return true if the given passphrase is valid This effectively tries to decrypt the AEAD encrypted key. If the passphrase is not the right one, this will fail.

pub fn interactive_config(args: &mut ORAMConfig)

Interactively ask ORAM parameters from the user

pub fn ask_oram_size(args: &mut ORAMConfig)

Ask the ORAM size from the user and set it on the ORAMConfig instance

pub fn ask_client_data_dir(args: &mut ORAMConfig)

Interactively ask the client data directory from the user

pub fn ask_mountpoint(args: &mut ORAMConfig)

pub fn tmp_filename(old: i64, i: i64) -> String

Return temporary filename This is useful for the enlarge operation

pub fn unique_tmp_node_path(old: i64, i: i64, args: &ORAMConfig) -> String

Return temporary filepath This is useful for the enlarge operation

pub fn double(cmd: CLISubCommand)

Enlarges an existing oram by doubling its number of nodes. This should be called when the oram is unmounted.

pub fn do_double(args: &mut ORAMConfig, manual: bool)

Actually enlarge the ORAM

pub fn resize2fs_enlarge(args: ORAMConfig)

Run resize2fs on the ORAM file

pub fn get_passphrase() -> String

Interactively ask the passphrase from the user

pub fn get_passphrase_first_time() -> String

Interactively ask for a new passphrase from the user This will ask twice to confirm and make sure that both passphrases match