webauth

Documentation

Index

• Constants
• func Handler(c echo.Context) error
• func Plugin() *node.Plugin
• type Request
• type Response

Constants

const (
	// CfgWebAPIAuthUsername defines the config flag of the web API authentication username.
	CfgWebAPIAuthUsername = "webapi.auth.username"
	// CfgWebAPIAuthPassword defines the config flag of the web API authentication password.
	CfgWebAPIAuthPassword = "webapi.auth.password"
	// CfgWebAPIAuthPrivateKey defines the config flag of the web API authentication private key.
	CfgWebAPIAuthPrivateKey = "webapi.auth.privateKey"
)

const PluginName = "WebAPI Auth"

PluginName is the name of the web API auth plugin.

Functions

func Handler

func Handler(c echo.Context) error

Handler handles the web auth request.

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

Types

type Request

type Request struct {
	// Username is the username of the request.
	Username string `json:"username"`
	// Password is the password of the request.
	Password string `json:"password"`
}

Request defines the struct of the request.

type Response

type Response struct {
	// Token is the json web token.
	Token string `json:"token"`
}

Response defines the struct of the response.