go-pkgz / auth / 32997592455

87%

push

github

Make the Telegram API base URL configurable, and close what that opens (#316)

* Allow pointing the Telegram provider at another API base URL

The bot API host was formatted inline in two places, the bot methods and
the file downloads, so nothing outside this package could redirect them.
That makes the Telegram provider unreachable from any test that is not
willing to talk to the live API, and it leaves operators behind a proxy
with no way in either.

NewTelegramAPIWithBaseURL takes the base and derives both forms from it.
NewTelegramAPI keeps its signature and its behaviour, delegating with the
public API, so existing callers are unaffected. An empty base falls back
to the public API rather than producing requests against nothing, and a
trailing slash is trimmed so callers need not care.

The test stands up a substitute API and checks every call reaches it,
including the avatar download, which is the second URL and the one easy
to miss.

Mirrored in v1 and v2 per the project rule for shared behaviour.

* Address review: redact the token, validate the base, use the caller's client

Making the host caller-supplied moved a token-bearing URL across a
boundary that used to be frozen, and three things behind it were not
built for that.

The bot token could reach the error text. request redacted its own two
paths and then returned parseError bare, which interpolates the upstream
description raw, so a proxy answering 502 with the request URI in it put
the token into the log through Run, GetUpdates and Send. The token
itself is now scrubbed from anything leaving request, rather than
matching a URL shape, since the leak is whatever the upstream chose to
echo. Covered by a server that echoes its request URI.

The base URL was unvalidated, so "https://api.telegram.org@evil.tld"
resolved to evil.tld and shipped /bot<token>/ there. The constructor
returns an error now: absolute http or https, host required, no
userinfo, query, fragment or opaque part, an optional ... (continued)

115 of 121 new or added lines in 1 file covered. (95.04%)

3332 of 3843 relevant lines covered (86.7%)

9.85 hits per line