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

feat: support per-host scope hints #604

Merged
merged 29 commits into from
Sep 27, 2023
Merged

feat: support per-host scope hints #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
a88b850
draft
Wwwsylvia Sep 18, 2023
65c4acb
fix + test
Wwwsylvia Sep 18, 2023
1657b05
unit tests
Wwwsylvia Sep 19, 2023
e260ef9
update internal
Wwwsylvia Sep 19, 2023
6737ba2
update client
Wwwsylvia Sep 19, 2023
4f80680
TODOs
Wwwsylvia Sep 20, 2023
14547a7
rename
Wwwsylvia Sep 20, 2023
57d0181
rename
Wwwsylvia Sep 20, 2023
fb139e5
move + test
Wwwsylvia Sep 20, 2023
bced651
WithRepositoryScopes
Wwwsylvia Sep 20, 2023
744e55b
2 client tests
Wwwsylvia Sep 20, 2023
0d2c1d3
test oauth password
Wwwsylvia Sep 21, 2023
3325e26
test refresh token
Wwwsylvia Sep 21, 2023
6a98c3c
test expire
Wwwsylvia Sep 21, 2023
f7180dc
client tests
Wwwsylvia Sep 21, 2023
448ae21
add docs
Wwwsylvia Sep 21, 2023
66f3841
update doc
Wwwsylvia Sep 21, 2023
c517954
minor reword
Wwwsylvia Sep 21, 2023
799ba84
rename
Wwwsylvia Sep 21, 2023
5a766a8
fix
Wwwsylvia Sep 21, 2023
29f3497
optimize
Wwwsylvia Sep 21, 2023
78c68b8
fix race?
Wwwsylvia Sep 21, 2023
60eba30
refactor
Wwwsylvia Sep 25, 2023
783cffc
rename
Wwwsylvia Sep 25, 2023
32e4866
update doc
Wwwsylvia Sep 25, 2023
fd3da4a
add a private function
Wwwsylvia Sep 25, 2023
56cc8e7
test new function
Wwwsylvia Sep 25, 2023
e6fa97b
address comments
Wwwsylvia Sep 26, 2023
db4eaa8
expose GetAllScopesForHost
Wwwsylvia Sep 26, 2023
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
5 changes: 2 additions & 3 deletions content.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import (
"oras.land/oras-go/v2/internal/docker"
"oras.land/oras-go/v2/internal/interfaces"
"oras.land/oras-go/v2/internal/platform"
"oras.land/oras-go/v2/internal/registryutil"
"oras.land/oras-go/v2/internal/syncutil"
"oras.land/oras-go/v2/registry"
"oras.land/oras-go/v2/registry/remote/auth"
Expand Down Expand Up @@ -91,7 +90,7 @@ func TagN(ctx context.Context, target Target, srcReference string, dstReferences
if err != nil {
return ocispec.Descriptor{}, err
}
ctx = registryutil.WithScopeHint(ctx, ref, auth.ActionPull, auth.ActionPush)
ctx = auth.AppendRepositoryScope(ctx, ref, auth.ActionPull, auth.ActionPush)
}

desc, contentBytes, err := FetchBytes(ctx, target, srcReference, FetchBytesOptions{
Expand Down Expand Up @@ -149,7 +148,7 @@ func Tag(ctx context.Context, target Target, src, dst string) (ocispec.Descripto
if err != nil {
return ocispec.Descriptor{}, err
}
ctx = registryutil.WithScopeHint(ctx, ref, auth.ActionPull, auth.ActionPush)
ctx = auth.AppendRepositoryScope(ctx, ref, auth.ActionPull, auth.ActionPush)
}
desc, rc, err := refFetcher.FetchReference(ctx, src)
if err != nil {
Expand Down
29 changes: 0 additions & 29 deletions internal/registryutil/auth.go
View file
Open in desktop

This file was deleted.

28 changes: 14 additions & 14 deletions registry/remote/auth/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,19 +177,19 @@ func (c *Client) Do(originalReq *http.Request) (*http.Response, error) {
// attempt cached auth token
var attemptedKey string
cache := c.cache()
registry := originalReq.Host
scheme, err := cache.GetScheme(ctx, registry)
host := originalReq.Host
scheme, err := cache.GetScheme(ctx, host)
if err == nil {
switch scheme {
case SchemeBasic:
token, err := cache.GetToken(ctx, registry, SchemeBasic, "")
token, err := cache.GetToken(ctx, host, SchemeBasic, "")
if err == nil {
req.Header.Set("Authorization", "Basic "+token)
}
case SchemeBearer:
scopes := GetScopes(ctx)
scopes := GetAllScopesForHost(ctx, host)
attemptedKey = strings.Join(scopes, " ")
token, err := cache.GetToken(ctx, registry, SchemeBearer, attemptedKey)
token, err := cache.GetToken(ctx, host, SchemeBearer, attemptedKey)
if err == nil {
req.Header.Set("Authorization", "Bearer "+token)
}
Expand All @@ -211,8 +211,8 @@ func (c *Client) Do(originalReq *http.Request) (*http.Response, error) {
case SchemeBasic:
resp.Body.Close()

token, err := cache.Set(ctx, registry, SchemeBasic, "", func(ctx context.Context) (string, error) {
return c.fetchBasicAuth(ctx, registry)
token, err := cache.Set(ctx, host, SchemeBasic, "", func(ctx context.Context) (string, error) {
return c.fetchBasicAuth(ctx, host)
})
if err != nil {
return nil, fmt.Errorf("%s %q: %w", resp.Request.Method, resp.Request.URL, err)
Expand All @@ -223,17 +223,17 @@ func (c *Client) Do(originalReq *http.Request) (*http.Response, error) {
case SchemeBearer:
resp.Body.Close()

// merge hinted scopes with challenged scopes
scopes := GetScopes(ctx)
if scope := params["scope"]; scope != "" {
scopes = append(scopes, strings.Split(scope, " ")...)
scopes := GetAllScopesForHost(ctx, host)
if paramScope := params["scope"]; paramScope != "" {
// merge hinted scopes with challenged scopes
scopes = append(scopes, strings.Split(paramScope, " ")...)
scopes = CleanScopes(scopes)
}
key := strings.Join(scopes, " ")

// attempt the cache again if there is a scope change
if key != attemptedKey {
if token, err := cache.GetToken(ctx, registry, SchemeBearer, key); err == nil {
if token, err := cache.GetToken(ctx, host, SchemeBearer, key); err == nil {
req = originalReq.Clone(ctx)
req.Header.Set("Authorization", "Bearer "+token)
if err := rewindRequestBody(req); err != nil {
Expand All @@ -254,8 +254,8 @@ func (c *Client) Do(originalReq *http.Request) (*http.Response, error) {
// attempt with credentials
realm := params["realm"]
service := params["service"]
token, err := cache.Set(ctx, registry, SchemeBearer, key, func(ctx context.Context) (string, error) {
return c.fetchBearerToken(ctx, registry, realm, service, scopes)
token, err := cache.Set(ctx, host, SchemeBearer, key, func(ctx context.Context) (string, error) {
return c.fetchBearerToken(ctx, host, realm, service, scopes)
})
if err != nil {
return nil, fmt.Errorf("%s %q: %w", resp.Request.Method, resp.Request.URL, err)
Expand Down
Loading
Loading