linotp.controllers package

This is the controller module. The controllers provide the Web API to communicate with LinOTP. You can use the following controllers:

linotp.controllers.admin	API to manage the tokens
linotp.controllers.audit	to search the audit trail
linotp.controllers.auth	to do authentication tests
linotp.controllers.error	to display errors
linotp.controllers.gettoken	to retrieve OTP values
linotp.controllers.maintenance	for internal maintenance purposes
linotp.controllers.manage	the Web UI
linotp.controllers.monitoring	for system monitoring
linotp.controllers.openid	the openid interface
linotp.controllers.ocra	Ocra token API
linotp.controllers.selfservice	the selfservice UI
linotp.controllers.system	to configure the system
linotp.controllers.tools	to access various tools
linotp.controllers.u2f	U2F token API
linotp.controllers.userservice	user API, used by selfservice frontend
linotp.controllers.validate	for authenticating / OTP checking

Additionally there is a new set of controllers accessible under /api/v2, providing the same functionality as some of the previous controllers, but with a more RESTful interface:

linotp.controllers.tokens	API to manage tokens
linotp.controllers.realms	API to manage realms
linotp.controllers.resolvers	API to manage resolvers and look up users

class linotp.controllers.BaseController(name, install_name='', **kwargs)

Bases: Blueprint

BaseController class - will be called with every request

before_handler()

Call derived controller’s legacy __before__ method if it exists

This method is called before each request is processed.

default_url_prefix = ''

Suggested URL to access this controller.

The URL at which this controller will be available depends on a number of factors. These are, in order of priority: 1. Any explicit path in the

settings ENABLE_CONTROLLER or DISABLE_CONTROLLER = ControllerName:PATH

2. The controller’s base_url_prefix setting

3. The name of the controller

jwt_check()

Check whether the current request needs to be authenticated using JWT, and if so, whether it contains a valid JWT access token. The login name from the access token is then stored in g.authUser for the benefit of lib.user.getUserFromRequest().

jwt_exempt = False

parse_requesting_user()

load the requesting user

The result is placed into request_context[‘RequestUser’]

property request_params

Submodules

• linotp.controllers.admin module
  • AdminController
    • AdminController.assign()
    • AdminController.check_serial()
    • AdminController.checkstatus()
    • AdminController.copyTokenPin()
    • AdminController.copyTokenUser()
    • AdminController.disable()
    • AdminController.enable()
    • AdminController.getSerialByOtp()
    • AdminController.getTokenOwner()
    • AdminController.init()
    • AdminController.loadtokens()
    • AdminController.losttoken()
    • AdminController.remove()
    • AdminController.reset()
    • AdminController.resync()
    • AdminController.set()
    • AdminController.setPin()
    • AdminController.setValidity()
    • AdminController.show()
    • AdminController.testresolver()
    • AdminController.tokenrealm()
    • AdminController.totp_lookup()
    • AdminController.unassign()
    • AdminController.unpair()
    • AdminController.userlist()
• linotp.controllers.audit module
  • AuditController
    • AuditController.search()
• linotp.controllers.auditlog module
  • AuditlogController
    • AuditlogController.get_audit_entries()
  • UserNotFoundException
• linotp.controllers.auth module
  • AuthController
    • AuthController.challenge_response()
    • AuthController.index()
    • AuthController.index3()
    • AuthController.jwt_exempt
    • AuthController.ocra2()
    • AuthController.pushtoken()
    • AuthController.qrtoken()
• linotp.controllers.base module
  • BaseController
    • BaseController.before_handler()
    • BaseController.default_url_prefix
    • BaseController.jwt_check()
    • BaseController.jwt_exempt
    • BaseController.parse_requesting_user()
    • BaseController.request_params
  • ControllerMetaClass
  • JWTMixin
    • JWTMixin.login()
    • JWTMixin.logout()
  • add_hyphenated_url()
  • jwt_exempt()
  • jwt_refresh()
  • methods()
• linotp.controllers.error module
  • ErrorController
    • ErrorController.document()
    • ErrorController.img()
    • ErrorController.jwt_exempt
    • ErrorController.style()
• linotp.controllers.gettoken module
  • GettokenController
    • GettokenController.getmultiotp()
    • GettokenController.getotp()
• linotp.controllers.maintenance module
  • MaintenanceController
    • MaintenanceController.check_status()
    • MaintenanceController.setLogLevel()
• linotp.controllers.manage module
  • ManageController
    • ManageController.audittrail()
    • ManageController.context()
    • ManageController.custom_style()
    • ManageController.help()
    • ManageController.index()
    • ManageController.login()
    • ManageController.policies()
    • ManageController.tokeninfo()
    • ManageController.tokentype()
    • ManageController.tokenview()
    • ManageController.tokenview_flexi()
    • ManageController.userview()
    • ManageController.userview_flexi()
• linotp.controllers.migrate module
  • MigrateController
    • MigrateController.backup()
    • MigrateController.restore()
• linotp.controllers.monitoring module
  • MonitoringController
    • MonitoringController.activeUsers()
    • MonitoringController.config()
    • MonitoringController.license()
    • MonitoringController.storageEncryption()
    • MonitoringController.tokens()
    • MonitoringController.userinfo()
• linotp.controllers.realms module
  • RealmsController
    • RealmsController.get_realms()
    • RealmsController.get_users()
• linotp.controllers.reporting module
  • ReportingController
    • ReportingController.delete_all()
    • ReportingController.delete_before()
    • ReportingController.maximum()
    • ReportingController.period()
    • ReportingController.show()
• linotp.controllers.resolvers module
  • ResolversController
    • ResolversController.get_resolvers()
    • ResolversController.get_user()
    • ResolversController.get_users()
  • UserNotFoundException
• linotp.controllers.selfservice module
  • SelfserviceController
    • SelfserviceController.assign()
    • SelfserviceController.authUser
    • SelfserviceController.custom_style()
    • SelfserviceController.default_url_prefix
    • SelfserviceController.delete()
    • SelfserviceController.disable()
    • SelfserviceController.enable()
    • SelfserviceController.form_access_methods
    • SelfserviceController.getotp()
    • SelfserviceController.history()
    • SelfserviceController.index()
    • SelfserviceController.jwt_exempt
    • SelfserviceController.landing()
    • SelfserviceController.load_form()
    • SelfserviceController.login()
    • SelfserviceController.logout()
    • SelfserviceController.reset()
    • SelfserviceController.resync()
    • SelfserviceController.setmpin()
    • SelfserviceController.setpin()
    • SelfserviceController.unassign()
    • SelfserviceController.usertokenlist()
    • SelfserviceController.webprovisiongoogletoken()
    • SelfserviceController.webprovisionoathtoken()
• linotp.controllers.system module
  • RemoveForbiddenError
  • SystemController
    • SystemController.checkPolicy()
    • SystemController.delConfig()
    • SystemController.delPolicy()
    • SystemController.delProvider()
    • SystemController.delRealm()
    • SystemController.delResolver()
    • SystemController.getConfig()
    • SystemController.getDefaultRealm()
    • SystemController.getPolicy()
    • SystemController.getPolicyDef()
    • SystemController.getProvider()
    • SystemController.getProviderDef()
    • SystemController.getRealms()
    • SystemController.getReportedStatuses()
    • SystemController.getResolver()
    • SystemController.getResolvers()
    • SystemController.getSupportInfo()
    • SystemController.importPolicy()
    • SystemController.isSupportValid()
    • SystemController.policies_flexi()
    • SystemController.setConfig()
    • SystemController.setDefault()
    • SystemController.setDefaultProvider()
    • SystemController.setDefaultRealm()
    • SystemController.setPolicy()
    • SystemController.setProvider()
    • SystemController.setRealm()
    • SystemController.setResolver()
    • SystemController.setSupport()
    • SystemController.setupSecurityModule()
    • SystemController.testProvider()
• linotp.controllers.tokens module
  • TokenAdapter
    • TokenAdapter.to_JSON_format()
  • TokensController
    • TokensController.get_token_by_serial()
    • TokensController.get_tokens()
• linotp.controllers.tools module
  • ToolsController
    • ToolsController.import_users()
    • ToolsController.migrate_resolver()
    • ToolsController.setPassword()
• linotp.controllers.u2f module
  • U2FController
    • U2FController.valid_facets()
• linotp.controllers.userservice module
  • UserNotFound
  • UserserviceController
    • UserserviceController.activateocratoken()
    • UserserviceController.assign()
    • UserserviceController.auth()
    • UserserviceController.context()
    • UserserviceController.delete()
    • UserserviceController.delete_cookie()
    • UserserviceController.disable()
    • UserserviceController.enable()
    • UserserviceController.enroll()
    • UserserviceController.finishocra2token()
    • UserserviceController.getSerialByOtp()
    • UserserviceController.getmultiotp()
    • UserserviceController.history()
    • UserserviceController.jwt_exempt
    • UserserviceController.login()
    • UserserviceController.logout()
    • UserserviceController.pre_context()
    • UserserviceController.reset()
    • UserserviceController.resync()
    • UserserviceController.set_cookie()
    • UserserviceController.setdescription()
    • UserserviceController.setmpin()
    • UserserviceController.setpin()
    • UserserviceController.unassign()
    • UserserviceController.userinfo()
    • UserserviceController.usertokenlist()
    • UserserviceController.verify()
    • UserserviceController.webprovision()
  • add_and_delete_cookies()
  • get_auth_user()
  • secure_cookie()
  • sendResult()
  • unauthorized()
• linotp.controllers.validate module
  • ValidateController
    • ValidateController.accept_transaction()
    • ValidateController.check()
    • ValidateController.check_s()
    • ValidateController.check_status()
    • ValidateController.check_t()
    • ValidateController.check_yubikey()
    • ValidateController.fail()
    • ValidateController.jwt_exempt
    • ValidateController.ok()
    • ValidateController.pair()
    • ValidateController.reject_transaction()
    • ValidateController.samlcheck()
    • ValidateController.simplecheck()
    • ValidateController.smspin()