Multi Factor Authentication with LinOTP#
Preface
By using LinOTP you decided to use a flexible, modern authentication system.
Congratulations on your choice!
LinOTP is a solution for authenticating with one time passwords. The runtime components of netgo LinOTP are available as source code, which gives you the possibility, to make your own adaption or to conduct code reviews on the software. LinOTP is originally based on GNU/Linux but as it is written in Python, it might also run on other operating systems.
netgo LinOTP is lean and very gentle on resources. It is scalable from small installations up to world-spanning, redundant enterprise installations.
This manual is divided into 5 main parts.
The LinOTP Management Guide describes the management of users, realms and tokens.
The LinOTP Installation Guide explains how to install LinOTP on different operating systems.
The LinOTP Selfservice Portal shows the administrator how users are allowed to manage their own tokens.
The LinOTP Appliance Manual deals with the LinOTP Appliance. No matter if you are using the hardware appliance or the virtual appliance, here you can find how to set up and configure the appliance.
If you plan to adapt or extend LinOTP you can develop your own modules. How to do this is described in LinOTP Development Guide.
Getting Support
netgo GmbH provides Enterprise Support for LinOTP.
Refer to https://www.linotp.de for the available support options.
The LinOTP logo and the LinOTP Manuals and documentation, “LinOTP Management Guide”, “LinOTP Installation Guide”, “LinOTP User Guide”, “LinOTP Appliance Manual”, “LinOTP Module Development Guide” and “API documentation” are intellectual property and under the copyright of netgo GmbH and can not be used without permission.
- 1. LinOTP Management Guide
- 1.1. Introduction
- 1.2. Quick Start Guide Token Management
- 1.3. Configure Resolvers and Realms - The Details
- 1.4. Supported tokens
- 1.5. Managing Tokens
- 1.5.1. Tokentype Configuration
- 1.5.2. Import tokens
- 1.5.3. Viewing users in certain realms
- 1.5.4. Viewing tokens in the WebUI
- 1.5.5. Assign tokens
- 1.5.6. Set OTP PIN
- 1.5.7. Enrolling tokens
- Enroll eToken NG-OTP
- Enroll mOTP Token
- Enroll HOTP, TOTP and OCRA2 Tokens
- Enroll LinOTP Static Password Token
- Enroll SMS OTP / Mobile TAN
- Enroll Remote Token
- Enroll Forwarding Token
- Enroll RADIUS Token
- Enroll LinOTP QR Token
- Enroll LinOTP Push Token
- Enroll OCRA2 Token
- Enroll YubiKeys
- Enroll E-Mail Token
- 1.5.8. Manage tokens
- 1.5.9. FIDO U2F
- 1.5.10. Set token realm
- 1.5.11. Token info
- 1.5.12. Lost token
- 1.5.13. Get serial by OTP
- 1.5.14. Get OTP
- 1.5.15. Users with no token
- 1.5.16. UserIdResolver migration
- 1.6. Policies
- 1.6.1. Introduction
- 1.6.2. Admin Policies
- 1.6.3. Audit Policies
- 1.6.4. Authentication Policies
- OTP PIN variants
- Authentication Passthrough
- Pass on no Token
- Challenge Response
- Forward Request to Remote Server
- Forward Request to Remote Server for User without Token only
- Setup LinOTP QR Token
- LinOTP Push Token Policies
- URL for OCRA2 Tokens
- Choose SMS Provider
- SMS Provider Failover
- Automatic SMS sending
- SMS Text
- Enforce SMS Text
- SMS Dynamic Mobile Number
- Choose E-mail Provider
- Email Subject
- Email Text
- Email dynamic address
- Automatically Disable or Delete Token
- 1.6.5. Authorization Policies
- 1.6.6. Enrollment Policies
- 1.6.7. Gettoken Policies
- 1.6.8. Notification Policies
- 1.6.9. Reporting Policies
- 1.6.10. Monitoring Policies
- 1.6.11. Selfservice policies
- 1.6.12. System policies
- 1.6.13. Users in policies
- 1.6.14. Clients in policies
- 1.6.15. Policy checker
- 1.6.16. Importing and exporting policies
- 1.6.17. Best practice - policy example
- 1.7. Audit Trail
- 1.8. Challenge Response
- 1.9. SMS Provider for SMS OTP Tokens / Mobile TANs
- 1.10. E-mail Provider for E-mail Token
- 1.11. Push Provider for LinOTP Push Token
- 1.12. System Config
- 1.13. Security Module
- 1.14. Retrieving OTP values
- 1.15. Tools
- 1.16. Backup and Restore
- 1.17. Monitoring / Reporting
- 1.18. PCI DSS
- 1.19. Usage scenarios
- 1.20. Troubleshooting
- 1.21. The LinOTP configuration
- 1.22. Indices and tables
- 2. LinOTP Selfservice Portal
- 2.1. Managing token in self service
- 2.2. Typical usecases for supported token in self service
- 2.2.1. Basic actions for tokens
- 2.2.2. Application Scenario with the LinOTP Push Token
- 2.2.3. Application Scenario with the LinOTP QR Token
- 2.2.4. Enrolling OATH Token for Google Authenticator
- 2.2.5. Using mOTP Token
- 2.2.6. Disable lost token
- 2.2.7. Change OTP PIN
- 2.2.8. Resynchronize Token
- 2.3. Individualize the Selfservice Portal
- 2.4. Indices and tables
- 3. LinOTP Installation Guide
- 3.1. Supported Operating Systems
- 3.2. Checklist
- 3.3. Server installation
- 3.4. Installing Authentication Modules
- 3.5. Customization
- 3.6. Database connection
- 3.7. Security Modules
- 3.8. Integration examples
- 3.8.1. OTP Authentication with an Apache web server
- 3.8.2. Firewall integration
- 3.8.3. Authentication with third party OTP solutions
- 3.8.4. Restrict access to certain devices to certain users
- 3.8.5. Map certain RADIUS clients to specific LinOTP realms
- 3.8.6. Authenticating RADIUS clients that pass the ntdomain
- 3.8.7. LinOTP and MIT Kerberos
- 3.8.8. Deny access for disabled users in Active Directory
- 3.8.9. Use LDAPs in UserIdResolvers
- 3.9. Migrating to LinOTP 3
- 3.10. Security advisories
- 3.11. Troubleshooting
- 3.12. Indices and tables
- 4. LinOTP Appliance Manual
- 4.1. SVA Install
- 4.2. Quick Start Guide Appliance
- 4.3. The Appliance Dashboard
- 4.4. Configuring network settings
- 4.5. Managing LinOTP token administrators
- 4.6. LinOTP debug logging
- 4.7. Configuring the RADIUS access to the LinOTP appliance
- 4.8. Working with configuration sets
- 4.9. Root user and appadmin user
- 4.10. Change the server SSL certificate
- 4.11. Advanced settings
- 4.12. Redundant setup
- 4.13. The support file
- 4.14. Updates
- 4.15. Backup and restore
- 4.16. License and Update key
- 4.17. Disaster recovery
- 4.18. Appliance uprade to Version 3
- 4.19. Network integration
- 4.20. Indices and tables
- 5. LinOTP Development Guide
- 6. LinOTP HOW-TOs Guide
- 6.1. Usability - HOW-TOs
- 6.2. Configuration - HOW-TOs
- 6.3. Infrastructure - HOW-TOs
- 6.4. Indices and tables