mkp224o cathugger

Use this command to install mkp224o with WinGet:

winget install --id=cathugger.mkp224o -e

mkp224o is a vanity address generator designed to create custom .onion v3 hidden service addresses using ed25519 cryptography for Tor networks. This tool allows users to generate memorable or specific patterns in onion service URLs, enhancing security and usability.

Key Features:

Custom Vanity Addresses: Generate onion service addresses with specified prefixes or patterns for improved readability and recognition.
Filter Support: Define filters to narrow down search criteria for vanity addresses, ensuring faster discovery of desired patterns.
Optimized ed25519 Key Generation: Leverages advanced cryptographic algorithms for efficient key generation tailored for Tor hidden services.
Cross-Platform Compatibility: Works on UNIX-like systems, including Linux and OpenBSD, with support for building under cygwin and msys2.
Tor Integration: Easily integrates generated keys into existing Tor configurations for seamless deployment of custom onion services.
Winget Deployment: Available via the Windows Package Manager (winget), enabling straightforward installation and management using commands like "install mkp224o via winget."

Target Audience and Benefits: Ideal for developers, cybersecurity professionals, and network administrators seeking to deploy secure and memorable .onion v3 services. mkp224o provides tangible benefits such as enhanced privacy through custom addresses and simplified key management for Tor hidden services.

This tool is perfect for users looking to create unique onion service identifiers while maintaining the highest standards of security and performance.

mkp224o - vanity address generator for ed25519 onion services

This tool generates vanity ed25519 (hidden service version 3¹², formely known as proposal 224) onion addresses.

Requirements for building

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:

apt install gcc libc6-dev libsodium-dev make autoconf

Building

Run ./autogen.sh to generate a configure script, if there isn't one already.

Run ./configure to generate a makefile. On *BSD platforms you may need to specify extra include/library paths: ./configure CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib".

On AMD64 platforms, you probably also want to pass something like --enable-amd64-51-30k to the configure script invocation for faster key generation; run ./configure --help to see all available options.

Finally, make to start building (gmake in *BSD platforms).

Usage

mkp224o needs one or more filters to work. You may specify them as command line arguments, eg ./mkp224o test, or load them from file with -f switch.

It makes directories with secret/public keys and hostnames for each discovered service. By default, the working directory is the current directory, but that can be overridden with -d switch.

Use -s switch to enable printing of statistics, which may be useful 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.

FAQ and other useful info

How do I generate address?

Once compiled, run it like ./mkp224o neko, and it will try creating keys for onions starting with "neko" in this example; use ./mkp224o -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?

Copy key folder (though technically only hs_ed25519_secret_key is required) to where you want your service keys to reside:
```
sudo cp -r neko54as6d54....onion /var/lib/tor/nekosvc
```
You may need to adjust ownership and permissions:
```
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.
How to generate addresses with 0-1 and 8-9 digits?

Onion addresses use base32 encoding which does not include 0,1,8,9 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?

Because of probablistic nature of brute force key generation, and varience of hardware it's going to run on, 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.
See this issue 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) 7 characters can take hours to days.
No promisses though, it depends on pure luck.
Will this work with onionbalance?

It appears that onionbalance supports loading usual hs_ed25519_secret_key key so it should work.
Is there a docker image?

Yes, if you do not wish to compile mkp224o yourself, you can use the ghcr.io/cathugger/mkp224o image like so:
```
docker run --rm -it -v $PWD:/keys ghcr.io/cathugger/mkp224o:master -d /keys neko
```

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.

keccak.c is based on Keccak-more-compact.c
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 at protonmail dot com)
Passphrase-based generation code and idea used in worker_batch() contributed by foobar2019

mkp224o - vanity address generator for ed25519 onion services

This tool generates vanity ed25519 (hidden service version 3¹², formely known as proposal 224) onion addresses.

Requirements for building

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:

apt install gcc libc6-dev libsodium-dev make autoconf

Building

Run ./autogen.sh to generate a configure script, if there isn't one already.

Run ./configure to generate a makefile. On *BSD platforms you may need to specify extra include/library paths: ./configure CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib".

Finally, make to start building (gmake in *BSD platforms).

Usage

mkp224o needs one or more filters to work. You may specify them as command line arguments, eg ./mkp224o test, or load them from file with -f switch.

It makes directories with secret/public keys and hostnames for each discovered service. By default, the working directory is the current directory, but that can be overridden with -d switch.

Use -s switch to enable printing of statistics, which may be useful 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.

FAQ and other useful info

How do I generate address?

Once compiled, run it like ./mkp224o neko, and it will try creating keys for onions starting with "neko" in this example; use ./mkp224o -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?

Copy key folder (though technically only hs_ed25519_secret_key is required) to where you want your service keys to reside:
```
sudo cp -r neko54as6d54....onion /var/lib/tor/nekosvc
```
You may need to adjust ownership and permissions:
```
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.
How to generate addresses with 0-1 and 8-9 digits?

Onion addresses use base32 encoding which does not include 0,1,8,9 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?

Because of probablistic nature of brute force key generation, and varience of hardware it's going to run on, 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.
See this issue 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) 7 characters can take hours to days.
No promisses though, it depends on pure luck.
Will this work with onionbalance?

It appears that onionbalance supports loading usual hs_ed25519_secret_key key so it should work.
Is there a docker image?

Yes, if you do not wish to compile mkp224o yourself, you can use the ghcr.io/cathugger/mkp224o image like so:
```
docker run --rm -it -v $PWD:/keys ghcr.io/cathugger/mkp224o:master -d /keys neko
```

Acknowledgements & Legal

keccak.c is based on Keccak-more-compact.c
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 at protonmail dot com)
Passphrase-based generation code and idea used in worker_batch() contributed by foobar2019

mkp224o cathugger

README

mkp224o - vanity address generator for ed25519 onion services

Requirements for building

Building

Usage

FAQ and other useful info

Acknowledgements & Legal

mkp224o cathugger

README

mkp224o - vanity address generator for ed25519 onion services

Requirements for building

Building

Usage

FAQ and other useful info

Acknowledgements & Legal

mkp224o cathugger

README

mkp224o - vanity address generator for ed25519 onion services

Requirements for building

Building

Usage

FAQ and other useful info

Acknowledgements & Legal

Footnotes

mkp224o cathugger

README

mkp224o - vanity address generator for ed25519 onion services

Requirements for building

Building

Usage

FAQ and other useful info

Acknowledgements & Legal

Footnotes