pageant

README

Package pageant provides an interface to PyTTY pageant.exe utility.

This package is windows-only.

See documentation on GoDoc

License: MIT

Documentation

Overview

Package pageant provides an interface to PyTTY pageant.exe utility. This package is windows-only

Index

• Constants
• Variables
• func Available() bool
• func New() agent.Agent

Constants

const MaxMessageLen = 8192

MaxMessageLen defines maximum size of message can be sent to pageant

Variables

var (
	// ErrPageantNotFound returns when pageant process not found
	ErrPageantNotFound = errors.New("pageant process not found")
	// ErrSendMessage returns when message to pageant cannt be sent
	ErrSendMessage = errors.New("error sending message")

	// ErrMessageTooLong returns when message is too long (see MaxMessageLen)
	ErrMessageTooLong = errors.New("message too long")
	// ErrInvalidMessageFormat returns when message have invalid fomat
	ErrInvalidMessageFormat = errors.New("invalid message format")
	// ErrResponseTooLong returns when response from pageant is too long
	ErrResponseTooLong = errors.New("response too long")
)

Functions

func Available

func Available() bool

Available returns true if Pageant is started

func New

func New() agent.Agent

New returns new ssh-agent instance (see http://golang.org/x/crypto/ssh/agent)