Skip to content

pass: base64 encoded username with backward compatility #288

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

pass: base64 encoded username with backward compatility #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f4fa5e
Fix username slash issue
davcosentino May 9, 2023
5a3e1bb
pass: base64 encoded username with backward compatility
crazy-max May 28, 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
31 changes: 19 additions & 12 deletions pass/pass.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ func (p Pass) Add(creds *credentials.Credentials) error {
return errors.New("missing credentials")
}

encoded := base64.URLEncoding.EncodeToString([]byte(creds.ServerURL))

_, err := p.runPass(creds.Secret, "insert", "-f", "-m", path.Join(PASS_FOLDER, encoded, creds.Username))
encodedServerURL := base64.URLEncoding.EncodeToString([]byte(creds.ServerURL))
encodedUsername := base64.URLEncoding.EncodeToString([]byte(creds.Username))
_, err := p.runPass(creds.Secret, "insert", "-f", "-m", path.Join(PASS_FOLDER, encodedServerURL, encodedUsername))
return err
}

Expand All @@ -99,8 +99,8 @@ func (p Pass) Delete(serverURL string) error {
return errors.New("missing server url")
}

encoded := base64.URLEncoding.EncodeToString([]byte(serverURL))
_, err := p.runPass("", "rm", "-rf", path.Join(PASS_FOLDER, encoded))
encodedServerURL := base64.URLEncoding.EncodeToString([]byte(serverURL))
_, err := p.runPass("", "rm", "-rf", path.Join(PASS_FOLDER, encodedServerURL))
return err
}

Expand Down Expand Up @@ -142,17 +142,16 @@ func (p Pass) Get(serverURL string) (string, string, error) {
return "", "", errors.New("missing server url")
}

encoded := base64.URLEncoding.EncodeToString([]byte(serverURL))

if _, err := os.Stat(path.Join(getPassDir(), PASS_FOLDER, encoded)); err != nil {
encodedServerURL := base64.URLEncoding.EncodeToString([]byte(serverURL))
if _, err := os.Stat(path.Join(getPassDir(), PASS_FOLDER, encodedServerURL)); err != nil {
if os.IsNotExist(err) {
return "", "", credentials.NewErrCredentialsNotFound()
}

return "", "", err
}

usernames, err := listPassDir(encoded)
usernames, err := listPassDir(encodedServerURL)
if err != nil {
return "", "", err
}
Expand All @@ -162,8 +161,12 @@ func (p Pass) Get(serverURL string) (string, string, error) {
}

actual := strings.TrimSuffix(usernames[0].Name(), ".gpg")
secret, err := p.runPass("", "show", path.Join(PASS_FOLDER, encoded, actual))
return actual, secret, err
username := actual
if decodedUsername, err := base64.URLEncoding.DecodeString(actual); err == nil {
username = string(decodedUsername)
}
secret, err := p.runPass("", "show", path.Join(PASS_FOLDER, encodedServerURL, actual))
return username, secret, err
}

// List returns the stored URLs and corresponding usernames for a given credentials label
Expand Down Expand Up @@ -194,7 +197,11 @@ func (p Pass) List() (map[string]string, error) {
return nil, fmt.Errorf("no usernames for %s", serverURL)
}

resp[string(serverURL)] = strings.TrimSuffix(usernames[0].Name(), ".gpg")
username := strings.TrimSuffix(usernames[0].Name(), ".gpg")
resp[string(serverURL)] = username
if decodedUsername, err := base64.URLEncoding.DecodeString(username); err == nil {
resp[string(serverURL)] = string(decodedUsername)
}
}

return resp, nil
Expand Down
74 changes: 66 additions & 8 deletions pass/pass_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,76 @@
package pass

import (
"encoding/base64"
"path"
"strings"
"testing"

"github.com/docker/docker-credential-helpers/credentials"
)

func TestPassHelperCheckInit(t *testing.T) {
helper := Pass{}
if v := helper.CheckInitialized(); !v {
t.Errorf("expected true, actual: %v", v)
}
}

func TestPassHelper(t *testing.T) {
tests := []struct {
name string
creds *credentials.Credentials
}{
{
name: "create nothing",
creds: &credentials.Credentials{
ServerURL: "https://foobar.docker.io:2376/v1",
Username: "nothing",
Secret: "isthebestmeshuggahalbum",
},
},
{
name: "create foo/bar",
creds: &credentials.Credentials{
ServerURL: "https://foobar.docker.io:2376/v1",
Username: "foo/bar",
Secret: "foobarbaz",
},
},
}

helper := Pass{}
if err := helper.checkInitialized(); err != nil {
t.Error(err)
}

for _, tc := range tests {
tc := tc
t.Run(tc.name, func(t *testing.T) {
if err := helper.Add(tc.creds); err != nil {
t.Error(err)
}
u, s, err := helper.Get(tc.creds.ServerURL)
if err != nil {
t.Error(err)
}
if u != tc.creds.Username {
t.Errorf("invalid username %s", u)
}
if s != tc.creds.Secret {
t.Errorf("invalid secret: %s", s)
}
if err := helper.Delete(tc.creds.ServerURL); err != nil {
t.Error(err)
}
if _, _, err := helper.Get(tc.creds.ServerURL); !credentials.IsErrCredentialsNotFound(err) {
t.Errorf("expected credentials not found, actual: %v", err)
}
})
}
}

func TestPassHelperBackwardCompat(t *testing.T) {
creds := &credentials.Credentials{
ServerURL: "https://foobar.docker.io:2376/v1",
Username: "nothing",
Expand All @@ -21,7 +84,9 @@ func TestPassHelper(t *testing.T) {
t.Error(err)
}

if err := helper.Add(creds); err != nil {
// add a credential with the old format
encodedServerURL := base64.URLEncoding.EncodeToString([]byte(creds.ServerURL))
if _, err := helper.runPass(creds.Secret, "insert", "-f", "-m", path.Join(PASS_FOLDER, encodedServerURL, creds.Username)); err != nil {
t.Error(err)
}

Expand All @@ -44,13 +109,6 @@ func TestPassHelper(t *testing.T) {
}
}

func TestPassHelperCheckInit(t *testing.T) {
helper := Pass{}
if v := helper.CheckInitialized(); !v {
t.Errorf("expected true, actual: %v", v)
}
}

func TestPassHelperList(t *testing.T) {
creds := []*credentials.Credentials{
{
Expand Down