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.

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

Fix authorization token Bearer prefix spelling in examples #372

Merged
merged 1 commit into from
Oct 23, 2024

Conversation

srosenda
Copy link
Contributor

@srosenda srosenda commented Aug 6, 2024

the prefix should be spelled exactly as "Bearer", see RFC 6750, section 2.1. Authorization Request Header Field https://datatracker.ietf.org/doc/html/rfc6750#section-2.1.

Fixes #371.

@bc-pi
Copy link
Member

bc-pi commented Aug 6, 2024

@srosenda
Copy link
Contributor Author

srosenda commented Aug 7, 2024

According to RFC9110 the authentication scheme is indeed case-insensitive contrary to how it is defined in RFC6750, so this issue can be closed. Would it still be good to unify the scheme spelling in the examples?

Edit: additionally I did not know that ABNF literal text strings are case-insensitive: https://www.rfc-editor.org/rfc/rfc5234#page-5. Hence the "Bearer" in RFC6750 can be spelled "BEARER" or "BeArEr", etc.

@Sakurann
Copy link
Collaborator

Sakurann commented Aug 9, 2024

@srosenda thanks a lot for doing the PR! Do you have contribution agreement/IPR signed with OIDF DCP WG?

@srosenda
Copy link
Contributor Author

srosenda commented Aug 9, 2024

@srosenda thanks a lot for doing the PR! Do you have contribution agreement/IPR signed with OIDF DCP WG?

@Sakurann Thanks! I have not signed the contribution agreement. I am checking how to proceed on the matter.

@Sakurann
Copy link
Collaborator

@srosenda you can always sign an individual contribution agreement. that would unblock us in a minute.

@srosenda srosenda force-pushed the fix/authorization-bearer-spelling branch from 17a29ab to e0cde14 Compare September 18, 2024 07:19
@srosenda
Copy link
Contributor Author

Rebased with main and amended the commit to unify the spelling also in the Token Response's toke_type parameter. Rewrote the commit message to state that this is not a correction, but an unification aimed to increase clarity.

@srosenda
Copy link
Contributor Author

@srosenda you can always sign an individual contribution agreement. that would unblock us in a minute.

@Sakurann finally I should be covered by a contribution agreement signed by Digital and Population Data Services Agency Finland. Sorry for the delay.

Although the authorization scheme is case-insensitive, all the examples
in the referred specifications RFC 6749 (and RFC 6750 referred by it)
use the spelling "Bearer", which is also the spelling in the IANA HTTP
Authentication Scheme Registry. Unified spelling reduces confusion and
possible mistakes in implementations that have missed the case-
insensitivity of the authentication scheme.
@srosenda srosenda force-pushed the fix/authorization-bearer-spelling branch from e0cde14 to 03d4204 Compare September 18, 2024 12:34
@srosenda
Copy link
Contributor Author

Fixed terminology to refer to authorization scheme in the commit message and signed the commit.

Copy link
Member

@bc-pi bc-pi left a comment

Choose a reason for hiding this comment

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

Best I remember the use of "BEARER" was intentional to demonstrate to readers exactly the point that authentication scheme names are case-insensitive but maybe I'm not remembering correctly and maybe no one cares anymore or ever.

@jogu jogu added the editorial Things that are not normative changes label Oct 23, 2024
@jogu
Copy link
Contributor

jogu commented Oct 23, 2024

Editorial, 4 approvals, open a while - merging! Thanks @srosenda !

@jogu jogu merged commit 1d544da into openid:main Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Things that are not normative changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Authorization token prefix "Bearer" is misspelled in some examples
5 participants