kev/onioncompressor
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added readme

Browse Source
This commit is contained in:
Kevin F 2021-08-27 06:23:39 +00:00
parent 67042ff2b7
commit 85b41fb860
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -0,0 +1,15 @@
# OnionCompressor
Per v3 Tor onion spec: https://github.com/torproject/torspec/blob/main/rend-spec-v3.txt
This small module 'compresses' v3 onions by decoding the base32, removing the non-security related checksum, and removing the version number.
The resulting bytes is actually a valid ed25519 public key, but you probably shouldn't use it for anything but normal Tor onion uses.
It can also uncompress the bytes back to the human friendly format.
# Usage
`compressed: bytes = onioncompressor.compress('duckduckgogg42xjoc72x3sjasowoarfbgcmvfimaftt6twagswzczad.onion')`
`uncompressed: str: = onioncompressor.compress(compressed)`