db

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 14, 2025 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	UsernamePassword string = "username_password"
	IAMUser          string = "iam_user"
	CyberArkPAM      string = "cyberark_pam"
	AtlasAccessKeys  string = "atlas_access_keys"
)

Possible secret types

View Source 
const (
	Managed string = "managed"
	PAM     string = "pam"
)

Possible store types

Variables

View Source 
var SecretTypeToStoreDict = map[string]string{
	UsernamePassword: Managed,
	CyberArkPAM:      PAM,
	IAMUser:          Managed,
	AtlasAccessKeys:  Managed,
}

SecretTypeToStoreDict maps secret types to store types.

Functions

This section is empty.

Types

type ArkSIADBAddSecret 

type ArkSIADBAddSecret struct {
	SecretName  string            `json:"secret_name" mapstructure:"secret_name" flag:"secret-name" validate:"required" desc:"Name of the secret"`
	Description string            `json:"description,omitempty" mapstructure:"description" flag:"description" desc:"Description about the secret"`
	Purpose     string            `json:"purpose,omitempty" mapstructure:"purpose" flag:"purpose" desc:"Purpose of the secret"`
	SecretType  string            `` /* 238-byte string literal not displayed */
	StoreType   string            `` /* 188-byte string literal not displayed */
	Tags        map[string]string `json:"tags,omitempty" mapstructure:"tags" flag:"tags" desc:"Tags of the secret"`

	// Username Password Secret Type
	Username string `json:"username,omitempty" mapstructure:"username" flag:"username" desc:"Name or id of the user for username_password type"`
	Password string `json:"password,omitempty" mapstructure:"password" flag:"password" desc:"Password of the user for username_password type"`

	// PAM Account Secret Type
	PAMSafe        string `json:"pam_safe,omitempty" mapstructure:"pam_safe" flag:"pam-safe" desc:"Safe of the account for pam_account type"`
	PAMAccountName string `` /* 130-byte string literal not displayed */

	// IAM Secret Type
	IAMAccount         string `json:"iam_account,omitempty" mapstructure:"iam_account" flag:"iam-account" desc:"Account number of the iam user"`
	IAMUsername        string `` /* 128-byte string literal not displayed */
	IAMAccessKeyID     string `json:"iam_access_key_id,omitempty" mapstructure:"iam_access_key_id" flag:"iam-access-key-id" desc:"Access key id of the user"`
	IAMSecretAccessKey string `` /* 141-byte string literal not displayed */

	// Atlas Secret Type
	AtlasPublicKey  string `` /* 135-byte string literal not displayed */
	AtlasPrivateKey string `` /* 139-byte string literal not displayed */
}

ArkSIADBAddSecret is the struct for adding a secret to the Ark SIA DB.

type ArkSIADBDeleteSecret 

type ArkSIADBDeleteSecret struct {
	SecretID   string `json:"secret_id,omitempty" mapstructure:"secret_id" flag:"secret-id" desc:"ID of the secret to delete"`
	SecretName string `json:"secret_name,omitempty" mapstructure:"secret_name" flag:"secret-name" desc:"Name of the secret to delete"`
}

ArkSIADBDeleteSecret is the struct for deleting a secret from the Ark SIA DB.

type ArkSIADBDisableSecret 

type ArkSIADBDisableSecret struct {
	SecretID   string `json:"secret_id,omitempty" mapstructure:"secret_id" flag:"secret-id" desc:"ID of the secret to disable"`
	SecretName string `json:"secret_name,omitempty" mapstructure:"secret_name" flag:"secret-name" desc:"Name of the secret to disable"`
}

ArkSIADBDisableSecret is the struct for disabling a secret in the Ark SIA DB.

type ArkSIADBEnableSecret 

type ArkSIADBEnableSecret struct {
	SecretID   string `json:"secret_id,omitempty" mapstructure:"secret_id" flag:"secret-id" desc:"ID of the secret to enable"`
	SecretName string `json:"secret_name,omitempty" mapstructure:"secret_name" flag:"secret-name" desc:"Name of the secret to enable"`
}

ArkSIADBEnableSecret is the struct for enabling a secret in the Ark SIA DB.

type ArkSIADBGetSecret 

type ArkSIADBGetSecret struct {
	SecretID   string `json:"secret_id,omitempty" mapstructure:"secret_id" flag:"secret-id" desc:"ID of the secret to get"`
	SecretName string `json:"secret_name,omitempty" mapstructure:"secret_name" flag:"secret-name" desc:"Name of the secret to get"`
}

ArkSIADBGetSecret is the struct for retrieving a secret from the Ark SIA DB.

type ArkSIADBSecretMetadata 

type ArkSIADBSecretMetadata struct {
	SecretID          string                  `json:"secret_id" mapstructure:"secret_id" desc:"Secret identifier"`
	SecretName        string                  `json:"secret_name" mapstructure:"secret_name" desc:"Name of the secret"`
	Description       string                  `json:"description,omitempty" mapstructure:"description" desc:"Description about the secret"`
	Purpose           string                  `json:"purpose,omitempty" mapstructure:"purpose" desc:"Purpose of the secret"`
	SecretType        string                  `` /* 139-byte string literal not displayed */
	SecretStore       ArkSIADBStoreDescriptor `json:"secret_store" mapstructure:"secret_store" desc:"Secret store details of the secret"`
	SecretLink        map[string]interface{}  `json:"secret_link,omitempty" mapstructure:"secret_link" desc:"Link details of the secret"`
	SecretExposedData map[string]interface{}  `` /* 138-byte string literal not displayed */
	Tags              map[string]string       `json:"tags,omitempty" mapstructure:"tags" desc:"Tags of the secret"`
	CreatedBy         string                  `json:"created_by" mapstructure:"created_by" desc:"Who created the secret"`
	CreationTime      string                  `json:"creation_time" mapstructure:"creation_time" desc:"Creation time of the secret"`
	LastUpdatedBy     string                  `json:"last_updated_by" mapstructure:"last_updated_by" desc:"Who last updated the secret"`
	LastUpdateTime    string                  `json:"last_update_time" mapstructure:"last_update_time" desc:"When was the secret last updated"`
	IsActive          bool                    `json:"is_active" mapstructure:"is_active" desc:"Whether the secret is active or not"`
}

ArkSIADBSecretMetadata represents the metadata of a secret in the Ark SIA DB.

type ArkSIADBSecretMetadataList 

type ArkSIADBSecretMetadataList struct {
	TotalCount int                      `json:"total_count" mapstructure:"total_count" desc:"Total secrets found"`
	Secrets    []ArkSIADBSecretMetadata `json:"secrets" mapstructure:"secrets" desc:"Actual secrets metadata"`
}

ArkSIADBSecretMetadataList represents a list of secret metadata in the Ark SIA DB.

type ArkSIADBSecretsFilter 

type ArkSIADBSecretsFilter struct {
	SecretName string            `json:"secret_name,omitempty" mapstructure:"secret_name" flag:"secret-name" desc:"Filter by secret name"`
	SecretType string            `` /* 164-byte string literal not displayed */
	StoreType  string            `json:"store_type,omitempty" mapstructure:"store_type" flag:"store-type" desc:"Filter by store type"`
	IsActive   bool              `json:"is_active,omitempty" mapstructure:"is_active" flag:"is-active" desc:"Filter by if secret is active"`
	Tags       map[string]string `json:"tags,omitempty" mapstructure:"tags" flag:"tags" desc:"Filter by tags"`
}

ArkSIADBSecretsFilter represents the filters for querying secrets in the Ark SIA DB.

type ArkSIADBSecretsStats 

type ArkSIADBSecretsStats struct {
	SecretsCount             int            `json:"secrets_count" mapstructure:"secrets_count" desc:"Overall secrets count"`
	ActiveSecretsCount       int            `json:"active_secrets_count" mapstructure:"active_secrets_count" desc:"Overall active secrets count"`
	InactiveSecretsCount     int            `json:"inactive_secrets_count" mapstructure:"inactive_secrets_count" desc:"Overall inactive secrets count"`
	SecretsCountBySecretType map[string]int `json:"secrets_count_by_secret_type" mapstructure:"secrets_count_by_secret_type" desc:"Secrets count by secret type"`
	SecretsCountByStoreType  map[string]int `json:"secrets_count_by_store_type" mapstructure:"secrets_count_by_store_type" desc:"Secrets count by store type"`
}

ArkSIADBSecretsStats represents the statistics of secrets in the Ark SIA DB.

type ArkSIADBStoreDescriptor 

type ArkSIADBStoreDescriptor struct {
	StoreID   string `json:"store_id,omitempty" mapstructure:"store_id" desc:"ID of the store"`
	StoreType string `json:"store_type,omitempty" mapstructure:"store_type" desc:"Type of the store"`
}

ArkSIADBStoreDescriptor represents the descriptor of a store in the Ark SIA DB.

type ArkSIADBUpdateSecret 

type ArkSIADBUpdateSecret struct {
	SecretID      string            `json:"secret_id,omitempty" mapstructure:"secret_id" flag:"secret-id" desc:"Secret id to update"`
	SecretName    string            `json:"secret_name,omitempty" mapstructure:"secret_name" flag:"secret-name" desc:"Name of the secret to update"`
	NewSecretName string            `json:"new_secret_name,omitempty" mapstructure:"new_secret_name" flag:"new-secret-name" desc:"New secret name to update to"`
	Description   string            `json:"description,omitempty" mapstructure:"description" flag:"description" desc:"Description about the secret to update"`
	Purpose       string            `json:"purpose,omitempty" mapstructure:"purpose" flag:"purpose" desc:"Purpose of the secret to update"`
	Tags          map[string]string `json:"tags,omitempty" mapstructure:"tags" flag:"tags" desc:"Tags of the secret to change to"`

	// Username Password Secret Type
	Username string `json:"username,omitempty" mapstructure:"username" flag:"username" desc:"Name or id of the user for username_password type"`
	Password string `json:"password,omitempty" mapstructure:"password" flag:"password" desc:"Password of the user for username_password type"`

	// PAM Account Secret Type
	PAMSafe        string `json:"pam_safe,omitempty" mapstructure:"pam_safe" flag:"pam-safe" desc:"Safe of the account for pam_account type"`
	PAMAccountName string `` /* 130-byte string literal not displayed */

	// IAM Secret Type
	IAMAccount         string `json:"iam_account,omitempty" mapstructure:"iam_account" flag:"iam-account" desc:"Account number of the iam user"`
	IAMUsername        string `` /* 128-byte string literal not displayed */
	IAMAccessKeyID     string `json:"iam_access_key_id,omitempty" mapstructure:"iam_access_key_id" flag:"iam-access-key-id" desc:"Access key id of the user"`
	IAMSecretAccessKey string `` /* 141-byte string literal not displayed */

	// Atlas Secret Type
	AtlasPublicKey  string `` /* 135-byte string literal not displayed */
	AtlasPrivateKey string `` /* 139-byte string literal not displayed */
}

ArkSIADBUpdateSecret is the struct for updating a secret in the Ark SIA DB.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.