YubiOTP

This is a library for verifying YubiKey OTP tokens. It includes both the low-level implementation for verifying tokens locally and clients for multiple versions of the Yubico validation web service. The primary audience is developers who wish to verify YubiKey tokens in their applications, presumably as part of a multi-factor authentication scheme.

For testing and experimenting, the included yubikey script simulates one or more YubiKey devices using a config file. It also includes utility commands such as a modhex converter. See yubikey -h for details.

This also includes a command-line web service client called yubiclient. See yubiclient -h for details.

• OTP API
  • yubiotp.otp
• Validation Client
  • Protocol Version 2.0
  • Protocol Version 1.1
  • Protocol Version 1.0
  • Response
• YubiOTP Utilities
  • yubiotp.modhex
  • yubiotp.crc
• Change Log
  • v1.0.0 - August 13, 2020 - Drop Python 2 support
  • v0.2.2 - July 20, 2018 - Switch to pycryptodome
  • v0.2.1 - September 10, 2013 - Python 3 compatibility
  • v0.2.0 - July 21, 2012 - yubiclient
  • v0.1.0 - July 12, 2012 - Initial release

License

Copyright (c) 2012, Peter Sagerson All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.