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
use crate::checkers::CheckerTypes;
use super::crack_results::CrackResult;
///! The Interface defines what the struct for each decoder looks like
//TODO: rename this file
pub struct Decoder<Type> {
/// The English name of the decoder.
pub name: &'static str,
/// A description, you can take the first line from Wikipedia
/// Sometimes our decoders do not exist on Wikipedia so we write our own.
pub description: &'static str,
/// Wikipedia Link
pub link: &'static str,
/// The tags it has. See other decoders. Think of it as a "category"
/// This is used to filter decoders.
/// For example, if you want to filter decoders that are "base64"
/// you would use the tag "base64" or "base".
/// You can also add tags like "online" to filter decoders that are online.
pub tags: Vec<&'static str>,
/// We get popularity by eye-balling it or using the API's data
pub popularity: f32,
/// we don't use the Type, so we use PhantomData to mark it!
pub phantom: std::marker::PhantomData<Type>,
}
/// The default implementation for a decoder
pub struct DefaultDecoder;
impl Default for Decoder<DefaultDecoder> {
fn default() -> Decoder<DefaultDecoder> {
Decoder {
name: "Default decoder",
description: "N/A",
link: "N/A",
tags: vec!["N/A"],
popularity: 0.0,
phantom: std::marker::PhantomData,
}
}
}
/// All decoders will share the same Crack trait
/// Which let's us put them into a vector and iterate over them,
/// Running `.crack()` on each of them.
/// Relevant docs: https://docs.rs/crack/0.3.0/crack/trait.Crack.html
pub trait Crack {
/// This function generates a new crack trait
fn new() -> Self
where
Self: Sized;
/// Crack is the function that actually does the decoding
fn crack(&self, text: &str, checker: &CheckerTypes) -> CrackResult;
/// Get all tags for the current decoder
fn get_tags(&self) -> &Vec<&str>;
/// Get the nam of the current decoder
fn get_name(&self) -> &str;
}
/// Returns a boolean of True if the string is successfully changed
/// So empty strings fail, but non-empty strings succeed
/// and only if the string is different from the original text.
pub fn check_string_success(decoded_text: &str, original_text: &str) -> bool {
if decoded_text.is_empty() {
return false;
} else if decoded_text != original_text {
return true;
}
false
}