From 821d347375a7854b5afbb85249806ca4adf665f0 Mon Sep 17 00:00:00 2001 From: Jeff Mitchell Date: Sun, 13 May 2018 16:39:22 -0400 Subject: [PATCH] Update HSM documentation and fix GCP docs build --- .../source/docs/enterprise/hsm/index.html.md | 38 +++++++++---------- website/source/docs/secrets/gcp/index.html.md | 2 +- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/website/source/docs/enterprise/hsm/index.html.md b/website/source/docs/enterprise/hsm/index.html.md index 3ba7a2759..9e1d3dbc1 100644 --- a/website/source/docs/enterprise/hsm/index.html.md +++ b/website/source/docs/enterprise/hsm/index.html.md @@ -11,32 +11,32 @@ description: |- HSM support is a feature of [Vault Enterprise](https://www.hashicorp.com/vault.html) that takes advantage of HSMs -to provide two pieces of special functionality: +to provide three pieces of special functionality: * Master Key Wrapping: Vault protects its master key by transiting it through the HSM for encryption rather than splitting into key shares - * Automatic Unsealing: Vault stores its encrypted master key in storage, + * Automatic Unsealing: Vault stores its HSM-wrapped master key in storage, allowing for automatic unsealing + * [Seal Wrapping](/docs/enterprise/sealwrap/index.html) to provide FIPS + KeyStorage-conforming functionality for Critical Security Parameters -HSM support is currently limited to devices that support PKCS#11 interfaces and -provide integration libraries. It has successfully been tested with the following -HSM platforms/vendors: +HSM support is available for devices that support PKCS#11 version 2.20+ +interfaces and provide integration libraries, and is currently available for +linux/amd64 platforms only. It has successfully been tested against many +different vendor HSMs; HSMs that provide only subsets of the full PKCS#11 +specification can usually be supported but it depends on available +cryptographic mechanisms. - * AWS [CloudHSM](https://aws.amazon.com/cloudhsm/) - * Thales [nShield](https://www.thalesesecurity.com/products/general-purpose-hsms) - * Utimaco [HSM](https://hsm.utimaco.com/) - * SafeNet/Gemalto [Luna](https://safenet.gemalto.com/data-encryption/hardware-security-modules-hsms/safenet-network-hsm/) - * Unbound [HSM](https://www.unboundtech.com/) - * OpenDNSSEC [SoftHSM](https://www.opendnssec.org/softhsm/) - -Please note however that configuration details, flags, and supported features within PKCS#11 vary depending on HSM model and configuration. Consult your HSM's documentation for more details. +Please note however that configuration details, flags, and supported features +within PKCS#11 vary depending on HSM model and configuration. Consult your +HSM's documentation for more details. Some parts of Vault work differently when using an HSM. Please see the -[Behavioral Changes](/docs/vault-enterprise/hsm/behavior.html) page for important information -on these differences. +[Behavioral Changes](/docs/enterprise/hsm/behavior.html) page for +important information on these differences. -The [Configuration](/docs/configuration/seal/pkcs11.html) page contains configuration -information. +The [Configuration](/docs/configuration/seal/pkcs11.html) page contains +configuration information. -Finally, the [Security](/docs/vault-enterprise/hsm/security.html) page contains information -about deploying Vault's HSM support in a secure fashion. +Finally, the [Security](/docs/enterprise/hsm/security.html) page contains +information about deploying Vault's HSM support in a secure fashion. diff --git a/website/source/docs/secrets/gcp/index.html.md b/website/source/docs/secrets/gcp/index.html.md index 27fcad4aa..023c01756 100644 --- a/website/source/docs/secrets/gcp/index.html.md +++ b/website/source/docs/secrets/gcp/index.html.md @@ -414,7 +414,7 @@ Please report issues, add feature requests, and submit contributions to the The GCP secrets engine has a full HTTP API. Please see the [GCP secrets engine API docs][api] for more details. -[api]: (/api/secret/gcp/index.html) +[api]: https://vaultproject.io/api/secret/gcp/index.html [cloud-creds]: https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application [custom-roles]: https://cloud.google.com/iam/docs/creating-custom-roles [gce]: https://cloud.google.com/compute/