225 lines
10 KiB
Go
225 lines
10 KiB
Go
package ratelimits
|
|
|
|
import (
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/letsencrypt/boulder/config"
|
|
"github.com/letsencrypt/boulder/test"
|
|
)
|
|
|
|
// loadAndParseDefaultLimits is a helper that calls both loadDefaults and
|
|
// parseDefaultLimits to handle a YAML file.
|
|
//
|
|
// TODO(#7901): Update the tests to test these functions individually.
|
|
func loadAndParseDefaultLimits(path string) (limits, error) {
|
|
fromFile, err := loadDefaults(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return parseDefaultLimits(fromFile)
|
|
}
|
|
|
|
// loadAndParseOverrideLimits is a helper that calls both loadOverrides and
|
|
// parseOverrideLimits to handle a YAML file.
|
|
//
|
|
// TODO(#7901): Update the tests to test these functions individually.
|
|
func loadAndParseOverrideLimits(path string) (limits, error) {
|
|
fromFile, err := loadOverrides(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return parseOverrideLimits(fromFile)
|
|
}
|
|
|
|
func TestParseOverrideNameId(t *testing.T) {
|
|
// 'enum:ipv4'
|
|
// Valid IPv4 address.
|
|
name, id, err := parseOverrideNameId(NewRegistrationsPerIPAddress.String() + ":10.0.0.1")
|
|
test.AssertNotError(t, err, "should not error")
|
|
test.AssertEquals(t, name, NewRegistrationsPerIPAddress)
|
|
test.AssertEquals(t, id, "10.0.0.1")
|
|
|
|
// 'enum:ipv6range'
|
|
// Valid IPv6 address range.
|
|
name, id, err = parseOverrideNameId(NewRegistrationsPerIPv6Range.String() + ":2001:0db8:0000::/48")
|
|
test.AssertNotError(t, err, "should not error")
|
|
test.AssertEquals(t, name, NewRegistrationsPerIPv6Range)
|
|
test.AssertEquals(t, id, "2001:0db8:0000::/48")
|
|
|
|
// Missing colon (this should never happen but we should avoid panicking).
|
|
_, _, err = parseOverrideNameId(NewRegistrationsPerIPAddress.String() + "10.0.0.1")
|
|
test.AssertError(t, err, "missing colon")
|
|
|
|
// Empty string.
|
|
_, _, err = parseOverrideNameId("")
|
|
test.AssertError(t, err, "empty string")
|
|
|
|
// Only a colon.
|
|
_, _, err = parseOverrideNameId(NewRegistrationsPerIPAddress.String() + ":")
|
|
test.AssertError(t, err, "only a colon")
|
|
|
|
// Invalid enum.
|
|
_, _, err = parseOverrideNameId("lol:noexist")
|
|
test.AssertError(t, err, "invalid enum")
|
|
}
|
|
|
|
func TestValidateLimit(t *testing.T) {
|
|
err := validateLimit(&limit{burst: 1, count: 1, period: config.Duration{Duration: time.Second}})
|
|
test.AssertNotError(t, err, "valid limit")
|
|
|
|
// All of the following are invalid.
|
|
for _, l := range []*limit{
|
|
{burst: 0, count: 1, period: config.Duration{Duration: time.Second}},
|
|
{burst: 1, count: 0, period: config.Duration{Duration: time.Second}},
|
|
{burst: 1, count: 1, period: config.Duration{Duration: 0}},
|
|
} {
|
|
err = validateLimit(l)
|
|
test.AssertError(t, err, "limit should be invalid")
|
|
}
|
|
}
|
|
|
|
func TestLoadAndParseOverrideLimits(t *testing.T) {
|
|
// Load a single valid override limit with Id formatted as 'enum:RegId'.
|
|
l, err := loadAndParseOverrideLimits("testdata/working_override.yml")
|
|
test.AssertNotError(t, err, "valid single override limit")
|
|
expectKey := joinWithColon(NewRegistrationsPerIPAddress.EnumString(), "10.0.0.2")
|
|
test.AssertEquals(t, l[expectKey].burst, int64(40))
|
|
test.AssertEquals(t, l[expectKey].count, int64(40))
|
|
test.AssertEquals(t, l[expectKey].period.Duration, time.Second)
|
|
|
|
// Load single valid override limit with a 'domain' Id.
|
|
l, err = loadAndParseOverrideLimits("testdata/working_override_regid_domain.yml")
|
|
test.AssertNotError(t, err, "valid single override limit with Id of regId:domain")
|
|
expectKey = joinWithColon(CertificatesPerDomain.EnumString(), "example.com")
|
|
test.AssertEquals(t, l[expectKey].burst, int64(40))
|
|
test.AssertEquals(t, l[expectKey].count, int64(40))
|
|
test.AssertEquals(t, l[expectKey].period.Duration, time.Second)
|
|
|
|
// Load multiple valid override limits with 'regId' Ids.
|
|
l, err = loadAndParseOverrideLimits("testdata/working_overrides.yml")
|
|
test.AssertNotError(t, err, "multiple valid override limits")
|
|
expectKey1 := joinWithColon(NewRegistrationsPerIPAddress.EnumString(), "10.0.0.2")
|
|
test.AssertEquals(t, l[expectKey1].burst, int64(40))
|
|
test.AssertEquals(t, l[expectKey1].count, int64(40))
|
|
test.AssertEquals(t, l[expectKey1].period.Duration, time.Second)
|
|
expectKey2 := joinWithColon(NewRegistrationsPerIPv6Range.EnumString(), "2001:0db8:0000::/48")
|
|
test.AssertEquals(t, l[expectKey2].burst, int64(50))
|
|
test.AssertEquals(t, l[expectKey2].count, int64(50))
|
|
test.AssertEquals(t, l[expectKey2].period.Duration, time.Second*2)
|
|
|
|
// Load multiple valid override limits with 'fqdnSet' Ids, as follows:
|
|
// - CertificatesPerFQDNSet:example.com
|
|
// - CertificatesPerFQDNSet:example.com,example.net
|
|
// - CertificatesPerFQDNSet:example.com,example.net,example.org
|
|
firstEntryKey, err := newFQDNSetBucketKey(CertificatesPerFQDNSet, []string{"example.com"})
|
|
test.AssertNotError(t, err, "valid fqdnSet with one domain should not fail")
|
|
secondEntryKey, err := newFQDNSetBucketKey(CertificatesPerFQDNSet, []string{"example.com", "example.net"})
|
|
test.AssertNotError(t, err, "valid fqdnSet with two domains should not fail")
|
|
thirdEntryKey, err := newFQDNSetBucketKey(CertificatesPerFQDNSet, []string{"example.com", "example.net", "example.org"})
|
|
test.AssertNotError(t, err, "valid fqdnSet with three domains should not fail")
|
|
l, err = loadAndParseOverrideLimits("testdata/working_overrides_regid_fqdnset.yml")
|
|
test.AssertNotError(t, err, "multiple valid override limits with 'fqdnSet' Ids")
|
|
test.AssertEquals(t, l[firstEntryKey].burst, int64(40))
|
|
test.AssertEquals(t, l[firstEntryKey].count, int64(40))
|
|
test.AssertEquals(t, l[firstEntryKey].period.Duration, time.Second)
|
|
test.AssertEquals(t, l[secondEntryKey].burst, int64(50))
|
|
test.AssertEquals(t, l[secondEntryKey].count, int64(50))
|
|
test.AssertEquals(t, l[secondEntryKey].period.Duration, time.Second*2)
|
|
test.AssertEquals(t, l[thirdEntryKey].burst, int64(60))
|
|
test.AssertEquals(t, l[thirdEntryKey].count, int64(60))
|
|
test.AssertEquals(t, l[thirdEntryKey].period.Duration, time.Second*3)
|
|
|
|
// Path is empty string.
|
|
_, err = loadAndParseOverrideLimits("")
|
|
test.AssertError(t, err, "path is empty string")
|
|
test.Assert(t, os.IsNotExist(err), "path is empty string")
|
|
|
|
// Path to file which does not exist.
|
|
_, err = loadAndParseOverrideLimits("testdata/file_does_not_exist.yml")
|
|
test.AssertError(t, err, "a file that does not exist ")
|
|
test.Assert(t, os.IsNotExist(err), "test file should not exist")
|
|
|
|
// Burst cannot be 0.
|
|
_, err = loadAndParseOverrideLimits("testdata/busted_override_burst_0.yml")
|
|
test.AssertError(t, err, "single override limit with burst=0")
|
|
test.AssertContains(t, err.Error(), "invalid burst")
|
|
|
|
// Id cannot be empty.
|
|
_, err = loadAndParseOverrideLimits("testdata/busted_override_empty_id.yml")
|
|
test.AssertError(t, err, "single override limit with empty id")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
|
|
// Name cannot be empty.
|
|
_, err = loadAndParseOverrideLimits("testdata/busted_override_empty_name.yml")
|
|
test.AssertError(t, err, "single override limit with empty name")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
|
|
// Name must be a string representation of a valid Name enumeration.
|
|
_, err = loadAndParseOverrideLimits("testdata/busted_override_invalid_name.yml")
|
|
test.AssertError(t, err, "single override limit with invalid name")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
|
|
// Multiple entries, second entry has a bad name.
|
|
_, err = loadAndParseOverrideLimits("testdata/busted_overrides_second_entry_bad_name.yml")
|
|
test.AssertError(t, err, "multiple override limits, second entry is bad")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
|
|
// Multiple entries, third entry has id of "lol", instead of an IPv4 address.
|
|
_, err = loadAndParseOverrideLimits("testdata/busted_overrides_third_entry_bad_id.yml")
|
|
test.AssertError(t, err, "multiple override limits, third entry has bad Id value")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
}
|
|
|
|
func TestLoadAndParseDefaultLimits(t *testing.T) {
|
|
// Load a single valid default limit.
|
|
l, err := loadAndParseDefaultLimits("testdata/working_default.yml")
|
|
test.AssertNotError(t, err, "valid single default limit")
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPAddress.EnumString()].burst, int64(20))
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPAddress.EnumString()].count, int64(20))
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPAddress.EnumString()].period.Duration, time.Second)
|
|
|
|
// Load multiple valid default limits.
|
|
l, err = loadAndParseDefaultLimits("testdata/working_defaults.yml")
|
|
test.AssertNotError(t, err, "multiple valid default limits")
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPAddress.EnumString()].burst, int64(20))
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPAddress.EnumString()].count, int64(20))
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPAddress.EnumString()].period.Duration, time.Second)
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPv6Range.EnumString()].burst, int64(30))
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPv6Range.EnumString()].count, int64(30))
|
|
test.AssertEquals(t, l[NewRegistrationsPerIPv6Range.EnumString()].period.Duration, time.Second*2)
|
|
|
|
// Path is empty string.
|
|
_, err = loadAndParseDefaultLimits("")
|
|
test.AssertError(t, err, "path is empty string")
|
|
test.Assert(t, os.IsNotExist(err), "path is empty string")
|
|
|
|
// Path to file which does not exist.
|
|
_, err = loadAndParseDefaultLimits("testdata/file_does_not_exist.yml")
|
|
test.AssertError(t, err, "a file that does not exist")
|
|
test.Assert(t, os.IsNotExist(err), "test file should not exist")
|
|
|
|
// Burst cannot be 0.
|
|
_, err = loadAndParseDefaultLimits("testdata/busted_default_burst_0.yml")
|
|
test.AssertError(t, err, "single default limit with burst=0")
|
|
test.AssertContains(t, err.Error(), "invalid burst")
|
|
|
|
// Name cannot be empty.
|
|
_, err = loadAndParseDefaultLimits("testdata/busted_default_empty_name.yml")
|
|
test.AssertError(t, err, "single default limit with empty name")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
|
|
// Name must be a string representation of a valid Name enumeration.
|
|
_, err = loadAndParseDefaultLimits("testdata/busted_default_invalid_name.yml")
|
|
test.AssertError(t, err, "single default limit with invalid name")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
|
|
// Multiple entries, second entry has a bad name.
|
|
_, err = loadAndParseDefaultLimits("testdata/busted_defaults_second_entry_bad_name.yml")
|
|
test.AssertError(t, err, "multiple default limits, one is bad")
|
|
test.Assert(t, !os.IsNotExist(err), "test file should exist")
|
|
}
|