linotp package¶
- LinOTP is an open solution for strong two-factor authentication
with One Time Passwords.
LinOTP server is licensed under the AGPLv3, so that you are able to have a complete working open source solution. But LinOTP 2 is also open as far as its modular architecture is concerned. LinOTP 2 aims to not bind you to any decision of the authentication protocol or it does not dictate you where your user information should be stored. This is achieved by its new, totally modular architecture.
Tokenclasses¶
LinOTP already comes with several tokenclasses defined in linotp.tokens But you can simply define your own tokenclass object. Take a look at the base class in tokenclass.py
UserIdResolvers¶
LinOTP can use arbitrary methods to look up your user base - the userid resolvers. With LinOTP comes a flatfile (passwd), the ldap/active directory resolver and a sql resolver.
LinOTP is accessed via a simple http based api, which returns json object that are easy to integrate into your authetication solution. Or you can use the simple webui which come with linotp
Subpackages¶
- linotp.cli package
- linotp.controllers package
BaseController
- Submodules
- linotp.controllers.admin module
- linotp.controllers.audit module
- linotp.controllers.auditlog module
- linotp.controllers.auth module
- linotp.controllers.base module
- linotp.controllers.error module
- linotp.controllers.gettoken module
- linotp.controllers.maintenance module
- linotp.controllers.manage module
- linotp.controllers.migrate module
- linotp.controllers.monitoring module
- linotp.controllers.realms module
- linotp.controllers.reporting module
- linotp.controllers.resolvers module
- linotp.controllers.selfservice module
- linotp.controllers.system module
- linotp.controllers.tokens module
- linotp.controllers.tools module
- linotp.controllers.u2f module
- linotp.controllers.userservice module
- linotp.controllers.validate module
- linotp.lib package
deprecated_methods()
render_calling_path()
- Subpackages
- linotp.lib.ImportOTP package
- linotp.lib.audit package
- linotp.lib.auth package
- linotp.lib.config package
- linotp.lib.crypto package
- linotp.lib.ext package
- linotp.lib.policy package
AuthorizeException
MaxTokenRealmPolicyException
MaxTokenTypeUserPolicyException
MaxTokenUserPolicyException
PolicyException
autoassignment_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_single_auth_policy()
get_tokenissuer()
get_tokenlabel()
ignore_autoassignment_pin()
is_auth_return()
match_allowed_realms()
parse_policy()
purge_enrollment_token()
set_realm()
supports_offline()
trigger_sms()
- Submodules
- linotp.lib.security package
- 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
TokenHandler
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
DurationParsingException
boolean()
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
NoResolverFound
User
delete_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()
- linotp.middlewares package
- linotp.model package
create_admin_realm()
create_admin_resolver()
fix_db_encoding()
init_db_tables()
set_defaults()
setup_db()
- Subpackages
- Submodules
- linotp.model.challange module
- linotp.model.config module
- linotp.model.db_logging module
- linotp.model.imported_user module
- linotp.model.local_admin_user module
- linotp.model.migrate module
- linotp.model.realm module
- linotp.model.reporting module
- linotp.model.resolver module
- linotp.model.token module
- linotp.model.tokenRealm module
- linotp.provider package
ProviderNotAvailable
default_func()
delProvider()
func()
getProvider()
get_all_new_providers()
get_default_provider()
get_legacy_provider()
get_provider_from_policy()
loadProvider()
loadProviderFromPolicy()
load_provider_classes()
load_provider_ini()
parse_default_provider()
parse_legacy_provider()
parse_provider()
save_legacy_provider()
save_new_provider()
setDefaultProvider()
setProvider()
- Subpackages
- Submodules
- linotp.tokens package
load_module()
reload_classes()
- Subpackages
- Submodules
- linotp.tokens.emailtoken module
- linotp.tokens.forwardtoken module
- linotp.tokens.hmactoken module
- linotp.tokens.passwordtoken module
- linotp.tokens.radiustoken module
- linotp.tokens.remotetoken module
- linotp.tokens.smstoken module
- linotp.tokens.spasstoken module
- linotp.tokens.tagespassworttoken module
- linotp.tokens.totptoken module
- linotp.tokens.yubicotoken module
- linotp.tokens.yubikeytoken module
- linotp.useridresolver package
Submodules¶
- linotp.app module
ConfigurationError
ExtFlaskConfig
LinOTPApp
LinOTPApp.cache
LinOTPApp.check()
LinOTPApp.check_license()
LinOTPApp.create_context()
LinOTPApp.database_needed()
LinOTPApp.enable_controller()
LinOTPApp.enabled_controllers
LinOTPApp.exclude_from_before_request_setup()
LinOTPApp.finalise_request()
LinOTPApp.getCacheManager()
LinOTPApp.getRadiusDictionaryPath()
LinOTPApp.getRequestParams()
LinOTPApp.init_jwt_config()
LinOTPApp.is_healthcheck_request()
LinOTPApp.is_request_static()
LinOTPApp.setup_audit()
LinOTPApp.setup_controllers()
LinOTPApp.setup_resolvers()
LinOTPApp.start_session()
allocate_security_module()
create_app()
drop_security_module()
healthcheck()
init_linotp_config()
init_logging()
init_security_provider()
setup_cache()
- linotp.flap module
- linotp.settings module
Config
Config.ACTIVE_SECURITY_MODULE
Config.ADMIN_PASSWORD
Config.ADMIN_REALM_NAME
Config.ADMIN_RESOLVER_NAME
Config.ADMIN_USERNAME
Config.AUDIT_DATABASE_URI
Config.AUDIT_ERROR_ON_TRUNCATION
Config.AUDIT_PRIVATE_KEY_FILE
Config.AUDIT_PUBLIC_KEY_FILE
Config.BABEL_DOMAIN
Config.BABEL_TRANSLATION_DIRECTORIES
Config.BACKUP_DIR
Config.BACKUP_FILE_TIME_FORMAT
Config.BEAKER_CACHE_TYPE
Config.CACHE_DIR
Config.CUSTOM_TEMPLATES_DIR
Config.DATABASE_URI
Config.DISABLE_CONTROLLERS
Config.ENABLE_CONTROLLERS
Config.GET_CLIENT_ADDRESS_FROM_POST_DATA
Config.HELP_URL
Config.HSM_DEFAULT_CONFIG
Config.HSM_PKCS11_CONFIG
Config.JWT_ACCESS_TOKEN_EXPIRES
Config.JWT_ACCESS_TOKEN_REFRESH
Config.JWT_BLACKLIST_ENABLED
Config.JWT_CSRF_CHECK_FORM
Config.JWT_SECRET_ITERATIONS
Config.JWT_SESSION_COOKIE
Config.JWT_TOKEN_LOCATION
Config.LOGGING_LEVEL
Config.LOG_CONFIG
Config.LOG_CONSOLE_LEVEL
Config.LOG_CONSOLE_LINE_FORMAT
Config.LOG_FILE_DIR
Config.LOG_FILE_LEVEL
Config.LOG_FILE_LINE_FORMAT
Config.LOG_FILE_MAX_LENGTH
Config.LOG_FILE_MAX_VERSIONS
Config.LOG_FILE_NAME
Config.LOG_LEVEL
Config.LOG_LEVEL_DB_CLIENT
Config.MAINTENANCE_VERIFY_CLIENT_ENV_VAR
Config.MAKO_DEFAULT_FILTERS
Config.MAKO_TRANSLATE_EXCEPTIONS
Config.PROFILE
Config.RADIUS_NAS_IDENTIFIER
Config.ROOT_DIR
Config.SECRET_FILE
Config.SESSION_COOKIE_SECURE
Config.SITE_ROOT_REDIRECT
Config.SQLALCHEMY_TRACK_MODIFICATIONS
Config.TLS_CA_CERTIFICATES_FILE
Config.TOKEN_MODULES
Config.TRUSTED_PROXIES
Config.init_app()
ConfigItem
ConfigSchema
DevelopmentConfig
LinOTPConfigKeyError
LinOTPConfigValueError
ProductionConfig
TestingConfig
check_absolute_pathname()
check_int_in_range()
check_json_schema()
check_membership()