sms-service/src/sms/backend/backend.go

   1 /*
   2  * Copyright 2018 Intel Corporation, Inc
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package backend
  18
  19 import (
  20         smsconfig "sms/config"
  21         smslogger "sms/log"
  22 )
  23
  24 // SecretDomain is where Secrets are stored.
  25 // A single domain can have any number of secrets
  26 type SecretDomain struct {
  27         UUID string `json:"uuid"`
  28         Name string `json:"name"`
  29 }
  30
  31 // Secret is the struct that defines the structure of a secret
  32 // It consists of a name and map containing key value pairs
  33 type Secret struct {
  34         Name   string                 `json:"name"`
  35         Values map[string]interface{} `json:"values"`
  36 }
  37
  38 // SecretBackend interface that will be implemented for various secret backends
  39 type SecretBackend interface {
  40         Init() error
  41         GetStatus() (bool, error)
  42         Unseal(shard string) error
  43
  44         GetSecret(dom string, sec string) (Secret, error)
  45         ListSecret(dom string) ([]string, error)
  46
  47         CreateSecretDomain(name string) (SecretDomain, error)
  48         CreateSecret(dom string, sec Secret) error
  49
  50         DeleteSecretDomain(name string) error
  51         DeleteSecret(dom string, name string) error
  52 }
  53
  54 // InitSecretBackend returns an interface implementation
  55 func InitSecretBackend() (SecretBackend, error) {
  56         backendImpl := &Vault{
  57                 vaultAddress: smsconfig.SMSConfig.BackendAddress,
  58                 vaultToken:   smsconfig.SMSConfig.VaultToken,
  59         }
  60
  61         err := backendImpl.Init()
  62         if err != nil {
  63                 smslogger.WriteError(err.Error())
  64                 return nil, err
  65         }
  66
  67         return backendImpl, nil
  68 }
  69
  70 // LoginBackend Interface that will be implemented for various login backends
  71 type LoginBackend interface {
  72 }