Two-factor authentication #1210

Kakulukian · 2024-02-05T11:42:50Z

No description provided.

HuggingFaceDocBuilderDev · 2024-02-05T11:48:27Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

julien-c · 2024-02-05T18:02:31Z

docs/hub/_toctree.yml

@@ -280,6 +280,8 @@
    sections:
    - local: security-tokens
      title: User Access Tokens
+    - local: security-two-factor-authentication


Suggested change

- local: security-two-factor-authentication

- local: security-mfa

shorter?

docs/hub/_toctree.yml

julien-c · 2024-02-05T18:06:15Z

docs/hub/security-two-factor-authentication.md

+In case you've forgotten your password and lost access to your two-factor authentication credentials, you can reach out to support (website@huggingface.co) to regain access to your account. You'll be required to verify your identity using a recovery authentication factor, such as an SSH key.
+
+To complete your recovery request, you'll need to confirm an alternative authentication factor. Choose a recovery verification method:
+- If you've previously established an SSH key on this account, provide your public SSH key


note that there was an open issue (by @severo i think) to expose any user's SSH public keys

So in that case anyone would have this

https://github.com/huggingface/moon-landing/issues/8160

I would just keep the very first line of this section for now I think :)

julien-c · 2024-02-05T18:07:16Z

docs/hub/security-two-factor-authentication.md

@@ -0,0 +1,99 @@
+# Two-Factor Authentication
+
+Implementing two-factor authentication is a method of verifying a user's identity by using two separate authentication methods. This extra layer of security ensures that only authorized individuals can access an account, even if the password has been compromised.


this sounds a bit complex/verbose, let's simplify it?

Suggested change

Implementing two-factor authentication is a method of verifying a user's identity by using two separate authentication methods. This extra layer of security ensures that only authorized individuals can access an account, even if the password has been compromised.

Adding an additional authentication factor ensures that only authorized individuals can access your account, even if the password has been compromised.

?

or even ... only you can access your account, even if your password has been compromised

Pierrci

Thanks @Kakulukian!! 🙏

Pierrci · 2024-02-05T20:59:38Z

docs/hub/security-two-factor-authentication.md

@@ -0,0 +1,99 @@
+# Two-Factor Authentication
+
+Implementing two-factor authentication is a method of verifying a user's identity by using two separate authentication methods. This extra layer of security ensures that only authorized individuals can access an account, even if the password has been compromised.


Suggested change

Implementing two-factor authentication is a method of verifying a user's identity by using two separate authentication methods. This extra layer of security ensures that only authorized individuals can access an account, even if the password has been compromised.

Adding an additional authentication factor ensures that only authorized individuals can access your account, even if the password has been compromised.

?

docs/hub/security-two-factor-authentication.md

Pierrci · 2024-02-05T21:16:48Z

docs/hub/security-two-factor-authentication.md

+In case you've forgotten your password and lost access to your two-factor authentication credentials, you can reach out to support (website@huggingface.co) to regain access to your account. You'll be required to verify your identity using a recovery authentication factor, such as an SSH key.
+
+To complete your recovery request, you'll need to confirm an alternative authentication factor. Choose a recovery verification method:
+- If you've previously established an SSH key on this account, provide your public SSH key


I would just keep the very first line of this section for now I think :)

Co-authored-by: Pierric Cistac <Pierrci@users.noreply.github.com>

pcuenca · 2024-02-06T09:52:24Z

docs/hub/security-two-factor-authentication.md

@@ -0,0 +1,99 @@
+# Two-Factor Authentication
+
+Implementing two-factor authentication is a method of verifying a user's identity by using two separate authentication methods. This extra layer of security ensures that only authorized individuals can access an account, even if the password has been compromised.


or even ... only you can access your account, even if your password has been compromised

pcuenca · 2024-02-06T09:54:22Z

docs/hub/security-two-factor-authentication.md

+To enable Two-factor Authentication with a one-time password:
+
+In the Hugging Face Hub:
+1. Go to your [Authentication settings](https://hf.co/settings/authentication)


not live yet, is it?

no, but soon

docs/hub/security-two-factor-authentication.md

Co-authored-by: Pedro Cuenca <pedro@huggingface.co>

This reverts commit dc2ff8d.

Pierrci

Last two nits, LGTM, thanks so much @Kakulukian!

docs/hub/security-two-fa.md

docs/hub/_toctree.yml

Co-authored-by: Pierric Cistac <Pierrci@users.noreply.github.com>

SBrandeis

lol you merge too fast

Mostly wording nits

SBrandeis · 2024-02-07T10:08:59Z

docs/hub/security-two-fa.md

+If you choose to enable two-factor authentication, at every login you will need to provide:
+- Username or email & password (normal login credentials)
+- One-time security code via app


(maybe)

Suggested change

If you choose to enable two-factor authentication, at every login you will need to provide:

- Username or email & password (normal login credentials)

- One-time security code via app

If you choose to enable two-factor authentication, at every login you will need to provide:

- Your username & password (the usual login credentials)

- A one-time security code generated with an app

SBrandeis · 2024-02-07T10:09:47Z

docs/hub/security-two-fa.md

+
+To enable Two-factor Authentication with a one-time password:
+
+In the Hugging Face Hub:


No need to precise IMO (we're already in the Hub documentation)

Suggested change

In the Hugging Face Hub:

SBrandeis · 2024-02-07T10:11:29Z

docs/hub/security-two-fa.md

+2. In the application, add a new entry in one of two ways:
+    - Scan the code displayed on screen Hub with your device’s camera to add the entry automatically
+    - Enter the details provided to add the entry manually


Suggested change

2. In the application, add a new entry in one of two ways:

- Scan the code displayed on screen Hub with your device’s camera to add the entry automatically

- Enter the details provided to add the entry manually

2. In the application, add a new entry in one of two ways:

- Scan the QR code displayed on screen with your device’s camera

- Enter the details provided to add the entry manually

SBrandeis · 2024-02-07T10:12:11Z

docs/hub/security-two-fa.md

+    - Scan the code displayed on screen Hub with your device’s camera to add the entry automatically
+    - Enter the details provided to add the entry manually
+
+In Hugging Face Hub:


Suggested change

In Hugging Face Hub:

To finalize the setup, on the Hugging Face Hub:

SBrandeis · 2024-02-07T10:12:25Z

docs/hub/security-two-fa.md

+
+In Hugging Face Hub:
+1. Enter the six-digit pin number from your authentication device into "Code"
+2. Save


Suggested change

2. Save

2. Click the save button

SBrandeis · 2024-02-07T10:13:49Z

docs/hub/security-two-fa.md

+    <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/two-fa/settings-dark.png" />
+</div>
+
+If you entered the correct pin, the Hub displays a list of recovery codes. Download them and keep them in a safe place.


Suggested change

If you entered the correct pin, the Hub displays a list of recovery codes. Download them and keep them in a safe place.

If you entered the correct pin, the Hub displays a list of recovery codes. Make sure you keep them in a safe place: they allow recovering access to your account if you ever lose access to the 2FA device.

SBrandeis · 2024-02-07T10:14:17Z

docs/hub/security-two-fa.md

+
+## Recovery codes
+
+Right after you've successfully activated 2FA with a one-time password, you're requested to download a collection of generated recovery codes. If you ever lose access to your one-time password authenticator, you can use one of these recovery codes to log in to your account.


Suggested change

Right after you've successfully activated 2FA with a one-time password, you're requested to download a collection of generated recovery codes. If you ever lose access to your one-time password authenticator, you can use one of these recovery codes to log in to your account.

Right after you've successfully activated 2FA with a one-time password, you're requested to download a collection of generated recovery codes. If you ever lose access to your one-time password authenticator device, you can use one of these recovery codes to log in to your account.

SBrandeis · 2024-02-07T10:15:49Z

docs/hub/security-two-fa.md

+3. Click on Regenerate recovery codes
+
+<Tip warning={true}>
+If you regenerate 2FA recovery codes, save them. You can’t use any previously created recovery codes.


Suggested change

If you regenerate 2FA recovery codes, save them. You can’t use any previously created recovery codes.

Regenerating 2FA recovery codes invalidates the previous ones, meaning you will not be able to use them anymore. We recommend you save the newly generated codes somewhere safe.

SBrandeis · 2024-02-07T10:16:40Z

docs/hub/security-two-fa.md

+1. Access your [Authentication settings](https://hf.co/settings/authentication)
+2. Click on "Remove".
+
+This clears all your 2FA registrations.


Not super clear IMO

Kakulukian added 2 commits February 5, 2024 12:40

Two-factor doc

d89e87b

add to toctree

ca621bd

some reformatting

aa15071

julien-c reviewed Feb 5, 2024

View reviewed changes

Pierrci reviewed Feb 5, 2024

View reviewed changes

Kakulukian and others added 3 commits February 6, 2024 10:47

Apply suggestions from code review

8a189f1

Co-authored-by: Pierric Cistac <Pierrci@users.noreply.github.com>

Remove support line, rename file

2ba9cc1

simplify intro

89f160a

pcuenca reviewed Feb 6, 2024

View reviewed changes

Kakulukian and others added 2 commits February 6, 2024 12:30

Suggestions

923a427

Co-authored-by: Pedro Cuenca <pedro@huggingface.co>

add images

715ad1c

Kakulukian marked this pull request as ready for review February 6, 2024 13:17

Kakulukian added 2 commits February 6, 2024 16:56

2fa -> mfa

dc2ff8d

Revert "2fa -> mfa"

d1fe21a

This reverts commit dc2ff8d.

Pierrci approved these changes Feb 6, 2024

View reviewed changes

docs/hub/security-two-fa.md Outdated Show resolved Hide resolved

docs/hub/_toctree.yml Show resolved Hide resolved

Kakulukian and others added 2 commits February 7, 2024 11:09

Update docs/hub/security-two-fa.md

3478762

Co-authored-by: Pierric Cistac <Pierrci@users.noreply.github.com>

add link to subpage

743973f

Kakulukian merged commit c57c1b7 into main Feb 7, 2024

Kakulukian deleted the two-factor-auth-docs branch February 7, 2024 10:17

SBrandeis reviewed Feb 7, 2024

View reviewed changes

	- local: security-two-factor-authentication
	- local: security-mfa

		@@ -0,0 +1,99 @@
		# Two-Factor Authentication

		Implementing two-factor authentication is a method of verifying a user's identity by using two separate authentication methods. This extra layer of security ensures that only authorized individuals can access an account, even if the password has been compromised.

	Implementing two-factor authentication is a method of verifying a user's identity by using two separate authentication methods. This extra layer of security ensures that only authorized individuals can access an account, even if the password has been compromised.
	Adding an additional authentication factor ensures that only authorized individuals can access your account, even if the password has been compromised.


		To enable Two-factor Authentication with a one-time password:

		In the Hugging Face Hub:

	In Hugging Face Hub:
	To finalize the setup, on the Hugging Face Hub:

	If you entered the correct pin, the Hub displays a list of recovery codes. Download them and keep them in a safe place.
	If you entered the correct pin, the Hub displays a list of recovery codes. Make sure you keep them in a safe place: they allow recovering access to your account if you ever lose access to the 2FA device.


		## Recovery codes

		Right after you've successfully activated 2FA with a one-time password, you're requested to download a collection of generated recovery codes. If you ever lose access to your one-time password authenticator, you can use one of these recovery codes to log in to your account.

	If you regenerate 2FA recovery codes, save them. You can’t use any previously created recovery codes.
	Regenerating 2FA recovery codes invalidates the previous ones, meaning you will not be able to use them anymore. We recommend you save the newly generated codes somewhere safe.

Two-factor authentication #1210

Two-factor authentication #1210

Uh oh!

Conversation

Kakulukian commented Feb 5, 2024

Uh oh!

HuggingFaceDocBuilderDev commented Feb 5, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pierrci left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Pierrci left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

SBrandeis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!