go-console

go console is a go lib to implement consoles, it includes:

Std output console
Telnet console
SSH console
MQTT console (with lib mqtt-shell of freedeamer82)
Other Consoles can be added easily(BLE,Serial etc..)

[============================================================
           ______________________________________           
  ________|                                      |_______  
  \       |                Welcome               |      / 
   \      |                                      |     / 
   /      |______________________________________|     \ 
  /__________)                                (_________\ 
 
[============================================================
> Password?
>
>
>

Std output console example

c := console.NewStdOutputConsole()
c.EnableLogin("root")
c.Start()

Telnet console example

func onNewTelnetConsole(console *console.Console) {
	console.EnableLogin("root")
}

ct := console.NewTelnetConsole(telnetPort, 2)
ct.AddCallback(onNewTelnetConsole)

SSH console example

with password

sshc, _ := console.NewSSHConsoleWithPassword(sshPrivateKeyPath, users, console.WithOptionKeyPassphrase(sshPrivateKeyPassPhrase))
go sshc.Start("localhost", sshPort, 2)

with pub key

sshc, _ := console.NewSSHConsoleWithCertificates(sshPrivateKeyPath, sshAuthorizedKeysPath, console.WithOptionKeyPassphrase(sshPrivateKeyPassPhrase))
go sshc.Start("localhost", sshPort, 2)

Mqtt console example

func onNewConsole(console *console.Console) {
	console.EnableLogin("root")
}

opt1 := console.WithOptionMqttConsoleMaxConnections(3)
opt2 := console.WithOptionMqttConsoleTimeout(timeoutSec * time.Second)
mqttConsole := console.NewMqttConsole(clientOps, "test", opt1, opt2)
mqttConsole.AddCallbackOnNewConsole(onNewConsole)
go mqttConsole.Start()

go console api

handle operation

func (c *Console) Start()
func (c *Console) Stop()
func (c *Console) AddCallbackOnClose(cb OnCLoseTaskCallback)
func (c *Console) RemoveCallbackOnClose()
func (c *Console) GetUUID() string

handle console commands (help and whoAmI already implemented)

func (c *Console) AddConsoleCommand(cmd *ConsoleCommand)
func (c *Console) RemoveConsoleCommand(cmd *ConsoleCommand)

handle login

func (c *Console) EnableLogin(password string)
func (c *Console) DisableLogin()
func (c *Console) IsLoginEnabled() bool
func (c *Console) IsUserLogged() bool

customize aspect

func (c *Console) SetWelcomeMessage(welcome string)
func (c *Console) SetTimeout(timeout time.Duration)

func (c *Console) Print(a ...interface{}) (n int, err error)
func (c *Console) Printf(format string, a ...interface{}) (n int, err error)
func (c *Console) PrintWithoutLn(a ...interface{}) (n int, err error)
func (c *Console) Println() (n int, err error)

console commands

func NewConsoleCommand(cmd string, handler ConsoleCommandHandler, help string) *ConsoleCommand

[ type ConsoleCommandHandler func(console *Console, command *ConsoleCommand, args []string) CommandError ]
func (c *ConsoleCommand) GetCommand() string
func (c *ConsoleCommand) GetHelp() string
func (c *ConsoleCommand) GetUserLevel() User
func (c *ConsoleCommand) SetUserLevel(level User)

example command implementation

hndEcho := func(c *Console, command *ConsoleCommand, args []string) {
  var echo = string
  for _,s := range args {
    echo = fmt.Sprintf("%s %s", echo, s)
  }
  c.Print(echo)
  return NO_ERR
}

echoCommand := NewConsoleCommand("echo", hndEcho, "display a text or a string to the standard output")
echoCommand.SetUserLevel(Guest)

myConsole.addConsoleCommand(echoCommand)

example add command on new console callback

sshc, _ := console.NewSSHConsoleWithPassword(
  sshPrivateKeyPath, 
  users, 
  console.WithOptionKeyPassphrase(sshPrivateKeyPassPhrase)
)
  
func onNewConsoleAddCommand(console *console.Console) {
  console.addConsoleCommand(echoCommand)
}
sshc.AddCallbackOnNewConsole(onNewConsoleAddCommand)
go sshc.Start("localhost", sshPort, 2)

example add timeout

sshc, _ := console.NewSSHConsoleWithPassword(
  sshPrivateKeyPath, 
  users, 
  console.WithOptionKeyPassphrase(sshPrivateKeyPassPhrase)
  console.WithOptionConsoleTimeout(2*time.Minute)
)

go sshc.Start("localhost", sshPort, 2)

run the example

(set parameters like psw, file path, ports on examples/server/main.go file)

cd example/server
go build

//console on std output
./server 0

//console telnet
./server 1

//console ssh (password)
./server 2

//console ssh (pub keys)
./server 3

//console mqtt
./server 4

freedreamer82/go-console