Skip to content

Commit f8548d5

Browse files
committed
Correct the description of the greeting
Resolves #2467
1 parent f6dfc99 commit f8548d5

File tree

2 files changed

+43
-32
lines changed

2 files changed

+43
-32
lines changed

doc/dev_guide/internals/iproto/authentication.rst

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,35 @@
1+
.. _box_protocol-authentication:
2+
13
Authentication
24
==============
35

4-
.. _box_protocol-authentication:
5-
66
Greeting message
77
----------------
88

99
When a client connects to the server instance, the instance responds with
10-
a 128-byte text greeting message, not in MsgPack format: |br|
11-
64-byte Greeting text line 1 |br|
12-
64-byte Greeting text line 2 |br|
13-
44-byte base64-encoded salt |br|
14-
20-byte NULL
10+
a 128-byte text greeting message, not in MsgPack format:
11+
12+
.. code-block:: none
13+
14+
Tarantool <version> (<protocol>) <instance-uuid>
15+
<salt>
16+
17+
For example:
18+
19+
.. code-block:: none
20+
21+
Tarantool 2.10.0 (Binary) 29b74bed-fdc5-454c-a828-1d4bf42c639a
22+
QK2HoFZGXTXBq2vFj7soCsHqTo6PGTF575ssUBAJLAI=
1523
1624
The greeting contains two 64-byte lines of ASCII text.
17-
Each line ends with a newline character (:code:`\n`). The first line contains
18-
the instance version and protocol type. The second line contains up to 44 bytes
19-
of base64-encoded random string, to use in the authentication packet, and ends
20-
with up to 23 spaces.
21-
22-
Part of the greeting is a base64-encoded session salt -
23-
a random string which can be used for authentication. The maximum length of an encoded
24-
salt (44 bytes) is more than the amount necessary to create the authentication
25-
message. An excess is reserved for future authentication
26-
schemas.
25+
Each line ends with a newline character (:code:`\n`). If the line content is less than 64 bytes long,
26+
the rest of the line is filled up with symbols with an ASCII code of 0 that aren't displayed in the console.
27+
28+
The first line contains
29+
the instance version and protocol type. The second line contains the session salt --
30+
a base64-encoded random string, which is usually 44 bytes long.
31+
The salt is used in the authentication packet.
32+
2733

2834
Authentication is optional -- if it is skipped, then the session user is ``'guest'``
2935
(the ``'guest'`` user does not need a password).

locale/ru/LC_MESSAGES/dev_guide/internals/iproto/authentication.po

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,33 @@ msgstr "Приветствие"
77

88
msgid ""
99
"When a client connects to the server instance, the instance responds with a "
10-
"128-byte text greeting message, not in MsgPack format: |br| 64-byte Greeting"
11-
" text line 1 |br| 64-byte Greeting text line 2 |br| 44-byte base64-encoded "
12-
"salt |br| 20-byte NULL"
10+
"128-byte text greeting message, not in MsgPack format:"
1311
msgstr ""
1412
"Когда клиент подключается к экземпляру сервера, тот выдает в ответе "
15-
"128-байтовое текстовое сообщение приветствия не в формате MsgPack: |br| 64 "
16-
"байта — строка 1 текста приветствия |br| 64 байта — строка 2 текста "
17-
"приветствия |br| 44 байта —закодированное в формате base-64 значение соль "
18-
"|br| 20 байтов — NULL"
13+
"128-байтовое текстовое сообщение приветствия не в формате MsgPack:"
14+
15+
16+
msgid "For example:"
17+
msgstr "Пример:"
1918

2019
msgid ""
2120
"The greeting contains two 64-byte lines of ASCII text. Each line ends with a"
22-
" newline character (:code:`\\n`). The first line contains the instance "
23-
"version and protocol type. The second line contains up to 44 bytes of "
24-
"base64-encoded random string, to use in the authentication packet, and ends "
25-
"with up to 23 spaces."
21+
" newline character (:code:`\\n`). If the line content is less than 64 bytes long,"
22+
" the rest of the line is filled up with symbols with an ASCII code of 0 that aren't displayed in the console."
2623
msgstr ""
2724
"Приветствие содержит две 64-байтные строки текста в формате ASCII. Каждая "
28-
"строка заканчивается символом разрыва строки (:code:`\\n`). Первая строка "
29-
"описывает версию экземпляра и тип протокола. Вторая строка содержит "
30-
"случайную строку в кодировке base-64 размером до 44 байтов для использования"
31-
" в пакете аутентификации и заканчивается на пробелы (до 23)."
25+
"строка заканчивается символом разрыва строки (:code:`\\n`). Если длина содержимого строки "
26+
"менее 64 байтов, то оставшееся место заполняется символами с ASCII-кодом 0. "
27+
"В консоли эти символы не отображаются."
28+
29+
msgid "The first line contains the instance "
30+
"version and protocol type. The second line contains the session salt -- "
31+
"a base64-encoded random string, which is usually 44 bytes long."
32+
" The salt is used in the authentication packet."
33+
msgstr "Первая строка "
34+
"описывает версию экземпляра и тип протокола. Вторая строка содержит соль сеанса -- "
35+
"случайную строку в кодировке base-64, обычно длиной 44 байта. Соль используется "
36+
"в пакете аутентификации."
3237

3338
msgid ""
3439
"Part of the greeting is a base64-encoded session salt - a random string "

0 commit comments

Comments
 (0)