torproject/torspec
1
0
Fork 0
mirror of https://github.com/torproject/torspec.git synced 2024-11-23 17:59:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'tor-github/pr/81'

Browse Source
This commit is contained in:
David Goulet 2019-11-19 09:31:31 -05:00
commit 03958da61f
1 changed files with 82 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
control-spec.txt
View File

@ -1817,7 +1817,88 @@
[HSPOST was added in Tor 0.2.7.1-alpha]
3.23. DROPOWNERSHIP
3.30. ONION_CLIENT_AUTH_ADD
The syntax is:
"ONION_CLIENT_AUTH_ADD" SP HSAddress
SP KeyType ":" PrivateKeyBlob
[SP "ClientName=" Nickname]
[SP "Flags=" TYPE] CRLF
HSAddress = 56*Base32Character
KeyType = "x25519" is the only one supported right now
PrivateKeyBlob = base64 encoding of x25519 key
Tells the connected Tor to add client-side v3 client auth credentials for the
onion service with "HSAddress". The "PrivateKeyBlob" is the x25519 private
key that should be used for this client, and "Nickname" is an optional
nickname for the client.
FLAGS is a comma-separated tuple of flags for this new client. For now, the
currently supported flags are:
"Permanent" - This client's credentials should be stored in the filesystem.
If this is not set, the client's credentials are epheremal
and stored in memory.
If client auth credentials already existed for this service, replace them
with the new ones.
If Tor has cached onion service descriptors that it has been unable to
decrypt in the past (due to lack of client auth credentials), attempt to
decrypt those descriptors as soon as this command succeeds.
On success, "250 OK" is returned. Otherwise, the following error codes exist:
251 - Client auth credentials for this onion service already existed and replaced.
252 - Added client auth credentials and successfully decrypted a cached descriptor.
512 - Syntax error in "HSAddress", or "PrivateKeyBlob" or "Nickname"
551 - Client with with this "Nickname" already exists
552 - Unrecognized KeyType
3.31. ONION_CLIENT_AUTH_REMOVE
The syntax is:
"ONION_CLIENT_AUTH_REMOVE" SP HSAddress
KeyType = "x25519" is the only one supported right now
Tells the connected Tor to remove the client-side v3 client auth credentials
for the onion service with "HSAddress".
On success "250 OK" is returned. Otherwise, the following error codes exist:
512 - Syntax error in "HSAddress".
251 - Client credentials for "HSAddress" did not exist.
3.32. ONION_CLIENT_AUTH_VIEW
The syntax is:
"ONION_CLIENT_AUTH_VIEW" [SP HSAddress] CRLF
Tells the connected Tor to list all the stored client-side v3 client auth
credentials for "HSAddress". If no "HSAddress" is provided, list all the
stored client-side v3 client auth credentials.
The server reply format is:
"250-ONION_CLIENT_AUTH_VIEW" [SP HSAddress] CRLF
*("250-CLIENT" SP KeyType ":" PrivateKeyBlob
[SP "ClientName=" Nickname]
[SP "Flags=" FLAGS] CRLF)
"250 OK" CRLF
KeyType = "x25519" is the only one supported right now
PrivateKeyBlob = base64 encoding of x25519 key
"Nickname" is an optional nickname for this client, which can be set either
through the ONION_CLIENT_AUTH_ADD command, or it's the filename of this
client if the credentials are stored in the filesystem.
FLAGS is a comma-separated field of flags for this client, the currently
supported flags are:
"Permanent" - This client's credentials are stored in the filesystem.
On success "250 OK" is returned. Otherwise, the following error codes exist:
512 - Syntax error in "HSAddress".
3.33. DROPOWNERSHIP
The syntax is:
"DROPOWNERSHIP" CRLF