yubico-client 1.7.0

# Yubico Python Client

Python class for verifying Yubico One Time Passwords (OTPs) based on the validation protocol version 2.0.

• Yubico website: [http://www.yubico.com][1]

• Yubico documentation: [http://www.yubico.com/developers/intro/][2]

• Validation Protocol Version 2.0 FAQ: [http://www.yubico.com/develop/open-source-software/web-api-clients/server/][3]

• Validation Protocol Version 2.0 description: [https://github.com/Yubico/yubikey-val/wiki/ValidationProtocolV20][4]

## Installation

pip install yubico-client

Note: Package has been recently renamed from yubico to yubico-client and the main module has been renamed from yubico to yubico_client. This was done to avoid naming conflicts and make creation of distribution specific packages easier.

## Build Status

[](http://travis-ci.org/Kami/python-yubico-client)

## Running Tests

python setup.py test

## Usage

1. Generate your client id and secret key (this can be done by visiting the [Yubico website](https://api.yubico.com/get-api-key/))

2. Use the client

Single mode:

from yubico_client import Yubico

yubico = Yubico(‘client id’, ‘secret key’) yubico.verify(‘otp’)

Multi mode:

from yubico_client import Yubico

yubico = Yubico(‘client id’, ‘secret key’) yubico.verify_multi([‘otp 1’, ‘otp 2’, ‘otp 3’])

The verify method will return True if the provided OTP is valid (STATUS=OK).

The verify_multi method will return True if all of the provided OTPs are valid (STATUS=OK).

Both methods can also throw one of the following exceptions:

• StatusCodeError - server returned REPLAYED_OTP status code

• SignatureVerificationError - server response message signature verification failed

• InvalidClientIdError - client with the specified id does not exist (server returned NO_SUCH_CLIENT status code)

• Exception - server returned one of the following status values: BAD_OTP, BAD_SIGNATURE, MISSING_PARAMETER, OPERATION_NOT_ALLOWED, BACKEND_ERROR, NOT_ENOUGH_ANSWERS, REPLAYED_REQUEST or no response was received from any of the servers in the specified time frame (default timeout = 10 seconds)

[1]: http://www.yubico.com [2]: http://www.yubico.com/developers/intro/ [3]: http://www.yubico.com/develop/open-source-software/web-api-clients/server/ [4]: https://github.com/Yubico/yubikey-val/wiki/ValidationProtocolV20