daemon

Documentation

Index

• Constants
• func Run(opts Opts, exit chan ExitMode, log chan Message) (err error)
• type ExitMode
• type Message
• type Opts
• type User

Constants

const (
	// PSSHSoftwareVersion is the softwareversion field of RFC 4253 section 4.2.
	PSSHSoftwareVersion string = "PROTECTEDSSH0.1"
)

Functions

func Run

func Run(opts Opts, exit chan ExitMode, log chan Message) (err error)

Run runs the daemon using the given DaemonOpts object.

Types

type ExitMode

type ExitMode int8

ExitMode is the mode for exiting. Only the explicit constants should be used.

const (
	// ExitRude indicates that the daemon should exit as soon as it receives this notification.
	// Nothing should be expected to be logged and there should be no cleanup.
	ExitRude ExitMode = 1

	// ExitErr is the same as ExitRude but should log the message for exiting.
	ExitErr ExitMode = -1

	// ExitClean indicates that the daemon should exit cleanly when it's safe to do so.
	// Only the cleanup will be logged.
	ExitClean ExitMode = 2

	// ExitWithReason is the same as ExitClean but should log the reason for exiting.
	ExitWithReason ExitMode = -2
)

type Message

type Message string

Message is some message being sent to the daemon that should be logged.

type Opts

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

Opts is the options that are used to run the daemon. TODO: should be parsed from /etc/protectedssh/config.toml or something like that.

type User

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

User is the configuration for a psshd user.