mirror of
https://github.com/tiennm99/goclaw.git
synced 2026-10-17 00:14:50 +00:00
* refactor(bitrix24): rename "Path B" framing to maintainer-specified naming [B24:2794] Per maintainer hard rule #10 (no generic "Path A/B" framing) from PR #1061 review. The Bitrix24 MCP auto-onboard flow is Bitrix-specific glue ("Bitrix24 OAuth -> existing mcp_user_credentials bridge"), NOT a generic MCP architecture pattern. Naming convention applied consistently: - First mention per file: full "Bitrix24 OAuth -> existing mcp_user_credentials bridge" (matches maintainer comment verbatim). - Subsequent mentions in same file: shortened "mcp_user_credentials bridge". - Test/log context referencing literal endpoint /api/auto-onboard: keep "auto-onboard" reference (it's the actual API endpoint name). Changes are documentation-only: - Rename in code comments + test descriptions + plan docs. - Clarify framing in mcp_client.go + provisioner.go doc comments to emphasize Bitrix-specific glue (not generic MCP infra). - Reuse existing mcp_user_credentials table + MCPServerStore methods (no schema / store / abstraction change). Files: - cmd/gateway.go (factory registration doc) - internal/channels/bitrix24/{channel,factory,mcp_client,provisioner}.go - internal/channels/bitrix24/{mcp_client,provisioner}_test.go - plan/goclaw-mcp-integration.md (21 occurrences) Verified: go build + MCP-related tests pass (TestProvision*, TestInitMCPProvisioner*, TestMCPClient*). Phase 1 of Path C execution per plans/reports/decision-log-260519-1555-bitrix24-pr-fork-decision.md. * fix: confine outbound media paths to agent workspace [B24:2794] Tool MEDIA:<path> output reached channel file-upload sinks (Bitrix imbot.v2.File.upload, Telegram sendDocument, etc.) verbatim via parseMediaResult, with no workspace-boundary check. A malicious or buggy tool emitting MEDIA:/etc/passwd could exfiltrate arbitrary files to chat. Extract the EvalSymlinks+Rel containment from extractMediaFromContent into a shared confineToWorkspace helper and apply it at the parseMediaResult sink in processToolResult. Fixing at the source/egress boundary protects every channel at once rather than per-channel. Paths that escape the workspace are dropped and logged (security.media_path_rejected). Add TestConfineToWorkspace (boundary unit) and TestParseMediaResultConfinedToWorkspace (sink regression for H2). * feat(bitrix24): support inbound + outbound media via imbot.v2 File API [B24:2794] Bitrix24 channel was text-only; attachments were parsed but dropped. - Inbound: download chat files via imbot.v2.File.download (one-time URL), forward to the agent with MIME preserved (internal/channels/bitrix24/download.go). - Outbound: upload agent media to the chat via imbot.v2.File.upload (internal/channels/bitrix24/send_media.go). - Add BaseChannel.HandleMessageMedia to preserve MIME/filename through the bus. - Per-channel media_max_mb cap (default 20) applies to both directions. Tests: 92 pass (internal/channels/bitrix24 + internal/channels), go vet clean (PG + sqliteonly). * refactor(bitrix24): migrate messaging/bot-list/unregister to imbot v2 API [B24:2794] Move outbound REST calls to the imbot v2 family (keeps register on v1): - imbot.message.add -> imbot.v2.Chat.Message.send (fields.message shape, live-verified) - imbot.bot.list (+ legacy imbot.list fallback) -> imbot.v2.Bot.list; add botListRows to normalize the v2 {bots:[...]} envelope, legacy array, and id-keyed map forms - imbot.unregister -> imbot.v2.Bot.unregister Bot registration stays on v1 imbot.register: v2 imbot.v2.Bot.register changes the event-delivery model (per-event handler URLs -> eventMode), which would require rewriting the inbound event parser. No user-facing behavior change. Tests: bitrix24 package green; go vet ./... clean. * feat(bitrix24): route whisper via v1 SKIP_CONNECTOR + add v2 replyId [B24:2794] Bot was leaking HiddenMessage (whisper) replies to the external Zalo connector because every outbound call went through imbot.v2.Chat.Message.send, which has no equivalent of the v1 SKIP_CONNECTOR flag. Branch the outbound path on inbound visibility: whisper → imbot.message.add + SKIP_CONNECTOR=Y (v1, send_v1.go) public → imbot.v2.Chat.Message.send + fields.replyId (v2, send_v2.go) Pipeline: events.go parse data[PARAMS][PARAMS][COMPONENT_ID]=HiddenMessage into EventParams.IsHiddenMessage (form + JSON variants) handle.go set bitrix_visibility on InboundMessage.Metadata consumer forward visibility + message_id into OutboundMessage send.go resolveSendOptions + sendChunk dispatcher + shared callWithRateLimitRetry helper metadata_keys.go single source of truth for the keys + values Defaults preserve pre-refactor behaviour: callers that don't populate bitrix_visibility still go through v2 public, and replyId is omitted unless a numeric bitrix_message_id arrives in metadata. Tests: TestParseEvent_FormURLEncoded_IsHiddenMessage (3 cases) TestParseEvent_JSON_IsHiddenMessage (3 cases) TestResolveSendOptions (8 cases) TestSend_BranchesOnVisibility (4 cases) * feat(bitrix24): openline sender-tag echo on replies [B24:2794] Openline sender-tag echo (this change): - Capture the connector sender tag ("[name #id]:" or "[name] #id:") from inbound openline group messages, strip it from the body the agent sees, and re-prepend the canonical "[name] #id:" form to the reply so the Open Channel connector routes the answer back to the right external user. - New sender_prefix.go helper (+ test) accepts both inbound layouts and emits one canonical form; scoped to messages carrying the tag, so plain chats are unaffected. - metadata_keys.go: MetaKeySenderPrefix; handle.go capture/strip/stash; gateway_consumer_normal.go forwards the key; send.go prepends it on the first chunk before chunking. Bundled bitrix24 channel-core work already on this branch: - handle.go: @mention is the sole trigger for both staff and connector customers; unmentioned traffic is dropped (was: drop all connector msgs). - isGroupMessageType: treat SONET_GROUP "B" as a group. - handle_test.go, mcp_client_test.go: cover the above. * feat(bitrix24): accept colon-less openline sender tag, echo [name] #id [B24:2794] The Open Channel connector dropped the trailing colon from its sender tag: inbound now arrives as "[Name] #id <msg>" (was "[Name] #id: <msg>"). The id-bearing patterns required the colon, so the tag fell through to the name-only branch and the reply echoed "[Name]" — dropping the #id the connector needs to route the answer back. - sender_prefix.go: make the trailing ":" optional on both id layouts ([name #id] / [name] #id, with or without colon) and echo the canonical "[name] #id" (no colon) to match the connector's current format. Bare "[name]" (no id) still echoes "[name]" for Open Channel only. - handle.go: gate the bare name-only layout to Open Channel (isOpenChannel) so ordinary group chats starting with "[x] ..." are left untouched. - sender_prefix_test.go: cover colon/no-colon x id-inside/id-outside, the name-only openline case, and the non-openline no-op. * fix: security and robustness fixes from the bitrix24 channel review [B24:2794] - download.go: block redirect-based SSRF on inbound media. CheckRedirect re-validates each hop (http(s) only, reject private/loopback/link-local hosts, cap hops); the initial portal-domain pin is no longer bypassable via a 3xx to an internal service. Public-host redirects still allowed. - handle.go: extract/echo the openline sender tag only for Open Channel sessions (was: any group chat), removing bogus prefixes in CRM group chats and narrowing the forged-tag misroute surface. - loop_tools.go + loop_media.go: confine result.Media to the agent / team / tenant-allowed roots (new confineToAnyRoot) before a channel uploads it, so a prompt-injected out-of-workspace path (e.g. /etc/passwd) cannot exfiltrate, while legitimate cross-workspace media (team files, delegatee output) still flows. - send_media.go: bounded outbound read via io.LimitReader replaces the os.Stat + os.ReadFile pair, closing the TOCTOU size-cap bypass; cap a single message's outbound attachments at 10 (mirrors inbound). - register.go: paginate imbot.v2.Bot.list (limit/offset + hasNextPage, capped at 40 pages) so verify/lookup see bots past the first 50. - mcp_client.go: redact access_token / refresh_token / client_secret from an echoed MCP error body before it is logged or returned (+ test). * fix(security): validate resolved dial IP on Bitrix media redirects [B24:2794] The inbound media download redirect guard only string-checked the redirect hostname (isPrivateOrLoopback on req.URL.Hostname()), so a redirect to a public hostname that resolves to 127.0.0.1 / 169.254.169.254 / an RFC1918 address — or a DNS-rebinding swap between check and dial — still passed the guard and the client would connect. Reported in PR review. Add security.NewRedirectFollowingSafeClient: it follows redirects but validates the RESOLVED destination IP of every hop at dial time via net.Dialer.Control, reusing the existing blocked-CIDR list. The IP it checks is the IP actually dialed, so both redirect-to-internal and DNS rebinding are refused, while legitimate public CDN redirects still succeed. download.go now uses it instead of the hostname-string guard. Tests: deterministic dial-control table (loopback / link-local / private / multicast / unspecified / public, v4 + v6), malformed/non-IP addr, test bypass, loopback-dial-blocked client wiring, and redirect cap + scheme checks. * feat(bitrix24): per-participant Zalo openline identity from 3-token sender tag [B24:2794] Parse the connector's "[Name] #uid #msgId" sender tag so each external customer in a shared Open Channel group gets its own contact + USER.md instead of collapsing onto the connector proxy id. Identity minting is gated on IS_CONNECTOR=Y to reject operator forged tags. Echo back the msgId only ("#msgId") on replies; keep the legacy single-number and name-only layouts unchanged. Zero DB migration. - sender_prefix.go: parseOpenlineSenderTag() classifies 3-token / legacy / name-only - handle.go: synthetic senderID "openlines:{instance}:{chat}:{uid}" + participant_user_id metadata, gated on FromIsConnector - gateway_consumer_normal.go: deriveGroupUserID() routes participant -> per-person scope, group fallback otherwise - send.go: buildAddressMention numeric-id guard so synthetic ids don't emit invalid [USER=...] BBCode - MetaKeyMessageID kept as Bitrix MESSAGE_ID (drives v2 fields.replyId); connector msgId surfaced only via echo prefix --------- Co-authored-by: DangTinh311 <dangtinh31193@gmail.com> Co-authored-by: Chinh Dang <chinhdang@192.168.68.104>
193 lines
7.2 KiB
Go
193 lines
7.2 KiB
Go
package bitrix24
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/nextlevelbuilder/goclaw/internal/bus"
|
|
"github.com/nextlevelbuilder/goclaw/internal/channels/media"
|
|
"github.com/nextlevelbuilder/goclaw/internal/security"
|
|
)
|
|
|
|
const (
|
|
// maxInboundFiles caps how many attachments we download per message so a
|
|
// single event can't trigger an unbounded fan-out of REST + HTTP calls.
|
|
maxInboundFiles = 10
|
|
// inboundDownloadTimeout bounds a single file download. The REST client's
|
|
// 15s timeout is tuned for JSON calls; media needs a longer, dedicated one.
|
|
inboundDownloadTimeout = 5 * time.Minute
|
|
// maxInboundRedirects caps redirect hops on a download (each re-validated by
|
|
// CheckRedirect). Bitrix download links rarely redirect; a low cap limits a
|
|
// redirect-loop / SSRF-probe before the per-hop host check even runs.
|
|
maxInboundRedirects = 5
|
|
)
|
|
|
|
// fileDownloadResult mirrors the imbot.v2.File.download result envelope.
|
|
// The method returns a one-time, pre-authorized download link.
|
|
type fileDownloadResult struct {
|
|
DownloadURL string `json:"downloadUrl"`
|
|
}
|
|
|
|
// downloadEventFiles resolves and downloads every attachment on a Bitrix24
|
|
// message event, returning bus.MediaFile values ready to publish to the bus.
|
|
//
|
|
// Each file is fetched via imbot.v2.File.download (returns a one-time download
|
|
// URL that already embeds an auth token) then streamed to a temp file under the
|
|
// configured size cap. The MIME type is preserved so the agent pipeline routes
|
|
// the file to the right reader (image / document / audio / video).
|
|
//
|
|
// Best-effort: a single file that fails to resolve or download is logged and
|
|
// skipped — the other files (and the message text) still reach the agent.
|
|
func (c *Channel) downloadEventFiles(ctx context.Context, botID int, files []EventFile) []bus.MediaFile {
|
|
if len(files) == 0 || botID <= 0 {
|
|
return nil
|
|
}
|
|
client := c.Client()
|
|
if client == nil {
|
|
slog.Warn("bitrix24 media: no REST client, skipping inbound files", "portal", c.cfg.Portal)
|
|
return nil
|
|
}
|
|
|
|
maxBytes := int64(c.cfg.MediaMaxMB) * 1024 * 1024
|
|
if maxBytes <= 0 {
|
|
maxBytes = 20 * 1024 * 1024 // applyConfigDefaults should set this; belt-and-braces.
|
|
}
|
|
|
|
if len(files) > maxInboundFiles {
|
|
slog.Warn("bitrix24 media: too many attachments, capping",
|
|
"total", len(files), "cap", maxInboundFiles, "portal", c.cfg.Portal)
|
|
files = files[:maxInboundFiles]
|
|
}
|
|
|
|
// SSRF guard. fetchOneFile validates the *initial* downloadUrl host against
|
|
// the portal domain, but that URL may legitimately 3xx to a public CDN, and a
|
|
// hostile/garbled 3xx could point at an internal service (cloud metadata
|
|
// 169.254.169.254, internal Redis, etc.). NewRedirectFollowingSafeClient
|
|
// re-validates the RESOLVED destination IP of every hop at dial time, so a
|
|
// redirect whose host resolves into a private/loopback/link-local range is
|
|
// refused — even via DNS rebinding — while legitimate public redirects still
|
|
// succeed. Checking the dial IP (not the hostname string) is the fix for the
|
|
// same class of bug as portal-domain validation.
|
|
hc := security.NewRedirectFollowingSafeClient(inboundDownloadTimeout, maxInboundRedirects)
|
|
var out []bus.MediaFile
|
|
for _, f := range files {
|
|
// Pre-flight size check — skip oversized files without a download attempt.
|
|
if f.Size > 0 && f.Size > maxBytes {
|
|
slog.Warn("bitrix24 media: file exceeds size cap, skipping",
|
|
"file_id", f.ID, "size", f.Size, "max", maxBytes)
|
|
continue
|
|
}
|
|
mf, err := c.fetchOneFile(ctx, hc, client, botID, f, maxBytes)
|
|
if err != nil {
|
|
slog.Warn("bitrix24 media: download failed, skipping file",
|
|
"file_id", f.ID, "name", f.Name, "err", err)
|
|
continue
|
|
}
|
|
out = append(out, mf)
|
|
}
|
|
return out
|
|
}
|
|
|
|
// fetchOneFile resolves one attachment's download URL via imbot.v2.File.download
|
|
// and streams it to a temp file, returning a populated bus.MediaFile.
|
|
func (c *Channel) fetchOneFile(ctx context.Context, hc *http.Client, client *Client, botID int, f EventFile, maxBytes int64) (bus.MediaFile, error) {
|
|
// fileId is documented as integer but Bitrix accepts the numeric string;
|
|
// EventFile.ID is already a string, so pass it through verbatim.
|
|
rr, err := client.Call(ctx, "imbot.v2.File.download", map[string]any{
|
|
"botId": botID,
|
|
"fileId": f.ID,
|
|
})
|
|
if err != nil {
|
|
return bus.MediaFile{}, fmt.Errorf("imbot.v2.File.download: %w", err)
|
|
}
|
|
var res fileDownloadResult
|
|
if err := json.Unmarshal(rr.Result, &res); err != nil {
|
|
return bus.MediaFile{}, fmt.Errorf("decode download result: %w", err)
|
|
}
|
|
if res.DownloadURL == "" {
|
|
return bus.MediaFile{}, fmt.Errorf("empty downloadUrl")
|
|
}
|
|
|
|
// Defense in depth: the link must point at the portal domain. The REST API
|
|
// issued it, so this normally holds — the check guards against a malformed
|
|
// or hostile response redirecting our fetch elsewhere (SSRF). Fail CLOSED:
|
|
// reject when either side is empty or they differ, so a blank/unparseable
|
|
// host (exactly the malformed case this exists to catch) is denied.
|
|
dom := client.Domain()
|
|
if host := bxURLHost(res.DownloadURL); dom == "" || host == "" || host != dom {
|
|
return bus.MediaFile{}, fmt.Errorf("downloadUrl host %q != portal %q", host, dom)
|
|
}
|
|
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, res.DownloadURL, nil)
|
|
if err != nil {
|
|
return bus.MediaFile{}, err
|
|
}
|
|
resp, err := hc.Do(req)
|
|
if err != nil {
|
|
return bus.MediaFile{}, fmt.Errorf("GET downloadUrl: %w", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
if resp.StatusCode != http.StatusOK {
|
|
return bus.MediaFile{}, fmt.Errorf("download status %d", resp.StatusCode)
|
|
}
|
|
|
|
mime := resolveMime(f, resp.Header.Get("Content-Type"))
|
|
|
|
tmp, err := os.CreateTemp("", "goclaw_bitrix_*"+filepath.Ext(f.Name))
|
|
if err != nil {
|
|
return bus.MediaFile{}, fmt.Errorf("create temp: %w", err)
|
|
}
|
|
// +1 so we can detect "wrote exactly the cap then more was available".
|
|
written, err := io.Copy(tmp, io.LimitReader(resp.Body, maxBytes+1))
|
|
tmp.Close()
|
|
if err != nil {
|
|
os.Remove(tmp.Name())
|
|
return bus.MediaFile{}, fmt.Errorf("save file: %w", err)
|
|
}
|
|
if written > maxBytes {
|
|
os.Remove(tmp.Name())
|
|
return bus.MediaFile{}, fmt.Errorf("file exceeds %d bytes", maxBytes)
|
|
}
|
|
|
|
slog.Info("bitrix24 media: downloaded inbound file",
|
|
"file_id", f.ID, "name", f.Name, "bytes", written, "mime", mime)
|
|
return bus.MediaFile{Path: tmp.Name(), MimeType: mime, Filename: f.Name}, nil
|
|
}
|
|
|
|
// resolveMime picks the best MIME type for an attachment, preferring the value
|
|
// Bitrix sent in the event, then the download response's Content-Type, then a
|
|
// filename-based guess. Falls back to octet-stream so persistMedia still stores
|
|
// the file (the agent treats unknown types as generic documents).
|
|
func resolveMime(f EventFile, respCT string) string {
|
|
if f.Mime != "" {
|
|
return f.Mime
|
|
}
|
|
if ct := strings.TrimSpace(strings.SplitN(respCT, ";", 2)[0]); ct != "" && ct != "application/octet-stream" {
|
|
return ct
|
|
}
|
|
if detected := media.DetectMIMEType(f.Name); detected != "" {
|
|
return detected
|
|
}
|
|
return "application/octet-stream"
|
|
}
|
|
|
|
// bxURLHost extracts the bare hostname (no port) from a URL, returning "" on
|
|
// parse failure. Hostname() — not Host — so a legitimate ":443" doesn't cause a
|
|
// false mismatch against the portal domain.
|
|
func bxURLHost(raw string) string {
|
|
u, err := url.Parse(raw)
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
return u.Hostname()
|
|
}
|