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

Add doc reference for client_auth_method #70124

Merged
merged 4 commits into from
Mar 10, 2021

Conversation

jkakavas
Copy link
Member

@jkakavas jkakavas commented Mar 9, 2021

Support for additional Client authentication methods was added in
the OIDC realm in #58708. This change adds the rp.client_auth_method
in the realm settings reference doc.

Support for additional Client authentication methods was added in
the OIDC realm in elastic#58708. This change adds the `rp.client_auth_method`
in the realm settings reference doc.
@jkakavas jkakavas added >docs General docs changes :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) v8.0.0 v7.10.3 v7.12.1 v7.11.3 labels Mar 9, 2021
@jkakavas jkakavas requested a review from ywangd March 9, 2021 06:50
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Security Meta label for security team labels Mar 9, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

Copy link
Member

@ywangd ywangd left a comment

Choose a reason for hiding this comment

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

Should we also document rp.client_auth_jwt_signature_algorithm while we are here?

Copy link
Member

@ywangd ywangd left a comment

Choose a reason for hiding this comment

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

LGTM

docs/reference/settings/security-settings.asciidoc Outdated Show resolved Hide resolved
// tag::rp-client-auth-method-tag[]
`rp.client_auth_method` {ess-icon}::
(<<static-cluster-setting, Static>>)
The Client authentication method used by elasticsearch as a client to authenticate
Copy link
Contributor

Choose a reason for hiding this comment

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

Feels one of the two occurrences of "client" is redundant:

Suggested change
The Client authentication method used by elasticsearch as a client to authenticate
The authentication method used by {es} as a client to authenticate

Copy link
Member Author

@jkakavas jkakavas Mar 10, 2021

Choose a reason for hiding this comment

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

I'll change the {es} thanks ! but it's called "Client authentication" in OpenID Connect , so I will leave this here ( not capitalized)

`rp.client_auth_signature_algorithm` {ess-icon}::
(<<static-cluster-setting, Static>>)
The signature algorithm that {es} uses to sign the JWT with which it authenticates
as a Client to the OpenID Connect Provider when `client_secret_jwt` is selected for
Copy link
Contributor

Choose a reason for hiding this comment

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

Unless this is a specific client that is always capitalized, I think it should be lowercase:

Suggested change
as a Client to the OpenID Connect Provider when `client_secret_jwt` is selected for
as a client to the OpenID Connect Provider when `client_secret_jwt` is selected for

@jkakavas jkakavas merged commit 2b48bd7 into elastic:master Mar 10, 2021
jkakavas added a commit to jkakavas/elasticsearch that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in elastic#58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
jkakavas added a commit to jkakavas/elasticsearch that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in elastic#58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
jkakavas added a commit to jkakavas/elasticsearch that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in elastic#58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
jkakavas added a commit to jkakavas/elasticsearch that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in elastic#58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
jkakavas added a commit that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in #58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
jkakavas added a commit that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in #58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
jkakavas added a commit that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in #58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
jkakavas added a commit that referenced this pull request Mar 10, 2021
Support for additional Client authentication methods was added in
the OIDC realm in #58708. This change adds the `rp.client_auth_method`
and `rp.client_auth_signature_algorithm` settings in the realm settings 
reference doc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) Team:Docs Meta label for docs team Team:Security Meta label for security team v7.10.3 v7.11.3 v7.12.1 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants