mendersoftware / mender-server / 1956764459

66%

main: 74%

Build Type

Pull #833

gitlab-ci

Committed by alfrunes

Commit Message

feat(deviceauth): Add rate limiting configuration for authenticated requests

Added the following configuration parameters:

```yaml
ratelimits:
  # auth configures ratelimits for authenticated requests.
  auth:
    # enable rate limiting also requires redis_connection_string to be effective.
    enable: false
    # reject_unmatched rejects requests that does not resolve to a
    # ratelimit group. That is, if either there's no api_pattern matching
    # the request or if the group_expression does not match a group.
    # Defaults to false - disable ratelimiting for unmatched requests.
    reject_unmatched: false
    # groups specify rate limiting groups that overrides the parameters in the
    # default group.
    groups:
        # name defines the name of the group. The name is used in
        # match.group_expression to match an api_pattern with a group.
      - name: default
        # interval is the time interval when the rate limiter resets.
        interval: 1m
        # quota is the number of requests allowed in an interval.
        quota: 300
        # event_expression is a go template for grouping requests.
        # The following attributes are available in the context:
        # Identity - contains a subset of the JWT claims:
        # .Subject  (jwt:"sub")          string
        # .Tenant   (jwt:"mender.tenant") string
        # .Plan     (jwt:"mender.plan")   string
        # .Addons   (jwt:"mender.addons") []struct{Enabled bool; Name string}
        # .IsUser   (jwt:"mender.user")   bool
        # .IsDevice (jwt:"mender.device") bool
        # .Trial    (jwt:"mender.trial")  bool
        event_expression: "{{with .Identity}}{{.Subject}}{{end}}"
        # More example groups:
    # - name: "example_slow_group_by_tenant"
    #   quota: 1
    #   interval: 30s
    #   event_expression: "{{with .Identity}}{{.Tenant}}{{end}}"
    # match specifies matching expressions for mapping API requests to rate
    # limiting groups.
    match:
      ... (continued)

Pull Request Pull Request #833: Update ratelimits configuration interface

Run Details

30 of 46 new or added lines in 2 files covered. (65.22%)

4 existing lines in 2 files now uncovered.

32389 of 49407 relevant lines covered (65.56%)

1.39 hits per line