forked from google/go-cloud
-
Notifications
You must be signed in to change notification settings - Fork 0
/
driver.go
52 lines (43 loc) · 2.02 KB
/
driver.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
// Copyright 2018 The Go Cloud Development Kit Authors
//
// 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
//
// https://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 driver defines interfaces to be implemented by secrets drivers, which
// will be used by the secrets package to interact with the underlying services.
// Application code should use package secrets.
package driver // import "github.com/kainoaseto/go-cloud/secrets/driver"
import (
"context"
"github.com/kainoaseto/go-cloud/gcerrors"
)
// Keeper holds the key information to encrypt a plain text message into a
// cipher message, as well as decrypt a cipher message into a plain text
// message.
type Keeper interface {
// Decrypt decrypts the ciphertext and returns the plaintext or an error.
// Decrypt *may* decrypt ciphertexts that were encrypted using a different
// key than the one provided to Keeper; some drivers encode the key used
// in the ciphertext.
Decrypt(ctx context.Context, ciphertext []byte) ([]byte, error)
// Encrypt encrypts the plaintext using the key, and returns the ciphertext.
Encrypt(ctx context.Context, plaintext []byte) ([]byte, error)
// Close releases any resources used for the Keeper.
Close() error
// ErrorAs allows drivers to expose driver-specific types for returned
// errors.
//
// See https://github.com/kainoaseto/go-cloud/concepts/as/ for background information.
ErrorAs(err error, i interface{}) bool
// ErrorCode should return a code that describes the error, which was returned
// by one of the other methods in this interface.
ErrorCode(error) gcerrors.ErrorCode
}