https://github.com/jenkinsci/miniorange-two-factor-plugin

This repository is for Jenkins two factor plugin.
https://github.com/jenkinsci/miniorange-two-factor-plugin

authentication jenkins-plugin login mfa security two-factor-authentication user-managment

Last synced: 8 months ago
JSON representation

This repository is for Jenkins two factor plugin.

• Host: GitHub
• URL: https://github.com/jenkinsci/miniorange-two-factor-plugin
• Owner: jenkinsci
• License: mit
• Created: 2023-08-28T21:31:41.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2025-01-16T05:39:05.000Z (over 1 year ago)
• Last Synced: 2025-01-30T06:11:12.308Z (over 1 year ago)
• Topics: authentication, jenkins-plugin, login, mfa, security, two-factor-authentication, user-managment
• Language: Java
• Homepage: https://plugins.jenkins.io/miniorange-two-factor/
• Size: 1.13 MB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Two-Factor Authentication for Jenkins

![image_1](/docs/images/jenkins_2fa.png)

**Two-Factor Authentication for Jenkins** Plugin adds a layer of security to Jenkins authentication by requiring users

to provide a second factor of authentication along with their username and password.

It enhances the overall security of your Jenkins environment. Additionally, this plugin does not require you to extend the security realm, making it easier to implement and use.

**Supported Authentication method**

* Security Questions

* OTP over email

* Duo Push Notification [Available in Premium version]

* Mobile Authenticator [Available in premium version]

* Yubikey hardware token [Available in premium version]

* OTP over SMS [Available in premium version]

* Backup code [Available in premium version]

**Features of Jenkins 2FA plugin**

* Enable and disable 2FA for all users in a single click [Free]

* 2FA supported for all security realms [Free]

* Easy configuration [Free]

* Enable 2FA for users in specific groups [Premium]

* Disable 2FA for users in specific groups [Premium]

**☞ Your unique requirements or feature requests are always welcome by our team, Feel free to write us at info@xecurify.com and we will customize our solutions to your needs.**

# Installation Instructions

* **Please follow [this](https://miniorange.com/atlassian/jenkins-two-factor-authentication/) guide for installation and activation of the plugin.**

# Reset Security methods

* Go to your user profile and click on the 2FA configuration button in the side panel.

![image_1](docs/images/configuration/reset_2FA.png)

* Choose the "**Reset**" or "**Configuration**" option to either reset the currently configured authentication method or set up a new method if it is currently not configured

![image_2](docs/images/configuration/ConfigureOrReset.png)

# Troubleshooting and Logging

Refer below steps to generate error Logs and send it to info@xecurify.com. We will help you

resolve your issue in no time.

* Sign in to Jenkins as an admin and select Manage Jenkins from the left panel of the dashboard.

* Scroll down to find the System Log option.

* Click Add new Log Recorder button and add the log recorder name as 2FaLogs.

* Add **io.jenkins.plugins.twofactor** as a Logger and select fine as a log level.

  ![image_3](docs/images/troubleshooting/logger_record.png)

* Save the settings.

* Perform 2FA on another browser/private window to record logs.

* Visit the System Log option again and copy the recorded logs from the 2FaLogs logger.

* Paste logs in a notepad/word file and send it to us.

* You can even reach us at info@xecurify.com or raise a ticket using this [link](https://miniorange.atlassian.net/servicedesk/customer/portal/2%22).