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

[DOCS] Removes redundant LDAP realm settings #30193

Merged
merged 3 commits into from
Apr 30, 2018

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 26, 2018

This PR removes the redundant information about LDAP realm settings from
https://www.elastic.co/guide/en/elastic-stack-overview/master/ldap-realm.html
after integrating the missing information in
https://www.elastic.co/guide/en/elasticsearch/reference/master/security-settings.html#ref-ldap-settings

@lcawl lcawl added >docs General docs changes v7.0.0 v6.3.0 :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) v6.4.0 labels Apr 26, 2018
@lcawl lcawl requested a review from jaymode April 26, 2018 23:14
@lcawl lcawl changed the title Lcawley ldaprealmsettings [DOCS] Removes redundant LDAP realm settings Apr 26, 2018
Copy link
Member

@jaymode jaymode left a comment

Choose a reason for hiding this comment

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

I left a couple of suggestions, other than those LGTM

This setting is deprecated; use `user_search.filter` instead.
The attribute to match with the username presented to. Defaults to `uid`.
deprecated[5.6] Use `user_search.filter` instead.
The attribute to match with the username presented to.
Copy link
Member

Choose a reason for hiding this comment

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

good catch. Maybe The attribute to match with the username sent with the request or username provided for authentication

@@ -265,30 +284,32 @@ Specifies whether the group search should be `sub_tree`, `one_level` or
`base` specifies that the `base_dn` is a group object, and that it is the
only group considered. Defaults to `sub_tree`.

`group_search.filter`::
`group_search.filter`:: Specifies a filter to use to look up a group.
Copy link
Member

Choose a reason for hiding this comment

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

should this be on a new line?

When not set, the realm searches for `group`, `groupOfNames`, `groupOfUniqueNames`,
or `posixGroup` with the attributes `member`, `memberOf`, or `memberUid`. Any
instance of `{0}` in the filter is replaced by the user attribute defined in
`group_search.user_attribute`.

`group_search.user_attribute`::
Specifies the user attribute that will be fetched and provided as a parameter to
Specifies the user attribute is fetched and provided as a parameter to
Copy link
Member

Choose a reason for hiding this comment

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

maybe that is?

Specifies the time-to-live for cached user entries (a user and its credentials
are cached for this period of time). Use the standard Elasticsearch
{ref}/common-options.html#time-units[time units]). Defaults to `20m`.
Specifies the time-to-live for cached user entries. A user and its credentials
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should say a hash of its credentials to more accurately represent what is being cached

@lcawl lcawl force-pushed the lcawley-ldaprealmsettings branch from 35b8081 to 164f1e5 Compare April 27, 2018 21:09
@lcawl
Copy link
Contributor Author

lcawl commented Apr 27, 2018

Thanks, @jaymode I've implemented those changes.

@hub-cap hub-cap added :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) and removed :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) labels Apr 27, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security

@lcawl lcawl merged commit 05160e6 into elastic:master Apr 30, 2018
@lcawl lcawl deleted the lcawley-ldaprealmsettings branch April 30, 2018 15:04
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request May 1, 2018
* origin/master:
  [test] add java packaging test project (elastic#30161)
  Fix macros in changelog (elastic#30269)
  [DOCS] Fixes syskeygen command name
  [ML] Include 3rd party C++ component notices (elastic#30132)
  _cluster/state Skip Test for pre-6.4, not pre-7.0 (elastic#30264)
  Improve docs for disk watermarks (elastic#30249)
  [DOCS] Removes redundant Active Directory realm settings (elastic#30190)
  [DOCS] Removes redundant LDAP realm settings (elastic#30193)
  _cluster/state should always return cluster_uuid (elastic#30143)
  HTML5ify Javadoc for core and test framework (elastic#30234)
  Minor tweaks to reroute documentation (elastic#30246)
@jimczi jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019
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) v6.3.0 v6.4.0 v7.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants