https://github.com/dwisiswant0/unch
Hides message with invisible Unicode characters
https://github.com/dwisiswant0/unch
Last synced: 5 months ago
JSON representation
Hides message with invisible Unicode characters
- Host: GitHub
- URL: https://github.com/dwisiswant0/unch
- Owner: dwisiswant0
- License: apache-2.0
- Created: 2024-03-30T21:19:13.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-29T02:18:30.000Z (about 1 year ago)
- Last Synced: 2025-03-31T11:06:29.494Z (7 months ago)
- Language: Go
- Size: 19.5 KB
- Stars: 94
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yaml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# unch 😗
[](https://github.com/dwisiswant0/unch/actions/workflows/tests.yaml)
[](http://pkg.go.dev/github.com/dwisiswant0/unch/pkg/unch)
Hides message with invisible **Un**icode **ch**aracters.
**unch** lets you hide one string in another string by using VARIATION SELECTOR-17 (`E0100`) through VARIATION SELECTOR-25 (`E01EF`). It enables encoding of strings that contain characters beyond the standard ASCII range.
```mermaid
flowchart LR
MESSAGE[/"MESSAGE"/]
B64["BASE64"]
LOOP{{"for CHAR in BASE64"}}
APPEND[["OUTPUT += CHAR + E0100 offset"]]
OUTPUT[/"PLAINTEXT + OUTPUT"/]
MESSAGE -- "Encode" --> B64
B64 --> LOOP --> APPEND
APPEND --> OUTPUT
```
Table of Contents
* [Installation](#installation)
* [Binary](#binary)
* [Source](#source)
* [Docker](#docker)
* [Usage](#usage)
* [Options](#options)
* [Examples](#examples)
* [Encoding](#encoding)
* [From STDIN](#from-stdin)
* [From a FILE](#from-a-file)
* [With _lorem ipsum_](#with-lorem-ipsum)
* [Excluding trailing newline](#excluding-trailing-newline)
* [Decoding](#decoding)
* [From STDIN](#from-stdin-1)
* [From a FILE](#from-a-file-1)
* [Library](#library)
* [License](#license)
## Installation
### Binary
Simply, download a pre-built binary from [releases page](https://github.com/dwisiswant0/unch/releases). Verify and run!
### Source
Using [Go](https://golang.org/doc/install) compiler:
> [!NOTE]
> Go version **1.22.0+** must be installed and configured.
```bash
go install -v github.com/dwisiswant0/unch@latest
```
**— or**
Manual building executable:
> [!WARNING]
> The `master` branch contains the latest code changes and updates, which might not have undergone thorough testing and quality assurance - thus, you may encounter instability or unexpected behavior.
```bash
git clone https://github.com/dwisiswant0/unch.git
cd unch/
# git checkout [VERSION]
make build
# ./bin/unch --help
```
### Docker
Pull the Docker image by running:
```bash
docker pull ghcr.io/dwisiswant0/unch:latest
```
## Usage
Simply, **unch** can be run with:
```bash
unch "MESSAGE" "PLAINTEXT"
```
To decode:
```bash
unch -d "ENCODED"
```
### Options
Here are all the options it supports.
| **Flag** | **Description** |
| -------------- | ------------------------------------------ |
| `-d`/`-decode` | Decodes the encoded MESSAGE |
| `-l`/`-lorem` | Generate random PLAINTEXT with lorem ipsum |
| `-n` | Do not output the trailing newline |
## Examples
These are some examples of usage.
### Encoding
```bash
unch "MESSAGE" "PLAINTEXT"
```
#### From STDIN
```bash
unch "PLAINTEXT" <<< "MESSAGE"
```
#### From a FILE
```bash
unch "PLAINTEXT" < MESSAGE.txt
```
#### With _lorem ipsum_
```bash
unch -l "MESSAGE"
# or
unch -l <<< "MESSAGE"
```
#### Excluding trailing newline
```bash
unch -n "MESSAGE" "PLAINTEXT" > ENCODED.txt
```
### Decoding
```bash
unch -d "ENCODED"
```
#### From STDIN
```bash
unch -d <<< "ENCODED"
```
#### From a FILE
```bash
unch -d < ENCODED.txt > DECODED.txt
```
### Library
See the [`examples/main.go`](/examples/main.go) file for detailed implementation within the library.
## License
**unch** is released with ♡ by **@dwisiswant0** under the Apache 2.0 license. See [`LICENSE`](/LICENSE).