15.2.1.2.5. HOTP Token¶
-
class
privacyidea.lib.tokens.hotptoken.
HotpTokenClass
(db_token)[source]¶ hotp token class implementation
-
check_otp
(anOtpVal, counter=None, window=None, options=None)[source]¶ check if the given OTP value is valid for this token.
- Parameters
anOtpVal (string) – the to be verified otpvalue
counter (int) – the counter state, that should be verified
window (int) – the counter +window, which should be checked
options (dict) – the dict, which could contain token specific info
- Returns
the counter state or -1
- Return type
int
-
check_otp_exist
(otp, window=10, symetric=False, inc_counter=True)[source]¶ checks if the given OTP value is/are values of this very token. This is used to autoassign and to determine the serial number of a token.
- Parameters
otp (string) – the to be verified otp value
window (int) – the lookahead window for the counter
- Returns
counter or -1 if otp does not exist
- Return type
int
-
generate_symmetric_key
(server_component, client_component, options=None)[source]¶ Generate a composite key from a server and client component using a PBKDF2-based scheme.
- Parameters
server_component (hex string) – The component usually generated by privacyIDEA
client_component (hex string) – The component usually generated by the client (e.g. smartphone)
options –
- Returns
the new generated key as hex string
- Return type
str
-
static
get_class_info
(key=None, ret='all')[source]¶ returns a subtree of the token definition Is used by lib.token.get_token_info
- Parameters
key (string) – subsection identifier
ret (user defined) – default return value, if nothing is found
- Returns
subsection if key exists or user defined
- Return type
dict
-
static
get_class_prefix
()[source]¶ Return the prefix, that is used as a prefix for the serial numbers. :return: oath
-
classmethod
get_default_settings
(g, params)[source]¶ This method returns a dictionary with default settings for token enrollment. These default settings are defined in SCOPE.USER or SCOPE.ADMIN and are hotp_hashlib, hotp_otplen. If these are set, the user or admin will only be able to enroll tokens with these values.
The returned dictionary is added to the parameters of the API call. :param g: context object, see documentation of
Match
:param params: The call parameters :type params: dict :return: default parameters
-
static
get_import_csv
(l)[source]¶ Read the list from a csv file and return a dictionary, that can be used to do a token_init.
- Parameters
l (list) – The list of the line of a csv file
- Returns
A dictionary of init params
-
get_init_detail
(params=None, user=None)[source]¶ to complete the token initialization some additional details should be returned, which are displayed at the end of the token initialization. This is the e.g. the enrollment URL for a Google Authenticator.
-
get_multi_otp
(count=0, epoch_start=0, epoch_end=0, curTime=None, timestamp=None, counter_index=False)[source]¶ return a dictionary of multiple future OTP values of the HOTP/HMAC token
- WARNING: the dict that is returned contains a sequence number as key.
This it NOT the otp counter!
- Parameters
count (int) – how many otp values should be returned
epoch_start – Not used in HOTP
epoch_end – Not used in HOTP
curTime – Not used in HOTP
timestamp – not used in HOTP
counter_index – whether the counter should be used as index
- Returns
tuple of status: boolean, error: text and the OTP dictionary
-
get_otp
(current_time=None)[source]¶ return the next otp value
- Parameters
curTime – Not Used in HOTP
- Returns
next otp value and PIN if possible
- Return type
tuple
-
static
get_setting_type
(key)[source]¶ This function returns the type of the token specific config/setting. This way a tokenclass can define settings, that can be “public” or a “password”. If this setting is written to the database, the type of the setting is set automatically in set_privacyidea_config
The key name needs to start with the token type.
- Parameters
key – The token specific setting key
- Returns
A string like “public”
-
static
get_sync_timeout
()[source]¶ get the token sync timeout value
- Returns
timeout value in seconds
- Return type
int
-
property
hashlib
¶
-
is_previous_otp
(otp, window=10)[source]¶ Check if the OTP values was previously used.
- Parameters
otp –
window –
- Returns
-