speakeasy

README

Speakeasy

This package provides cross-platform Go (#golang) helpers for taking user input from the terminal while not echoing the input back (similar to getpasswd). The package uses syscalls to avoid any dependence on cgo, and is therefore compatible with cross-compiling.

Unicode

Multi-byte unicode characters work successfully on Mac OS X. On Windows, however, this may be problematic (as is UTF in general on Windows). Other platforms have not been tested.

License

The code herein was not written by me, but was compiled from two separate open source packages. Unix portions were imported from gopass, while Windows portions were imported from the CloudFoundry Go CLI's Windows terminal helpers.

The license for the windows portion has been copied exactly from the source (though I attempted to fill in the correct owner in the boilerplate copyright notice).

Documentation

Index

• Constants
• func Ask(prompt string) (password string, err error)
• func FAsk(file *os.File, prompt string) (password string, err error)

Constants

const ENABLE_ECHO_INPUT = 0x0004

SetConsoleMode function can be used to change value of ENABLE_ECHO_INPUT: http://msdn.microsoft.com/en-us/library/windows/desktop/ms686033(v=vs.85).aspx

Functions

func Ask

func Ask(prompt string) (password string, err error)

Ask the user to enter a password with input hidden. prompt is a string to display before the user's input. Returns the provided password, or an error if the command failed.

func FAsk

func FAsk(file *os.File, prompt string) (password string, err error)

Same as the Ask function, except it is possible to specify the file to write the prompt to.