Skip to content

Commit

Permalink
GUACAMOLE-1643: Merge documentation for KSM user- and connection grou…
Browse files Browse the repository at this point in the history
…p-level configuration.
  • Loading branch information
mike-jumper committed Aug 27, 2024
2 parents 0288b59 + 4fca6b8 commit f41d101
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions src/vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ question should be able to access.

![Application creation confirmation dialog showing the generated one-time token.](images/vault-ksm-004-generate-token.png)

This token can be used to generate a base64-encoded configuration blob as
described in the following step, or it can be used directly to set a KSM
config for a user or connection, as described in [the following section](guac-vault-config).

5. Copy the provided one-time token using [the KSM CLI tool](https://docs.keeper.io/secrets-manager/secrets-manager/secrets-manager-command-line-interface/init-command)
to obtain the base64-encoded configuration that must be provided to
Guacamole with [the `ksm-config` property](guac-vault-config). **This token
Expand Down Expand Up @@ -170,6 +174,29 @@ All other configuration properties are optional.
secret. This is optional, and by default it is false - domains will
not be stripped from the username.

`ksm-allow-user-config`
: Whether or not users should be allowed to set their own KSM configuration,
which will be used to pull secrets _only_ when not already provided by the
global or connection-group-level KSM configuration. I.E. a user-level KSM
configuration will never be used if a matching secret is otherwise available.

#### User and Connection Group KSM Configuration

In addition to the required global `ksm-config` configuration blob, Guacamole
can also be configured with user or connection group KSM configuration, which
will pull additional secrets _only_ when not already available. If a secret can
be pulled using the `ksm-config` global KSM config, it will always be used.
Failing that, if a secret is available using the connection grop config, that
value will be used. Only when neither the global or containing connection group
KSM configs define a secret will the user KSM config be used. Note also that
user KSM configs will be disabled unless the global `ksm-allow-user-config` and
per-connection `ksm-user-config-enabled` attribute are both set to true.

These KSM config values can be set directly in the webapp, on the [connection
group edit page](connection-group-management), and on the [user preferences page](preferences).
Unlike the `ksm-config` global configuration, either the base64-encoded configuration
provided by Keeper Commander can be used, or the one-time token can be used directly.

(completing-vault-install)=

### Completing the installation
Expand Down

0 comments on commit f41d101

Please sign in to comment.