Nemcio/Gitea
1
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2025-12-22 16:30:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Mention X-Gitea-OTP on MFA docs page

Browse Source
This commit is contained in:
James Lakin
2021-02-04 22:17:18 +00:00
parent 7f831718e9
commit 39a19ffb48
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/content/doc/usage/multi-factor-authentication.en-us.md
View File

@@ -21,14 +21,15 @@ Gitea supports both TOTP (Time-based One-Time Password) tokens and FIDO-based ha
MFA can be configured within the "Security" tab of the user settings page. MFA can be configured within the "Security" tab of the user settings page.
## Using MFA ## MFA Considerations
Enabling MFA on a user does affect how the Git HTTP protocol and the Gitea API can be used. Enabling MFA on a user does affect how the Git HTTP protocol can be used with the Git CLI.
These interfaces do not support MFA, and trying to use a password normally will no longer be possible whilst MFA is enabled. This interface does not support MFA, and trying to use a password normally will no longer be possible whilst MFA is enabled.
However, an access token can be generated within the "Applications" tab of the user settings page. If SSH is not an option for Git operations, an access token can be generated within the "Applications" tab of the user settings page.
This access token can be used as if it were a password in order to use these interfaces. This access token can be used as if it were a password in order to allow the Git CLI to function over HTTP.
> **Warning** - By its very nature, an access token sidesteps the security benefits of MFA. > **Warning** - By its very nature, an access token sidesteps the security benefits of MFA.
> It must be kept secure and should only be used as a last resort. > It must be kept secure and should only be used as a last resort.
Using Git over SSH is separate to the normal authentication process and will still function normally. The Gitea API supports providing the relevant TOTP password in the `X-Gitea-OTP` header, as described in [API Usage](https://docs.gitea.io/en-us/api-usage).
This should be used instead of an access token where possible.