cryptr 0.10.0

simple encrypted (streaming) values
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use clap::{Parser, Subcommand};

/// cryptr
#[derive(Debug, Parser)]
#[command(author, version, about, long_about = None)]
pub enum Args {
    /// Encryption Module
    Encrypt(ArgsEncryptDecrypt),
    /// Decryption Module
    Decrypt(ArgsEncryptDecrypt),
    /// Encryption Keys Management
    #[command(subcommand)]
    Keys(ArgsKeys),
    /// S3 Access Credentials
    #[command(subcommand)]
    S3(ArgsS3),
}

#[derive(Debug, Parser)]
pub struct ArgsEncryptDecrypt {
    /// The source - format:
    /// File         -> file:/path/to/your/file
    /// S3           -> s3:/bucket_name/object_name
    /// Shell Input  -> leave empty
    #[arg(short, long, verbatim_doc_comment)]
    pub from: Option<String>,

    /// The target - format:
    /// File         -> file:/path/to/your/file
    /// S3           -> s3:/bucket_name/object_name
    /// Shell Output -> leave empty
    #[arg(short, long, verbatim_doc_comment)]
    pub to: Option<String>,

    /// If you want to use a specific password
    #[arg(short = 'p', long)]
    pub with_password: bool,

    /// If you want to use a specific encryption key id from your config
    /// instead of the default active one.
    /// Will be ignored for decryption.
    #[arg(short = 'k', long, verbatim_doc_comment)]
    pub with_key_id: Option<String>,

    /// Print out progress to the console
    #[arg(short, long)]
    pub show_progress: bool,

    /// If you need to connect to a host for which TLS certificates cannot be verified
    #[arg(long)]
    pub insecure: bool,
}

impl ArgsEncryptDecrypt {
    pub fn from_to_fmt() -> String {
        r#"Format:
File         -> file:/path/to/your/file
S3           -> s3:bucket_name/object_name
Shell Input  -> leave empty
"#
        .to_string()
    }
}

#[derive(Debug, Clone, Subcommand)]
pub enum ArgsKeys {
    /// Convert keys between different formats
    #[command(subcommand)]
    Convert(ArgsKeysConvert),
    /// List your keys
    List(ArgsKeysList),
    /// Generates a new random key and sets it as default
    NewRandom(ArgsKeysNew),
    /// Change the currently active key
    SetActive,
    /// Import keys
    Import(ArgsKeysImport),
    /// Export keys
    Export(ArgsKeysExport),
    /// Delete an encryption key from the config
    Delete,
}

#[derive(Debug, Clone, Subcommand)]
pub enum ArgsKeysConvert {
    /// Convert keys between different formats
    LegacyString,
}

#[derive(Debug, Clone, Parser)]
pub struct ArgsKeysList {
    /// Specify a file to read the keys from. Default: $HOME/.crypt/keys
    #[arg(short, long)]
    pub file: Option<String>,

    /// Print the actual key value
    #[arg(short, long)]
    pub show_values: bool,
}

#[derive(Debug, Clone, Parser)]
pub struct ArgsKeysNew {
    /// Specify an ID for the new key
    #[arg(long)]
    pub with_id: Option<String>,
}

#[derive(Debug, Clone, Parser)]
pub struct ArgsKeysImport {
    /// Import sealed encryption keys from a file
    #[arg(short, long)]
    pub file: Option<String>,
}

#[derive(Debug, Clone, Parser)]
pub struct ArgsKeysExport {
    /// Optional output file path for the export
    #[arg(short, long)]
    pub file: Option<String>,

    /// Only export specific encryption key IDs given as a CSV
    #[arg(short, long)]
    pub ids: Option<String>,
}

#[derive(Debug, Clone, Parser)]
pub enum ArgsS3 {
    /// Shows the output of the current S3 config
    Show,
    /// Update the S3 config
    Update,
    /// List's the objects in the given bucket
    List(ArgsS3List),
}

#[derive(Debug, Clone, Parser)]
pub struct ArgsS3List {
    /// The name of the bucket
    #[arg(short, long)]
    pub bucket: String,

    /// If you need to connect to a host for which TLS certificates cannot be verified
    #[arg(long)]
    pub insecure: bool,
}