auth

Documentation

Index

• Variables
• func Commands(svcOpts ...vine.Option) []*cli.Command
• func Plugins() []plugin.Plugin
• func Register(pl plugin.Plugin) error
• func Run(ctx *cli.Context, svcOpts ...vine.Option)

Variables

var (
	// Name of the service
	Name = "go.vine.auth"
	// Address of the service
	Address = ":8010"
	// ServiceFlags are provided to commands which run vine services
	ServiceFlags = []cli.Flag{
		&cli.StringFlag{
			Name:    "address",
			Usage:   "Set the auth http address e.g 0.0.0.0:8010",
			EnvVars: []string{"VINE_SERVER_ADDRESS"},
		},
		&cli.StringFlag{
			Name:    "auth-provider",
			EnvVars: []string{"VINE_AUTH_PROVIDER"},
			Usage:   "Auth provider enables account generation",
		},
		&cli.StringFlag{
			Name:    "auth-public-key",
			EnvVars: []string{"VINE_AUTH_PUBLIC_KEY"},
			Usage:   "Public key for JWT auth (base64 encoded PEM)",
		},
		&cli.StringFlag{
			Name:    "auth-private-key",
			EnvVars: []string{"VINE_AUTH_PRIVATE_KEY"},
			Usage:   "Private key for JWT auth (base64 encoded PEM)",
		},
	}
	// RuleFlags are provided to commands which create or delete rules
	RuleFlags = []cli.Flag{
		&cli.StringFlag{
			Name:  "scope",
			Usage: "The scope to amend, e.g. 'user' or '*', leave blank to make public",
		},
		&cli.StringFlag{
			Name:  "resource",
			Usage: "The resource to amend in the format type:name:endpoint, e.g. service:go.vine.auth:*",
		},
		&cli.StringFlag{
			Name:  "access",
			Usage: "The access level, must be granted or denied",
			Value: "granted",
		},
		&cli.IntFlag{
			Name:  "priority",
			Usage: "The priority level, default is 0, the greater the number the higher the priority",
			Value: 0,
		},
	}
	// AccountFlags are provided to the create account command
	AccountFlags = []cli.Flag{
		&cli.StringFlag{
			Name:  "secret",
			Usage: "The account secret (password)",
		},
		&cli.StringSliceFlag{
			Name:  "scopes",
			Usage: "Comma seperated list of scopes to give the account",
		},
	}
)

Functions

func Commands

func Commands(svcOpts ...vine.Option) []*cli.Command

Commands for auth

func Plugins

func Plugins() []plugin.Plugin

Plugins lists the auth plugins

func Register

func Register(pl plugin.Plugin) error

Register registers an auth plugin

func Run

func Run(ctx *cli.Context, svcOpts ...vine.Option)

run the auth service