horcrust 1.0.0

Horcrust is a command-line-tool which splits a file into encrypted shards for safekeeping. As long as the specified threshold is met, a user can resurrect their original file at any time - no password necessary.
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

use std::path::PathBuf;
use clap::{Parser, Subcommand, Args, ArgAction};
use crate::utils::{is_qualified_path, shards_in_range, is_qualified_file};

pub static BANNER: &str = " ██░ ██  ▒█████   ██▀███   ▄████▄   ██▀███   █    ██   ██████ ▄▄▄█████▓
▓██░ ██▒▒██▒  ██▒▓██ ▒ ██▒▒██▀ ▀█  ▓██ ▒ ██▒ ██  ▓██▒▒██    ▒ ▓  ██▒ ▓▒
▒██▀▀██░▒██░  ██▒▓██ ░▄█ ▒▒▓█    ▄ ▓██ ░▄█ ▒▓██  ▒██░░ ▓██▄   ▒ ▓██░ ▒░
░▓█ ░██ ▒██   ██░▒██▀▀█▄  ▒▓▓▄ ▄██▒▒██▀▀█▄  ▓▓█  ░██░  ▒   ██▒░ ▓██▓ ░ 
░▓█▒░██▓░ ████▓▒░░██▓ ▒██▒▒ ▓███▀ ░░██▓ ▒██▒▒▒█████▓ ▒██████▒▒  ▒██▒ ░ 
 ▒ ░░▒░▒░ ▒░▒░▒░ ░ ▒▓ ░▒▓░░ ░▒ ▒  ░░ ▒▓ ░▒▓░░▒▓▒ ▒ ▒ ▒ ▒▓▒ ▒ ░  ▒ ░░   
 ▒ ░▒░ ░  ░ ▒ ▒░   ░▒ ░ ▒░  ░  ▒     ░▒ ░ ▒░░░▒░ ░ ░ ░ ░▒  ░ ░    ░    
 ░  ░░ ░░ ░ ░ ▒    ░░   ░ ░          ░░   ░  ░░░ ░ ░ ░  ░  ░    ░      
 ░  ░  ░    ░ ░     ░     ░ ░         ░        ░           ░           
                          ░                                            ";


#[derive(Parser)]
#[command(
    name="horcrust",
    bin_name="hx", 
    version = option_env!("CARGO_PKG_VERSION").unwrap_or("dev"),
    about = "Split a file into encrypted shards, no password required - secrecy preserved.", 
    long_about = "Horcrust is an encryption program that splits a file into encrypted shards. Users can set a threshold, defining the number required for secret recovery, eliminating the need for passwords. Horcrust supports piped input. For example, you can use it like this: cat secret.txt | hx split -s 3 -t 2.",
    subcommand_required = true,
    arg_required_else_help = true,
)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Commands,
}

#[derive(Subcommand)]
pub enum Commands {
    #[command(about = "Split a file into desired shards and threshold.")]
    Split(SplitArguments),
    #[command(about = "Recover the secret.")]
    Bind(BindArguments)
}

#[derive(Args)]
pub struct SplitArguments {
    #[arg(
        required = false, 
        index = 1, 
        help = "The secret to split",
        value_parser = is_qualified_file,
        action = ArgAction::Set,
    )]
    pub file: Option<PathBuf>,
    #[arg(
        required = true, 
        short = 's', 
        long = "shards",
        help = "Number of shards to split the secret into.",
        value_parser = shards_in_range,
        action = ArgAction::Set,
    )]
    pub shards: u8,
    #[arg(
        required = true, 
        short = 't', 
        long = "threshold",
        help = "Number of shards required to resurrect the original secret.",
        value_parser = shards_in_range,
        action = ArgAction::Set,
    )]
    pub threshold: u8,
    #[arg(
        required = false, 
        short = 'd', 
        long = "destination",
        help = "Where to place the horcruxes, a new directory will be created if specified one does not exist.",
        value_parser = is_qualified_path,
        default_value = ".",
        action = ArgAction::Set,
    )]
    pub destination: Option<PathBuf>,
}

#[derive(Args)]
pub struct BindArguments { 
    #[arg(
        required = true, 
        index = 1,
        help = "Source directory that contains the horcruxes.",
        value_parser = is_qualified_path,
        default_value = ".",
        action = ArgAction::Set,
    )]
    pub source: Option<PathBuf>,
    #[arg(
        required = false, 
        short = 'd', 
        long = "destination",
        help = "Where to place the recovered secret, a new directory will be created if the provided one doesn't exist.",
        value_parser = is_qualified_path,
        default_value = ".",
        action = ArgAction::Set,
    )]
    pub destination: Option<PathBuf>
}