Introduction to Yubikey client FreePascal library
=================================================

Introduction
------------

This is a library written in FreePascal to validate a Yubikey OTP against
the Yubico online server.  Description of included files:

* AUTHORS, COPYING, NEWS, README: meta-information about the project.

* ykclient.pas: Implementation of the library.

* tool.pas: Source for command line tool "ykclient" to validate an OTP.

* selftest.pas: Self tests of the library.

* build / clean: Build system

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.

Building from Git
-----------------

Skip to the next section if you are using an official packaged
version.

You may check out the sources using Git with the following command:

-----------
  $ git clone git://github.com/stenvaag/yubico-fpc-client.git
-----------

This will create a directory 'yubico-fpc-client'.  Enter the directory:

-----------
  $ cd yubico-fpc-client
-----------

Building
--------

You will need the lnet package from http://lnet.wordpress.com/.

To build use

-----------
  $ ./build
-----------

Command-line tools
------------------

There is one command line tool, ykclient, to validate a particular
OTP.  It needs a client id, which you can allocate for yourself on
Yubico's web site.

Example session below.

-----------
tor@pluto:~/src/yubico-fpc-client$ ./ykclient 
Usage: ./ykclient <client_id> <yubikey_otp>
 CLIENT_ID: your client id integer
 YUBIKEY_OTP: One-time password generated by yubikey
tor@pluto:~/src/yubico-fpc-client$ ./ykclient --debug 16 ccccccbchvthlivuitriujjifivbvtrjkjfirllluurj
Input:
  client id: 16
  token: ccccccbchvthlivuitriujjifivbvtrjkjfirllluurj
Verification output (2): Yubikey OTP was replayed (REPLAYED_OTP)
tor@pluto:~/src/yubico-fpc-client$ 
-----------

Questions?
----------

Talk to <yubico-devel@googlegroups.com>.