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.

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

Normalize auth key before calling SetAuthentication #11430

Merged
merged 1 commit into from
Sep 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 19 additions & 1 deletion pkg/auth/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,9 @@ func authConfigsToAuthFile(authConfigs map[string]types.DockerAuthConfig) (strin
// tested, and we make sure to use the same code as the image backend.
sys := types.SystemContext{AuthFilePath: authFilePath}
for server, config := range authConfigs {
// Note that we do not validate the credentials here. Wassume
server = normalize(server)

// Note that we do not validate the credentials here. We assume
// that all credentials are valid. They'll be used on demand
// later.
if err := imageAuth.SetAuthentication(&sys, server, config.Username, config.Password); err != nil {
Expand All @@ -270,6 +272,22 @@ func authConfigsToAuthFile(authConfigs map[string]types.DockerAuthConfig) (strin
return authFilePath, nil
}

// normalize takes a server and removes the leading "http[s]://" prefix as well
// as removes path suffixes from docker registries.
func normalize(server string) string {
stripped := strings.TrimPrefix(server, "http://")
stripped = strings.TrimPrefix(stripped, "https://")

/// Normalize docker registries
if strings.HasPrefix(stripped, "index.docker.io/") ||
strings.HasPrefix(stripped, "registry-1.docker.io/") ||
strings.HasPrefix(stripped, "docker.io/") {
stripped = strings.SplitN(stripped, "/", 2)[0]
}

return stripped
}

// dockerAuthToImageAuth converts a docker auth config to one we're using
// internally from c/image. Note that the Docker types look slightly
// different, so we need to convert to be extra sure we're not running into
Expand Down
66 changes: 66 additions & 0 deletions pkg/auth/auth_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package auth

import (
"io/ioutil"
"testing"

"github.com/containers/image/v5/types"
"github.com/stretchr/testify/assert"
)

func TestAuthConfigsToAuthFile(t *testing.T) {
for _, tc := range []struct {
name string
server string
shouldErr bool
expectedContains string
}{
{
name: "empty auth configs",
server: "",
shouldErr: false,
expectedContains: "{}",
},
{
name: "registry with prefix",
server: "my-registry.local/username",
shouldErr: false,
expectedContains: `"my-registry.local/username":`,
},
{
name: "normalize https:// prefix",
server: "http://my-registry.local/username",
shouldErr: false,
expectedContains: `"my-registry.local/username":`,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

},
{
name: "normalize docker registry with https prefix",
server: "http://index.docker.io/v1/",
shouldErr: false,
expectedContains: `"index.docker.io":`,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’d expect the key to be docker.io here, although ultimately it works.

},
{
name: "normalize docker registry without https prefix",
server: "docker.io/v2/",
shouldErr: false,
expectedContains: `"docker.io":`,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be docker.io/v2, or rejected as invalid due to the trailing slash. (it never matches in actual files).

},
} {
configs := map[string]types.DockerAuthConfig{}
if tc.server != "" {
configs[tc.server] = types.DockerAuthConfig{}
}

filePath, err := authConfigsToAuthFile(configs)

if tc.shouldErr {
assert.NotNil(t, err)
assert.Empty(t, filePath)
} else {
assert.Nil(t, err)
content, err := ioutil.ReadFile(filePath)
assert.Nil(t, err)
assert.Contains(t, string(content), tc.expectedContains)
}
}
}