From af9dd0d0551045254c48a2b5301910787a3d08b7 Mon Sep 17 00:00:00 2001 From: Dain Nilsson Date: Wed, 30 Jan 2013 14:48:09 +0100 Subject: [PATCH] Updated README --- README | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README b/README index 8dbfa0f..b8870a4 100644 --- a/README +++ b/README @@ -1,3 +1,26 @@ +yubikey-val +=========== + +The YubiKey Validation Server (YK-VAL) is a server that validates Yubikey OTPs. It is written in PHP, for use with web servers such as Apache. + +The server implements the Yubico API protocol as defined in: + +http://yubico.com/developers/api/ + +This server talks to another service for decrypting the OTPs, to avoid storing any AES keys within the validation server. One implementation of this service is YKKSM: + +https://github.com/Yubico/yubikey-ksm + +Another implementation of a KSM using the YubiHSM hardware is Python-PyHSM: + +https://github.com/Yubico/python-pyhsm + +Note that version 1.x is a minimal centralized server. Version 2.x is a replicated system that uses multiple machines. + +Releases are available from: + +http://yubico.github.com/yubikey-val/releases.html + Documentation is in doc/ If you've checked out the source tree and the doc/ dir is empty, do