whisper

Documentation

Index

• func Client() whisper.Service
• func ConnectClient(endpoint string) error
• func CreateSecretLink(secret string, password string, accesses int, expirationDate time.Time) (link string, err error)
• func ResetClient()

Functions

func Client

func Client() whisper.Service

Accessor for the client, used in testing.

func ConnectClient

func ConnectClient(endpoint string) error

Connects the client to the Whisper service, throws an error if the client is already connected.

func CreateSecretLink

func CreateSecretLink(secret string, password string, accesses int, expirationDate time.Time) (link string, err error)

Creates a Whisper secret and returns the link to the Whisper UI where a user can access the secret value. If the password is specified, then the user will need to enter the password to access the secret. The accesses and expiration date options limit how long the secret is available. By default these values are 3 accesses and 7 days from today. An error is returned if the secret cannot be created with Whisper.

func ResetClient

func ResetClient()

Resets the client connection.