Commit Graph
41 Commits
Author SHA1 Message Date
Jeff Mitchell 253d79116c Swap id field in grants to ids since that's now standardized (#4250)
* Swap id field in grants to ids since that's now standardized

* Fix some tests I missed

* Update generated resource table
2024-01-17 23:54:49 -08:00
e49a84ce9c docs: Add connection workflow docs (#4034)
* docs: Add connection workflow docs

* docs: Update HCP connect to target topic

* docs: Update Overview topic and nav

* docs: Break out exec flag topic

* docs: Updates to connect helpers topic

* docs: Update exec flag and proxycommand topics

* docs: Fix broken link

* docs: Update meta content and get started topics

* docs: Redirect deleted proxycommand topic

* docs: Add links for HCP and self-managed tutorials

* docs: Add multi-hop

* adds CodeTabs and windows instructions

* Update website/content/docs/concepts/connection-workflows/workflow-ssh-proxycommand.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* removes windows workflow

---------

Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2023-12-13 13:58:10 -05:00
eea5e80fa2 Update documentation with new authenticate usage on the CLI (#2865)
* docs: update deploy-and-login getting started guide with new authenticate usage

* docs: update api-clients/cli.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/manage-users-groups.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/workflow-ssh-proxycommand.mdx with new short form usage of authenticate command when using the primary auth method in the global scope

* docs: update oss/installing/no-gen-resources.mdx to remove login-name usage in authenticate command

* docs: update oss/installing/run-and-login.mdx with short form usage of boundary authenticate

* docs: fix tabs

* docs: fix numbering

* Apply batch of suggestions from code review

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: fix code blocks

* fixes code blocks

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
2023-02-07 10:40:31 -05:00
Ashlee M Boyer e6be6431b2 docs: Migrate link formats (#2777)
* Adding docs-content-check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* Migrating links to new format
2023-01-20 15:17:34 -08:00
Jeff Mitchell f494a9b80a Update website with new password rules taken into account (#2330)
* Update website with new password rules taken into account

* Remove the prompt examples as it messes up copying
2022-08-09 17:46:25 -04:00
c05fa66096 Hashiconf docs changes (#2178)
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

Co-authored-by: XingLu Wang <95828202+xingluw@users.noreply.github.com>

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>

Co-authored-by: irenarindos <irena.rindos@gmail.com>

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>

Co-authored-by: Louis Ruch <louisruch@gmail.com>

Co-authored-by: XingLu Wang <xinglu.wang@hashicorp.com>

Co-authored-by: XingLu Wang <95828202+xingluw@users.noreply.github.com>
2022-06-22 02:37:49 -04:00
George Christou 3a7f12f0c3 doc: [ssh] Use %n for ProxyCommand (#1696) 2021-11-12 10:37:42 -05:00
Nico Vibert 05869a6f74 Update manage-targets.mdx (#1376)
Fixed typo (equivalient -> equivalent)
2021-07-28 11:50:27 -07:00
xuwhao ade67e6bb5 fixed typo: specifc -> specific, varibles -> variables, idomatic -> idiomatic. (#1421) 2021-07-27 19:36:42 -04:00
df35699c4e Integrate with Vault to retrieve and manage per session credentials (#1308)
* Fix down migrations

* Udpates due to merge

* Sentinel values only have to be greater than 0

* Create credential related sdk structs and methods.

* Post merge interface updating.

* Removing scratch code that was not cleaned up.

* updates

* Convert client certificate and client certificate keys into pem blocks and validate.

* Add newline at end of file.

* Faster check for "s" at the end of a resource name when generating from templates.

* make fmt

* updates

* Add dynamic credentials to a session

* Refactor: move contents of file

* updates

* Updates

* Add InvalidDynamicCredential error

* Assign credentials

* Allow updating client certificates seperate from the client certificate key.

* Replace application purpose string with enum value

* PR feedback / fix go test .

* Delete dead code

* Use common view

* Refactor: extract interface and rename method

* Refactor: move code to eliminate privPurpLibrary

* Add comment to requestMap

* Refactor: do not export methods on an unexported struct

* Update internal/db/schema/migrations/postgres/10/03_vault_credential.up.sql

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Add comments to credential Purpose constants

* Reorder switch statements to handle errors first

* PR feedback

* update

* fix merge

* Organizing the scheduler code and extract the individual store creation test helper function.

* Run 'make fmt'

* Create certificate when creating store.  Allow vault address to be passed in as option

* Refactor: rename database views and associated structs

This change renames two database views and associated go structs to use
a consistent naming pattern. Views ending in 'private' contain encrypted
credentials needed for connecting to Vault. Views ending in 'public'
mirror the 'private' views but do not include any encrypted values.

This change does not include any changes to functionality or behavior.

* Adding SAD target operations for credential libraries to the SDK.

* Add status field and enumeration table for credential status

* Refactor: rename Status to TokenStatus

* Add status to vault credentials

* Creating the template for the CLI and helper functions.

* Add private database view for vault credentials

* Add scope_id to view and cleanup TODO comment

* Reformat embedded sql queries

* Add vault client helpers

* updates

* white space

* Add LookupLease test

* CLI commands for Store work.  Renamed fields in proto w/ vault prefix.

* Test issue credentials with client TLS

* Add additional checks to vault ping

* Add an error for vault token capabilities and create a VaultToken error kind

* Add support for working with Vault policies

* Use Vault 1.7.2 for testing

* Add testing helper for creating a vault client with a non-root token

* Fix Vault renew lease test

The Vault renew lease endpoint accepts an optional duration parameter
for requesting the number of seconds to extend the lease by. However,
Vault is not required to honor this request.

* Add a var for the required capabilities of a boundary Vault token

* Enhance the test helper for adding a policy to Vault

* Allow the test role in postgresql to revoke credentials

* Remove out of date comments

* Enhance Vault test helpers for the database secrets engine

* Reformat comments

* Add a method for getting the capabilities of the current Vault token

* Add revoke lease to internal Vault client

* Reformat: combine err return line with check for nil line

* Remove redundant checks in test code

Remove checks in test code that are redundant with checks in the test
harness.

* Refactor CreateToken test helper to return the secret and the token

* Fix build failures caused by signature change in vault.CreateToken

* Fix Vault version and Vault API link in comments

* ran `make gen` after merging from mgaffney-vault.

* Remove Vault prefix from attribute fields in API, create a base CLI option for adding field prefixes. format now uses that prefix for error reporting.

* Template now allows attaching attribute field prefixes.

* Credential store uses PrefixAttributeFieldErrorsWithSubactionPrefix.

* Fixing naming of vault flags and helper flags.

* Updating more references to generated api methods.

* Make the capabilities String method more readable

* Add comment outlining PrintApiError usage of Options.

* Refactor test to move declarations closer to first use

* Fix comment

* Implement revoke method on vault repository

* Tests now verify certs, CA, and tokens, addresses can be updated in a store.

* Added test for creating store with pk/cert in same field.

* Allo updating certificates seperate from private key.  Only contact backing vault service when updating token.

* Fixing bad tests and removing unused code.

* Adding tests for various ways of updating tokens.

* Add private credential

* Add token revocation job and cred renewal/revocation job

* Regen after merge.

* Fixing field mask related merge error.

* Create Library CLI. Removes vault prefix from path. Adds a WithoutCleanup testOption for vault.

* Set all credentials to revoked when a token is revoked

* Fixing missed renaming update.

* fix copy/paste error.

* Fixing code generation errors after merge.

* make gen after merge.

* Update internal/cmd/commands/credentialstorescmd/vault_funcs.go

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Update internal/cmd/commands/credentialstorescmd/vault_funcs.go

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Update internal/cmd/commands/credentialstorescmd/vault_funcs.go

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Refactor: move migrations from 10 to 12

* Removing logic from transaction.

* wrapping client errors in the calling op for CredentialStore's client() method.

* Redact token

* redact client key

* updates

* Add trigger to revoke credentials when session is canceled or terminated

* Fixing some help text for some flags.

* Add ability to load values from files (file://) or environment variables (env://).

* Updating comments

* fix bad merge

* feedback

* Adding issued credentials to sessions.

* Error on capabilities

* updates

* Expose NewVaulTestServer

* Add godoc

* Adding generated SessionCredential struct for API.

* Progress on building handler test for Authorize Session.

* feedback

* Update policies

* Add 'revoke' as a status for Vault Tokens

* Add delete_time to vault credential store

* Create dynamic credentials at session creation time.

* Tests pass with credentials attached to AuthorizedSession result.

* Only call issue if there are credentials to issue.

* Fixing output only issues. Adding type to credential library.

* Fix test to clear un/pw generated.  confirm generated un/pw changes from 1 authorize session call to another.

* Update lookupTokenError

* Add delete_time to private credential store

* Refactor: move private store to separate file

* Fixing tests for AuthorizeSession and verifying error cases.

* Only create the credential repo if there are credentials to issue.

* Rename Library field to CredentialLibrary.

* Fixing missing change of Library to CredentialLibrary.

* Removing Default SDK functions for fields which are required and update CLI to match.

* Replace resource specific id variables with "id" and the input parmater for paths to be just a single string and the resource name as it should show up in the path.

* Soft delete vault credential stores

* Prevent new SQL functions from silently overwriting existing functions

* Rename "Hmac" to "HMAC" in the human readable cli response table.

* Fix tests

* Add vault database cleanup jobs

* Add ability to set the token period in the vault test harness

* updates

* Add not_null_columns func test

* remove unused struct

* Up no output timeout

* Validate current vault token on addr update

* Fix client cert change test

* add cert test

* Update revocation job where

* Fix comment

* Use Vault's default port in CLI help strings

* Remove down migrations

* Increase migration file numbers by 1

* Run make migrations

* Move migrations from 12 to 10

* Increase Circle CI timeout for acceptance tests

* Fix spelling mistake in error messages

* ASD cmds for Target and returning credentials to AuthSession request (#1338)

* Add Add/Set/Remove commands for libraries on Targets.  Return credentials on AuthorizeSession request.

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

Co-authored-by: Louis Ruch <louisruch@gmail.com>
Co-authored-by: Todd Knight <T.Alan.Knight@gmail.com>
Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2021-06-22 22:26:26 -04:00
Jeff Mitchell 054c0aa538 Update password generated account IDs (#1290) 2021-06-08 12:31:58 -04:00
Jeff Mitchell 727d1c7085 Add "no-op" action and use it as default for scope permissions (#1138)
Because of listing visibility, if no actions are assigned to a user for
an individual resource, it's excluded from the list. This is fine and
good. However, when we made a change in 0.2.0 to restrict the
information returned from listing for the anonymous user for scopes and
auth methods, it exposed the fact that because of the way this
visibility works we had to add `read` to scopes by default -- thereby
rather defeating the purpose of restricting what goes back to `u_anon`
requests.

The purpose of "no-op" is to never be used for real actions within the
API, but as something that can be granted to specifically enable
visibility for the targeted user. This makes the controls over list
visibility much more granular.
2021-04-23 10:13:37 -04:00
John Reese c096157cf9 Fix spelling errors found in the documentation (#1073) 2021-04-08 12:14:36 -04:00
Bryce Kalow bd8cc5464e feat(website): migrates nav data format and updates docs pages (#1049)
* migrates nav data format and updates docs pages

* removes sidebar_title from content files

* updates api docs to work with new format
2021-04-05 13:04:57 -04:00
Jeff MalnickandJeff Mitchell d9a6bd1a60 docs: add workflow for transparent usage of Boundary by SSH client (#796)
* docs: add workflow for transparent usage of Boundary by SSH client

Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2020-12-10 12:48:06 -08:00
Jeff Mitchell c33f4fe5d7 Fix old "boundary proxy" CLI example (#804)
Fixes #800
2020-11-30 12:41:33 -05:00
Susmitha Girumala 353360bbcf Update doc clickthrough videos for ui v0.1.2 changes (#789) 2020-11-16 16:01:29 -05:00
Susmitha Girumala 83e54fe088 doc: Update host set videos in "Manage Targets" to reflect v0.1.1 UI (#742) 2020-10-23 11:03:07 -07:00
Patrick Bernal 1c75a07cb3 fix typo (#712)
host_catalog_id was doubled in hcl code snippet.
2020-10-16 08:46:08 -07:00
Jeff Escalante eaa2de60a9 one more broken link (#673) 2020-10-14 08:22:05 -07:00
Jeff Mitchell 52a43b65b4 Update sessions and targets workflow docs (#659) 2020-10-13 12:37:13 -04:00
Jeff Mitchell 24754933cf Update users/groups workflow doc (#655) 2020-10-13 12:14:40 -04:00
Jeff Mitchell 1a6564db91 Update roles and scopes workflow docs (#656) 2020-10-13 12:14:26 -04:00
Jeff MalnickandPete Pacent f35da900b0 docs: fix the output in creating org roles (#654)
* docs: fix the output in creating org roles and remove the TF configurations not used by each section

* Fixing dead link and cli output typo

Co-authored-by: Pete Pacent <ppacent@hashicorp.com>
2020-10-13 08:50:28 -07:00
Jeff Mitchell 7129971e56 Update website docs to mostly move organization -> org (#652) 2020-10-13 10:47:32 -04:00
Todd Knight 2d66c3b192 Add Admin Console tab for viewing session info and cancelling. (#632) 2020-10-12 13:54:35 -07:00
19ff4b91ae Adding manage roles page to docs (#603)
* Adding manage roles page to docs

* Adding instructions for assigning principals and grants to a role

* adding terraform to assign principles example and assign grants example

* docs: add role clickthroughs and step-by-step instructions

* Removing old manage role screenshots for admin workflow

Co-authored-by: Pete Pacent <ppacent@hashicorp.com>
Co-authored-by: Randall Morey <randall@randallmorey.com>
2020-10-12 12:31:23 -07:00
Randall MoreyandSusmitha Girumala b1eead187c step-by-step admin console instructions with videos (#583)
* docs:  update step-by-step instructions in common workflows and add video placeholders for forthcoming clickthroughs

* docs: Link clickthrough videos to "Getting started > Run and Login" and "Common Workflows" sections

* style: make video a comfortable viewing size and visually distinguish from background

* docs: Fix "frist" typo to "first" under "Manage Scopes"

Co-authored-by: Susmitha Girumala <susmitha@hashicorp.com>
2020-10-09 15:01:51 -07:00
Kyle MacDonald e51ae7bc86 website: correct link to domain-model docs (#542) 2020-10-06 15:09:29 -07:00
Todd Knight 8e6e2fc735 Session Workflow use "connect" instead of "proxy" and fix few typos for other workflow docs. (#524) 2020-10-05 09:23:04 -07:00
Jeff Mitchell 9237d6f787 Rename authorize to authorize-session (#531)
As pointed out by Rob, this makes it clearer what the action actually
is. We were sort of torn on it before, but I've definitely come around
to it.
2020-10-05 11:02:23 -04:00
Jeff Mitchell 271da38765 Fix website build 2020-10-02 20:01:33 -04:00
Todd Knight e0285a00ea Document CLI commands for session management (#514)
* Documentation for how to manage sessions using the CLI.  UI is still a TODO.

* Removing TODO under the UI tab.
2020-10-01 09:39:34 -07:00
DevOps Rob 63dbf7cdc3 fixed sidebar typo (#510)
* fixed sidebar typo

* fixed remaining sidebar typo
2020-09-30 13:57:16 -07:00
Jeff Malnick cda345a00d docs: add friendly disclaimer about resource IDs to workflows (#509) 2020-09-30 13:03:47 -07:00
Jeff Malnick d9a68ff52b docs: add manage identities workflow (#490) 2020-09-30 11:09:12 -07:00
Todd Knight 39da242f38 Removing a few incorrect statements in the documentation. (#498) 2020-09-29 15:11:26 -07:00
Jeff Malnick ac3725bf89 Docs: Use tabs for workflows (#492)
* docs: use tabs for targets workflow

* docs: use tabs for scopes workflow
2020-09-29 09:24:47 -07:00
Jeff Malnick 1d1491dc9a docs: add managing scopes workflow (#489) 2020-09-29 06:31:42 -07:00
Jeff Malnick 5f939bff34 docs: add target workflow (#487) 2020-09-28 18:54:02 -07:00
Jeff Malnick f8d96a253f docs: add workflows outline (#486) 2020-09-28 18:40:23 -07:00