Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
edumfa 2.8.0 documentation
Light Logo Dark Logo
edumfa 2.8.0 documentation
  • 1. Overview
  • 2. Installation
    • 2.1. Python Package Index
    • 2.2. Ubuntu Packages
    • 2.3. Docker Installation
    • 2.4. Upgrading
    • 2.5. The Config File
    • 2.6. Debugging and Logging
    • 2.7. The WSGI Script
    • 2.8. The edumfa-manage Script
    • 2.9. Security Modules
  • 3. First Steps
    • 3.1. Add an administrator
    • 3.2. Login to the Web UI
    • 3.3. Creating your first realm
    • 3.4. Enrolling your first token
  • 4. WebUI
    • 4.3.1. User Details
    • 4.3.2. Manage Users
    • 4.3.3. Additional user attributes
  • 5. Configuration
    • 5.1. UserIdResolvers
    • 5.2. Realms
    • 5.3. System Config
    • 5.4. CA Connectors
    • 5.5. SMTP server configuration
    • 5.6. RADIUS server configuration
    • 5.7. eduMFA server configuration
    • 5.8. SMS Gateway configuration
    • 5.9. Service IDs
    • 5.10. Token configuration
      • 5.10.1. Email Token Configuration
      • 5.10.2. HOTP Token Config
      • 5.10.3. SMS Token Configuration
      • 5.10.4. TiQR Token Configuration
      • 5.10.5. TOTP Token Config
      • 5.10.6. U2F Token Config
      • 5.10.7. WebAuthn Token Config
      • 5.10.8. WebAuthn Required Policies
      • 5.10.9. Yubico Cloud mode
      • 5.10.10. Yubikey AES mode
  • 6. Tokens
    • 6.1. Authentication Modes and Client Modes
    • 6.2. Hardware and Software Tokens
    • 6.3. Token types in eduMFA
      • 6.3.1.1. Four Eyes
      • 6.3.1.2. Application Specific Password Token
      • 6.3.1.3. Certificate Token
      • 6.3.1.4. Day Password Token
      • 6.3.1.5. eduPUSH Token
      • 6.3.1.6. Email
      • 6.3.1.7. HOTP Token
      • 6.3.1.8. Indexed Secret Token
      • 6.3.1.9. mOTP Token
      • 6.3.1.10. OCRA
      • 6.3.1.11. Paper Token (PPR)
      • 6.3.1.12. Legacy PUSH Token
      • 6.3.1.13. Password Token
      • 6.3.1.14. Questionnaire Token
      • 6.3.1.15. RADIUS
      • 6.3.1.16. Registration
      • 6.3.1.17. Remote
      • 6.3.1.18. SMS Token
      • 6.3.1.19. Spass - Simple Pass Token
      • 6.3.1.20. SSH Keys
      • 6.3.1.21. TAN Token
      • 6.3.1.22. TiQR
      • 6.3.1.23. TOTP
      • 6.3.1.24. U2F
      • 6.3.1.25. VASCO
      • 6.3.1.26. WebAuthn
      • 6.3.1.27. Yubico
      • 6.3.1.28. Yubikey
  • 7. Policies
    • 7.1. Admin policies
    • 7.2. User Policies
    • 7.3. Authentication policies
    • 7.4. Authorization policies
    • 7.5. Enrollment policies
    • 7.6. WebUI Policies
    • 7.7. Register Policy
    • 7.8. Policy Templates
    • 7.9. Extended Policy Conditions
  • 8. Event Handler
    • 8.6.1. User Notification Handler Module
    • 8.6.2. Token Handler Module
    • 8.6.3. Script Handler Module
    • 8.6.4. Counter Handler Module
    • 8.6.5. Federation Handler Module
    • 8.6.6. RequestMangler Handler Module
    • 8.6.7. ResponseMangler Handler Module
    • 8.6.8. Logging Handler Module
    • 8.6.9. Custom User Attribute Handler Module
    • 8.6.10. WebHook Handler Module
  • 9. Periodic Tasks
    • 9.1.1. SimpleStats
    • 9.1.2. EventCounter
  • 10. Audit
  • 11. Applications and Machines or Services
  • 12. Workflows and Tools
    • 12.1. Import
    • 12.2. Token Enrollment Wizard
    • 12.3. Enrollment Tools
      • 12.3.1. Yubikey Enrollment Tools
    • 12.4. Tools
    • 12.5. Two Step Enrollment
  • 13. Job Queue
  • 14. Code Documentation
    • 14.1.1. REST API
      • 14.1.1.1. Audit endpoint
      • 14.1.1.2. Authentication endpoints
      • 14.1.1.3. Validate endpoints
      • 14.1.1.4. System endpoints
      • 14.1.1.5. Tokengroup endpoints
      • 14.1.1.6. Service ID endpoints
      • 14.1.1.7. Resolver endpoints
      • 14.1.1.8. Realm endpoints
      • 14.1.1.9. Default Realm endpoints
      • 14.1.1.10. Token endpoints
      • 14.1.1.11. User endpoints
      • 14.1.1.12. Policy endpoints
      • 14.1.1.13. Event endpoints
      • 14.1.1.14. Machine Resolver endpoints
      • 14.1.1.15. Machine endpoints
      • 14.1.1.16. CA Connector endpoints
      • 14.1.1.17. Recover endpoints
      • 14.1.1.18. Register endpoints
      • 14.1.1.19. Monitoring endpoints
      • 14.1.1.20. Periodic Task endpoints
      • 14.1.1.21. Application endpoints
      • 14.1.1.22. Tokentype endpoints
      • 14.1.1.23. SMTP server endpoints
      • 14.1.1.24. SMS Gateway endpoints
      • 14.1.1.25. RADIUS server endpoints
      • 14.1.1.26. Client endpoints
    • 14.2.1. library functions
      • 14.2.1.1. Users
      • 14.2.1.2. Token Class
        • 14.2.1.2.1. 4 Eyes Token
        • 14.2.1.2.2. Certificate Token
        • 14.2.1.2.3. Daplug Token
        • 14.2.1.2.4. eduPUSH Token
        • 14.2.1.2.5. Email Token
        • 14.2.1.2.6. HOTP Token
        • 14.2.1.2.7. mOTP Token
        • 14.2.1.2.8. OCRA Token
        • 14.2.1.2.9. Paper Token
        • 14.2.1.2.10. PasswordToken
        • 14.2.1.2.11. Legacy PUSH Token
        • 14.2.1.2.12. Questionnaire Token
        • 14.2.1.2.13. RADIUS Token
        • 14.2.1.2.14. Registration Code Token
        • 14.2.1.2.15. Remote Token
        • 14.2.1.2.16. SMS Token
        • 14.2.1.2.17. SPass Token
        • 14.2.1.2.18. SSHKey Token
        • 14.2.1.2.19. TiQR Token
        • 14.2.1.2.20. TOTP Token
        • 14.2.1.2.21. U2F Token
        • 14.2.1.2.22. Vasco Token
        • 14.2.1.2.23. WebAuthn Token
        • 14.2.1.2.24. Yubico Token
        • 14.2.1.2.25. Yubikey Token
      • 14.2.1.3. Token Functions
      • 14.2.1.4. Application Class
      • 14.2.1.5. Policy Module
      • 14.2.1.6. Job Queue
        • 14.2.1.6.1. Huey Queue Class
      • 14.2.1.7. API Policies
      • 14.2.1.8. Policy Decorators
      • 14.2.1.9. Event Handler
        • 14.2.1.9.1. Event Handler Base Class
        • 14.2.1.9.2. User Notification Event Handler
      • 14.2.1.10. SMS Provider
        • 14.2.1.10.1. HTTP SMS Provider
        • 14.2.1.10.2. Sipgate SMS Provider
        • 14.2.1.10.3. SMTP SMS Provider
    • 14.2.2. UserIdResolvers
    • 14.2.3. Audit log
    • 14.2.4. Monitoring
    • 14.2.5. Machine Resolvers
    • 14.2.6. PinHandler
    • 14.3.1. The database model
  • 15. Frequently Asked Questions
    • 15.1. Customization
    • 15.2. How can I create users in the eduMFA Web UI?
    • 15.3. So what’s the thing with all the admins?
    • 15.4. What are possible rollout strategies?
    • 15.5. What are possible migration strategies?
    • 15.6. Setup translation
    • 15.7. How can I setup HA (High Availability) with eduMFA?
    • 15.8. Database connect string
    • 15.9. Are there shortcuts to use the Web UI?
    • 15.10. How to copy a resolver definition?
    • 15.11. Cryptographic considerations of eduMFA
    • 15.12. Re-Encrypting data
    • 15.13. Time is sensitive in eduMFA
    • 15.14. Policies
    • 15.15. Performance considerations
    • 15.16. What happens in the tokenview?
    • 15.17. How to mitigate brute force and lock tokens
  • 16. Glossary
Back to top
View this page

5. Configuration¶

The configuration menu can be used to define useridresolvers and realms, set the system config and the token config.

It also contains a shortcut to the Policies, Event Handler and Periodic Tasks.

  • 5.1. UserIdResolvers
  • 5.2. Realms
  • 5.3. System Config
  • 5.4. CA Connectors
  • 5.5. SMTP server configuration
  • 5.6. RADIUS server configuration
  • 5.7. eduMFA server configuration
  • 5.8. SMS Gateway configuration
  • 5.9. Service IDs
  • 5.10. Token configuration
Next
5.1. UserIdResolvers
Previous
4.3.3. Additional user attributes
Copyright © 2014-2023, Cornelius Kölbel; 2024-2025 eduMFA Project
Made with Sphinx and @pradyunsg's Furo