mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2025-10-29 04:02:25 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

invert reject / allow to make default more sensible

Browse source
This commit is contained in:
tobi 2025-09-16 15:58:54 +02:00
commit 220b17e2f8
7 changed files with 40 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/configuration/instance.md
View file

@ -230,14 +230,14 @@ instance-stats-mode: ""
# Default: true # Default: true
instance-allow-backdating-statuses: true instance-allow-backdating-statuses: true
# Bool. If set to true, then any HTTP requests coming into the instance, # Bool. If set to false (default), then any HTTP requests coming into the
# whether by client, web browser, or server-to-server requests, will be # instance, whether by client, web browser, or server-to-server requests,
# rejected if they do not identify themselves by setting a value on the # will be rejected if they do not identify themselves by setting a value
# request's User-Agent header. Since almost all HTTP clients provide # in the User-Agent header. Since almost all HTTP clients provide *something*
# *something* as a User-Agent value, leaving this set to "true" will # as a User-Agent value, leaving this set to false will likely not cause
# likely not cause issues, but you can turn it off if necessary. # issues, but you can set it to true if it's necessary for some clients.
# #
# Options: [true, false] # Options: [true, false]
# Default: true # Default: false
instance-reject-empty-user-agents: true instance-allow-empty-user-agents: false
``` ```

16
example/config.yaml
View file

@ -529,16 +529,16 @@ instance-stats-mode: ""
# Default: true # Default: true
instance-allow-backdating-statuses: true instance-allow-backdating-statuses: true
# Bool. If set to true, then any HTTP requests coming into the instance, # Bool. If set to false (default), then any HTTP requests coming into the
# whether by client, web browser, or server-to-server requests, will be # instance, whether by client, web browser, or server-to-server requests,
# rejected if they do not identify themselves by setting a value on the # will be rejected if they do not identify themselves by setting a value
# request's User-Agent header. Since almost all HTTP clients provide # in the User-Agent header. Since almost all HTTP clients provide *something*
# *something* as a User-Agent value, leaving this set to "true" will # as a User-Agent value, leaving this set to "false" will likely not cause
# likely not cause issues, but you can turn it off if necessary. # issues, but you can set it to "true" if necessary for some clients.
# #
# Options: [true, false] # Options: [true, false]
# Default: true # Default: false
instance-reject-empty-user-agents: true instance-allow-empty-user-agents: false
########################### ###########################
##### ACCOUNTS CONFIG ##### ##### ACCOUNTS CONFIG #####

2
internal/config/config.go
View file

@ -105,7 +105,7 @@ type Configuration struct {
InstanceSubscriptionsProcessEvery time.Duration `name:"instance-subscriptions-process-every" usage:"Period to elapse between instance subscriptions processing jobs, starting from instance-subscriptions-process-from."` InstanceSubscriptionsProcessEvery time.Duration `name:"instance-subscriptions-process-every" usage:"Period to elapse between instance subscriptions processing jobs, starting from instance-subscriptions-process-from."`
InstanceStatsMode string `name:"instance-stats-mode" usage:"Allows you to customize the way stats are served to crawlers: one of '', 'serve', 'zero', 'baffle'. Home page stats remain unchanged."` InstanceStatsMode string `name:"instance-stats-mode" usage:"Allows you to customize the way stats are served to crawlers: one of '', 'serve', 'zero', 'baffle'. Home page stats remain unchanged."`
InstanceAllowBackdatingStatuses bool `name:"instance-allow-backdating-statuses" usage:"Allow local accounts to backdate statuses using the scheduled_at param to /api/v1/statuses"` InstanceAllowBackdatingStatuses bool `name:"instance-allow-backdating-statuses" usage:"Allow local accounts to backdate statuses using the scheduled_at param to /api/v1/statuses"`
InstanceRejectEmptyUserAgents bool `name:"instance-reject-empty-user-agents" usage:"Reject all incoming HTTP requests that do not have a User-Agent header set"` InstanceAllowEmptyUserAgents bool `name:"instance-allow-empty-user-agents" usage:"Allow incoming HTTP requests that do not have a User-Agent header set"`
AccountsRegistrationOpen bool `name:"accounts-registration-open" usage:"Allow anyone to submit an account signup request. If false, server will be invite-only."` AccountsRegistrationOpen bool `name:"accounts-registration-open" usage:"Allow anyone to submit an account signup request. If false, server will be invite-only."`
AccountsReasonRequired bool `name:"accounts-reason-required" usage:"Do new account signups require a reason to be submitted on registration?"` AccountsReasonRequired bool `name:"accounts-reason-required" usage:"Do new account signups require a reason to be submitted on registration?"`

32
internal/config/helpers.gen.go
View file

@ -77,7 +77,7 @@ const (
InstanceSubscriptionsProcessEveryFlag = "instance-subscriptions-process-every" InstanceSubscriptionsProcessEveryFlag = "instance-subscriptions-process-every"
InstanceStatsModeFlag = "instance-stats-mode" InstanceStatsModeFlag = "instance-stats-mode"
InstanceAllowBackdatingStatusesFlag = "instance-allow-backdating-statuses" InstanceAllowBackdatingStatusesFlag = "instance-allow-backdating-statuses"
InstanceRejectEmptyUserAgentsFlag = "instance-reject-empty-user-agents" InstanceAllowEmptyUserAgentsFlag = "instance-allow-empty-user-agents"
AccountsRegistrationOpenFlag = "accounts-registration-open" AccountsRegistrationOpenFlag = "accounts-registration-open"
AccountsReasonRequiredFlag = "accounts-reason-required" AccountsReasonRequiredFlag = "accounts-reason-required"
AccountsRegistrationDailyLimitFlag = "accounts-registration-daily-limit" AccountsRegistrationDailyLimitFlag = "accounts-registration-daily-limit"
@ -278,7 +278,7 @@ func (cfg *Configuration) RegisterFlags(flags *pflag.FlagSet) {
flags.Duration("instance-subscriptions-process-every", cfg.InstanceSubscriptionsProcessEvery, "Period to elapse between instance subscriptions processing jobs, starting from instance-subscriptions-process-from.") flags.Duration("instance-subscriptions-process-every", cfg.InstanceSubscriptionsProcessEvery, "Period to elapse between instance subscriptions processing jobs, starting from instance-subscriptions-process-from.")
flags.String("instance-stats-mode", cfg.InstanceStatsMode, "Allows you to customize the way stats are served to crawlers: one of '', 'serve', 'zero', 'baffle'. Home page stats remain unchanged.") flags.String("instance-stats-mode", cfg.InstanceStatsMode, "Allows you to customize the way stats are served to crawlers: one of '', 'serve', 'zero', 'baffle'. Home page stats remain unchanged.")
flags.Bool("instance-allow-backdating-statuses", cfg.InstanceAllowBackdatingStatuses, "Allow local accounts to backdate statuses using the scheduled_at param to /api/v1/statuses") flags.Bool("instance-allow-backdating-statuses", cfg.InstanceAllowBackdatingStatuses, "Allow local accounts to backdate statuses using the scheduled_at param to /api/v1/statuses")
flags.Bool("instance-reject-empty-user-agents", cfg.InstanceRejectEmptyUserAgents, "Reject all incoming HTTP requests that do not have a User-Agent header set") flags.Bool("instance-allow-empty-user-agents", cfg.InstanceAllowEmptyUserAgents, "Allow incoming HTTP requests that do not have a User-Agent header set")
flags.Bool("accounts-registration-open", cfg.AccountsRegistrationOpen, "Allow anyone to submit an account signup request. If false, server will be invite-only.") flags.Bool("accounts-registration-open", cfg.AccountsRegistrationOpen, "Allow anyone to submit an account signup request. If false, server will be invite-only.")
flags.Bool("accounts-reason-required", cfg.AccountsReasonRequired, "Do new account signups require a reason to be submitted on registration?") flags.Bool("accounts-reason-required", cfg.AccountsReasonRequired, "Do new account signups require a reason to be submitted on registration?")
flags.Int("accounts-registration-daily-limit", cfg.AccountsRegistrationDailyLimit, "Limit amount of approved account sign-ups allowed per 24hrs before registration is closed. 0 or less = no limit.") flags.Int("accounts-registration-daily-limit", cfg.AccountsRegistrationDailyLimit, "Limit amount of approved account sign-ups allowed per 24hrs before registration is closed. 0 or less = no limit.")
@ -471,7 +471,7 @@ func (cfg *Configuration) MarshalMap() map[string]any {
cfgmap["instance-subscriptions-process-every"] = cfg.InstanceSubscriptionsProcessEvery cfgmap["instance-subscriptions-process-every"] = cfg.InstanceSubscriptionsProcessEvery
cfgmap["instance-stats-mode"] = cfg.InstanceStatsMode cfgmap["instance-stats-mode"] = cfg.InstanceStatsMode
cfgmap["instance-allow-backdating-statuses"] = cfg.InstanceAllowBackdatingStatuses cfgmap["instance-allow-backdating-statuses"] = cfg.InstanceAllowBackdatingStatuses
cfgmap["instance-reject-empty-user-agents"] = cfg.InstanceRejectEmptyUserAgents cfgmap["instance-allow-empty-user-agents"] = cfg.InstanceAllowEmptyUserAgents
cfgmap["accounts-registration-open"] = cfg.AccountsRegistrationOpen cfgmap["accounts-registration-open"] = cfg.AccountsRegistrationOpen
cfgmap["accounts-reason-required"] = cfg.AccountsReasonRequired cfgmap["accounts-reason-required"] = cfg.AccountsReasonRequired
cfgmap["accounts-registration-daily-limit"] = cfg.AccountsRegistrationDailyLimit cfgmap["accounts-registration-daily-limit"] = cfg.AccountsRegistrationDailyLimit
@ -1022,11 +1022,11 @@ func (cfg *Configuration) UnmarshalMap(cfgmap map[string]any) error {
} }
} }
if ival, ok := cfgmap["instance-reject-empty-user-agents"]; ok { if ival, ok := cfgmap["instance-allow-empty-user-agents"]; ok {
var err error var err error
cfg.InstanceRejectEmptyUserAgents, err = cast.ToBoolE(ival) cfg.InstanceAllowEmptyUserAgents, err = cast.ToBoolE(ival)
if err != nil { if err != nil {
return fmt.Errorf("error casting %#v -> bool for 'instance-reject-empty-user-agents': %w", ival, err) return fmt.Errorf("error casting %#v -> bool for 'instance-allow-empty-user-agents': %w", ival, err)
} }
} }
@ -3313,27 +3313,27 @@ func GetInstanceAllowBackdatingStatuses() bool { return global.GetInstanceAllowB
// SetInstanceAllowBackdatingStatuses safely sets the value for global configuration 'InstanceAllowBackdatingStatuses' field // SetInstanceAllowBackdatingStatuses safely sets the value for global configuration 'InstanceAllowBackdatingStatuses' field
func SetInstanceAllowBackdatingStatuses(v bool) { global.SetInstanceAllowBackdatingStatuses(v) } func SetInstanceAllowBackdatingStatuses(v bool) { global.SetInstanceAllowBackdatingStatuses(v) }
// GetInstanceRejectEmptyUserAgents safely fetches the Configuration value for state's 'InstanceRejectEmptyUserAgents' field // GetInstanceAllowEmptyUserAgents safely fetches the Configuration value for state's 'InstanceAllowEmptyUserAgents' field
func (st *ConfigState) GetInstanceRejectEmptyUserAgents() (v bool) { func (st *ConfigState) GetInstanceAllowEmptyUserAgents() (v bool) {
st.mutex.RLock() st.mutex.RLock()
v = st.config.InstanceRejectEmptyUserAgents v = st.config.InstanceAllowEmptyUserAgents
st.mutex.RUnlock() st.mutex.RUnlock()
return return
} }
// SetInstanceRejectEmptyUserAgents safely sets the Configuration value for state's 'InstanceRejectEmptyUserAgents' field // SetInstanceAllowEmptyUserAgents safely sets the Configuration value for state's 'InstanceAllowEmptyUserAgents' field
func (st *ConfigState) SetInstanceRejectEmptyUserAgents(v bool) { func (st *ConfigState) SetInstanceAllowEmptyUserAgents(v bool) {
st.mutex.Lock() st.mutex.Lock()
defer st.mutex.Unlock() defer st.mutex.Unlock()
st.config.InstanceRejectEmptyUserAgents = v st.config.InstanceAllowEmptyUserAgents = v
st.reloadToViper() st.reloadToViper()
} }
// GetInstanceRejectEmptyUserAgents safely fetches the value for global configuration 'InstanceRejectEmptyUserAgents' field // GetInstanceAllowEmptyUserAgents safely fetches the value for global configuration 'InstanceAllowEmptyUserAgents' field
func GetInstanceRejectEmptyUserAgents() bool { return global.GetInstanceRejectEmptyUserAgents() } func GetInstanceAllowEmptyUserAgents() bool { return global.GetInstanceAllowEmptyUserAgents() }
// SetInstanceRejectEmptyUserAgents safely sets the value for global configuration 'InstanceRejectEmptyUserAgents' field // SetInstanceAllowEmptyUserAgents safely sets the value for global configuration 'InstanceAllowEmptyUserAgents' field
func SetInstanceRejectEmptyUserAgents(v bool) { global.SetInstanceRejectEmptyUserAgents(v) } func SetInstanceAllowEmptyUserAgents(v bool) { global.SetInstanceAllowEmptyUserAgents(v) }
// GetAccountsRegistrationOpen safely fetches the Configuration value for state's 'AccountsRegistrationOpen' field // GetAccountsRegistrationOpen safely fetches the Configuration value for state's 'AccountsRegistrationOpen' field
func (st *ConfigState) GetAccountsRegistrationOpen() (v bool) { func (st *ConfigState) GetAccountsRegistrationOpen() (v bool) {

8
internal/middleware/useragent.go
View file

@ -30,8 +30,8 @@ import (
// which aborts requests with empty user agent // which aborts requests with empty user agent
// strings, returning code 418 - I'm a teapot. // strings, returning code 418 - I'm a teapot.
// //
// If `instance-reject-empty-user-agents` is // If `instance-allow-empty-user-agents` is
// false, it just logs a debug msg instead. // true, it logs a debug msg instead of aborting.
func UserAgentOrTeapot() gin.HandlerFunc { func UserAgentOrTeapot() gin.HandlerFunc {
// Build variables outside the handler // Build variables outside the handler
@ -39,7 +39,7 @@ func UserAgentOrTeapot() gin.HandlerFunc {
// time a request is processed. // time a request is processed.
var ( var (
rsp = []byte(`{"error": "I'm a teapot: no user-agent sent with request"}`) rsp = []byte(`{"error": "I'm a teapot: no user-agent sent with request"}`)
rejectEmpty = config.GetInstanceRejectEmptyUserAgents() allowEmpty = config.GetInstanceAllowEmptyUserAgents()
) )
return func(c *gin.Context) { return func(c *gin.Context) {
@ -49,7 +49,7 @@ func UserAgentOrTeapot() gin.HandlerFunc {
return return
} }
if !rejectEmpty { if allowEmpty {
// No user-agent was // No user-agent was
// set but that's OK. // set but that's OK.
log.Debugf( log.Debugf(

4
test/envparsing.sh
View file

@ -112,6 +112,7 @@ EXPECT=$(cat << "EOF"
"http-client-timeout": 30000000000, "http-client-timeout": 30000000000,
"http-client-tls-insecure-skip-verify": false, "http-client-tls-insecure-skip-verify": false,
"instance-allow-backdating-statuses": true, "instance-allow-backdating-statuses": true,
"instance-allow-empty-user-agents": true,
"instance-deliver-to-shared-inboxes": false, "instance-deliver-to-shared-inboxes": false,
"instance-expose-allowlist": true, "instance-expose-allowlist": true,
"instance-expose-allowlist-web": true, "instance-expose-allowlist-web": true,
@ -127,7 +128,6 @@ EXPECT=$(cat << "EOF"
"nl", "nl",
"en-GB" "en-GB"
], ],
"instance-reject-empty-user-agents": false,
"instance-stats-mode": "baffle", "instance-stats-mode": "baffle",
"instance-subscriptions-process-every": 86400000000000, "instance-subscriptions-process-every": 86400000000000,
"instance-subscriptions-process-from": "23:00", "instance-subscriptions-process-from": "23:00",
@ -253,6 +253,7 @@ GTS_TLS_MODE='' \
GTS_DB_TLS_CA_CERT='' \ GTS_DB_TLS_CA_CERT='' \
GTS_WEB_TEMPLATE_BASE_DIR='/root' \ GTS_WEB_TEMPLATE_BASE_DIR='/root' \
GTS_WEB_ASSET_BASE_DIR='/root' \ GTS_WEB_ASSET_BASE_DIR='/root' \
GTS_INSTANCE_ALLOW_EMPTY_USER_AGENTS="true" \
GTS_INSTANCE_EXPOSE_PEERS=true \ GTS_INSTANCE_EXPOSE_PEERS=true \
GTS_INSTANCE_EXPOSE_BLOCKLIST=true \ GTS_INSTANCE_EXPOSE_BLOCKLIST=true \
GTS_INSTANCE_EXPOSE_BLOCKLIST_WEB=true \ GTS_INSTANCE_EXPOSE_BLOCKLIST_WEB=true \
@ -265,7 +266,6 @@ GTS_INSTANCE_FEDERATION_SPAM_FILTER=true \
GTS_INSTANCE_DELIVER_TO_SHARED_INBOXES=false \ GTS_INSTANCE_DELIVER_TO_SHARED_INBOXES=false \
GTS_INSTANCE_INJECT_MASTODON_VERSION=true \ GTS_INSTANCE_INJECT_MASTODON_VERSION=true \
GTS_INSTANCE_LANGUAGES="nl,en-gb" \ GTS_INSTANCE_LANGUAGES="nl,en-gb" \
GTS_INSTANCE_REJECT_EMPTY_USER_AGENTS="false" \
GTS_INSTANCE_STATS_MODE="baffle" \ GTS_INSTANCE_STATS_MODE="baffle" \
GTS_ACCOUNTS_ALLOW_CUSTOM_CSS=true \ GTS_ACCOUNTS_ALLOW_CUSTOM_CSS=true \
GTS_ACCOUNTS_CUSTOM_CSS_LENGTH=5000 \ GTS_ACCOUNTS_CUSTOM_CSS_LENGTH=5000 \

2
testrig/config.go
View file

@ -107,7 +107,7 @@ func testDefaults() config.Configuration {
InstanceSubscriptionsProcessFrom: "23:00", // 11pm, InstanceSubscriptionsProcessFrom: "23:00", // 11pm,
InstanceSubscriptionsProcessEvery: 24 * time.Hour, // 1/day. InstanceSubscriptionsProcessEvery: 24 * time.Hour, // 1/day.
InstanceAllowBackdatingStatuses: true, InstanceAllowBackdatingStatuses: true,
InstanceRejectEmptyUserAgents: false, InstanceAllowEmptyUserAgents: true,
AccountsRegistrationOpen: true, AccountsRegistrationOpen: true,
AccountsReasonRequired: true, AccountsReasonRequired: true,