wincred

README

wincred

Go wrapper around the Windows Credential Manager API functions.

Installation

go get github.com/danieljoos/wincred

Usage

See the following examples:

Create and store a new generic credential object

package main

import (
    "fmt"
    "github.com/danieljoos/wincred"
)

func main() {
    cred := wincred.NewGenericCredential("myGoApplication")
    cred.CredentialBlob = []byte("my secret")
    err := cred.Write()
    
    if err != nil {
        fmt.Println(err)
    }
} 

Retrieve a credential object

package main

import (
    "fmt"
    "github.com/danieljoos/wincred"
)

func main() {
    cred, err := wincred.GetGenericCredential("myGoApplication")
    if err == nil {
        fmt.Println(string(cred.CredentialBlob))
    }
} 

Remove a credential object

package main

import (
    "fmt"
    "github.com/danieljoos/wincred"
)

func main() {
    cred, err := wincred.GetGenericCredential("myGoApplication")
    if err != nil {
        fmt.Println(err)
        return
    }
    cred.Delete()
} 

List all available credentials

package main

import (
    "fmt"
    "github.com/danieljoos/wincred"
)

func main() {
    creds, err := wincred.List()
    if err != nil {
        fmt.Println(err)
        return
    }
    for i := range(creds) {
        fmt.Println(creds[i].TargetName)
    }
}

Documentation

Index

• type Credential
  • func List() ([]*Credential, error)
• type CredentialAttribute
• type CredentialPersistence
• type DomainPassword
  • func GetDomainPassword(targetName string) (*DomainPassword, error)
  • func NewDomainPassword(targetName string) (result *DomainPassword)
  • func (t *DomainPassword) Delete() (err error)
  • func (t *DomainPassword) SetPassword(pw string)
  • func (t *DomainPassword) Write() (err error)
• type GenericCredential
  • func GetGenericCredential(targetName string) (*GenericCredential, error)
  • func NewGenericCredential(targetName string) (result *GenericCredential)
  • func (t *GenericCredential) Delete() (err error)
  • func (t *GenericCredential) Write() (err error)

Types

type Credential

type Credential struct {
	TargetName     string
	Comment        string
	LastWritten    time.Time
	CredentialBlob []byte
	Attributes     []CredentialAttribute
	TargetAlias    string
	UserName       string
	Persist        CredentialPersistence
}

func List

func List() ([]*Credential, error)

List the contents of the Credentials store

type CredentialAttribute

type CredentialAttribute struct {
	Keyword string
	Value   []byte
}

type CredentialPersistence

type CredentialPersistence uint32

const (
	PersistSession      CredentialPersistence = 0x1
	PersistLocalMachine CredentialPersistence = 0x2
	PersistEnterprise   CredentialPersistence = 0x3
)

type DomainPassword

type DomainPassword struct {
	Credential
}

func GetDomainPassword

func GetDomainPassword(targetName string) (*DomainPassword, error)

Get the domain password credential with the given target host name

func NewDomainPassword

func NewDomainPassword(targetName string) (result *DomainPassword)

Create a new domain password credential used for login to the given target host name

func (*DomainPassword) Delete

func (t *DomainPassword) Delete() (err error)

Delete the domain password credential from Windows credential manager

func (*DomainPassword) SetPassword

func (t *DomainPassword) SetPassword(pw string)

Set the CredentialBlob field of a domain password credential using an UTF16 encoded password string

func (*DomainPassword) Write

func (t *DomainPassword) Write() (err error)

Persist the domain password credential to Windows credential manager

type GenericCredential

type GenericCredential struct {
	Credential
}

func GetGenericCredential

func GetGenericCredential(targetName string) (*GenericCredential, error)

Get the generic credential with the given name from Windows credential manager

func NewGenericCredential

func NewGenericCredential(targetName string) (result *GenericCredential)

Create a new generic credential with the given name

func (*GenericCredential) Delete

func (t *GenericCredential) Delete() (err error)

Delete the credential from Windows credential manager

func (*GenericCredential) Write

func (t *GenericCredential) Write() (err error)

Persist the credential to Windows credential manager