357 Commits

Author SHA1 Message Date
Socheat Sok
f1922d2113
Minor tweak on "Set Certificate Chain" docs for Transit secret engine (#26250)
The `certificate_chain` parameter is incorrect from the description in the PR #21081.
2024-04-04 09:37:45 -04:00
radek-sprta
ab59f8fa56
Docs: Mention default_extensions_template in API docs (#26028)
Co-authored-by: Chris Capurso <1036769+ccapurso@users.noreply.github.com>
2024-03-19 11:06:51 -04:00
Hector Manuel
8ef273832e
Docs: New parameter for the Kubernetes Secrets roles (#25581)
* Docs: New parameter for the K8s Secrets roles

* Fix: Apply text correction from review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Peter Wilson <peter.wilson@hashicorp.com>
2024-03-13 18:27:30 +00:00
Austin Gebauer
57f7fa9c60
docs: adds enterprise documentation for plugin wif (#25706)
* docs: adds enterprise documentation for plugin wif

* attempt fix anchor link

* Update website/content/api-docs/secret/identity/tokens.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/identity/tokens.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/identity/tokens.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* remove API section for plugin WIF

* commas

* move wif out of subsection

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-03-07 19:14:30 -08:00
Steven Clark
43f8c7a6f0
PKI EST docs (#25521)
* PKI EST docs

 Initial draft of the PKI EST setup and API docs for feedback

* Add missing enable_sentinel_parsing param to API docs

* Update grammar

* Some API doc feedback

* Note about dedicated auth mounts

* Additional PR feedback

---------

Co-authored-by: Scott G. Miller <smiller@hashicorp.com>
2024-03-07 14:27:59 -05:00
Steven Clark
09294e891a
Add notes around OCSP GET request issue (#25745)
* Add note around OCSP GET request issue

 - Fix some broken TOC links
 - Add a note in the api-docs and in the considerations page
   around Vault having issues with OCSP GET requests and that
   POST requests should be preferred.
 - Add existing known issue to all branches that are affected.

* Fix links to partial file for 1.12 and 1.13 upgrade docs
2024-03-01 15:25:07 -05:00
Milena Zlaticanin
3a844a2e45
Update Azure secrets docs + deprecation (#25637)
* Update Azure secrets docs + deprecation

* add changelog

* update

* update docs

* update deprec doc
2024-02-28 11:59:00 -07:00
vinay-gopalan
60fb3c14d5
Add documentation for new Identity Token .well-known endpoint used for Plugin WIF (#25469) 2024-02-22 09:08:59 -08:00
vinay-gopalan
2dc73f0636
Add documentation for AWS Plugin WIF (#25398) 2024-02-21 09:19:43 -08:00
aphorise
6d59868fb8
Docs: Tranform secrets encode parameter: expiration added. (#25168)
* Docs: Tranform secrets encode parameter:  added.

* Docs: Tranform secrets encode parameter `expiration` text corrected & formating on `ttl` too.

* Docs: Tranform secrets encode parameter `expiration` formating & correction.

* Update website/content/api-docs/secret/transform.mdx
2024-02-02 10:20:10 -05:00
Austin Gebauer
677d98a821
oidc/provider: adds code_challenge_methods_supported to metadata (#24979)
* oidc/provider: adds code_challenge_methods_supported to metadata

* adds changelog

* adds docs
2024-01-22 13:40:13 -08:00
Nestor Reyes
4811fd1962
Update oracle.mdx missing feature flags (#23517)
* Update oracle.mdx missing feature flags

Adding missing feature flags to API doc. 
split_statements and disconnect_sessions.

Related PR
https://github.com/hashicorp/vault-plugin-database-oracle/pull/62

* Update website/content/api-docs/secret/databases/oracle.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-01-22 13:59:04 -06:00
Andy Assareh
ab2e0e5a28
typo corrections - spelling and grammar (#24625)
* typo corrections - spelling

* spelling and grammar
2024-01-04 12:50:42 -05:00
Tom Proctor
dc5c3e8d97
New database plugin API to reload by plugin name (#24472) 2023-12-13 10:23:34 +00:00
Steven Clark
a41852379b
Document and augment tests that PKI accepts 8192 bit RSA keys (#24364)
- Noticed that our documentation was out of date, we allow 8192
   bit RSA keys to be used as an argument to the various PKI
   issuer/key creation APIs.
 - Augument some unit tests to verify this continues to work
2023-12-05 15:26:03 -05:00
Milena Zlaticanin
aa9b02307d
Update Azure Secrets docs (#24279) 2023-12-04 15:41:25 -07:00
Steven Clark
53040690a2
PKI: Do not set NextUpdate OCSP field when ocsp_expiry is 0 (#24192)
* Do not set NextUpdate OCSP field when ocsp_expiry is 0

* Add cl
2023-11-20 10:32:05 -05:00
Robert
54bf0807c1
secrets/aws: add support for STS Session Tokens with TOTP (#23690)
* Add test coverage

* Add session_token field, deprecate security_token

* Undo auth docs

* Update api docs

* Add MFA code support

---------

Co-authored-by: Graham Christensen <graham@grahamc.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Austin Gebauer <34121980+austingebauer@users.noreply.github.com>
2023-11-08 17:06:28 -06:00
kpcraig
dd15e5296f
Add documentation for new ldap param (#23817) 2023-11-01 11:33:53 -04:00
Steven Clark
8c9929bed2
Update specifics around managed keys support in Transit (#23795) 2023-10-26 13:45:15 -04:00
Andreas Gruhler
548b7a094b
Fix backticks for cluster_aia_path (#23845) 2023-10-26 08:28:16 -04:00
kpcraig
30f19b383f
VAULT-18307: update rotation period for aws static roles on update (#23528) 2023-10-11 17:06:58 +00:00
Skybladev2
6ff9fcabab
Fix path for Delete metadata and all versions (#23542)
* Fix path for Delete metadata and all versions

* fix template - remove unneeded trailing double colon
2023-10-09 13:05:49 -07:00
Nicola Kabar
2a46d492a3
updated the LIST identity/entity-alias/id endpoint docs (#23016)
* updated the LIST identity/entity-alias/id endpoint docs to reflect new data returned

* Update website/content/api-docs/secret/identity/entity-alias.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/identity/entity-alias.mdx

Co-authored-by: Max Bowsher <maxbowsher@gmail.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Max Bowsher <maxbowsher@gmail.com>
2023-09-18 12:30:30 -07:00
Raymond Ho
018e5675fe
VAULT 18227/introduce cap ldap library (#22185) 2023-09-14 10:26:29 -07:00
Alexander Scheel
21742020f0
Add API docs on Transit X.509 certificates (#22998)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-09-12 11:35:37 -04:00
vinay-gopalan
2b74a4826b
Add documentation for IAM authentication for DB Secrets Engine (#22836)
Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-09-08 14:03:50 -07:00
John-Michael Faircloth
1870018090
docs: db schedule-based static role rotations (#22863)
* docs: db schedule-based static role rotations

* fix broken link

* add mutual exclusion notice on overview page

* prepend slash to relative link
2023-09-07 16:50:57 -05:00
Steven Clark
aa81aeaba0
Add api-docs for PKI CIEPS sign-intermediate (#22371)
* Add api-docs for PKI CIEPS sign-intermediate

 - This adds the CIEPS sign-intermediate api-docs and tweaks the existing CIEPS apis to mark the policy url argument as optional.

* Define CIEPS in the first use per section
2023-08-17 08:57:55 -04:00
Chip Stepowski
f0c66d4e26
Add metadata policy requirement for KV-V2 list.mdx (#21812)
* Add metadata policy requirement for KV-V2 list.mdx

Customer requested change as our API docs page does not state the token policy must have access to metadata in the policy when listing KV-V2 secrets. I let them know it exists here: https://developer.hashicorp.com/vault/docs/secrets/kv/kv-v2#acl-rules, in the ACL section, but they wanted to have it added to the API docs as well.

* Update website/content/api-docs/secret/kv/kv-v2.mdx

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
2023-08-15 13:51:44 -04:00
Sarah Chavis
91face4eff
convert OSS language to "community" (#22343) 2023-08-15 13:31:52 -04:00
Alexander Scheel
d4e402d597
Docs CIEPS Configuration (#22259)
* Clarify wording, add missing expiration fields

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add API docs on CIEPS configuration

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Fix ToC, headers to include EnterpriseAlert

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Update website/content/api-docs/secret/pki.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* Update website/content/api-docs/secret/pki.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

---------

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2023-08-09 09:27:06 -04:00
Alexander Scheel
04a081226d
Add docs on CIEPS issuance (#22098)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-08-09 08:01:17 -04:00
John-Michael Faircloth
a1a5be97e2
docs/db: fix outdated static role information (#22239) 2023-08-08 11:02:53 -05:00
Sarah Chavis
b6d973a133
Make enterprise callouts consistent (#22073) 2023-07-27 17:41:14 +00:00
Laurent
366693c78d
Add a parameter to allow ExtKeyUsage field usage from a role within ACME (#21702)
* imprv: Add a parameter to allow ExtKeyUsage field usage from a role

* chore: Add the changelog entry

* imprv: Reword UI and changelog

* doc: Add allow_role_extkeyusage in parameter list

* imprv: Align variable names with existing fields/codebase

* Add unit test and tweak some labels

---------

Co-authored-by: Steve Clark <steven.clark@hashicorp.com>
2023-07-17 09:31:13 -04:00
Anton Averchenkov
f4f0412b6a
[docs] Convert titles to sentense case (#21426)
* Convert documentation titles to sentense case

* Docker, Google, Foundry, Cloud proper case
2023-06-30 19:22:07 -04:00
Max Bowsher
43ae739971
Refactor identity/mfa/method/* endpoints to fix bad OpenAPI (#20879)
* Refactor `identity/mfa/method/*` endpoints to fix bad OpenAPI

There is a problem with how the `identity/mfa/method/*` endpoints are
defined, resulting in incorrect OpenAPI generation.

I raised hashicorp/vault-client-go#180 to track a consequence, and
opened #20873 which explains the problem and adds a log message to
detect it.

This PR is now the fix.

It's actually quite an interesting problem, that has come about through
some particular implementation choices, in Vault's first/only case where
REST API objects are created by writing to the collection URL, and have
their ID allocated by the server, instead of the client.

The triggering cause of the malfunction was trying to have a single
framework.Path struct instance which optionally includes or excludes the
method_id path parameter, and also another framework.Path struct
instance handling list operations.

The fix is to simplify the path regexes, and have one framework.Path
which handles the method_id being present, and one that handles it being
absent.

The diff is somewhat large, because the affected code had been
copy/pasted four times (TOTP, Okta, Duo, PingID) - so I took the
opportunity to fix the duplication, creating appropriate helper methods
so that the quadruplicated code could be re-unified.

* Revise documentation

This update refactors how the documentation presents these endpoints to
users, both for clarity, and to align with the new structure of the
code.

From a user perspective, it clears up some unclear presentation of when
the `method_id` parameter should and should not be present, adds
a missing description of the response to create requests, and changes
the `method_id` parameter name to be used consistently (rather than `id`
in some cases, unlike the actual code/OpenAPI).

* Fix incorrect acronym (review fix)

* Accept suggestion of tweaked grammar in documentation

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>

* Add changelog

---------

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>
2023-06-23 13:32:41 -04:00
Violet Hynes
8e40823fe1
Some small KV API docs improvements (#21395) 2023-06-22 13:39:47 -04:00
Steven Clark
eb634e9326
Remove bump_version from transit import docs (#21393)
- The argument was removed along the development path, but the
   documentation was not updated.
2023-06-21 15:36:52 -04:00
Alexander Scheel
3347e5d56b
Fix naming of enable_templating parameter (#21319)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-16 17:04:37 +00:00
Theron Voran
a3657dc604
docs/pki: add remove_roots_from_chain option to /pki/issue (#21161)
Adds the `remove_roots_from_chain` option to the docs for
`/pki/issue`, based on addNonCACommonFields().
2023-06-13 10:15:52 -07:00
Steven Clark
820f7ee22f
Clarify that no_store=true certs can still be revoked (#21169)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-13 11:34:26 -04:00
Alexander Scheel
508017d073
Add missing documentation on cert metrics (#21073)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-08 09:09:10 -04:00
Alexander Scheel
f079b7b0a4
Add TLS-ALPN-01 Challenge Type to ACME (#20943)
* Add ACME TLS-ALPN-01 Challenge validator to PKI

This adds support for verifying the last missing challenge type,
TLS-ALPN-01 challenges, using Go's TLS library. We wish to add this as
many servers (such as Caddy) support transparently renewing certificates
via this protocol, without influencing the contents of sites served.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Enable suggesting, validating tls-alpn-01 in PKI

Notably, while RFC 8737 is somewhat vague about what identifier types
can be validated with this protocol, it does restrict SANs to be only
DNSSans; from this, we can infer that it is not applicable for IP
typed identifiers. Additionally, since this must resolve to a specific
domain name, we cannot provision it for wildcard identifiers either.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Fix test expectations to allow ALPN challenges

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add tls-alpn-01 as a supported challenge to docs

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add test for tls-alpn-01 challenge verifier

This hacks the challenge engine to allow non-standard (non-443) ports,
letting us use a local server listener with custom implementation.

In addition to the standard test cases, we run:

 - A test with a longer chain (bad),
 - A test without a DNSSan (bad),
 - A test with a bad DNSSan (bad),
 - A test with some other SANs (bad),
 - A test without a CN (good),
 - A test without any leaf (bad), and
 - A test without the extension (bad).

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add changelog entry

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Update builtin/logical/pki/acme_challenges.go

Co-authored-by: Alexander Scheel <alex.scheel@hashicorp.com>

---------

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Kit Haines <khaines@mit.edu>
2023-06-07 16:34:00 +00:00
kpcraig
45b9dffea1
Update aws static credential fields to match dynamic credential fields (#21017)
* prospective field name change

* doc update

* we can actually update all struct tags here
2023-06-06 14:30:39 -05:00
Steven Clark
0bd356f6cd
Generate ACME EAB tokens that do not start with '-' (#20945)
* Generate ACME EAB tokens that do not start with -

 - To avoid people having issues copying EAB tokens and using them on command lines when they start with - from the base64 encoded values, append a prefix.
 - Remove the key_bits data from the eab api, not really useful and now technically wrong
 - Fix up some issues with tests not running in parallel.
 - Update docs to reflect new EAB apis.

* Add ACME directory to the various EAB output APIs

* Update EAB token prefix to be divisable by 3

 - Our decoded prefix was not divisable by 3, which meant the last
   character might be tweaked by the rest of the input
2023-06-05 14:38:03 +00:00
claire bontempo
34a722195e
UI: add pki/config/acme, fix pki/configcluster save bug (#20944)
* fix cluster/config actually saving doh

* add mkdown copy

* add acme config to edit form

* fix tests

* add empty state capabilities test

* add acceptance test for mixed permission save

* swap order to match form

* update copy

* make markdown changes

* fix y
2023-06-02 02:59:03 +00:00
Kit Haines
e63dc30507
Change from default_role to default_directory_policy (#20935)
* Change from default_role to default_directory_policy to allow future improvements.

* Helper functions

* Use the helper function and make fmt.

* Do not allow the zero-length role "".

* Semgrep doesn't like shadowing errors that are impossible to hit, so fix that.

* Add default to switch branches.

* Add/fix docs.

* Fix wrong requestedRole
2023-06-01 22:06:30 +00:00
Alexander Scheel
63ccb60b9a
Transit BYOK export capabilities (#20736)
* Add WrapKey capabilities to keysutil

This allows one keysutil to wrap another key, assuming that key has an
type matching one of keysutil's allowed KeyTypes. This allows completing
the BYOK import loop with Transit, allowing imported wrapping keys to
export (wrap) other keys in transit, without having them leave in
plaintext.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add /byok-export/:dst/:src[/:version] to Transit

Still respecting exportable, we allow encrypted-only export of transit
keys to another cluster using the BYOK semantics.

In particular, this allows an operator to securely establish key
material between two separate Transit installations. This potentially
allows one cluster to be used as a source cluster (encrypting a large
amount of data) and a second cluster to decrypt this data later. This
might be useful in hybrid or site-specific deployments of Vault for
instance.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add missing dependency to sdk/, vault/

Also updates to a newer version while we're here.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add documentation on BYOK export

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add tests for BYOK export/import

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add changelog entry

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Update website/content/api-docs/secret/transit.mdx

* Update builtin/logical/transit/path_byok.go

Co-authored-by: Matt Schultz <975680+schultz-is@users.noreply.github.com>

---------

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Matt Schultz <975680+schultz-is@users.noreply.github.com>
2023-05-30 21:42:41 +00:00