Skip to content

Commit

Permalink
Fix some more spellings
Browse files Browse the repository at this point in the history 
THis brings teh README into a better readable state
  • Loading branch information
@heiglandreas
heiglandreas committed Jan 30, 2025
1 parent ce6f67c commit acf1618
Showing 1 changed file with 53 additions and 26 deletions.
79 changes: 53 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,21 @@ Use your existing LDAP as authentication-backend for your WordPress!
[![Build Status](https://github.com/heiglandreas/authLdap/actions/workflows/tests.yml/badge.svg)](https://github.com/heiglandreas/authLdap/actions/workflows/tests.yml)
[![WordPress Stats](https://img.shields.io/wordpress/plugin/dt/authldap.svg)](https://wordpress.org/plugins/authldap/stats/)
[![WordPress Version](https://img.shields.io/wordpress/plugin/v/authldap.svg)](https://wordpress.org/plugins/authldap/)
[![WordPress testet](https://img.shields.io/wordpress/v/authldap.svg)](https://wordpress.org/plugins/authldap/)
[![WordPress tested](https://img.shields.io/wordpress/v/authldap.svg)](https://wordpress.org/plugins/authldap/)
[![Code Climate](https://codeclimate.com/github/heiglandreas/authLdap/badges/gpa.svg)](https://codeclimate.com/github/heiglandreas/authLdap)
[![codecov](https://codecov.io/gh/heiglandreas/authLdap/branch/master/graph/badge.svg?token=AYAhEeWtRQ)](https://codecov.io/gh/heiglandreas/authLdap)

So what are the differences to other WordPress-LDAP-Authentication-Plugins?

* **Flexible**: You are totaly free in which LDAP-backend to use. Due to the extensive configuration you can
freely decide how to do the authentication of your users. It simply depends on your
filters
* **Independent**: As soon as a user logs in, it is added/updated to the WordPress' user-database
to allow WordPress to always use the correct data. You only have to administer your users once.
* **Flexible**: You are totally free in which LDAP-backend to use. Due to the
extensive configuration you can freely decide how to do the authentication
of your users. It simply depends on your filters
* **Independent**: As soon as a user logs in, it is added/updated to the WordPress'
user-database to allow WordPress to always use the correct data. You only have
to administer your users once.
* **Failsafe**: Due to the users being created in WordPress' User-database they can
also log in when the LDAP-backend currently is gone. (If password caching is configured)
also log in when the LDAP-backend currently is gone.
(If password caching is configured)
* **Role-Aware**: You can map WordPress' roles to values of an existing LDAP-attribute.

## How does the plugin work?
Expand All @@ -37,49 +39,74 @@ wonderful plugin of Alistair Young from http://www.weblogs.uhi.ac.uk/sm00ay/?p=4

### Usage Settings

* **Enable Authentication via LDAP** Whether you want to enable authLdap for login or not
* **debug authLdap** When you have problems with authentication via LDAP you can enable a debugging mode here.
* **Save entered Password** Decide whether passwords will be cached in your wordpress-installation. **Attention:** Without the cache your users will not be able to log into your site when your LDAP is down!
* **Enable Authentication via LDAP** Whether you want to enable authLdap for login
or not
* **debug authLdap** When you have problems with authentication via LDAP you can
enable a debugging mode here.
* **Save entered Password** Decide whether passwords will be cached in your
WordPress-installation. **Attention:** Without the cache your users will not
be able to log into your site when your LDAP is down!

### Server Settings

* **LDAP Uri** This is the URI where your ldap-backend can be reached. More information are actually on the Configuration page
* **Filter** This is the real McCoy! The filter you define here specifies how a user will be found. Before applying the filter a %s will be replaced with the given username. This means, when a user logs in using ‘foobar’ as username the following happens:
* **LDAP Uri** This is the URI where your ldap-backend can be reached. More
information are actually on the Configuration page
* **Filter** This is the real McCoy! The filter you define here specifies how
a user will be found. Before applying the filter a %s will be replaced with
the given username. This means, when a user logs in using ‘foobar’ as username
the following happens:

* **uid=%1$s** check for any LDAP-Entry that has an attribute ‘uid’ with value ‘foobar’
* **(&(objectclass=posixAccount)(|(uid=%1$s)(mail=%1$s)))** check for any LDAP-Entry that has an attribute ‘objectclass’ with value ‘posixAccout’ and either a UID- or a mail-attribute with value ‘foobar’
* **uid=%1$s** check for any LDAP-Entry that has an attribute ‘uid’ with
value ‘foobar’
* **(&(objectclass=posixAccount)(|(uid=%1$s)(mail=%1$s)))** check for
any LDAP-Entry that has an attribute ‘objectclass’ with value
‘posixAccout’ and either a UID- or a mail-attribute with value ‘foobar’

This filter is rather powerfull if used wisely.
This filter is rather powerful if used wisely.

### Creating Users

* **Name-Attribute** Which Attribute from the LDAP contains the Full or the First name of the user trying to log in. This defaults to name
* **Second Name Attribute** If the above Name-Attribute only contains the First Name of the user you can here specify an Attribute that contains the second name. This field is empty by default
* **User-ID Attribute** This field will be used as login-name for wordpress. Please give the Attribute, that is used to identify the user. This should be the same as you used in the above Filter-Option. This field defaults to uid
* **Mail Attribute** Which Attribute holds the eMail-Address of the user? If more than one eMail-Address are stored in the LDAP, only the first given is used. This field defaults to mail
* **Web-Attribute** If your users have a personal page (URI) stored in the LDAP, it can be provided here. This field is empty by default
* **Name-Attribute** Which Attribute from the LDAP contains the Full or
the First name of the user trying to log in. This defaults to name
* **Second Name Attribute** If the above Name-Attribute only contains the
First Name of the user you can here specify an Attribute that contains
the second name. This field is empty by default
* **User-ID Attribute** This field will be used as login-name for WordPress.
Please give the Attribute, that is used to identify the user. This should
be the same as you used in the above Filter-Option. This field defaults
to uid
* **Mail Attribute** Which Attribute holds the eMail-Address of the user?
If more than one eMail-Address are stored in the LDAP, only the first
given is used. This field defaults to mail
* **Web-Attribute** If your users have a personal page (URI) stored in the
LDAP, it can be provided here. This field is empty by default

### User-Groups for Roles

* **Group-Attribute** This is the attribute that defines the Group-ID that can be matched against the Groups defined further down This field defaults to gidNumber.
* **Group-Filter** Here you can add the filter for selecting groups for the currentlly logged in user The Filter should contain the string %s which will be replaced by the login-name of the currently logged in
* **Group-Attribute** This is the attribute that defines the Group-ID that
can be matched against the Groups defined further down This field defaults
to gidNumber.
* **Group-Filter** Here you can add the filter for selecting groups for the
currently logged-in user The Filter should contain the string %s which will
be replaced by the login-name of the currently logged in


## FAQ

<dl>
<dt>Can I change a users password with this plugin?</dt>
<dd>Short Answer: <strong>No</strong>!<br>Long Answer: As the users credentials are not
only used for a wordpress-site when you authenticate against an LDAP but for
<dd>Short Answer: <strong>No</strong>!<br>Long Answer: As the users credentials
are not
only used for a WordPress-site when you authenticate against an LDAP but for
many other services also chances are great that there is a centralized place
where password-changes shall be made. We'll later allow inclusion of a link
to such a place but currently it's not available. And as password-hashing and
where to store it requires deeper insight into the LDAP-Server then most users
have and admins are willing to give, password changes are out of scope of this
plugin. If you know exactyl what you do, you might want to have a look at
plugin. If you know exactly what you do, you might want to have a look at
<a href="https://github.com/heiglandreas/authLdap/issues/54#issuecomment-125851029">
issue 54</a>
wherer a way of adding it is described!
where a way of adding it is described!
</dd>
<dt>Can I add a user to the LDAP when she creates a user-account on WordPress?</dt>
<dd>Short Answer: <strong>No</strong>!<br>Long Answer: Even though that is technically possible
Expand Down

0 comments on commit acf1618

Please sign in to comment.