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

Rename flag to --oidc-pkce-method and improve docs #1240

Merged
merged 5 commits into from
Jan 14, 2025

Conversation

int128
Copy link
Owner

@int128 int128 commented Jan 13, 2025

Resolves #1227.
Resolves #858.

Changes

Flags

This changes the flag --oidc-use-pkce to --oidc-pkce-method. It does not change the default behavior.

  • Before
    • PKCE is automatically used if the provider supports it.
    • --oidc-use-pkce forces to use PKCE.
  • After
    • PKCE is automatically used if the provider supports it.
    • --oidc-use-pkce is deprecated. Equivalent to --oidc-pkce-method=S256.
    • --oidc-pkce-method is added. It forces to use PKCE. Default to --oidc-pkce-method=auto.

Docs

This also improves the docs:

  • Remove the client secret from README
  • Add PKCE section to usage

@int128 int128 changed the title Add --oidc-pkce-method and improve docs Rename flag to --oidc-pkce-method and improve docs Jan 14, 2025
@int128 int128 changed the title Rename flag to --oidc-pkce-method and improve docs Rename flag to --oidc-pkce-method and improve docs Jan 14, 2025
@int128 int128 marked this pull request as ready for review January 14, 2025 00:51
@int128 int128 merged commit aa1f445 into master Jan 14, 2025
17 checks passed
@int128 int128 deleted the int128/Add---oidc-pkce-method-and-improve-docs branch January 14, 2025 00:57
@gaeljw
Copy link

gaeljw commented Jan 14, 2025

Thanks @int128 , really appreciate the clarifications 👍

@3deep5me
Copy link

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recommend usage of PKCE in the README Flag to force PKCE
3 participants