README

   1 onak 0.4.2
   2 Copyright 2003-2013 Jonathan McDowell
   3 http://www.earth.li/projectpurple/progs/onak.html
   4
   5
   6 Introduction:
   7
   8 onak is an OpenPGP compatible keyserver. It's primary purpose is the
   9 storage and retrieval of OpenPGP keys but it also has features that make
  10 use of the stored keys for various other purposes. The most useful of
  11 these is probably the pathfinder. This takes two keys, a & b, and
  12 attempts to find a path of trust from a to b in the key database. I
  13 started work on it because at the time there was no DFSG compliant
  14 server that supported multiple subkeys and could act as a drop in
  15 replacement for pksd, which I was running at the time.
  16
  17
  18 Installation:
  19
  20 onak has been mainly developed under Linux with a bit of work on FreeBSD
  21 at times also. It should run on all architectures, but has only been
  22 tested on i386, AMD64 and PowerPC so far.
  23
  24 Typing "./configure && make" should produce a version of onak with
  25 support for the DB4 backend. If you want to choose a different backend
  26 (see below for a discussion about the options) you'll need to pass the
  27 appropriate option to ./configure.
  28
  29 Once make has completed you'll end up with various binaries:
  30
  31 * onak
  32   This is the main program. It's intended to be run from the command
  33   line and allows the addition, deletion and searching of keys in the
  34   database.
  35
  36 * onak-mail.pl
  37   The mail processor. Takes incoming mail (usually to
  38   pgp-public-keys@host) and calls onak to do the necessary work.
  39   Currently only supports INCREMENTAL mails for syncing with other
  40   keyservers and INDEX mails from users.
  41
  42 * add, lookup & gpgwww
  43   The CGI programs. add & lookup are common to all PGP keyservers while
  44   gpgwww is the pathfinder component of onak. To get a keyserver that
  45   clients such as GPG can sync with you'll need to put these in a /pks
  46   directory on a web server running on port 11371. There's an example
  47   mathopd.conf file provided that I used for testing, but I'm now using
  48   Apache for the public test rig as it's already present on the host
  49   running it.
  50
  51 * splitkeys
  52   Utility to take a keyring and split it up into a bunch of smaller ones.
  53
  54
  55 Config:
  56
  57 I've finally added config file support. onak.conf is an example config;
  58 the main thing to change is the db_dir to whereever you want to put your
  59 database files. The configure script allows you to specific where it
  60 should live; by default it'll be PREFIX/etc/onak.conf.
  61
  62
  63 Backends:
  64
  65 Currently there is support for 6 different database backends:
  66
  67 * file
  68   The original backend. Very simple and ideal for testing. Stores each
  69   key as a separate file. Doesn't support searching based on key text.
  70
  71 * pg (PostgreSQL)
  72   Once the preferred backend. Use onak.sql to create the tables
  73   necessary to run with this. Unfortunately although suitable for the
  74   keyserver side it was found to be too slow for running the pathfinder
  75   with a large number of keys. This may well be due to my use of it - if
  76   you can help speed it up info would be appreciated.
  77
  78 * db2 (Berkeley libdb2)
  79   Only added to provide the ability to run the pathfinder with a key
  80   database produced by pksd. Currently only supports pulling keys out by
  81   keyid - no key updating or searching by key test. Found to be
  82   tempramental and prone to deadlock in the db2 library.
  83
  84 * db4 (Berkeley libdb4)
  85   The currently preferred backend. Supports the full range of functions
  86   like the pg backend but is considerably faster. Also easier to setup
  87   assuming you have libdb4 installed; there's no need to have an SQL
  88   database running and configured.
  89
  90 * fs (file backend)
  91   A fuller featured file based backend. Doesn't need any external
  92   libraries and supports the full range of operations (such as text and
  93   subkey searching). Needs a good filesystem to get good performance
  94   though as it creates many, many files and links.
  95
  96 * hkp
  97   A proxying backend. No keys are stored locally; all fetch and store
  98   requests are forwarded to the provided keyserver.
  99
 100
 101 Other keyservers:
 102
 103 I'm aware of the following other keyservers. If you know of any more
 104 please let me know and I'll add them.
 105
 106 * pks
 107   http://sf.net/projects/pks/
 108   The prodominant keyserver I believe; what I used to run on
 109   wwwkeys.uk.pgp.net. Had a spurt of activity a year or two ago, but
 110   seems to have died off again. The main issue with pks is that it lacks
 111   support for keys with multiple subkeys bound to them and older
 112   versions unfortunately mangle them.
 113
 114 * CryptNET Keyserver
 115   http://www.cryptnet.net/fsp/cks/
 116   A GPLed server with support for multiple subkeys, but unfortunately
 117   when I looked at it there was no support for syncing via email which
 118   means it can't replace a pks server to act as part of pgp.net.
 119
 120 * OpenPKSD
 121   http://openpksd.org/
 122   Don't really know a lot about this. Primarily Japanese development
 123   AFAICT.
 124
 125 * SKS
 126   http://sks.sourceforge.net/
 127   A reasonably new keyserver concentrating more on the whole issue of
 128   syncronization between keyservers. Seems to be gaining in popularity.
 129
 130
 131 Contacting the author:
 132
 133 I can be reached via email as noodles@earth.li. I'm usually on IRC on
 134 OFTC (irc.oftc.net) as Noodles.
 135
 136 All constructive criticism, bugs reports, patches and ideas are welcome.
 137
 138
 139 Obtaining later versions:
 140
 141 onak lives at:
 142
 143 http://www.earth.li/projectpurple/progs/onak.html
 144
 145 Development is carried out using git; you can access the repository
 146 with something like:
 147
 148 git clone git://the.earth.li/onak.git
 149
 150 or it can be browsed via gitweb at:
 151
 152 http://the.earth.li/gitweb/?p=onak.git;a=summary
 153
 154
 155 License:
 156
 157 onak is distributed under the GNU Public License version 2, a copy of
 158 which should have been provided with this archive as LICENSE.