secured 0.6.0

A lightweight, easy-to-use Rust package for file encryption and decryption, suitable for both CLI and library integration in Rust applications.
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

use clap::{Parser, Subcommand};

mod utils;
pub use utils::{decrypt_files, encrypt_files};
use utils::{
  generate_encryption_key_with_options, get_password_or_prompt, inspect_files, Credentials,
};

/// Defines command line subcommands for the application.
#[derive(Debug, Subcommand)]
enum Command {
  /// Encrypts a specified file.
  Encrypt {
    /// Path to the files to be encrypted. Supports glob patterns.
    path: Vec<String>,

    /// Optional password. If not provided, it will be prompted for.
    #[arg(short, long)]
    password: Option<String>,

    /// Optional hex encoded encryption key. If not provided, it will be derived from the password.
    /// If provided, the password will be ignored.
    #[arg(short, long)]
    key: Option<String>,

    /// Wipe the original file after encryption.
    #[arg(short, long)]
    wipe: bool,
  },

  /// Decrypts a specified file.
  Decrypt {
    /// Path to the files to be decrypted. Supports glob patterns.
    path: Vec<String>,

    /// Optional password. If not provided, it will be prompted for.
    #[arg(short, long)]
    password: Option<String>,

    /// Optional hex encoded encryption key. If not provided, it will be derived from the password.
    /// If provided, the password will be ignored.
    #[arg(short, long)]
    key: Option<String>,

    /// Wipe the encrypted file after decryption.
    #[arg(short, long)]
    wipe: bool,
  },

  /// Derives a key from a given password.
  Key {
    /// Optional password. If not provided, it will be prompted for.
    #[arg(short, long)]
    password: Option<String>,

    /// Iterations to be used for key derivation.
    /// Defaults to 900,000.
    #[arg(short, long, default_value = "900000")]
    iterations: usize,

    /// Hex salt to be used for key derivation.
    /// Defaults to a random 16 byte array.
    #[arg(short, long)]
    salt: Option<String>,
  },

  /// Inspects a specified `.secured` file.
  Inspect {
    /// Path to the files to be inspected. Supports glob patterns.
    path: Vec<String>,
  },
}

/// Defines the command line arguments structure.
#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
struct Args {
  /// The specific subcommand to execute (either Encrypt or Decrypt).
  #[command(subcommand)]
  command: Command,
}

fn main() {
  let args = Args::parse();

  match args.command {
    Command::Encrypt {
      path,
      password,
      key,
      wipe,
    } => match key {
      Some(key) => encrypt_files(&Credentials::HexKey(key), path, wipe),
      None => {
        let password = get_password_or_prompt(password, true);
        encrypt_files(&Credentials::Password(password), path, wipe);
      }
    },
    Command::Decrypt {
      path,
      password,
      key,
      wipe,
    } => match key {
      Some(key) => decrypt_files(&Credentials::HexKey(key), path, wipe),
      None => {
        let password = get_password_or_prompt(password, false);
        decrypt_files(&Credentials::Password(password), path, wipe);
      }
    },
    Command::Key {
      password,
      iterations,
      salt,
    } => {
      let password = get_password_or_prompt(password, true);
      generate_encryption_key_with_options(&password, iterations, salt);
    }
    Command::Inspect { path } => inspect_files(path),
  }
}