2021-11-01 22:21:38 +03:00
|
|
|
package server
|
|
|
|
|
|
|
|
import (
|
2021-12-25 17:15:05 +03:00
|
|
|
"errors"
|
2022-12-25 19:41:38 +03:00
|
|
|
"heckel.io/ntfy/user"
|
2022-10-05 23:42:07 +03:00
|
|
|
"net/netip"
|
2021-11-01 22:21:38 +03:00
|
|
|
"sync"
|
|
|
|
"time"
|
2022-10-05 23:42:07 +03:00
|
|
|
|
|
|
|
"golang.org/x/time/rate"
|
|
|
|
"heckel.io/ntfy/util"
|
2021-11-01 22:21:38 +03:00
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
2021-12-24 02:03:04 +03:00
|
|
|
// visitorExpungeAfter defines how long a visitor is active before it is removed from memory. This number
|
|
|
|
// has to be very high to prevent e-mail abuse, but it doesn't really affect the other limits anyway, since
|
|
|
|
// they are replenished faster (typically).
|
|
|
|
visitorExpungeAfter = 24 * time.Hour
|
2021-11-01 22:21:38 +03:00
|
|
|
)
|
|
|
|
|
2021-12-25 17:15:05 +03:00
|
|
|
var (
|
|
|
|
errVisitorLimitReached = errors.New("limit reached")
|
|
|
|
)
|
|
|
|
|
2021-11-01 22:21:38 +03:00
|
|
|
// visitor represents an API user, and its associated rate.Limiter used for rate limiting
|
|
|
|
type visitor struct {
|
2022-12-19 17:59:32 +03:00
|
|
|
config *Config
|
|
|
|
messageCache *messageCache
|
2023-01-03 04:08:37 +03:00
|
|
|
userManager *user.Manager // May be nil!
|
2022-12-19 17:59:32 +03:00
|
|
|
ip netip.Addr
|
2022-12-25 19:41:38 +03:00
|
|
|
user *user.User
|
2023-01-09 04:46:46 +03:00
|
|
|
messages int64 // Number of messages sent, reset every day
|
|
|
|
emails int64 // Number of emails sent, reset every day
|
2022-12-21 05:18:33 +03:00
|
|
|
requestLimiter *rate.Limiter // Rate limiter for (almost) all requests (including messages)
|
2023-01-09 04:46:46 +03:00
|
|
|
messagesLimiter util.Limiter // Rate limiter for messages, may be nil
|
2022-12-21 05:18:33 +03:00
|
|
|
emailsLimiter *rate.Limiter // Rate limiter for emails
|
|
|
|
subscriptionLimiter util.Limiter // Fixed limiter for active subscriptions (ongoing connections)
|
2023-01-09 04:46:46 +03:00
|
|
|
bandwidthLimiter util.Limiter // Limiter for attachment bandwidth downloads
|
2022-12-24 20:10:51 +03:00
|
|
|
accountLimiter *rate.Limiter // Rate limiter for account creation
|
|
|
|
firebase time.Time // Next allowed Firebase message
|
2023-01-09 23:40:46 +03:00
|
|
|
seen time.Time // Last seen time of this visitor (needed for removal of stale visitors)
|
2022-12-19 17:59:32 +03:00
|
|
|
mu sync.Mutex
|
2021-11-01 22:21:38 +03:00
|
|
|
}
|
|
|
|
|
2022-12-28 06:14:14 +03:00
|
|
|
type visitorInfo struct {
|
2023-01-09 23:40:46 +03:00
|
|
|
Limits *visitorLimits
|
|
|
|
Stats *visitorStats
|
|
|
|
}
|
|
|
|
|
|
|
|
type visitorLimits struct {
|
|
|
|
Basis visitorLimitBasis
|
|
|
|
MessagesLimit int64
|
|
|
|
MessagesExpiryDuration time.Duration
|
|
|
|
EmailsLimit int64
|
|
|
|
ReservationsLimit int64
|
|
|
|
AttachmentTotalSizeLimit int64
|
|
|
|
AttachmentFileSizeLimit int64
|
|
|
|
AttachmentExpiryDuration time.Duration
|
|
|
|
}
|
|
|
|
|
|
|
|
type visitorStats struct {
|
2022-12-20 00:22:13 +03:00
|
|
|
Messages int64
|
|
|
|
MessagesRemaining int64
|
|
|
|
Emails int64
|
|
|
|
EmailsRemaining int64
|
2023-01-08 05:04:13 +03:00
|
|
|
Reservations int64
|
|
|
|
ReservationsRemaining int64
|
2022-12-20 00:22:13 +03:00
|
|
|
AttachmentTotalSize int64
|
|
|
|
AttachmentTotalSizeRemaining int64
|
2022-04-03 19:39:52 +03:00
|
|
|
}
|
|
|
|
|
2023-01-09 23:40:46 +03:00
|
|
|
// visitorLimitBasis describes how the visitor limits were derived, either from a user's
|
|
|
|
// IP address (default config), or from its tier
|
|
|
|
type visitorLimitBasis string
|
|
|
|
|
|
|
|
const (
|
|
|
|
visitorLimitBasisIP = visitorLimitBasis("ip")
|
|
|
|
visitorLimitBasisTier = visitorLimitBasis("tier")
|
|
|
|
)
|
|
|
|
|
2023-01-03 04:08:37 +03:00
|
|
|
func newVisitor(conf *Config, messageCache *messageCache, userManager *user.Manager, ip netip.Addr, user *user.User) *visitor {
|
2023-01-09 04:46:46 +03:00
|
|
|
var messagesLimiter util.Limiter
|
2022-12-24 20:10:51 +03:00
|
|
|
var requestLimiter, emailsLimiter, accountLimiter *rate.Limiter
|
2022-12-21 05:18:33 +03:00
|
|
|
var messages, emails int64
|
|
|
|
if user != nil {
|
|
|
|
messages = user.Stats.Messages
|
|
|
|
emails = user.Stats.Emails
|
2022-12-24 20:10:51 +03:00
|
|
|
} else {
|
|
|
|
accountLimiter = rate.NewLimiter(rate.Every(conf.VisitorAccountCreateLimitReplenish), conf.VisitorAccountCreateLimitBurst)
|
2022-12-21 05:18:33 +03:00
|
|
|
}
|
2023-01-08 05:04:13 +03:00
|
|
|
if user != nil && user.Tier != nil {
|
|
|
|
requestLimiter = rate.NewLimiter(dailyLimitToRate(user.Tier.MessagesLimit), conf.VisitorRequestLimitBurst)
|
2023-01-09 04:46:46 +03:00
|
|
|
messagesLimiter = util.NewFixedLimiter(user.Tier.MessagesLimit)
|
2023-01-08 05:04:13 +03:00
|
|
|
emailsLimiter = rate.NewLimiter(dailyLimitToRate(user.Tier.EmailsLimit), conf.VisitorEmailLimitBurst)
|
2022-12-18 07:54:19 +03:00
|
|
|
} else {
|
2022-12-18 22:35:05 +03:00
|
|
|
requestLimiter = rate.NewLimiter(rate.Every(conf.VisitorRequestLimitReplenish), conf.VisitorRequestLimitBurst)
|
2022-12-20 00:22:13 +03:00
|
|
|
emailsLimiter = rate.NewLimiter(rate.Every(conf.VisitorEmailLimitReplenish), conf.VisitorEmailLimitBurst)
|
2022-12-18 07:54:19 +03:00
|
|
|
}
|
2021-11-01 22:21:38 +03:00
|
|
|
return &visitor{
|
2022-12-19 17:59:32 +03:00
|
|
|
config: conf,
|
|
|
|
messageCache: messageCache,
|
2023-01-09 23:40:46 +03:00
|
|
|
userManager: userManager, // May be nil
|
2022-12-19 17:59:32 +03:00
|
|
|
ip: ip,
|
|
|
|
user: user,
|
2022-12-21 05:18:33 +03:00
|
|
|
messages: messages,
|
|
|
|
emails: emails,
|
2022-12-19 17:59:32 +03:00
|
|
|
requestLimiter: requestLimiter,
|
2023-01-09 23:40:46 +03:00
|
|
|
messagesLimiter: messagesLimiter, // May be nil
|
2022-12-20 00:22:13 +03:00
|
|
|
emailsLimiter: emailsLimiter,
|
2022-12-19 17:59:32 +03:00
|
|
|
subscriptionLimiter: util.NewFixedLimiter(int64(conf.VisitorSubscriptionLimit)),
|
|
|
|
bandwidthLimiter: util.NewBytesLimiter(conf.VisitorAttachmentDailyBandwidthLimit, 24*time.Hour),
|
2022-12-24 20:10:51 +03:00
|
|
|
accountLimiter: accountLimiter, // May be nil
|
2022-12-19 17:59:32 +03:00
|
|
|
firebase: time.Unix(0, 0),
|
|
|
|
seen: time.Now(),
|
2021-11-01 22:21:38 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (v *visitor) RequestAllowed() error {
|
2022-12-18 22:35:05 +03:00
|
|
|
if !v.requestLimiter.Allow() {
|
2021-12-25 17:15:05 +03:00
|
|
|
return errVisitorLimitReached
|
2021-12-24 02:03:04 +03:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2022-06-01 03:38:56 +03:00
|
|
|
func (v *visitor) FirebaseAllowed() error {
|
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
|
|
|
if time.Now().Before(v.firebase) {
|
|
|
|
return errVisitorLimitReached
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (v *visitor) FirebaseTemporarilyDeny() {
|
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
2022-06-01 06:27:24 +03:00
|
|
|
v.firebase = time.Now().Add(v.config.FirebaseQuotaExceededPenaltyDuration)
|
2022-06-01 03:38:56 +03:00
|
|
|
}
|
|
|
|
|
2023-01-09 04:46:46 +03:00
|
|
|
func (v *visitor) MessageAllowed() error {
|
|
|
|
if v.messagesLimiter != nil && v.messagesLimiter.Allow(1) != nil {
|
|
|
|
return errVisitorLimitReached
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2021-12-24 02:03:04 +03:00
|
|
|
func (v *visitor) EmailAllowed() error {
|
2022-12-19 17:59:32 +03:00
|
|
|
if !v.emailsLimiter.Allow() {
|
2021-12-25 17:15:05 +03:00
|
|
|
return errVisitorLimitReached
|
2021-11-01 22:21:38 +03:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2021-12-25 17:15:05 +03:00
|
|
|
func (v *visitor) SubscriptionAllowed() error {
|
2021-11-01 22:21:38 +03:00
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
2022-12-19 17:59:32 +03:00
|
|
|
if err := v.subscriptionLimiter.Allow(1); err != nil {
|
2021-12-25 17:15:05 +03:00
|
|
|
return errVisitorLimitReached
|
2021-11-01 22:21:38 +03:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (v *visitor) RemoveSubscription() {
|
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
2022-12-19 17:59:32 +03:00
|
|
|
v.subscriptionLimiter.Allow(-1)
|
2021-11-01 22:21:38 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
func (v *visitor) Keepalive() {
|
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
|
|
|
v.seen = time.Now()
|
|
|
|
}
|
|
|
|
|
2022-01-13 05:24:48 +03:00
|
|
|
func (v *visitor) BandwidthLimiter() util.Limiter {
|
2022-12-19 17:59:32 +03:00
|
|
|
return v.bandwidthLimiter
|
2022-01-13 02:52:07 +03:00
|
|
|
}
|
|
|
|
|
2021-11-01 22:21:38 +03:00
|
|
|
func (v *visitor) Stale() bool {
|
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
|
|
|
return time.Since(v.seen) > visitorExpungeAfter
|
|
|
|
}
|
2022-04-03 19:39:52 +03:00
|
|
|
|
2023-01-11 06:51:51 +03:00
|
|
|
func (v *visitor) IncrementMessages() {
|
2022-12-19 17:59:32 +03:00
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
|
|
|
v.messages++
|
2022-12-21 05:18:33 +03:00
|
|
|
if v.user != nil {
|
|
|
|
v.user.Stats.Messages = v.messages
|
|
|
|
}
|
2022-12-19 17:59:32 +03:00
|
|
|
}
|
|
|
|
|
2023-01-11 06:51:51 +03:00
|
|
|
func (v *visitor) IncrementEmails() {
|
2022-12-19 17:59:32 +03:00
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
|
|
|
v.emails++
|
2022-12-21 05:18:33 +03:00
|
|
|
if v.user != nil {
|
|
|
|
v.user.Stats.Emails = v.emails
|
|
|
|
}
|
2022-12-19 17:59:32 +03:00
|
|
|
}
|
|
|
|
|
2023-01-11 06:51:51 +03:00
|
|
|
func (v *visitor) ResetStats() {
|
|
|
|
v.mu.Lock()
|
|
|
|
defer v.mu.Unlock()
|
|
|
|
v.messages = 0
|
|
|
|
v.emails = 0
|
|
|
|
if v.user != nil {
|
|
|
|
v.user.Stats.Messages = 0
|
|
|
|
v.user.Stats.Emails = 0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-01-09 23:40:46 +03:00
|
|
|
func (v *visitor) Limits() *visitorLimits {
|
|
|
|
limits := &visitorLimits{}
|
|
|
|
if v.user != nil && v.user.Tier != nil {
|
|
|
|
limits.Basis = visitorLimitBasisTier
|
|
|
|
limits.MessagesLimit = v.user.Tier.MessagesLimit
|
|
|
|
limits.MessagesExpiryDuration = v.user.Tier.MessagesExpiryDuration
|
|
|
|
limits.EmailsLimit = v.user.Tier.EmailsLimit
|
|
|
|
limits.ReservationsLimit = v.user.Tier.ReservationsLimit
|
|
|
|
limits.AttachmentTotalSizeLimit = v.user.Tier.AttachmentTotalSizeLimit
|
|
|
|
limits.AttachmentFileSizeLimit = v.user.Tier.AttachmentFileSizeLimit
|
|
|
|
limits.AttachmentExpiryDuration = v.user.Tier.AttachmentExpiryDuration
|
|
|
|
} else {
|
|
|
|
limits.Basis = visitorLimitBasisIP
|
|
|
|
limits.MessagesLimit = replenishDurationToDailyLimit(v.config.VisitorRequestLimitReplenish)
|
|
|
|
limits.MessagesExpiryDuration = v.config.CacheDuration
|
|
|
|
limits.EmailsLimit = replenishDurationToDailyLimit(v.config.VisitorEmailLimitReplenish)
|
|
|
|
limits.ReservationsLimit = 0 // No reservations for anonymous users, or users without a tier
|
|
|
|
limits.AttachmentTotalSizeLimit = v.config.VisitorAttachmentTotalSizeLimit
|
|
|
|
limits.AttachmentFileSizeLimit = v.config.AttachmentFileSizeLimit
|
|
|
|
limits.AttachmentExpiryDuration = v.config.AttachmentExpiryDuration
|
|
|
|
}
|
|
|
|
return limits
|
|
|
|
}
|
|
|
|
|
2022-12-28 06:14:14 +03:00
|
|
|
func (v *visitor) Info() (*visitorInfo, error) {
|
2022-12-19 17:59:32 +03:00
|
|
|
v.mu.Lock()
|
2022-12-20 05:42:36 +03:00
|
|
|
messages := v.messages
|
|
|
|
emails := v.emails
|
|
|
|
v.mu.Unlock()
|
2023-01-09 23:40:46 +03:00
|
|
|
var attachmentsBytesUsed int64
|
2022-12-20 05:42:36 +03:00
|
|
|
var err error
|
|
|
|
if v.user != nil {
|
|
|
|
attachmentsBytesUsed, err = v.messageCache.AttachmentBytesUsedByUser(v.user.Name)
|
|
|
|
} else {
|
|
|
|
attachmentsBytesUsed, err = v.messageCache.AttachmentBytesUsedBySender(v.ip.String())
|
|
|
|
}
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2023-01-08 05:04:13 +03:00
|
|
|
var reservations int64
|
2023-01-03 04:08:37 +03:00
|
|
|
if v.user != nil && v.userManager != nil {
|
2023-01-09 23:40:46 +03:00
|
|
|
reservations, err = v.userManager.ReservationsCount(v.user.Name)
|
2023-01-03 04:08:37 +03:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2023-01-02 04:42:33 +03:00
|
|
|
}
|
|
|
|
}
|
2023-01-09 23:40:46 +03:00
|
|
|
limits := v.Limits()
|
|
|
|
stats := &visitorStats{
|
|
|
|
Messages: messages,
|
|
|
|
MessagesRemaining: zeroIfNegative(limits.MessagesLimit - messages),
|
|
|
|
Emails: emails,
|
|
|
|
EmailsRemaining: zeroIfNegative(limits.EmailsLimit - emails),
|
|
|
|
Reservations: reservations,
|
|
|
|
ReservationsRemaining: zeroIfNegative(limits.ReservationsLimit - reservations),
|
|
|
|
AttachmentTotalSize: attachmentsBytesUsed,
|
|
|
|
AttachmentTotalSizeRemaining: zeroIfNegative(limits.AttachmentTotalSizeLimit - attachmentsBytesUsed),
|
|
|
|
}
|
|
|
|
return &visitorInfo{
|
|
|
|
Limits: limits,
|
|
|
|
Stats: stats,
|
|
|
|
}, nil
|
2022-12-20 00:22:13 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
func zeroIfNegative(value int64) int64 {
|
|
|
|
if value < 0 {
|
|
|
|
return 0
|
|
|
|
}
|
|
|
|
return value
|
|
|
|
}
|
|
|
|
|
|
|
|
func replenishDurationToDailyLimit(duration time.Duration) int64 {
|
|
|
|
return int64(24 * time.Hour / duration)
|
|
|
|
}
|
|
|
|
|
|
|
|
func dailyLimitToRate(limit int64) rate.Limit {
|
|
|
|
return rate.Limit(limit) * rate.Every(24*time.Hour)
|
2022-04-03 19:39:52 +03:00
|
|
|
}
|