2015-04-14 03:41:53 +00:00
---
2020-01-18 00:18:09 +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.
2020-05-29 17:28:03 +00:00
_Unsealing_ is the process of obtaining the plaintext master key necessary to
2015-04-14 03:41:53 +00:00
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
2020-05-29 17:28:03 +00:00
also stored with the data (in the _keyring_), but encrypted with another
encryption key known as the _master key_.
2015-04-14 03:41:53 +00:00
Therefore, to decrypt the data, Vault must decrypt the encryption key
2020-05-29 17:28:03 +00:00
which requires the master key. Unsealing is the process of getting access to
this master key. The master key is stored alongside all other Vault data,
but is encrypted by yet another mechanism: the unseal key.
2015-04-14 03:41:53 +00:00
2020-05-29 17:28:03 +00:00
To recap: most Vault data is encrypted using the encryption key in the keyring;
the keyring is encrypted by the master key; and the master key is encrypted by
the unseal key.
## Shamir seals
The default Vault config uses a Shamir seal. Instead of distributing the unseal
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
2020-05-29 17:28:03 +00:00
reconstruct the unseal key, which is then used to decrypt the master key.
2015-04-14 03:41:53 +00:00
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
2020-05-29 17:28:03 +00:00
decrypt the master key.
2015-04-14 03:41:53 +00:00
## Unsealing
2018-06-07 04:11:21 +00:00
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.
2020-05-29 17:28:03 +00:00
Once a Vault node is unsealed, it remains unsealed until one of these things happens:
2015-04-14 03:41:53 +00:00
2020-01-18 00:18:09 +00:00
1. It is resealed via the API (see below).
2015-04-14 03:41:53 +00:00
2020-01-18 00:18:09 +00:00
2. The server is restarted.
2015-04-14 03:41:53 +00:00
2020-05-29 17:28:03 +00:00
3. Vault's storage layer encounters an unrecoverable error.
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,
2020-05-29 17:28:03 +00:00
but unsealing it using Shamir is a very manual process. For most users
AutoUnseal will provide a better experience.
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.
2018-10-25 23:44:53 +00:00
## Auto Unseal
2019-10-16 15:25:41 +00:00
Auto Unseal was developed to aid in reducing the operational complexity of
2020-05-29 17:28:03 +00:00
keeping the unseal key secure. This feature delegates the responsibility of
securing the unseal key from users to a trusted device or service. At startup
Vault will connect to the device or service implementing the seal and ask it
to decrypt the master key Vault read from storage.
2018-10-25 23:44:53 +00:00
2019-04-01 12:23:46 +00:00
When using Auto Unseal there are certain operations in Vault that still
2019-10-16 15:25:41 +00:00
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
2020-05-29 17:28:03 +00:00
_recovery keys_ and are used for these operations.
It is still possible to seal a Vault node using the API. In this case Vault
will remain sealed until restarted, or the unseal API is used, which with AutoUnseal
requires the recovery key fragments instead of the unseal key fragments that
would be provided with Shamir. The process remains the same.
2018-10-25 23:44:53 +00:00
For a list of examples and supported providers, please see the
2020-01-22 20:05:41 +00:00
[seal documentation](/docs/configuration/seal).
2018-10-25 23:44:53 +00:00
2020-05-12 05:02:59 +00:00
## Recovery Key Rekeying
2018-10-25 23:44:53 +00:00
2020-05-12 05:02:59 +00:00
During the KMS 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.
2020-02-05 20:30:04 +00:00
2020-05-12 05:02:59 +00:00
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`.
2020-02-05 20:30:04 +00:00
2020-05-12 05:02:59 +00:00
## Seal Migration
2019-10-16 15:25:41 +00:00
2020-05-12 05:02:59 +00:00
The seal can be migrated from Shamir Seal to KMS Seal, KMS Seal to Shamir Seal,
and KMS Seal to another KMS Seal.
~> **NOTE**: Seal migration process cannot be performed without downtime. Due to
the technical underpinnings of the seal implementations, it is at this point not
possible to perform seal migration without briefly bringing the whole cluster
down. We understand that it can be hard for many deployments to face downtime,
but we believe that switching seals is a rare event and hence we hope for the
downtime to be considered as an acceptable trade-off.
~> **NOTE**: Seal migration operation will require both old and new seals to be
available during the migration. For example, migration from KMS seal to Shamir
seal will require that the KMS key be accessible during the migration.
~> **NOTE**: Seal migration from KMS seal to Shamir seal is not currently
supported when using Vault Enterprise. We plan to support this officially in a
future release.
~> **NOTE**: Seal migration from KMS seal to KMS seal of same kind is not
currently supported. We plan to support this officially in a future release.
### Migration post Vault 1.4.0
These steps are common for seal migrations between any supported kinds and for
any storage backend.
1. Take a standby node down and update the [seal
2020-05-21 17:18:17 +00:00
configuration](/docs/configuration/seal). If the migration is from Shamir seal
to KMS seal, add the desired new KMS seal block to the config. If the migration
is from KMS seal to Shamir seal, add `disabled = "true"` to the old seal block.
If the migration is from KMS seal to another KMS seal, add `disabled = "true"`
to the old seal block and add the desired new KMS seal block. Now, bring the
standby node back up and run the unseal command on each by supplying the
`-migrate` flag. Supply Shamir unseal keys if old seal was Shamir, which will be
migrated as the recovery keys for the KMS seal. Supply recovery keys if the old
seal is one of KMS seals, which will be migrated as the recovery keys of the new
KMS seal or as Shamir unseal keys if the new seal is Shamir.
2020-05-12 05:02:59 +00:00
2. Perform step 1 for all the standby nodes, one at a time. It is necessary to
2020-05-21 17:18:17 +00:00
bring back the downed standby node before moving on to the other standby nodes,
specifically when integrated storage is in use for it helps to retain the
quorum.
2020-05-12 05:02:59 +00:00
3. Stop the active node. One of the standby nodes will become the active node
2020-05-21 17:18:17 +00:00
and perform the migration. When using Integrated Storage, ensure that quorum is
reached and a leader is elected. Monitor the server log in the active node to
witness the completion of the seal migration process. Wait for a little while
for the migration information to replicate to all the nodes in case of
Integrated Storage. In enterprise Vault, switching a KMS seal implies that the
seal wrapped storage entries get re-wrapped. Monitor the log and wait until this
process is complete (look for `seal re-wrap completed`).
2020-05-12 05:02:59 +00:00
4. Seal migration is now completed. Update the config of the old active node
2020-05-21 17:18:17 +00:00
(that is still down) to use the new seal blocks (completely unaware of the old
seal type) and bring it up. It will be auto-unsealed if the new seal is one of the
KMS seals or will require unseal keys if the new seal is Shamir.
2020-05-12 05:02:59 +00:00
5. At this point, config files of all the nodes can be updated to only have the
2020-05-21 17:18:17 +00:00
new seal information. Standby nodes can be restarted right away and the active
node can be restarted upon a leadership change.
2020-05-12 05:02:59 +00:00
### Migration pre 1.4
#### Migration From Shamir to Auto Unseal
2020-05-21 17:18:17 +00:00
2020-05-12 05:02:59 +00:00
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.
2020-05-21 17:18:17 +00:00
`$ vault operator unseal -migrate`
2020-05-12 05:02:59 +00:00
#### Migration From Auto Unseal to Shamir
To migrate from Auto Unseal to Shamir keys, take your server cluster offline and
2020-05-21 17:18:17 +00:00
update the [seal configuration](/docs/configuration/seal) and add `disabled = "true"` to the seal block. This allows the migration to use this information to
2020-05-12 05:02:59 +00:00
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-05 20:30:04 +00:00
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.
2020-05-12 05:02:59 +00:00
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
2020-05-21 17:18:17 +00:00
block. Then add another seal block to describe the new seal.
2020-02-05 20:30:04 +00:00
2020-05-12 05:02:59 +00:00
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-05 20:30:04 +00:00
2020-05-12 05:02:59 +00:00
#### Migration with Integrated Storage
2020-02-21 11:57:48 +00:00
Integrated Storage uses the Raft protocol underneath, which requires a quorum of
2020-05-12 05:02:59 +00:00
servers to be online before the cluster is functional. Therefore, bringing the
2020-02-21 11:57:48 +00:00
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
2020-05-12 05:02:59 +00:00
node that will perform the migration. The migrated information will be replicated to
2020-02-21 11:57:48 +00:00
all other cluster peers and when the peers eventually become the leader,
migration will not happen again on the peer nodes.
