12 Commits

15 changed files with 466 additions and 130 deletions

View File

@@ -226,6 +226,9 @@ func main() {
== Library Hacking
=== Reference
Aside from the above (INCREDIBLY brief and perhaps slightly inaccurate) introduction to SecretService concepts, it is recommended to see the `.ref/` directory in git. Notably, the `URLS` file profides several excellent resources for understanding SecretService further. The Dbus specification (first URL in the file) is highly recommended if you are unfamiliar with SecretService internals.
=== Tests
Many functions are consolidated into a single test due to how dependent certain processes are on other objects. However, all functionality should be covered by test cases and the error string will always be passed through the stack to `go test -v` output.

10
TODO
View File

@@ -1,11 +1 @@
- TEST CASES
-- https://pkg.go.dev/testing
-- https://go.dev/doc/tutorial/add-a-test
-- https://gobyexample.com/testing
-- https://blog.alexellis.io/golang-writing-unit-tests/
- Benchmarking?
- Example usage
- Merge master into V1
-- and tag release (v1.0.0)
- Merge doc.go and README.adoc to V0
-- and tag release (v0.1.3)

View File

@@ -1,10 +1,9 @@
package gosecret
import (
`strings`
"time"
`github.com/godbus/dbus/v5`
"github.com/godbus/dbus/v5"
)
/*
@@ -13,8 +12,6 @@ import (
*/
func NewCollection(service *Service, path dbus.ObjectPath) (coll *Collection, err error) {
var splitPath []string
if service == nil {
err = ErrNoDbusConn
}
@@ -29,14 +26,23 @@ func NewCollection(service *Service, path dbus.ObjectPath) (coll *Collection, er
Dbus: service.Conn.Object(DbusService, path),
},
service: service,
// lastModified: time.Now(),
// LastModified: time.Now(),
}
splitPath = strings.Split(string(coll.Dbus.Path()), "/")
coll.name = splitPath[len(splitPath)-1]
_, _, err = coll.Modified()
// Populate the struct fields...
// TODO: use channel for errors; condense into a MultiError and switch to goroutines.
if _, err = coll.Locked(); err != nil {
return
}
if _, err = coll.Label(); err != nil {
return
}
if _, err = coll.Created(); err != nil {
return
}
if _, _, err = coll.Modified(); err != nil {
return
}
return
}
@@ -46,7 +52,16 @@ func NewCollection(service *Service, path dbus.ObjectPath) (coll *Collection, er
whether any existing secret with the same label should be replaced or not, and the optional itemType.
itemType is optional; if specified, it should be a Dbus interface (only the first element is used).
If not specified, the default DbusDefaultItemType will be used.
If not specified, the default DbusDefaultItemType will be used. The most common itemType is DbusDefaultItemType
and is the current recommendation.
Other types used are:
org.gnome.keyring.NetworkPassword
org.gnome.keyring.Note
These are libsecret schemas as defined at
https://gitlab.gnome.org/GNOME/libsecret/-/blob/master/libsecret/secret-schemas.c (and bundled in with libsecret).
Support for adding custom schemas MAY come in the future but is unsupported currently.
*/
func (c *Collection) CreateItem(label string, attrs map[string]string, secret *Secret, replace bool, itemType ...string) (item *Item, err error) {
@@ -66,6 +81,8 @@ func (c *Collection) CreateItem(label string, attrs map[string]string, secret *S
props[DbusItemLabel] = dbus.MakeVariant(label)
props[DbusItemType] = dbus.MakeVariant(typeString)
props[DbusItemAttributes] = dbus.MakeVariant(attrs)
props[DbusItemCreated] = dbus.MakeVariant(uint64(time.Now().Unix()))
// props[DbusItemModified] = dbus.MakeVariant(uint64(time.Now().Unix()))
if err = c.Dbus.Call(
DbusCollectionCreateItem, 0, props, secret, replace,
@@ -129,15 +146,16 @@ func (c *Collection) Items() (items []*Item, err error) {
paths = variant.Value().([]dbus.ObjectPath)
items = make([]*Item, len(paths))
items = make([]*Item, 0)
for idx, path := range paths {
for _, path := range paths {
item = nil
if item, err = NewItem(c, path); err != nil {
errs = append(errs, err)
err = nil
continue
}
items[idx] = item
items = append(items, item)
}
err = NewErrors(err)
@@ -155,8 +173,28 @@ func (c *Collection) Label() (label string, err error) {
label = variant.Value().(string)
if label != c.name {
c.name = label
c.LabelName = label
return
}
// Lock will lock an unlocked Collection. It will no-op if the Collection is currently locked.
func (c *Collection) Lock() (err error) {
if _, err = c.Locked(); err != nil {
return
}
if c.IsLocked {
return
}
if err = c.service.Lock(c); err != nil {
return
}
c.IsLocked = true
if _, _, err = c.Modified(); err != nil {
return
}
return
@@ -173,6 +211,7 @@ func (c *Collection) Locked() (isLocked bool, err error) {
}
isLocked = variant.Value().(bool)
c.IsLocked = isLocked
return
}
@@ -185,6 +224,11 @@ func (c *Collection) Relabel(newLabel string) (err error) {
if err = c.Dbus.SetProperty(DbusCollectionLabel, variant); err != nil {
return
}
c.LabelName = newLabel
if _, _, err = c.Modified(); err != nil {
return
}
return
}
@@ -202,6 +246,7 @@ func (c *Collection) SearchItems(profile string) (items []*Item, err error) {
var paths []dbus.ObjectPath
var errs []error = make([]error, 0)
var attrs map[string]string = make(map[string]string, 0)
var item *Item
attrs["profile"] = profile
@@ -211,20 +256,66 @@ func (c *Collection) SearchItems(profile string) (items []*Item, err error) {
return
}
items = make([]*Item, len(paths))
items = make([]*Item, 0)
for idx, path := range paths {
if items[idx], err = NewItem(c, path); err != nil {
for _, path := range paths {
item = nil
if item, err = NewItem(c, path); err != nil {
errs = append(errs, err)
err = nil
continue
}
items = append(items, item)
}
err = NewErrors(err)
return
}
// SetAlias is a thin wrapper/shorthand for Service.SetAlias (but specific to this Collection).
func (c *Collection) SetAlias(alias string) (err error) {
var call *dbus.Call
call = c.service.Dbus.Call(
DbusServiceSetAlias, 0, alias, c.Dbus.Path(),
)
if err = call.Err; err != nil {
return
}
c.Alias = alias
if _, _, err = c.Modified(); err != nil {
return
}
return
}
// Unlock will unlock a locked Collection. It will no-op if the Collection is currently unlocked.
func (c *Collection) Unlock() (err error) {
if _, err = c.Locked(); err != nil {
return
}
if !c.IsLocked {
return
}
if err = c.service.Unlock(c); err != nil {
return
}
c.IsLocked = false
if _, _, err = c.Modified(); err != nil {
return
}
return
}
// Created returns the time.Time of when a Collection was created.
func (c *Collection) Created() (created time.Time, err error) {
@@ -238,6 +329,7 @@ func (c *Collection) Created() (created time.Time, err error) {
timeInt = variant.Value().(uint64)
created = time.Unix(int64(timeInt), 0)
c.CreatedAt = created
return
}
@@ -247,7 +339,7 @@ func (c *Collection) Created() (created time.Time, err error) {
that indicates if the collection has changed since the last call of Collection.Modified.
Note that when calling NewCollection, the internal library-tracked modification
time (Collection.lastModified) will be set to the latest modification time of the Collection
time (Collection.LastModified) will be set to the latest modification time of the Collection
itself as reported by Dbus rather than the time that NewCollection was called.
*/
func (c *Collection) Modified() (modified time.Time, isChanged bool, err error) {
@@ -265,39 +357,20 @@ func (c *Collection) Modified() (modified time.Time, isChanged bool, err error)
if !c.lastModifiedSet {
// It's "nil", so set it to modified. We can't check for a zero-value in case Dbus has it as a zero-value.
c.lastModified = modified
c.LastModified = modified
c.lastModifiedSet = true
}
isChanged = modified.After(c.lastModified)
c.lastModified = modified
isChanged = modified.After(c.LastModified)
c.LastModified = modified
return
}
/*
PathName returns the "real" name of a Collection.
In some cases, the Collection.Label may not be the actual *name* of the collection
(i.e. the label is different from the name used in the Dbus path).
This is a thin wrapper around simply extracting the last item from
the Collection.Dbus.Path().
*/
func (c *Collection) PathName() (realName string) {
// path is a *very* thin wrapper around Collection.Dbus.Path(). It is needed for LockableObject interface membership.
func (c *Collection) path() (dbusPath dbus.ObjectPath) {
var pathSplit []string = strings.Split(string(c.Dbus.Path()), "/")
realName = pathSplit[len(pathSplit)-1]
return
}
/*
setModify updates the Collection's modification time (as specified by Collection.Modified).
It seems that this does not update automatically.
*/
func (c *Collection) setModify() (err error) {
err = c.Dbus.SetProperty(DbusCollectionModified, uint64(time.Now().Unix()))
dbusPath = c.Dbus.Path()
return
}

View File

@@ -148,6 +148,7 @@ func TestCollection_Label(t *testing.T) {
t.Fatalf("NewService failed: %v", err.Error())
}
t.Logf("Attempting to get label of collection: %v", defaultCollectionLabel)
if collection, err = svc.GetCollection(defaultCollectionLabel); err != nil {
t.Errorf(
"failed when fetching collection '%v': %v",
@@ -207,9 +208,9 @@ func TestCollection_Locked(t *testing.T) {
}
if isLocked, err = collection.Locked(); err != nil {
t.Errorf("failed to get lock status for collection '%v': %v", collection.PathName(), err.Error())
t.Errorf("failed to get lock status for collection '%v': %v", collection.path(), err.Error())
} else {
t.Logf("collection '%v' lock status: %v", collection.PathName(), isLocked)
t.Logf("collection '%v' lock status: %v", collection.path(), isLocked)
}
if err = svc.Close(); err != nil {

View File

@@ -1,5 +1,9 @@
package gosecret
import (
"github.com/godbus/dbus/v5"
)
// Constants for use with gosecret.
const (
/*
@@ -19,14 +23,17 @@ const (
// DbusPrompterInterface is an interface for issuing a Prompt. Yes, it should be doubled up like that.
DbusPrompterInterface string = DbusServiceBase + ".Prompt.Prompt"
/*
DbusDefaultItemType is the default type to use for Item.Type.
I've only ever seen "org.gnome.keyring.NetworkPassword" in the wild
aside from the below. It may be legacy (gnome-keyring is obsoleted by SecretService).
If in doubt, the below is considered the "proper" interface.
DbusDefaultItemType is the default type to use for Item.Type/Collection.CreateItem.
*/
DbusDefaultItemType string = DbusServiceBase + ".Generic"
)
// Libsecret/SecretService special values.
var (
// DbusRemoveAliasPath is used to remove an alias from a Collection and/or Item.
DbusRemoveAliasPath dbus.ObjectPath = dbus.ObjectPath("/")
)
// Service interface.
const (
/*

View File

@@ -12,8 +12,10 @@ var (
ErrInvalidProperty error = errors.New("invalid variant type; cannot convert")
// ErrNoDbusConn gets triggered if a connection to Dbus can't be detected.
ErrNoDbusConn error = errors.New("no valid dbus connection")
// ErrMissingPaths gets triggered if one or more Dbus object paths are expected but non/not enough are received.
// ErrMissingPaths gets triggered if one or more Dbus object paths are expected but none/not enough are received.
ErrMissingPaths error = errors.New("one or more Dbus object paths were expected but an insufficient amount were received")
// ErrMissingObj gets triggered if one or more gosecret-native objects are expected but none/not enough are received.
ErrMissingObj error = errors.New("one or more objects were expected but an insufficient amount were received")
// ErrMissingAttrs gets triggered if attributes were expected but not passed.
ErrMissingAttrs error = errors.New("attributes must not be empty/nil")
// ErrDoesNotExist gets triggered if a Collection, Item, etc. is attempted to be fetched but none exists via the specified identifier.

View File

@@ -115,3 +115,32 @@ func pathsFromPath(bus dbus.BusObject, path string) (paths []dbus.ObjectPath, er
return
}
/*
NameFromPath returns an actual name (as it appears in Dbus) from a dbus.ObjectPath.
Note that you can get any object's dbus.ObjectPath via <object>.Dbus.Path().
path is validated to ensure it is not an empty string.
*/
func NameFromPath(path dbus.ObjectPath) (name string, err error) {
var strSplit []string
var ok bool
if ok, err = pathIsValid(path); err != nil {
return
} else if !ok {
err = ErrBadDbusPath
return
}
strSplit = strings.Split(string(path), "/")
if len(strSplit) < 1 {
err = ErrBadDbusPath
return
}
name = strSplit[len(strSplit)-1]
return
}

View File

@@ -1,11 +1,11 @@
package gosecret
import (
`strconv`
`strings`
`time`
"strconv"
"strings"
"time"
`github.com/godbus/dbus/v5`
"github.com/godbus/dbus/v5"
)
// NewItem returns a pointer to an Item based on Collection and a Dbus path.
@@ -32,14 +32,30 @@ func NewItem(collection *Collection, path dbus.ObjectPath) (item *Item, err erro
item.idx, err = strconv.Atoi(splitPath[len(splitPath)-1])
item.collection = collection
// Populate the struct fields...
// TODO: use channel for errors; condense into a MultiError and switch to goroutines.
if _, err = item.GetSecret(collection.service.Session); err != nil {
return
}
if _, err = item.Locked(); err != nil {
return
}
if _, err = item.Attributes(); err != nil {
return
}
if _, err = item.Label(); err != nil {
return
}
if _, err = item.Type(); err != nil {
return
}
_, _, err = item.Modified()
if _, err = item.Created(); err != nil {
return
}
if _, _, err = item.Modified(); err != nil {
return
}
return
}
@@ -54,6 +70,35 @@ func (i *Item) Attributes() (attrs map[string]string, err error) {
}
attrs = variant.Value().(map[string]string)
i.Attrs = attrs
return
}
/*
ChangeItemType changes an Item.Type to newItemType.
Note that this is probably a bad idea unless you're also doing Item.SetSecret.
It must be a Dbus interface path (e.g. "foo.bar.Baz").
If newItemType is an empty string, DbusDefaultItemType will be used.
*/
func (i *Item) ChangeItemType(newItemType string) (err error) {
var variant dbus.Variant
if strings.TrimSpace(newItemType) == "" {
newItemType = DbusDefaultItemType
}
variant = dbus.MakeVariant(newItemType)
if err = i.Dbus.SetProperty(DbusItemType, variant); err != nil {
return
}
i.SecretType = newItemType
if _, _, err = i.Modified(); err != nil {
return
}
return
}
@@ -98,6 +143,7 @@ func (i *Item) GetSecret(session *Session) (secret *Secret, err error) {
secret.session = session
secret.item = i
i.Secret = secret
return
}
@@ -112,6 +158,7 @@ func (i *Item) Label() (label string, err error) {
}
label = variant.Value().(string)
i.LabelName = label
return
}
@@ -153,7 +200,9 @@ func (i *Item) ModifyAttributes(replaceAttrs map[string]string) (err error) {
}
}
err = i.ReplaceAttributes(currentProps)
if err = i.ReplaceAttributes(currentProps); err != nil {
return
}
return
}
@@ -166,6 +215,11 @@ func (i *Item) Relabel(newLabel string) (err error) {
if err = i.Dbus.SetProperty(DbusItemLabel, variant); err != nil {
return
}
i.LabelName = newLabel
if _, _, err = i.Modified(); err != nil {
return
}
return
}
@@ -180,6 +234,11 @@ func (i *Item) ReplaceAttributes(newAttrs map[string]string) (err error) {
if err = i.Dbus.SetProperty(DbusItemAttributes, props); err != nil {
return
}
i.Attrs = newAttrs
if _, _, err = i.Modified(); err != nil {
return
}
return
}
@@ -196,9 +255,12 @@ func (i *Item) SetSecret(secret *Secret) (err error) {
err = c.Err
return
}
i.Secret = secret
if _, _, err = i.Modified(); err != nil {
return
}
return
}
@@ -212,6 +274,29 @@ func (i *Item) Type() (itemType string, err error) {
}
itemType = variant.Value().(string)
i.SecretType = itemType
return
}
// Lock will lock an unlocked Item. It will no-op if the Item is currently locked.
func (i *Item) Lock() (err error) {
if _, err = i.Locked(); err != nil {
return
}
if i.IsLocked {
return
}
if err = i.collection.service.Lock(i); err != nil {
return
}
i.IsLocked = true
if _, _, err = i.Modified(); err != nil {
return
}
return
}
@@ -227,6 +312,29 @@ func (i *Item) Locked() (isLocked bool, err error) {
}
isLocked = variant.Value().(bool)
i.IsLocked = isLocked
return
}
// Unlock will unlock a locked Item. It will no-op if the Item is currently unlocked.
func (i *Item) Unlock() (err error) {
if _, err = i.Locked(); err != nil {
return
}
if !i.IsLocked {
return
}
if err = i.collection.service.Unlock(i); err != nil {
return
}
i.IsLocked = false
if _, _, err = i.Modified(); err != nil {
return
}
return
}
@@ -244,6 +352,7 @@ func (i *Item) Created() (created time.Time, err error) {
timeInt = variant.Value().(uint64)
created = time.Unix(int64(timeInt), 0)
i.CreatedAt = created
return
}
@@ -253,7 +362,7 @@ func (i *Item) Created() (created time.Time, err error) {
that indicates if the collection has changed since the last call of Item.Modified.
Note that when calling NewItem, the internal library-tracked modification
time (Item.lastModified) will be set to the latest modification time of the Item
time (Item.LastModified) will be set to the latest modification time of the Item
itself as reported by Dbus rather than the time that NewItem was called.
*/
func (i *Item) Modified() (modified time.Time, isChanged bool, err error) {
@@ -271,12 +380,20 @@ func (i *Item) Modified() (modified time.Time, isChanged bool, err error) {
if !i.lastModifiedSet {
// It's "nil", so set it to modified. We can't check for a zero-value in case Dbus has it as a zero-value.
i.lastModified = modified
i.LastModified = modified
i.lastModifiedSet = true
}
isChanged = modified.After(i.lastModified)
i.lastModified = modified
isChanged = modified.After(i.LastModified)
i.LastModified = modified
return
}
// path is a *very* thin wrapper around Item.Dbus.Path(). It is needed for LockableObject membership.
func (i *Item) path() (dbusPath dbus.ObjectPath) {
dbusPath = i.Dbus.Path()
return
}

View File

@@ -46,6 +46,9 @@ func TestItem(t *testing.T) {
if item, err = collection.CreateItem(testItemLabel, itemAttrs, secret, true); err != nil {
t.Errorf("could not create item %v in collection '%v': %v", testItemLabel, collectionName.String(), err.Error())
if err = collection.Delete(); err != nil {
t.Errorf("could not delete collection '%v': %v", collectionName.String(), err.Error())
}
if err = svc.Close(); err != nil {
t.Fatalf("could not close Service.Session: %v", err.Error())
}

View File

@@ -1,5 +1,9 @@
package gosecret
import (
`fmt`
)
/*
MarshalJSON converts a SecretValue to a JSON representation.
For compat reasons, the MarshalText is left "unmolested" (i.e. renders to a Base64 value).
@@ -7,7 +11,7 @@ package gosecret
*/
func (s *SecretValue) MarshalJSON() (b []byte, err error) {
b = []byte(string(*s))
b = []byte(fmt.Sprintf("\"%v\"", string(*s)))
return
}

View File

@@ -5,6 +5,7 @@ import (
"fmt"
"path/filepath"
"strings"
`time`
"github.com/godbus/dbus/v5"
)
@@ -56,16 +57,17 @@ func (s *Service) Collections() (collections []*Collection, err error) {
paths = variant.Value().([]dbus.ObjectPath)
collections = make([]*Collection, len(paths))
collections = make([]*Collection, 0)
for idx, path := range paths {
for _, path := range paths {
coll = nil
if coll, err = NewCollection(s, path); err != nil {
// return
errs = append(errs, err)
err = nil
continue
}
collections[idx] = coll
collections = append(collections, coll)
}
err = NewErrors(err)
@@ -85,6 +87,8 @@ func (s *Service) CreateAliasedCollection(label, alias string) (collection *Coll
var props map[string]dbus.Variant = make(map[string]dbus.Variant)
props[DbusCollectionLabel] = dbus.MakeVariant(label)
props[DbusCollectionCreated] = dbus.MakeVariant(uint64(time.Now().Unix()))
props[DbusCollectionModified] = dbus.MakeVariant(uint64(time.Now().Unix()))
if err = s.Dbus.Call(
DbusServiceCreateCollection, 0, props, alias,
@@ -124,12 +128,13 @@ func (s *Service) CreateCollection(label string) (collection *Collection, err er
*/
func (s *Service) GetCollection(name string) (c *Collection, err error) {
var errs []error
var errs []error = make([]error, 0)
var colls []*Collection
var collLabel string
var pathName string
// First check for an alias.
if c, err = s.ReadAlias(name); err != nil && err != ErrDoesNotExist {
c = nil
return
}
if c != nil {
@@ -143,7 +148,12 @@ func (s *Service) GetCollection(name string) (c *Collection, err error) {
return
}
for _, i := range colls {
if i.name == name {
if pathName, err = NameFromPath(i.Dbus.Path()); err != nil {
errs = append(errs, err)
err = nil
continue
}
if pathName == name {
c = i
return
}
@@ -151,12 +161,7 @@ func (s *Service) GetCollection(name string) (c *Collection, err error) {
// Still nothing? Try by label.
for _, i := range colls {
if collLabel, err = i.Label(); err != nil {
errs = append(errs, err)
err = nil
continue
}
if collLabel == name {
if i.LabelName == name {
c = i
return
}
@@ -177,6 +182,8 @@ func (s *Service) GetCollection(name string) (c *Collection, err error) {
GetSecrets allows you to fetch values (Secret) from multiple Item object paths using this Service's Session.
An ErrMissingPaths will be returned for err if itemPaths is nil or empty.
The returned secrets is a map with itemPaths as the keys and their corresponding Secret as the value.
If you know which Collection your desired Secret is in, it is recommended to iterate through Collection.Items instead
(as Secrets returned here may have missing functionality).
*/
func (s *Service) GetSecrets(itemPaths ...dbus.ObjectPath) (secrets map[dbus.ObjectPath]*Secret, err error) {
@@ -226,24 +233,28 @@ func (s *Service) GetSession() (ssn *Session, err error) {
return
}
/*
Lock locks an Unlocked Service, Collection, etc.
You can usually get objectPath for the object(s) to unlock via <object>.Dbus.Path().
If objectPaths is nil or empty, the Service's own path will be used.
*/
func (s *Service) Lock(objectPaths ...dbus.ObjectPath) (err error) {
// Lock locks an Unlocked Collection or Item (LockableObject).
func (s *Service) Lock(objects ...LockableObject) (err error) {
var toLock []dbus.ObjectPath
// We only use these as destinations.
var locked []dbus.ObjectPath
var prompt *Prompt
var promptPath dbus.ObjectPath
if objectPaths == nil || len(objectPaths) == 0 {
objectPaths = []dbus.ObjectPath{s.Dbus.Path()}
if objects == nil || len(objects) == 0 {
err = ErrMissingObj
return
}
toLock = make([]dbus.ObjectPath, len(objects))
for idx, o := range objects {
toLock[idx] = o.path()
}
if err = s.Dbus.Call(
DbusServiceLock, 0, objectPaths,
DbusServiceLock, 0, toLock,
).Store(&locked, &promptPath); err != nil {
return
}
@@ -257,12 +268,20 @@ func (s *Service) Lock(objectPaths ...dbus.ObjectPath) (err error) {
}
}
// TODO: use channels and goroutines here.
for _, o := range objects {
if _, err = o.Locked(); err != nil {
return
}
}
return
}
/*
OpenSession returns a pointer to a Session from the Service.
It's a convenience function around NewSession.
However, NewService attaches a Session by default at Service.Session so this is likely unnecessary.
*/
func (s *Service) OpenSession(algo, input string) (session *Session, output dbus.Variant, err error) {
@@ -324,6 +343,16 @@ func (s *Service) ReadAlias(alias string) (collection *Collection, err error) {
return
}
// RemoveAlias is a thin wrapper around Service.SetAlias using the removal method specified there.
func (s *Service) RemoveAlias(alias string) (err error) {
if err = s.SetAlias(alias, DbusRemoveAliasPath); err != nil {
return
}
return
}
/*
SearchItems searches all Collection objects and returns all matches based on the map of attributes.
*/
@@ -336,6 +365,7 @@ func (s *Service) SearchItems(attributes map[string]string) (unlockedItems []*It
var ok bool
var c *Collection
var cPath dbus.ObjectPath
var item *Item
var errs []error = make([]error, 0)
if attributes == nil || len(attributes) == 0 {
@@ -347,8 +377,8 @@ func (s *Service) SearchItems(attributes map[string]string) (unlockedItems []*It
DbusServiceSearchItems, 0, attributes,
).Store(&unlocked, &locked)
lockedItems = make([]*Item, len(locked))
unlockedItems = make([]*Item, len(unlocked))
lockedItems = make([]*Item, 0)
unlockedItems = make([]*Item, 0)
if collectionObjs, err = s.Collections(); err != nil {
return
@@ -361,8 +391,9 @@ func (s *Service) SearchItems(attributes map[string]string) (unlockedItems []*It
}
// Locked items
for idx, i := range locked {
for _, i := range locked {
item = nil
cPath = dbus.ObjectPath(filepath.Dir(string(i)))
if c, ok = collections[cPath]; !ok {
@@ -372,18 +403,20 @@ func (s *Service) SearchItems(attributes map[string]string) (unlockedItems []*It
continue
}
if lockedItems[idx], err = NewItem(c, i); err != nil {
if item, err = NewItem(c, i); err != nil {
errs = append(errs, errors.New(fmt.Sprintf(
"could not create Item for locked item %v", string(i),
)))
err = nil
continue
}
lockedItems = append(lockedItems, item)
}
// Unlocked items
for idx, i := range unlocked {
for _, i := range unlocked {
item = nil
cPath = dbus.ObjectPath(filepath.Dir(string(i)))
if c, ok = collections[cPath]; !ok {
@@ -393,13 +426,14 @@ func (s *Service) SearchItems(attributes map[string]string) (unlockedItems []*It
continue
}
if unlockedItems[idx], err = NewItem(c, i); err != nil {
if item, err = NewItem(c, i); err != nil {
errs = append(errs, errors.New(fmt.Sprintf(
"could not create Item for unlocked item %v", string(i),
)))
err = nil
continue
}
unlockedItems = append(unlockedItems, item)
}
if errs != nil && len(errs) > 0 {
@@ -411,38 +445,57 @@ func (s *Service) SearchItems(attributes map[string]string) (unlockedItems []*It
/*
SetAlias sets an alias for an existing Collection.
(You can get its path via <Collection>.Dbus.Path().)
To remove an alias, set objectPath to dbus.ObjectPath("/").
*/
func (s *Service) SetAlias(alias string, objectPath dbus.ObjectPath) (err error) {
var c *dbus.Call
var collection *Collection
if collection, err = s.GetCollection(alias); err != nil {
return
}
c = s.Dbus.Call(
DbusServiceSetAlias, 0, alias, objectPath,
)
err = c.Err
if err = c.Err; err != nil {
return
}
if objectPath == DbusRemoveAliasPath {
collection.Alias = ""
} else {
collection.Alias = alias
}
return
}
/*
Unlock unlocks a Locked Service, Collection, etc.
You can usually get objectPath for the object(s) to unlock via <object>.Dbus.Path().
If objectPaths is nil or empty, the Service's own path will be used.
*/
func (s *Service) Unlock(objectPaths ...dbus.ObjectPath) (err error) {
// Unlock unlocks a locked Collection or Item (LockableObject).
func (s *Service) Unlock(objects ...LockableObject) (err error) {
var toUnlock []dbus.ObjectPath
// We only use these as destinations.
var unlocked []dbus.ObjectPath
var prompt *Prompt
var resultPath dbus.ObjectPath
if objectPaths == nil || len(objectPaths) == 0 {
objectPaths = []dbus.ObjectPath{s.Dbus.Path()}
if objects == nil || len(objects) == 0 {
err = ErrMissingObj
return
}
toUnlock = make([]dbus.ObjectPath, len(objects))
for idx, o := range objects {
toUnlock[idx] = o.path()
}
if err = s.Dbus.Call(
DbusServiceUnlock, 0, objectPaths,
DbusServiceUnlock, 0, toUnlock,
).Store(&unlocked, &resultPath); err != nil {
return
}
@@ -456,5 +509,20 @@ func (s *Service) Unlock(objectPaths ...dbus.ObjectPath) (err error) {
}
}
// TODO: use channels and goroutines here.
for _, o := range objects {
if _, err = o.Locked(); err != nil {
return
}
}
return
}
// path is a *very* thin wrapper around Service.Dbus.Path().
func (s *Service) path() (dbusPath dbus.ObjectPath) {
dbusPath = s.Dbus.Path()
return
}

View File

@@ -85,7 +85,7 @@ func TestService_Collections(t *testing.T) {
}
t.Logf(
"collection #%v (name '%v', label '%v'): created %v, last modified %v",
idx, c.PathName(), collLabel, created, modified,
idx, c.path(), collLabel, created, modified,
)
}
}
@@ -177,7 +177,7 @@ func TestService_GetCollection(t *testing.T) {
if coll, err = svc.GetCollection(defaultCollection); err != nil {
t.Errorf("failed to get collection '%v' via Service.GetCollection: %v", defaultCollection, err.Error())
} else {
t.Logf("got collection '%v' via reference '%v'", coll.name, defaultCollection)
t.Logf("got collection '%v' via reference '%v'", coll.LabelName, defaultCollection)
}
if err = svc.Close(); err != nil {
@@ -277,7 +277,13 @@ func TestService_Secrets(t *testing.T) {
t.Errorf("at least one locked item in collection '%v'", collectionName.String())
}
if len(itemResultsUnlocked) != 1 {
t.Errorf("number of unlocked items in collection '%v' is not equal to 1", collectionName.String())
t.Errorf(
"number of unlocked items in collection '%v' (%v) is not equal to 1; items dump pending...",
collectionName.String(), len(itemResultsUnlocked),
)
for idx, i := range itemResultsUnlocked {
t.Logf("ITEM #%v IN COLLECTION %v: %v ('%v')", idx, collectionName.String(), i.LabelName, string(i.Dbus.Path()))
}
}
if resultItemName, err = itemResultsUnlocked[0].Label(); err != nil {
t.Errorf("cannot fetch test Item name from collection '%v' in SearchItems: %v", collectionName.String(), err.Error())
@@ -374,10 +380,11 @@ func TestService_Locking(t *testing.T) {
}
if collection, err = svc.CreateCollection(collectionName.String()); err != nil {
if err = svc.Close(); err != nil {
t.Errorf("could not close Service.Session: %v", err.Error())
}
t.Errorf("could not create collection '%v': %v", collectionName.String(), err.Error())
if err = svc.Close(); err != nil {
t.Fatalf("could not close Service.Session: %v", err.Error())
}
return
} else {
t.Logf("created collection '%v' at path '%v' successfully", collectionName.String(), string(collection.Dbus.Path()))
}
@@ -400,23 +407,23 @@ func TestService_Locking(t *testing.T) {
// Change the state.
if isLocked {
if err = svc.Unlock(collection.Dbus.Path()); err != nil {
if err = collection.Unlock(); err != nil {
t.Errorf("could not unlock collection '%v': %v", collectionName.String(), err.Error())
}
if stateChangeLock, err = collection.Locked(); err != nil {
t.Errorf("received error when checking collection '%v' lock status: %v", collectionName.String(), err.Error())
}
if err = svc.Lock(collection.Dbus.Path()); err != nil {
if err = collection.Lock(); err != nil {
t.Errorf("could not lock collection '%v': %v", collectionName.String(), err.Error())
}
} else {
if err = svc.Lock(collection.Dbus.Path()); err != nil {
if err = collection.Lock(); err != nil {
t.Errorf("could not lock collection '%v': %v", collectionName.String(), err.Error())
}
if stateChangeLock, err = collection.Locked(); err != nil {
t.Errorf("received error when checking collection '%v' lock status: %v", collectionName.String(), err.Error())
}
if err = svc.Unlock(collection.Dbus.Path()); err != nil {
if err = collection.Unlock(); err != nil {
t.Errorf("could not unlock collection '%v': %v", collectionName.String(), err.Error())
}
}

View File

@@ -42,3 +42,11 @@ func (s *Session) Close() (err error) {
return
}
// path is a *very* thin wrapper around Session.Dbus.Path().
func (s *Session) path() (dbusPath dbus.ObjectPath) {
dbusPath = s.Dbus.Path()
return
}

View File

@@ -58,6 +58,11 @@ type Prompt struct {
*DbusObject
}
type LockableObject interface {
Locked() (bool, error)
path() dbus.ObjectPath
}
/*
Service is a general SecretService interface, sort of handler for Dbus - it's used for fetching a Session, Collections, etc.
https://developer-old.gnome.org/libsecret/0.18/SecretService.html
@@ -67,6 +72,8 @@ type Service struct {
*DbusObject
// Session is a default Session initiated automatically.
Session *Session `json:"-"`
// IsLocked indicates if the Service is locked or not. Status updated by Service.Locked.
IsLocked bool `json:"locked"`
}
/*
@@ -82,24 +89,31 @@ type Session struct {
/*
Collection is an accessor for libsecret collections, which contain multiple Secret Item items.
Do not change any of these values directly; use the associated methods instead.
Reference:
https://developer-old.gnome.org/libsecret/0.18/SecretCollection.html
https://specifications.freedesktop.org/secret-service/latest/ch03.html
*/
type Collection struct {
*DbusObject
// lastModified is unexported because it's important that API users don't change it; it's used by Collection.Modified.
lastModified time.Time
// IsLocked indicates if the Collection is locked or not. Status updated by Collection.Locked.
IsLocked bool `json:"locked"`
// LabelName is the Collection's label (as given by Collection.Label and modified by Collection.Relabel).
LabelName string `json:"label"`
// CreatedAt is when this Collection was created (used by Collection.Created).
CreatedAt time.Time `json:"created"`
// LastModified is when this Item was last changed; it's used by Collection.Modified.
LastModified time.Time `json:"modified"`
// Alias is the Collection's alias (as handled by Service.ReadAlias and Service.SetAlias).
Alias string `json:"alias"`
// lastModifiedSet is unexported; it's only used to determine if this is a first-initialization of the modification time or not.
lastModifiedSet bool
// name is used for the Collection's name/label so the Dbus path doesn't need to be parsed all the time.
name string
// service tracks the Service this Collection was created from.
service *Service
}
/*
Item is an entry in a Collection that contains a Secret.
Item is an entry in a Collection that contains a Secret. Do not change any of these values directly; use the associated methods instead.
https://developer-old.gnome.org/libsecret/0.18/SecretItem.html
https://specifications.freedesktop.org/secret-service/latest/re03.html
*/
@@ -107,8 +121,18 @@ type Item struct {
*DbusObject
// Secret is the corresponding Secret object.
Secret *Secret `json:"secret"`
// lastModified is unexported because it's important that API users don't change it; it's used by Collection.Modified.
lastModified time.Time
// IsLocked indicates if the Item is locked or not. Status updated by Item.Locked.
IsLocked bool
// Attrs are the Item's attributes (as would be returned via Item.Attributes).
Attrs map[string]string `json:"attributes"`
// LabelName is the Item's label (as given by Item.Label and modified by Item.Relabel).
LabelName string `json:"label"`
// SecretType is the Item's secret type (as returned by Item.Type).
SecretType string `json:"type"`
// CreatedAt is when this Item was created (used by Item.Created).
CreatedAt time.Time `json:"created"`
// LastModified is when this Item was last changed; it's used by Item.Modified.
LastModified time.Time `json:"modified"`
// lastModifiedSet is unexported; it's only used to determine if this is a first-initialization of the modification time or not.
lastModifiedSet bool
/*
@@ -145,5 +169,5 @@ type Secret struct {
session *Session
}
// SecretValue is a custom type that handles JSON encoding/decoding a little more easily.
// SecretValue is a custom type that handles JSON encoding a little more easily.
type SecretValue []byte