add authentication information to rpc-spec.txt (#1808)

* document the Authentication header in rpc-spec.txt
This commit is contained in:
Tyler 2021-09-15 08:35:23 -05:00 committed by GitHub
parent abdfcb9681
commit 32fab5a67b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions

View File

@ -81,6 +81,19 @@
For more information on configuration, see settings.json documentation for
"rpc-host-whitelist-enabled" and "rpc-host-whitelist" keys.
2.3.3. Authentication
Enabling authentication is an optional security feature that can be enabled
on Transmission RPC servers. Authentication occurs by method of HTTP Basic
Access Authentication.
If authentication is enabled, Transmission inspects the "Authorization:"
HTTP header value to validate the credentials of the request. The value
of this HTTP header is expected to be "Basic <b64 credentials>", where
<b64 credentials> is equal to a base64 encoded string of the username
and password (respectively), separated by a colon.
3. Torrent Requests
3.1. Torrent Action Requests