Fără Descriere

Allan Barcelos dfd8e0e2e1 unit tests and SECURITY policy 1 an în urmă
.github 1a611f6f3d fix name 1 an în urmă
.mvn 1c77faa011 first version, working 1 an în urmă
.vscode 1c77faa011 first version, working 1 an în urmă
src dfd8e0e2e1 unit tests and SECURITY policy 1 an în urmă
.gitignore 1c77faa011 first version, working 1 an în urmă
Jenkinsfile 1c77faa011 first version, working 1 an în urmă
LICENSE.md 1c77faa011 first version, working 1 an în urmă
README.md b50868445d Update README.md 1 an în urmă
SECURITY.md dfd8e0e2e1 unit tests and SECURITY policy 1 an în urmă
pom.xml dfd8e0e2e1 unit tests and SECURITY policy 1 an în urmă

README.md

MFA Google Auth Plugin

Jenkins Plugin Jenkins Plugin Installs MIT License

A Jenkins plugin that enforces multi‑factor authentication (MFA) using Google Authenticator. This plugin adds an additional layer of security by requiring users to provide a time‑based one‑time password (TOTP) after entering their username and password.


✨ Features

✅ Enforces MFA for Jenkins users

✅ Integrates with Google Authenticator

✅ Configurable enforcement policies

✅ Easy to set up and manage through Jenkins UI


📦 Installation

  1. Build the plugin:

    mvn clean package
    

After a successful build, you will find the .hpi file in the target/ directory.

  1. Upload to Jenkins:

    • Go to Manage Jenkins → Manage Plugins → Advanced
    • Use the Upload Plugin section to upload the mfa-google-auth.hpi.
  2. Restart Jenkins if required.


🔧 Configuration

  1. In Jenkins, go to Manage Jenkins → Configure Global Security.
  2. Enable MFA Google Auth Plugin under the security realm or configure it as instructed in your environment.
  3. Each user should scan the generated QR code with Google Authenticator (or a compatible TOTP app) and enter their verification code.

📌 Requirements


🛠 Development

This plugin is built with the Jenkins Plugin Parent POM.

To work on the plugin locally:

# Build and run tests
mvn clean verify

# Run Jenkins with the plugin
mvn hpi:run

Then open Jenkins at http://localhost:8080/jenkins/.


📜 License

This project is licensed under the MIT License.