README.md 1.53 KB
Newer Older
Pietsch, Martin's avatar
Pietsch, Martin committed
1 2
Description
===========
Pietsch, Martin's avatar
Pietsch, Martin committed
3

Pietsch, Martin's avatar
Pietsch, Martin committed
4
This role is the top level package of all auth categorised software and does not provide a special software product. This software is used for authorisation and authentication processes.
Pietsch, Martin's avatar
Pietsch, Martin committed
5 6

Requirements
Pietsch, Martin's avatar
Pietsch, Martin committed
7 8 9 10 11 12 13
============

Variables
----------

- development note: Define these variables in the defaults/main.yml file of your sub-role.

14
* auth_permitted_users
Pietsch, Martin's avatar
Pietsch, Martin committed
15 16 17 18 19
  * description:
    * This option contains a list of usernames that are allowed to access the system(s).
  * default: []
  * example: auth_permitted_users: ["user1", "user2"]

20
* auth_permitted_groups
Pietsch, Martin's avatar
Pietsch, Martin committed
21 22 23 24 25
  * description:
    * This option contains a list of groupnames that are allowed to access the system(s).
  * default: []
  * example: auth_permitted_users: ["group1", "group2"]

26
* auth_denied_users
Pietsch, Martin's avatar
Pietsch, Martin committed
27 28 29 30 31
  * description:
    * This option contains a list of usernames that are locked for the access to the system(s).
  * default: []
  * example: auth_permitted_users: ["user1", "user2"]

32
* auth_denied_groups
Pietsch, Martin's avatar
Pietsch, Martin committed
33 34 35 36 37
  * description:
    * This option contains a list of groupnames that are locked for the access to the system(s).
  * default: []
  * example: auth_permitted_users: ["user1", "user2"]
    
38 39 40 41 42
* auth_referrals
  * description:
    * This option contains a list of referrals. These are used when an uthentication service cannot find something in its local database to handle a request.
  * default: undefined  

Pietsch, Martin's avatar
Pietsch, Martin committed
43 44
Processes
=========
Pietsch, Martin's avatar
Pietsch, Martin committed
45

Pietsch, Martin's avatar
Pietsch, Martin committed
46 47
main
----
Pietsch, Martin's avatar
Pietsch, Martin committed
48

Pietsch, Martin's avatar
Pietsch, Martin committed
49
1. NOP
Pietsch, Martin's avatar
Pietsch, Martin committed
50

Pietsch, Martin's avatar
Pietsch, Martin committed
51 52
configure
---------
Pietsch, Martin's avatar
Pietsch, Martin committed
53

Pietsch, Martin's avatar
Pietsch, Martin committed
54
1. NOP
Pietsch, Martin's avatar
Pietsch, Martin committed
55 56

License
Pietsch, Martin's avatar
Pietsch, Martin committed
57
=======
Pietsch, Martin's avatar
Pietsch, Martin committed
58

Pietsch, Martin's avatar
Pietsch, Martin committed
59
BSD-3-Clauses
Pietsch, Martin's avatar
Pietsch, Martin committed
60

Pietsch, Martin's avatar
Pietsch, Martin committed
61 62
Contributors
============
Pietsch, Martin's avatar
Pietsch, Martin committed
63

Pietsch, Martin's avatar
Pietsch, Martin committed
64
- Martin Pietsch (martin.pietsch@tu-dresden.de)