-
Notifications
You must be signed in to change notification settings - Fork 17
/
config.toml.dist
315 lines (255 loc) · 12.1 KB
/
config.toml.dist
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
################################################################
# Portier Broker configuration template
#
# All settings in this template are listed with their defaults. If the default
# value of a setting is fine, you can leave the setting out of your
# configuration.
#
# If a setting in this template is commented, that means it is unset by
# default, and any value listed is an example only.
#
# Alternatively, the broker can be configured using the environment. Each
# setting here has a matching `BROKER_*` environment variable. For example,
# `public_url` can also be set using the `BROKER_PUBLIC_URL` environment
# variable.
#
# Configuration from the environment takes precedence over the configuration
# file. (It's also possible to use the environment only, without a
# configuration file.)
################################################################
# Basic settings
# The IP address and port to bind the HTTP server to. Note that `listen_ip`
# accepts IPv4 and IPv6, but currently not hostnames.
#
# Alternatively, you may use systemd socket activation to pass in a listening
# socket, in which case these settings are ignored. (See the included systemd
# unit file.)
#
# Also note that the broker currently only talks plain HTTP, and not HTTPS.
# Using HTTPS is strongly recommended, but you'll need to add a reverse proxy
# in front of the broker to do this. (Apache or Nginx can do this for you.)
#
# If using the Docker image, you can leave these settings out of your config.
listen_ip = "127.0.0.1"
listen_port = 3333
# The broker server's public-facing URL.
#
# It's important to set this correctly, or JSON Web Tokens will fail to
# validate. Relying Parties will use the same value for their Broker URL. To
# ensure consistency, trailing slashes should be avoided.
public_url = "" # Required
# A list of IP addresses or subnets (CIDR-notation) of trusted reverse proxies.
#
# Portier uses this to determine the actual client IP address, and setting this
# correctly is important for rate-limits.
#
# Portier will look for the `X-Forwarded-For` header sent by reverse proxies.
# In Nginx, you'd accomplish this with:
#
# proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
#
trusted_proxies = ["127.0.0.0/8", "::1"]
# The 'From' name and address used by Portier to send emails.
from_name = "Portier"
from_address = "" # Required
# Optional Google Client ID for verifying `@gmail.com` addresses.
# You can create one of these at: https://console.cloud.google.com/
#google_client_id = ""
# To generate RSA keys, the broker runs an external command. By default, this
# looks for the OpenSSL CLI in `$PATH`, but you may need to change this for
# your environment. Whatever command you specify here should output a single
# PEM key on stdout.
#
# Using automatic key rotation is strongly recommended, but if you cannot
# provide a working value for this setting, it's possible to manually configure
# keys. See the `keyfiles` and `keytext` options in the advanced section for
# how to do this.
generate_rsa_command = ["openssl", "genrsa", "2048"]
################################################################
# Storage
# Selecting one of these storage methods is required.
#
# For simple installations, SQLite is recommended. Alternatively, Redis can be
# useful when running multiple instances of the broker, or when there's no
# persistent file storage. This is common with cloud hosting, like Heroku.
# Setting `sqlite_db` enables SQLite storage. Please also read:
# https://github.com/portier/portier-broker/blob/master/docs/storage/sqlite.md
#sqlite_db = "/var/lib/portier-broker/db.sqlite3"
# Setting `redis_url` enables Redis storage. Please also read:
# https://github.com/portier/portier-broker/blob/master/docs/storage/redis.md
#redis_url = "redis://localhost/0"
# Setting `memory_storage` enables in-memory storage. This should only be used
# for local testing.
#memory_storage = true
################################################################
# Sending mail
# Selecting one of these methods to send mail is required.
#
# If you're looking for an easy way to test the broker locally, consider using
# SMTP with Mailhog: https://github.com/mailhog/MailHog
# Setting `smtp_server` enables SMTP to send mail. The value should be a
# hostname or IP address, and may optionally have a port. (If not specified,
# port 25 is used.) The `smtp_username` and `smtp_password` fields are
# optional.
#smtp_server = ""
#smtp_username = ""
#smtp_password = ""
# Setting `sendmail_command` enables sending mail using the given `sendmail`
# executable. The path in this example is usually the correct one.
#sendmail_command = "/usr/sbin/sendmail"
# Setting `postmark_token` enables sending mail using the Postmark API. The
# value is a Postmark server API token.
#postmark_token = ""
################################################################
# Access control
# The lists in this section all take literal string values, but also filenames
# by prefixing a path with `@`. These files must contain one value per line,
# but may contain empty lines or comments starting with `//` or `#`.
#
# Note that files are only loaded once during startup, and the broker must be
# restarted after updating them.
# List of (exact) website origins that are allowed to use this broker. If left
# unset, the broker will allow any Relying Party to use it. (Note that an empty
# list here has different meaning than leaving it unset.)
#allowed_origins = ["https://example.com"]
# List of (exact) email domains that are explicitely allowed to use this
# broker. When an email address matches this list, checks for
# `blocked_domains`, `valid_tlds` and `valid_suffixes` are skipped.
#
# This is a good place to add test domains that aren't public, like
# `my-domain.test`.
allowed_domains = []
# Set this flag to true to treat any email domain not in `allowed_domains` as
# blocked. This effectively disables the checks for `blocked_domains`,
# `valid_tlds` and `valid_suffixes`. Useful for private brokers.
allowed_domains_only = false
# List of (exact) email domains that are explicitely blocked from using this
# broker.
blocked_domains = []
# List of (exact) top-level domains (TLDs) considered valid for email
# addresses. The default is to use a recent copy of the IANA list from:
# https://data.iana.org/TLD/
valid_tlds = ["@tlds-alpha-by-domain.txt"]
# List of domain suffixes considered valid for email addresses. This list
# follows the format described at: https://publicsuffix.org/
#
# The default is also to use a recent copy of the list from the above site.
valid_suffixes = ["@public_suffix_list.dat"]
################################################################
# Advanced settings
# By default, the broker automatically generates and rotates keys used to sign
# JSON Web Tokens. If for some reason you wish to provide keys manually, you
# can do so with these settings.
#
# Only PEM format is accepted, but the `keytext` and each file in `keyfiles`
# may contain multiple PEM blocks. The broker will list all public keys in API
# responses, but will only use the last key for signing.
keyfiles = []
#keytext = """
#-----BEGIN PRIVATE KEY-----
#[...]
#"""
# Signing algorithms to use for JSON Web Tokens. Currently supported values
# are: RS256, EdDSA. The protocol for selecting algorithms other than RS256 is
# experimental and non-standard, so by default only RS256 is enabled.
signing_algs = ["RS256"]
# Directory that contains broker data files. This directory should contain the
# `lang`, `res` and `tmpl` subdirectories. The default empty string value for
# this setting causes the broker to use the current working directory.
data_dir = ""
# Various Time-To-Live values can be tweaked from their recommended defaults.
# If the default values don't suit your deployment, we'd love to hear why!
# HTTP max-age for our static resources
static_ttl = 604800 # 1 week
# HTTP max-age for our discovery JSON
discovery_ttl = 604800 # 1 week
# Key rotation rate, and HTTP max-age for our keys JSON
keys_ttl = 86400 # 1 day
# Duration that JSON Web Tokens are valid for
token_ttl = 600 # 10 minutes
# Time that users have to complete authentication
session_ttl = 900 # 15 minutes
# Minimum cache time for downstream HTTP requests made by the broker
cache_ttl = 3600 # 1 hour
################################################################
# Rate limits
# Limits can be set in a flexible way. We've tried to provide some sensible
# defaults, but if you're exposing your broker to the internet, you may need
# control over limits.
#
# Limits are specified as a list of strings. When setting these using the
# `BROKER_LIMITS` environment variable, they can be space or comma separated.
# Each entry contains a count, a time window, and may be preceded with optional
# flags separated by semi-colons.
#
# Here are some examples to illustrate what's possible:
#
# - `1000/sec` - A global limit of 1000 requests per second.
#
# - `email:5/min` - Per email address, max 5 requests per minute.
#
# - `ip:origin:10/s` - Max 10 requests per second for each unique combination
# of IP and Relying Party origin. (A 'compound key' in database terminology.)
#
# - `email:decr_complete:5/15m` - Per email, allow max 5 in-progress attempts
# per 15 minutes. The `decr_complete` flag ensures that when the user
# completes a login, effectively a new 'slot' opens up for them.
#
# - `ip:extend_window:1000/s` - Max 1000 requests per second, per IP, with an
# extending window. For example, during an ongoing attack, the IP does not
# get new slots the next second, because its ongoing attempts keep extending
# the window further. The penalty is lifted only when attempts stop
# completely for one full second after the last attempt. This flag can have
# drastic effects, and is usually only applied to short time windows.
#
# Flags control what the limit applies to and its behavior. These are all the
# currently implemented flags:
#
# - `ip`: Apply the limit to the users IP address.
# - `email`: Apply the limit to the users email address.
# - `domain`: Apply the limit to the users email domain.
# - `origin`: Apply the limit to the Relying Party origin.
# - `decr_complete`: Decrement the counter for completed requests.
# - `extend_window`: Extend the window on every hit, instead of just the first.
#
# The time window is a number followed by a unit. The number may be omitted,
# which will mean 1 of the given unit. The following units can be used:
#
# - `s` / `sec` / `secs` / `second` / `seconds`
# - `m` / `min` / `mins` / `minute` / `minutes`
# - `h` / `hour` / `hours`
# - `d` / `day` / `days`
#
# Note that each limit added also increases the amount of queries to your
# selected storage method. The list order does not matter, because all limits
# are always tested on every attempt, and processing does not short-circuit.
limits = [
# Per IP, max 50 requests per second.
"ip:50/s",
# Per IP, max 100 requests per 5 seconds, with an extending window.
"ip:extend_window:100/5s",
# Per IP and email, max 30 requests per hour.
"ip:email:30/h",
# Per IP and email, allow 5 slots per 15 minutes.
"ip:email:decr_complete:5/15m",
# Per IP and email, allow 2 slots per 15 minutes on each site.
"ip:email:origin:decr_complete:2/15m",
]
################################################################
# WebFinger overrides
# The broker uses WebFinger to discover domains that provide custom
# authentication. If WebFinger cannot be configured on a domain, custom
# overrides can be configured with sections like the ones below. (Note that it
# is currently not possible to configure these overrides using environment
# variables.)
# The following example enables Google authentication for a domain. Note that
# both `rel` and `href` should be treated as magic constants.
#[[domain_overrides."example.com"]]
#rel = "https://portier.io/specs/auth/1.0/idp/google"
#href = "https://accounts.google.com"
# The following example configures a custom Portier Identity Provider for a
# domain. Note that `rel` here should be treated as a magic constant, and
# `href` points to the actual Identity Provider implementation.
#[[domain_overrides."example.com"]]
#rel = "https://portier.io/specs/auth/1.0/idp"
#href = "https://identity-provider.example.com"