Files
multica/server/internal/integrations/lark/binding_token.go
beast 4217de4389 fix(lark): tolerate binding token clock skew (#5191)
* fix(lark): tolerate binding token clock skew

Clamp binding-token expiry against the database clock while preserving the 15-minute TTL cap. Return the persisted expiry so binding cards reflect the value enforced by Postgres.

* docs(lark): correct stale table name in binding token TTL comments

Post-#124 the table is channel_binding_token (with the
channel_binding_token_ttl_cap CHECK); update the two comments in
types.go and binding_token_test.go that still named the pre-generalization
lark_binding_token table.

---------

Co-authored-by: Bohan-J <bohan.optimism@gmail.com>
2026-07-10 14:47:54 +08:00

305 lines
12 KiB
Go

package lark
import (
"context"
"crypto/rand"
"crypto/sha256"
"encoding/base64"
"encoding/hex"
"errors"
"fmt"
"time"
"github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/pgtype"
db "github.com/multica-ai/multica/server/pkg/db/generated"
)
// BindingToken is the public shape of a freshly minted token. The raw
// token is returned to the caller exactly once — it is the unguessable
// secret embedded in the binding URL the Bot replies with. After this
// call returns, only the hash exists server-side; the raw value
// cannot be recovered from the DB.
type BindingToken struct {
Raw string
ExpiresAt time.Time
}
// RedeemedBindingToken is the row returned to the caller after a
// successful redemption. The redemption path uses these fields to
// write the lark_user_binding row.
type RedeemedBindingToken struct {
WorkspaceID pgtype.UUID
InstallationID pgtype.UUID
LarkOpenID OpenID
}
// InstallerBinder is the narrow surface RegistrationService needs to
// record the installer's lark_user_binding row in the same business
// step as the installation insert. Without this step the first inbound
// message from the installer would be dropped as `unbound_user` and
// the Bot would reply "you're not bound, click here…" to the person
// who just authorized the install seconds ago.
//
// Implementations MUST be idempotent on (installation_id, lark_open_id):
// a re-install by the same user should not error.
//
// `qtx` is the channel-backed handle to run the bind against. The
// caller opens the transaction so the installation insert and the
// binding write commit together; nil means "use the service's own
// (non-transactional) queries handle".
type InstallerBinder interface {
BindInstallerTx(ctx context.Context, qtx *ChannelStore, p InstallerBindParams) error
}
// InstallerBindParams carries the inputs InstallerBinder needs. Kept
// as a struct so adding union_id (Phase 2) does not break callers.
type InstallerBindParams struct {
WorkspaceID pgtype.UUID
InstallationID pgtype.UUID
MulticaUserID pgtype.UUID // the installer's Multica account
LarkOpenID OpenID // the installer's per-installation open_id
}
// BindingTokenService mints and redeems binding tokens for the
// "you're not bound yet, click here" flow. The TTL is fixed at
// BindingTokenTTL (15 min); the DB CHECK enforces the same cap so a
// misconfigured caller cannot quietly mint a longer-lived token.
//
// Redemption (RedeemAndBind) is transactional: consuming the token
// and inserting the lark_user_binding row commit together, so a
// failed bind never burns a token, and a successful bind never
// leaves a consumed-but-unused token behind.
type BindingTokenService struct {
queries *ChannelStore
tx TxStarter
now func() time.Time
}
// NewBindingTokenService constructs the default service. The clock
// is injectable so tests can pin time for deterministic expiry
// behavior; production callers use NewBindingTokenServiceWithClock
// with time.Now.
func NewBindingTokenService(queries *db.Queries, tx TxStarter) *BindingTokenService {
return NewBindingTokenServiceWithClock(queries, tx, time.Now)
}
// NewBindingTokenServiceWithClock is the seam for tests; production
// callers should use NewBindingTokenService. queries is wrapped in a
// ChannelStore so lark_* calls resolve to channel_* rows (MUL-3515).
func NewBindingTokenServiceWithClock(queries *db.Queries, tx TxStarter, now func() time.Time) *BindingTokenService {
return &BindingTokenService{queries: NewChannelStore(queries), tx: tx, now: now}
}
// Mint creates a new single-use binding token and returns the raw
// secret + expiry. The raw value MUST be sent over a secure channel
// to the intended recipient — Lark DMs are encrypted in transit by
// the platform — and never logged. Mint is the only function in this
// package that produces a raw token; subsequent reads are by hash.
func (s *BindingTokenService) Mint(ctx context.Context, workspaceID, installationID pgtype.UUID, openID OpenID) (BindingToken, error) {
raw, err := randomToken(32)
if err != nil {
return BindingToken{}, fmt.Errorf("generate token: %w", err)
}
hash := hashToken(raw)
expiresAt := s.now().Add(BindingTokenTTL)
row, err := s.queries.CreateLarkBindingToken(ctx, CreateBindingTokenParams{
TokenHash: hash,
WorkspaceID: workspaceID,
InstallationID: installationID,
ChannelUserID: string(openID),
ExpiresAt: pgtype.Timestamptz{Time: expiresAt, Valid: true},
})
if err != nil {
return BindingToken{}, fmt.Errorf("persist token: %w", err)
}
return BindingToken{Raw: raw, ExpiresAt: row.ExpiresAt.Time}, nil
}
// RedeemAndBind atomically consumes a raw token and writes the
// lark_user_binding row in a single DB transaction. The redeemer's
// identity is the supplied multicaUserID (taken from the session by
// the handler, never from the token), so a stolen token cannot bind
// a Lark open_id to an attacker's account.
//
// Failure modes are returned as typed errors:
//
// - ErrBindingTokenInvalid: token doesn't exist / already consumed /
// expired. Same opaque error for all three to avoid a timing
// oracle for replay races.
//
// - ErrBindingAlreadyAssigned: a binding already exists for this
// (installation, open_id), pointing at a DIFFERENT Multica user.
// The token is NOT consumed in this case — we roll back so the
// correct holder of the existing binding is not disrupted and
// ops can still revoke the surplus token explicitly. Account
// transfer must go through an explicit unbind, not a redemption.
//
// - ErrBindingNotWorkspaceMember: the redeemer is not a member of
// the token's workspace, which trips the composite FK to
// member(workspace_id, user_id). Rolled back identically.
//
// On the happy path the consume + bind commit together: a successful
// return guarantees both the consumed_at write and the binding row
// landed; a returned error guarantees neither did.
func (s *BindingTokenService) RedeemAndBind(ctx context.Context, raw string, multicaUserID pgtype.UUID) (RedeemedBindingToken, error) {
if s.tx == nil {
return RedeemedBindingToken{}, errors.New("lark: BindingTokenService missing TxStarter")
}
tx, err := s.tx.Begin(ctx)
if err != nil {
return RedeemedBindingToken{}, fmt.Errorf("begin tx: %w", err)
}
defer tx.Rollback(ctx)
qtx := s.queries.WithTx(tx)
row, err := qtx.ConsumeLarkBindingToken(ctx, hashToken(raw))
if err != nil {
if errors.Is(err, pgx.ErrNoRows) {
return RedeemedBindingToken{}, ErrBindingTokenInvalid
}
return RedeemedBindingToken{}, fmt.Errorf("consume token: %w", err)
}
// Explicit membership gate. The lark_user_binding -> member FK that
// used to reject a non-member redeemer is gone (MUL-3515 §4), so we
// check it here. Returning before Commit rolls the consume back, so
// a non-member's attempt does not burn the token — same outcome the
// FK violation produced.
isMember, err := qtx.IsWorkspaceMember(ctx, row.WorkspaceID, multicaUserID)
if err != nil {
return RedeemedBindingToken{}, fmt.Errorf("check membership: %w", err)
}
if !isMember {
return RedeemedBindingToken{}, ErrBindingNotWorkspaceMember
}
_, err = qtx.CreateLarkUserBinding(ctx, CreateUserBindingParams{
WorkspaceID: row.WorkspaceID,
MulticaUserID: multicaUserID,
InstallationID: row.InstallationID,
ChannelUserID: row.ChannelUserID,
})
if err != nil {
// pgx.ErrNoRows here means the conflict row exists but its
// multica_user_id differs from ours, so the WHERE clause on
// the ON CONFLICT DO UPDATE rejected the rebind. See the
// comment on CreateChannelUserBinding in queries/channel.sql.
if errors.Is(err, pgx.ErrNoRows) {
return RedeemedBindingToken{}, ErrBindingAlreadyAssigned
}
return RedeemedBindingToken{}, fmt.Errorf("create binding: %w", err)
}
if err := tx.Commit(ctx); err != nil {
return RedeemedBindingToken{}, fmt.Errorf("commit: %w", err)
}
return RedeemedBindingToken{
WorkspaceID: row.WorkspaceID,
InstallationID: row.InstallationID,
LarkOpenID: OpenID(row.ChannelUserID),
}, nil
}
// BindInstallerTx is the auto-binding path for the device-flow
// install: the user who just authorized the install is recorded as
// bound to their own open_id, so the first inbound message in the
// bot's DM arrives at a `bound` identity check and the user is NOT
// prompted with a redundant "click here to bind" card.
//
// `qtx` is the RegistrationService's transaction-scoped queries
// handle. The service opens a transaction that wraps the
// lark_installation insert and this binding write so a half-applied
// install (installation row without the installer binding) cannot
// land. When `qtx` is nil the service's own (non-transactional)
// queries handle is used, which is the right behavior for tests that
// don't need atomicity.
//
// Token redemption deliberately does NOT share this code path:
// - RedeemAndBind consumes a server-minted token in the same tx as
// the binding insert; that's how anti-replay works.
// - BindInstallerTx is invoked from the device-flow success hook
// where the authoritative proof of identity is the Lark-validated
// polling response (open_id returned alongside the freshly minted
// client_id / client_secret). There is no token to consume, and
// inventing one would only widen the attack surface.
//
// The underlying CreateLarkUserBinding query is idempotent on
// (installation_id, lark_open_id) when multica_user_id matches (the
// ON CONFLICT DO UPDATE gating spelled out on the SQL), so a
// re-install by the same user is a no-op metadata refresh. A
// re-install by a DIFFERENT user surfaces as ErrBindingAlreadyAssigned
// — the registration caller treats that as a hard error and the
// frontend surfaces it as "this Lark account is bound elsewhere",
// preventing one workspace admin from silently rebinding another's
// PersonalAgent install.
func (s *BindingTokenService) BindInstallerTx(ctx context.Context, qtx *ChannelStore, p InstallerBindParams) error {
q := qtx
if q == nil {
q = s.queries
}
// Explicit membership gate, replacing the removed member FK
// (MUL-3515 §4): the installer must be a member of the workspace
// they are binding into.
isMember, err := q.IsWorkspaceMember(ctx, p.WorkspaceID, p.MulticaUserID)
if err != nil {
return fmt.Errorf("check membership: %w", err)
}
if !isMember {
return ErrBindingNotWorkspaceMember
}
_, err = q.CreateLarkUserBinding(ctx, CreateUserBindingParams{
WorkspaceID: p.WorkspaceID,
MulticaUserID: p.MulticaUserID,
InstallationID: p.InstallationID,
ChannelUserID: string(p.LarkOpenID),
})
if err != nil {
if errors.Is(err, pgx.ErrNoRows) {
return ErrBindingAlreadyAssigned
}
return fmt.Errorf("bind installer: %w", err)
}
return nil
}
// ErrBindingTokenInvalid is returned by RedeemAndBind when the token
// hash does not exist, the token has already been consumed, or it
// has expired. The caller must NOT distinguish those sub-cases —
// that distinction enables timing oracles for token replay races and
// adds no product value (the user sees the same "link invalid or
// expired, please request a new one" copy either way).
var ErrBindingTokenInvalid = errors.New("binding token invalid or expired")
// ErrBindingAlreadyAssigned is returned by RedeemAndBind when a
// lark_user_binding row already exists for the (installation,
// open_id) pair and points at a different Multica user. Account
// transfer must go through an explicit unbind flow; a binding token
// cannot be used to grab an already-bound open_id from another user.
var ErrBindingAlreadyAssigned = errors.New("lark open_id is already bound to a different user")
// ErrBindingNotWorkspaceMember is returned by RedeemAndBind and
// BindInstallerTx when the user is not (or no longer) a member of the
// target workspace, detected by an explicit IsWorkspaceMember check
// (MUL-3515 §4 removed the member FK that used to enforce this).
// Translated to 403 at the HTTP boundary.
var ErrBindingNotWorkspaceMember = errors.New("redeemer is not a workspace member")
func randomToken(n int) (string, error) {
buf := make([]byte, n)
if _, err := rand.Read(buf); err != nil {
return "", err
}
// URL-safe so the token embeds cleanly in the binding URL
// without escaping. RawURLEncoding drops `=` padding which is
// optional for decoders and would otherwise look ugly in
// user-visible URLs.
return base64.RawURLEncoding.EncodeToString(buf), nil
}
func hashToken(raw string) string {
sum := sha256.Sum256([]byte(raw))
return hex.EncodeToString(sum[:])
}