diff --git a/BLURB b/BLURB index e149fba..83a0e7d 100644 --- a/BLURB +++ b/BLURB @@ -1,8 +1,8 @@ Author: Yubico Basename: yubikey-val -Homepage: http://opensource.yubico.com/yubikey-val/ +Homepage: https://developers.yubico.com/yubikey-val/ License: BSD-2-Clause Name: yubikey-val Project: yubikey-val -Summary: YubiKey OTP validation server in PHP +Summary: YubiKey OTP Validation Server Travis: https://travis-ci.org/Yubico/yubikey-val diff --git a/README b/README index 345762c..ce38507 100644 --- a/README +++ b/README @@ -1,29 +1,31 @@ -yubikey-val -=========== +YubiKey OTP Validation Server +============================= The YubiKey Validation Server (YK-VAL) is a server that validates -Yubikey OTPs. YK-VAL is written in PHP, for use with web servers such -as Apache. +Yubikey One-Time Passwords (OTPs). YK-VAL is written in PHP, for use +behind web servers such as Apache. + +License +------- + +The project is licensed under a BSD license. See the file COPYING for +exact wording. For any copyright year range specified as YYYY-ZZZZ in +this package note that the range specifies every single year in that +closed interval. + +General +------- The server implements the Yubico API protocol as defined in -doc/ValidationProtocol*. +doc/ValidationProtocol* and further documentation is also available in +the doc/ subdirectory. -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 +This server talks to a KSM service for decrypting the OTPs, to avoid +storing any AES keys on the validation server. One implementation of +this service is the YubiKey-KSM -- +https://developers.yubico.com/yubikey-ksm/ -- and another +implementation using the YubiHSM hardware is PyHSM: +https://developers.yubico.com/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/