linotp.lib package¶
This model contains the linotp processing logic
- linotp.lib.deprecated_methods(deprecated_methods_list)¶
deprecated_methods - decorator function
mark linotp endpoints as deprecated when accessed with a http method in the provided list, eg.
@deprecated_methods([‘GET’]) def check()
1- A warning for the deprecation will be added to the docstring 2- A warning should be written in case that the ‘check’ endpoint is accessed using a Http GET request. The warning log itself should be implemented in the controllers before calling the method(in progress TODO)
- Developer Note: the implementation is not completed: major shortcoming is that its
not possible to access the request method the function is called with.
- Parameters
deprecated_methods_list – a list of methods that are deprecated for the
end point. E.g. [“GET”] or [“POST”] or [“GET”, “POST”]
- linotp.lib.render_calling_path(func)¶
return the api path inc HTTP methods
utility for sphimx rendering of api docs:
Subpackages¶
- linotp.lib.ImportOTP package
- linotp.lib.audit package
- linotp.lib.auth package
- linotp.lib.config package
getFromConfig()getLinotpConfig()refreshConfig()removeFromConfig()storeConfig()updateConfig()- Submodules
- linotp.lib.crypto package
SecretObjSecretObj.aes_decrypt()SecretObj.calc_dh()SecretObj.check_encrypted_pin()SecretObj.check_hashed_pin()SecretObj.compare()SecretObj.compare_password()SecretObj.decrypt()SecretObj.decrypt_pin()SecretObj.encrypt()SecretObj.encryptPin()SecretObj.encrypt_pin()SecretObj.getKey()SecretObj.hash_pin()SecretObj.hmac_digest()
- Submodules
- linotp.lib.crypto.encrypted_data module
- linotp.lib.crypto.pbkdf2 module
- linotp.lib.crypto.rsa module
- linotp.lib.crypto.utils module
check()compare()compare_password()createActivationCode()createNonce()crypt_password()decode_base64_urlsafe()decrypt()decryptPassword()decryptPin()dsa_to_dh_public()dsa_to_dh_secret()encode_base64_urlsafe()encrypt()encryptPassword()encryptPin()extract_tan()get_dh_secret_key()get_hashalgo_from_description()get_public_key()get_rand_digit_str()get_secret_key()geturandom()hash_digest()hmac_digest()init_key_partition()kdf2()zerome()
- linotp.lib.ext package
- linotp.lib.policy package
AuthorizeExceptionMaxTokenRealmPolicyExceptionMaxTokenTypeUserPolicyExceptionMaxTokenUserPolicyExceptionPolicyExceptionautoassignment_forward()checkAdminAuthorization()checkAuthorisation()checkOTPPINPolicy()checkPolicyPost()checkPolicyPre()checkToolsAuthorisation()check_auth_serial()check_auth_tokentype()check_user_authorization()createRandomPin()delete_on_authentication_exceed()disable_on_authentication_exceed()getAdminPolicies()getOTPPINEncrypt()get_active_token_statuses_for_reporting()get_auth_AutoSMSPolicy()get_auth_challenge_response()get_auth_forward()get_auth_forward_on_no_token()get_auth_passOnNoToken()get_auth_passthru()get_auto_enrollment()get_autoassignment()get_autoassignment_from_realm()get_autoassignment_without_pass()get_partition()get_pin_policies()get_realm_for_setrealm()get_single_auth_policy()get_tokenissuer()get_tokenlabel()ignore_autoassignment_pin()is_auth_return()match_allowed_realms()parse_policy()purge_enrollment_token()supports_offline()trigger_sms()- Submodules
- linotp.lib.policy.action module
- linotp.lib.policy.definitions module
- linotp.lib.policy.evaluate module
- linotp.lib.policy.filter module
- linotp.lib.policy.forward module
- linotp.lib.policy.manage module
- linotp.lib.policy.maxtoken module
- linotp.lib.policy.permissions module
- linotp.lib.policy.processing module
- linotp.lib.policy.util module
- linotp.lib.security package
FatalHSMExceptionSecurityModuleSecurityModule.decrypt()SecurityModule.decryptPassword()SecurityModule.decryptPin()SecurityModule.encrypt()SecurityModule.encryptPassword()SecurityModule.encryptPin()SecurityModule.getAdditionalClassConfig()SecurityModule.isReady()SecurityModule.random()SecurityModule.setup_module()SecurityModule.signMessage()SecurityModule.verfiyMessageSignature()
- Submodules
- linotp.lib.tools package
Submodules¶
- linotp.lib.HMAC module
- linotp.lib.apps module
- linotp.lib.cache module
- linotp.lib.cache_utils module
- linotp.lib.challenges module
- linotp.lib.context module
- linotp.lib.error module
- linotp.lib.fs_utils module
- linotp.lib.local module
- linotp.lib.log module
- linotp.lib.logs module
- linotp.lib.migrate module
- linotp.lib.module_loader module
- linotp.lib.monitoring module
- linotp.lib.pairing module
- linotp.lib.realm module
- linotp.lib.registry module
- linotp.lib.remote_service module
- linotp.lib.reply module
- linotp.lib.reporting module
- linotp.lib.request module
- linotp.lib.resolver module
- linotp.lib.resources module
- linotp.lib.rw_lock module
- linotp.lib.secret_obj module
- linotp.lib.selfservice module
- linotp.lib.support module
- linotp.lib.text_utils module
- linotp.lib.token module
TokenHandlerTokenHandler.addTokenInfo()TokenHandler.assignToken()TokenHandler.auto_assignToken()TokenHandler.auto_assign_otp_only()TokenHandler.auto_enrollToken()TokenHandler.check_serial()TokenHandler.copyTokenPin()TokenHandler.copyTokenRealms()TokenHandler.copyTokenUser()TokenHandler.enableToken()TokenHandler.genSerial()TokenHandler.getTokenOwner()TokenHandler.getTokensOfType()TokenHandler.get_serial_by_otp()TokenHandler.get_token_by_otp()TokenHandler.hasOwner()TokenHandler.initToken()TokenHandler.isTokenOwner()TokenHandler.losttoken()TokenHandler.removeToken()TokenHandler.resyncToken()TokenHandler.setCounterWindow()TokenHandler.setDescription()TokenHandler.setHashLib()TokenHandler.setMaxFailCount()TokenHandler.setOtpLen()TokenHandler.setSyncWindow()TokenHandler.unassignToken()
add_last_accessed_info()add_last_verified_info()add_time_info()createTokenClassObject()genSerial()getNumTokenUsers()getOtp()getRealms4Token()getRealmsOfTokenOrUser()getRolloutToken4User()getTokenConfig()getTokenInRealm()getTokenNumResolver()getTokenRealms()getTokenType()get_multi_otp()get_raw_token()get_raw_tokens()get_token()get_token_owner()get_token_type_list()get_tokens()get_tokenserial_of_transaction()get_used_tokens_count()remove_token()resetToken()setDefaults()setPin()setPinSo()setPinUser()setRealms()tokenExist()token_owner_iterator()
- linotp.lib.tokeniterator module
- linotp.lib.type_utils module
DurationParsingExceptionboolean()check_networks_expression()check_time_format_string()convert_to_datetime()encrypted_data()get_duration()get_ip_address()get_ip_network()get_timeout()is_duration()is_integer()is_ip_address()is_ip_address_dotted_quad()is_network()parse_duration()parse_timeout()
- linotp.lib.user module
NoResolverFoundUserdelete_from_local_cache()delete_from_realm_resolver_cache()delete_from_realm_resolver_local_cache()delete_from_resolver_user_cache()delete_from_user_cache()delete_realm_resolver_cache()delete_resolver_user_cache()find_resolver_spec_for_config_identifier()getRealmBox()getResolvers()getResolversOfUser()getSearchFields()getSplitAtSign()getUserDetail()getUserFromParam()getUserFromRequest()getUserId()getUserInfo()getUserList()getUserListIterators()getUserPhone()getUserRealms()getUserResolverId()get_authenticated_user()get_resolvers_of_user()get_user_from_options()get_userinfo()lookup_user_in_resolver()setRealm()splitUser()
- linotp.lib.useriterator module
- linotp.lib.userservice module
- linotp.lib.util module
check_selfservice_session()checksum()deep_update()dict_copy()generate_otpkey()generate_password()getLowerParams()getParam()get_api_version()get_client()get_copyright_info()get_log_level()get_request_param()get_version()get_version_number()int_from_bytes()is_TRUSTED_PROXIES_active()is_addr_in_network()is_http_forwarded_active()is_valid_fqdn()is_x_forwarded_for_active()modhex_decode()modhex_encode()normalize_activation_code()remove_empty_lines()remove_session_from_param()str2unicode()unicode_compare()uniquify()