Documentation
¶
Overview ¶
Package api is a generated GoMock package.
Index ¶
- Variables
- type AppRoleAuthenticator
- type AppRoleConfig
- type AuthConfig
- type AuthMethod
- type AuthenticatedClient
- func (d *AuthenticatedClient) AppRoleAuthEnabled(ctx context.Context) (bool, error)
- func (d *AuthenticatedClient) CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error
- func (d *AuthenticatedClient) CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error
- func (d *AuthenticatedClient) CreateAppRoleSecretID(ctx context.Context, name string) (string, error)
- func (d *AuthenticatedClient) CreateSecret(ctx context.Context, path string, data map[string]interface{}) (*Secret, error)
- func (d *AuthenticatedClient) CreateSecretKey(ctx context.Context, path, key string, value []byte) error
- func (d *AuthenticatedClient) CreateToken(ctx context.Context, policies []string) (string, error)
- func (d *AuthenticatedClient) DeleteSecret(ctx context.Context, path string) error
- func (d *AuthenticatedClient) EnableAppRoleAuth(ctx context.Context) error
- func (d *AuthenticatedClient) GetSecret(ctx context.Context, path, key string) (*Secret, error)
- func (d *AuthenticatedClient) ListKeys(ctx context.Context, path string) ([]string, error)
- func (d *AuthenticatedClient) ReadAppRoleRoleID(ctx context.Context, name string) (string, error)
- type Authenticator
- type Client
- type CreateACLPolicyRequest
- type CreateAppRoleRequest
- type HttpClient
- func (c *HttpClient) AppRoleAuthEnabled(ctx context.Context) (bool, error)
- func (c *HttpClient) CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error
- func (c *HttpClient) CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error
- func (c *HttpClient) CreateAppRoleSecretID(ctx context.Context, name string) (string, error)
- func (c *HttpClient) CreateSecret(ctx context.Context, path string, data map[string]interface{}) (*Secret, error)
- func (c *HttpClient) CreateSecretKey(ctx context.Context, path, key string, value []byte) error
- func (c *HttpClient) CreateToken(ctx context.Context, policies []string) (string, error)
- func (c *HttpClient) DeleteSecret(ctx context.Context, path string) error
- func (c *HttpClient) EnableAppRoleAuth(ctx context.Context) error
- func (c *HttpClient) GetSecret(ctx context.Context, path, key string) (*Secret, error)
- func (c *HttpClient) ListKeys(ctx context.Context, path string) ([]string, error)
- func (c *HttpClient) ReadAppRoleRoleID(ctx context.Context, name string) (string, error)
- type MockAuthenticator
- type MockAuthenticatorMockRecorder
- type MockClient
- func (m *MockClient) AppRoleAuthEnabled(ctx context.Context) (bool, error)
- func (m *MockClient) CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error
- func (m *MockClient) CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error
- func (m *MockClient) CreateAppRoleSecretID(ctx context.Context, name string) (string, error)
- func (m *MockClient) CreateSecret(ctx context.Context, path string, data map[string]interface{}) (*Secret, error)
- func (m *MockClient) CreateSecretKey(ctx context.Context, path, key string, value []byte) error
- func (m *MockClient) CreateToken(ctx context.Context, policies []string) (string, error)
- func (m *MockClient) DeleteSecret(ctx context.Context, path string) error
- func (m *MockClient) EXPECT() *MockClientMockRecorder
- func (m *MockClient) EnableAppRoleAuth(ctx context.Context) error
- func (m *MockClient) GetSecret(ctx context.Context, path, key string) (*Secret, error)
- func (m *MockClient) ListKeys(ctx context.Context, path string) ([]string, error)
- func (m *MockClient) ReadAppRoleRoleID(ctx context.Context, name string) (string, error)
- type MockClientMockRecorder
- func (mr *MockClientMockRecorder) AppRoleAuthEnabled(ctx interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) CreateACLPolicy(ctx, req interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) CreateAppRole(ctx, req interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) CreateAppRoleSecretID(ctx, name interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) CreateSecret(ctx, path, data interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) CreateSecretKey(ctx, path, key, value interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) CreateToken(ctx, policies interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) DeleteSecret(ctx, path interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) EnableAppRoleAuth(ctx interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) GetSecret(ctx, path, key interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) ListKeys(ctx, path interface{}) *gomock.Call
- func (mr *MockClientMockRecorder) ReadAppRoleRoleID(ctx, name interface{}) *gomock.Call
- type Secret
Constants ¶
This section is empty.
Variables ¶
var ( // ErrSecretKeyExists indicates that a KV document already contains the requested key. ErrSecretKeyExists = errors.New("secret key already exists") // ErrCASConflict indicates that repeated concurrent KV updates prevented a safe write. ErrCASConflict = errors.New("vault KV check-and-set conflict") )
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 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 (*AuthenticatedClient) CreateSecret ¶
func (*AuthenticatedClient) CreateSecretKey ¶ added in v0.5.2
func (*AuthenticatedClient) CreateToken ¶
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) ReadAppRoleRoleID ¶
type Authenticator ¶
type Client ¶
type Client interface {
// ListKeys lists KV document and folder names below path.
ListKeys(ctx context.Context, path string) ([]string, error)
// GetSecret reads KV document metadata or one key payload.
GetSecret(ctx context.Context, path, key string) (*Secret, error)
// CreateSecret writes a complete KV document for CLI and setup operations.
CreateSecret(ctx context.Context, path string, data map[string]interface{}) (*Secret, error)
// CreateSecretKey creates one key without replacing existing document keys.
CreateSecretKey(ctx context.Context, path, key string, value []byte) error
// DeleteSecret deletes KV document metadata.
DeleteSecret(ctx context.Context, path string) error
// CreateACLPolicy creates or replaces a Vault ACL policy.
CreateACLPolicy(ctx context.Context, req CreateACLPolicyRequest) error
// CreateToken creates a Vault token with the provided policies.
CreateToken(ctx context.Context, policies []string) (string, error)
// AppRoleAuthEnabled reports whether AppRole authentication is enabled.
AppRoleAuthEnabled(ctx context.Context) (bool, error)
// EnableAppRoleAuth enables AppRole authentication.
EnableAppRoleAuth(ctx context.Context) error
// CreateAppRole creates or replaces an AppRole.
CreateAppRole(ctx context.Context, req CreateAppRoleRequest) error
// ReadAppRoleRoleID reads an AppRole role ID.
ReadAppRoleRoleID(ctx context.Context, name string) (string, error)
// CreateAppRoleSecretID creates an AppRole secret ID.
CreateAppRoleSecretID(ctx context.Context, name string) (string, error)
}
func NewHttpClient ¶
type CreateACLPolicyRequest ¶
type CreateAppRoleRequest ¶
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 (*HttpClient) CreateSecret ¶
func (*HttpClient) CreateSecretKey ¶ added in v0.5.2
CreateSecretKey adds one key to a KV document using check-and-set writes.
func (*HttpClient) CreateToken ¶
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) ReadAppRoleRoleID ¶
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 ¶
func (m *MockAuthenticator) EXPECT() *MockAuthenticatorMockRecorder
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 interface{}) *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 ¶
CreateAppRoleSecretID mocks base method.
func (*MockClient) CreateSecret ¶
func (m *MockClient) CreateSecret(ctx context.Context, path string, data map[string]interface{}) (*Secret, error)
CreateSecret mocks base method.
func (*MockClient) CreateSecretKey ¶ added in v0.5.2
CreateSecretKey mocks base method.
func (*MockClient) CreateToken ¶
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) ReadAppRoleRoleID ¶
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 interface{}) *gomock.Call
AppRoleAuthEnabled indicates an expected call of AppRoleAuthEnabled.
func (*MockClientMockRecorder) CreateACLPolicy ¶
func (mr *MockClientMockRecorder) CreateACLPolicy(ctx, req interface{}) *gomock.Call
CreateACLPolicy indicates an expected call of CreateACLPolicy.
func (*MockClientMockRecorder) CreateAppRole ¶
func (mr *MockClientMockRecorder) CreateAppRole(ctx, req interface{}) *gomock.Call
CreateAppRole indicates an expected call of CreateAppRole.
func (*MockClientMockRecorder) CreateAppRoleSecretID ¶
func (mr *MockClientMockRecorder) CreateAppRoleSecretID(ctx, name interface{}) *gomock.Call
CreateAppRoleSecretID indicates an expected call of CreateAppRoleSecretID.
func (*MockClientMockRecorder) CreateSecret ¶
func (mr *MockClientMockRecorder) CreateSecret(ctx, path, data interface{}) *gomock.Call
CreateSecret indicates an expected call of CreateSecret.
func (*MockClientMockRecorder) CreateSecretKey ¶ added in v0.5.2
func (mr *MockClientMockRecorder) CreateSecretKey(ctx, path, key, value interface{}) *gomock.Call
CreateSecretKey indicates an expected call of CreateSecretKey.
func (*MockClientMockRecorder) CreateToken ¶
func (mr *MockClientMockRecorder) CreateToken(ctx, policies interface{}) *gomock.Call
CreateToken indicates an expected call of CreateToken.
func (*MockClientMockRecorder) DeleteSecret ¶
func (mr *MockClientMockRecorder) DeleteSecret(ctx, path interface{}) *gomock.Call
DeleteSecret indicates an expected call of DeleteSecret.
func (*MockClientMockRecorder) EnableAppRoleAuth ¶
func (mr *MockClientMockRecorder) EnableAppRoleAuth(ctx interface{}) *gomock.Call
EnableAppRoleAuth indicates an expected call of EnableAppRoleAuth.
func (*MockClientMockRecorder) GetSecret ¶
func (mr *MockClientMockRecorder) GetSecret(ctx, path, key interface{}) *gomock.Call
GetSecret indicates an expected call of GetSecret.
func (*MockClientMockRecorder) ListKeys ¶
func (mr *MockClientMockRecorder) ListKeys(ctx, path interface{}) *gomock.Call
ListKeys indicates an expected call of ListKeys.
func (*MockClientMockRecorder) ReadAppRoleRoleID ¶
func (mr *MockClientMockRecorder) ReadAppRoleRoleID(ctx, name interface{}) *gomock.Call
ReadAppRoleRoleID indicates an expected call of ReadAppRoleRoleID.