Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

yhsm-validation-server(1) [debian man page]

yhsm-validation-server(1)				      General Commands Manual					 yhsm-validation-server(1)

NAME

       yhsm-validation-server - Credential validation server utilizing YubiHSM

SYNOPSIS

       yhsm-validation-server [mode]

DESCRIPTION

       This is a validation server using the YubiHSM for cryptographic operations.

       It is primarily built to validate YubiKey OTPs (not stored in the YubiHSM internal database), but it can also validate OATH token codes and
       legacy passwords.

OPTIONS

       -D, --device
	      device file name (default: /dev/ttyACM0)

       -v, --verbose
	      enable verbose operation

       --debug
	      enable debug printout, including all data sent to/from YubiHSM

       --U, --serve-url base
	      base of URL for validation web service (default: /yhsm/validate?)

       --port num
	      port to listen on (default: 8003)

       --addr addr
	      address to bind to (default: 127.0.0.1)

       --hmac-kh kh
	      key handle to use for HMAC-SHA-1. Examples : "1", "0xabcd".

       --hotp-window num
	      number of OATH counter values to try (default: 5)

       --db-file fn
	      db file holding AEADs (see yhsm-init-oath-token(1)) (default: /var/yubico/yhsm-validation-server.db)

       --clients-file fn
	      text file with mode OTP validation  client  shared  secrets  (see  yhsm-init-oath-token(1))  (default:  /var/yubico/yhsm-validation-
	      server.db)

       --pid-file fn
	      write process id of server to this file

MODES

       --otp  Validate YubiKey OTP against entry in the YubiHSM internal database.  Response should be compatible with those of yubikey-val-
	      server-php <http://code.google.com/p/yubikey-val-server-php/>.

       --short-otp
	      Validate YubiKey OTP against entry in the YubiHSM internal database.  Returns a single line with the decrypted information from  the
	      OTP, compatible with yubikey-ksm <http://code.google.com/p/yubikey-ksm/>.

       --hotp Validate codes using the OATH HOTP algorithm, performing the HMAC-SHA-1 inside the YubiHSM.

       --pwhash
	      Validate	that  a  string (a PBKDF2 hash of a password for example) matches the one in an AEAD.  Can be used to protect legacy pass-
	      words within an AEAD only readable to a YubiHSM, but still recoverable if you know the AEAD key (since you put it in the YubiHSM).

CLIENTS FILE

       This file holds HMAC-SHA-1 secrets shared between the validation client and server.

       An example file, with a single entry for id 4711 would be :

	   # hash-style comments and blank lines are ignored
	   4711,grF5BERXEXPPpww1/TBvFg==

	   # end

EXIT STATUS

       0   YubiHSM keystore successfully unlocked

       1   Failed to unlock keystore

       255 Client ID not found in internal database

BUGS

       Report python-pyhsm/yhsm-validation-server bugs in the issue tracker <https://github.com/Yubico/python-pyhsm/issues/>

SEE ALSO

       The python-yubico home page <https://github.com/Yubico/python-pyhsm/>

       YubiHSMs can be obtained from Yubico <http://www.yubico.com/>.

python-pyhsm							   December 2011					 yhsm-validation-server(1)

Check Out this Related Man Page

yhsm-yubikey-ksm(1)					      General Commands Manual					       yhsm-yubikey-ksm(1)

NAME

       yhsm-yubikey-ksm - Decrypt YubiKey OTPs using an attached YubiHSM

SYNOPSIS

       yhsm-yubikey-ksm --key-handles ...  [options]

DESCRIPTION

       This is a small network server with a REST-like API that decodes YubiKey OTPs.

       It can be used as a decryption backend (Key Storage Module) to a validation service such as the YubiCloud.

       The AES keys of the YubiKeys must be present as AEAD files decryptable to the attached YubiHSM. Such AEADs can for example be created using
       yhsm-import-keys(1).

       Note that this daemon is single threaded - it will only handle a single request at once.  A request timeout is therefor most important.

OPTIONS

       -D, --device
	      device file name (default: /dev/ttyACM0)

       -v, --verbose
	      enable verbose operation

       --debug
	      enable debug printout, including all data sent to/from YubiHSM

       --U, --serve-url base
	      base of URL for decrypt web service (default: /yhsm/validate?)

       --port num
	      port to listen on (default: 8002)

       --addr addr
	      address to bind to (default: 127.0.0.1)

       --key-handles kh, --key-handle kh
	      key handles to use for decoding OTPs. Examples : "1", "0xabcd".

       --aead-dir dir, -B dir
	      base directory for AEADs (default: /var/cache/yubikey-ksm/aeads)

       --reqtimeout num
	      number of seconds before a request times out (default: 5)

       --pid-file fn
	      write process id of server to this file

BUGS

       Report python-pyhsm/yhsm-yubikey-ksm bugs in the issue tracker <https://github.com/Yubico/python-pyhsm/issues/>

SEE ALSO

       The python-yubico home page <https://github.com/Yubico/python-pyhsm/>

       YubiHSMs can be obtained from Yubico <http://www.yubico.com/>.

python-pyhsm							   December 2011					       yhsm-yubikey-ksm(1)
Man Page