Skip to content
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

Jump to bottom

[keyvault] add cae support #23543

Merged
merged 7 commits into from
Oct 18, 2024
Merged

[keyvault] add cae support #23543

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e5e6d4b
cae-tests
gracewilcox Oct 3, 2024
4a4099f
update azcore
gracewilcox Oct 14, 2024
5821ca7
version
gracewilcox Oct 14, 2024
ab1b903
charles feedback
gracewilcox Oct 15, 2024
8de3f62
charles feedback 2
gracewilcox Oct 15, 2024
6f3f05c
update to 1.16
gracewilcox Oct 18, 2024
d422e34
go mod tidy
gracewilcox Oct 18, 2024
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
2 changes: 1 addition & 1 deletion sdk/security/keyvault/internal/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release History

## 1.1.0 (2024-10-15)
## 1.1.0 (2024-10-16)

### Features Added
* Added CAE support
Expand Down
68 changes: 51 additions & 17 deletions sdk/security/keyvault/internal/challenge_policy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ import (
"github.com/stretchr/testify/require"
)

var (
challengedToken = "needs more claims"
claimsToken = "all the claims"
kvChallenge = `Bearer authorization="https://login.microsoftonline.com/tenant", resource="https://vault.azure.net"`
caeChallenge1 = `Bearer realm="", authorization_uri="https://login.microsoftonline.com/common/oauth2/authorize", error="insufficient_claims", claims="dGVzdGluZzE="`
gracewilcox marked this conversation as resolved.
Show resolved Hide resolved
caeChallenge2 = `Bearer realm="", authorization_uri="https://login.microsoftonline.com/common/oauth2/authorize", error="insufficient_claims", claims="dGVzdGluZzI="`
// requireToken is a mock.Response predicate that checks a request for the expected token
requireToken = func(t *testing.T, want string) func(req *http.Request) bool {
return func(r *http.Request) bool {
_, actual, _ := strings.Cut(r.Header.Get("Authorization"), " ")
require.Equal(t, want, actual)
return true
}
}
)

type credentialFunc func(context.Context, policy.TokenRequestOptions) (azcore.AccessToken, error)

func (cf credentialFunc) GetToken(ctx context.Context, options policy.TokenRequestOptions) (azcore.AccessToken, error) {
Expand Down Expand Up @@ -100,41 +116,43 @@ func TestChallengePolicy(t *testing.T) {
}
}

var (
accessTk = "***"
kvChallenge = `Bearer authorization="https://login.microsoftonline.com/tenant", resource="https://vault.azure.net"`
caeChallenge1 = `Bearer realm="", authorization_uri="https://login.microsoftonline.com/common/oauth2/authorize", error="insufficient_claims", claims="dGVzdGluZzE="`
caeChallenge2 = `Bearer realm="", authorization_uri="https://login.microsoftonline.com/common/oauth2/authorize", error="insufficient_claims", claims="dGVzdGluZzI="`
)

func TestChallengePolicy_CAE(t *testing.T) {
srv, close := mock.NewServer(mock.WithTransformAllRequestsToTestServerUrl())
defer close()
srv.AppendResponse(
mock.WithHeader("WWW-Authenticate", kvChallenge),
mock.WithStatusCode(401),
mock.WithPredicate(requireToken(t, "")),
)
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one
srv.AppendResponse()

srv.AppendResponse(
mock.WithHeader("WWW-Authenticate", caeChallenge1),
mock.WithStatusCode(401),
mock.WithPredicate(requireToken(t, challengedToken)),
)
srv.AppendResponse()
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one
srv.AppendResponse(
mock.WithPredicate(requireToken(t, claimsToken)),
)
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one

tkReqs := 0
cred := credentialFunc(func(ctx context.Context, tro policy.TokenRequestOptions) (azcore.AccessToken, error) {
require.True(t, tro.EnableCAE)
tkReqs += 1
tk := challengedToken
switch tkReqs {
case 1:
require.Empty(t, tro.Claims)
case 2:
// second call should include challenge claims
tk = claimsToken
require.Equal(t, "testing1", tro.Claims)
default:
t.Fatal("unexpected token request")
}
return azcore.AccessToken{Token: accessTk, ExpiresOn: time.Now().Add(time.Hour)}, nil
return azcore.AccessToken{Token: tk, ExpiresOn: time.Now().Add(time.Hour)}, nil
})
p := NewKeyVaultChallengePolicy(cred, nil)
pl := runtime.NewPipeline("", "",
Expand All @@ -148,15 +166,15 @@ func TestChallengePolicy_CAE(t *testing.T) {
res, err := pl.Do(req)
require.NoError(t, err)
require.Equal(t, 200, res.StatusCode)
require.Equal(t, tkReqs, 1)
require.Equal(t, 1, tkReqs)

// req 2 cae
req, err = runtime.NewRequest(context.Background(), "GET", "https://42.vault.azure.net")
require.NoError(t, err)
res, err = pl.Do(req)
require.NoError(t, err)
require.Equal(t, 200, res.StatusCode)
require.Equal(t, tkReqs, 2)
require.Equal(t, 2, tkReqs)
}

func TestChallengePolicy_KVThenCAE(t *testing.T) {
Expand All @@ -165,27 +183,35 @@ func TestChallengePolicy_KVThenCAE(t *testing.T) {
srv.AppendResponse(
mock.WithHeader("WWW-Authenticate", kvChallenge),
mock.WithStatusCode(401),
mock.WithPredicate(requireToken(t, "")),
)
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one
srv.AppendResponse(
mock.WithHeader("WWW-Authenticate", caeChallenge1),
mock.WithStatusCode(401),
mock.WithPredicate(requireToken(t, challengedToken)),
)
srv.AppendResponse()
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one
srv.AppendResponse(
mock.WithPredicate(requireToken(t, claimsToken)),
)
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one

tkReqs := 0
cred := credentialFunc(func(ctx context.Context, tro policy.TokenRequestOptions) (azcore.AccessToken, error) {
require.True(t, tro.EnableCAE)
tkReqs += 1
tk := challengedToken
switch tkReqs {
case 1:
require.Empty(t, tro.Claims)
case 2:
// second call should include challenge claims
tk = claimsToken
require.Equal(t, "testing1", tro.Claims)
default:
t.Fatal("unexpected token request")
}
return azcore.AccessToken{Token: accessTk, ExpiresOn: time.Now().Add(time.Hour)}, nil
return azcore.AccessToken{Token: tk, ExpiresOn: time.Now().Add(time.Hour)}, nil
})
p := NewKeyVaultChallengePolicy(cred, nil)
pl := runtime.NewPipeline("", "",
Expand All @@ -206,30 +232,38 @@ func TestChallengePolicy_TwoCAEChallenges(t *testing.T) {
srv.AppendResponse(
mock.WithHeader("WWW-Authenticate", kvChallenge),
mock.WithStatusCode(401),
mock.WithPredicate(requireToken(t, "")),
)
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one
srv.AppendResponse()

srv.AppendResponse(
gracewilcox marked this conversation as resolved.
Show resolved Hide resolved
mock.WithHeader("WWW-Authenticate", caeChallenge1),
mock.WithStatusCode(401),
mock.WithPredicate(requireToken(t, challengedToken)),
)
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one
srv.AppendResponse(
mock.WithHeader("WWW-Authenticate", caeChallenge2),
mock.WithStatusCode(401),
mock.WithPredicate(requireToken(t, claimsToken)),
)
srv.AppendResponse() // when a response's predicate returns true, srv pops the following one
tkReqs := 0
cred := credentialFunc(func(ctx context.Context, tro policy.TokenRequestOptions) (azcore.AccessToken, error) {
require.True(t, tro.EnableCAE)
tk := challengedToken
tkReqs += 1
switch tkReqs {
case 1:
require.Empty(t, tro.Claims)
case 2:
// second call should include challenge claims
tk = claimsToken
require.Equal(t, "testing1", tro.Claims)
default:
t.Fatal("unexpected token request")
}
return azcore.AccessToken{Token: accessTk, ExpiresOn: time.Now().Add(time.Hour)}, nil
return azcore.AccessToken{Token: tk, ExpiresOn: time.Now().Add(time.Hour)}, nil
})
p := NewKeyVaultChallengePolicy(cred, nil)
pl := runtime.NewPipeline("", "",
Expand Down