X-Git-Url: https://the.earth.li/gitweb/?a=blobdiff_plain;f=README;h=c329b3b19554fee874949005ddf9417edd00bf47;hb=adc800dbc424a1e246dd4a82a0c2e88eeda25531;hp=e04bcaf595eb6ef893edf0128990cb3d739810f3;hpb=39f70717750a0f0d07d218d1de07681bfeb1b588;p=onak.git diff --git a/README b/README index e04bcaf..c329b3b 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ -onak 0.2.0 -Copyright 2003 Project Purple. Written by Jonathan McDowell +onak 0.5.0 +Copyright 2003-2016 Jonathan McDowell http://www.earth.li/projectpurple/progs/onak.html @@ -12,18 +12,19 @@ these is probably the pathfinder. This takes two keys, a & b, and attempts to find a path of trust from a to b in the key database. I started work on it because at the time there was no DFSG compliant server that supported multiple subkeys and could act as a drop in -replacement for pksd, which I was running (and still am). +replacement for pksd, which I was running at the time. Installation: onak has been mainly developed under Linux with a bit of work on FreeBSD -at times also. It's i386 specific at present thanks to the bit of -assembly in bithelp.h. Feel free to submit a patch for your arch. :) +at times also. It should run on all architectures, but has only been +tested on i386, AMD64 and PowerPC so far. -Typing "make" should produce a version of onak with support for the DB3 -backend. If you want to choose a different backend (see below for a -discussion about the options) you'll need to edit the Makefile first. +Typing "./configure && make" should produce a version of onak with +support for the DB4 backend. If you want to choose a different backend +(see below for a discussion about the options) you'll need to pass the +appropriate option to ./configure. Once make has completed you'll end up with various binaries: @@ -36,7 +37,7 @@ Once make has completed you'll end up with various binaries: The mail processor. Takes incoming mail (usually to pgp-public-keys@host) and calls onak to do the necessary work. Currently only supports INCREMENTAL mails for syncing with other - keyservers. + keyservers and INDEX mails from users. * add, lookup & gpgwww The CGI programs. add & lookup are common to all PGP keyservers while @@ -46,21 +47,22 @@ Once make has completed you'll end up with various binaries: mathopd.conf file provided that I used for testing, but I'm now using Apache for the public test rig as it's already present on the host running it. + +* splitkeys + Utility to take a keyring and split it up into a bunch of smaller ones. Config: -I've finally added config file support. onak.conf is an example config; -the main thing to change is the db_dir to whereever you want to put your -database files. You can change CONFIGFILE in onak-conf.h to specify -where onak should look for this file. By default it's -"/home/noodles/projects/onak/onak.conf" as this suits my development. No -doubt it'll become a compile option at some point. +I've finally added config file support. onak.ini is an example config; +the main thing to change is the location in the backend section to +whereever you want to put your database files. The configure script allows +you to specific where it should live; by default it'll be PREFIX/etc/onak.ini. Backends: -Currently there is support for 4 different database backends: +Currently there is support for 6 different database backends: * file The original backend. Very simple and ideal for testing. Stores each @@ -73,18 +75,22 @@ Currently there is support for 4 different database backends: with a large number of keys. This may well be due to my use of it - if you can help speed it up info would be appreciated. -* db2 (Berkeley libdb2) - Only added to provide the ability to run the pathfinder with a key - database produced by pksd. Currently only supports pulling keys out by - keyid - no key updating or searching by key test. Found to be - tempramental and prone to deadlock in the db2 library. - -* db3 (Berkeley libdb3) +* db4 (Berkeley libdb4) The currently preferred backend. Supports the full range of functions like the pg backend but is considerably faster. Also easier to setup - assuming you have libdb3 installed; there's no need to have an SQL + assuming you have libdb4 installed; there's no need to have an SQL database running and configured. +* fs (file backend) + A fuller featured file based backend. Doesn't need any external + libraries and supports the full range of operations (such as text and + subkey searching). Needs a good filesystem to get good performance + though as it creates many, many files and links. + +* hkp + A proxying backend. No keys are stored locally; all fetch and store + requests are forwarded to the provided keyserver. + Other keyservers: @@ -93,12 +99,11 @@ please let me know and I'll add them. * pks http://sf.net/projects/pks/ - The prodominant keyserver I believe; certainly what I run on - wwwkeys.uk.pgp.net. Recently development restarted on this (when I - started writing onak it had been dormant for some time) so it should - hopefully get its problems sorted out soon. The main issue with pks is - that it lacks support for keys with multiple subkeys bound to them and - unfortunately mangles them. + The prodominant keyserver I believe; what I used to run on + wwwkeys.uk.pgp.net. Had a spurt of activity a year or two ago, but + seems to have died off again. The main issue with pks is that it lacks + support for keys with multiple subkeys bound to them and older + versions unfortunately mangle them. * CryptNET Keyserver http://www.cryptnet.net/fsp/cks/ @@ -114,7 +119,7 @@ please let me know and I'll add them. * SKS http://sks.sourceforge.net/ A reasonably new keyserver concentrating more on the whole issue of - syncronization between keyservers. + syncronization between keyservers. Seems to be gaining in popularity. Contacting the author: @@ -125,9 +130,23 @@ OFTC (irc.oftc.net) as Noodles. All constructive criticism, bugs reports, patches and ideas are welcome. -License: +Obtaining later versions: + +onak lives at: + +http://www.earth.li/projectpurple/progs/onak.html -onak is distributed under the GNU Public License, a copy of which should -have been provided with this archive as LICENSE. +Development is carried out using git; you can access the repository +with something like: + +git clone git://the.earth.li/onak.git + +or it can be browsed via gitweb at: + +http://the.earth.li/gitweb/?p=onak.git;a=summary + + +License: -$Id: README,v 1.5 2003/06/08 21:18:43 noodles Exp $ +onak is distributed under the GNU Public License version 2, a copy of +which should have been provided with this archive as LICENSE.