Skip to content

Commit

Permalink
add authentication information to rpc-spec.txt (#1808)
Browse files Browse the repository at this point in the history
* document the Authentication header in rpc-spec.txt
  • Loading branch information
tylergibbs2 committed Sep 15, 2021
1 parent abdfcb9 commit 32fab5a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions extras/rpc-spec.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 32fab5a

Please sign in to comment.