When constructing a Deployment (which is a plaintext representation of a Snapshot), ensure that we encrypt secret values. To do so, we introduce a new type `secrets.Manager` which is able to encrypt and decrypt values. In addition, it is able to reflect information about itself that can be stored in the deployment such that we can deserialize the deployment into a snapshot (decrypting the values in the process) without external knowledge about how it was encrypted. The ability to do this is import for allowing stack references to work, since two stacks may not use the same manager (or they will use the same type of manager, but have different state). The state value is stored in plaintext in the deployment, so it **must not** contain sensitive data. A sample manager, which just base64 encodes and decodes strings is provided, as it useful for testing. We will allow it to be varried soon.
40 lines
1.6 KiB
Go
40 lines
1.6 KiB
Go
// Copyright 2016-2018, Pulumi Corporation.
|
|
//
|
|
// 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 secrets
|
|
|
|
import (
|
|
"encoding/json"
|
|
|
|
"github.com/pulumi/pulumi/pkg/resource/config"
|
|
)
|
|
|
|
type Manager interface {
|
|
// Type retruns a string that reflects the type of this provider. This is serialized along with the state of
|
|
// the manager into the deployment such that we can re-construct the correct manager when deserializing a
|
|
// deployment into a snapshot.
|
|
Type() string
|
|
// An opaque state, which can be JSON serialized and used later to reconstruct the provider when deserializing
|
|
// the deployment into a snapshot.
|
|
State() interface{}
|
|
// Encrypter returns a `config.Encrypter` that can be used to encrypt values when serializing a snapshot into a
|
|
// deployment, or an error if one can not be constructed.
|
|
Encrypter() (config.Encrypter, error)
|
|
// Decrypter returns a `config.Decrypter` that can be used to decrypt values when deserializing a snapshot from a
|
|
// deployment, or an error if one can not be constructed.
|
|
Decrypter() (config.Decrypter, error)
|
|
}
|
|
|
|
type ManagerProvider interface {
|
|
FromState(state json.RawMessage) (Manager, error)
|
|
}
|