constants

Documentation

Index

• Constants
• func GetShortFlag(flag string) string

Constants

const (
	Read           = "read"
	Create         = "create"
	Update         = "update"
	Rollback       = "rollback"
	Upload         = "upload"
	Edit           = "edit"
	Delete         = "delete"
	Describe       = "describe"
	Clear          = "clear"
	List           = "list"
	ChangePassword = "change-password"
	Search         = "search"
	BustCache      = "bustcache"
	AddMember      = "add-members"
	DeleteMember   = "delete-members"
	Restore        = "restore"
	Ping           = "ping"
	Rotate         = "rotate"
	Encrypt        = "encrypt"
	Decrypt        = "decrypt"
	Generate       = "generate"
	Apply          = "apply"
	Status         = "status"
	UseProfile     = "use-profile"
)

Constants for Actions

const (
	NounSecret          = "secret"
	NounSecrets         = "secrets"
	NounPolicy          = "policy"
	NounPolicies        = "policies"
	NounAuth            = "auth"
	NounToken           = "token"
	NounUser            = "user"
	NounUsers           = "users"
	NounWhoAmI          = "whoami"
	EvaluateFlag        = "eval"
	Init                = "init"
	NounClient          = "client"
	NounClients         = "clients"
	NounAwsProfile      = "awsprofile"
	NounCliConfig       = "cli-config"
	NounConfig          = "config"
	NounRole            = "role"
	NounRoles           = "roles"
	NounUsage           = "usage"
	NounGroup           = "group"
	NounGroups          = "groups"
	NounAuthProvider    = "auth-provider"
	NounLogs            = "logs"
	NounAudit           = "audit"
	NounPrincipal       = "principal"
	NounPki             = "pki"
	NounSiem            = "siem"
	NounSiems           = "siems"
	NounHome            = "home"
	NounPool            = "pool"
	NounPools           = "pools"
	NounEngine          = "engine"
	NounEngines         = "engines"
	NounBootstrapUrl    = "url"
	NounBootstrapUrlTTL = "url-ttl"
	NounClientUses      = "uses"
	NounClientTTL       = "ttl"
	NounClientDesc      = "desc"
	NounKey             = "key"
	NounEncryption      = "crypto"
	NounReport          = "report"
	NounBreakGlass      = "breakglass"
	NounBYOK            = "byok"
	NounCert            = "certificate"
	NounPrivateKey      = "privateKey"
)

Nouns

const (
	Key                     = "key"
	Value                   = "value"
	Profile                 = "profile"
	Path                    = "path"
	ID                      = "id"
	Data                    = "data"
	Username                = "auth.username"
	Tenant                  = "tenant"
	DomainName              = "domain"
	Password                = "auth.password"
	SecurePassword          = "auth.securePassword"
	CurrentPassword         = "currentPassword"
	NewPassword             = "newPassword"
	AuthProvider            = "auth.provider"
	Encoding                = "encoding"
	Beautify                = "beautify"
	Plain                   = "plain"
	Filter                  = "filter"
	Verbose                 = "verbose"
	Config                  = "config"
	Dev                     = "dev"
	AuthType                = "auth.type"
	AwsProfile              = "auth.awsprofile"
	GcpProject              = "auth.gcp.project"
	GcpToken                = "auth.gcp.token"
	GcpServiceAccount       = "auth.gcp.service"
	GcpAuthType             = "auth.gcp.type"
	AuthClientSecret        = "auth.client.secret"
	AuthClientID            = "auth.client.id"
	Callback                = "auth.callback"
	AuthCert                = "auth.certificate"
	AuthPrivateKey          = "auth.privateKey"
	ThyOne                  = "thycoticone"
	ThyOneAuthClientBaseUri = "baseUri"
	ThyOneAuthClientID      = "clientId"
	ThyOneAuthClientSecret  = "clientSecret"
	SendWelcomeEmail        = "send.welcome.email"

	Query             = "query"
	SearchLinks       = "search.links"
	SearchComparison  = "search.comparison"
	SearchType        = "search.type"
	SearchField       = "search.field"
	Limit             = "limit"
	OffSet            = "offset"
	SearchTerm        = "searchTerm"
	Cursor            = "cursor"
	RefreshToken      = "refreshtoken"
	Output            = "out"
	Overwrite         = "overwrite"
	ClientID          = "client.id"
	ClientSecret      = "client.secret"
	Version           = "version"
	VersionStart      = "version-start"
	VersionEnd        = "version-end"
	StartDate         = "startdate"
	EndDate           = "enddate"
	Force             = "force"
	Sort              = "sort"
	SortedBy          = "sorted-by"
	NewAdmins         = "new-admins"
	MinNumberOfShares = "min-number-of-shares"
	Shares            = "shares"
	SendToEngine      = "send-to-engine"
	PrimaryKey        = "primary-key"
	SecondaryKey      = "secondary-key"
)

Flags

const (
	// shared
	DataExternalID  = "external.id"
	DataDescription = "desc"
	DataAttributes  = "attributes"
	DataProvider    = "provider"

	// user
	DataUsername       = "username"
	DataSecurePassword = "securePassword"
	DataPassword       = "password"
	DataDisplayname    = "displayname"

	// permission
	DataSubject   = "subjects"
	DataEffect    = "effect"
	DataAction    = "actions"
	DataCondition = "conditions"
	DataCidr      = "cidr"
	DataResource  = "resources"

	// role and pool
	DataName     = "name"
	DataPoolName = "pool.name"

	// auth provider
	DataType      = "type"
	DataTenantID  = "azure.tenant.id"
	DataAccountID = "aws.account.id"
	DataProjectID = "gcp.project.id"
	DataCallback  = "callback"

	// group
	DataGroupName = "group.name"
	Members       = "members"
)

Data Flags

const (
	CursorHelpMessage = "Next cursor for additional results. The cursor is provided at the end of each body response (\"cursor\": \"MQ==\") (optional)"
	LimitHelpMessage  = "Maximum number of results per cursor (optional)"
	SortHelpMessage   = "Sort specifies order in ascending (asc) or descending (desc) order (optional)"
)

Common Help Messages

const (
	StoreType = "store.type"
	Type      = "type"
	Store     = "store"
)

Security

const (
	Yaml      = "yaml"
	Json      = "json"
	YamlShort = "yml"
)

Encodings

const (
	CmdRoot           = "dsv"
	CmdFilePrefix     = "@"
	DefaultProfile    = "default"
	DefaultThyOneName = "thy-one"
	DefaultCallback   = "localhost:8072"
)

Configuration-related constants.

const (
	Auto   = "auto"
	Manual = "manual"

	PrivateKey = "private-key"
	Nonce      = "nonce"
	Scheme     = "scheme"
	Metadata   = "metadata"

	ExamplePrivateKey = "MnI1dTh4L0E/RChHK0tiUGVTaFZtWXEzczZ2OXkkQiY="
	ExampleNonce      = "S1NzeHdFcHB6b1Bz"
)

const (
	ExamplePath             = "databases/mongo-db01"
	ExamplePolicyPath       = "secrets/databases/mongo-db01"
	ExampleRoleName         = "gcp-svc-1"
	ExampleDataJSON         = `'{"Key":"Value","Key2":"Value2"}'`
	ExampleDataPath         = "@/tmp/data.json"
	ExampleConfigPath       = "@/tmp/config.yml"
	ExampleUser             = "kadmin"
	ExampleSIEM             = "LogsInc"
	ExamplePassword         = "********"
	ExampleAuthType         = "clientcred"
	ExampleUserSearch       = "adm"
	ExamplePolicySearch     = "secrets/databases"
	ExampleSiemSearch       = "my_siem"
	ExampleAuthClientID     = "8sdh2el7-ai29S05a5"
	ExampleAuthClientSecret = "pLaKNWL99IK2kL-xMI"
	ExampleDomain           = "secretsvaultcloud.com"
	ExampleClientID         = "8sdh2el7-ai29S05a5"
	ExampleGroup            = "administrators"
	ExampleGroupCreate      = `{"groupName": "administrators"}`
	ExampleGroupAddMembers  = `{"members": ["member1","member2"]}`
)

Constants used for documentation.

const (
	Register     = "register"
	Sign         = "sign"
	Leaf         = "leaf"
	GenerateRoot = "generate-root"
	SSHCert      = "ssh-cert"
)

const (
	RootCAPath      = "rootcapath"
	LeafCAPath      = "leafcapath"
	CertPath        = "certpath"
	PrivKeyPath     = "privkeypath"
	CSRPath         = "csrpath"
	Domains         = "domains"
	Principals      = "principals"
	SubjectAltNames = "subjectaltnames"
	TTL             = "ttl"
	MaxTTL          = "maxttl"
	PkiStorePath    = "store-path"
	CommonName      = "common-name"
	Organization    = "organization"
	Country         = "country"
	State           = "state"
	Locality        = "locality"
	EmailAddress    = "email"
	Description     = "description"
	CRL             = "crl"
)

const (
	Root  = "root"
	Chain = "chain"
)

const (
	PrefixEntity         = "secrets/"
	PrefixEntityInternal = "secrets:"
	DomainKey            = "domain"
	Domain               = "secretsvaultcloud.com"
	DomainEU             = "secretsvaultcloud.eu"
	DomainAU             = "secretsvaultcloud.com.au"
	DomainCA             = "secretsvaultcloud.ca"
	HTTPSchemeKey        = "http"
	HTTPSchemeSecure     = "https"
	SuffixDescription    = "::description"
	SuffixListPaths      = "::listpaths"
	SearchKey            = "searchTerm"
	PortKey              = "port"
	APIVersionKey        = "api.version"
	APIVersion           = "v1"
	PasswordKey          = "password"
)

Constants for Requests

const (
	StoreRoot             = "thy"
	TokenRoot             = "token"
	EncryptionKey         = "encryptionkey"
	CliConfigRoot         = "config"
	SecretRoot            = "secret"
	SecretDescriptionRoot = "description"
)

store constants

const (
	Cache         = "cache"
	CacheStrategy = "cache.strategy"
	CacheAge      = "cache.age"
	Age           = "age"
	Strategy      = "strategy"
)

cache constants

const (
	CacheStrategyNever                      = "server"
	CacheStrategyServerThenCache            = "server.cache"
	CacheStrategyCacheThenServer            = "cache.server"
	CacheStrategyCacheThenServerThenExpired = "cache.server.expired"
)

Supported cache strategies.

const (
	AuthSkipCache = "auth.skip.cache"
)

Control authentication cache usage.

const (
	Editor = "editor"
)

Cli-Config only

const (
	ProductName = "DevOps Secrets Vault"
)

const (
	StorePath = "store.path"
)

Hidden Flags

Functions

func GetShortFlag

func GetShortFlag(flag string) string