README.txt

   1 mkp224o - vanity address generator for ed25519 onion services
   2
   3 This tool generates vanity ed25519 (hidden service version 3, formely known as proposal 224) onion addresses.
   4 For context, see <https://gitweb.torproject.org/torspec.git/plain/rend-spec-v3.txt>.
   5
   6 REQUIREMENTS:
   7 C99 compatible compiler (gcc and clang should work),
   8 libsodium (including headers), GNU make,
   9 GNU autoconf (to generate configure script, needed only if not using release tarball),
  10 UNIX-like platform (currently tested in Linux and OpenBSD, but should also build under cygwin and msys2).
  11 For debian-like linux distros, this should be enough to prepare for building:
  12 `apt install gcc libsodium-dev make autoconf`.
  13
  14 BUILDING:
  15 `./autogen.sh` to generate configure script, if it's not there already.
  16 `./configure` to generate makefile; in *BSD platforms you probably want to use
  17 `./configure CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib"`.
  18 You probably also want to pass something like "--enable-amd64-51-30k"
  19 or "--enable-donna" to configure script for faster key generation;
  20 run `./configure --help` to see all available options.
  21 Finally, `make` to start building (`gmake` in *BSD platforms).
  22
  23 USAGE:
  24 Generator needs one or more filters to work.
  25 It makes directory with secret/public keys and hostname
  26 for each discovered service. By default root is current
  27 directory, but that can be overridden with -d switch.
  28 Use -s switch to enable printing of statistics, which may be useful
  29 when benchmarking different ed25519 implementations on your machine.
  30 Use -h switch to obtain all available options.
  31 I highly recommend reading OPTIMISATION.txt for performance-related tips.
  32
  33 CONTACT:
  34 For bug reports/questions/whatever else, email cathugger at cock dot li.
  35 PGP key, if needed, can be found at <http://cathug2kyi4ilneggumrenayhuhsvrgn6qv2y47bgeet42iivkpynqad.onion/contact.html>.
  36
  37 ACKNOWLEDGEMENTS & LEGAL:
  38 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.
  39 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/>.
  40
  41 keccak.c is based on <https://github.com/gvanas/KeccakCodePackage/blob/master/Standalone/CompactFIPS202/Keccak-more-compact.c>.
  42 ed25519/{ref10,amd64-51-30k,amd64-64-24k} are adopted from SUPERCOP <https://bench.cr.yp.to/supercop.html>.
  43 ed25519/ed25519-donna adopted from <https://github.com/floodyberry/ed25519-donna>.
  44 Idea used in worker_fast() is stolen from <https://github.com/Yawning/horse25519>.
  45 base64 routines and initial YAML processing work contributed by Alexander Khristoforov <heios@protonmail.com>.
  46 Passphrase-based generation code and idea used in worker_batch() contributed by <https://github.com/foobar2019>.