254 Commits

Author SHA1 Message Date
Robert
3726d8fb1d
Add configuration section to sync API docs (#24179)
* Add configuration section

* Add restricted root namespace alert
2023-11-27 16:10:37 -06:00
Steven Clark
b7dff9777d
Allow backends to extract credentials from payloads and trigger an authentication workflow (#23924)
* wip

* Work on the tuneable allowance and some bugs

* Call handleCancellableRequest instead, which gets the audit order more correct and includes the preauth response

* Get rid of no longer needed operation

* Phew, this wasn't necessary

* Add auth error handling by the backend, and fix a bug with handleInvalidCredentials

* Cleanup req/resp naming

* Use the new form, and data

* Discovered that tokens werent really being checked because isLoginRequest returns true for the re-request into the backend, when it shouldnt

* Add a few more checks in the delegated request handler for bad inputs

 - Protect the delegated handler from bad inputs from the backend such
   as an empty accessor, a path that isn't registered as a login request
 - Add similar protections for bad auth results as we do in the normal
   login request paths. Technically not 100% needed but if somehow the
   handleCancelableRequest doesn't use the handleLoginRequest code path
   we could get into trouble in the future
 - Add delegated-auth-accessors flag to the secrets tune command and
   api-docs

* Unit tests and some small fixes

* Remove transit preauth test, rely on unit tests

* Cleanup and add a little more commentary in tests

* Fix typos, add another failure use-case which we reference a disabled auth mount

* PR Feedback

 - Use router to lookup mount instead of defining a new lookup method
 - Enforce auth table types and namespace when mount is found
 - Define a type alias for the handleInvalidCreds
 - Fix typos/grammar
 - Clean up globals in test

* Additional PR feedback

 - Add test for delegated auth handler
 - Force batch token usage
 - Add a test to validate failures if a non-batch token is used
 - Check for Data member being nil in test cases

* Update failure error message around requiring batch tokens

* Trap MFA requests

* Reword some error messages

* Add test and fixes for delegated response wrapping

* Move MFA test to dedicated mount

 - If the delegated auth tests were running in parallel, the MFA test
   case might influence the other tests, so move the MFA to a dedicated
   mount

* PR feedback: use textproto.CanonicalMIMEHeaderKey

 - Change the X-Vault-Wrap-Ttl constant to X-Vault-Wrap-TTL
   and use textproto.CanonicalMIMEHeaderKey to format it
   within the delete call.
 - This protects the code around changes of the constant typing

* PR feedback

 - Append Error to RequestDelegatedAuth
 - Force error interface impl through explicit nil var assignment on
   RequestDelegatedAuthError
 - Clean up test factory and leverage NewTestSoloCluster
 - Leverage newer maps.Clone as this is 1.16 only

---------

Co-authored-by: Scott G. Miller <smiller@hashicorp.com>
2023-11-21 14:36:49 -05:00
Max Coulombe
af46b954f6
Document secrets sync LIST request modifications (#23975)
* * document list request adjustments

---------

Co-authored-by: Robert <17119716+robmonte@users.noreply.github.com>
2023-11-10 09:04:26 -05:00
Steven Clark
750ab337ea
Add missing allowed_managed_key param to mount creation doc (#23948)
- We had updated the mount tune api, but missed it within the
   creation api docs
2023-11-02 08:26:00 -04:00
Raymond Ho
2c8dea8733
remove subscription id in docs (#23923) 2023-10-31 15:17:57 -07:00
Marc Boudreau
550c99ae3b
VAULT-20669: Add New Authenticated Endpoint for Version (#23740)
* add sys/internal/ui/version path

* add read capability for sys/internal/ui/version in default policy

* add changelog file

* doc: add api-docs page for sys/internal/ui/version

* add godoc for pathInternalUIVersion function

* add tests for functions in version package

* remove unreachable code

* use closure to restore version at end of test function

* use an example version in sample response

* Update website/content/api-docs/system/internal-ui-version.mdx

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

* Apply suggestions from code review

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

* Update website/content/api-docs/system/internal-ui-version.mdx

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

* add copyright header to version_test.go

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-10-26 12:52:52 -04:00
claire bontempo
db4819427a
docs/add line separators to curl requests secrets sync (#23681)
* add line separators to curl requests

* revert unsync change
2023-10-23 08:29:26 -07:00
Brian Scholer
a0a150b7f1
Update step-down.mdx to describe behavior against non-active nodes (#23657)
* Update step-down.mdx to describe behavior against non-active nodes

Behavior changed in Vault 1.9:
https://developer.hashicorp.com/vault/docs/v1.9.x/commands/operator/step-down
2023-10-18 19:33:46 -07:00
claire bontempo
676ed96a6c
minor doc fixes (#23656) 2023-10-13 21:55:19 -04:00
claire bontempo
9197f002eb
fix repository typo (#23654) 2023-10-13 13:39:31 -07:00
Skybladev2
a485837cb6
Add method and path for Read the client count configuration (#23551) 2023-10-12 10:10:04 -04:00
Sarah Chavis
1b7b5a1c6e
Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
Skybladev2
ec026ad2ce
Remove asterixes in header (#23548) 2023-10-09 13:03:54 -07:00
Max Coulombe
acf0736590
Slight rephrase for the association API endpoints (#23393)
* slight rephrase for the association API endpoints
---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-10-05 14:53:21 -04:00
Sarah Chavis
8ee4b1e1d0
[DOCS] Confirm restricted endpoint alerts (main) (#23514)
* Make sure includes are fully correct
* Remove duplicates and sort A-Z
2023-10-05 13:00:40 -04:00
Hamid Ghaf
305d6d9b67
merkle corruption checker docs (#22971)
* merkle corruption checker docs

* doc link fix

* fix the link again

* Update website/content/api-docs/system/replication/index.mdx

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>

* feedback

* Apply suggestions from code review

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

---------

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-09-28 15:11:16 -07:00
Thy Ton
98e9d0c95e
add API docs for plugin runtimes (#23223)
Co-authored-by: Tom Proctor <tomhjp@users.noreply.github.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-09-28 05:35:22 +00:00
Kuba Wieczorek
6685565b7e
[VAULT-20073] Docs: update docs on Sentinel RGP group policy application (#23292)
Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
Co-authored-by: Peter Wilson <peter.wilson@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-09-27 21:38:29 +01:00
Sarah Chavis
827bb275be
[DOCS] Fix restricted endpoint info (#23333)
* Update restricted API list and alert tags
* add cli commands w/o public endpoints
2023-09-27 20:31:00 +00:00
Max Coulombe
7106e6c22f
* fix remove endpoint doc (#23329) 2023-09-27 15:40:07 -04:00
Max Coulombe
03732eb158
Secrets-Sync/vault-18673-documentation (#23189)
* secrets sync initial documentation for beta version

Co-authored-by: vinay-gopalan <86625824+vinay-gopalan@users.noreply.github.com>
Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com>
Co-authored-by: robmonte <17119716+robmonte@users.noreply.github.com>
Co-authored-by: vinay-gopalan <86625824+vinay-gopalan@users.noreply.github.com>
Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
Co-authored-by: Raymond Ho <raymond.ho@hashicorp.com>
2023-09-27 08:56:39 -04:00
Scott Miller
036cbcebd9
First draft of Seal HA documentation (#23252)
* wip

* Initial draft of Seal HA docs

* nav data

* Fix env var name

* title

* Note partially wrapped values and disabled seal participation

* Update website/data/docs-nav-data.json

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

* correct initial upgrade limitation

* Add note about shamir seals and migration

* fix nav json

* snapshot note

* availability note

* seal-backend-status

* Add a couple more clarifying statements

* header typo

* correct initial upgrade wording

* Update website/content/docs/configuration/seal/seal-ha.mdx

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

* Update website/content/docs/concepts/seal.mdx

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

---------

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2023-09-22 13:18:48 -05:00
Sarah Chavis
1996c186df
[DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
divyaac
6ef2a60314
Added patch (#23206) 2023-09-20 18:25:21 -07:00
Bianca Moreira
1d72ac5278
Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
Josh Black
dbf094940f
Add more docs for update-primary (#22677)
* add more docs for update-primary

* Update website/content/api-docs/system/replication/replication-dr.mdx

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

* Update website/content/api-docs/system/replication/replication-dr.mdx

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

* Update website/content/api-docs/system/replication/replication-dr.mdx

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

* Update website/content/api-docs/system/replication/replication-performance.mdx

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

* Update website/content/api-docs/system/replication/replication-performance.mdx

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

* PR feedback

* Apply suggestions from code review

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

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-09-01 12:42:46 -07:00
Sean Ellefson
2b626eae18
Correcting method from GET to LIST (#22649) 2023-08-30 11:03:23 -07:00
Bianca Moreira
cf43d3eeed
Add administrative namespace docs (#22581)
* Add administrative namespace section to namespaces docs
* Tag sys endpoints with restricted admin alert
---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-08-30 09:31:53 -07:00
Sarah Chavis
04fc15471b
Update alert partials and files that include them (#22556) 2023-08-24 15:30:17 -07:00
divyaac
edbaac3920
Added lease quota count and rate limit count docs (#22509)
* Added lease quota count and rate limit count docs

* Update website/content/api-docs/system/lease-count-quotas.mdx

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>

* Edited docs

* Update website/content/api-docs/system/lease-count-quotas.mdx

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

* Update website/content/api-docs/system/lease-count-quotas.mdx

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

* Update website/content/api-docs/system/rate-limit-quotas.mdx

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

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-08-23 16:40:29 -07:00
Josh Black
d50bd4eb05
OSS changes for https://github.com/hashicorp/vault-enterprise/pull/4254 (#22482) 2023-08-21 15:03:44 -07:00
ssurana90
4ff9fb3fd3
adding explanation for allow_store_key flag , based on internal engineering conversation. (#17258) 2023-08-17 16:00:38 -07:00
Sarah Chavis
91face4eff
convert OSS language to "community" (#22343) 2023-08-15 13:31:52 -04:00
Violet Hynes
c6bd2db5b0
Improve docs around enable_rate_limit_response_headers (#22302) 2023-08-11 13:43:28 -04:00
Sarah Chavis
b6d973a133
Make enterprise callouts consistent (#22073) 2023-07-27 17:41:14 +00:00
Josh Black
d407078766
Don't allow setting dead server last contact threshold to less than 1 minute (#22040)
* Don't allow setting dead server last contact threshold to less than 1 minute

* add changelog

* document the minimum dead server last contact threshold
2023-07-25 20:46:52 +00:00
Max Winslow
03ba365032
fix sys/raft doc headings (#21591)
* fix sys/raft doc headings

* Update website/content/api-docs/system/storage/raftautosnapshots.mdx

Co-authored-by: Mike Palmiotto <mike@p4lm.io>

---------

Co-authored-by: Mike Palmiotto <mike@p4lm.io>
2023-07-13 15:49:10 +01:00
Jason O'Donnell
237b9f7140
Add documentation for DR reindex endpoint (#21446)
* Add dr reindex doc

* Format
2023-07-07 11:36:38 -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
Josh Black
0ff9059967
OSS changes for fixing bug in update-primary (#21119) 2023-06-09 14:35:41 -07:00
Peter Wilson
676d1c69fe
Docs: audit - add warning when disabling device regarding HMAC (#20715)
* added note to warn of potential issues in disabling audit when using HMAC

* added to command docs pages too
2023-05-23 14:55:55 +01:00
Mike Palmiotto
810d504e4f
Add current_billing_period activity endpoint param (#20694)
* Add current_billing_period activity endpoint param

This commit introduces a new parameter: `current_billing_period`, which
can be used in lieu of `start_time` and `end_time` options.

GET ... /sys/internal/counters/activity?current_billing_period=true now
results in a response which contains the full billing period
information.

* changelog

* Update internal counters docs
2023-05-22 09:22:45 -04:00
l-with
167def69d9
Add possibility to decode generated encoded root token to api (#20595) 2023-05-18 15:18:19 -04:00
Josh Black
cf2f527c85
Clarify origin of ID parameter for path filter creation (#20415)
* Clarify origin of ID parameter for path filter creation

* add additional note

* add additional info
2023-05-01 08:34:03 -07:00
Josh Black
299fe6996c
Correct an oversight re: skip_flush in the docs (#20383) 2023-04-26 17:30:09 -07:00
Brian Shumate
2532fd55fa
Docs: DR replication API updates (#20373)
* Docs: DR replication API updates

- Add clarification for secondary_public_key parameter
- Update section header

* During activation
2023-04-26 16:15:46 -07:00
Josh Black
5ada399581
update website docs for new update-primary mode (#20302) 2023-04-21 15:21:28 -07:00
Yura Shutkin
b930010ae2
Update wrapping-unwrap.mdx (#20109)
* Update wrapping-unwrap.mdx

It is possible to unwrap data without authentication in Vault. I've added an example of a curl request.

* Add changelog record
2023-04-18 14:20:27 -07:00
Matt Schultz
fc783b00ab
Update docs to include specifics and caveats around Transit Managed Keys support. (#20099) 2023-04-12 12:19:25 -05:00
Mike Palmiotto
05ba6bbddd
api: Add reporting fields to activitylog config endpoint (#20086)
This PR adds the internal reporting state to the
`internal/counters/config` read endpoint:
* reporting_enabled
* billing_start_timestamp
2023-04-12 12:02:28 -04:00