Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OctoPrint-MfaTotp plugin #1346

Merged
merged 4 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions _plugins/mfa_totp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: plugin

id: mfa_totp
title: "Two Factor Authentication: TOTP"
description: Plugin to support TOTP based Two Factor Authentication in OctoPrint.
authors:
- Gina Häußge
license: AGPLv3

date: 2025-01-27

homepage: https://github.com/OctoPrint/OctoPrint-MfaTotp
source: https://github.com/OctoPrint/OctoPrint-MfaTotp
archive: https://github.com/OctoPrint/OctoPrint-MfaTotp/archive/main.zip

follow_dependency_links: false

tags:
- 2fa
- mfa
- authentication
- security
- login
- totp

screenshots:
- url: /assets/img/plugins/mfa_totp/screenshot_login.png
alt: Screenshot of the login workflow, showing an additional prompt added to the login dialog, asking for entering a second factor, with TOTP being an option.
caption: Second factor dialog in the login workflow, asking for TOTP.
- url: /assets/img/plugins/mfa_totp/screenshot_enrollment.png
alt: Screenshot of the enrollment dialog, showing a QR Code to scan with an authenticator app and asking for a first token to be entered to confirm enrollment.
caption: The enrollment dialog

featuredimage: /assets/img/plugins/mfa_totp/screenshot_login.png

compatibility:
python: ">=3.7,<4"
octoprint:
- ">=1.11.0"
---

A plugin to support TOTP based Two Factor Authentication in OctoPrint >= 1.11.0.

Successfully tested with

- Google Authenticator
- Aegis

but adheres to the TOTP standard and should work with any related apps.

To enroll your user account, open the "User Settings", then under "2FA: TOTP" click on "Enroll" and follow the instructions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/plugins/mfa_totp/screenshot_login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading