Merge pull request #49 from smacz42/andrewcz-ldapcherry-issue34

Add demo backend configuration files in goodies

docs/goodies.rst

@@ -50,3 +50,17 @@ Basic Lighttpd Vhost
 
 .. literalinclude:: ../goodies/lighttpd.conf
     :language: yaml
+
+Demo Backend Configuration Files
+--------------------------------
+
+The files here are the ones that are used at the demo site at `ldapcherry.kakwalab.ovh <https://ldapcherry.kakwalab.ovh/>`_ and can be used for a self-hosted demo backend:
+
+.. literalinclude:: ../goodies/demo_backend_configs/attributes.yml
+    :language: yaml
+
+.. literalinclude:: ../goodies/demo_backend_configs/roles.yml
+    :language: yaml
+
+.. literalinclude:: ../goodies/demo_backend_configs/ldapcherry.ini
+    :language: ini

goodies/demo_backend_configs/attributes.yml

@@ -0,0 +1,112 @@
+description: "First Name and Display Name"
+    display_name: "Display Name"
+    type: string
+    weight: 30
+    autofill:
+        function: lcDisplayName
+        args:
+            - $first-name
+            - $name
+    backends:
+        demo: cn
+first-name:
+    description: "First name of the user"
+    display_name: "First Name"
+    search_displayed: True
+    type: string
+    weight: 20
+    backends:
+        demo: givenName
+name:
+    description: "Family name of the user"
+    display_name: "Name"
+    search_displayed: True
+    weight: 10
+    type: string
+    backends:
+        demo: sn
+email:
+    description: "Email of the user"
+    display_name: "Email"
+    search_displayed: True
+    type: email
+    weight: 40
+    autofill:
+        function: lcMail
+        args:
+            - $first-name
+            - $name
+            - '@example.com'
+    backends:
+        demo: mail
+uid:
+    description: "UID of the user"
+    display_name: "UID"
+    search_displayed: True
+    key: True
+    type: string
+    weight: 50
+    autofill:
+        function: lcUid
+        args:
+            - $first-name
+            - $name
+            - '10000'
+            - '40000'
+    backends:
+        demo: uid
+uidNumber:
+    description: "User ID Number of the user"
+    display_name: "UID Number"
+    weight: 60
+    type: int
+    autofill:
+        function: lcUidNumber
+        args:
+            - $first-name
+            - $name
+            - '10000'
+            - '40000'
+    backends:
+        demo: uidNumber
+gidNumber:
+    description: "Group ID Number of the user"
+    display_name: "GID Number"
+    weight: 70
+    type: int
+    default: '10000'
+    backends:
+        demo: gidNumber
+shell:
+    description: "Shell of the user"
+    display_name: "Shell"
+    weight: 80
+    self: True
+    type: stringlist
+    values:
+        - /bin/bash
+        - /bin/zsh
+        - /bin/sh
+    backends:
+        demo: loginShell
+home:
+    description: "Home user path"
+    display_name: "Home"
+    weight: 90
+    type: string
+    autofill:
+        function: lcHomeDir
+        args:
+            - $first-name
+            - $name
+            - /home/
+    backends:
+        demo: homeDirectory
+password:
+    description: "Password of the user"
+    display_name: "Password"
+    weight: 31
+    self: True
+    type: password
+    backends:
+        demo: userPassword

goodies/demo_backend_configs/ldapcherry.ini

@@ -0,0 +1,25 @@
+[backends]
+#####################################
+#   configuration of demo backend   #
+#####################################
+
+# Name of the backend
+demo.module = 'ldapcherry.backend.backendDemo'
+# Display name of the Backend
+demo.display_name  = 'Demo Backend'
+# Groups of admin user
+demo.admin.groups  = 'SECOFF'
+# Groups of basic user
+demo.basic.groups  = 'Test 2, Test 1'
+# Password attribute name
+demo.pwd_attr = 'userPassword'
+# Attribute to use for the search
+demo.search_attributes = 'cn, sn, givenName, uid'
+# Login of default admin user
+demo.admin.user = 'admin'
+# Password of default admin user
+demo.admin.password = 'admin'
+# Login of default basic user
+demo.basic.user = 'user'
+# Password of default basic user
+demo.basic.password = 'user'

goodies/demo_backend_configs/roles.yml

@@ -0,0 +1,36 @@
+sec-officer:
+    display_name: Security Officer
+    description: Security officer of the system
+    LC_admins: True
+    backends_groups:
+        demo:
+            - SECOFF
+admin-lv3:
+    display_name: Administrators Level 3
+    description: Super administrators of the system
+    backends_groups:
+        demo:
+            - cn=dns admins,ou=Group,dc=example,dc=org
+            - cn=nagios admins,ou=Group,dc=example,dc=org
+            - cn=puppet admins,ou=Group,dc=example,dc=org
+            - cn=users,ou=Group,dc=example,dc=org
+admin-lv2:
+    display_name: Administrators Level 2
+    description: Basic administrators of the system
+    backends_groups:
+        demo:
+            - cn=nagios admins,ou=Group,dc=example,dc=org
+            - cn=users,ou=Group,dc=example,dc=org
+developpers:
+    display_name: Developpers
+    description: Developpers of the system
+    backends_groups:
+        demo:
+            - cn=developpers,ou=Group,dc=example,dc=org
+            - cn=users,ou=Group,dc=example,dc=org
+users:
+    display_name: Simple Users
+    description: Basic users of the system
+    backends_groups:
+        demo:
+            - cn=users,ou=Group,dc=example,dc=org