teamvault

package module

v4.5.0 Latest Latest Go to latest Published: Apr 30, 2025 License: BSD-2-Clause Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
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/v4/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/v4/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/v4/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/v4/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/v4/cmd/teamvault-url

Run:

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

Documentation ¶

Index ¶

type ApiUrl
- func (a ApiUrl) Key() (Key, error)
- func (a ApiUrl) String() string
type Config
- func ParseTeamvaultConfig(content []byte) (*Config, error)
type ConfigGenerator
- func NewConfigGenerator(configParser ConfigParser) ConfigGenerator
type ConfigParser
- func NewConfigParser(teamvaultConnector Connector) ConfigParser
type Connector
- func NewCacheConnector(connector Connector) Connector
- func NewDiskFallbackConnector(connector Connector) Connector
- func NewDummyConnector() Connector
- func NewRemoteConnector(httpClient *http.Client, url Url, user User, pass Password) Connector
type CurrentRevision
- func (t CurrentRevision) String() string
type File
- func (t File) Content() ([]byte, error)
- func (t File) String() string
type HtpasswdGenerator
- func NewHtpasswdGenerator(connector Connector) HtpasswdGenerator
type Key
- func (k 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 TeamvaultConfigPath
- func (t TeamvaultConfigPath) Exists() bool
- func (t TeamvaultConfigPath) NormalizePath() (TeamvaultConfigPath, error)
- func (t TeamvaultConfigPath) Parse() (*Config, error)
- func (t TeamvaultConfigPath) String() string
type Url
- func (u Url) String() string
type User
- func (u User) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ApiUrl ¶

type ApiUrl string

func (ApiUrl) Key ¶

func (a ApiUrl) Key() (Key, error)

func (ApiUrl) String ¶

func (a ApiUrl) String() string

type Config ¶

type Config struct {
	Url          Url      `json:"url"`
	User         User     `json:"user"`
	Password     Password `json:"pass"`
	CacheEnabled bool     `json:"cacheEnabled,omitempty"`
}

func ParseTeamvaultConfig ¶

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

type ConfigGenerator ¶

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

func NewConfigGenerator ¶

func NewConfigGenerator(configParser ConfigParser) ConfigGenerator

type ConfigParser ¶

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

func NewConfigParser ¶

func NewConfigParser(
	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 NewCacheConnector ¶

func NewCacheConnector(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 CurrentRevision ¶

type CurrentRevision string

func (CurrentRevision) String ¶

func (t CurrentRevision) String() string

type File ¶

type File string

func (File) Content ¶

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

func (File) String ¶

func (t File) String() string

type HtpasswdGenerator ¶

type HtpasswdGenerator interface {
	Generate(ctx context.Context, key Key) ([]byte, error)
}

func NewHtpasswdGenerator ¶

func NewHtpasswdGenerator(connector Connector) HtpasswdGenerator

type Key ¶

type Key string

func (Key) String ¶

func (k 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 TeamvaultConfigPath ¶

type TeamvaultConfigPath string

func (TeamvaultConfigPath) Exists ¶

func (t TeamvaultConfigPath) Exists() bool

Exists the backup

func (TeamvaultConfigPath) NormalizePath ¶

func (t TeamvaultConfigPath) NormalizePath() (TeamvaultConfigPath, error)

func (TeamvaultConfigPath) Parse ¶

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

func (TeamvaultConfigPath) String ¶

func (t TeamvaultConfigPath) String() string

type Url ¶

type Url string

func (Url) String ¶

func (u Url) String() string

type User ¶

type User string

func (User) String ¶

func (u User) String() string

Source Files ¶

View all Source files

Directories ¶

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

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