Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/multicatch/axxd
A simple axx file decryption tool.
https://github.com/multicatch/axxd
Last synced: 28 days ago
JSON representation
A simple axx file decryption tool.
- Host: GitHub
- URL: https://github.com/multicatch/axxd
- Owner: multicatch
- License: mit
- Created: 2021-07-13T17:00:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-22T09:46:02.000Z (over 2 years ago)
- Last Synced: 2024-09-07T12:54:51.837Z (2 months ago)
- Language: Rust
- Homepage:
- Size: 1.5 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# axxd
An **axx** file **d**ecryption tool.
This tool can decrypt AxCrypt-encrypted files.
I made this because I needed a simple native tool to decrypt axx files on Linux
and I didn't want to use WINE.
## Usage
The newest standalone version can be downladed from GitHub Releases or build from sources using `cargo build --release`.
```text
axxd 0.1.0
Axxd - an [axx] file [d]ecryptor
USAGE:
axxd [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
-n, --no-overwrite Abort when target file already exists
-o, --overwrite Overwrite target file if exists
-V, --version Prints version information
OPTIONS:
-f, --file Input file path
-p, --passphrase Encryption passphrase
```
If you don't specify `-f` or `-p` options, you will be asked for the missing parameters.
Example:
```text
$ ./axxd -p secret.axx
Enter passphrase:
test
Decrypting secret.axx...
File successfully decrypted. Saving into "secret.txt".
```
The app will ask you if a target file already exists.
To decrypt files in fully non-interactive mode, use `-o` or `-n`.
```text
$ ./axxd -f secret.axx
Enter passphrase:
test
Decrypting secret.axx...
File successfully decrypted. Saving into "secret.txt".
WARNING: File already exits. Proceed? [y/n]
n
Aborting.
$ ./axxd -f secret.axx -p test -n
Decrypting secret.axx...
File successfully decrypted. Saving into "secret.txt".
WARNING: File already exits. Aborting.
```
## Using the API
You can simply decrypt a file using a `decrypt_file>(path: P, passphrase: &str)` function.
It reads the file and then tries to decrypt it using a given passphrase.
Returns decrypted content as result.
```rust
match decrypt_file(&source_file, &pass) {
Ok(content) => save_file(content),
Err(e) => {
println!("Cannot decrypt file.");
display_error_and_quit(e);
}
}
```
You can also use `decrypt(data: &EncryptedContent, passphrase: &str)` to decrypt raw content.
To parse raw bytes into `EncryptedContent`, use the `parse` function
```rust
let data = EncryptedContent::parse(&input);
decrypt(&data, passphrase)
````