mirror of
https://github.com/go-gitea/gitea.git
synced 2026-05-13 00:16:07 +02:00
Fix #37564: Rename to StripUrl
This commit is contained in:
parent
8c94ee876c
commit
4646e0bc3f
@ -27,22 +27,20 @@ func SanitizeURL(s string) (string, error) {
|
||||
return u.String(), nil
|
||||
}
|
||||
|
||||
// SanitizeURLForLog returns a redacted form of a URL safe to include in
|
||||
// log lines. It strips userinfo (e.g. https://user:pass@…), the query
|
||||
// string (which may contain signed-URL credentials such as AWS S3 / GCS /
|
||||
// Cloudinary signatures), and the fragment, leaving only scheme+host+path.
|
||||
// On a parse failure the placeholder "<unparseable url>" is returned to
|
||||
// avoid leaking the raw URL into logs.
|
||||
// StripUrl returns the scheme, host, and path portions of s with userinfo,
|
||||
// query string, and fragment removed. Intended for logging URLs whose
|
||||
// userinfo or query string may carry credentials (e.g. https://user:pass@…
|
||||
// or signed S3/GCS/Cloudinary URLs whose signatures live in the query
|
||||
// string). Returns "<unparseable url>" if s cannot be parsed.
|
||||
//
|
||||
// Unlike SanitizeURL this is intended exclusively for logging: callers
|
||||
// that still need to USE the URL (mirroring, indexing, migrations, etc.)
|
||||
// should keep using SanitizeURL because they need the query string
|
||||
// preserved.
|
||||
func SanitizeURLForLog(s string) string {
|
||||
// Unlike SanitizeURL (which only strips userinfo and is used by callers
|
||||
// such as mirroring/indexing/migrations that still need the query string
|
||||
// to actually use the URL), StripUrl is for logging only.
|
||||
func StripUrl(s string) string {
|
||||
u, err := url.Parse(s)
|
||||
if err != nil {
|
||||
return "<unparseable url>"
|
||||
}
|
||||
redacted := url.URL{Scheme: u.Scheme, Host: u.Host, Path: u.Path}
|
||||
return redacted.String()
|
||||
stripped := url.URL{Scheme: u.Scheme, Host: u.Host, Path: u.Path}
|
||||
return stripped.String()
|
||||
}
|
||||
|
||||
@ -9,7 +9,7 @@ import (
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestSanitizeURLForLog(t *testing.T) {
|
||||
func TestStripUrl(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
in string
|
||||
@ -54,7 +54,7 @@ func TestSanitizeURLForLog(t *testing.T) {
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
assert.Equal(t, c.want, SanitizeURLForLog(c.in))
|
||||
assert.Equal(t, c.want, StripUrl(c.in))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@ -308,7 +308,7 @@ func oauth2UpdateAvatarIfNeed(ctx *context.Context, rawURL string, u *user_model
|
||||
}
|
||||
// Compute a redacted URL for log lines BEFORE issuing the request, so we
|
||||
// never accidentally log signed-URL query parameters or userinfo.
|
||||
logURL := util.SanitizeURLForLog(rawURL)
|
||||
logURL := util.StripUrl(rawURL)
|
||||
|
||||
// Bind the outbound fetch to the inbound request context so the download
|
||||
// is cancelled if the user navigates away / aborts login, and so any
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user