open-vault/website/pages/docs/concepts/seal.mdx

164 lines
7.4 KiB
Plaintext
Raw Normal View History

2015-04-14 03:41:53 +00:00
---
layout: docs
page_title: Seal/Unseal
sidebar_title: Seal/Unseal
description: >-
A Vault must be unsealed before it can access its data. Likewise, it can be
sealed to lock it down.
2015-04-14 03:41:53 +00:00
---
# Seal/Unseal
When a Vault server is started, it starts in a _sealed_ state. In this
state, Vault is configured to know where and how to access the physical
storage, but doesn't know how to decrypt any of it.
_Unsealing_ is the process of constructing the master key necessary to
read the decryption key to decrypt the data, allowing access to the Vault.
Prior to unsealing, almost no operations are possible with Vault. For
example authentication, managing the mount tables, etc. are all not possible.
The only possible operations are to unseal the Vault and check the status
of the unseal.
## Why?
The data stored by Vault is stored encrypted. Vault needs the
_encryption key_ in order to decrypt the data. The encryption key is
also stored with the data, but encrypted with another encryption key
known as the _master key_. The master key isn't stored anywhere.
Therefore, to decrypt the data, Vault must decrypt the encryption key
which requires the master key. Unsealing is the process of reconstructing
this master key.
Instead of distributing this master key as a single key to an operator,
Vault uses an algorithm known as
2016-01-14 18:42:47 +00:00
[Shamir's Secret Sharing](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing)
2015-04-14 03:41:53 +00:00
to split the key into shards. A certain threshold of shards is required to
reconstruct the master key.
This is the _unseal_ process: the shards are added one at a time (in any
order) until enough shards are present to reconstruct the key and
decrypt the data.
## Unsealing
The unseal process is done by running `vault operator unseal` or via the API.
2015-04-14 03:41:53 +00:00
This process is stateful: each key can be entered via multiple mechanisms
on multiple computers and it will work. This allows each shard of the master
key to be on a distinct machine for better security.
Once a Vault is unsealed, it remains unsealed until one of two things happens:
1. It is resealed via the API (see below).
2015-04-14 03:41:53 +00:00
2. The server is restarted.
2015-04-14 03:41:53 +00:00
-> **Note:** Unsealing makes the process of automating a Vault install
difficult. Automated tools can easily install, configure, and start Vault,
but unsealing it is a very manual process. We have plans in the future to
2015-04-17 19:01:20 +00:00
make it easier. For the time being, the best method is to manually unseal
multiple Vault servers in [HA mode](/docs/concepts/ha). Use a tool such
2015-04-17 19:01:20 +00:00
as Consul to make sure you only query Vault servers that are unsealed.
2015-04-14 03:41:53 +00:00
## Sealing
2016-01-19 15:42:50 +00:00
There is also an API to seal the Vault. This will throw away the master
2015-04-14 03:41:53 +00:00
key and require another unseal process to restore it. Sealing only requires
a single operator with root privileges.
2015-04-28 18:32:04 +00:00
This way, if there is a detected intrusion, the Vault data can be locked
2015-04-14 03:41:53 +00:00
quickly to try to minimize damages. It can't be accessed again without
access to the master key shards.
## Auto Unseal
Auto Unseal was developed to aid in reducing the operational complexity of
keeping the master key secure. This feature delegates the responsibility of
securing the master key from users to a trusted device or service. Instead of
only constructing the key in memory, the master key is encrypted with one of
these services or devices and then stored in the storage backend allowing Vault
to decrypt the master key at startup and unseal automatically.
When using Auto Unseal there are certain operations in Vault that still
require a quorum of users to perform an operation such as generating a root token.
During the initialization process, a set of Shamir keys are generated that are called
Recovery Keys and are used for these operations.
For a list of examples and supported providers, please see the
[seal documentation](/docs/configuration/seal).
## Seal Migration
2020-02-21 11:57:48 +00:00
The seal can be migrated from Shamir keys to Auto Unseal, Auto Unseal to Shamir
keys and Auto Unseal to another Auto Unseal.
~> **NOTE**: The migration operation will require both seals to be available
during the migration. For example, a migration from a cloud KMS seal to
Shamir will require that the cloud KMS be accessible during the migration.
### Migration From Shamir to Auto Unseal
To migrate from Shamir keys to Auto Unseal, take your server cluster offline and update
the [seal configuration](/docs/configuration/seal) with the appropriate seal
configuration. Bring your server back up and leave the rest of the nodes offline if
using multi-server mode, then run the unseal process with the `-migrate` flag and bring
the rest of the cluster online.
All unseal commands must specify the `-migrate` flag. Once the required threshold of
unseal keys are entered, unseal keys will be migrated to recovery keys.
```
$ vault operator unseal -migrate
```
### Migration From Auto Unseal to Shamir
~> **NOTE**: Migration to Shamir seal is not currently supported when using
Vault Enterprise. We plan to support this officially in a future release.
To migrate from Auto Unseal to Shamir keys, take your server cluster offline and update
the [seal configuration](/docs/configuration/seal) and add `disabled = "true"`
to the seal block. This allows the migration to use this information to decrypt the key
but will not unseal Vault. When you bring your server back up, run the unseal process
with the `-migrate` flag and use the Recovery Keys to perform the migration. All unseal
commands must specify the `-migrate` flag. Once the required threshold of recovery keys
are entered, the recovery keys will be migrated to be used as unseal keys.
### Migration From Auto Unseal to Auto Unseal
2020-02-21 11:57:48 +00:00
~> **NOTE**: Migration between same Auto Unseal types is not currently
supported. We plan to support this officially in a future release.
To migrate from Auto Unseal to a different Auto Unseal configuration, take your server
cluster offline and update the existing [seal configuration](/docs/configuration/seal)
and add `disabled = "true"` to the seal block. Then add another seal block to describe
the new seal.
When you bring your server back up, run the unseal process with the `-migrate` flag and
use the Recovery Keys to perform the migration. All unseal commands must specify
the `-migrate` flag. Once the required threshold of recovery keys are entered,
the recovery keys will be kept and used as recovery keys in the new seal.
2020-02-21 11:57:48 +00:00
### Migration with Integrated Storage
Integrated Storage uses the Raft protocol underneath, which requires a quorum of
servers to be online before the cluster is functional. Therefore, bring the
cluster back up one node at a time with the seal configuration updated, will not
work in this case. Follow the same steps for each kind of migration described
above with the exception that after the cluster is taken offline, update the
seal configurations of all the nodes appropriately and bring them all back up.
When the quorum of nodes are back up, Raft will elect a leader and the leader
node will perform the migration. The migrated information will be replicated to
all other cluster peers and when the peers eventually become the leader,
migration will not happen again on the peer nodes.
## Recovery Key Rekeying
During Auto Seal initialization process, a set of Shamir keys called Recovery Keys are
generated which are used for operations that still require a quorum of users.
Recovery Keys can be rekeyed to change the number of shares or thresholds. When using the
Vault CLI, this is performed by using the `-target=recovery` flag to `vault operator rekey`.