Skip to content

Commit d8600e2

Browse files
authored
remove duplicated docs section about password hashing rate limiting (#4554)
1 parent b5ae846 commit d8600e2

File tree

1 file changed

+0
-54
lines changed

1 file changed

+0
-54
lines changed

docs/src/developer/reference/config-options.md

-54
Original file line numberDiff line numberDiff line change
@@ -878,60 +878,6 @@ The `ipAddressExceptions` have to be CIDR blocks which can be specified like
878878
by pass the rate limits. To limit one particular IP address, it can be specified
879879
as `127.0.0.1/32`.
880880

881-
Due to the performance implications, password hashing has to be rate limited
882-
more than other operations. To allow this, the rate limiting happens at a deeper
883-
level than nginx. It can be configured using these options:
884-
885-
```yaml
886-
brig:
887-
optSettings:
888-
setPasswordHashingRateLimit:
889-
ipAddrLimit:
890-
burst: 5
891-
inverseRate: 300000000 # 5 mins, makes it 12 reqs/hour
892-
userLimit:
893-
burst: 5
894-
inverseRate: 60000000 # 1 min, makes it 60 req/hour
895-
internalLimit:
896-
burst: 10
897-
inverseRate: 0 # No rate limiting for internal use
898-
ipv4CidrBlock: 32 # Only block individual IP addresses
899-
ipv6CidrBlock: 64 # Block /64 range at a time.
900-
ipAddressExceptions: []
901-
maxRateLimitedKeys: 100000 # Estimated memory usage: 4 MB
902-
galley:
903-
settings:
904-
passwordHashingRateLimit:
905-
ipAddrLimit:
906-
burst: 5
907-
inverseRate: 300000000 # 5 mins, makes it 12 reqs/hour
908-
userLimit:
909-
burst: 5
910-
inverseRate: 60000000 # 1 min, makes it 60 req/hour
911-
internalLimit:
912-
burst: 10
913-
inverseRate: 0 # No rate limiting for internal use
914-
ipv4CidrBlock: 32 # Only block individual IP addresses
915-
ipv6CidrBlock: 64 # Block /64 range at a time.
916-
ipAddressExceptions: []
917-
maxRateLimitedKeys: 100000 # Estimated memory usage: 4 MB
918-
```
919-
920-
The above are the default values.
921-
922-
The rate limiting happens using the [Token Bucket
923-
Algorithm](https://en.wikipedia.org/wiki/Token_bucket). The parameters can be
924-
separately configured for:
925-
1. IP Addresses to be used in case of unauthenticated requests using
926-
`ipAddrLimit`.
927-
2. Users and providers using `userLimit`.
928-
3. Internal usages (like calls from backoffice) using `internalLimit`.
929-
930-
The `ipAddressExceptions` have to be CIDR blocks which can be specified like
931-
`"127.0.0.0/8"` to allow any IP address from `127.0.0.0` to `127.255.255.255` to
932-
by pass the rate limits. To limit one particular IP address, it can be specified
933-
as `127.0.0.1/32`.
934-
935881
#### Disabling API versions
936882

937883
It is possible to disable one ore more API versions. When an API version is disabled it won’t be advertised on the `GET /api-version` endpoint, neither in the `supported`, nor in the `development` section. Requests made to any endpoint of a disabled API version will result in the same error response as a request made to an API version that does not exist.

0 commit comments

Comments
 (0)