c95ec45307
This renames some instances of ucp to airship in the documentation and makes some trivial documentation fixes. Change-Id: I9a4a81d15bfc13b4fe089b7d65f0df43eeade9fb
2.4 KiB
Data Encryption
Deckhand supports encrypting the data section of
documents at-rest to secure sensitive data. This encryption behavior is
triggered by setting metadata.storagePolicy: encrypted. It
is solely the document author's responsibility to decide the appropriate
storagePolicy for the data contained in the document.
Note
Note that encryption of document data incurs runtime
overhead as the price of encryption is performance. As a
general rule, the more documents with
storagePolicy: encrypted, the longer it will take to render
the documents, particularly because Barbican has
a built-in restriction
around retrieving only one encrypted payload a time. This means that if
50 documents have storagePolicy: encrypted within a
revision, then Deckhand must perform 50 API calls to Barbican when
rendering the documents for that revision.
Encrypted documents, like cleartext documents, are stored in
Deckhand's database, except the data section of each
encrypted document is replaced with a reference to Barbican.
Supported Data Types
Barbican supports encrypting any data type via its "opaque" secret type. Thus, Deckhand supports encryption of any data type by utilizing this secret type.
However, Deckhand will attempt to use Barbican's other
secret types where possible. For example, Deckhand will use "public" for
document types with kind PublicKey.