onepassword

README

POSH 1Password provider

Integrates 1Password into your shell and adds helpers for your commands.

Help

1Password session helper.

Usage:
  op [command]

Available commands:
  get [id]          Retrieve an entry from your account
  signin            Sign into your 1Password account for the session
  register [email]  Add your 1Password account

Usage

Plugin

package plugin

import (
	"github.com/foomo/posh/provider/onepassword"
	"github.com/foomo/posh/pkg/cache"
	"github.com/foomo/posh/pkg/command"
	"github.com/foomo/posh/pkg/log"
	"github.com/foomo/posh/pkg/plugin"
	"github.com/spf13/viper"
)

type Plugin struct {
	l        log.Logger
	c        cache.Cache
	commands command.Commands
}

func New(l log.Logger) (plugin.Plugin, error) {
	inst := &Plugin{
		l:        l,
		c:        cache.MemoryCache{},
		commands: command.Commands{},
	}

	// ...

	// 1Password
	if onePassword, err := onepassword.New(l, inst.c)); err != nil {
		return nil, err
	} else if cmd, err := onepassword.NewCommand(l, onePassword); err != nil {
		return nil, err
	} else {
		inst.commands.Add(cmd)
	}

	// ...

	return inst, nil
}

Config

Add this to your '.posh.yml' file:

onePassword:
  account: <ACCOUNT>
  tokenFilename: .posh/config/.op

To add a requirement check for op, add:

require:
  scripts:
    - name: op
      command: |
        [[ $(op account --account <ACCOUNT> get 2>&1) =~ "found no account" ]] && exit 1 || exit 0
      help: |
        You're 1Password account is not registered yet! Please do so by running:

          $ op account add --address <ACCOUNT>.1password.eu --email <EMAIL>
  packages:
    - name: op
      version: '~2'
      command: op --version
      help: |
        Please ensure you have the 1Password cli 'op' installed in the required version: %s!

          $ brew update
          $ brew install 1password-cli

Documentation

Index

• Variables
• func AuthChecker(p *OnePassword) check.Checker
• type Command
  • func NewCommand(l log.Logger, op *OnePassword, opts ...CommandOption) (*Command, error)
  • func (c *Command) Complete(ctx context.Context, r *readline.Readline) []goprompt.Suggest
  • func (c *Command) Description() string
  • func (c *Command) Execute(ctx context.Context, r *readline.Readline) error
  • func (c *Command) Help(ctx context.Context, r *readline.Readline) string
  • func (c *Command) Name() string
• type CommandOption
  • func CommandWithName(v string) CommandOption
• type Config
• type OnePassword
  • func New(l log.Logger, cache cache.Cache, opts ...Option) (*OnePassword, error)
  • func (op *OnePassword) Get(ctx context.Context, secret Secret) (string, error)
  • func (op *OnePassword) GetDocument(ctx context.Context, secret Secret) (string, error)
  • func (op *OnePassword) GetOnetimePassword(ctx context.Context, account, uuid string) (string, error)
  • func (op *OnePassword) IsAuthenticated() (bool, error)
  • func (op *OnePassword) Render(ctx context.Context, source string) ([]byte, error)
  • func (op *OnePassword) RenderFile(ctx context.Context, source string) ([]byte, error)
  • func (op *OnePassword) RenderFileTo(ctx context.Context, source, target string) error
  • func (op *OnePassword) SignIn(ctx context.Context) error
• type Option
  • func WithConfigKey(v string) Option
• type Secret

Variables

var ErrNotSignedIn = errors.New("you're not signed into your 1password account")

Functions

func AuthChecker

func AuthChecker(p *OnePassword) check.Checker

Types

type Command

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

func NewCommand

func NewCommand(l log.Logger, op *OnePassword, opts ...CommandOption) (*Command, error)

func (*Command) Complete

func (c *Command) Complete(ctx context.Context, r *readline.Readline) []goprompt.Suggest

func (*Command) Description

func (c *Command) Description() string

func (*Command) Execute

func (c *Command) Execute(ctx context.Context, r *readline.Readline) error

func (*Command) Help

func (c *Command) Help(ctx context.Context, r *readline.Readline) string

func (*Command) Name

func (c *Command) Name() string

type CommandOption

type CommandOption func(*Command) error

func CommandWithName

func CommandWithName(v string) CommandOption

type Config

type Config struct {
	Account       string `json:"account" yaml:"account"`
	TokenFilename string `json:"tokenFilename" yaml:"tokenFilename"`
}

type OnePassword

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

func New

func New(l log.Logger, cache cache.Cache, opts ...Option) (*OnePassword, error)

func (*OnePassword) Get

func (op *OnePassword) Get(ctx context.Context, secret Secret) (string, error)

func (*OnePassword) GetDocument

func (op *OnePassword) GetDocument(ctx context.Context, secret Secret) (string, error)

func (*OnePassword) GetOnetimePassword

func (op *OnePassword) GetOnetimePassword(ctx context.Context, account, uuid string) (string, error)

func (*OnePassword) IsAuthenticated

func (op *OnePassword) IsAuthenticated() (bool, error)

func (*OnePassword) Render

func (op *OnePassword) Render(ctx context.Context, source string) ([]byte, error)

func (*OnePassword) RenderFile

func (op *OnePassword) RenderFile(ctx context.Context, source string) ([]byte, error)

func (*OnePassword) RenderFileTo

func (op *OnePassword) RenderFileTo(ctx context.Context, source, target string) error

func (*OnePassword) SignIn

func (op *OnePassword) SignIn(ctx context.Context) error

type Option

type Option func(*OnePassword) error

func WithConfigKey

func WithConfigKey(v string) Option

type Secret

type Secret struct {
	Account string `json:"account" yaml:"account"`
	Vault   string `json:"vault" yaml:"vault"`
	Item    string `json:"item" yaml:"item"`
	Field   string `json:"field" yaml:"field"`
}