Lightweight identity and authorization management software
Find a file
2020-10-21 15:22:44 +02:00
canaille Renamed the project 'canaille' 2020-10-21 14:04:40 +02:00
docker Renamed the project 'canaille' 2020-10-21 14:04:40 +02:00
schemas Consents page 2020-09-17 12:01:21 +02:00
tests Renamed the project 'canaille' 2020-10-21 14:04:40 +02:00
.coveralls.yml Updated coveralss token 2020-10-21 15:05:38 +02:00
.gitignore Renamed the project 'canaille' 2020-10-21 14:04:40 +02:00
.gitlab-ci.yml Python 3.9 support 2020-10-20 09:51:15 +02:00
docker-compose.yml Added some ldap debug information 2020-09-16 17:48:36 +02:00
LICENSE.md License 2020-08-19 13:50:12 +02:00
MANIFEST.in Renamed the project 'canaille' 2020-10-21 14:04:40 +02:00
README.md Renamed the project 'canaille' 2020-10-21 14:04:40 +02:00
setup.cfg Updated classifiers 2020-10-21 15:22:44 +02:00
setup.py setup.cfg instead of requirements.txt 2020-08-19 11:45:02 +02:00

⚠ Canaille is under development. Do not use in production yet. ⚠

Canaille

Canaille is a French word meaning rascal, and is pronounced approximatively Can I?, as in Can I access this data please?. It is a simple OpenID Connect provider based upon OpenLDAP.

It aims to be very light, simple to install and simple to maintain. Its main features are :

  • OAuth/OpenID Connect support;
  • Authentication against a LDAP directory;
  • No additional database required. Everything is stored in your OpenLDAP server;
  • The code is easy to read and easy to edit in case you want to write a patch.

Install

First you need to install the schemas into your LDAP server. There are several ways to achieve this:

LDAP schemas

Option 1: Add the schema into your filesystem

test -d /etc/openldap/schema && sudo cp schema/* /etc/openldap/schema
test -d /etc/ldap/schema && sudo cp schema/* /etc/ldap/schema
sudo service slapd restart

Option 2: Use slapadd

sudo slapadd -n0 -l schema/*.ldif

Web interface

Then you can deploy the code either by copying the git repository or installing the pip package:

pip install canaille

Finally you have to run the website in a WSGI server:

pip install gunicorn
gunicorn "canaille:create_app()"

Contribute

Contributions are welcome! To run the tests, you just need to run tox.

To try a development environment, you can run the docker image and then open https://127.0.0.1:5000 You can then connect with user admin and password admin to access an admin account, or user user and password user for a regular one.

cp canaille/conf/config.sample.toml canaille/conf/config.toml
cp canaille/conf/oauth-authorization-server.sample.json canaille/conf/oauth-authorization-server.json
cp canaille/conf/openid-configuration.sample.json canaille/conf/openid-configuration.json
docker-compose up