rc_protocol

README

rc-protocol

Golang implementation of the rc-protocol

This module is used to build Golang remote-control servers and clients.

Install

TBD

Documentation

Index

• Constants
• type Auth
• type Message
• type MessageOptions
• type RCProtocol
  • func NewRCProtocol() RCProtocol
• type Response

Constants

const AUTH_HEADER_NAME = "authorization"

const ISO_8601_FORMAT = "2006-01-02T15:04:05-0700"

Types

type Auth

type Auth interface {
	CreateSig(name string, keyDir string) (string, error)
	CheckSig(header string, certDir string) (bool, error)
	GetHeaderName() string
	ParseHeader(header string) []string
}

type Message

type Message struct {
	Id      int            `json:"id"`
	Command string         `json:"command"`
	Options MessageOptions `json:"options"`
}

type MessageOptions

type MessageOptions struct {
	Cwd     string            `json:"cwd"`
	Timeout int               `json:"timeout"`
	Env     map[string]string `json:"env"`
}

type RCProtocol

type RCProtocol interface {
	Message(json string) Message
	Response(json string) Response
	Auth
}

func NewRCProtocol

func NewRCProtocol() RCProtocol

type Response

type Response struct {
	Id       string `json:"id"`
	Stdout   string `json:"stdout"`
	Stderr   string `json:"stderr"`
	ExitCode int    `json:"exitCode"`
	Signal   string `json:"signal"`
}