Skip to content

Commit bae5c44

Browse files
committed
Use native keychain bindings if possible
Switch from github.com/zalando/go-keyring to github.com/99designs/keyring that uses native bindings on macOS and Windows. On darwin, github.com/zalando/go-keyring encodes secret data in hex or base64, adding a prefix indicating that. If new library returns this prefix, convert the secret to plain data to keep using existing token and not require reauthentication. Originally suggested in cli#7023 (comment) Fixes cli#7123
1 parent 30066b0 commit bae5c44

3 files changed

Lines changed: 95 additions & 12 deletions

File tree

‎go.mod‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ go 1.22.5
55
toolchain go1.22.6
66

77
require (
8+
github.com/99designs/keyring v1.2.2
89
github.com/AlecAivazis/survey/v2 v2.3.7
910
github.com/MakeNowJust/heredoc v1.0.0
1011
github.com/briandowns/spinner v1.18.1
@@ -55,6 +56,7 @@ require (
5556
)
5657

5758
require (
59+
github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4 // indirect
5860
github.com/alecthomas/chroma/v2 v2.8.0 // indirect
5961
github.com/alessio/shellescape v1.4.2 // indirect
6062
github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect
@@ -74,6 +76,7 @@ require (
7476
github.com/docker/cli v27.1.1+incompatible // indirect
7577
github.com/docker/distribution v2.8.2+incompatible // indirect
7678
github.com/docker/docker-credential-helpers v0.7.0 // indirect
79+
github.com/dvsekhvalnov/jose2go v1.5.0 // indirect
7780
github.com/fatih/color v1.16.0 // indirect
7881
github.com/fsnotify/fsnotify v1.7.0 // indirect
7982
github.com/gdamore/encoding v1.0.0 // indirect
@@ -91,10 +94,12 @@ require (
9194
github.com/go-openapi/strfmt v0.23.0 // indirect
9295
github.com/go-openapi/swag v0.23.0 // indirect
9396
github.com/go-openapi/validate v0.24.0 // indirect
97+
github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 // indirect
9498
github.com/godbus/dbus/v5 v5.1.0 // indirect
9599
github.com/google/certificate-transparency-go v1.2.1 // indirect
96100
github.com/google/uuid v1.6.0 // indirect
97101
github.com/gorilla/css v1.0.0 // indirect
102+
github.com/gsterjov/go-libsecret v0.0.0-20161001094733-a6f4afe4910c // indirect
98103
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect
99104
github.com/hashicorp/errwrap v1.1.0 // indirect
100105
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
@@ -115,6 +120,7 @@ require (
115120
github.com/microcosm-cc/bluemonday v1.0.26 // indirect
116121
github.com/mitchellh/go-homedir v1.1.0 // indirect
117122
github.com/mitchellh/mapstructure v1.5.0 // indirect
123+
github.com/mtibben/percent v0.2.1 // indirect
118124
github.com/muesli/reflow v0.3.0 // indirect
119125
github.com/muesli/termenv v0.15.2 // indirect
120126
github.com/oklog/ulid v1.3.1 // indirect

‎go.sum‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ cloud.google.com/go/kms v1.15.8 h1:szIeDCowID8th2i8XE4uRev5PMxQFqW+JjwYxL9h6xs=
99
cloud.google.com/go/kms v1.15.8/go.mod h1:WoUHcDjD9pluCg7pNds131awnH429QGvRM3N/4MyoVs=
1010
filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
1111
filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
12+
github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4 h1:/vQbFIOMbk2FiG/kXiLl8BRyzTWDw7gX/Hz7Dd5eDMs=
13+
github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4/go.mod h1:hN7oaIRCjzsZ2dE+yG5k+rsdt3qcwykqK6HVGcKwsw4=
14+
github.com/99designs/keyring v1.2.2 h1:pZd3neh/EmUzWONb35LxQfvuY7kiSXAq3HQd97+XBn0=
15+
github.com/99designs/keyring v1.2.2/go.mod h1:wes/FrByc8j7lFOAGLGSNEg8f/PaI3cgTBqhFkHUrPk=
1216
github.com/AdamKorcz/go-fuzz-headers-1 v0.0.0-20230919221257-8b5d3ce2d11d h1:zjqpY4C7H15HjRPEenkS4SAn3Jy2eRRjkjZbGR30TOg=
1317
github.com/AdamKorcz/go-fuzz-headers-1 v0.0.0-20230919221257-8b5d3ce2d11d/go.mod h1:XNqJ7hv2kY++g8XEHREpi+JqZo3+0l+CH2egBVN4yqM=
1418
github.com/AlecAivazis/survey/v2 v2.3.7 h1:6I/u8FvytdGsgonrYsVn2t8t4QiRnh6QSTqkkhIiSjQ=
@@ -140,6 +144,8 @@ github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m3
140144
github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
141145
github.com/docker/docker-credential-helpers v0.7.0 h1:xtCHsjxogADNZcdv1pKUHXryefjlVRqWqIhk/uXJp0A=
142146
github.com/docker/docker-credential-helpers v0.7.0/go.mod h1:rETQfLdHNT3foU5kuNkFR1R1V12OJRRO5lzt2D1b5X0=
147+
github.com/dvsekhvalnov/jose2go v1.5.0 h1:3j8ya4Z4kMCwT5nXIKFSV84YS+HdqSSO0VsTQxaLAeM=
148+
github.com/dvsekhvalnov/jose2go v1.5.0/go.mod h1:QsHjhyTlD/lAVqn/NSbVZmSCGeDehTB/mPZadG+mhXU=
143149
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
144150
github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM=
145151
github.com/fatih/color v1.16.0/go.mod h1:fL2Sau1YI5c0pdGEVCbKQbLXB6edEj1ZgiY4NijnWvE=
@@ -190,6 +196,8 @@ github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpv
190196
github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg=
191197
github.com/go-test/deep v1.1.1 h1:0r/53hagsehfO4bzD2Pgr/+RgHqhmf+k1Bpse2cTu1U=
192198
github.com/go-test/deep v1.1.1/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE=
199+
github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 h1:ZpnhV/YsD2/4cESfV5+Hoeu/iUR3ruzNvZ+yQfO03a0=
200+
github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2/go.mod h1:bBOAhwG1umN6/6ZUMtDFBMQR8jRg9O75tm9K00oMsK4=
193201
github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
194202
github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
195203
github.com/golang-jwt/jwt/v5 v5.2.1 h1:OuVbFODueb089Lh128TAcimifWaLhJwVflnrgM17wHk=
@@ -224,6 +232,8 @@ github.com/gorilla/css v1.0.0 h1:BQqNyPTi50JCFMTw/b67hByjMVXZRwGha6wxVGkeihY=
224232
github.com/gorilla/css v1.0.0/go.mod h1:Dn721qIggHpt4+EFCcTLTU/vk5ySda2ReITrtgBl60c=
225233
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
226234
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
235+
github.com/gsterjov/go-libsecret v0.0.0-20161001094733-a6f4afe4910c h1:6rhixN/i8ZofjG1Y75iExal34USq5p+wiN1tpie8IrU=
236+
github.com/gsterjov/go-libsecret v0.0.0-20161001094733-a6f4afe4910c/go.mod h1:NMPJylDgVpX0MLRlPy15sqSwOFv/U1GZ2m21JhFfek0=
227237
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
228238
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
229239
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
@@ -290,6 +300,8 @@ github.com/klauspost/compress v1.17.4 h1:Ej5ixsIri7BrIjBkRZLTo6ghwrEtHFk7ijlczPW
290300
github.com/klauspost/compress v1.17.4/go.mod h1:/dCuZOvVtNoHsyb+cuJD3itjs3NbnF6KH9zAO4BDxPM=
291301
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
292302
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
303+
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
304+
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
293305
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
294306
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
295307
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
@@ -325,6 +337,8 @@ github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG
325337
github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
326338
github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
327339
github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
340+
github.com/mtibben/percent v0.2.1 h1:5gssi8Nqo8QU/r2pynCm+hBQHpkB/uNK7BJCFogWdzs=
341+
github.com/mtibben/percent v0.2.1/go.mod h1:KG9uO+SZkUp+VkRHsCdYQV3XSZrrSpR3O9ibNBTZrns=
328342
github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s=
329343
github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8=
330344
github.com/muesli/termenv v0.15.2 h1:GohcuySI0QmI3wN8Ok9PtKGkgkFIk7y6Vpb5PvrY+Wo=
@@ -333,6 +347,7 @@ github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38 h1:0Fr
333347
github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38/go.mod h1:saF2fIVw4banK0H4+/EuqfFLpRnoy5S+ECwTOCcRcSU=
334348
github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32 h1:W6apQkHrMkS0Muv8G/TipAy/FJl/rCYT0+EuS8+Z0z4=
335349
github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms=
350+
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
336351
github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=
337352
github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
338353
github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
@@ -551,6 +566,7 @@ google.golang.org/grpc v1.64.1/go.mod h1:hiQF4LFZelK2WKaP6W0L92zGHtiQdZxk8CrSdvy
551566
google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
552567
google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
553568
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
569+
gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
554570
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
555571
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
556572
gopkg.in/h2non/gock.v1 v1.1.2 h1:jBbHXgGBK/AoPVfJh5x4r/WxIrElvbLel8TCZkkZJoY=

‎internal/keyring/keyring.go‎

Lines changed: 73 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,19 @@ package keyring
33

44
import (
55
"errors"
6+
"strings"
67
"time"
78

8-
"github.com/zalando/go-keyring"
9+
"github.com/99designs/keyring"
10+
zkeyring "github.com/zalando/go-keyring"
911
)
1012

1113
var ErrNotFound = errors.New("secret not found in keyring")
1214

15+
// Timeout for all operations with keyring.
16+
// Provide enough time for user to authenticate if necessary.
17+
const timeout = 30 * time.Second
18+
1319
type TimeoutError struct {
1420
message string
1521
}
@@ -18,65 +24,120 @@ func (e *TimeoutError) Error() string {
1824
return e.message
1925
}
2026

27+
var GetKeyring = func(service string) (keyring.Keyring, error) {
28+
return keyring.Open(keyring.Config{ServiceName: service})
29+
}
30+
31+
func MockInit() {
32+
keyrings := make(map[string]keyring.Keyring)
33+
GetKeyring = func(service string) (keyring.Keyring, error) {
34+
kr, ok := keyrings[service]
35+
if !ok {
36+
kr = keyring.NewArrayKeyring(nil)
37+
keyrings[service] = kr
38+
}
39+
return kr, nil
40+
}
41+
}
42+
2143
// Set secret in keyring for user.
2244
func Set(service, user, secret string) error {
45+
kr, err := GetKeyring(service)
46+
if err != nil {
47+
return err
48+
}
2349
ch := make(chan error, 1)
2450
go func() {
2551
defer close(ch)
26-
ch <- keyring.Set(service, user, secret)
52+
ch <- kr.Set(keyring.Item{Key: user, Data: []byte(secret)})
2753
}()
2854
select {
2955
case err := <-ch:
3056
return err
31-
case <-time.After(3 * time.Second):
57+
case <-time.After(timeout):
3258
return &TimeoutError{"timeout while trying to set secret in keyring"}
3359
}
3460
}
3561

3662
// Get secret from keyring given service and user name.
3763
func Get(service, user string) (string, error) {
64+
kr, err := GetKeyring(service)
65+
if err != nil {
66+
return "", err
67+
}
3868
ch := make(chan struct {
3969
val string
4070
err error
4171
}, 1)
4272
go func() {
4373
defer close(ch)
44-
val, err := keyring.Get(service, user)
74+
val, err := kr.Get(user)
75+
sval := string(val.Data)
76+
// go-keyring encodes secret data on darwin adding a prefix
77+
// convert it to plain data with zalando/keyring for backward compatibility
78+
if err == nil && strings.HasPrefix(sval, "go-keyring") {
79+
sval, err = zkeyring.Get(service, user)
80+
if err == nil {
81+
err = kr.Set(keyring.Item{Key: user, Data: []byte(sval)})
82+
}
83+
}
4584
ch <- struct {
4685
val string
4786
err error
48-
}{val, err}
87+
}{sval, err}
4988
}()
5089
select {
5190
case res := <-ch:
52-
if errors.Is(res.err, keyring.ErrNotFound) {
91+
if errors.Is(res.err, zkeyring.ErrNotFound) || errors.Is(res.err, keyring.ErrKeyNotFound) {
5392
return "", ErrNotFound
5493
}
5594
return res.val, res.err
56-
case <-time.After(3 * time.Second):
95+
case <-time.After(timeout):
5796
return "", &TimeoutError{"timeout while trying to get secret from keyring"}
5897
}
5998
}
6099

61100
// Delete secret from keyring.
62101
func Delete(service, user string) error {
102+
kr, err := GetKeyring(service)
103+
if err != nil {
104+
return err
105+
}
63106
ch := make(chan error, 1)
64107
go func() {
65108
defer close(ch)
66-
ch <- keyring.Delete(service, user)
109+
ch <- kr.Remove(user)
67110
}()
68111
select {
69112
case err := <-ch:
70113
return err
71-
case <-time.After(3 * time.Second):
114+
case <-time.After(timeout):
72115
return &TimeoutError{"timeout while trying to delete secret from keyring"}
73116
}
74117
}
75118

76-
func MockInit() {
77-
keyring.MockInit()
119+
type ErrKeyring struct {
120+
err error
121+
}
122+
123+
func (kr *ErrKeyring) Get(key string) (keyring.Item, error) {
124+
return keyring.Item{}, kr.err
125+
}
126+
func (kr *ErrKeyring) GetMetadata(key string) (keyring.Metadata, error) {
127+
return keyring.Metadata{}, kr.err
128+
}
129+
func (kr *ErrKeyring) Set(item keyring.Item) error {
130+
return kr.err
131+
}
132+
func (kr *ErrKeyring) Remove(key string) error {
133+
return kr.err
134+
}
135+
func (kr *ErrKeyring) Keys() ([]string, error) {
136+
return nil, kr.err
78137
}
79138

80139
func MockInitWithError(err error) {
81-
keyring.MockInitWithError(err)
140+
GetKeyring = func(service string) (keyring.Keyring, error) {
141+
return &ErrKeyring{err}, nil
142+
}
82143
}

0 commit comments

Comments
 (0)