|
| 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 | +) |
| 12 | + |
| 13 | +var ( |
| 14 | + ErrCredentialBadUsername = errors.New("credential username is invalid") |
| 15 | + ErrInvalidCredentialFlags = errors.New("an invalid flag was specified for the flags parameter") |
| 16 | + ErrInvalidCredentialParameter = errors.New("protected field does not match provided value for an existing credential") |
| 17 | + ErrNoLogonSession = errors.New("logon session does not exist or there is no credential set associated with this logon session") |
| 18 | +) |
| 19 | + |
| 20 | +func (k *keychainStore[T]) Delete(ctx context.Context, id store.ID) error { |
| 21 | + if err := id.Valid(); err != nil { |
| 22 | + return err |
| 23 | + } |
| 24 | + |
| 25 | + g, err := wincred.GetGenericCredential(k.itemLabel(id)) |
| 26 | + if err != nil && !errors.Is(err, wincred.ErrElementNotFound) { |
| 27 | + return mapWindowsCredentialError(err) |
| 28 | + } |
| 29 | + if g == nil { |
| 30 | + return nil |
| 31 | + } |
| 32 | + |
| 33 | + err = g.Delete() |
| 34 | + if err != nil && !errors.Is(err, wincred.ErrElementNotFound) { |
| 35 | + return err |
| 36 | + } |
| 37 | + return nil |
| 38 | +} |
| 39 | + |
| 40 | +func (k *keychainStore[T]) Get(ctx context.Context, id store.ID) (store.Secret, error) { |
| 41 | + if err := id.Valid(); err != nil { |
| 42 | + return nil, err |
| 43 | + } |
| 44 | + |
| 45 | + g, err := wincred.GetGenericCredential(k.itemLabel(id)) |
| 46 | + if err != nil { |
| 47 | + return nil, mapWindowsCredentialError(err) |
| 48 | + } |
| 49 | + |
| 50 | + secret := k.factory() |
| 51 | + if err := secret.Unmarshal(g.CredentialBlob); err != nil { |
| 52 | + return nil, err |
| 53 | + } |
| 54 | + |
| 55 | + return secret, nil |
| 56 | +} |
| 57 | + |
| 58 | +// isServiceCredential checks if a credential attribute contains the |
| 59 | +// `service:group` and `service:name` attribute. |
| 60 | +// |
| 61 | +// The keychainStore serviceGroup and serviceName should match what is stored |
| 62 | +// in the attributes. |
| 63 | +func isServiceCredential[T store.Secret](k *keychainStore[T], attrs []wincred.CredentialAttribute) bool { |
| 64 | + // must have both serviceGroup and serviceName |
| 65 | + var ( |
| 66 | + serviceName string |
| 67 | + serviceGroup string |
| 68 | + ) |
| 69 | + for _, attr := range attrs { |
| 70 | + switch attr.Keyword { |
| 71 | + case "service:group": |
| 72 | + serviceGroup = string(attr.Value) |
| 73 | + case "service:name": |
| 74 | + serviceName = string(attr.Value) |
| 75 | + } |
| 76 | + } |
| 77 | + return strings.EqualFold(serviceGroup, k.serviceGroup) && strings.EqualFold(serviceName, k.serviceName) |
| 78 | +} |
| 79 | + |
| 80 | +// findServiceCredentials is an iterator that yields credentials that match the |
| 81 | +// service group and service name. |
| 82 | +func findServiceCredentials[T store.Secret](k *keychainStore[T], credentials []*wincred.Credential) iter.Seq[*wincred.Credential] { |
| 83 | + return func(yield func(cred *wincred.Credential) bool) { |
| 84 | + for _, c := range credentials { |
| 85 | + if isServiceCredential(k, c.Attributes) { |
| 86 | + if !yield(c) { |
| 87 | + return |
| 88 | + } |
| 89 | + } |
| 90 | + } |
| 91 | + } |
| 92 | +} |
| 93 | + |
| 94 | +func (k *keychainStore[T]) GetAll(ctx context.Context) (map[store.ID]store.Secret, error) { |
| 95 | + credentials, err := wincred.List() |
| 96 | + if err != nil { |
| 97 | + return nil, mapWindowsCredentialError(err) |
| 98 | + } |
| 99 | + |
| 100 | + onlyLabelPrefix := k.itemLabel(store.ID("")) |
| 101 | + |
| 102 | + secrets := make(map[store.ID]store.Secret, len(credentials)) |
| 103 | + for cred := range findServiceCredentials(k, credentials) { |
| 104 | + secret := k.factory() |
| 105 | + id, err := store.ParseID(strings.ReplaceAll(cred.TargetName, onlyLabelPrefix, "")) |
| 106 | + if err != nil { |
| 107 | + return nil, err |
| 108 | + } |
| 109 | + |
| 110 | + gc, err := wincred.GetGenericCredential(cred.TargetName) |
| 111 | + if err != nil { |
| 112 | + return nil, mapWindowsCredentialError(err) |
| 113 | + } |
| 114 | + if err := secret.Unmarshal(gc.CredentialBlob); err != nil { |
| 115 | + return nil, err |
| 116 | + } |
| 117 | + secrets[id] = secret |
| 118 | + } |
| 119 | + |
| 120 | + return secrets, nil |
| 121 | +} |
| 122 | + |
| 123 | +func (k *keychainStore[T]) Save(ctx context.Context, id store.ID, secret store.Secret) error { |
| 124 | + if err := id.Valid(); err != nil { |
| 125 | + return err |
| 126 | + } |
| 127 | + |
| 128 | + data, err := secret.Marshal() |
| 129 | + if err != nil { |
| 130 | + return err |
| 131 | + } |
| 132 | + |
| 133 | + g := wincred.NewGenericCredential(k.itemLabel(id)) |
| 134 | + g.UserName = id.String() |
| 135 | + g.CredentialBlob = data |
| 136 | + g.Persist = wincred.PersistLocalMachine |
| 137 | + g.Attributes = []wincred.CredentialAttribute{ |
| 138 | + { |
| 139 | + Keyword: "service:group", |
| 140 | + Value: []byte(k.serviceGroup), |
| 141 | + }, |
| 142 | + { |
| 143 | + Keyword: "service:name", |
| 144 | + Value: []byte(k.serviceName), |
| 145 | + }, |
| 146 | + } |
| 147 | + return mapWindowsCredentialError(g.Write()) |
| 148 | +} |
| 149 | + |
| 150 | +func mapWindowsCredentialError(err error) error { |
| 151 | + switch err { |
| 152 | + case wincred.ErrElementNotFound: |
| 153 | + return store.ErrCredentialNotFound |
| 154 | + case wincred.ErrBadUsername: |
| 155 | + return ErrCredentialBadUsername |
| 156 | + case wincred.ErrInvalidParameter: |
| 157 | + return ErrInvalidCredentialParameter |
| 158 | + } |
| 159 | + return nil |
| 160 | +} |
0 commit comments