package pkg

import "github.com/edgexfoundry/go-mod-secrets/pkg"

******************************************************************************

• Copyright 2019 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

Package errors contains the error types which are used by the SecretClient to communicate errors

Index ¶

• Constants
• type Caller
• type ErrSecretStore
• func NewErrSecretStore(description string) ErrSecretStore
• func (e ErrSecretStore) Error() string
• type ErrSecretsNotFound
• func NewErrSecretsNotFound(keys []string) ErrSecretsNotFound
• func (scnf ErrSecretsNotFound) Error() string
• type TokenExpiredCallback

Constants ¶

const (
	CoreSecurityServiceKey = "edgex-core-security"
	ConfigFileName         = "configuration.toml"
	ConfigDirectory        = "./res"
	ConfigDirEnv           = "EDGEX_CONF_DIR"
)

Defines the valid secret store providers.

Types ¶

type Caller ¶

type Caller interface {
	Do(req *http.Request) (*http.Response, error)
}

Caller interface used to abstract the implementation details for issuing an HTTP request. This allows for easier testing by the way of mocks.

type ErrSecretStore ¶

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

ErrSecretStore error for unexpected problems with the secret store.

func NewErrSecretStore ¶

func NewErrSecretStore(description string) ErrSecretStore

NewErrSecretStore creates an ErrSecretStore error type.

func (ErrSecretStore) Error ¶

func (e ErrSecretStore) Error() string

type ErrSecretsNotFound ¶

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

ErrSecretsNotFound error when a secret cannot be found. This aids in differentiating between empty("") values and non-existent keys

func NewErrSecretsNotFound ¶

func NewErrSecretsNotFound(keys []string) ErrSecretsNotFound

NewErrSecretsNotFound creates a new ErrSecretsNotFound error.

func (ErrSecretsNotFound) Error ¶

func (scnf ErrSecretsNotFound) Error() string

type TokenExpiredCallback ¶

type TokenExpiredCallback func(expiredToken string) (replacementToken string, retry bool)

TokenExpiredCallback is the callback function to handle the case when the vault token has already expired

Source Files ¶

constants.go errors.go interfaces.go

Directories ¶