Skip to content

[docs] Include File Transfers in moderated sessions docs #26032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avatus merged 7 commits into from
May 15, 2023
Merged

[docs] Include File Transfers in moderated sessions docs #26032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
05f19f1
[docs] Include File Transfers in moderated sessions docs
avatus May 10, 2023
5af36cf
Fix typo
avatus May 10, 2023
28862c5
Add note in tsh scp reference
avatus May 12, 2023
2615b3e
Update docs/pages/access-controls/guides/moderated-sessions.mdx
avatus May 12, 2023
f1827e0
Add screenshot
avatus May 12, 2023
54d6bb6
Update docs/pages/access-controls/guides/moderated-sessions.mdx
avatus May 12, 2023
70746a9
Update moderated-sessions.mdx
avatus May 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/pages/access-controls/guides/moderated-sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,24 @@ comma-separated list of usernames.
This information can be picked up by a third party integration and may for
example be used to enable notifications over some external communication system.

## File transfers

File transfers within moderated sessions are available via the Web UI only. When initiating a file transfer, if the
current active session requires moderation, a file transfer request will automatically be sent to all current party members.

Both the session originator and the moderator(s) must be present in the Web UI during the file transfer initiation to receive
the file transfer request notification. Once the file transfer has been requested, all members of the party will be notified
and prompted with an Approve/Deny dialog.

![Approve/Deny Prompt](https://github.com/gravitational/teleport/assets/5201977/49e11b8c-4729-42b4-a83c-9db7dfa25b74)


If a moderator denies the file transfer request, the request is immediately removed and all party members are notified.

After enough approvals have been given to satisfy the policy (the same policy to start the session), the file transfer
will automatically begin.


Copy link
Copy Markdown
Collaborator

@zmb3 zmb3 May 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might also make sense to have an FAQ or troubleshooting page with what happens when you try to tsh scp when moderation is required.

Copy link
Copy Markdown
Contributor Author

@avatus avatus May 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, will add!

Copy link
Copy Markdown
Contributor

@stevenGravy stevenGravy May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

having some screen shots would be an added bonus.

Copy link
Copy Markdown
Contributor

@stevenGravy stevenGravy May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are file approve/denies logged as audit log entries? good to note if they are.

Copy link
Copy Markdown
Contributor Author

@avatus avatus May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not yet, have an upcoming PR that will add the audit logs and will update the docs then. The file transfer itself is still audited as usual

## RFD

- [Moderated Sessions](https://github.com/gravitational/teleport/blob/master/rfd/0043-kubeaccess-multiparty.md)
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/reference/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -829,6 +829,9 @@ Run `tsh help <subcommand>` or see the [Global Flags section](#tsh-global-flags)
```code
$ tsh --proxy=proxy.example.com scp example.txt user@host:/destination/dir
```
<Admonition type="note">
`tsh scp` will not work from the CLI if the user requires session moderation. You can transfer files in a moderated session by joining the SSH session from the Web UI and requesting the file transfer there. Both the session initiator and moderators must be present in the Web UI in order to approve the file transfer request.
</Admonition>

### tsh ls

Expand Down