luckyimnotanigger/mkp224o
1
0
Fork 0
mirror of https://github.com/cathugger/mkp224o.git synced 2025-04-23 07:19:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

use markdown instead of text

Browse source
This commit is contained in:
Yannic Haupenthal 2020-08-28 18:59:29 +02:00
parent bb9e793540
commit 1de7b078af
No known key found for this signature in database
GPG key ID: 30BEEF01A79FDDD7
1 changed files with 97 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

135
README.md
View file

@ -1,89 +1,130 @@
mkp224o - vanity address generator for ed25519 onion services # mkp224o - vanity address generator for ed25519 onion services
This tool generates vanity ed25519 (hidden service version 3, formely known as proposal 224) onion addresses. This tool generates vanity ed25519 ([hidden service version 3][v3],
For context, see <https://gitweb.torproject.org/torspec.git/plain/rend-spec-v3.txt>. formely known as proposal 224) onion addresses.
## Requirements
REQUIREMENTS: * C99 compatible compiler (gcc and clang should work)
* libsodium (including headers)
* GNU make
* GNU autoconf (to generate configure script, needed only if not using release tarball)
* UNIX-like platform (currently tested in Linux and OpenBSD, but should
also build under cygwin and msys2).
C99 compatible compiler (gcc and clang should work),
libsodium (including headers), GNU make,
GNU autoconf (to generate configure script, needed only if not using release tarball),
UNIX-like platform (currently tested in Linux and OpenBSD, but should also build under cygwin and msys2).
For debian-like linux distros, this should be enough to prepare for building: For debian-like linux distros, this should be enough to prepare for building:
`apt install gcc libsodium-dev make autoconf`.
```bash
apt install gcc libsodium-dev make autoconf
```
BUILDING: ## Building
`./autogen.sh` to generate configure script, if it's not there already. `./autogen.sh` to generate configure script, if it's not there already.
`./configure` to generate makefile; in *BSD platforms you probably want to use
`./configure` to generate makefile; in \*BSD platforms you probably want to use
`./configure CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib"`. `./configure CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib"`.
You probably also want to pass something like "--enable-amd64-51-30k"
or "--enable-donna" to configure script for faster key generation; You probably also want to pass something like `--enable-amd64-51-30k`
or `--enable-donna` to configure script for faster key generation;
run `./configure --help` to see all available options. run `./configure --help` to see all available options.
Finally, `make` to start building (`gmake` in *BSD platforms).
Finally, `make` to start building (`gmake` in \*BSD platforms).
USAGE: ## Usage
Generator needs one or more filters to work. Generator needs one or more filters to work.
It makes directory with secret/public keys and hostname It makes directory with secret/public keys and hostname
for each discovered service. By default root is current for each discovered service. By default root is current
directory, but that can be overridden with -d switch. directory, but that can be overridden with `-d` switch.
Use -s switch to enable printing of statistics, which may be useful
Use `-s` switch to enable printing of statistics, which may be useful
when benchmarking different ed25519 implementations on your machine. when benchmarking different ed25519 implementations on your machine.
Use -h switch to obtain all available options.
I highly recommend reading OPTIMISATION.txt for performance-related tips.
Use `-h` switch to obtain all available options.
FAQ AND OTHER USEFUL INFO: I highly recommend reading [OPTIMISATION.txt][OPTIMISATION] for
performance-related tips.
## FAQ and other useful info
* How do I generate address? * How do I generate address?
- Once compiled, run it like `./mkp224o neko`, and it will try creating keys Once compiled, run it like `./mkp224o neko`, and it will try creating
for onions starting with "neko" in this example; use `./mkp224o -d nekokeys neko` to keys for onions starting with "neko" in this example; use `./mkp224o
not litter current directory and put all discovered keys in directory named "nekokeys". -d nekokeys neko` to not litter current directory and put all
discovered keys in directory named "nekokeys".
* How do I make tor use generated keys? * How do I make tor use generated keys?
- Copy key folder (though technically only hs_ed25519_secret_key is required) Copy key folder (though technically only `hs_ed25519_secret_key` is required)
to where you want your service keys to reside: to where you want your service keys to reside:
`sudo cp -r neko54as6d54....onion /var/lib/tor/nekosvc`.
```bash
sudo cp -r neko54as6d54....onion /var/lib/tor/nekosvc
```
You may need to adjust owner and permissions: You may need to adjust owner and permissions:
`sudo chown -R tor: /var/lib/tor/nekosvc`,
`sudo chmod -R u+rwX,og-rwx /var/lib/tor/nekosvc`. ```bash
Then edit torrc and add new service with that folder. sudo chown -R tor: /var/lib/tor/nekosvc
sudo chmod -R u+rwX,og-rwx /var/lib/tor/nekosvc
```
Then edit `torrc` and add new service with that folder.
After reload/restart tor should pick it up. After reload/restart tor should pick it up.
* Generate addresses with 1-2 and 7-9 digits? * Generate addresses with 1-2 and 7-9 digits?
- onion addresses use base32 encoding which does not include 1,2,7,8,9 numbers. onion addresses use base32 encoding which does not include 1,2,7,8,9
so no, that's not possible to generate these, and mkp224o tries to detect invalid filters containing them early on. numbers.
so no, that's not possible to generate these, and mkp224o tries to
detect invalid filters containing them early on.
* How long is it going to take? * How long is it going to take?
- Because of probablistic nature of brute force key generation, and varience of hardware it's going to run on, Because of probablistic nature of brute force key generation, and
it's hard to make promisses about how long it's going to take, especially when the most of users want just a few keys. varience of hardware it's going to run on, it's hard to make promisses
See <https://github.com/cathugger/mkp224o/issues/27> for very valuable discussion about this. about how long it's going to take, especially when the most of users
If your machine is powerful enough, 6 character prefix shouldn't take more than few tens of minutes, want just a few keys.
if using batch mode (read OPTIMISATION.txt). 7 characters can take hours to days. See [this issue][#27] for very valuable discussion about this.
If your machine is powerful enough, 6 character prefix shouldn't take
more than few tens of minutes, if using batch mode (read
[OPTIMISATION.txt][OPTIMISATION]) 7 characters can take hours
to days.
No promisses though, it depends on pure luck. No promisses though, it depends on pure luck.
* Will this work with onionbalance? * Will this work with onionbalance?
- It appears that onionbalance supports loading usual hs_ed25519_secret_key key so it should work. It appears that onionbalance supports loading usual
`hs_ed25519_secret_key` key so it should work.
## Contact
CONTACT:
For bug reports/questions/whatever else, email cathugger at cock dot li. For bug reports/questions/whatever else, email cathugger at cock dot li.
PGP key, if needed, can be found at <http://cathug2kyi4ilneggumrenayhuhsvrgn6qv2y47bgeet42iivkpynqad.onion/contact.html>. PGP key, if needed, can be found at <http://cathug2kyi4ilneggumrenayhuhsvrgn6qv2y47bgeet42iivkpynqad.onion/contact.html>.
## Acknowledgements & Legal
ACKNOWLEDGEMENTS & LEGAL: To the extent possible under law, the author(s) have dedicated all
copyright and related and neighboring rights to this software to the
public domain worldwide. This software is distributed without any
warranty.
You should have received a copy of the CC0 Public Domain Dedication
along with this software. If not, see [CC0][].
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty. * `keccak.c` is based on [Keccak-more-compact.c][keccak.c]
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. * `ed25519/{ref10,amd64-51-30k,amd64-64-24k}` are adopted from
[SUPERCOP][]
* `ed25519/ed25519-donna` adopted from [ed25519-donna][]
* Idea used in `worker_fast()` is stolen from [horse25519][]
* base64 routines and initial YAML processing work contributed by
Alexander Khristoforov (heios@protonmail.com)
* Passphrase-based generation code and idea used in `worker_batch()`
contributed by [foobar2019][]
keccak.c is based on <https://github.com/gvanas/KeccakCodePackage/blob/master/Standalone/CompactFIPS202/Keccak-more-compact.c>. [v3]: https://gitweb.torproject.org/torspec.git/plain/rend-spec-v3.txt
ed25519/{ref10,amd64-51-30k,amd64-64-24k} are adopted from SUPERCOP <https://bench.cr.yp.to/supercop.html>. [OPTIMISATION]: ./OPTIMISATION.txt
ed25519/ed25519-donna adopted from <https://github.com/floodyberry/ed25519-donna>. [#27]: https://github.com/cathugger/mkp224o/issues/27
Idea used in worker_fast() is stolen from <https://github.com/Yawning/horse25519>. [keccak.c]: https://github.com/XKCP/XKCP/blob/master/Standalone/CompactFIPS202/C/Keccak-more-compact.c
base64 routines and initial YAML processing work contributed by Alexander Khristoforov <heios@protonmail.com>. [CC0]: http://creativecommons.org/publicdomain/zero/1.0/
Passphrase-based generation code and idea used in worker_batch() contributed by <https://github.com/foobar2019>. [SUPERCOP]: https://bench.cr.yp.to/supercop.html
[ed25519-donna]: https://github.com/floodyberry/ed25519-donna
[horse25519]: https://github.com/Yawning/horse25519
[foobar2019]: https://github.com/foobar2019