pkg

Documentation

Overview

Package pkg generalized functions, interfaces, and structs which can be used for for different data-stores implementations.

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

• 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 ErrSecretStore
  • func NewErrSecretStore(description string) ErrSecretStore
  • func (e ErrSecretStore) Error() string
• type ErrSecretsNotFound
  • func NewErrSecretsNotFound(keys []string) ErrSecretsNotFound
  • func (scnf ErrSecretsNotFound) Error() string
• type SecretClient
  • func (sc SecretClient) GetSecrets(keys ...string) (map[string]string, error)
• type SecretStoreManager

Constants

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

Defines the valid secret store providers.

Types

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 SecretClient

type SecretClient struct {
	Manager SecretStoreManager
}

func (SecretClient) GetSecrets

func (sc SecretClient) GetSecrets(keys ...string) (map[string]string, error)

GetSecrets returns the values requested at the provided keys. If the secret manager returns a nil or empty map, a SecretsNotFound error is returned. If any other error is encountered by the secret manager it is bubbled up and no partial results are provided.

type SecretStoreManager

type SecretStoreManager interface {
	// GetValue Retrieves the values associated with the specified keys.
	// returns ErrSecretsNotFound if any of the specified keys do not have a value set.
	GetValues(keys ...string) (map[string]string, error)
}

SecretStoreManager provides functionality for interacting with an underlying data-store.