Skip to content

Commit afed0af

Browse files
committed
Add workspace readme
1 parent 0c3c2be commit afed0af

File tree

2 files changed

+96
-22
lines changed

2 files changed

+96
-22
lines changed

Diff for: Cargo.lock

+36-22
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: README

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Homoglyphs (CLI)
2+
3+
**Generate all homoglyphs for a given input sentence.**
4+
5+
> An homoglyph is one of two or more graphemes, characters, or glyphs with shapes that appear identical or very similar. The designation is also applied to sequences of characters sharing these properties.
6+
>
7+
> The Unicode character set contains many strongly homoglyphic characters known as "confusables". These present security risks in a variety of situations. One might deliberately spoof a domain name by replacing one character with its homoglyph, thus creating a second domain name, not readily distinguishable from the first, that can be exploited in phishing.
8+
> \- *[wikipedia](https://en.wikipedia.org/wiki/Homoglyph)*
9+
10+
## Install
11+
12+
```bash
13+
cargo install homoglyphs
14+
```
15+
16+
## Examples
17+
18+
### Generate all possible homoglyphs with all the confusable characters
19+
20+
```bash
21+
homoglyphs -a "rust"
22+
```
23+
24+
### Generate homoglyphs with default settings (100 homoglyphs, 8 confusables for each characters of input sentence)
25+
26+
```bash
27+
homoglyphs "rust is nice"
28+
```
29+
30+
### Generate 'n' homoglyphs
31+
32+
```bash
33+
homoglyphs -n 3000 "rust is awesome"
34+
```
35+
36+
### Generate homoglyphs possible for the given number of confusable
37+
38+
```bash
39+
homoglyphs -n 3000 "rust is incredible"
40+
```
41+
42+
### Try to generate a maximum of 'n' homoglyphs with 'c' confusable for each characters of input sentence
43+
44+
```bash
45+
homoglyphs -n 500 -c 6 "rust is the best"
46+
```
47+
48+
### Print output in different format
49+
50+
#### In array with ascii, empty, markdown, modern and psql styles
51+
52+
```bash
53+
homoglyphs -n 25 "rust is the best" -f markdown
54+
```
55+
56+
#### In json or just raw
57+
58+
```bash
59+
homoglyphs -n 25 "rust is the best" -f json
60+
```

0 commit comments

Comments
 (0)