mirror of
https://github.com/pomerium/pomerium.git
synced 2025-06-07 21:32:54 +02:00
authenticate: add support for apple identity tokens (#5610)
## Summary Add support for IdP identity token authorization for Apple. Apple does not appear to support access token validation. This allows a user to pass an identity token directly as a bearer token: ``` curl -H 'Authorization: Bearer Apple-Identity-Token' ... ``` ## Related issues - [ENG-2000](https://linear.app/pomerium/issue/ENG-2000/core-implement-token-validation-for-apple) ## Checklist - [x] reference any related issues - [x] updated unit tests - [x] add appropriate label (`enhancement`, `bug`, `breaking`, `dependencies`, `ci`) - [x] ready for review
This commit is contained in:
parent
c1c540f876
commit
93b8c93daa
2 changed files with 102 additions and 8 deletions
|
@ -12,10 +12,12 @@ import (
|
||||||
"net/url"
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
go_oidc "github.com/coreos/go-oidc/v3/oidc"
|
||||||
"github.com/go-jose/go-jose/v3/jwt"
|
"github.com/go-jose/go-jose/v3/jwt"
|
||||||
"golang.org/x/oauth2"
|
"golang.org/x/oauth2"
|
||||||
|
|
||||||
"github.com/pomerium/pomerium/internal/httputil"
|
"github.com/pomerium/pomerium/internal/httputil"
|
||||||
|
"github.com/pomerium/pomerium/internal/jwtutil"
|
||||||
"github.com/pomerium/pomerium/internal/urlutil"
|
"github.com/pomerium/pomerium/internal/urlutil"
|
||||||
"github.com/pomerium/pomerium/internal/version"
|
"github.com/pomerium/pomerium/internal/version"
|
||||||
"github.com/pomerium/pomerium/pkg/identity/identity"
|
"github.com/pomerium/pomerium/pkg/identity/identity"
|
||||||
|
@ -28,9 +30,10 @@ const Name = "apple"
|
||||||
|
|
||||||
const (
|
const (
|
||||||
defaultProviderURL = "https://appleid.apple.com"
|
defaultProviderURL = "https://appleid.apple.com"
|
||||||
tokenURL = "/auth/token" //nolint: gosec
|
tokenURLPath = "/auth/token" //nolint: gosec
|
||||||
authURL = "/auth/authorize"
|
authURLPath = "/auth/authorize"
|
||||||
revocationURL = "/auth/revoke"
|
revocationURLPath = "/auth/revoke"
|
||||||
|
keysURLPath = "/auth/keys"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
@ -44,6 +47,7 @@ var (
|
||||||
type Provider struct {
|
type Provider struct {
|
||||||
oauth *oauth2.Config
|
oauth *oauth2.Config
|
||||||
authCodeOptions map[string]string
|
authCodeOptions map[string]string
|
||||||
|
issuerURL string
|
||||||
}
|
}
|
||||||
|
|
||||||
// New instantiates an OpenID Connect (OIDC) provider for Apple.
|
// New instantiates an OpenID Connect (OIDC) provider for Apple.
|
||||||
|
@ -61,6 +65,7 @@ func New(_ context.Context, o *oauth.Options) (*Provider, error) {
|
||||||
maps.Copy(p.authCodeOptions, defaultAuthCodeOptions)
|
maps.Copy(p.authCodeOptions, defaultAuthCodeOptions)
|
||||||
maps.Copy(p.authCodeOptions, options.AuthCodeOptions)
|
maps.Copy(p.authCodeOptions, options.AuthCodeOptions)
|
||||||
|
|
||||||
|
p.issuerURL = options.ProviderURL
|
||||||
// Apple expects the AuthStyle to use Params instead of Headers
|
// Apple expects the AuthStyle to use Params instead of Headers
|
||||||
// So we have to do our own oauth2 config
|
// So we have to do our own oauth2 config
|
||||||
p.oauth = &oauth2.Config{
|
p.oauth = &oauth2.Config{
|
||||||
|
@ -69,8 +74,8 @@ func New(_ context.Context, o *oauth.Options) (*Provider, error) {
|
||||||
Scopes: options.Scopes,
|
Scopes: options.Scopes,
|
||||||
RedirectURL: options.RedirectURL.String(),
|
RedirectURL: options.RedirectURL.String(),
|
||||||
Endpoint: oauth2.Endpoint{
|
Endpoint: oauth2.Endpoint{
|
||||||
AuthURL: urlutil.Join(options.ProviderURL, authURL),
|
AuthURL: urlutil.Join(p.issuerURL, authURLPath),
|
||||||
TokenURL: urlutil.Join(options.ProviderURL, tokenURL),
|
TokenURL: urlutil.Join(p.issuerURL, tokenURLPath),
|
||||||
AuthStyle: oauth2.AuthStyleInParams,
|
AuthStyle: oauth2.AuthStyleInParams,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
@ -134,7 +139,7 @@ func (p *Provider) Revoke(ctx context.Context, t *oauth2.Token) error {
|
||||||
params.Add("client_id", p.oauth.ClientID)
|
params.Add("client_id", p.oauth.ClientID)
|
||||||
params.Add("client_secret", p.oauth.ClientSecret)
|
params.Add("client_secret", p.oauth.ClientSecret)
|
||||||
|
|
||||||
err := httputil.Do(ctx, http.MethodPost, revocationURL, version.UserAgent(), nil, params, nil)
|
err := httputil.Do(ctx, http.MethodPost, revocationURLPath, version.UserAgent(), nil, params, nil)
|
||||||
if err != nil && errors.Is(err, httputil.ErrTokenRevoked) {
|
if err != nil && errors.Is(err, httputil.ErrTokenRevoked) {
|
||||||
return fmt.Errorf("identity/apple: unexpected revoke error: %w", err)
|
return fmt.Errorf("identity/apple: unexpected revoke error: %w", err)
|
||||||
}
|
}
|
||||||
|
@ -185,10 +190,27 @@ func (p *Provider) SignOut(_ http.ResponseWriter, _ *http.Request, _, _, _ strin
|
||||||
|
|
||||||
// VerifyAccessToken verifies an access token.
|
// VerifyAccessToken verifies an access token.
|
||||||
func (p *Provider) VerifyAccessToken(_ context.Context, _ string) (claims map[string]any, err error) {
|
func (p *Provider) VerifyAccessToken(_ context.Context, _ string) (claims map[string]any, err error) {
|
||||||
|
// apple does not appear to have any way of verifying access tokens
|
||||||
return nil, identity.ErrVerifyAccessTokenNotSupported
|
return nil, identity.ErrVerifyAccessTokenNotSupported
|
||||||
}
|
}
|
||||||
|
|
||||||
// VerifyIdentityToken verifies an identity token.
|
// VerifyIdentityToken verifies an identity token.
|
||||||
func (p *Provider) VerifyIdentityToken(_ context.Context, _ string) (claims map[string]any, err error) {
|
func (p *Provider) VerifyIdentityToken(ctx context.Context, rawIdentityToken string) (claims map[string]any, err error) {
|
||||||
return nil, identity.ErrVerifyIdentityTokenNotSupported
|
keySet := go_oidc.NewRemoteKeySet(ctx, urlutil.Join(p.issuerURL, keysURLPath))
|
||||||
|
verifier := go_oidc.NewVerifier(p.issuerURL, keySet, &go_oidc.Config{
|
||||||
|
ClientID: p.oauth.ClientID,
|
||||||
|
})
|
||||||
|
|
||||||
|
identityToken, err := verifier.Verify(ctx, rawIdentityToken)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error verifying identity token: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
claims = jwtutil.Claims(map[string]any{})
|
||||||
|
err = identityToken.Claims(&claims)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error unmarshaling identity token claims: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return claims, nil
|
||||||
}
|
}
|
||||||
|
|
72
pkg/identity/oauth/apple/apple_test.go
Normal file
72
pkg/identity/oauth/apple/apple_test.go
Normal file
|
@ -0,0 +1,72 @@
|
||||||
|
package apple_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/rsa"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3"
|
||||||
|
"github.com/go-jose/go-jose/v3/jwt"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/pomerium/pomerium/internal/testutil"
|
||||||
|
"github.com/pomerium/pomerium/internal/urlutil"
|
||||||
|
"github.com/pomerium/pomerium/pkg/identity/oauth"
|
||||||
|
"github.com/pomerium/pomerium/pkg/identity/oauth/apple"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestVerifyIdentityToken(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ctx := testutil.GetContext(t, time.Minute)
|
||||||
|
|
||||||
|
privateKey, err := rsa.GenerateKey(rand.Reader, 2048)
|
||||||
|
require.NoError(t, err)
|
||||||
|
jwtSigner, err := jose.NewSigner(jose.SigningKey{Algorithm: jose.RS256, Key: privateKey}, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
iat := time.Now().Unix()
|
||||||
|
exp := iat + 3600
|
||||||
|
|
||||||
|
m := http.NewServeMux()
|
||||||
|
m.HandleFunc("GET /auth/keys", func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
json.NewEncoder(w).Encode(jose.JSONWebKeySet{
|
||||||
|
Keys: []jose.JSONWebKey{
|
||||||
|
{Key: privateKey.Public(), Use: "sig", Algorithm: "RS256"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
srv := httptest.NewServer(m)
|
||||||
|
|
||||||
|
rawIdentityToken1, err := jwt.Signed(jwtSigner).Claims(map[string]any{
|
||||||
|
"iss": srv.URL,
|
||||||
|
"aud": "CLIENT_ID",
|
||||||
|
"sub": "subject",
|
||||||
|
"exp": exp,
|
||||||
|
"iat": iat,
|
||||||
|
}).CompactSerialize()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
p, err := apple.New(ctx, &oauth.Options{
|
||||||
|
ProviderURL: srv.URL,
|
||||||
|
ClientID: "CLIENT_ID",
|
||||||
|
ClientSecret: "CLIENT_SECRET",
|
||||||
|
RedirectURL: urlutil.MustParseAndValidateURL("https://www.example.com"),
|
||||||
|
})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
claims, err := p.VerifyIdentityToken(ctx, rawIdentityToken1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
delete(claims, "iat")
|
||||||
|
delete(claims, "exp")
|
||||||
|
assert.Equal(t, map[string]any{
|
||||||
|
"aud": "CLIENT_ID",
|
||||||
|
"iss": srv.URL,
|
||||||
|
"sub": "subject",
|
||||||
|
}, claims)
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue