From c4a57728e9097a8b04c8cec10b62719fc9582bde Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 07:32:32 +0200 Subject: [PATCH 1/9] Include minimal working config in minimal example Changed the minimal config example to include at least the minimal config settings to result in a working Authelia installation. --- config.minimal.yml | 100 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/config.minimal.yml b/config.minimal.yml index 2daa4764e..ebf79a213 100644 --- a/config.minimal.yml +++ b/config.minimal.yml @@ -14,3 +14,103 @@ session: # The domain to protect. # Note: Authelia must also be served by that domain. domain: example.com + +# Configuration of the storage backend used to store data and secrets. +# i.e 2FA data +# You must use only an available configuration: local, mongo +storage: + # The directory where the DB files will be saved + local: + path: /etc/authelia/volume + +totp: + issuer: example.com + +authentication_methods: + default_method: two_factor + per_subdomain_methods: + single_factor.example.com: single_factor + +access_control: + # Default policy can either be `allow` or `deny`. + # It is the policy applied to any resource if it has not been overriden + # in the `any`, `groups` or `users` category. + default_policy: deny + groups: + admins: + # All resources in all domains + - domain: '*.example.com' + policy: allow + # Except mx2.mail.example.com (it restricts the first rule) + #- domain: 'mx2.mail.example.com' + # policy: deny + + # User-based rules. The key is a user name and the value + # is a list of rules. + users: + john: + - domain: dev.example.com + policy: allow + resources: + - '^/users/john/.*$' + harry: + - domain: dev.example.com + policy: allow + resources: + - '^/users/harry/.*$' + bob: + - domain: '*.mail.example.com' + policy: allow + - domain: 'dev.example.com' + policy: allow + resources: +- '^/users/bob/.*$' + + +regulation: + # The number of failed login attempts before user is banned. + # Set it to 0 to disable regulation. + max_retries: 3 + + # The time range during which the user can attempt login before being banned. + # The user is banned if the authenticaction failed `max_retries` times in a `find_time` seconds window. + find_time: 120 + + # The length of time before a banned user can login again. + ban_time: 300 + +# Default redirection URL +# +# If user tries to authenticate without any referer, Authelia +# does not know where to redirect the user to at the end of the +# authentication process. +# This parameter allows you to specify the default redirection +# URL Authelia will use in such a case. +# +# Note: this parameter is optional. If not provided, user won't +# be redirected upon successful authentication. +#default_redirection_url: https://authelia.example.domain + +notifier: + # For testing purpose, notifications can be sent in a file + ## filesystem: + ## filename: /tmp/authelia/notification.txt + + # Use your email account to send the notifications. You can use an app password. + # List of valid services can be found here: https://nodemailer.com/smtp/well-known/ + ## email: + ## username: user@example.com + ## password: yourpassword + ## sender: admin@example.com + ## service: gmail + + # Use a SMTP server for sending notifications + # Use a SMTP server for sending notifications + smtp: + username: test + password: password + secure: false + host: 'smtp' + port: 1025 + sender: admin@example.com + From 323848736a6cb86c2fb00a9b82cb11d63d3cbe8d Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 07:36:45 +0200 Subject: [PATCH 2/9] Added some documentation snippets --- config.minimal.yml | 56 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/config.minimal.yml b/config.minimal.yml index ebf79a213..8fcef184b 100644 --- a/config.minimal.yml +++ b/config.minimal.yml @@ -23,14 +23,64 @@ storage: local: path: /etc/authelia/volume +# TOTP Issuer Name +# +# This will be the issuer name displayed in Google Authenticator +# See: https://github.com/google/google-authenticator/wiki/Key-Uri-Format for more info on issuer names totp: issuer: example.com +# Authentication methods +# +# Authentication methods can be defined per subdomain. +# There are currently two available methods: "single_factor" and "two_factor" +# +# Note: by default a domain uses "two_factor" method. +# +# Note: 'per_subdomain_methods' is a dictionary where keys must be subdomains and +# values must be one of the two possible methods. +# +# Note: 'per_subdomain_methods' is optional. +# +# Note: authentication_methods is optional. If it is not set all sub-domains +# are protected by two factors. authentication_methods: default_method: two_factor per_subdomain_methods: single_factor.example.com: single_factor +# Access Control +# +# Access control is a set of rules you can use to restrict user access to certain +# resources. +# Any (apply to anyone), per-user or per-group rules can be defined. +# +# If 'access_control' is not defined, ACL rules are disabled and the `allow` default +# policy is applied, i.e., access is allowed to anyone. Otherwise restrictions follow +# the rules defined. +# +# Note: One can use the wildcard * to match any subdomain. +# It must stand at the beginning of the pattern. (example: *.mydomain.com) +# +# Note: You must put the pattern in simple quotes when using the wildcard for the YAML +# to be syntaxically correct. +# +# Definition: A `rule` is an object with the following keys: `domain`, `policy` +# and `resources`. +# - `domain` defines which domain or set of domains the rule applies to. +# - `policy` is the policy to apply to resources. It must be either `allow` or `deny`. +# - `resources` is a list of regular expressions that matches a set of resources to +# apply the policy to. +# +# Note: Rules follow an order of priority defined as follows: +# In each category (`any`, `groups`, `users`), the latest rules have the highest +# priority. In other words, it means that if a given resource matches two rules in the +# same category, the latest one overrides the first one. +# Each category has also its own priority. That is, `users` has the highest priority, then +# `groups` and `any` has the lowest priority. It means if two rules in different categories +# match a given resource, the one in the category with the highest priority overrides the +# other one. +# access_control: # Default policy can either be `allow` or `deny`. # It is the policy applied to any resource if it has not been overriden @@ -66,7 +116,11 @@ access_control: resources: - '^/users/bob/.*$' - +# Configuration of the authentication regulation mechanism. +# +# This mechanism prevents attackers from brute forcing the first factor. +# It bans the user if too many attempts are done in a short period of +# time. regulation: # The number of failed login attempts before user is banned. # Set it to 0 to disable regulation. From 326a763343b64bce3296f94c4265872e17574a33 Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 07:39:04 +0200 Subject: [PATCH 3/9] Changed example file location for users_database If using Docker as a medium for Authelia, having both the storage and users_database in one directory is preferable due to only one volume being needed. /etc/authelia cant be this directory, since there are other files in there, hence the subdirectory. --- config.minimal.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.minimal.yml b/config.minimal.yml index 8fcef184b..43156dc06 100644 --- a/config.minimal.yml +++ b/config.minimal.yml @@ -5,7 +5,7 @@ authentication_backend: file: # The path to the database file. The file is at the root of the repo. - path: /etc/authelia/users_database.yml + path: /etc/authelia/volume/users_database.yml session: # The secret to encrypt the session cookies with. From 48c1bb5136af677ad2570934500ab402b8e98c7b Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 07:52:44 +0200 Subject: [PATCH 4/9] Minimal example config for docker swarm Currently missing: reverse proxy, since I am using traefik and I do not have it fully working yet with the internal traefik tools. --- docker-compose.swarm.minimal.yml | 47 ++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docker-compose.swarm.minimal.yml diff --git a/docker-compose.swarm.minimal.yml b/docker-compose.swarm.minimal.yml new file mode 100644 index 000000000..a519fe831 --- /dev/null +++ b/docker-compose.swarm.minimal.yml @@ -0,0 +1,47 @@ +version: '3.4' +services: + authelia: + image: clems4ever/authelia:latest + # Used for Docker configs + configs: + - source: authelia.v3 + target: /etc/authelia/config.yml + uid: '0' + gid: '0' + mode: 0444 + environment: + - NODE_TLS_REJECT_UNAUTHORIZED=0 + # Where the authelia volume is to be mounted. Mounted in a subdirectory to host both the users_database and storage at the same time. + volumes: + - authelia:/etc/authelia/volume + networks: + - overlay + deploy: + #Configure Authelia to automatically restart on failure. + restart_policy: + condition: on-failure + delay: 5s + max_attempts: 3 + window: 120s + # Mode: global would start authelia on all available nodes, replicated limits it to how many replicas are configured. + mode: replicated + # How many replicas are wanted. Can be any number >0 up to however many nodes are available. + replicas: 1 + placement: + constraints: + - node.role == worker + +#The volume for authelia needs to be configured. There are many drivers available. Such as local storage, ceph-rdb, nfs, cifs etc. +volumes: + authelia: + driver: default + name: volume-authelia + +networks: + overlay: + external: true + +# This is needed if Docker configs are being used to provide Authelia with its configuration. +configs: + authelia: + external: true From 5eafeb65f7abeb519b6e5ca08b0c4e221ce04b99 Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 07:56:27 +0200 Subject: [PATCH 5/9] Config example fixed --- docker-compose.swarm.minimal.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose.swarm.minimal.yml b/docker-compose.swarm.minimal.yml index a519fe831..4754f901c 100644 --- a/docker-compose.swarm.minimal.yml +++ b/docker-compose.swarm.minimal.yml @@ -4,7 +4,7 @@ services: image: clems4ever/authelia:latest # Used for Docker configs configs: - - source: authelia.v3 + - source: authelia target: /etc/authelia/config.yml uid: '0' gid: '0' From ef510612461b3d8514aeb4183f473c56b58e4b59 Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 07:58:53 +0200 Subject: [PATCH 6/9] Fixed formatting --- config.minimal.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.minimal.yml b/config.minimal.yml index 43156dc06..c9de59d24 100644 --- a/config.minimal.yml +++ b/config.minimal.yml @@ -114,7 +114,7 @@ access_control: - domain: 'dev.example.com' policy: allow resources: -- '^/users/bob/.*$' + - '^/users/bob/.*$' # Configuration of the authentication regulation mechanism. # From 10ffaf0f4f897c7c31b8ffd88ee9d0400bfbbc36 Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 15:54:15 +0200 Subject: [PATCH 7/9] Cut down on comments, change directory of users_db I removed some (parts) of comments as requested. Also changed the directory of the users_database.yml. I would add the one/two volume issue into the docker swarm config then. --- config.minimal.yml | 74 ++++------------------------------------------ 1 file changed, 6 insertions(+), 68 deletions(-) diff --git a/config.minimal.yml b/config.minimal.yml index c9de59d24..2771b7d6d 100644 --- a/config.minimal.yml +++ b/config.minimal.yml @@ -4,24 +4,16 @@ authentication_backend: file: - # The path to the database file. The file is at the root of the repo. - path: /etc/authelia/volume/users_database.yml + path: /etc/authelia/users_database.yml session: - # The secret to encrypt the session cookies with. secret: unsecure_session_secret - - # The domain to protect. - # Note: Authelia must also be served by that domain. domain: example.com -# Configuration of the storage backend used to store data and secrets. -# i.e 2FA data -# You must use only an available configuration: local, mongo +# Configuration of the storage backend used to store data and secrets. i.e. totp data storage: - # The directory where the DB files will be saved local: - path: /etc/authelia/volume + path: /etc/authelia/storage # TOTP Issuer Name # @@ -34,16 +26,6 @@ totp: # # Authentication methods can be defined per subdomain. # There are currently two available methods: "single_factor" and "two_factor" -# -# Note: by default a domain uses "two_factor" method. -# -# Note: 'per_subdomain_methods' is a dictionary where keys must be subdomains and -# values must be one of the two possible methods. -# -# Note: 'per_subdomain_methods' is optional. -# -# Note: authentication_methods is optional. If it is not set all sub-domains -# are protected by two factors. authentication_methods: default_method: two_factor per_subdomain_methods: @@ -53,38 +35,8 @@ authentication_methods: # # Access control is a set of rules you can use to restrict user access to certain # resources. -# Any (apply to anyone), per-user or per-group rules can be defined. -# -# If 'access_control' is not defined, ACL rules are disabled and the `allow` default -# policy is applied, i.e., access is allowed to anyone. Otherwise restrictions follow -# the rules defined. -# -# Note: One can use the wildcard * to match any subdomain. -# It must stand at the beginning of the pattern. (example: *.mydomain.com) -# -# Note: You must put the pattern in simple quotes when using the wildcard for the YAML -# to be syntaxically correct. -# -# Definition: A `rule` is an object with the following keys: `domain`, `policy` -# and `resources`. -# - `domain` defines which domain or set of domains the rule applies to. -# - `policy` is the policy to apply to resources. It must be either `allow` or `deny`. -# - `resources` is a list of regular expressions that matches a set of resources to -# apply the policy to. -# -# Note: Rules follow an order of priority defined as follows: -# In each category (`any`, `groups`, `users`), the latest rules have the highest -# priority. In other words, it means that if a given resource matches two rules in the -# same category, the latest one overrides the first one. -# Each category has also its own priority. That is, `users` has the highest priority, then -# `groups` and `any` has the lowest priority. It means if two rules in different categories -# match a given resource, the one in the category with the highest priority overrides the -# other one. -# access_control: # Default policy can either be `allow` or `deny`. - # It is the policy applied to any resource if it has not been overriden - # in the `any`, `groups` or `users` category. default_policy: deny groups: admins: @@ -95,8 +47,7 @@ access_control: #- domain: 'mx2.mail.example.com' # policy: deny - # User-based rules. The key is a user name and the value - # is a list of rules. + # User-based rules. users: john: - domain: dev.example.com @@ -117,16 +68,10 @@ access_control: - '^/users/bob/.*$' # Configuration of the authentication regulation mechanism. -# -# This mechanism prevents attackers from brute forcing the first factor. -# It bans the user if too many attempts are done in a short period of -# time. -regulation: - # The number of failed login attempts before user is banned. - # Set it to 0 to disable regulation. +regulation: + # Set it to 0 to disable max_retries. max_retries: 3 - # The time range during which the user can attempt login before being banned. # The user is banned if the authenticaction failed `max_retries` times in a `find_time` seconds window. find_time: 120 @@ -135,12 +80,6 @@ regulation: # Default redirection URL # -# If user tries to authenticate without any referer, Authelia -# does not know where to redirect the user to at the end of the -# authentication process. -# This parameter allows you to specify the default redirection -# URL Authelia will use in such a case. -# # Note: this parameter is optional. If not provided, user won't # be redirected upon successful authentication. #default_redirection_url: https://authelia.example.domain @@ -158,7 +97,6 @@ notifier: ## sender: admin@example.com ## service: gmail - # Use a SMTP server for sending notifications # Use a SMTP server for sending notifications smtp: username: test From 04cd62dd3ec6543f6c7fae6adba40478789c9d58 Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 15:57:46 +0200 Subject: [PATCH 8/9] Changed the comment about the config location --- docker-compose.swarm.minimal.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docker-compose.swarm.minimal.yml b/docker-compose.swarm.minimal.yml index 4754f901c..adabd1f3d 100644 --- a/docker-compose.swarm.minimal.yml +++ b/docker-compose.swarm.minimal.yml @@ -11,9 +11,10 @@ services: mode: 0444 environment: - NODE_TLS_REJECT_UNAUTHORIZED=0 - # Where the authelia volume is to be mounted. Mounted in a subdirectory to host both the users_database and storage at the same time. + # Where the authelia volume is to be mounted. To only use a single volume, the minimal config needs to be changed to read the users_database.yml also from this subdirectory. + # Otherwise a second volume will need to be configured here to mount the users_database.yml. volumes: - - authelia:/etc/authelia/volume + - authelia:/etc/authelia/storage networks: - overlay deploy: @@ -28,7 +29,7 @@ services: # How many replicas are wanted. Can be any number >0 up to however many nodes are available. replicas: 1 placement: - constraints: + constraints: - node.role == worker #The volume for authelia needs to be configured. There are many drivers available. Such as local storage, ceph-rdb, nfs, cifs etc. From ed9b593ddfa08598d7598d6f74166b8105542f44 Mon Sep 17 00:00:00 2001 From: Philipp Rintz <13933258+p-rintz@users.noreply.github.com> Date: Fri, 12 Oct 2018 16:18:17 +0200 Subject: [PATCH 9/9] Uncommented filesystem notifier --- config.minimal.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/config.minimal.yml b/config.minimal.yml index 2771b7d6d..385b05b44 100644 --- a/config.minimal.yml +++ b/config.minimal.yml @@ -86,8 +86,8 @@ regulation: notifier: # For testing purpose, notifications can be sent in a file - ## filesystem: - ## filename: /tmp/authelia/notification.txt + filesystem: + filename: /tmp/authelia/notification.txt # Use your email account to send the notifications. You can use an app password. # List of valid services can be found here: https://nodemailer.com/smtp/well-known/ @@ -98,11 +98,11 @@ notifier: ## service: gmail # Use a SMTP server for sending notifications - smtp: - username: test - password: password - secure: false - host: 'smtp' - port: 1025 - sender: admin@example.com + #smtp: + # username: test + # password: password + # secure: false + # host: 'smtp' + # port: 1025 + # sender: admin@example.com