Documentation
¶
Index ¶
- Constants
- Variables
- func CheckForConfigFileAndParse() error
- func CloseDb()
- func CreateConfigurationFile(user *UserConfiguration, database *DatabaseConfiguration) error
- func CreateDb(databasePath string, masterkey []byte) error
- func CreateDefaultFile(completeFilePath string) error
- func DbInit() error
- func InitCriticalData() error
- func ParseConfigurationFile() error
- func ReadMasterKeyFromFile(filepath string) ([]byte, error)
- func SaveConfigurationFile() error
- type Configuration
- type DatabaseConfiguration
- type MasterKey
- type UserConfiguration
Constants ¶
const ( // ConfigFileName name of the configuration file ConfigFileName = ".passwdvaultconfig" // ConfigFileType configuration file type ConfigFileType = "yaml" )
Variables ¶
var ( ConfigFilePath = path.Join(os.Getenv("HOME"), ConfigFileName+"."+ConfigFileType) DefaultConfig = Configuration{ User: UserConfiguration{ Name: "someuser", Email: "[email protected]", }, Database: DatabaseConfiguration{ Name: "badger", Path: "/tmp/", Encrypted: true, MasterKey: MasterKey{ FromFilePath: "/etc/passwdvault/mk", Length: 32, }, }, } )
DefaultConfig default configuration
Functions ¶
func CheckForConfigFileAndParse ¶
func CheckForConfigFileAndParse() error
CheckForConfigFileAndParse utility function that checks if config file exists and parse it
func CreateConfigurationFile ¶
func CreateConfigurationFile(user *UserConfiguration, database *DatabaseConfiguration) error
CreateConfigurationFile creates a configuration file in $HOME/.passwdvaultconfig.yaml with values specified in user and database
func CreateDefaultFile ¶
CreateDefaultFile creates a default configuration file in $HOME/.passwdvaultconfig.yaml
func InitCriticalData ¶
func InitCriticalData() error
InitCriticalData utility function that initiates every critical data needed to the program
func ParseConfigurationFile ¶
func ParseConfigurationFile() error
ParseConfigurationFile parses the configuration file
func ReadMasterKeyFromFile ¶
ReadMasterKeyFromFile reads masterkey value from file
func SaveConfigurationFile ¶
func SaveConfigurationFile() error
SaveConfigurationFile saves configuration file
Types ¶
type Configuration ¶
type Configuration struct {
User UserConfiguration
Database DatabaseConfiguration
}
Configuration holds default configuration file with useful data about the database path and config
type DatabaseConfiguration ¶
type DatabaseConfiguration struct {
Name string `mapstructure:"filename"`
Path string `mapstructure:"path"`
Encrypted bool `mapstructure:"encrypted"`
MasterKey MasterKey
}
DatabaseConfiguration struct of the database configuration
type MasterKey ¶
type MasterKey struct {
FromFilePath string `mapstructure:"filepath"`
Length int8 `mapstructure:"len"`
}
MasterKey struct of the masterkey needed to unlock the database
type UserConfiguration ¶
type UserConfiguration struct {
Name string `mapstructure:"name"`
Email string `mapstructure:"email"`
}
UserConfiguration struct of user configuration
Source Files