Package liboath-doc

Documentation files for liboath

http://www.nongnu.org/oath-toolkit/

Library Functions (Section 3)
oath_authenticate_usersfile
Authenticate user named username with the one-time password otp and (optional) password passwd. Credentials are read (and updated) from a text file named...
oath_base32_decode
Decode a base32 encoded string into binary data. Space characters are ignored and pad characters are added if needed. Non-base32 data are not ignored but...
oath_base32_encode
Encode binary data into a string with base32 data. The in parameter should contain inlen bytes of data to encode. The function allocates a new string in *out to...
oath_bin2hex
Convert binary data to NUL-terminated string with hex data. The output hexstr is allocated by the caller and must have room for at least 2*binlen+1, to make...
oath_check_version
Check OATH library version. See OATH_VERSION for a suitable req_version string. This function is one of few in the library that can be used without a successful...
oath_done
This function deinitializes the OATH library, which were initialized using oath_init(). After calling this function, no other OATH library function may be...
oath_hex2bin
Convert string with hex data to binary data. Non-hexadecimal data are not ignored but instead will lead to an OATH_INVALID_HEX error. If binstr is NULL, then...
oath_hotp_generate
Generate a one-time-password using the HOTP algorithm as described in RFC 4226. Use a value of OATH_HOTP_DYNAMIC_TRUNCATION for truncation_offset unless you...
oath_hotp_validate
Validate an OTP according to OATH HOTP algorithm per RFC 4226. Currently only OTP lengths of 6, 7 or 8 digits are supported. This restrictions may be lifted in...
oath_hotp_validate_callback
Validate an OTP according to OATH HOTP algorithm per RFC 4226. Validation is implemented by generating a number of potential OTPs and performing a call to the...
oath_init
This function initializes the OATH library. Every user of this library needs to call this function before using other functions. You should call oath_done()...
oath_strerror
Convert return code to human readable string explanation of the reason for the particular error code. This string can be used to output a diagnostic message to...
oath_strerror_name
Convert return code to human readable string representing the error code symbol itself. For example, oath_strerror_name(OATH_OK) returns the string "OATH_OK"...
oath_totp_generate
Generate a one-time-password using the time-variant TOTP algorithm described in RFC 6238. The input parameters are taken as time values. The system parameter...
oath_totp_generate2
Generate a one-time-password using the time-variant TOTP algorithm described in RFC 6238. The input parameters are taken as time values. The system parameter...
oath_totp_validate
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Currently only OTP lengths of 6, 7 or 8 digits are supported. This restrictions may be lifted in...
oath_totp_validate2
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Currently only OTP lengths of 6, 7 or 8 digits are supported. This restrictions may be lifted in...
oath_totp_validate2_callback
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Validation is implemented by generating a number of potential OTPs and performing a call to the...
oath_totp_validate3
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Currently only OTP lengths of 6, 7 or 8 digits are supported. This restrictions may be lifted in...
oath_totp_validate3_callback
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Validation is implemented by generating a number of potential OTPs and performing a call to the...
oath_totp_validate4
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Currently only OTP lengths of 6, 7 or 8 digits are supported. This restrictions may be lifted in...
oath_totp_validate4_callback
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Validation is implemented by generating a number of potential OTPs and performing a call to the...
oath_totp_validate_callback
Validate an OTP according to OATH TOTP algorithm per RFC 6238. Validation is implemented by generating a number of potential OTPs and performing a call to the...