|
| 1 | +package keychain |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "errors" |
| 6 | + "iter" |
| 7 | + "strings" |
| 8 | + |
| 9 | + "github.com/danieljoos/wincred" |
| 10 | + "github.com/docker/secrets-engine/store" |
| 11 | + "golang.org/x/sys/windows" |
| 12 | + "golang.org/x/text/encoding/unicode" |
| 13 | + "golang.org/x/text/transform" |
| 14 | +) |
| 15 | + |
| 16 | +var ( |
| 17 | + ErrCredentialBadUsername = errors.New("credential username is invalid") |
| 18 | + ErrInvalidCredentialFlags = errors.New("an invalid flag was specified for the flags parameter") |
| 19 | + ErrInvalidCredentialParameter = errors.New("protected field does not match provided value for an existing credential") |
| 20 | + ErrNoLogonSession = errors.New("logon session does not exist or there is no credential set associated with this logon session") |
| 21 | + sysErrInvalidCredentialFlags = windows.Errno(windows.ERROR_INVALID_FLAGS) |
| 22 | + sysErrNoSuchLogonSession = windows.Errno(windows.ERROR_NO_SUCH_LOGON_SESSION) |
| 23 | +) |
| 24 | + |
| 25 | +// encodeSecret marshals the secret into a slice of bytes in UTF16 format |
| 26 | +func encodeSecret(secret store.Secret) ([]byte, error) { |
| 27 | + data, err := secret.Marshal() |
| 28 | + if err != nil { |
| 29 | + return nil, err |
| 30 | + } |
| 31 | + |
| 32 | + encoder := unicode.UTF16(unicode.LittleEndian, unicode.IgnoreBOM).NewEncoder() |
| 33 | + blob, _, err := transform.Bytes(encoder, data) |
| 34 | + if err != nil { |
| 35 | + return nil, err |
| 36 | + } |
| 37 | + return blob, nil |
| 38 | +} |
| 39 | + |
| 40 | +// decodeSecret unmarshals the secret from UTF16 format to UTF8 |
| 41 | +// secret will contain the unmarshaled value. |
| 42 | +func decodeSecret(blob []byte, secret store.Secret) error { |
| 43 | + decoder := unicode.UTF16(unicode.LittleEndian, unicode.IgnoreBOM).NewDecoder() |
| 44 | + val, _, err := transform.Bytes(decoder, blob) |
| 45 | + if err != nil { |
| 46 | + return err |
| 47 | + } |
| 48 | + |
| 49 | + return secret.Unmarshal(val) |
| 50 | +} |
| 51 | + |
| 52 | +func (k *keychainStore[T]) Delete(ctx context.Context, id store.ID) error { |
| 53 | + if err := id.Valid(); err != nil { |
| 54 | + return err |
| 55 | + } |
| 56 | + |
| 57 | + g := wincred.NewGenericCredential(k.itemLabel(id)) |
| 58 | + err := g.Delete() |
| 59 | + if err != nil && !errors.Is(err, wincred.ErrElementNotFound) { |
| 60 | + return mapWindowsCredentialError(err) |
| 61 | + } |
| 62 | + return nil |
| 63 | +} |
| 64 | + |
| 65 | +func (k *keychainStore[T]) Get(ctx context.Context, id store.ID) (store.Secret, error) { |
| 66 | + if err := id.Valid(); err != nil { |
| 67 | + return nil, err |
| 68 | + } |
| 69 | + |
| 70 | + gc, err := wincred.GetGenericCredential(k.itemLabel(id)) |
| 71 | + if err != nil { |
| 72 | + return nil, mapWindowsCredentialError(err) |
| 73 | + } |
| 74 | + |
| 75 | + secret := k.factory() |
| 76 | + if err := decodeSecret(gc.CredentialBlob, secret); err != nil { |
| 77 | + return nil, err |
| 78 | + } |
| 79 | + return secret, nil |
| 80 | +} |
| 81 | + |
| 82 | +// isServiceCredential checks if a credential attribute contains the |
| 83 | +// `service:group` and `service:name` attribute. |
| 84 | +// |
| 85 | +// The keychainStore serviceGroup and serviceName should match what is stored |
| 86 | +// in the attributes. |
| 87 | +func isServiceCredential[T store.Secret](k *keychainStore[T], attrs []wincred.CredentialAttribute) bool { |
| 88 | + // must have both serviceGroup and serviceName |
| 89 | + var ( |
| 90 | + serviceName string |
| 91 | + serviceGroup string |
| 92 | + ) |
| 93 | + for _, attr := range attrs { |
| 94 | + switch attr.Keyword { |
| 95 | + case "service:group": |
| 96 | + serviceGroup = string(attr.Value) |
| 97 | + case "service:name": |
| 98 | + serviceName = string(attr.Value) |
| 99 | + } |
| 100 | + } |
| 101 | + return strings.EqualFold(serviceGroup, k.serviceGroup) && strings.EqualFold(serviceName, k.serviceName) |
| 102 | +} |
| 103 | + |
| 104 | +// findServiceCredentials is an iterator that yields credentials that match the |
| 105 | +// service group and service name. |
| 106 | +func findServiceCredentials[T store.Secret](k *keychainStore[T], credentials []*wincred.Credential) iter.Seq[*wincred.Credential] { |
| 107 | + return func(yield func(cred *wincred.Credential) bool) { |
| 108 | + for _, c := range credentials { |
| 109 | + if isServiceCredential(k, c.Attributes) { |
| 110 | + if !yield(c) { |
| 111 | + return |
| 112 | + } |
| 113 | + } |
| 114 | + } |
| 115 | + } |
| 116 | +} |
| 117 | + |
| 118 | +func (k *keychainStore[T]) GetAll(ctx context.Context) (map[store.ID]store.Secret, error) { |
| 119 | + credentials, err := wincred.List() |
| 120 | + if err != nil { |
| 121 | + return nil, mapWindowsCredentialError(err) |
| 122 | + } |
| 123 | + |
| 124 | + onlyLabelPrefix := k.itemLabel(store.ID("")) |
| 125 | + |
| 126 | + secrets := make(map[store.ID]store.Secret, len(credentials)) |
| 127 | + for cred := range findServiceCredentials(k, credentials) { |
| 128 | + secret := k.factory() |
| 129 | + id, err := store.ParseID(strings.ReplaceAll(cred.TargetName, onlyLabelPrefix, "")) |
| 130 | + if err != nil { |
| 131 | + return nil, err |
| 132 | + } |
| 133 | + |
| 134 | + gc, err := wincred.GetGenericCredential(cred.TargetName) |
| 135 | + if err != nil { |
| 136 | + return nil, mapWindowsCredentialError(err) |
| 137 | + } |
| 138 | + |
| 139 | + decoder := unicode.UTF16(unicode.LittleEndian, unicode.IgnoreBOM).NewDecoder() |
| 140 | + blob, _, err := transform.Bytes(decoder, gc.CredentialBlob) |
| 141 | + if err != nil { |
| 142 | + return nil, err |
| 143 | + } |
| 144 | + if err := secret.Unmarshal(blob); err != nil { |
| 145 | + return nil, err |
| 146 | + } |
| 147 | + secrets[id] = secret |
| 148 | + } |
| 149 | + |
| 150 | + return secrets, nil |
| 151 | +} |
| 152 | + |
| 153 | +func (k *keychainStore[T]) Save(ctx context.Context, id store.ID, secret store.Secret) error { |
| 154 | + if err := id.Valid(); err != nil { |
| 155 | + return err |
| 156 | + } |
| 157 | + |
| 158 | + blob, err := encodeSecret(secret) |
| 159 | + if err != nil { |
| 160 | + return err |
| 161 | + } |
| 162 | + |
| 163 | + g := wincred.NewGenericCredential(k.itemLabel(id)) |
| 164 | + g.UserName = id.String() |
| 165 | + g.CredentialBlob = blob |
| 166 | + g.Persist = wincred.PersistLocalMachine |
| 167 | + g.Attributes = []wincred.CredentialAttribute{ |
| 168 | + { |
| 169 | + Keyword: "id", |
| 170 | + Value: []byte(id.String()), |
| 171 | + }, |
| 172 | + { |
| 173 | + Keyword: "service:group", |
| 174 | + Value: []byte(k.serviceGroup), |
| 175 | + }, |
| 176 | + { |
| 177 | + Keyword: "service:name", |
| 178 | + Value: []byte(k.serviceName), |
| 179 | + }, |
| 180 | + } |
| 181 | + return mapWindowsCredentialError(g.Write()) |
| 182 | +} |
| 183 | + |
| 184 | +func mapWindowsCredentialError(err error) error { |
| 185 | + switch err { |
| 186 | + case wincred.ErrElementNotFound: |
| 187 | + return store.ErrCredentialNotFound |
| 188 | + case wincred.ErrBadUsername: |
| 189 | + return ErrCredentialBadUsername |
| 190 | + case wincred.ErrInvalidParameter: |
| 191 | + return ErrInvalidCredentialParameter |
| 192 | + case sysErrInvalidCredentialFlags: |
| 193 | + return ErrInvalidCredentialFlags |
| 194 | + case sysErrNoSuchLogonSession: |
| 195 | + return ErrNoLogonSession |
| 196 | + } |
| 197 | + return err |
| 198 | +} |
0 commit comments