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 hatch run yubikey -h for details.

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

• OTP API
  • yubiotp.otp
    • CRCError
    • OTP
      • OTP.pack()
      • OTP.unpack()
    • YubiKey
      • YubiKey.generate()
    • decode_otp()
    • encode_otp()
• Validation Client
  • Protocol Version 2.0
    • YubiClient20
      • YubiClient20.base_url
      • YubiClient20.url()
      • YubiClient20.verify()
  • Protocol Version 1.1
    • YubiClient11
      • YubiClient11.base_url
      • YubiClient11.url()
      • YubiClient11.verify()
  • Protocol Version 1.0
    • YubiClient10
      • YubiClient10.base_url
      • YubiClient10.url()
      • YubiClient10.verify()
  • Response
    • YubiResponse
      • YubiResponse.fields
      • YubiResponse.is_nonce_valid()
      • YubiResponse.is_ok()
      • YubiResponse.is_signature_valid()
      • YubiResponse.is_token_valid()
      • YubiResponse.is_valid()
      • YubiResponse.public_id
      • YubiResponse.status()
• YubiOTP Utilities
  • yubiotp.modhex
    • hex_to_modhex()
    • is_modhex()
    • modhex()
    • modhex_to_hex()
    • unmodhex()
  • yubiotp.crc
    • crc16()
    • verify_crc16()
• Change Log
  • Unreleased - Tooling
  • 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

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org/>