Skip to content

feat: add PKCE support for /resend #2401

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

Merged
cemalkilic merged 1 commit into from
Apr 2, 2026
Merged

feat: add PKCE support for /resend #2401

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: 24 additions & 7 deletions internal/api/resend.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,22 @@ import (

// ResendConfirmationParams holds the parameters for a resend request
type ResendConfirmationParams struct {
Type string `json:"type"`
Email string `json:"email"`
Phone string `json:"phone"`
Type string `json:"type"`
Email string `json:"email"`
Phone string `json:"phone"`
CodeChallenge string `json:"code_challenge"`
CodeChallengeMethod string `json:"code_challenge_method"`
}

func (p *ResendConfirmationParams) Validate(a *API) error {
config := a.config

switch p.Type {
case mail.SignupVerification, mail.EmailChangeVerification, smsVerification, phoneChangeVerification:
case mail.SignupVerification, mail.EmailChangeVerification:
if err := validatePKCEParams(p.CodeChallengeMethod, p.CodeChallenge); err != nil {
return err
}
case smsVerification, phoneChangeVerification:
break
default:
// type does not match one of the above
Expand Down Expand Up @@ -121,8 +127,13 @@ func (a *API) Resend(w http.ResponseWriter, r *http.Request) error {
if terr := models.NewAuditLogEntry(config.AuditLog, r, tx, user, models.UserConfirmationRequestedAction, "", nil); terr != nil {
return terr
}
// PKCE not implemented yet
return a.sendConfirmation(r, tx, user, models.ImplicitFlow)
flowType := getFlowFromChallenge(params.CodeChallenge)
if isPKCEFlow(flowType) {
if _, terr := generateFlowState(tx, models.EmailSignup.String(), models.EmailSignup, params.CodeChallengeMethod, params.CodeChallenge, &user.ID); terr != nil {
return terr
}
}
return a.sendConfirmation(r, tx, user, flowType)
case smsVerification:
if terr := models.NewAuditLogEntry(config.AuditLog, r, tx, user, models.UserRecoveryRequestedAction, "", nil); terr != nil {
return terr
Expand All @@ -133,7 +144,13 @@ func (a *API) Resend(w http.ResponseWriter, r *http.Request) error {
}
messageID = mID
case mail.EmailChangeVerification:
return a.sendEmailChange(r, tx, user, user.EmailChange, models.ImplicitFlow)
flowType := getFlowFromChallenge(params.CodeChallenge)
if isPKCEFlow(flowType) {
if _, terr := generateFlowState(tx, models.EmailChange.String(), models.EmailChange, params.CodeChallengeMethod, params.CodeChallenge, &user.ID); terr != nil {
return terr
}
}
return a.sendEmailChange(r, tx, user, user.EmailChange, flowType)
case phoneChangeVerification:
mID, terr := a.sendPhoneConfirmation(r, tx, user, user.PhoneChange, phoneChangeVerification, sms_provider.SMSProvider)
if terr != nil {
Expand Down
134 changes: 132 additions & 2 deletions internal/api/resend_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"

Expand Down Expand Up @@ -109,6 +110,68 @@ func (ts *ResendTestSuite) TestResendValidation() {

}

func (ts *ResendTestSuite) TestResendPKCEValidation() {
const validChallenge = "testtesttesttesttesttesttestteststeststesttesttesttest"
cases := []struct {
desc string
params map[string]interface{}
expected map[string]interface{}
}{
{
desc: "Signup with code_challenge but missing code_challenge_method",
params: map[string]interface{}{
"type": "signup",
"email": "foo@example.com",
"code_challenge": validChallenge,
},
expected: map[string]interface{}{
"code": http.StatusBadRequest,
"message": InvalidPKCEParamsErrorMessage,
},
},
{
desc: "Signup with code_challenge_method but missing code_challenge",
params: map[string]interface{}{
"type": "signup",
"email": "foo@example.com",
"code_challenge_method": "s256",
},
expected: map[string]interface{}{
"code": http.StatusBadRequest,
"message": InvalidPKCEParamsErrorMessage,
},
},
{
desc: "Email change with code_challenge but missing code_challenge_method",
params: map[string]interface{}{
"type": "email_change",
"email": "foo@example.com",
"code_challenge": validChallenge,
},
expected: map[string]interface{}{
"code": http.StatusBadRequest,
"message": InvalidPKCEParamsErrorMessage,
},
},
}
for _, c := range cases {
ts.Run(c.desc, func() {
var buffer bytes.Buffer
require.NoError(ts.T(), json.NewEncoder(&buffer).Encode(c.params))
req := httptest.NewRequest(http.MethodPost, "http://localhost/resend", &buffer)
req.Header.Set("Content-Type", "application/json")

w := httptest.NewRecorder()
ts.API.handler.ServeHTTP(w, req)
require.Equal(ts.T(), c.expected["code"], w.Code)

data := make(map[string]interface{})
require.NoError(ts.T(), json.NewDecoder(w.Body).Decode(&data))
require.Equal(ts.T(), c.expected["message"], data["msg"])
})
}
}

func (ts *ResendTestSuite) TestResendSuccess() {
// Create user
u, err := models.NewUser("123456789", "foo@example.com", "password", ts.Config.JWT.Aud, nil)
Expand Down Expand Up @@ -150,8 +213,7 @@ func (ts *ResendTestSuite) TestResendSuccess() {
cases := []struct {
desc string
params map[string]interface{}
// expected map[string]interface{}
user *models.User
user *models.User
}{
{
desc: "Resend signup confirmation",
Expand Down Expand Up @@ -215,3 +277,71 @@ func (ts *ResendTestSuite) TestResendSuccess() {
})
}
}

func (ts *ResendTestSuite) TestResendPKCESuccess() {
const testCodeChallenge = "testtesttesttesttesttesttestteststeststesttesttesttest"

// Avoid max freq limit error
now := time.Now().Add(-1 * time.Minute)

ts.Config.Mailer.SecureEmailChangeEnabled = false

// Fresh user for signup PKCE resend
signupUser, err := models.NewUser("", "pkce-signup@example.com", "password", ts.Config.JWT.Aud, nil)
require.NoError(ts.T(), err)
signupUser.ConfirmationToken = "oldtoken"
signupUser.ConfirmationSentAt = &now
require.NoError(ts.T(), ts.API.db.Create(signupUser))
require.NoError(ts.T(), models.CreateOneTimeToken(ts.API.db, signupUser.ID, signupUser.GetEmail(), signupUser.ConfirmationToken, models.ConfirmationToken))

// Fresh user for email_change PKCE resend
emailChangeUser, err := models.NewUser("", "pkce-change@example.com", "password", ts.Config.JWT.Aud, nil)
require.NoError(ts.T(), err)
emailChangeUser.EmailChange = "pkce-change-new@example.com"
emailChangeUser.EmailChangeSentAt = &now
emailChangeUser.EmailChangeTokenNew = "oldchangetoken"
require.NoError(ts.T(), ts.API.db.Create(emailChangeUser))
require.NoError(ts.T(), models.CreateOneTimeToken(ts.API.db, emailChangeUser.ID, emailChangeUser.EmailChange, emailChangeUser.EmailChangeTokenNew, models.EmailChangeTokenNew))

ts.Run("Resend signup confirmation with PKCE", func() {
var buffer bytes.Buffer
require.NoError(ts.T(), json.NewEncoder(&buffer).Encode(map[string]interface{}{
"type": "signup",
"email": signupUser.GetEmail(),
"code_challenge": testCodeChallenge,
"code_challenge_method": "s256",
}))
req := httptest.NewRequest(http.MethodPost, "http://localhost/resend", &buffer)
req.Header.Set("Content-Type", "application/json")

w := httptest.NewRecorder()
ts.API.handler.ServeHTTP(w, req)
require.Equal(ts.T(), http.StatusOK, w.Code)

dbUser, err := models.FindUserByID(ts.API.db, signupUser.ID)
require.NoError(ts.T(), err)
require.NotEqual(ts.T(), dbUser.ConfirmationToken, signupUser.ConfirmationToken)
require.True(ts.T(), strings.HasPrefix(dbUser.ConfirmationToken, PKCEPrefix), "expected pkce_ prefix on ConfirmationToken, got: %s", dbUser.ConfirmationToken)
})

ts.Run("Resend email change with PKCE", func() {
var buffer bytes.Buffer
require.NoError(ts.T(), json.NewEncoder(&buffer).Encode(map[string]interface{}{
"type": "email_change",
"email": emailChangeUser.GetEmail(),
"code_challenge": testCodeChallenge,
"code_challenge_method": "s256",
}))
req := httptest.NewRequest(http.MethodPost, "http://localhost/resend", &buffer)
req.Header.Set("Content-Type", "application/json")

w := httptest.NewRecorder()
ts.API.handler.ServeHTTP(w, req)
require.Equal(ts.T(), http.StatusOK, w.Code)

dbUser, err := models.FindUserByID(ts.API.db, emailChangeUser.ID)
require.NoError(ts.T(), err)
require.NotEqual(ts.T(), dbUser.EmailChangeTokenNew, emailChangeUser.EmailChangeTokenNew)
require.True(ts.T(), strings.HasPrefix(dbUser.EmailChangeTokenNew, PKCEPrefix), "expected pkce_ prefix on EmailChangeTokenNew, got: %s", dbUser.EmailChangeTokenNew)
})
}
Loading