bitwarden

README

Bitwarden API Client

This package provides a client for the Bitwarden API, which is used to interact with the Bitwarden password manager.

References:

• API https://github.com/jcs/rubywarden/blob/master/API.md
• Package https://pkg.go.dev/github.com/mutablelogic/go-client/pkg/bitwarden

Documentation

Overview

bitwarden implements an API client for bitwarden

References:

https://github.com/jcs/rubywarden/blob/master/API.md
https://github.com/mvdan/bitw/blob/master/auth.go
https://github.com/philhug/bitwarden-client-go

bitwarden implements an API client for bitwarden

Index

• func OptCredentials(clientId, secret string) client.ClientOpt
• func OptDevice(device schema.Device) client.ClientOpt
• func OptFileStorage(cachePath string) client.ClientOpt
• func OptStorage(v Storage) client.ClientOpt
• type Client
  • func New(opts ...client.ClientOpt) (*Client, error)
  • func (c *Client) Ciphers(opts ...RequestOpt) (schema.Iterator[*schema.Cipher], error)
  • func (c *Client) Folders(opts ...RequestOpt) (schema.Iterator[*schema.Folder], error)
  • func (c *Client) Login(opts ...RequestOpt) error
  • func (c *Client) Session() *schema.Session
  • func (c *Client) Sync(opts ...RequestOpt) (*schema.Profile, error)
• type Login
• type RequestOpt
  • func OptForce() RequestOpt
  • func OptPassword(v string) RequestOpt
• type Storage

Functions

func OptCredentials

func OptCredentials(clientId, secret string) client.ClientOpt

Set the client_id and client_secret

func OptDevice

func OptDevice(device schema.Device) client.ClientOpt

Set the device, populating missing fields

func OptFileStorage

func OptFileStorage(cachePath string) client.ClientOpt

Use file storage engine to read and write data

func OptStorage

func OptStorage(v Storage) client.ClientOpt

Use a storage engine to read and write data

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...client.ClientOpt) (*Client, error)

func (*Client) Ciphers

func (c *Client) Ciphers(opts ...RequestOpt) (schema.Iterator[*schema.Cipher], error)

Return cipher iterator

func (*Client) Folders

func (c *Client) Folders(opts ...RequestOpt) (schema.Iterator[*schema.Folder], error)

Return folder iterator

func (*Client) Login

func (c *Client) Login(opts ...RequestOpt) error

Login sets the session token. Use OptForce to request token even if there is a valid token

func (*Client) Session

func (c *Client) Session() *schema.Session

Session returns the copy of the current session

func (*Client) Sync

func (c *Client) Sync(opts ...RequestOpt) (*schema.Profile, error)

Sync folders, cipers and folders with storage, and return the profile

type Login

type Login struct {
	GrantType    string `json:"grant_type"`
	Scope        string `json:"scope"`
	ClientId     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
}

type RequestOpt

type RequestOpt func(*opt) error

func OptForce

func OptForce() RequestOpt

Force login by clearing the token

func OptPassword

func OptPassword(v string) RequestOpt

Set decryption password

type Storage

type Storage interface {
	// Read the session from storage a session id, returns nil if there is no session
	ReadSession() (*schema.Session, error)

	// Write the session to storage
	WriteSession(*schema.Session) error

	// Read the profile from storage
	ReadProfile() (*schema.Profile, error)

	// Write the profile to storage
	WriteProfile(*schema.Profile) error

	// Write the folders to storage
	WriteFolders(schema.Folders) error

	// Write the ciphers to storage
	WriteCiphers(schema.Ciphers) error

	// Read all ciphers and return an iterator
	ReadCiphers() (schema.Iterator[*schema.Cipher], error)

	// Read all folders and return an iterator
	ReadFolders() (schema.Iterator[*schema.Folder], error)
}

Storage is an interface for reading and writing session, profile, folder and cipher information