Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Encoding #329

Merged
merged 7 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions docs/_docs/user-guide/eldritch.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,3 +548,45 @@ The <b>crypto.hash_file</b> method will produce the hash of the given file's con
- SHA1
- SHA256
- SHA512

### crypto.encode_b64
`crypto.encode_b64(content: str, encode_type: Optional<str>) -> str`

The <b>crypto.encode_b64</b> method encodes the given text using the given base64 encoding method. Valid methods include:

- STANDARD (default)
- STANDARD_NO_PAD
- URL_SAFE
- URL_SAFE_NO_PAD

### crypto.decode_b64
`crypto.decode_b64(content: str, decode_type: Optional<str>) -> str`

The <b>crypto.decode_b64</b> method encodes the given text using the given base64 decoding method. Valid methods include:

- STANDARD (default)
- STANDARD_NO_PAD
- URL_SAFE
- URL_SAFE_NO_PAD

### crypto.from_json
`crypto.from_json(content: str) -> Value`

The <b>crypto.from_json</b> method converts JSON text to an object of correct type.
jabbate19 marked this conversation as resolved.
Show resolved Hide resolved

```python
crypto.from_json("{\"foo\":\"bar\"}")
{
"foo": "bar"
}
```

### crypto.to_json
`crypto.to_json(content: Value) -> str`

The <b>crypto.to_json</b> method converts given type to JSON text.

```python
crypto.to_json({"foo": "bar"})
"{\"foo\":\"bar\"}"
```
1 change: 1 addition & 0 deletions implants/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ anyhow = "1.0.65"
assert_cmd = "2.0.6"
async-recursion = "1.0.0"
async-trait = "0.1.68"
base64 = "0.21.4"
chrono = "0.4.24"
clap = "3.2.23"
default-net = "0.13.1"
Expand Down
1 change: 1 addition & 0 deletions implants/lib/eldritch/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ allocative_derive = { workspace = true }
anyhow = { workspace = true }
async-recursion = { workspace = true }
async-trait = { workspace = true }
base64 = { workspace = true }
chrono = { workspace = true }
derive_more = { workspace = true }
eval = { workspace = true }
Expand Down
20 changes: 20 additions & 0 deletions implants/lib/eldritch/src/crypto.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
mod aes_encrypt_file_impl;
mod aes_decrypt_file_impl;
mod hash_file_impl;
mod encode_b64_impl;
mod decode_b64_impl;
mod from_json_impl;
mod to_json_impl;

use allocative::Allocative;
use derive_more::Display;
Expand Down Expand Up @@ -64,4 +68,20 @@
if false { println!("Ignore unused this var. _this isn't allowed by starlark. {:?}", this); }
hash_file_impl::hash_file(file, algo)
}
fn encode_b64<'v>(this: CryptoLibrary, content: String, encode_type: Option<String>) -> anyhow::Result<String> {
if false { println!("Ignore unused this var. _this isn't allowed by starlark. {:?}", this); }

Check warning on line 72 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L72

Added line #L72 was not covered by tests
encode_b64_impl::encode_b64(content, encode_type)
}

Check warning on line 74 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L74

Added line #L74 was not covered by tests
fn decode_b64<'v>(this: CryptoLibrary, content: String, encode_type: Option<String>) -> anyhow::Result<String> {
if false { println!("Ignore unused this var. _this isn't allowed by starlark. {:?}", this); }

Check warning on line 76 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L76

Added line #L76 was not covered by tests
decode_b64_impl::decode_b64(content, encode_type)
}

Check warning on line 78 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L78

Added line #L78 was not covered by tests
fn from_json<'v>(this: CryptoLibrary, starlark_heap: &'v Heap, content: String) -> anyhow::Result<Value<'v>> {
if false { println!("Ignore unused this var. _this isn't allowed by starlark. {:?}", this); }

Check warning on line 80 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L80

Added line #L80 was not covered by tests
from_json_impl::from_json(starlark_heap, content)
}

Check warning on line 82 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L82

Added line #L82 was not covered by tests
fn to_json<'v>(this: CryptoLibrary, content: Value) -> anyhow::Result<String> {
if false { println!("Ignore unused this var. _this isn't allowed by starlark. {:?}", this); }

Check warning on line 84 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L84

Added line #L84 was not covered by tests
to_json_impl::to_json(content)
}

Check warning on line 86 in implants/lib/eldritch/src/crypto.rs

View check run for this annotation

Codecov / codecov/patch

implants/lib/eldritch/src/crypto.rs#L86

Added line #L86 was not covered by tests
}
51 changes: 51 additions & 0 deletions implants/lib/eldritch/src/crypto/decode_b64_impl.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
use anyhow::{anyhow, Result};
use base64::{Engine, engine::general_purpose};

pub fn decode_b64(content: String, encode_type: Option<String>) -> Result<String> {
let decode_type = match encode_type.unwrap_or("STANDARD".to_string()).as_str() {
"STANDARD" => {general_purpose::STANDARD},
"STANDARD_NO_PAD" => {general_purpose::STANDARD_NO_PAD},
"URL_SAFE" => {general_purpose::URL_SAFE},
"URL_SAFE_NO_PAD" => {general_purpose::URL_SAFE_NO_PAD},
_ => return Err(anyhow!("Invalid encode type. Valid types are: STANDARD, STANDARD_NO_PAD, URL_SAFE_PAD, URL_SAFE_NO_PAD"))
};
decode_type.decode(content.as_bytes()).map(|res| String::from_utf8_lossy(&res).to_string()).map_err(|e| anyhow!("Error decoding base64: {:?}", e))
}

#[cfg(test)]
mod tests {
#[test]
fn test_decode_b64() -> anyhow::Result<()>{
let res = super::decode_b64("dGVzdA==".to_string(), Some("STANDARD".to_string()))?;
assert_eq!(res, "test");
let res = super::decode_b64("dGVzdA".to_string(), Some("STANDARD_NO_PAD".to_string()))?;
assert_eq!(res, "test");
let res = super::decode_b64("aHR0cHM6Ly9nb29nbGUuY29tLyY=".to_string(), Some("URL_SAFE".to_string()))?;
assert_eq!(res, "https://google.com/&");
let res = super::decode_b64("aHR0cHM6Ly9nb29nbGUuY29tLyY".to_string(), Some("URL_SAFE_NO_PAD".to_string()))?;
assert_eq!(res, "https://google.com/&");
Ok(())
}

#[test]
fn test_decode_b64_invalid_type() -> anyhow::Result<()>{
let res = super::decode_b64("test".to_string(), Some("INVALID".to_string()));
assert!(res.is_err());
Ok(())
}

#[test]
fn test_decode_b64_default_type() -> anyhow::Result<()>{
let res = super::decode_b64("dGVzdA==".to_string(), None)?;
assert_eq!(res, "test");
Ok(())
}

#[test]
fn test_decode_b64_invalid_content() -> anyhow::Result<()>{
let res = super::decode_b64("///".to_string(), Some("STANDARD".to_string()));
assert!(res.is_err());
Ok(())
}

}
43 changes: 43 additions & 0 deletions implants/lib/eldritch/src/crypto/encode_b64_impl.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
use anyhow::{anyhow, Result};
use base64::{Engine, engine::general_purpose};

pub fn encode_b64(content: String, encode_type: Option<String>) -> Result<String> {
let encode_type = match encode_type.unwrap_or("STANDARD".to_string()).as_str() {
"STANDARD" => {general_purpose::STANDARD},
"STANDARD_NO_PAD" => {general_purpose::STANDARD_NO_PAD},
"URL_SAFE" => {general_purpose::URL_SAFE},
"URL_SAFE_NO_PAD" => {general_purpose::URL_SAFE_NO_PAD},
_ => return Err(anyhow!("Invalid encode type. Valid types are: STANDARD, STANDARD_NO_PAD, URL_SAFE_PAD, URL_SAFE_NO_PAD"))
};
Ok(encode_type.encode(content.as_bytes()))
}

#[cfg(test)]
mod tests {
#[test]
fn test_encode_b64() -> anyhow::Result<()>{
let res = super::encode_b64("test".to_string(), Some("STANDARD".to_string()))?;
assert_eq!(res, "dGVzdA==");
let res = super::encode_b64("test".to_string(), Some("STANDARD_NO_PAD".to_string()))?;
assert_eq!(res, "dGVzdA");
let res = super::encode_b64("https://google.com/&".to_string(), Some("URL_SAFE".to_string()))?;
assert_eq!(res, "aHR0cHM6Ly9nb29nbGUuY29tLyY=");
let res = super::encode_b64("https://google.com/&".to_string(), Some("URL_SAFE_NO_PAD".to_string()))?;
assert_eq!(res, "aHR0cHM6Ly9nb29nbGUuY29tLyY");
Ok(())
}

#[test]
fn test_encode_b64_invalid_type() -> anyhow::Result<()>{
let res = super::encode_b64("test".to_string(), Some("INVALID".to_string()));
assert!(res.is_err());
Ok(())
}

#[test]
fn test_encode_b64_default_type() -> anyhow::Result<()>{
let res = super::encode_b64("test".to_string(), None)?;
assert_eq!(res, "dGVzdA==");
Ok(())
}
}
40 changes: 40 additions & 0 deletions implants/lib/eldritch/src/crypto/from_json_impl.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
use anyhow::{anyhow, Result};
use starlark::values::{Heap, Value};

pub fn from_json(starlark_heap: &Heap, json: String) -> Result<Value> {
jabbate19 marked this conversation as resolved.
Show resolved Hide resolved
let json_data: serde_json::Value = serde_json::from_str(&json).map_err(|e| anyhow!("Error parsing json: {:?}", e))?;

Ok(starlark_heap.alloc(json_data.clone()))
}

#[cfg(test)]
mod tests {
use serde_json::json;
use starlark::values::{Heap, Value};

#[test]
fn test_from_json_object() -> anyhow::Result<()>{
let test_heap = Heap::new();
let res = super::from_json(&test_heap, r#"{"test": "test"}"#.to_string())?;
let res_value = test_heap.alloc(json!({"test": "test"}));
assert_eq!(res, res_value);
Ok(())
}

#[test]
fn test_from_json_list() -> anyhow::Result<()>{
let test_heap = Heap::new();
let res = super::from_json(&test_heap, r#"[1, "foo", false, null]"#.to_string())?;
let res_value = test_heap.alloc(json!([1, "foo", false, null]));
assert_eq!(res, res_value);
Ok(())
}

#[test]
fn test_from_json_invalid() -> anyhow::Result<()>{
let test_heap = Heap::new();
let res = super::from_json(&test_heap, r#"{"test":"#.to_string());
assert!(res.is_err());
Ok(())
}
}
40 changes: 40 additions & 0 deletions implants/lib/eldritch/src/crypto/to_json_impl.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
use anyhow::Result;
use starlark::values::Value;

pub fn to_json(json: Value) -> Result<String> {
jabbate19 marked this conversation as resolved.
Show resolved Hide resolved
json.to_json()
}

#[cfg(test)]
mod tests {
use starlark::{values::{dict::Dict, Heap, Value}, const_frozen_string, collections::SmallMap};
use anyhow::Result;

#[test]
fn to_json_object() -> Result<()> {
let test_heap = Heap::new();
let res = SmallMap::new();
let mut dict_res = Dict::new(res);
dict_res.insert_hashed(
const_frozen_string!("test").to_value().get_hashed()?,
test_heap.alloc_str("test").to_value(),
);
let res = super::to_json(test_heap.alloc(dict_res))?;
assert_eq!(res, r#"{"test":"test"}"#);
Ok(())
}

#[test]
fn to_json_list() -> Result<()> {
let test_heap = Heap::new();
let mut vec_val: Vec<Value> = Vec::new();
vec_val.push(test_heap.alloc(1));
vec_val.push(test_heap.alloc("foo"));
vec_val.push(test_heap.alloc(false));
vec_val.push(Value::new_none());
let res = test_heap.alloc(vec_val);
let res = super::to_json(res)?;
assert_eq!(res, r#"[1,"foo",false,null]"#);
Ok(())
}
}
2 changes: 1 addition & 1 deletion implants/lib/eldritch/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ dir(process) == ["kill", "list", "name"]
dir(sys) == ["dll_inject", "exec", "get_env", "get_ip", "get_os", "get_pid", "get_user", "is_linux", "is_macos", "is_windows", "shell"]
dir(pivot) == ["arp_scan", "bind_proxy", "ncat", "port_forward", "port_scan", "smb_exec", "ssh_copy", "ssh_exec", "ssh_password_spray"]
dir(assets) == ["copy","list","read","read_binary"]
dir(crypto) == ["aes_decrypt_file", "aes_encrypt_file", "hash_file"]
dir(crypto) == ["aes_decrypt_file", "aes_encrypt_file", "decode_b64", "encode_b64", "from_json", "hash_file", "to_json"]
"#,
);
}
Expand Down
Loading