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

Highlight the JSON blocks appropriately

Browse Source
This commit is contained in:
Kovid Goyal 2022-08-11 06:46:42 +05:30
parent cd6882d21e
commit 78a5957863
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/rc_protocol.rst
View File

@ -7,13 +7,15 @@ form::
<ESC>P@kitty-cmd<JSON object><ESC>\ <ESC>P@kitty-cmd<JSON object><ESC>\
Where ``<ESC>`` is the byte ``0x1b``. The JSON object has the form:: Where ``<ESC>`` is the byte ``0x1b``. The JSON object has the form:
.. code-block:: json
{ {
"cmd": "command name", "cmd": "command name",
"version": <kitty version>, "version": "<kitty version>",
"no_response": <Optional Boolean>, "no_response": "<Optional Boolean>",
"payload": <Optional JSON object>, "payload": "<Optional JSON object>"
} }
The ``version`` above is an array of the form :code:`[0, 14, 2]`. If you are The ``version`` above is an array of the form :code:`[0, 14, 2]`. If you are
@ -54,13 +56,18 @@ timestamp more than 5 minutes from the current time are rejected. The command is
encrypted using AES-256-GCM in AEAD mode, with a symmetric key that is derived from the ECDH encrypted using AES-256-GCM in AEAD mode, with a symmetric key that is derived from the ECDH
key-pair by running the shared secret through SHA-256 hashing, once. An IV of key-pair by running the shared secret through SHA-256 hashing, once. An IV of
96 bits of CSRNG data is used. The tag for AEAD must be 128 bits long. A new 96 bits of CSRNG data is used. The tag for AEAD must be 128 bits long. A new
command is created that contains the fields:: command is created and transmitted that contains the fields:
.. code-block:: json
{
"version": "<kitty version>",
"iv": "base85 encoded IV",
"tag": "base85 encoded AEAD tag",
"pubkey": "base85 encoded ECDH public key of sender",
"enc_proto": "The first field from KITTY_PUBLIC_KEY, currently always 1",
"encrypted": "The original command encrypted and base85 encoded"
}
version: copied form the original command
iv: base85 encoded IV
tag: base85 encoded AEAD tag
pubkey: base85 encoded ECDH public key of sender
enc_proto: The first field from KITTY_PUBLIC_KEY, currently always ``1``
encrypted: The original command encrypted and base85 encoded
.. include:: generated/rc.rst .. include:: generated/rc.rst