-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update moderated sessions guide
Moderated sessions are a bit confusing because we combined an existing OSS feature (joining sessions), with an Enterprise-only feature (requiring session join policies). I've expanded the scope of the moderated sessions guide to make it a "joining sessions" guide instead, and added some extra details around RBAC for active sessions. Updates #51116
- Loading branch information
Showing
10 changed files
with
258 additions
and
290 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
373 changes: 173 additions & 200 deletions
373
...ss-controls/guides/moderated-sessions.mdx → ...cess-controls/guides/joining-sessions.mdx
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,7 +37,7 @@ After a user completes an SSO authentication flow, Teleport creates a temporary | |
When a user signs in to Teleport with `tsh login`, they can configure the TTL of | ||
the `user` Teleport creates. Teleport enforces a limit of 30 hours (the default | ||
is 12 hours). | ||
|
||
In the Teleport audit log, you will see an event of type `user.create` with | ||
information about the temporary user. | ||
|
||
|
@@ -145,7 +145,7 @@ $ ssh-keygen -L -f ~/.tsh/keys/${TELEPORT_CLUSTER}/${SSO_USER}-ssh/${TELEPORT_CL | |
Since Teleport creates temporary users and issues short-lived certificates when | ||
a user authenticates via SSO, it is straightforward to integrate Teleport with | ||
multiple SSO providers. Besides the temporary `user` resource, no persistent | ||
backend data in Teleport is tied to a user's account with the SSO provider. | ||
backend data in Teleport is tied to a user's account with the SSO provider. | ||
|
||
This also means that if one SSO provider becomes unavailable, the end user only | ||
needs to choose another SSO provider when signing in to Teleport. While the | ||
|
@@ -187,7 +187,7 @@ The callback address can be changed if calling back to a remote machine | |
instead of the local machine is required: | ||
|
||
```code | ||
# --bind-addr sets the host and port tsh will listen on, and --callback changes | ||
# --bind-addr sets the host and port tsh will listen on, and --callback changes | ||
# what link is displayed to the user | ||
$ tsh login --proxy=proxy.example.com --auth=github --bind-addr=localhost:1234 --callback https://remote.machine:1234 | ||
``` | ||
|
@@ -294,7 +294,7 @@ GitHub as an SSO option. | |
(!docs/pages/includes/sso/saml-slo.mdx!) | ||
|
||
You may use `entity_descriptor_url` in lieu of `entity_descriptor` to fetch | ||
the entity descriptor from your IDP. | ||
the entity descriptor from your IDP. | ||
|
||
We recommend "pinning" the entity descriptor by including the XML rather than | ||
fetching from a URL. | ||
|
@@ -307,7 +307,7 @@ fetching from a URL. | |
``` | ||
|
||
You may use `entity_descriptor_url`, in lieu of `entity_descriptor`, to fetch | ||
the entity descriptor from your IDP. | ||
the entity descriptor from your IDP. | ||
|
||
We recommend "pinning" the entity descriptor by including the XML rather than | ||
fetching from a URL. | ||
|
@@ -334,7 +334,7 @@ fetching from a URL. | |
``` | ||
|
||
You may use `entity_descriptor_url`, in lieu of `entity_descriptor`, to fetch | ||
the entity descriptor from your IDP. | ||
the entity descriptor from your IDP. | ||
|
||
We recommend "pinning" the entity descriptor by including the XML rather than | ||
fetching from a URL. | ||
|
@@ -351,7 +351,7 @@ fetching from a URL. | |
(!docs/pages/includes/sso/saml-slo.mdx!) | ||
|
||
You may use `entity_descriptor_url`, in lieu of `entity_descriptor`, to fetch | ||
the entity descriptor from your IDP. | ||
the entity descriptor from your IDP. | ||
|
||
We recommend "pinning" the entity descriptor by including the XML rather than | ||
fetching from a URL. | ||
|
@@ -366,7 +366,7 @@ fetching from a URL. | |
</TabItem> | ||
</Tabs> | ||
|
||
Create the connector: | ||
Create the connector: | ||
|
||
```code | ||
$ tctl create -f connector.yaml | ||
|
@@ -413,13 +413,13 @@ At this time, the `spec.provider` field should not be set for any other identity | |
|
||
## Configuring SSO for MFA checks | ||
|
||
Teleport administrators can configure Teleport to delegate MFA checks to an | ||
Teleport administrators can configure Teleport to delegate MFA checks to an | ||
SSO provider as an alternative to registering MFA devices directly with the Teleport cluster. | ||
This allows Teleport users to use MFA devices and custom flows configured in the SSO provider | ||
to carry out privileged actions in Teleport, such as: | ||
|
||
- [Per-session MFA](../guides/per-session-mfa.mdx) | ||
- [Moderated sessions](../guides/moderated-sessions.mdx) | ||
- [Moderated sessions](../guides/joining-sessions.mdx) | ||
- [Admin actions](../guides/mfa-for-admin-actions.mdx) | ||
|
||
Administrators may want to consider enabling this feature in order to: | ||
|
@@ -434,8 +434,8 @@ Administrators may want to consider enabling this feature in order to: | |
|
||
### Configure the IDP App / Client | ||
|
||
There is no standardized MFA flow unlike there is with SAML/OIDC | ||
login, so each IDP may offer zero, one, or more ways to offer MFA checks. | ||
There is no standardized MFA flow unlike there is with SAML/OIDC | ||
login, so each IDP may offer zero, one, or more ways to offer MFA checks. | ||
|
||
Generally, these offerings will fall under one of the following cases: | ||
|
||
|
@@ -448,7 +448,7 @@ which prompts for MFA for an active OIDC session. | |
2. Use the same IDP app for MFA: | ||
|
||
Some IDPs provide a way to fork to different flows using the same IDP app. | ||
For example, with Okta (OIDC), you can provide `acr_values: ["phr"]` to | ||
For example, with Okta (OIDC), you can provide `acr_values: ["phr"]` to | ||
[enforce phishing resistant authentication](https://developer.okta.com/docs/guides/step-up-authentication/main/#predefined-parameter-values). | ||
|
||
For a simpler approach, you could use the same IDP app for both login and MFA | ||
|
@@ -483,15 +483,15 @@ and add MFA settings. | |
``` | ||
|
||
You may use `entity_descriptor_url` in lieu of `entity_descriptor` to fetch | ||
the entity descriptor from your IDP. | ||
the entity descriptor from your IDP. | ||
|
||
We recommend "pinning" the entity descriptor by including the XML rather than | ||
fetching from a URL. | ||
|
||
</TabItem> | ||
</Tabs> | ||
|
||
Update the connector: | ||
Update the connector: | ||
|
||
```code | ||
$ tctl create -f connector.yaml | ||
|
@@ -525,7 +525,7 @@ spec: | |
|
||
Along with sending groups, an SSO provider will also provide a user's email address. | ||
In many organizations, the username that a person uses to log in to a system is the | ||
same as the first part of their email address, the "local" part. | ||
same as the first part of their email address, the "local" part. | ||
|
||
For example, `[email protected]` might log in with the username `dave.smith`. | ||
Teleport provides an easy way to extract the first part of an email address so | ||
|
@@ -673,4 +673,3 @@ which Teleport replaces with values from the single sign-on provider that the | |
user used to authenticate with Teleport. For full details on how variable | ||
expansion works in Teleport roles, see the [Teleport Access Controls | ||
Reference](../../../reference/access-controls/roles.mdx). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.