KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor updates to file transfer protocol docs

Browse Source
This commit is contained in:
Kovid Goyal 2021-11-23 22:28:18 +05:30
parent c44b5bb03f
commit ec28bd93c3
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/file-transfer-protocol.rst
View File

@ -294,7 +294,7 @@ Similarly when receiving files from the terminal emulator, the final file
command that the client sends to the terminal requesting the start of the command that the client sends to the terminal requesting the start of the
transfer of data for the file can include the ``compression`` key:: transfer of data for the file can include the ``compression`` key::
→ action=file id=someid file_id=f1 name=/some/path → action=file id=someid file_id=f1 name=/some/path compression=zlib
.. _bypass_auth: .. _bypass_auth:
@ -319,12 +319,11 @@ The value of ``bypass`` is of the form ``hash_function_name : hash_value``
(without spaces). Currently, only the SHA256 hash function is supported. (without spaces). Currently, only the SHA256 hash function is supported.
.. warning:: .. warning::
Hashing does not hide the value of the password. So this functionality Hashing does not effectively hide the value of the password. So this
should only be used in secure/trusted contexts. While there exist hash functionality should only be used in secure/trusted contexts. While there
functions harder to compute than SHA256, they are unsuitable as they will exist hash functions harder to compute than SHA256, they are unsuitable as
introduce a lot of latency to starting a session and in any case there is they will introduce a lot of latency to starting a session and in any case
no mathematical proof that **any** hash function is actually not there is no mathematical proof that **any** hash function is not brute-forceable.
brute-forceable.
Encoding of transfer commands as escape codes Encoding of transfer commands as escape codes
------------------------------------------------ ------------------------------------------------