Skip to content

Commit

Permalink
docs: add Casdoor Authenticator App documentation (#633)
Browse files Browse the repository at this point in the history
* docs: add Casdoor Authenticator App documentation

* update doc
  • Loading branch information
IZUMI-Zu authored Sep 4, 2024
1 parent c3ed11f commit a9329b2
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 0 deletions.
63 changes: 63 additions & 0 deletions docs/how-to-connect/casdoor-authenticator-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Casdoor Authenticator App
description: Store totp code in Casdoor
keywords: [authenticator, 2fa, password manager, totp]
authors: [IZUMI-Zu]
---

## Overview

We are excited to introduce the Casdoor Authenticator App, a new addition to the Casdoor ecosystem that allows users to store TOTP (Time-based One-Time Password) codes securely in Casdoor. With this app, users can conveniently manage their two-factor authentication (2FA) needs directly from their mobile devices. The Casdoor Authenticator App supports generating TOTP codes for enhanced security during login, providing a simple and user-friendly experience for securing your accounts.

In addition to client-side functionality, Casdoor also offers server-side management capabilities for administrators, enabling them to monitor and manage user logins and authentication processes more effectively. Furthermore, the Casdoor Authenticator App supports syncing TOTP data to the server, ensuring that your authentication codes are securely backed up and always available, providing a robust solution for managing your authentication needs.

Whether you are a developer, an administrator, or an end-user, the Casdoor Authenticator App ensures a seamless, secure, and flexible way to manage your two-factor authentication.

| Android App | iOS App |
| ----------- | ------- |
| ![android](/img/casdoor-authenticator-app/android.png) | ![ios](/img/casdoor-authenticator-app/ios.png) |

## What is TOTP?

TOTP stands for Time-based One-Time Passwords and is a common form of two-factor authentication (2FA). Unique numeric passwords are generated with a standardized [algorithm](https://tools.ietf.org/html/rfc6238) that uses the current time as an input. The time-based passwords are available offline and provide user-friendly, increased account security when used as a second factor.

## How to use the Casdoor Authenticator App?

### Step 0: Install the Casdoor Authenticator App

The Casdoor Authenticator App is currently available for Android devices. You can download the app from the following sources:

1. Official GitHub Releases: [Casdoor Authenticator App Latest Release](https://github.com/casdoor/casdoor-app/releases/latest)
2. Source Code: [Casdoor Authenticator App GitHub Repository](https://github.com/casdoor/casdoor-app)

For developers interested in building the app from source, you can find the source code and build instructions in the [Casdoor App GitHub Repository](https://github.com/casdoor/casdoor-app#building-from-source).

### Step 1: Enable Totp Account storage in Casdoor Server (Optional)

This setup is optional for users who want to store their TOTP codes in the Casdoor server. Before using the Casdoor Authenticator App, you need to make sure that the MFA accounts setting is enabled in the Casdoor server.

![Mfa account setting](/img/casdoor-authenticator-app/mfa-account-setting.png)

### Step 2: Log in to the Casdoor Authenticator App

After installing the Casdoor Authenticator App and enabling the MFA accounts setting in the Casdoor server, you can log in to the app using your Casdoor account credentials. The app will prompt you to enter your server URL, client ID, and organization name to authenticate your account.

![Login](/img/casdoor-authenticator-app/login.png)

Now, you can view your TOTP codes and manage your 2FA settings directly from the Casdoor Authenticator App like other authenticator apps.

## Migration from Google Authenticator

If you are currently using Google Authenticator for your TOTP codes, you can easily migrate your TOTP data to the Casdoor Authenticator App. To do this, follow these steps:

### Step 1: Export TOTP data from Google Authenticator

Select the "Transfer Accounts" option in the menu of Google Authenticator and choose the accounts you want to transfer. Then, click the "Export" button to generate a QR code.

![Export TOTP data](/img/casdoor-authenticator-app/google-export.png)

### Step 2: Import TOTP data to the Casdoor Authenticator App

In the Casdoor Authenticator App, scan the QR code generated by Google Authenticator to import your TOTP data. The app will automatically add the accounts to your Casdoor Authenticator App, allowing you to manage your TOTP codes securely.

![Import TOTP data](/img/casdoor-authenticator-app/import-totp.gif)
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ module.exports = {
},
"how-to-connect/face-id",
"how-to-connect/webauthn",
"how-to-connect/casdoor-authenticator-app",
],
},
{
Expand Down
Binary file added static/img/casdoor-authenticator-app/android.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 static/img/casdoor-authenticator-app/ios.png
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 static/img/casdoor-authenticator-app/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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a9329b2

Please sign in to comment.