OpenProject OmniAuth LDAP Strategy Provider

This plugin provides the OmniAuth LDAP Strategy for OpenProject.

Installation

Add the following entries to your Gemfile.plugins in your OpenProject (4.0+) root directory:

gem 'openproject-auth_plugins', :git => 'https://github.com/opf/openproject-auth_plugins', :branch => 'stable'
gem "openproject-auth_ldap", :git => 'https://github.com/hostsharing/openproject-auth_ldap', :branch => 'stable'

Note: OpenProject 4.0+ requires net-ldap for the internal LDAP authentication scheme. If you use this plugin and run bundle install, bundler will fail to find compatible version, as net-ldap required from the omniauth-ldap gem is rather outdated. To avoid this, create a Gemfile.local file with my fork of the omniauth-ldap gem:

gem 'omniauth-ldap', :git => 'https://github.com/oliverguenther/omniauth-ldap'

Requirements

My fork of the omniauth-ldap gem ~> 1.0.4
OpenProject >= 4.0
openproject-auth

Configuration

To add your own LDAP strategy provider(s), create the following settings file (relative to your OpenProject root):

config/plugins/auth_ldap/settings.yml

with the following contents:

myldap:
  name: "my-ldap"
  host: 'localhost'
  port: 389
  base: 'dc=example, dc=com'
  filter: '(&(uid=%{username})(memberOf=cn=myapp-users,ou=groups,dc=example,dc=com))'
  uid: 'uid'
  display_name: "LDAP"

uid specifies the LDAP attribute that is used as the username field in the login form.
display_name is the name of the omniauth login scheme as displayed to the user.
name attribute identifies the authentication scheme (e.g., it is used for the auth route /auth//)
An optional icon may be set to an asset path which will override the default OpenProject authentication icon (defaults to two meshing cogwheels).

The plugin simply passes all options to omniauth-ldap. See their documentation for all available configuration keys.

Multiple Providers

If you have the use-case of multiple LDAP providers, simply add several providers to your yaml config, OpenProject will handle the rest automatically.

Copyrights & License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.