teamvault

package module

v0.0.0-...-daa2672 Latest Latest Go to latest Published: Apr 23, 2024 License: BSD-2-Clause Imports: 19 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bborbe/teamvault-utils

Links

Open Source Insights

README ¶

Teamvault Utils

Generate config directory with Teamvault secrets

Install:

go get github.com/bborbe/teamvault-utils/cmd/teamvault-config-dir-generator

Config:

{
    "url": "https://teamvault.example.com",
    "user": "my-user",
    "pass": "my-pass"
}

Run:

teamvault-config-dir-generator \
-teamvault-config="~/.teamvault.json" \
-source-dir=templates \
-target-dir=results \
-logtostderr \
-v=2

Parse variable Teamvault secrets

Install:

go get github.com/bborbe/teamvault-utils/cmd/teamvault-config-parser

Sample config:

foo=bar
username={{ "vLVLbm" | teamvaultUser }}
password={{ "vLVLbm" | teamvaultPassword }}
bar=foo

Run:

cat my.config | teamvault-config-parser
-teamvault-config="~/.teamvault.json" \
-logtostderr \
-v=2

Teamvault Get Username

Install:

go get github.com/bborbe/teamvault-utils/cmd/teamvault-username

Run:

teamvault-username \
--teamvault-config ~/.teamvault-sm.json \
--teamvault-key vLVLbm

Teamvault Get Password

Install:

go get github.com/bborbe/teamvault-utils/cmd/teamvault-password

Run:

teamvault-password \
--teamvault-config ~/.teamvault-sm.json \
--teamvault-key vLVLbm

Teamvault Get Url

Install:

go get github.com/bborbe/teamvault-utils/cmd/teamvault-url

Run:

teamvault-url \
--teamvault-config ~/.teamvault-sm.json \
--teamvault-key vLVLbm

Documentation ¶

Index ¶

type Cache
- func (c *Cache) File(ctx context.Context, key Key) (File, error)
- func (c *Cache) Password(ctx context.Context, key Key) (Password, error)
- func (c *Cache) Search(ctx context.Context, key string) ([]Key, error)
- func (c *Cache) Url(ctx context.Context, key Key) (Url, error)
- func (c *Cache) User(ctx context.Context, key Key) (User, error)
type ConfigGenerator
- func NewGenerator(configParser ConfigParser) ConfigGenerator
type ConfigParser
- func NewParser(teamvaultConnector Connector) ConfigParser
type Connector
- func NewCache(connector Connector) Connector
- func NewDiskFallbackConnector(connector Connector) Connector
- func NewDummyConnector() Connector
- func NewRemoteConnector(httpClient *http.Client, url Url, user User, pass Password) Connector
type File
- func (t File) Content() ([]byte, error)
- func (t File) String() string
type Htpasswd
- func (c *Htpasswd) Generate(ctx context.Context, key Key) ([]byte, error)
type Key
- func (t Key) String() string
type Password
- func (t Password) String() string
type SourceDirectory
- func (s SourceDirectory) String() string
type Staging
- func (s Staging) Bool() bool
type TargetDirectory
- func (t TargetDirectory) String() string
type TeamvaultApiUrl
- func (t TeamvaultApiUrl) Key() (Key, error)
- func (t TeamvaultApiUrl) String() string
type TeamvaultConfig
- func ParseTeamvaultConfig(content []byte) (*TeamvaultConfig, error)
type TeamvaultConfigPath
- func (t TeamvaultConfigPath) Exists() bool
- func (d TeamvaultConfigPath) NormalizePath() (TeamvaultConfigPath, error)
- func (t TeamvaultConfigPath) Parse() (*TeamvaultConfig, error)
- func (t TeamvaultConfigPath) String() string
type TeamvaultCurrentRevision
- func (t TeamvaultCurrentRevision) String() string
type Url
- func (t Url) String() string
type User
- func (t User) String() string
type VariableName
- func (v VariableName) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Cache ¶

type Cache struct {
	Connector Connector
	Passwords map[Key]Password
	Users     map[Key]User
	Urls      map[Key]Url
	Files     map[Key]File
}

func (*Cache) File ¶

func (c *Cache) File(ctx context.Context, key Key) (File, error)

func (*Cache) Password ¶

func (c *Cache) Password(ctx context.Context, key Key) (Password, error)

func (*Cache) Search ¶

func (c *Cache) Search(ctx context.Context, key string) ([]Key, error)

func (*Cache) Url ¶

func (c *Cache) Url(ctx context.Context, key Key) (Url, error)

func (*Cache) User ¶

func (c *Cache) User(ctx context.Context, key Key) (User, error)

type ConfigGenerator ¶

type ConfigGenerator interface {
	Generate(ctx context.Context, sourceDirectory SourceDirectory, targetDirectory TargetDirectory) error
}

func NewGenerator ¶

func NewGenerator(configParser ConfigParser) ConfigGenerator

type ConfigParser ¶

type ConfigParser interface {
	Parse(ctx context.Context, content []byte) ([]byte, error)
}

func NewParser ¶

func NewParser(
	teamvaultConnector Connector,
) ConfigParser

type Connector ¶

type Connector interface {
	Password(ctx context.Context, key Key) (Password, error)
	User(ctx context.Context, key Key) (User, error)
	Url(ctx context.Context, key Key) (Url, error)
	File(ctx context.Context, key Key) (File, error)
	Search(ctx context.Context, name string) ([]Key, error)
}

func NewCache ¶

func NewCache(connector Connector) Connector

func NewDiskFallbackConnector ¶

func NewDiskFallbackConnector(connector Connector) Connector

func NewDummyConnector ¶

func NewDummyConnector() Connector

func NewRemoteConnector ¶

func NewRemoteConnector(
	httpClient *http.Client,
	url Url,
	user User,
	pass Password,
) Connector

type File ¶

type File string

func (File) Content ¶

func (t File) Content() ([]byte, error)

func (File) String ¶

func (t File) String() string

type Htpasswd ¶

type Htpasswd struct {
	Connector Connector
}

func (*Htpasswd) Generate ¶

func (c *Htpasswd) Generate(ctx context.Context, key Key) ([]byte, error)

type Key ¶

type Key string

func (Key) String ¶

func (t Key) String() string

type Password ¶

type Password string

func (Password) String ¶

func (t Password) String() string

type SourceDirectory ¶

type SourceDirectory string

func (SourceDirectory) String ¶

func (s SourceDirectory) String() string

type Staging ¶

type Staging bool

func (Staging) Bool ¶

func (s Staging) Bool() bool

type TargetDirectory ¶

type TargetDirectory string

func (TargetDirectory) String ¶

func (t TargetDirectory) String() string

type TeamvaultApiUrl ¶

type TeamvaultApiUrl string

func (TeamvaultApiUrl) Key ¶

func (t TeamvaultApiUrl) Key() (Key, error)

func (TeamvaultApiUrl) String ¶

func (t TeamvaultApiUrl) String() string

type TeamvaultConfig ¶

type TeamvaultConfig struct {
	Url      Url      `json:"url"`
	User     User     `json:"user"`
	Password Password `json:"pass"`
}

func ParseTeamvaultConfig ¶

func ParseTeamvaultConfig(content []byte) (*TeamvaultConfig, error)

type TeamvaultConfigPath ¶

type TeamvaultConfigPath string

func (TeamvaultConfigPath) Exists ¶

func (t TeamvaultConfigPath) Exists() bool

Exists the backup

func (TeamvaultConfigPath) NormalizePath ¶

func (d TeamvaultConfigPath) NormalizePath() (TeamvaultConfigPath, error)

func (TeamvaultConfigPath) Parse ¶

func (t TeamvaultConfigPath) Parse() (*TeamvaultConfig, error)

func (TeamvaultConfigPath) String ¶

func (t TeamvaultConfigPath) String() string

type TeamvaultCurrentRevision ¶

type TeamvaultCurrentRevision string

func (TeamvaultCurrentRevision) String ¶

func (t TeamvaultCurrentRevision) String() string

type Url ¶

type Url string

func (Url) String ¶

func (t Url) String() string

type User ¶

type User string

func (User) String ¶

func (t User) String() string

type VariableName ¶

type VariableName string

func (VariableName) String ¶

func (v VariableName) String() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
teamvault-config-dir-generator
teamvault-config-parser
teamvault-file
teamvault-password
teamvault-url
teamvault-username
mocks Code generated by counterfeiter.	Code generated by counterfeiter.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL