1
0
mirror of https://github.com/Yubico/yubikey-ksm.git synced 2025-02-20 21:54:21 +01:00

Improve README. Dist it.

This commit is contained in:
Simon Josefsson 2013-04-22 12:16:06 +02:00
parent 765509f545
commit 9ecb4f9b5d
2 changed files with 23 additions and 11 deletions

View File

@ -28,7 +28,7 @@
VERSION = 1.14
PACKAGE = yubikey-ksm
CODE = .htaccess Makefile NEWS ykksm-config.php ykksm-db.sql \
CODE = .htaccess Makefile NEWS README ykksm-config.php ykksm-db.sql \
ykksm-decrypt.php ykksm-export ykksm-gen-keys \
ykksm-import ykksm-utils.php ykksm-checksum
DOCS = doc/DecryptionProtocol.wiki doc/DesignGoals.wiki \

32
README
View File

@ -1,25 +1,37 @@
yubikey-ksm
===========
The YubiKey Key Storage Module (YK-KSM) provides a AES key storage facility for use with a YubiKey validation server.
The YubiKey Key Storage Module (YK-KSM) provides a AES key storage
facility for use with a YubiKey validation server.
The YK-KSM is intended to be run on a locked-down server.
This separation allows third parties to keep tight control of the AES keys for their YubiKeys, but at the same time allow external validation servers (e.g., Yubico's) to validate OTPs from these YubiKeys.
This separation allows third parties to keep tight control of the AES
keys for their YubiKeys, but at the same time allow external
validation servers (e.g., Yubico's) to validate OTPs from these
YubiKeys.
Releases are available from:
http://yubico.github.com/yubikey-ksm/releases.html
http://yubico.github.io/yubikey-ksm/releases.html
The YK-KSM was designed to work with the YubiKey validation server in PHP:
The YK-KSM was designed to work with the YubiKey validation server:
https://github.com/Yubico/yubikey-val/
http://yubico.github.io/yubikey-val/
Documentation is in doc.
Documentation is in doc/.
The documentation is also available online at:
http://github.com/Yubico/yubikey-ksm/wiki
Development
-----------
To create a tarball you must have a recent versions of "help2man" and
"git2cl".
If you've checked out the source tree and the doc/ dir is empty, do
$ git submodule init
$ git submodule update
The documentation is also available online at
http://github.com/Yubico/yubikey-ksm/wiki