Skip to content

fix: preserve API_EXTERNAL_URL path when building confirmation links #2591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tsushanth wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: preserve API_EXTERNAL_URL path when building confirmation links #2591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions internal/mailer/templatemailer/templatemailer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ func (m *Mailer) InviteMail(r *http.Request, user *models.User, otp, referrerURL

data := map[string]any{
"SiteURL": m.cfg.SiteURL,
"ConfirmationURL": externalURL.ResolveReference(path).String(),
"ConfirmationURL": resolveWithBasePath(externalURL, path).String(),
"Email": user.Email,
"Token": otp,
"TokenHash": user.ConfirmationToken,
Expand All @@ -232,7 +232,7 @@ func (m *Mailer) ConfirmationMail(r *http.Request, user *models.User, otp, refer

data := map[string]any{
"SiteURL": m.cfg.SiteURL,
"ConfirmationURL": externalURL.ResolveReference(path).String(),
"ConfirmationURL": resolveWithBasePath(externalURL, path).String(),
"Email": user.Email,
"Token": otp,
"TokenHash": user.ConfirmationToken,
Expand Down Expand Up @@ -297,7 +297,7 @@ func (m *Mailer) EmailChangeMail(r *http.Request, user *models.User, otpNew, otp
go func(address, token, tokenHash string) {
data := map[string]any{
"SiteURL": m.cfg.SiteURL,
"ConfirmationURL": externalURL.ResolveReference(path).String(),
"ConfirmationURL": resolveWithBasePath(externalURL, path).String(),
"Email": user.GetEmail(),
"NewEmail": user.EmailChange,
"Token": token,
Expand Down Expand Up @@ -337,7 +337,7 @@ func (m *Mailer) RecoveryMail(r *http.Request, user *models.User, otp, referrerU
}
data := map[string]any{
"SiteURL": m.cfg.SiteURL,
"ConfirmationURL": externalURL.ResolveReference(path).String(),
"ConfirmationURL": resolveWithBasePath(externalURL, path).String(),
"Email": user.Email,
"Token": otp,
"TokenHash": user.RecoveryToken,
Expand All @@ -360,7 +360,7 @@ func (m *Mailer) MagicLinkMail(r *http.Request, user *models.User, otp, referrer

data := map[string]any{
"SiteURL": m.cfg.SiteURL,
"ConfirmationURL": externalURL.ResolveReference(path).String(),
"ConfirmationURL": resolveWithBasePath(externalURL, path).String(),
"Email": user.Email,
"Token": otp,
"TokenHash": user.RecoveryToken,
Expand Down Expand Up @@ -418,7 +418,7 @@ func (m *Mailer) GetEmailActionLink(user *models.User, actionType, referrerURL s
if err != nil {
return "", err
}
return externalURL.ResolveReference(path).String(), nil
return resolveWithBasePath(externalURL, path).String(), nil
}

func (m *Mailer) PasswordChangedNotificationMail(r *http.Request, user *models.User) error {
Expand Down Expand Up @@ -491,6 +491,25 @@ func (m *Mailer) MFAFactorUnenrolledNotificationMail(r *http.Request, user *mode
return m.mail(r.Context(), m.cfg, MFAFactorUnenrolledNotificationTemplate, user.GetEmail(), data)
}

// resolveWithBasePath is like url.ResolveReference but preserves the path
// prefix of the base URL. url.ResolveReference implements RFC 3986 §5.2 which
// replaces the entire base path when the reference path is absolute; this
// causes the path component of API_EXTERNAL_URL (e.g. /auth/v1) to be
// silently dropped when building email confirmation links.
func resolveWithBasePath(base *url.URL, ref *url.URL) *url.URL {
result := *base
if ref.Path != "" {
if strings.HasPrefix(ref.Path, "/") {
result.Path = strings.TrimRight(base.Path, "/") + ref.Path
} else {
result.Path = strings.TrimRight(base.Path, "/") + "/" + ref.Path
}
}
result.RawQuery = ref.RawQuery
result.Fragment = ref.Fragment
return &result
}

type emailParams struct {
Token string
Type string
Expand Down
10 changes: 8 additions & 2 deletions internal/mailer/templatemailer/templatemailer_url_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func TestGetPath(t *testing.T) {
SiteURL: "https://test.example.com/removedpath",
Path: "/templates/confirm.html",
Params: nil,
Expected: "https://test.example.com/templates/confirm.html",
Expected: "https://test.example.com/removedpath/templates/confirm.html",
},
{
SiteURL: "https://test.example.com/",
Expand All @@ -56,6 +56,12 @@ func TestGetPath(t *testing.T) {
Params: &params,
Expected: "https://test.example.com?token=token&type=signup&redirect_to=https://example.com",
},
{
SiteURL: "http://127.0.0.1:54321/auth/v1",
Path: "/verify",
Params: nil,
Expected: "http://127.0.0.1:54321/auth/v1/verify",
},
}

for _, c := range cases {
Expand All @@ -65,7 +71,7 @@ func TestGetPath(t *testing.T) {
path, err := getPath(c.Path, c.Params)

assert.NoError(t, err)
assert.Equal(t, c.Expected, u.ResolveReference(path).String())
assert.Equal(t, c.Expected, resolveWithBasePath(u, path).String())
}
}

Expand Down