1258 lines
46 KiB
Diff
1258 lines
46 KiB
Diff
diff --git a/example/config.yaml b/example/config.yaml
|
|
index 2b3a873fb..52615a345 100644
|
|
--- a/example/config.yaml
|
|
+++ b/example/config.yaml
|
|
@@ -105,13 +105,13 @@ account-domain: ""
|
|
protocol: "https"
|
|
|
|
# String. Address to bind the GoToSocial server to.
|
|
-# This can be an IPv4 address or an IPv6 address (surrounded in square brackets), or a hostname.
|
|
+# This can be an IPv4 address or an IPv6 address (surrounded in square brackets), or a hostname or unix socket
|
|
# The default value will bind to all interfaces, which makes the server
|
|
# accessible by other machines. For most setups there is no need to change this.
|
|
# If you are using GoToSocial in a reverse proxy setup with the proxy running on
|
|
# the same machine, you will want to set this to "localhost" or an equivalent,
|
|
# so that the proxy can't be bypassed.
|
|
-# Examples: ["0.0.0.0", "172.128.0.16", "localhost", "[::]", "[2001:db8::fed1]"]
|
|
+# Examples: ["0.0.0.0", "172.128.0.16", "localhost", "[::]", "[2001:db8::fed1]", "unix//run/gts/sock]
|
|
# Default: "0.0.0.0"
|
|
bind-address: "0.0.0.0"
|
|
|
|
@@ -124,6 +124,13 @@ bind-address: "0.0.0.0"
|
|
# Default: 8080
|
|
port: 8080
|
|
|
|
+# String, HTTP header name that contains the client ip
|
|
+# Reverse proxy may need to be configured to set this header
|
|
+# This setting is required when using unix socket as bind address as there is no other way to get client ip for rate limiting
|
|
+# Examples: ["X-Client-IP","X-CDN-Client-IP"]
|
|
+# Default: ""
|
|
+trusted-platform: ""
|
|
+
|
|
# Array of string. CIDRs or IP addresses of proxies that should be trusted when determining real client IP from behind a reverse proxy.
|
|
# If you're running inside a Docker container behind Traefik or Nginx, for example, add the subnet of your docker network,
|
|
# or the gateway of the docker network, and/or the address of the reverse proxy (if it's not running on the host network).
|
|
@@ -155,7 +162,7 @@ db-type: "postgres"
|
|
# If address is set to :memory: then an in-memory database will be used (no file).
|
|
# WARNING: :memory: should NOT BE USED except for testing purposes.
|
|
#
|
|
-# Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:", "sqlite.db"]
|
|
+# Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:", "sqlite.db", "/run/postgresql/"]
|
|
# Default: ""
|
|
db-address: ""
|
|
|
|
diff --git a/go.mod b/go.mod
|
|
index 7d15b19dd..beb7b0235 100644
|
|
--- a/go.mod
|
|
+++ b/go.mod
|
|
@@ -72,6 +72,7 @@ require (
|
|
github.com/uptrace/bun/extra/bunotel v1.2.11
|
|
github.com/wagslane/go-password-validator v0.3.0
|
|
github.com/yuin/goldmark v1.7.8
|
|
+ go.balki.me/anyhttp v0.5.0
|
|
go.opentelemetry.io/otel v1.34.0
|
|
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.34.0
|
|
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.34.0
|
|
diff --git a/go.sum b/go.sum
|
|
index 24176856b..a9680692a 100644
|
|
--- a/go.sum
|
|
+++ b/go.sum
|
|
@@ -620,6 +620,8 @@ github.com/yuin/goldmark v1.7.8 h1:iERMLn0/QJeHFhxSt3p6PeN9mGnvIKSpG9YYorDMnic=
|
|
github.com/yuin/goldmark v1.7.8/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
|
|
gitlab.com/NyaaaWhatsUpDoc/sqlite v1.35.0-concurrency-workaround h1:rSPHdoNXzXyWQUUeMEy8pdOFn8lH7XqdBRTS9G+jdTg=
|
|
gitlab.com/NyaaaWhatsUpDoc/sqlite v1.35.0-concurrency-workaround/go.mod h1:9cr2sicr7jIaWTBKQmAxQLfBv9LL0su4ZTEV+utt3ic=
|
|
+go.balki.me/anyhttp v0.5.0 h1:uys0oRciBpZfwtxXAevScKy6amIQBXyDrcV0EtGF5zo=
|
|
+go.balki.me/anyhttp v0.5.0/go.mod h1:JhfekOIjgVODoVqUCficjpIgmB3wwlB7jhN0eN2EZ/s=
|
|
go.mongodb.org/mongo-driver v1.14.0 h1:P98w8egYRjYe3XDjxhYJagTokP/H6HzlsnojRgZRd80=
|
|
go.mongodb.org/mongo-driver v1.14.0/go.mod h1:Vzb0Mk/pa7e6cWw85R4F/endUC3u0U9jGcNU603k65c=
|
|
go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
|
|
diff --git a/internal/config/config.go b/internal/config/config.go
|
|
index 8ce2105b4..93ad8d7b0 100644
|
|
--- a/internal/config/config.go
|
|
+++ b/internal/config/config.go
|
|
@@ -59,6 +59,7 @@ type Configuration struct {
|
|
BindAddress string `name:"bind-address" usage:"Bind address to use for the GoToSocial server (eg., 0.0.0.0, 172.138.0.9, [::], localhost). For ipv6, enclose the address in square brackets, eg [2001:db8::fed1]. Default binds to all interfaces."`
|
|
Port int `name:"port" usage:"Port to use for GoToSocial. Change this to 443 if you're running the binary directly on the host machine."`
|
|
TrustedProxies []string `name:"trusted-proxies" usage:"Proxies to trust when parsing x-forwarded headers into real IPs."`
|
|
+ TrustedPlatform string `name:"trusted-platform" usage:"HTTP header that contains the real client ip"`
|
|
SoftwareVersion string `name:"software-version" usage:""`
|
|
|
|
DbType string `name:"db-type" usage:"Database type: eg., postgres"`
|
|
@@ -194,6 +195,8 @@ type Configuration struct {
|
|
AdminMediaListRemoteOnly bool `name:"remote-only" usage:"list only remote attachments/emojis; if specified then local-only cannot also be true"`
|
|
|
|
RequestIDHeader string `name:"request-id-header" usage:"Header to extract the Request ID from. Eg.,'X-Request-Id'."`
|
|
+
|
|
+ KalaclistaAllowedUnauthorizedGet bool `name:"kalaclista-allowed-unauthorized-get" usage:"unlock AUTHOZIED_FETCH (aka Secure mode in Mastodon) mode."`
|
|
}
|
|
|
|
type HTTPClientConfiguration struct {
|
|
diff --git a/internal/config/defaults.go b/internal/config/defaults.go
|
|
index 78a8230d5..b8b2ff5f2 100644
|
|
--- a/internal/config/defaults.go
|
|
+++ b/internal/config/defaults.go
|
|
@@ -233,4 +233,6 @@
|
|
RequestIDHeader: "X-Request-Id",
|
|
|
|
LogClientIP: true,
|
|
+
|
|
+ KalaclistaAllowedUnauthorizedGet: false,
|
|
}
|
|
diff --git a/internal/config/helpers.gen.go b/internal/config/helpers.gen.go
|
|
index 156c19fd5..ab12c44be 100644
|
|
--- a/internal/config/helpers.gen.go
|
|
+++ b/internal/config/helpers.gen.go
|
|
@@ -2,7 +2,7 @@
|
|
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
-//
|
|
+//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
@@ -351,6 +351,31 @@ func GetTrustedProxies() []string { return global.GetTrustedProxies() }
|
|
// SetTrustedProxies safely sets the value for global configuration 'TrustedProxies' field
|
|
func SetTrustedProxies(v []string) { global.SetTrustedProxies(v) }
|
|
|
|
+// GetTrustedPlatform safely fetches the Configuration value for state's 'TrustedPlatform' field
|
|
+func (st *ConfigState) GetTrustedPlatform() (v string) {
|
|
+ st.mutex.RLock()
|
|
+ v = st.config.TrustedPlatform
|
|
+ st.mutex.RUnlock()
|
|
+ return
|
|
+}
|
|
+
|
|
+// SetTrustedPlatform safely sets the Configuration value for state's 'TrustedPlatform' field
|
|
+func (st *ConfigState) SetTrustedPlatform(v string) {
|
|
+ st.mutex.Lock()
|
|
+ defer st.mutex.Unlock()
|
|
+ st.config.TrustedPlatform = v
|
|
+ st.reloadToViper()
|
|
+}
|
|
+
|
|
+// TrustedPlatformFlag returns the flag name for the 'TrustedPlatform' field
|
|
+func TrustedPlatformFlag() string { return "trusted-platform" }
|
|
+
|
|
+// GetTrustedPlatform safely fetches the value for global configuration 'TrustedPlatform' field
|
|
+func GetTrustedPlatform() string { return global.GetTrustedPlatform() }
|
|
+
|
|
+// SetTrustedPlatform safely sets the value for global configuration 'TrustedPlatform' field
|
|
+func SetTrustedPlatform(v string) { global.SetTrustedPlatform(v) }
|
|
+
|
|
// GetSoftwareVersion safely fetches the Configuration value for state's 'SoftwareVersion' field
|
|
func (st *ConfigState) GetSoftwareVersion() (v string) {
|
|
st.mutex.RLock()
|
|
@@ -3328,19 +3353,13 @@ func (st *ConfigState) SetCacheConversationLastStatusIDsMemRatio(v float64) {
|
|
}
|
|
|
|
// CacheConversationLastStatusIDsMemRatioFlag returns the flag name for the 'Cache.ConversationLastStatusIDsMemRatio' field
|
|
-func CacheConversationLastStatusIDsMemRatioFlag() string {
|
|
- return "cache-conversation-last-status-ids-mem-ratio"
|
|
-}
|
|
+func CacheConversationLastStatusIDsMemRatioFlag() string { return "cache-conversation-last-status-ids-mem-ratio" }
|
|
|
|
// GetCacheConversationLastStatusIDsMemRatio safely fetches the value for global configuration 'Cache.ConversationLastStatusIDsMemRatio' field
|
|
-func GetCacheConversationLastStatusIDsMemRatio() float64 {
|
|
- return global.GetCacheConversationLastStatusIDsMemRatio()
|
|
-}
|
|
+func GetCacheConversationLastStatusIDsMemRatio() float64 { return global.GetCacheConversationLastStatusIDsMemRatio() }
|
|
|
|
// SetCacheConversationLastStatusIDsMemRatio safely sets the value for global configuration 'Cache.ConversationLastStatusIDsMemRatio' field
|
|
-func SetCacheConversationLastStatusIDsMemRatio(v float64) {
|
|
- global.SetCacheConversationLastStatusIDsMemRatio(v)
|
|
-}
|
|
+func SetCacheConversationLastStatusIDsMemRatio(v float64) { global.SetCacheConversationLastStatusIDsMemRatio(v) }
|
|
|
|
// GetCacheDomainPermissionDraftMemRation safely fetches the Configuration value for state's 'Cache.DomainPermissionDraftMemRation' field
|
|
func (st *ConfigState) GetCacheDomainPermissionDraftMemRation() (v float64) {
|
|
@@ -4686,3 +4705,29 @@ func GetRequestIDHeader() string { return global.GetRequestIDHeader() }
|
|
|
|
// SetRequestIDHeader safely sets the value for global configuration 'RequestIDHeader' field
|
|
func SetRequestIDHeader(v string) { global.SetRequestIDHeader(v) }
|
|
+
|
|
+// GetKalaclistaAllowedUnauthorizedGet safely fetches the Configuration value for state's 'KalaclistaAllowedUnauthorizedGet' field
|
|
+func (st *ConfigState) GetKalaclistaAllowedUnauthorizedGet() (v bool) {
|
|
+ st.mutex.RLock()
|
|
+ v = st.config.KalaclistaAllowedUnauthorizedGet
|
|
+ st.mutex.RUnlock()
|
|
+ return
|
|
+}
|
|
+
|
|
+// SetKalaclistaAllowedUnauthorizedGet safely sets the Configuration value for state's 'KalaclistaAllowedUnauthorizedGet' field
|
|
+func (st *ConfigState) SetKalaclistaAllowedUnauthorizedGet(v bool) {
|
|
+ st.mutex.Lock()
|
|
+ defer st.mutex.Unlock()
|
|
+ st.config.KalaclistaAllowedUnauthorizedGet = v
|
|
+ st.reloadToViper()
|
|
+}
|
|
+
|
|
+// KalaclistaAllowedUnauthorizedGetFlag returns the flag name for the 'KalaclistaAllowedUnauthorizedGet' field
|
|
+func KalaclistaAllowedUnauthorizedGetFlag() string { return "kalaclista-allowed-unauthorized-get" }
|
|
+
|
|
+// GetKalaclistaAllowedUnauthorizedGet safely fetches the value for global configuration 'KalaclistaAllowedUnauthorizedGet' field
|
|
+func GetKalaclistaAllowedUnauthorizedGet() bool { return global.GetKalaclistaAllowedUnauthorizedGet() }
|
|
+
|
|
+// SetKalaclistaAllowedUnauthorizedGet safely sets the value for global configuration 'KalaclistaAllowedUnauthorizedGet' field
|
|
+func SetKalaclistaAllowedUnauthorizedGet(v bool) { global.SetKalaclistaAllowedUnauthorizedGet(v) }
|
|
+
|
|
diff --git a/internal/middleware/signaturecheck.go b/internal/middleware/signaturecheck.go
|
|
index ea63ec4f0..cb8b9df9a 100644
|
|
--- a/internal/middleware/signaturecheck.go
|
|
+++ b/internal/middleware/signaturecheck.go
|
|
@@ -33,7 +33,8 @@
|
|
sigHeader = string(httpsig.Signature)
|
|
authHeader = string(httpsig.Authorization)
|
|
// untyped error returned by httpsig when no signature is present
|
|
- noSigError = "neither \"" + sigHeader + "\" nor \"" + authHeader + "\" have signature parameters"
|
|
+ noSigError = "neither \"" + sigHeader + "\" nor \"" + authHeader + "\" have signature parameters"
|
|
+ bothSigError = "both \"" + sigHeader + "\" and \"" + authHeader + "\" have signature parameters"
|
|
)
|
|
|
|
// SignatureCheck returns a gin middleware for checking http signatures.
|
|
@@ -54,6 +55,12 @@ func SignatureCheck(uriBlocked func(context.Context, *url.URL) (bool, error)) fu
|
|
// Create the signature verifier from the request;
|
|
// this will error if the request wasn't signed.
|
|
verifier, err := httpsig.NewVerifier(c.Request)
|
|
+ if err != nil && err.Error() == bothSigError {
|
|
+ log.Debugf(ctx, "this request has both http signature headers, but fix it: %s", err)
|
|
+ c.Request.Header.Del(authHeader)
|
|
+ verifier, err = httpsig.NewVerifier(c.Request)
|
|
+ }
|
|
+
|
|
if err != nil {
|
|
// Only actually *abort* the request with 401
|
|
// if a signature was present but malformed.
|
|
diff --git a/internal/processing/fedi/common.go b/internal/processing/fedi/common.go
|
|
index 1a4d38bc1..1d62aacdb 100644
|
|
--- a/internal/processing/fedi/common.go
|
|
+++ b/internal/processing/fedi/common.go
|
|
@@ -20,8 +20,10 @@
|
|
import (
|
|
"context"
|
|
"errors"
|
|
+ "net/http"
|
|
"net/url"
|
|
|
|
+ "github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
@@ -51,6 +53,12 @@ func (p *Processor) authenticate(ctx context.Context, requestedUser string) (*co
|
|
// get requesting account, dereferencing if necessary.
|
|
pubKeyAuth, errWithCode := p.federator.AuthenticateFederatedRequest(ctx, requestedUser)
|
|
if errWithCode != nil {
|
|
+ if config.GetKalaclistaAllowedUnauthorizedGet() && errWithCode.Code() == http.StatusUnauthorized {
|
|
+ return &commonAuth{
|
|
+ receivingAcct: receiver,
|
|
+ }, nil
|
|
+ }
|
|
+
|
|
return nil, errWithCode
|
|
}
|
|
|
|
diff --git a/internal/processing/fedi/emoji.go b/internal/processing/fedi/emoji.go
|
|
index 9ac0ea244..446e496c0 100644
|
|
--- a/internal/processing/fedi/emoji.go
|
|
+++ b/internal/processing/fedi/emoji.go
|
|
@@ -20,15 +20,19 @@
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
+ "net/http"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/ap"
|
|
+ "github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
)
|
|
|
|
// EmojiGet handles the GET for a federated emoji originating from this instance.
|
|
func (p *Processor) EmojiGet(ctx context.Context, requestedEmojiID string) (interface{}, gtserror.WithCode) {
|
|
if _, errWithCode := p.federator.AuthenticateFederatedRequest(ctx, ""); errWithCode != nil {
|
|
- return nil, errWithCode
|
|
+ if !(config.GetKalaclistaAllowedUnauthorizedGet() && errWithCode.Code() == http.StatusUnauthorized) {
|
|
+ return nil, errWithCode
|
|
+ }
|
|
}
|
|
|
|
requestedEmoji, err := p.state.DB.GetEmojiByID(ctx, requestedEmojiID)
|
|
diff --git a/internal/processing/fedi/user.go b/internal/processing/fedi/user.go
|
|
index 79c1b4fdb..b980161c9 100644
|
|
--- a/internal/processing/fedi/user.go
|
|
+++ b/internal/processing/fedi/user.go
|
|
@@ -21,9 +21,11 @@
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
+ "net/http"
|
|
"net/url"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/ap"
|
|
+ "github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
"github.com/superseriousbusiness/gotosocial/internal/uris"
|
|
@@ -67,6 +69,16 @@ func (p *Processor) UserGet(ctx context.Context, requestedUsername string, reque
|
|
// we can serve a more complete profile.
|
|
pubKeyAuth, errWithCode := p.federator.AuthenticateFederatedRequest(ctx, requestedUsername)
|
|
if errWithCode != nil {
|
|
+ // kalaclista modded: unauthorized-fetch
|
|
+ if config.GetKalaclistaAllowedUnauthorizedGet() && errWithCode.Code() == http.StatusUnauthorized {
|
|
+ person, err := p.converter.AccountToAS(ctx, receiver)
|
|
+ if err != nil {
|
|
+ err := gtserror.Newf("error converting account: %w", err)
|
|
+ return nil, gtserror.NewErrorInternalError(err)
|
|
+ }
|
|
+ return data(person)
|
|
+ }
|
|
+
|
|
return nil, errWithCode // likely 401
|
|
}
|
|
|
|
diff --git a/internal/router/router.go b/internal/router/router.go
|
|
index c2bf18b4f..97ee65847 100644
|
|
--- a/internal/router/router.go
|
|
+++ b/internal/router/router.go
|
|
@@ -23,6 +23,7 @@
|
|
"fmt"
|
|
"net"
|
|
"net/http"
|
|
+ "strings"
|
|
"time"
|
|
|
|
"codeberg.org/gruf/go-bytesize"
|
|
@@ -31,6 +32,7 @@
|
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
"github.com/superseriousbusiness/gotosocial/internal/log"
|
|
+ "go.balki.me/anyhttp"
|
|
"golang.org/x/crypto/acme/autocert"
|
|
)
|
|
|
|
@@ -75,6 +77,11 @@ func New(ctx context.Context) (*Router, error) {
|
|
engine.MaxMultipartMemory = maxMultipartMemory
|
|
engine.HandleMethodNotAllowed = true
|
|
|
|
+ // Custom header set by trusted upstream
|
|
+ if tp := config.GetTrustedPlatform(); tp != "" {
|
|
+ engine.TrustedPlatform = tp
|
|
+ }
|
|
+
|
|
// Set up client IP forwarding via
|
|
// trusted x-forwarded-* headers.
|
|
trustedProxies := config.GetTrustedProxies()
|
|
@@ -135,6 +142,7 @@ func (r *Router) Start() error {
|
|
certFile = config.GetTLSCertificateChain()
|
|
keyFile = config.GetTLSCertificateKey()
|
|
leEnabled = config.GetLetsEncryptEnabled()
|
|
+ bindAddr = config.GetBindAddress()
|
|
)
|
|
|
|
switch {
|
|
@@ -155,6 +163,18 @@ func (r *Router) Start() error {
|
|
return err
|
|
}
|
|
|
|
+ // TLS handled by reverse proxy connecting using unix socket
|
|
+ case strings.HasPrefix(bindAddr, "unix?"):
|
|
+ listen, err = func() (func() error, error) {
|
|
+ listener, _, _, err := anyhttp.GetListener(bindAddr)
|
|
+ if err != nil {
|
|
+ return nil, err
|
|
+ }
|
|
+ return func() error {
|
|
+ return r.srv.Serve(listener)
|
|
+ }, nil
|
|
+ }()
|
|
+
|
|
// Default listen. TLS must
|
|
// be handled by reverse proxy.
|
|
default:
|
|
diff --git a/vendor/go.balki.me/anyhttp/LICENSE b/vendor/go.balki.me/anyhttp/LICENSE
|
|
new file mode 100644
|
|
index 000000000..ad2653ac1
|
|
--- /dev/null
|
|
+++ b/vendor/go.balki.me/anyhttp/LICENSE
|
|
@@ -0,0 +1,201 @@
|
|
+ Apache License
|
|
+ Version 2.0, January 2004
|
|
+ http://www.apache.org/licenses/
|
|
+
|
|
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
+
|
|
+ 1. Definitions.
|
|
+
|
|
+ "License" shall mean the terms and conditions for use, reproduction,
|
|
+ and distribution as defined by Sections 1 through 9 of this document.
|
|
+
|
|
+ "Licensor" shall mean the copyright owner or entity authorized by
|
|
+ the copyright owner that is granting the License.
|
|
+
|
|
+ "Legal Entity" shall mean the union of the acting entity and all
|
|
+ other entities that control, are controlled by, or are under common
|
|
+ control with that entity. For the purposes of this definition,
|
|
+ "control" means (i) the power, direct or indirect, to cause the
|
|
+ direction or management of such entity, whether by contract or
|
|
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
+ outstanding shares, or (iii) beneficial ownership of such entity.
|
|
+
|
|
+ "You" (or "Your") shall mean an individual or Legal Entity
|
|
+ exercising permissions granted by this License.
|
|
+
|
|
+ "Source" form shall mean the preferred form for making modifications,
|
|
+ including but not limited to software source code, documentation
|
|
+ source, and configuration files.
|
|
+
|
|
+ "Object" form shall mean any form resulting from mechanical
|
|
+ transformation or translation of a Source form, including but
|
|
+ not limited to compiled object code, generated documentation,
|
|
+ and conversions to other media types.
|
|
+
|
|
+ "Work" shall mean the work of authorship, whether in Source or
|
|
+ Object form, made available under the License, as indicated by a
|
|
+ copyright notice that is included in or attached to the work
|
|
+ (an example is provided in the Appendix below).
|
|
+
|
|
+ "Derivative Works" shall mean any work, whether in Source or Object
|
|
+ form, that is based on (or derived from) the Work and for which the
|
|
+ editorial revisions, annotations, elaborations, or other modifications
|
|
+ represent, as a whole, an original work of authorship. For the purposes
|
|
+ of this License, Derivative Works shall not include works that remain
|
|
+ separable from, or merely link (or bind by name) to the interfaces of,
|
|
+ the Work and Derivative Works thereof.
|
|
+
|
|
+ "Contribution" shall mean any work of authorship, including
|
|
+ the original version of the Work and any modifications or additions
|
|
+ to that Work or Derivative Works thereof, that is intentionally
|
|
+ submitted to Licensor for inclusion in the Work by the copyright owner
|
|
+ or by an individual or Legal Entity authorized to submit on behalf of
|
|
+ the copyright owner. For the purposes of this definition, "submitted"
|
|
+ means any form of electronic, verbal, or written communication sent
|
|
+ to the Licensor or its representatives, including but not limited to
|
|
+ communication on electronic mailing lists, source code control systems,
|
|
+ and issue tracking systems that are managed by, or on behalf of, the
|
|
+ Licensor for the purpose of discussing and improving the Work, but
|
|
+ excluding communication that is conspicuously marked or otherwise
|
|
+ designated in writing by the copyright owner as "Not a Contribution."
|
|
+
|
|
+ "Contributor" shall mean Licensor and any individual or Legal Entity
|
|
+ on behalf of whom a Contribution has been received by Licensor and
|
|
+ subsequently incorporated within the Work.
|
|
+
|
|
+ 2. Grant of Copyright License. Subject to the terms and conditions of
|
|
+ this License, each Contributor hereby grants to You a perpetual,
|
|
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
+ copyright license to reproduce, prepare Derivative Works of,
|
|
+ publicly display, publicly perform, sublicense, and distribute the
|
|
+ Work and such Derivative Works in Source or Object form.
|
|
+
|
|
+ 3. Grant of Patent License. Subject to the terms and conditions of
|
|
+ this License, each Contributor hereby grants to You a perpetual,
|
|
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
+ (except as stated in this section) patent license to make, have made,
|
|
+ use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
+ where such license applies only to those patent claims licensable
|
|
+ by such Contributor that are necessarily infringed by their
|
|
+ Contribution(s) alone or by combination of their Contribution(s)
|
|
+ with the Work to which such Contribution(s) was submitted. If You
|
|
+ institute patent litigation against any entity (including a
|
|
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
+ or a Contribution incorporated within the Work constitutes direct
|
|
+ or contributory patent infringement, then any patent licenses
|
|
+ granted to You under this License for that Work shall terminate
|
|
+ as of the date such litigation is filed.
|
|
+
|
|
+ 4. Redistribution. You may reproduce and distribute copies of the
|
|
+ Work or Derivative Works thereof in any medium, with or without
|
|
+ modifications, and in Source or Object form, provided that You
|
|
+ meet the following conditions:
|
|
+
|
|
+ (a) You must give any other recipients of the Work or
|
|
+ Derivative Works a copy of this License; and
|
|
+
|
|
+ (b) You must cause any modified files to carry prominent notices
|
|
+ stating that You changed the files; and
|
|
+
|
|
+ (c) You must retain, in the Source form of any Derivative Works
|
|
+ that You distribute, all copyright, patent, trademark, and
|
|
+ attribution notices from the Source form of the Work,
|
|
+ excluding those notices that do not pertain to any part of
|
|
+ the Derivative Works; and
|
|
+
|
|
+ (d) If the Work includes a "NOTICE" text file as part of its
|
|
+ distribution, then any Derivative Works that You distribute must
|
|
+ include a readable copy of the attribution notices contained
|
|
+ within such NOTICE file, excluding those notices that do not
|
|
+ pertain to any part of the Derivative Works, in at least one
|
|
+ of the following places: within a NOTICE text file distributed
|
|
+ as part of the Derivative Works; within the Source form or
|
|
+ documentation, if provided along with the Derivative Works; or,
|
|
+ within a display generated by the Derivative Works, if and
|
|
+ wherever such third-party notices normally appear. The contents
|
|
+ of the NOTICE file are for informational purposes only and
|
|
+ do not modify the License. You may add Your own attribution
|
|
+ notices within Derivative Works that You distribute, alongside
|
|
+ or as an addendum to the NOTICE text from the Work, provided
|
|
+ that such additional attribution notices cannot be construed
|
|
+ as modifying the License.
|
|
+
|
|
+ You may add Your own copyright statement to Your modifications and
|
|
+ may provide additional or different license terms and conditions
|
|
+ for use, reproduction, or distribution of Your modifications, or
|
|
+ for any such Derivative Works as a whole, provided Your use,
|
|
+ reproduction, and distribution of the Work otherwise complies with
|
|
+ the conditions stated in this License.
|
|
+
|
|
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
+ any Contribution intentionally submitted for inclusion in the Work
|
|
+ by You to the Licensor shall be under the terms and conditions of
|
|
+ this License, without any additional terms or conditions.
|
|
+ Notwithstanding the above, nothing herein shall supersede or modify
|
|
+ the terms of any separate license agreement you may have executed
|
|
+ with Licensor regarding such Contributions.
|
|
+
|
|
+ 6. Trademarks. This License does not grant permission to use the trade
|
|
+ names, trademarks, service marks, or product names of the Licensor,
|
|
+ except as required for reasonable and customary use in describing the
|
|
+ origin of the Work and reproducing the content of the NOTICE file.
|
|
+
|
|
+ 7. Disclaimer of Warranty. Unless required by applicable law or
|
|
+ agreed to in writing, Licensor provides the Work (and each
|
|
+ Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
+ implied, including, without limitation, any warranties or conditions
|
|
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
+ PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
+ appropriateness of using or redistributing the Work and assume any
|
|
+ risks associated with Your exercise of permissions under this License.
|
|
+
|
|
+ 8. Limitation of Liability. In no event and under no legal theory,
|
|
+ whether in tort (including negligence), contract, or otherwise,
|
|
+ unless required by applicable law (such as deliberate and grossly
|
|
+ negligent acts) or agreed to in writing, shall any Contributor be
|
|
+ liable to You for damages, including any direct, indirect, special,
|
|
+ incidental, or consequential damages of any character arising as a
|
|
+ result of this License or out of the use or inability to use the
|
|
+ Work (including but not limited to damages for loss of goodwill,
|
|
+ work stoppage, computer failure or malfunction, or any and all
|
|
+ other commercial damages or losses), even if such Contributor
|
|
+ has been advised of the possibility of such damages.
|
|
+
|
|
+ 9. Accepting Warranty or Additional Liability. While redistributing
|
|
+ the Work or Derivative Works thereof, You may choose to offer,
|
|
+ and charge a fee for, acceptance of support, warranty, indemnity,
|
|
+ or other liability obligations and/or rights consistent with this
|
|
+ License. However, in accepting such obligations, You may act only
|
|
+ on Your own behalf and on Your sole responsibility, not on behalf
|
|
+ of any other Contributor, and only if You agree to indemnify,
|
|
+ defend, and hold each Contributor harmless for any liability
|
|
+ incurred by, or claims asserted against, such Contributor by reason
|
|
+ of your accepting any such warranty or additional liability.
|
|
+
|
|
+ END OF TERMS AND CONDITIONS
|
|
+
|
|
+ APPENDIX: How to apply the Apache License to your work.
|
|
+
|
|
+ To apply the Apache License to your work, attach the following
|
|
+ boilerplate notice, with the fields enclosed by brackets "[]"
|
|
+ replaced with your own identifying information. (Don't include
|
|
+ the brackets!) The text should be enclosed in the appropriate
|
|
+ comment syntax for the file format. We also recommend that a
|
|
+ file or class name and description of purpose be included on the
|
|
+ same "printed page" as the copyright notice for easier
|
|
+ identification within third-party archives.
|
|
+
|
|
+ Copyright 2022 balki
|
|
+
|
|
+ Licensed under the Apache License, Version 2.0 (the "License");
|
|
+ you may not use this file except in compliance with the License.
|
|
+ You may obtain a copy of the License at
|
|
+
|
|
+ http://www.apache.org/licenses/LICENSE-2.0
|
|
+
|
|
+ Unless required by applicable law or agreed to in writing, software
|
|
+ distributed under the License is distributed on an "AS IS" BASIS,
|
|
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
+ See the License for the specific language governing permissions and
|
|
+ limitations under the License.
|
|
diff --git a/vendor/go.balki.me/anyhttp/README.md b/vendor/go.balki.me/anyhttp/README.md
|
|
new file mode 100644
|
|
index 000000000..85bce6fc3
|
|
--- /dev/null
|
|
+++ b/vendor/go.balki.me/anyhttp/README.md
|
|
@@ -0,0 +1,80 @@
|
|
+Create http server listening on unix sockets and systemd socket activated fds
|
|
+
|
|
+## Quick Usage
|
|
+
|
|
+ go get go.balki.me/anyhttp
|
|
+
|
|
+Just replace `http.ListenAndServe` with `anyhttp.ListenAndServe`.
|
|
+
|
|
+```diff
|
|
+- http.ListenAndServe(addr, h)
|
|
++ anyhttp.ListenAndServe(addr, h)
|
|
+```
|
|
+
|
|
+## Address Syntax
|
|
+
|
|
+### Unix socket
|
|
+
|
|
+Syntax
|
|
+
|
|
+ unix?path=<socket_path>&mode=<socket file mode>&remove_existing=<true|false>
|
|
+
|
|
+Examples
|
|
+
|
|
+ unix?path=relative/path.sock
|
|
+ unix?path=/var/run/app/absolutepath.sock
|
|
+ unix?path=/run/app.sock&mode=600&remove_existing=false
|
|
+
|
|
+| option | description | default |
|
|
+|-----------------|------------------------------------------------|----------|
|
|
+| path | path to unix socket | Required |
|
|
+| mode | socket file mode | 666 |
|
|
+| remove_existing | Whether to remove existing socket file or fail | true |
|
|
+
|
|
+### Systemd Socket activated fd:
|
|
+
|
|
+Syntax
|
|
+
|
|
+ sysd?idx=<fd index>&name=<fd name>&check_pid=<true|false>&unset_env=<true|false>&idle_timeout=<duration>
|
|
+
|
|
+Only one of `idx` or `name` has to be set
|
|
+
|
|
+Examples:
|
|
+
|
|
+ # First (or only) socket fd passed to app
|
|
+ sysd?idx=0
|
|
+
|
|
+ # Socket with FileDescriptorName
|
|
+ sysd?name=myapp
|
|
+
|
|
+ # Using default name and auto shutdown if no requests received in last 30 minutes
|
|
+ sysd?name=myapp.socket&idle_timeout=30m
|
|
+
|
|
+| option | description | default |
|
|
+|--------------|--------------------------------------------------------------------------------------------|------------------|
|
|
+| name | Name configured via FileDescriptorName or socket file name | Required |
|
|
+| idx | FD Index. Actual fd num will be 3 + idx | Required |
|
|
+| idle_timeout | time to wait before shutdown. [syntax][0] | no auto shutdown |
|
|
+| check_pid | Check process PID matches LISTEN_PID | true |
|
|
+| unset_env | Unsets the LISTEN\* environment variables, so they don't get passed to any child processes | true |
|
|
+
|
|
+### TCP
|
|
+
|
|
+If the address is not one of above, it is assumed to be tcp and passed to `http.ListenAndServe`.
|
|
+
|
|
+Examples:
|
|
+
|
|
+ :http
|
|
+ :8888
|
|
+ 127.0.0.1:8080
|
|
+
|
|
+## Documentation
|
|
+
|
|
+https://pkg.go.dev/go.balki.me/anyhttp
|
|
+
|
|
+### Related links
|
|
+
|
|
+ * https://gist.github.com/teknoraver/5ffacb8757330715bcbcc90e6d46ac74#file-unixhttpd-go
|
|
+ * https://github.com/coreos/go-systemd/tree/main/activation
|
|
+
|
|
+[0]: https://pkg.go.dev/time#ParseDuration
|
|
diff --git a/vendor/go.balki.me/anyhttp/anyhttp.go b/vendor/go.balki.me/anyhttp/anyhttp.go
|
|
new file mode 100644
|
|
index 000000000..8d316a78f
|
|
--- /dev/null
|
|
+++ b/vendor/go.balki.me/anyhttp/anyhttp.go
|
|
@@ -0,0 +1,440 @@
|
|
+// Package anyhttp has helpers to serve http from unix sockets and systemd socket activated fds
|
|
+package anyhttp
|
|
+
|
|
+import (
|
|
+ "context"
|
|
+ "errors"
|
|
+ "fmt"
|
|
+ "io/fs"
|
|
+ "net"
|
|
+ "net/http"
|
|
+ "net/url"
|
|
+ "os"
|
|
+ "strconv"
|
|
+ "strings"
|
|
+ "sync"
|
|
+ "syscall"
|
|
+ "time"
|
|
+
|
|
+ "go.balki.me/anyhttp/idle"
|
|
+)
|
|
+
|
|
+// AddressType of the address passed
|
|
+type AddressType string
|
|
+
|
|
+var (
|
|
+ // UnixSocket - address is a unix socket, e.g. unix?path=/run/foo.sock
|
|
+ UnixSocket AddressType = "UnixSocket"
|
|
+ // SystemdFD - address is a systemd fd, e.g. sysd?name=myapp.socket
|
|
+ SystemdFD AddressType = "SystemdFD"
|
|
+ // TCP - address is a TCP address, e.g. :1234
|
|
+ TCP AddressType = "TCP"
|
|
+ // Unknown - address is not recognized
|
|
+ Unknown AddressType = "Unknown"
|
|
+)
|
|
+
|
|
+// UnixSocketConfig has the configuration for Unix socket
|
|
+type UnixSocketConfig struct {
|
|
+
|
|
+ // Absolute or relative path of socket, e.g. /run/app.sock
|
|
+ SocketPath string
|
|
+
|
|
+ // Socket file permission
|
|
+ SocketMode fs.FileMode
|
|
+
|
|
+ // Whether to delete existing socket before creating new one
|
|
+ RemoveExisting bool
|
|
+}
|
|
+
|
|
+// DefaultUnixSocketConfig has defaults for UnixSocketConfig
|
|
+var DefaultUnixSocketConfig = UnixSocketConfig{
|
|
+ SocketMode: 0666,
|
|
+ RemoveExisting: true,
|
|
+}
|
|
+
|
|
+// NewUnixSocketConfig creates a UnixSocketConfig with the default values and the socketPath passed
|
|
+func NewUnixSocketConfig(socketPath string) UnixSocketConfig {
|
|
+ usc := DefaultUnixSocketConfig
|
|
+ usc.SocketPath = socketPath
|
|
+ return usc
|
|
+}
|
|
+
|
|
+type sysdEnvData struct {
|
|
+ pid int
|
|
+ fdNames []string
|
|
+ fdNamesStr string
|
|
+ numFds int
|
|
+}
|
|
+
|
|
+var sysdEnvParser = struct {
|
|
+ sysdOnce sync.Once
|
|
+ data sysdEnvData
|
|
+ err error
|
|
+}{}
|
|
+
|
|
+func parse() (sysdEnvData, error) {
|
|
+ p := &sysdEnvParser
|
|
+ p.sysdOnce.Do(func() {
|
|
+ p.data.pid, p.err = strconv.Atoi(os.Getenv("LISTEN_PID"))
|
|
+ if p.err != nil {
|
|
+ p.err = fmt.Errorf("invalid LISTEN_PID, err: %w", p.err)
|
|
+ return
|
|
+ }
|
|
+ p.data.numFds, p.err = strconv.Atoi(os.Getenv("LISTEN_FDS"))
|
|
+ if p.err != nil {
|
|
+ p.err = fmt.Errorf("invalid LISTEN_FDS, err: %w", p.err)
|
|
+ return
|
|
+ }
|
|
+ p.data.fdNamesStr = os.Getenv("LISTEN_FDNAMES")
|
|
+ p.data.fdNames = strings.Split(p.data.fdNamesStr, ":")
|
|
+
|
|
+ })
|
|
+ return p.data, p.err
|
|
+}
|
|
+
|
|
+// SysdConfig has the configuration for the socket activated fd
|
|
+type SysdConfig struct {
|
|
+ // Integer value starting at 0. Either index or name is required
|
|
+ FDIndex *int
|
|
+ // Name configured via FileDescriptorName or the default socket file name. Either index or name is required
|
|
+ FDName *string
|
|
+ // Check process PID matches LISTEN_PID
|
|
+ CheckPID bool
|
|
+ // Unsets the LISTEN* environment variables, so they don't get passed to any child processes
|
|
+ UnsetEnv bool
|
|
+ // Shutdown http server if no requests received for below timeout
|
|
+ IdleTimeout *time.Duration
|
|
+}
|
|
+
|
|
+// DefaultSysdConfig has the default values for SysdConfig
|
|
+var DefaultSysdConfig = SysdConfig{
|
|
+ CheckPID: true,
|
|
+ UnsetEnv: true,
|
|
+}
|
|
+
|
|
+// NewSysDConfigWithFDIdx creates SysdConfig with defaults and fdIdx
|
|
+func NewSysDConfigWithFDIdx(fdIdx int) SysdConfig {
|
|
+ sysc := DefaultSysdConfig
|
|
+ sysc.FDIndex = &fdIdx
|
|
+ return sysc
|
|
+}
|
|
+
|
|
+// NewSysDConfigWithFDName creates SysdConfig with defaults and fdName
|
|
+func NewSysDConfigWithFDName(fdName string) SysdConfig {
|
|
+ sysc := DefaultSysdConfig
|
|
+ sysc.FDName = &fdName
|
|
+ return sysc
|
|
+}
|
|
+
|
|
+// GetListener returns the unix socket listener
|
|
+func (u *UnixSocketConfig) GetListener() (net.Listener, error) {
|
|
+
|
|
+ if u.RemoveExisting {
|
|
+ if err := os.Remove(u.SocketPath); err != nil && !errors.Is(err, fs.ErrNotExist) {
|
|
+ return nil, err
|
|
+ }
|
|
+ }
|
|
+
|
|
+ l, err := net.Listen("unix", u.SocketPath)
|
|
+ if err != nil {
|
|
+ return nil, err
|
|
+ }
|
|
+
|
|
+ if err = os.Chmod(u.SocketPath, u.SocketMode); err != nil {
|
|
+ return nil, err
|
|
+ }
|
|
+
|
|
+ return l, nil
|
|
+}
|
|
+
|
|
+// StartFD is the starting file descriptor number
|
|
+const StartFD = 3
|
|
+
|
|
+func makeFdListener(fd int, name string) (net.Listener, error) {
|
|
+ fdFile := os.NewFile(uintptr(fd), name)
|
|
+ l, err := net.FileListener(fdFile)
|
|
+ if err != nil {
|
|
+ return nil, err
|
|
+ }
|
|
+ syscall.CloseOnExec(fd)
|
|
+ return l, nil
|
|
+}
|
|
+
|
|
+// GetListener returns the FileListener created with socketed activated fd
|
|
+func (s *SysdConfig) GetListener() (net.Listener, error) {
|
|
+
|
|
+ if s.UnsetEnv {
|
|
+ defer UnsetSystemdListenVars()
|
|
+ }
|
|
+
|
|
+ envData, err := parse()
|
|
+ if err != nil {
|
|
+ return nil, err
|
|
+ }
|
|
+
|
|
+ if s.CheckPID {
|
|
+ if envData.pid != os.Getpid() {
|
|
+ return nil, fmt.Errorf("unexpected PID, current:%v, LISTEN_PID: %v", os.Getpid(), envData.pid)
|
|
+ }
|
|
+ }
|
|
+
|
|
+ if s.FDIndex != nil {
|
|
+ idx := *s.FDIndex
|
|
+ if idx < 0 || idx >= envData.numFds {
|
|
+ return nil, fmt.Errorf("invalid fd index, expected between 0 and %v, got: %v", envData.numFds, idx)
|
|
+ }
|
|
+ fd := StartFD + idx
|
|
+ if idx < len(envData.fdNames) {
|
|
+ return makeFdListener(fd, envData.fdNames[idx])
|
|
+ }
|
|
+ return makeFdListener(fd, fmt.Sprintf("sysdfd_%d", fd))
|
|
+ }
|
|
+
|
|
+ if s.FDName != nil {
|
|
+ for idx, name := range envData.fdNames {
|
|
+ if name == *s.FDName {
|
|
+ fd := StartFD + idx
|
|
+ return makeFdListener(fd, name)
|
|
+ }
|
|
+ }
|
|
+ return nil, fmt.Errorf("fdName not found: %q, LISTEN_FDNAMES:%q", *s.FDName, envData.fdNamesStr)
|
|
+ }
|
|
+
|
|
+ return nil, errors.New("neither FDIndex nor FDName set")
|
|
+}
|
|
+
|
|
+// GetListener is low level function for use with non-http servers. e.g. tcp, smtp
|
|
+// Caller should handle idle timeout if needed
|
|
+func GetListener(addr string) (net.Listener, AddressType, any /* cfg */, error) {
|
|
+
|
|
+ addrType, unixSocketConfig, sysdConfig, perr := parseAddress(addr)
|
|
+ if perr != nil {
|
|
+ return nil, Unknown, nil, perr
|
|
+ }
|
|
+ if unixSocketConfig != nil {
|
|
+ listener, err := unixSocketConfig.GetListener()
|
|
+ if err != nil {
|
|
+ return nil, Unknown, nil, err
|
|
+ }
|
|
+ return listener, addrType, unixSocketConfig, nil
|
|
+ } else if sysdConfig != nil {
|
|
+ listener, err := sysdConfig.GetListener()
|
|
+ if err != nil {
|
|
+ return nil, Unknown, nil, err
|
|
+ }
|
|
+ return listener, addrType, sysdConfig, nil
|
|
+ }
|
|
+ if addr == "" {
|
|
+ addr = ":http"
|
|
+ }
|
|
+ listener, err := net.Listen("tcp", addr)
|
|
+ return listener, TCP, nil, err
|
|
+}
|
|
+
|
|
+type ServerCtx struct {
|
|
+ AddressType AddressType
|
|
+ Listener net.Listener
|
|
+ Server *http.Server
|
|
+ Idler idle.Idler
|
|
+ Done <-chan error
|
|
+ UnixSocketConfig *UnixSocketConfig
|
|
+ SysdConfig *SysdConfig
|
|
+}
|
|
+
|
|
+func (s *ServerCtx) Wait() error {
|
|
+ return <-s.Done
|
|
+}
|
|
+
|
|
+func (s *ServerCtx) Addr() net.Addr {
|
|
+ return s.Listener.Addr()
|
|
+}
|
|
+
|
|
+func (s *ServerCtx) Shutdown(ctx context.Context) error {
|
|
+ err := s.Server.Shutdown(ctx)
|
|
+ if err != nil {
|
|
+ return err
|
|
+ }
|
|
+ return <-s.Done
|
|
+}
|
|
+
|
|
+// ServeTLS creates and serves a HTTPS server.
|
|
+func ServeTLS(addr string, h http.Handler, certFile string, keyFile string) (*ServerCtx, error) {
|
|
+ return serve(addr, h, certFile, keyFile)
|
|
+}
|
|
+
|
|
+// Serve creates and serves a HTTP server.
|
|
+func Serve(addr string, h http.Handler) (*ServerCtx, error) {
|
|
+ return serve(addr, h, "", "")
|
|
+}
|
|
+
|
|
+// ListenAndServe is the drop-in replacement for `http.ListenAndServe`.
|
|
+// Supports unix and systemd sockets in addition
|
|
+func ListenAndServe(addr string, h http.Handler) error {
|
|
+ ctx, err := Serve(addr, h)
|
|
+ if err != nil {
|
|
+ return err
|
|
+ }
|
|
+ return ctx.Wait()
|
|
+}
|
|
+
|
|
+func ListenAndServeTLS(addr string, certFile string, keyFile string, h http.Handler) error {
|
|
+ ctx, err := ServeTLS(addr, h, certFile, keyFile)
|
|
+ if err != nil {
|
|
+ return err
|
|
+ }
|
|
+ return ctx.Wait()
|
|
+}
|
|
+
|
|
+// UnsetSystemdListenVars unsets the LISTEN* environment variables so they are not passed to any child processes
|
|
+func UnsetSystemdListenVars() {
|
|
+ _ = os.Unsetenv("LISTEN_PID")
|
|
+ _ = os.Unsetenv("LISTEN_FDS")
|
|
+ _ = os.Unsetenv("LISTEN_FDNAMES")
|
|
+}
|
|
+
|
|
+func parseAddress(addr string) (addrType AddressType, usc *UnixSocketConfig, sysc *SysdConfig, err error) {
|
|
+ usc = nil
|
|
+ sysc = nil
|
|
+ err = nil
|
|
+ u, err := url.Parse(addr)
|
|
+ if err != nil {
|
|
+ return TCP, nil, nil, nil
|
|
+ }
|
|
+ if u.Path == "unix" {
|
|
+ duc := DefaultUnixSocketConfig
|
|
+ usc = &duc
|
|
+ addrType = UnixSocket
|
|
+ for key, val := range u.Query() {
|
|
+ if len(val) != 1 {
|
|
+ err = fmt.Errorf("unix socket address error. Multiple %v found: %v", key, val)
|
|
+ return
|
|
+ }
|
|
+ if key == "path" {
|
|
+ usc.SocketPath = val[0]
|
|
+ } else if key == "mode" {
|
|
+ if _, serr := fmt.Sscanf(val[0], "%o", &usc.SocketMode); serr != nil {
|
|
+ err = fmt.Errorf("unix socket address error. Bad mode: %v, err: %w", val, serr)
|
|
+ return
|
|
+ }
|
|
+ } else if key == "remove_existing" {
|
|
+ if removeExisting, berr := strconv.ParseBool(val[0]); berr == nil {
|
|
+ usc.RemoveExisting = removeExisting
|
|
+ } else {
|
|
+ err = fmt.Errorf("unix socket address error. Bad remove_existing: %v, err: %w", val, berr)
|
|
+ return
|
|
+ }
|
|
+ } else {
|
|
+ err = fmt.Errorf("unix socket address error. Bad option; key: %v, val: %v", key, val)
|
|
+ return
|
|
+ }
|
|
+ }
|
|
+ if usc.SocketPath == "" {
|
|
+ err = fmt.Errorf("unix socket address error. Missing path; addr: %v", addr)
|
|
+ return
|
|
+ }
|
|
+ } else if u.Path == "sysd" {
|
|
+ dsc := DefaultSysdConfig
|
|
+ sysc = &dsc
|
|
+ addrType = SystemdFD
|
|
+ for key, val := range u.Query() {
|
|
+ if len(val) != 1 {
|
|
+ err = fmt.Errorf("systemd socket fd address error. Multiple %v found: %v", key, val)
|
|
+ return
|
|
+ }
|
|
+ if key == "name" {
|
|
+ sysc.FDName = &val[0]
|
|
+ } else if key == "idx" {
|
|
+ if idx, ierr := strconv.Atoi(val[0]); ierr == nil {
|
|
+ sysc.FDIndex = &idx
|
|
+ } else {
|
|
+ err = fmt.Errorf("systemd socket fd address error. Bad idx: %v, err: %w", val, ierr)
|
|
+ return
|
|
+ }
|
|
+ } else if key == "check_pid" {
|
|
+ if checkPID, berr := strconv.ParseBool(val[0]); berr == nil {
|
|
+ sysc.CheckPID = checkPID
|
|
+ } else {
|
|
+ err = fmt.Errorf("systemd socket fd address error. Bad check_pid: %v, err: %w", val, berr)
|
|
+ return
|
|
+ }
|
|
+ } else if key == "unset_env" {
|
|
+ if unsetEnv, berr := strconv.ParseBool(val[0]); berr == nil {
|
|
+ sysc.UnsetEnv = unsetEnv
|
|
+ } else {
|
|
+ err = fmt.Errorf("systemd socket fd address error. Bad unset_env: %v, err: %w", val, berr)
|
|
+ return
|
|
+ }
|
|
+ } else if key == "idle_timeout" {
|
|
+ if timeout, terr := time.ParseDuration(val[0]); terr == nil {
|
|
+ sysc.IdleTimeout = &timeout
|
|
+ } else {
|
|
+ err = fmt.Errorf("systemd socket fd address error. Bad idle_timeout: %v, err: %w", val, terr)
|
|
+ return
|
|
+ }
|
|
+ } else {
|
|
+ err = fmt.Errorf("systemd socket fd address error. Bad option; key: %v, val: %v", key, val)
|
|
+ return
|
|
+ }
|
|
+ }
|
|
+ if (sysc.FDIndex == nil) == (sysc.FDName == nil) {
|
|
+ err = fmt.Errorf("systemd socket fd address error. Exactly only one of name and idx has to be set. name: %v, idx: %v", sysc.FDName, sysc.FDIndex)
|
|
+ return
|
|
+ }
|
|
+ } else {
|
|
+ // Just assume as TCP address
|
|
+ return TCP, nil, nil, nil
|
|
+ }
|
|
+ return
|
|
+}
|
|
+
|
|
+func serve(addr string, h http.Handler, certFile string, keyFile string) (*ServerCtx, error) {
|
|
+
|
|
+ serveFn := func() func(ctx *ServerCtx) error {
|
|
+ if certFile != "" {
|
|
+ return func(ctx *ServerCtx) error {
|
|
+ return ctx.Server.ServeTLS(ctx.Listener, certFile, keyFile)
|
|
+ }
|
|
+ }
|
|
+ return func(ctx *ServerCtx) error {
|
|
+ return ctx.Server.Serve(ctx.Listener)
|
|
+ }
|
|
+ }()
|
|
+ var ctx ServerCtx
|
|
+ var err error
|
|
+ var cfg any
|
|
+
|
|
+ ctx.Listener, ctx.AddressType, cfg, err = GetListener(addr)
|
|
+ if err != nil {
|
|
+ return nil, err
|
|
+ }
|
|
+ switch ctx.AddressType {
|
|
+ case UnixSocket:
|
|
+ ctx.UnixSocketConfig = cfg.(*UnixSocketConfig)
|
|
+ case SystemdFD:
|
|
+ ctx.SysdConfig = cfg.(*SysdConfig)
|
|
+ }
|
|
+ errChan := make(chan error)
|
|
+ ctx.Done = errChan
|
|
+ if ctx.AddressType == SystemdFD && ctx.SysdConfig.IdleTimeout != nil {
|
|
+ ctx.Idler = idle.CreateIdler(*ctx.SysdConfig.IdleTimeout)
|
|
+ ctx.Server = &http.Server{Handler: idle.WrapIdlerHandler(ctx.Idler, h)}
|
|
+ waitErrChan := make(chan error)
|
|
+ go func() {
|
|
+ waitErrChan <- serveFn(&ctx)
|
|
+ }()
|
|
+ go func() {
|
|
+ select {
|
|
+ case err := <-waitErrChan:
|
|
+ errChan <- err
|
|
+ case <-ctx.Idler.Chan():
|
|
+ errChan <- ctx.Server.Shutdown(context.TODO())
|
|
+ }
|
|
+ }()
|
|
+ } else {
|
|
+ ctx.Server = &http.Server{Handler: h}
|
|
+ go func() {
|
|
+ errChan <- serveFn(&ctx)
|
|
+ }()
|
|
+ }
|
|
+ return &ctx, nil
|
|
+}
|
|
diff --git a/vendor/go.balki.me/anyhttp/idle/idle.go b/vendor/go.balki.me/anyhttp/idle/idle.go
|
|
new file mode 100644
|
|
index 000000000..ee3d81ff1
|
|
--- /dev/null
|
|
+++ b/vendor/go.balki.me/anyhttp/idle/idle.go
|
|
@@ -0,0 +1,127 @@
|
|
+// Package idle helps to gracefully shutdown idle (typically http) servers
|
|
+package idle
|
|
+
|
|
+import (
|
|
+ "fmt"
|
|
+ "net/http"
|
|
+ "sync/atomic"
|
|
+ "time"
|
|
+)
|
|
+
|
|
+var (
|
|
+ // For simple servers without backgroud jobs, global singleton for simpler API
|
|
+ // Enter/Exit worn't work for global idler as Enter may be called before Wait, use CreateIdler in those cases
|
|
+ gIdler atomic.Pointer[idler]
|
|
+)
|
|
+
|
|
+// Wait waits till the server is idle and returns. i.e. no Ticks in last <timeout> duration
|
|
+func Wait(timeout time.Duration) error {
|
|
+ i := CreateIdler(timeout).(*idler)
|
|
+ ok := gIdler.CompareAndSwap(nil, i)
|
|
+ if !ok {
|
|
+ return fmt.Errorf("idler already waiting")
|
|
+ }
|
|
+ i.Wait()
|
|
+ return nil
|
|
+}
|
|
+
|
|
+// Tick records the current time. This will make the server not idle until next Tick or timeout
|
|
+func Tick() {
|
|
+ i := gIdler.Load()
|
|
+ if i != nil {
|
|
+ i.Tick()
|
|
+ }
|
|
+}
|
|
+
|
|
+// WrapHandler calls Tick() before processing passing request to http.Handler
|
|
+func WrapHandler(h http.Handler) http.Handler {
|
|
+ if h == nil {
|
|
+ h = http.DefaultServeMux
|
|
+ }
|
|
+ return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
+ Tick()
|
|
+ h.ServeHTTP(w, r)
|
|
+ })
|
|
+}
|
|
+
|
|
+// WrapIdlerHandler calls idler.Tick() before processing passing request to http.Handler
|
|
+func WrapIdlerHandler(i Idler, h http.Handler) http.Handler {
|
|
+ if h == nil {
|
|
+ h = http.DefaultServeMux
|
|
+ }
|
|
+ return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
+ i.Tick()
|
|
+ h.ServeHTTP(w, r)
|
|
+ })
|
|
+}
|
|
+
|
|
+// Idler helps manage idle servers
|
|
+type Idler interface {
|
|
+ // Tick records the current time. This will make the server not idle until next Tick or timeout
|
|
+ Tick()
|
|
+
|
|
+ // Wait waits till the server is idle and returns. i.e. no Ticks in last <timeout> duration
|
|
+ Wait()
|
|
+
|
|
+ // For long running background jobs, use Enter to record start time. Wait will not return while there are active jobs running
|
|
+ Enter()
|
|
+
|
|
+ // Exit records end of a background job
|
|
+ Exit()
|
|
+
|
|
+ // Get the channel to wait yourself
|
|
+ Chan() <-chan struct{}
|
|
+}
|
|
+
|
|
+type idler struct {
|
|
+ lastTick atomic.Pointer[time.Time]
|
|
+ c chan struct{}
|
|
+ active atomic.Int64
|
|
+}
|
|
+
|
|
+func (i *idler) Enter() {
|
|
+ i.active.Add(1)
|
|
+}
|
|
+
|
|
+func (i *idler) Exit() {
|
|
+ i.Tick()
|
|
+ i.active.Add(-1)
|
|
+}
|
|
+
|
|
+// CreateIdler creates an Idler with given timeout
|
|
+func CreateIdler(timeout time.Duration) Idler {
|
|
+ i := &idler{}
|
|
+ i.c = make(chan struct{})
|
|
+ i.Tick()
|
|
+ go func() {
|
|
+ for {
|
|
+ if i.active.Load() != 0 {
|
|
+ time.Sleep(timeout)
|
|
+ continue
|
|
+ }
|
|
+ t := *i.lastTick.Load()
|
|
+ now := time.Now()
|
|
+ dur := t.Add(timeout).Sub(now)
|
|
+ if dur == dur.Abs() {
|
|
+ time.Sleep(dur)
|
|
+ continue
|
|
+ }
|
|
+ break
|
|
+ }
|
|
+ close(i.c)
|
|
+ }()
|
|
+ return i
|
|
+}
|
|
+
|
|
+func (i *idler) Tick() {
|
|
+ now := time.Now()
|
|
+ i.lastTick.Store(&now)
|
|
+}
|
|
+
|
|
+func (i *idler) Wait() {
|
|
+ <-i.c
|
|
+}
|
|
+
|
|
+func (i *idler) Chan() <-chan struct{} {
|
|
+ return i.c
|
|
+}
|
|
diff --git a/vendor/modules.txt b/vendor/modules.txt
|
|
index e053e6ce0..338ab8877 100644
|
|
--- a/vendor/modules.txt
|
|
+++ b/vendor/modules.txt
|
|
@@ -959,6 +959,10 @@ github.com/yuin/goldmark/renderer
|
|
github.com/yuin/goldmark/renderer/html
|
|
github.com/yuin/goldmark/text
|
|
github.com/yuin/goldmark/util
|
|
+# go.balki.me/anyhttp v0.5.0
|
|
+## explicit; go 1.20
|
|
+go.balki.me/anyhttp
|
|
+go.balki.me/anyhttp/idle
|
|
# go.mongodb.org/mongo-driver v1.14.0
|
|
## explicit; go 1.18
|
|
go.mongodb.org/mongo-driver/bson
|