Skip to content

Conversation

@autonome
Copy link
Contributor

@autonome autonome commented Aug 12, 2024

  • moved files
  • removed draft date
  • determined name
  • added description (triangulated from mdn, spec, caniuse)
  • added entry point
  • verified baselines
  • added to a group, or not (see below)
  • determined whether the feature should be split up or not
  • looked for other related draft features that could be included
  • am i missing anything else?

Name

Sheesh:

  • Spec: Web Cryptography API
  • MDN: Web Crypto API
  • CIU: Web Cryptography
  • Node: Web Crypto API
  • W3C GH: /webcrypto
  • Blink: WebCrypto
  • Developer: no consistent pattern that i could find

Thoughts:

  • I posit "crypto" will confuse people and also make cryptographers mad
  • There's a precedent for "Web {x}" in WF already
  • There's very little "API" suffix in WF so far, even when specs have it, but some (not nearly all) folks do seem to refer to it that way

Proposal for WF: Web Cryptography

We can use "crypto" as shorthand in URLs and file paths, but should expand to the full name in any other context.

I'd be ok with popping "API" on there if people think it's needed. Not adding it keeps options open for future.

Edit: Updated to use Web Cryptography

Description

The description feels a bit short, and I like "operations" as Caniuse went with, vs "systems" from MDN which sounds heavyweight. I tried to balance it with the "utilities" bit since there are standalone functions. Thoughts, preferences from anyone?

Edit: Updated to use "cryptographic operations" instead of "systems".

Group

This feels like it could be its own group, as there's no other group it aligns with, and also it's a general feature area along a specific theme. Could name it Web Crypto API per how developers refer to it, or Cryptography for a more general bucket for potential future features to be added to which may not be in the same API namespace.

Edit: Leaving group out for now, we can always come back to it

Splits/Merges

Discussed w/ @ddbeck and deleted webcrypto-secure-curves files and merged into here, as they're considered by developers as part of the Web Cryptography feature, not something separate and standalone.

@github-actions github-actions bot added the feature definition Creating or defining new features or groups of features. label Aug 12, 2024
@autonome
Copy link
Contributor Author

Hmm, secure curves needs to be in here too.

@autonome autonome marked this pull request as draft August 12, 2024 16:38
@autonome
Copy link
Contributor Author

@ddbeck I'm going to merge https://github.com/web-platform-dx/web-features/blob/main/features/draft/spec/webcrypto-secure-curves.yml into the general webcrypto api feature.

Even if new curves are added (likely), they're more like flavors of the same basic APIs, not new APIs in and of themselves. wdyt?

@ddbeck
Copy link
Collaborator

ddbeck commented Aug 13, 2024

@ddbeck I'm going to merge https://github.com/web-platform-dx/web-features/blob/main/features/draft/spec/webcrypto-secure-curves.yml into the general webcrypto api feature.

Even if new curves are added (likely), they're more like flavors of the same basic APIs, not new APIs in and of themselves. wdyt?

Reproducing my answer from chat:

Yes, that seems like a reasonable thing to do.

When I encounter something like this, I search Wikipedia, web, Stack Overflow, and caniuse (unchecking the MDN box) for the spec language ("secure curves") and the narrowest names in the list of compat keys ("ed25519" here, though adding "javascript" is needed some places like Stack Overflow). If I can't find evidence that it's a distinct thing that people are writing and asking about, then I look to see what predecessor feature it might be part of.

So for this feature that approach checks out: Web Crypto is the feature that developers care about but it has some smaller bits tacked on that developers don't recognize as a distinct "thing" (we've been calling these "later additions").

@autonome autonome marked this pull request as ready for review August 13, 2024 17:22
@autonome autonome requested a review from ddbeck August 22, 2024 12:43
@ddbeck ddbeck enabled auto-merge (squash) August 22, 2024 12:59
@ddbeck ddbeck merged commit 0d53670 into web-platform-dx:main Aug 22, 2024
@autonome autonome deleted the webcrypto branch August 28, 2024 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature definition Creating or defining new features or groups of features.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants