gopass

README

getpasswd in Go

Retrieve password from user terminal or piped input without echo.

Verified on BSD, Linux, and Windows.

Example:

package main

import "fmt"
import "github.com/glycerine/gopass"

func main() {
	fmt.Printf("Password: ")

	// Silent. For printing *'s use gopass.GetPasswdMasked()
	pass, err := gopass.GetPasswd()
	if err != nil {
		// Handle gopass.ErrInterrupted or getch() read error
	}

	// Do something with pass
}

Caution: Multi-byte characters not supported!

Forked from https://github.com/howeyc/gopass

Documentation

Index

• Variables
• func GetPasswd() ([]byte, error)
• func GetPasswdMasked() ([]byte, error)
• func GetPasswdPrompt(prompt string, mask bool, r FdReader, w io.Writer) ([]byte, error)
• type CleartextReader
  • func NewCleartextReader() *CleartextReader
  • func (c *CleartextReader) ReadSlice() ([]byte, error)
  • func (c *CleartextReader) SetPrompt(s string)
• type FdReader

Variables

var (
	ErrInterrupted       = errors.New("interrupted")
	ErrMaxLengthExceeded = fmt.Errorf("maximum byte limit (%v) exceeded", maxLength)
)

Functions

func GetPasswd

func GetPasswd() ([]byte, error)

GetPasswd returns the password read from the terminal without echoing input. The returned byte array does not include end-of-line characters.

func GetPasswdMasked

func GetPasswdMasked() ([]byte, error)

GetPasswdMasked returns the password read from the terminal, echoing asterisks. The returned byte array does not include end-of-line characters.

func GetPasswdPrompt

func GetPasswdPrompt(prompt string, mask bool, r FdReader, w io.Writer) ([]byte, error)

GetPasswdPrompt prompts the user and returns the password read from the terminal. If mask is true, then asterisks are echoed. The returned byte array does not include end-of-line characters.

Types

type CleartextReader

type CleartextReader struct {
	Prompt string
	R      FdReader
	W      io.Writer
}

func NewCleartextReader

func NewCleartextReader() *CleartextReader

func (*CleartextReader) ReadSlice

func (c *CleartextReader) ReadSlice() ([]byte, error)

ReadSlice returns a line of input read from terminal, interruptable by ctrl-c. If prompt is not empty, it will be output as a prompt to the user

func (*CleartextReader) SetPrompt

func (c *CleartextReader) SetPrompt(s string)

SetPrompt changes the user prompt to s.

type FdReader

type FdReader interface {
	io.Reader
	Fd() uintptr
}