Skip to content

Commit

Permalink
fix: update code_verifier to use recommended method (oauth2-proxy#2620)
Browse files Browse the repository at this point in the history
The [RFC](https://datatracker.ietf.org/doc/html/rfc7636#section-4.1)
says that a code verifier just uses unreserved characters, but the
recommended method is that it is a base64-urlencoded 32-octet url. Some
implementations of PKCE (most notably the one used by salesforce)
require that this is a valid base64 encoded string[1], so this patch
switches to using the recommended approach to make it more compatible.

[1]: https://help.salesforce.com/s/articleView?id=sf.remoteaccess_pkce.htm&type=5
  • Loading branch information
vishvananda authored Nov 6, 2024
1 parent 3ceef0c commit 4e2013e
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 17 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
- [#2755](https://github.com/oauth2-proxy/oauth2-proxy/pull/2755) feat: add X-Envoy-External-Address as supported header (@bjencks)
- [#1985](https://github.com/oauth2-proxy/oauth2-proxy/pull/1985) Add support for systemd socket (@isodude)
- [#2300](https://github.com/oauth2-proxy/oauth2-proxy/pull/2300) Add fix for websocket path rewrite (@rekup)
- [#2821](https://github.com/oauth2-proxy/oauth2-proxy/pull/2821) feat: add CF-Connecting-IP as supported real ip header
- [#2821](https://github.com/oauth2-proxy/oauth2-proxy/pull/2821) feat: add CF-Connecting-IP as supported real ip header (@ondrejsika)
- [#2620](https://github.com/oauth2-proxy/oauth2-proxy/pull/2620) fix: update code_verifier to use recommended method (@vishvananda)

# V7.7.1

Expand Down
2 changes: 1 addition & 1 deletion oauthproxy.go
Original file line number Diff line number Diff line change
Expand Up @@ -802,7 +802,7 @@ func (p *OAuthProxy) doOAuthStart(rw http.ResponseWriter, req *http.Request, ove
)
if p.provider.Data().CodeChallengeMethod != "" {
codeChallengeMethod = p.provider.Data().CodeChallengeMethod
codeVerifier, err = encryption.GenerateRandomASCIIString(96)
codeVerifier, err = encryption.GenerateCodeVerifierString(96)
if err != nil {
logger.Errorf("Unable to build random ASCII string for code verifier: %v", err)
p.ErrorPage(rw, req, http.StatusInternalServerError, err.Error())
Expand Down
18 changes: 7 additions & 11 deletions pkg/encryption/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"encoding/base64"
"fmt"
"hash"
"math/big"
"io"
"net/http"
"strconv"
"strings"
Expand Down Expand Up @@ -83,17 +83,13 @@ func SignedValue(seed string, key string, value []byte, now time.Time) (string,
return cookieVal, nil
}

func GenerateRandomASCIIString(length int) (string, error) {
b := make([]byte, length)
charsetLen := new(big.Int).SetInt64(int64(len(asciiCharset)))
for i := range b {
character, err := rand.Int(rand.Reader, charsetLen)
if err != nil {
return "", err
}
b[i] = asciiCharset[character.Int64()]
// GenerateCodeVerifierString returns a base64 encoded string of n random bytes
func GenerateCodeVerifierString(n int) (string, error) {
data := make([]byte, n)
if _, err := io.ReadFull(rand.Reader, data); err != nil {
return "", err
}
return string(b), nil
return base64.URLEncoding.WithPadding(base64.NoPadding).EncodeToString(data), nil
}

func GenerateCodeChallenge(method, codeVerifier string) (string, error) {
Expand Down
8 changes: 4 additions & 4 deletions pkg/encryption/utils_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -130,12 +130,12 @@ func TestValidate(t *testing.T) {
assert.Equal(t, validValue, expectedValue)
}

func TestGenerateRandomASCIIString(t *testing.T) {
randomString, err := GenerateRandomASCIIString(96)
func TestGenerateCodeVerifierString(t *testing.T) {
randomString, err := GenerateCodeVerifierString(96)
assert.NoError(t, err)

// Only 8-bit characters
assert.Equal(t, 96, len([]byte(randomString)))
// Should be 128 characters long
assert.Equal(t, 128, len([]byte(randomString)))

// All non-ascii characters removed should still be the original string
removedChars := strings.Map(func(r rune) rune {
Expand Down

0 comments on commit 4e2013e

Please sign in to comment.