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.

Sign up for GitHub

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

Jump to bottom

Add a guide page on credential types #33745

Merged
merged 19 commits into from
Jun 4, 2024
Merged

Add a guide page on credential types #33745

merged 19 commits into from
Jun 4, 2024

Conversation

wbamberg
Copy link
Collaborator

@wbamberg wbamberg commented May 24, 2024 •
edited
Loading

This PR adds a new page that's an overview guide to the different credential types supported in the Credential Management API.

@hamishwillee , @chrisdavidmills , perhaps you are interested in looking at it?

@github-actions github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels May 24, 2024
@wbamberg
Credential types guide page
7d146fe
@wbamberg
Merge remote-tracking branch 'upstream/main' into add-credential-types
76b6267 
* upstream/main: (55 commits)
  Replace `.` with `#` in example given selectors are `#ids` (mdn#33791)
  update info in cross browser testing strategies (mdn#33730)
  Clarify that `navigator.storage.persist()` depends on heuristics (mdn#33780)
  fix typo (mdn#33785)
  feat: improvements on Glossary/Hoisting (mdn#33787)
  CSS update: overview of shapes guide (mdn#33771)
  CSS update: Shapes from box values (mdn#33770)
  Fix issue 033506: correct droppedEntriesCount (mdn#33538)
  Revert "=== Symbol("foo")" (mdn#33782)
  docs(css): FF126 - Support for `shape()` function (mdn#33446)
  Bump lint-staged from 15.2.4 to 15.2.5 (mdn#33777)
  Bump ajv from 8.13.0 to 8.14.0 (mdn#33776)
  Add missing spaces for `subtlecrypto` (mdn#33774)
  fix: typo in `color_and_luminca` (mdn#33775)
  feat: improvments on gutters (mdn#33751)
  FF127Relnote- data: and javascript: URLS forbidden in base HREF (mdn#33738)
  update the content of SVG `<view>` element (mdn#33710)
  Clipboard.write() - log and fixes (mdn#33769)
  updated ClipboardItem and Clipboard documentation and examples using … (mdn#33262)
  Fix error in the code snippet for Symbol (mdn#33765)
  ...
@wbamberg wbamberg changed the title Add a draft section on credential types Add a guide page on credential types May 28, 2024
@wbamberg wbamberg marked this pull request as ready for review May 28, 2024 17:15
@wbamberg wbamberg requested review from a team as code owners May 28, 2024 17:15
@wbamberg wbamberg requested review from Elchi3 and dipikabh and removed request for a team May 28, 2024 17:15
@wbamberg wbamberg requested review from chrisdavidmills and hamishwillee and removed request for Elchi3 and dipikabh May 29, 2024 15:59
chrisdavidmills
chrisdavidmills requested changes May 30, 2024
View reviewed changes
Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wbamberg nice work! I've had a look at it, and provided mostly text comments. The explanations of the APIs are nicely written, and mostly make sense.

files/en-us/web/api/credential_management_api/credential_types/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credential_management_api/credential_types/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credential_management_api/credential_types/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credential_management_api/credential_types/index.md

> **Note:** Most browsers do not support this credential type and it is not widely used on the web. Instead, browsers automatically offer to store passwords in the password manager, and can automatically retrieve stored passwords to autofill [password input elements](/en-US/docs/Web/HTML/Element/input/password).

Modern browsers provide users with a password manager, which enables users to store the passwords they enter on websites, and later retrieve them when they need to log in again. Password managers can help with password security by remembering passwords for users and autofilling them, which allows users to choose stronger passwords.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and also not create security risks by writing them down?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's overall better practice to have strong unique passwords and write them down somewhere than to have simple enough passwords that they can be remembered: https://www.schneier.com/blog/archives/2005/06/write_down_your.html.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this, but even so, it is better for security to not have to write them down at all, regardless of how strong or weak they are.

That said, I will leave it up to you whether you add it. I don't think it is that important to the narrative that I'm going to die on this hill ;-)

files/en-us/web/api/credential_management_api/credential_types/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credential_management_api/credential_types/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credential_management_api/credential_types/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credential_management_api/credential_types/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credential_management_api/credential_types/index.md Show resolved Hide resolved
files/en-us/web/api/credential_management_api/index.md Outdated Show resolved Hide resolved
hamishwillee
hamishwillee reviewed May 31, 2024
View reviewed changes
files/en-us/web/api/credential_management_api/credential_types/index.md

## Passwords

> **Note:** Most browsers do not support this credential type and it is not widely used on the web. Instead, browsers automatically offer to store passwords in a password manager, and can automatically retrieve stored passwords to autofill [password input elements](/en-US/docs/Web/HTML/Element/input/password).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So just to be clear the browser automatically stores credential types when needed/requested, and autofills forms or whatever, while the credential API just stores and gets credentials, but all the work for doing this and for populating forms has to be done by the developer?

If so, I wonder why any browser/site has implemented this.

Perhaps make first automatically italic.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well I'm not sure, I only learned last week or so that this API isn't really used, because neither MDN nor web.dev say anything about that. One thing you can do with CM, that the browser won't do for you, is sign people in automatically. I suppose in general gives you much more control over how sign-in happens.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As it is now the whole rationale is a bit wishy washy, but I'd say this is more than good enough for the current PR. We can find out more in a follow on.

@hamishwillee
Copy link
Collaborator

Love it. Just a few suggestions.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 3, 2024 •
edited
Loading

Preview URLs

External URLs (7)

URL: /en-US/docs/Web/API/Credential_Management_API/Credential_types
Title: Credential types

(comment last updated: 2024-06-03 18:17:41)

wbamberg and others added 7 commits June 3, 2024 10:45
@wbamberg @hamishwillee
Update files/en-us/web/api/credential_management_api/credential_types…
e184d98 
…/index.md

Co-authored-by: Hamish Willee <[email protected]>
@wbamberg
Update credental types diagram to emphasise that FederatedCredential …
bf06e0b 
…is deprecated
@wbamberg @hamishwillee
Update files/en-us/web/api/credential_management_api/credential_types…
b383ff1 
…/index.md

Co-authored-by: Hamish Willee <[email protected]>
@wbamberg @hamishwillee
Update files/en-us/web/api/credential_management_api/credential_types…
1d6a31f 
…/index.md

Co-authored-by: Hamish Willee <[email protected]>
@wbamberg @hamishwillee
Update files/en-us/web/api/credential_management_api/credential_types…
bf6d9bc 
…/index.md

Co-authored-by: Hamish Willee <[email protected]>
@wbamberg
Move paragraph about deprecated FederatedIdentity credential
b25f13d
@wbamberg @hamishwillee
Update files/en-us/web/api/credential_management_api/index.md
2f2540a 
Co-authored-by: Hamish Willee <[email protected]>
@wbamberg
Copy link
Collaborator Author

wbamberg commented Jun 3, 2024

OK, I think I'm done with updates to this PR, please take another look :).

hamishwillee
hamishwillee approved these changes Jun 3, 2024
View reviewed changes
Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am very happy with the fixes and whole doc.

I would merge, but not sure if @chrisdavidmills has had his final look.

chrisdavidmills
chrisdavidmills approved these changes Jun 4, 2024
View reviewed changes
Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent, lovely work, @wbamberg!

Let's dooooo it!

@chrisdavidmills chrisdavidmills merged commit b22d69d into mdn:main Jun 4, 2024
9 checks passed
@wbamberg
Copy link
Collaborator Author

wbamberg commented Jun 4, 2024

🎉 thank you both!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions GitHub Actions github-actions left review comments

@chrisdavidmills chrisdavidmills chrisdavidmills approved these changes

@hamishwillee hamishwillee hamishwillee approved these changes

Assignees
No one assigned
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@wbamberg @hamishwillee @chrisdavidmills