config

Documentation

Index

• Constants
• Variables
• func GetDir() (string, error)
• func GetFile() (string, error)
• func GetFilePretty() (string, error)
• func NewContext(ctx context.Context, conf *Config) context.Context
• type Config
  • func FromContext(ctx context.Context) (*Config, bool)
  • func Load(cmd *cobra.Command, save bool) (*Config, error)
  • func New() *Config
  • func (c *Config) RegisterFlags(cmd *cobra.Command)
• type NamedProfile
• type Profile
• type ProfileMap
  • func (p ProfileMap) Named() []NamedProfile
• type ProfileRef
  • func (p *ProfileRef) MarshalText() ([]byte, error)
  • func (p *ProfileRef) UnmarshalText(text []byte) error
• type TOMLParser
  • func (p TOMLParser) Marshal(o map[string]interface{}) ([]byte, error)
  • func (p TOMLParser) Unmarshal(b []byte) (map[string]interface{}, error)

Constants

const (
	FlagConfig = "config"

	FlagCount    = "count"
	FlagWordlist = "wordlist"
	FlagTemplate = "template"
	FlagProfile  = "profile"
)

Variables

var ErrProfileNotFound = errors.New("profile not found")

Functions

func GetDir

func GetDir() (string, error)

func GetFile

func GetFile() (string, error)

func GetFilePretty

func GetFilePretty() (string, error)

func NewContext

func NewContext(ctx context.Context, conf *Config) context.Context

Types

type Config

type Config struct {
	File string `toml:"-"`

	Count    int           `toml:"count" comment:"Number of passphrases to generate."`
	Profile  ProfileRef    `toml:"profile" comment:"Default profile used to generate passphrases."`
	Param    any           `toml:"-"`
	Profiles ProfileMap    `toml:"profiles" comment:"Preconfigured profiles and default parameters."`
	Wordlist wordlist.Meta `toml:"wordlist" comment:"Wordlist to use. (one of: long, short1, short2)"`
	Template string        `toml:"template" comment:"Default template used to generate passphrases. If not empty, will override the default profile." `
}

func FromContext

func FromContext(ctx context.Context) (*Config, bool)

func Load

func Load(cmd *cobra.Command, save bool) (*Config, error)

func New

func New() *Config

func (*Config) RegisterFlags

func (c *Config) RegisterFlags(cmd *cobra.Command)

type NamedProfile

type NamedProfile struct {
	Name string
	Profile
}

type Profile

type Profile struct {
	Template string `toml:"template"`
	Param    int    `toml:"param,omitempty"`
}

type ProfileMap

type ProfileMap map[string]Profile

func (ProfileMap) Named

func (p ProfileMap) Named() []NamedProfile

type ProfileRef

type ProfileRef struct {
	Name  string
	Param int
}

func (*ProfileRef) MarshalText

func (p *ProfileRef) MarshalText() ([]byte, error)

func (*ProfileRef) UnmarshalText

func (p *ProfileRef) UnmarshalText(text []byte) error

type TOMLParser

type TOMLParser struct{}

func (TOMLParser) Marshal

func (p TOMLParser) Marshal(o map[string]interface{}) ([]byte, error)

func (TOMLParser) Unmarshal

func (p TOMLParser) Unmarshal(b []byte) (map[string]interface{}, error)