api

package
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: Aug 29, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package api is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppRoleAuthenticator

type AppRoleAuthenticator struct {
	// contains filtered or unexported fields
}

func NewAppRoleAuthenticator

func NewAppRoleAuthenticator(
	client *vaultapi.Client,
	cfg AppRoleConfig,
) (*AppRoleAuthenticator, error)

func (*AppRoleAuthenticator) Authenticate

func (a *AppRoleAuthenticator) Authenticate(ctx context.Context) error

type AppRoleConfig

type AppRoleConfig struct {
	// RoleID is Vault AppRole role_id bootstrap credential.
	RoleID string `env:"ROLE_ID,file" json:"-"`
	// SecretID is Vault AppRole secret_id bootstrap credential.
	SecretID string `env:"SECRET_ID,file" json:"-"`
}

type AuthConfig

type AuthConfig struct {
	// Token is a path to a file containing a Vault runtime token.
	Token string `env:"TOKEN,file" json:"-"`

	AppRole AppRoleConfig `envPrefix:"APPROLE_"`
}

type AuthMethod

type AuthMethod string
var (
	AuthMethodStatic  AuthMethod = "static"
	AuthMethodAppRole AuthMethod = "approle"
)

func (AuthMethod) Title

func (m AuthMethod) Title() string

func (AuthMethod) Valid

func (m AuthMethod) Valid() bool

type AuthenticatedClient

type AuthenticatedClient struct {
	// contains filtered or unexported fields
}

func (*AuthenticatedClient) AppRoleAuthEnabled

func (d *AuthenticatedClient) AppRoleAuthEnabled(ctx context.Context) (bool, error)

func (*AuthenticatedClient) CreateACLPolicy

func (d *AuthenticatedClient) CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error

func (*AuthenticatedClient) CreateAppRole

func (d *AuthenticatedClient) CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error

func (*AuthenticatedClient) CreateAppRoleSecretID

func (d *AuthenticatedClient) CreateAppRoleSecretID(ctx context.Context, name string) (string, error)

func (*AuthenticatedClient) CreateSecret

func (d *AuthenticatedClient) CreateSecret(
	ctx context.Context,
	path string,
	data map[string]interface{},
) (*Secret, error)

func (*AuthenticatedClient) CreateToken

func (d *AuthenticatedClient) CreateToken(ctx context.Context, policies []string) (string, error)

func (*AuthenticatedClient) DeleteSecret

func (d *AuthenticatedClient) DeleteSecret(ctx context.Context, path string) error

func (*AuthenticatedClient) EnableAppRoleAuth

func (d *AuthenticatedClient) EnableAppRoleAuth(ctx context.Context) error

func (*AuthenticatedClient) GetSecret

func (d *AuthenticatedClient) GetSecret(ctx context.Context, path, key string) (*Secret, error)

func (*AuthenticatedClient) ListKeys

func (d *AuthenticatedClient) ListKeys(ctx context.Context, path string) ([]string, error)

func (*AuthenticatedClient) ReadAppRoleRoleID

func (d *AuthenticatedClient) ReadAppRoleRoleID(ctx context.Context, name string) (string, error)

type Authenticator

type Authenticator interface {
	Authenticate(ctx context.Context) error
}

type Client

type Client interface {
	ListKeys(ctx context.Context, path string) ([]string, error)
	GetSecret(ctx context.Context, path, key string) (*Secret, error)
	CreateSecret(ctx context.Context, path string, data map[string]interface{}) (*Secret, error)
	DeleteSecret(ctx context.Context, path string) error

	CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error

	CreateToken(ctx context.Context, policies []string) (string, error)

	AppRoleAuthEnabled(ctx context.Context) (bool, error)
	EnableAppRoleAuth(ctx context.Context) error
	CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error
	ReadAppRoleRoleID(ctx context.Context, name string) (string, error)
	CreateAppRoleSecretID(ctx context.Context, name string) (string, error)
}

func NewHttpClient

func NewHttpClient(
	ctx context.Context,
	mountPath string,
	addr url.URL,
	authConfig AuthConfig,
) (Client, error)

type CreateACLPolicyRequest

type CreateACLPolicyRequest struct {
	Name  string
	Rules string
}

type CreateAppRoleRequest

type CreateAppRoleRequest struct {
	Name            string
	TokenPolicies   []string
	TokenTTL        string
	TokenMaxTTL     string
	SecretIDTTL     string
	SecretIDNumUses int
}

type HttpClient

type HttpClient struct {
	// contains filtered or unexported fields
}

func (*HttpClient) AppRoleAuthEnabled

func (c *HttpClient) AppRoleAuthEnabled(ctx context.Context) (bool, error)

func (*HttpClient) CreateACLPolicy

func (c *HttpClient) CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error

func (*HttpClient) CreateAppRole

func (c *HttpClient) CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error

func (*HttpClient) CreateAppRoleSecretID

func (c *HttpClient) CreateAppRoleSecretID(ctx context.Context, name string) (string, error)

func (*HttpClient) CreateSecret

func (c *HttpClient) CreateSecret(ctx context.Context, path string, data map[string]interface{}) (*Secret, error)

func (*HttpClient) CreateToken

func (c *HttpClient) CreateToken(ctx context.Context, policies []string) (string, error)

func (*HttpClient) DeleteSecret

func (c *HttpClient) DeleteSecret(ctx context.Context, path string) error

func (*HttpClient) EnableAppRoleAuth

func (c *HttpClient) EnableAppRoleAuth(ctx context.Context) error

func (*HttpClient) GetSecret

func (c *HttpClient) GetSecret(ctx context.Context, path, key string) (*Secret, error)

func (*HttpClient) ListKeys

func (c *HttpClient) ListKeys(ctx context.Context, path string) ([]string, error)

func (*HttpClient) ReadAppRoleRoleID

func (c *HttpClient) ReadAppRoleRoleID(ctx context.Context, name string) (string, error)

type MockAuthenticator

type MockAuthenticator struct {
	// contains filtered or unexported fields
}

MockAuthenticator is a mock of Authenticator interface.

func NewMockAuthenticator

func NewMockAuthenticator(ctrl *gomock.Controller) *MockAuthenticator

NewMockAuthenticator creates a new mock instance.

func (*MockAuthenticator) Authenticate

func (m *MockAuthenticator) Authenticate(ctx context.Context) error

Authenticate mocks base method.

func (*MockAuthenticator) EXPECT

EXPECT returns an object that allows the caller to indicate expected use.

type MockAuthenticatorMockRecorder

type MockAuthenticatorMockRecorder struct {
	// contains filtered or unexported fields
}

MockAuthenticatorMockRecorder is the mock recorder for MockAuthenticator.

func (*MockAuthenticatorMockRecorder) Authenticate

func (mr *MockAuthenticatorMockRecorder) Authenticate(ctx any) *gomock.Call

Authenticate indicates an expected call of Authenticate.

type MockClient

type MockClient struct {
	// contains filtered or unexported fields
}

MockClient is a mock of Client interface.

func NewMockClient

func NewMockClient(ctrl *gomock.Controller) *MockClient

NewMockClient creates a new mock instance.

func (*MockClient) AppRoleAuthEnabled

func (m *MockClient) AppRoleAuthEnabled(ctx context.Context) (bool, error)

AppRoleAuthEnabled mocks base method.

func (*MockClient) CreateACLPolicy

func (m *MockClient) CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error

CreateACLPolicy mocks base method.

func (*MockClient) CreateAppRole

func (m *MockClient) CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error

CreateAppRole mocks base method.

func (*MockClient) CreateAppRoleSecretID

func (m *MockClient) CreateAppRoleSecretID(ctx context.Context, name string) (string, error)

CreateAppRoleSecretID mocks base method.

func (*MockClient) CreateSecret

func (m *MockClient) CreateSecret(ctx context.Context, path string, data map[string]any) (*Secret, error)

CreateSecret mocks base method.

func (*MockClient) CreateToken

func (m *MockClient) CreateToken(ctx context.Context, policies []string) (string, error)

CreateToken mocks base method.

func (*MockClient) DeleteSecret

func (m *MockClient) DeleteSecret(ctx context.Context, path string) error

DeleteSecret mocks base method.

func (*MockClient) EXPECT

func (m *MockClient) EXPECT() *MockClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClient) EnableAppRoleAuth

func (m *MockClient) EnableAppRoleAuth(ctx context.Context) error

EnableAppRoleAuth mocks base method.

func (*MockClient) GetSecret

func (m *MockClient) GetSecret(ctx context.Context, path, key string) (*Secret, error)

GetSecret mocks base method.

func (*MockClient) ListKeys

func (m *MockClient) ListKeys(ctx context.Context, path string) ([]string, error)

ListKeys mocks base method.

func (*MockClient) ReadAppRoleRoleID

func (m *MockClient) ReadAppRoleRoleID(ctx context.Context, name string) (string, error)

ReadAppRoleRoleID mocks base method.

type MockClientMockRecorder

type MockClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockClientMockRecorder is the mock recorder for MockClient.

func (*MockClientMockRecorder) AppRoleAuthEnabled

func (mr *MockClientMockRecorder) AppRoleAuthEnabled(ctx any) *gomock.Call

AppRoleAuthEnabled indicates an expected call of AppRoleAuthEnabled.

func (*MockClientMockRecorder) CreateACLPolicy

func (mr *MockClientMockRecorder) CreateACLPolicy(ctx, req any) *gomock.Call

CreateACLPolicy indicates an expected call of CreateACLPolicy.

func (*MockClientMockRecorder) CreateAppRole

func (mr *MockClientMockRecorder) CreateAppRole(ctx, req any) *gomock.Call

CreateAppRole indicates an expected call of CreateAppRole.

func (*MockClientMockRecorder) CreateAppRoleSecretID

func (mr *MockClientMockRecorder) CreateAppRoleSecretID(ctx, name any) *gomock.Call

CreateAppRoleSecretID indicates an expected call of CreateAppRoleSecretID.

func (*MockClientMockRecorder) CreateSecret

func (mr *MockClientMockRecorder) CreateSecret(ctx, path, data any) *gomock.Call

CreateSecret indicates an expected call of CreateSecret.

func (*MockClientMockRecorder) CreateToken

func (mr *MockClientMockRecorder) CreateToken(ctx, policies any) *gomock.Call

CreateToken indicates an expected call of CreateToken.

func (*MockClientMockRecorder) DeleteSecret

func (mr *MockClientMockRecorder) DeleteSecret(ctx, path any) *gomock.Call

DeleteSecret indicates an expected call of DeleteSecret.

func (*MockClientMockRecorder) EnableAppRoleAuth

func (mr *MockClientMockRecorder) EnableAppRoleAuth(ctx any) *gomock.Call

EnableAppRoleAuth indicates an expected call of EnableAppRoleAuth.

func (*MockClientMockRecorder) GetSecret

func (mr *MockClientMockRecorder) GetSecret(ctx, path, key any) *gomock.Call

GetSecret indicates an expected call of GetSecret.

func (*MockClientMockRecorder) ListKeys

func (mr *MockClientMockRecorder) ListKeys(ctx, path any) *gomock.Call

ListKeys indicates an expected call of ListKeys.

func (*MockClientMockRecorder) ReadAppRoleRoleID

func (mr *MockClientMockRecorder) ReadAppRoleRoleID(ctx, name any) *gomock.Call

ReadAppRoleRoleID indicates an expected call of ReadAppRoleRoleID.

type Secret

type Secret struct {
	VersionID string
	Keys      []string
	Payload   []byte
}

Jump to

Keyboard shortcuts

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