You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`url` - LDAP server URL, eg. *ldaps://ldap.example.org:636*, or a list of URLs, e.g. `["ldaps://ldap.example.org:636"]`
41
+
-`url` - LDAP server URL, eg. _ldaps://ldap.example.org:636_, or a list of URLs, e.g. `["ldaps://ldap.example.org:636"]`
42
42
43
43
ldapauth-fork options:
44
44
45
-
-`bindDN` - Admin connection DN, e.g. *uid=myapp,ou=users,dc=example,dc=org*. Optional. If not given at all, admin client is not bound. Giving empty string may result in anonymous bind when allowed.
46
-
-`bindCredentials` - Password for bindDN.
47
-
-`searchBase` - The base DN from which to search for users by username. E.g. *ou=users,dc=example,dc=org*
48
-
-`searchFilter` - LDAP search filter with which to find a user by username, e.g. *(uid={{username}})*. Use the literal *{{username}}* to have the given username interpolated in for the LDAP search.
49
-
-`searchAttributes` - Optional, default all. Array of attributes to fetch from LDAP server.
50
-
-`bindProperty` - Optional, default *dn*. Property of the LDAP user object to use when binding to verify the password. E.g. *name*, *email*
51
-
-`searchScope` - Optional, default *sub*. Scope of the search, one of *base*, *one*, or *sub*.
45
+
-`bindDN` - Admin connection DN, e.g. _uid=myapp,ou=users,dc=example,dc=org_. Optional. If not given at all, admin client is not bound. Giving empty string may result in anonymous bind when allowed.
46
+
-`bindCredentials` - Password for bindDN.
47
+
-`searchBase` - The base DN from which to search for users by username. E.g. _ou=users,dc=example,dc=org_
48
+
-`searchFilter` - LDAP search filter with which to find a user by username, e.g. _(uid={{username}})_. Use the literal _{{username}}_ to have the given username interpolated in for the LDAP search.
49
+
-`searchAttributes` - Optional, default all. Array of attributes to fetch from LDAP server.
50
+
-`bindProperty` - Optional, default _dn_. Property of the LDAP user object to use when binding to verify the password. E.g. _name_, _email_
51
+
-`searchScope` - Optional, default _sub_. Scope of the search, one of _base_, _one_, or _sub_.
52
52
53
53
ldapauth-fork can look for valid users groups too. Related options:
54
54
55
-
-`groupSearchBase` - Optional. The base DN from which to search for groups. If defined, also `groupSearchFilter` must be defined for the search to work.
56
-
-`groupSearchFilter` - Optional. LDAP search filter for groups. Place literal *{{dn}}* in the filter to have it replaced by the property defined with `groupDnProperty` of the found user object. *{{username}}* is also available and will be replaced with the *uid* of the found user. This is useful for example to filter PosixGroups by *memberUid*. Optionally you can also assign a function instead. The found user is passed to the function and it should return a valid search filter for the group search.
57
-
-`groupSearchAttributes` - Optional, default all. Array of attributes to fetch from LDAP server.
58
-
-`groupDnProperty` - Optional, default *dn*. The property of user object to use in *{{dn}}* interpolation of `groupSearchFilter`.
59
-
-`groupSearchScope` - Optional, default *sub*.
55
+
-`groupSearchBase` - Optional. The base DN from which to search for groups. If defined, also `groupSearchFilter` must be defined for the search to work.
56
+
-`groupSearchFilter` - Optional. LDAP search filter for groups. Place literal _{{dn}}_ in the filter to have it replaced by the property defined with `groupDnProperty` of the found user object. _{{username}}_ is also available and will be replaced with the _uid_ of the found user. This is useful for example to filter PosixGroups by _memberUid_. Optionally you can also assign a function instead. The found user is passed to the function and it should return a valid search filter for the group search.
57
+
-`groupSearchAttributes` - Optional, default all. Array of attributes to fetch from LDAP server.
58
+
-`groupDnProperty` - Optional, default _dn_. The property of user object to use in _{{dn}}_ interpolation of `groupSearchFilter`.
59
+
-`groupSearchScope` - Optional, default _sub_.
60
60
61
61
Other ldapauth-fork options:
62
62
63
-
-`includeRaw` - Optional, default false. Set to true to add property `_raw` containing the original buffers to the returned user object. Useful when you need to handle binary attributes
64
-
-`cache` - Optional, default false. If true, then up to 100 credentials at a time will be cached for 5 minutes.
65
-
-`log` - Bunyan logger instance, optional. If given this will result in TRACE-level error logging for component:ldapauth. The logger is also passed forward to ldapjs.
63
+
-`includeRaw` - Optional, default false. Set to true to add property `_raw` containing the original buffers to the returned user object. Useful when you need to handle binary attributes
64
+
-`cache` - Optional, default false. If true, then up to 100 credentials at a time will be cached for 5 minutes.
65
+
-`log` - Bunyan logger instance, optional. If given this will result in TRACE-level error logging for component:ldapauth. The logger is also passed forward to ldapjs.
66
66
67
67
Optional ldapjs options, see [ldapjs documentation](https://github.com/mcavage/node-ldapjs/blob/v1.0.1/docs/client.md):
68
68
69
-
-`tlsOptions` - Needed for TLS connection. See [Node.js documentation](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback)
70
-
-`socketPath`
71
-
-`timeout`
72
-
-`connectTimeout`
73
-
-`idleTimeout`
74
-
-`reconnect`
75
-
-`strictDN`
76
-
-`queueSize`
77
-
-`queueTimeout`
78
-
-`queueDisable`
69
+
-`tlsOptions` - Needed for TLS connection. See [Node.js documentation](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback)
0 commit comments