mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-10-01 19:52:09 +03:00
7aa5fc085f
* feat(tgbot): gate the bot behind three user levels Every Telegram account that found the bot could run /help, /status and /usage, and tap any client button it could forge: nothing separated an account no admin had bound from a customer. Each update now resolves to stranger, client or admin, and commands are allowlisted per level so a command added later stays admin-only until it is listed. A stranger may run /start and /id only, and /start answers with the ChatID an admin needs to bind it; a stranger's callbacks are answered and dropped. Client detection reads the same tgId lookup as clientOwnedByTgUser, so the level gate and the ownership check agree. The bot also ignores everything outside private chats: authorization keys on the sender while wizard state keys on the chat, and the two are the same identity only in a private chat. * feat(tgbot): bind Telegram accounts through /start deep links Linking a customer meant the customer sending /id and an admin copying the ChatID into the client by hand, which does not scale past a few customers and is easy to get wrong. The admin client card now offers an invite link, t.me/<bot>?start=<subId>, and the first account to open it is bound through the existing SetClientTelegramUserID. A subId already grants the subscription, so binding gives the holder nothing the token did not. A subscription that spans several clients binds all of them, and is refused if any part belongs to another account; re-opening your own link is idempotent. Unknown and already-claimed tokens share one reply, so the link cannot be used to probe for valid subIds. * fix(tgbot): harden invite claims after review Review of the access-level and binding change found five problems: - Concurrent claims of one link all read the client as unbound, all bound and all were told so, while only the last write held. Resolving and binding now share one lock, and a bind that fails part-way through a multi-client subscription undoes the bindings it already made. - A subId has no minimum strength and the bot needs only its public username, so /start was an unthrottled guessing oracle. Non-admin claim attempts are capped at five per account per hour, the first refused one notifies the admins, and the Subscription ID field now says it doubles as the bot invite code. - levelOf expanded every inbound's client JSON on every non-admin update. It now reads the indexed tg_id column of the clients table. - A button tapped in a group chat was dropped unanswered and kept spinning, with nothing logged. It is answered now, and each ignored chat is logged once. - The subId was pasted raw into the t.me link, so '#' or '&' truncated it and Telegram rejects anything outside A-Za-z0-9_-. The payload is now base64url, and a subId too long for the 64-character limit is refused. * fix(tgbot): answer group chats again and make the claim race test bite ignoredChat dropped every non-private chat because wizard state was keyed by chat while authorization keyed on the sender. #6604 on main re-keyed that state by (chat, user) so admins can drive the bot from a group, so after the merge the drop only took the whole bot away from those admins, report keyboards sent to a group included. The level gate already keys on the sender, so group chats need no special case. TestConcurrentClaimsBindOnlyOneAccount passed with inviteClaimMu removed: the first claimant took the pool's idle connection and bound before the rest had opened theirs, so no two ever raced. It now holds the inbound write the binds need until every claimant has resolved, and fails without the lock ("6 accounts told they bound"). TestCommandAllowed restated the commandsByLevel map; TestGateCommand drives the same allowlist through gateCommand. TestIgnoredChat goes with the code it pinned. * docs(tgbot): document access levels and invite links The command table still said /help and /status answer anyone. An account no admin has linked now reaches only /start and /id, and a customer is linked through the client card's Invite Link, whose token is the Subscription ID. Updated in en, fa, ru and zh. --------- Co-authored-by: MHSanaei <ho3ein.sanaei@gmail.com>
238 lines
7.1 KiB
Go
238 lines
7.1 KiB
Go
package tgbot
|
|
|
|
import (
|
|
"encoding/base64"
|
|
"html"
|
|
"strconv"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/logger"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/util/common"
|
|
|
|
"github.com/mymmrac/telego"
|
|
)
|
|
|
|
type inviteOutcome int
|
|
|
|
const (
|
|
inviteInvalid inviteOutcome = iota
|
|
inviteTaken
|
|
inviteAlreadyOwned
|
|
inviteBindable
|
|
)
|
|
|
|
// A client's SubID doubles as its invite token: whoever holds it can already
|
|
// fetch the subscription, so binding grants no access the token did not.
|
|
func (t *Tgbot) resolveInviteToken(token string, fromID int64) (inviteOutcome, []*model.ClientRecord) {
|
|
token = strings.TrimSpace(token)
|
|
if token == "" || fromID <= 0 {
|
|
return inviteInvalid, nil
|
|
}
|
|
records, err := t.clientService.GetRecordsBySubID(token)
|
|
if err != nil || len(records) == 0 {
|
|
return inviteInvalid, nil
|
|
}
|
|
return classifyInvite(records, fromID), records
|
|
}
|
|
|
|
// One subscription can span several clients, so a token is claimable only when
|
|
// no part of it belongs to someone else.
|
|
func classifyInvite(records []*model.ClientRecord, fromID int64) inviteOutcome {
|
|
unbound := false
|
|
for _, record := range records {
|
|
switch record.TgID {
|
|
case 0:
|
|
unbound = true
|
|
case fromID:
|
|
default:
|
|
return inviteTaken
|
|
}
|
|
}
|
|
if unbound {
|
|
return inviteBindable
|
|
}
|
|
return inviteAlreadyOwned
|
|
}
|
|
|
|
// Claims run on concurrent handlers, so resolving and binding happen under one
|
|
// lock: a second claimant must see the first one's binding, not the rows it read.
|
|
var inviteClaimMu sync.Mutex
|
|
|
|
// claimInvite reports the outcome it told the user, bindErr aside, so a caller
|
|
// can tell a bind that landed from a refusal without reading the reply.
|
|
func (t *Tgbot) claimInvite(chatId int64, fromID int64, payload string) inviteOutcome {
|
|
token, ok := decodeInvitePayload(payload)
|
|
if !ok {
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.messages.inviteInvalid"))
|
|
return inviteInvalid
|
|
}
|
|
|
|
inviteClaimMu.Lock()
|
|
outcome, records := t.resolveInviteToken(token, fromID)
|
|
var bindErr error
|
|
if outcome == inviteBindable {
|
|
bindErr = t.bindRecordsToUser(records, fromID)
|
|
}
|
|
inviteClaimMu.Unlock()
|
|
|
|
switch outcome {
|
|
case inviteAlreadyOwned:
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.messages.inviteBound", "Email=="+recordEmails(records)))
|
|
case inviteBindable:
|
|
if bindErr != nil {
|
|
logger.Warning("tgbot: invite bind failed:", bindErr)
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.answers.errorOperation"))
|
|
return inviteInvalid
|
|
}
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.messages.inviteBound", "Email=="+recordEmails(records)))
|
|
default:
|
|
// Unknown and already-claimed tokens share one reply, so a prober cannot
|
|
// tell a valid SubID from an invalid one.
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.messages.inviteInvalid"))
|
|
}
|
|
return outcome
|
|
}
|
|
|
|
func recordEmails(records []*model.ClientRecord) string {
|
|
emails := make([]string, 0, len(records))
|
|
for _, record := range records {
|
|
emails = append(emails, record.Email)
|
|
}
|
|
return strings.Join(emails, ", ")
|
|
}
|
|
|
|
// Every unbound client behind the token is bound, so a subscription spanning
|
|
// several inbounds does not leave the customer holding only part of it. A failure
|
|
// part-way undoes this claim's bindings, so the reply never hides a half-bind.
|
|
func (t *Tgbot) bindRecordsToUser(records []*model.ClientRecord, tgID int64) error {
|
|
var bound []int
|
|
for _, record := range records {
|
|
if record.TgID != 0 {
|
|
continue
|
|
}
|
|
traffic, err := t.inboundService.GetClientTrafficByEmail(record.Email)
|
|
if err == nil && traffic == nil {
|
|
err = common.NewError("no traffic record for client:", record.Email)
|
|
}
|
|
if err == nil {
|
|
err = t.setClientTgID(traffic.Id, tgID)
|
|
}
|
|
if err != nil {
|
|
for _, trafficID := range bound {
|
|
if undoErr := t.setClientTgID(trafficID, EmptyTelegramUserID); undoErr != nil {
|
|
logger.Warning("tgbot: undoing partial invite bind failed:", undoErr)
|
|
}
|
|
}
|
|
return err
|
|
}
|
|
bound = append(bound, traffic.Id)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (t *Tgbot) setClientTgID(trafficID int, tgID int64) error {
|
|
needRestart, err := t.clientService.SetClientTelegramUserID(&t.inboundService, trafficID, tgID)
|
|
if needRestart {
|
|
t.xrayService.SetToNeedRestart()
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Telegram accepts only A-Za-z0-9_- in a start payload, at most 64 characters,
|
|
// while a subId may hold '#', '&' or non-ASCII; base64url carries any subId
|
|
// that fits intact instead of letting the link truncate it into another one.
|
|
const maxInvitePayload = 64
|
|
|
|
func encodeInvitePayload(subID string) (string, bool) {
|
|
payload := base64.RawURLEncoding.EncodeToString([]byte(subID))
|
|
return payload, len(payload) <= maxInvitePayload
|
|
}
|
|
|
|
func decodeInvitePayload(payload string) (string, bool) {
|
|
raw, err := base64.RawURLEncoding.DecodeString(strings.TrimSpace(payload))
|
|
if err != nil || len(raw) == 0 {
|
|
return "", false
|
|
}
|
|
return string(raw), true
|
|
}
|
|
|
|
func (t *Tgbot) sendInviteLink(chatId int64, email string) {
|
|
record, err := t.clientService.GetRecordByEmail(nil, email)
|
|
username := botUsername()
|
|
if err != nil || record.SubID == "" || username == "" {
|
|
logger.Warning("tgbot: invite link unavailable for", email, err)
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.answers.errorOperation"))
|
|
return
|
|
}
|
|
payload, ok := encodeInvitePayload(record.SubID)
|
|
if !ok {
|
|
logger.Warning("tgbot: subId of", email, "is too long for a Telegram invite link")
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.answers.errorOperation"))
|
|
return
|
|
}
|
|
link := "https://t.me/" + username + "?start=" + payload
|
|
t.SendMsgToTgbot(chatId, t.I18nBot("tgbot.messages.inviteLink", "Email=="+email, "Link=="+link))
|
|
}
|
|
|
|
// A subId can be short or human-readable, so claim attempts are capped per
|
|
// Telegram account: guessing stays slow, and admins hear about whoever tries.
|
|
const (
|
|
inviteAttemptLimit = 5
|
|
inviteAttemptWindow = time.Hour
|
|
)
|
|
|
|
type inviteAttempts struct {
|
|
windowStart time.Time
|
|
count int
|
|
}
|
|
|
|
var (
|
|
inviteAttemptsMu sync.Mutex
|
|
inviteAttemptsBy = map[int64]*inviteAttempts{}
|
|
inviteAttemptsNow = time.Now
|
|
)
|
|
|
|
// allowInviteAttempt counts one claim attempt and reports whether it may run.
|
|
// Admins are told once per window, on the first attempt past the limit.
|
|
func (t *Tgbot) allowInviteAttempt(from *telego.User) bool {
|
|
now := inviteAttemptsNow()
|
|
inviteAttemptsMu.Lock()
|
|
for id, a := range inviteAttemptsBy {
|
|
if now.Sub(a.windowStart) >= inviteAttemptWindow {
|
|
delete(inviteAttemptsBy, id)
|
|
}
|
|
}
|
|
a, ok := inviteAttemptsBy[from.ID]
|
|
if !ok {
|
|
a = &inviteAttempts{windowStart: now}
|
|
inviteAttemptsBy[from.ID] = a
|
|
}
|
|
a.count++
|
|
count := a.count
|
|
inviteAttemptsMu.Unlock()
|
|
|
|
if count == inviteAttemptLimit+1 {
|
|
t.SendMsgToTgbotAdmins(t.I18nBot("tgbot.messages.inviteRateLimitedAdmin",
|
|
"User=="+tgUserMention(from),
|
|
"ID=="+strconv.FormatInt(from.ID, 10),
|
|
"Limit=="+strconv.Itoa(inviteAttemptLimit)))
|
|
}
|
|
return count <= inviteAttemptLimit
|
|
}
|
|
|
|
func tgUserMention(from *telego.User) string {
|
|
id := strconv.FormatInt(from.ID, 10)
|
|
name := strings.TrimSpace(from.FirstName + " " + from.LastName)
|
|
if name == "" {
|
|
name = id
|
|
}
|
|
mention := `<a href="tg://user?id=` + id + `">` + html.EscapeString(name) + `</a>`
|
|
if from.Username != "" {
|
|
mention += " @" + html.EscapeString(from.Username)
|
|
}
|
|
return mention
|
|
}
|