commit da84c257cc600a1aeb6bafb70bd3fc0878ed212f Author: Isis Lovecruft isis@torproject.org Date: Wed Dec 20 22:51:38 2017 +0000

Change moat API specification to remove "moat-transports" response.

* FIXES #24636: https://bugs.torproject.org/24636 --- README.rst | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-)

diff --git a/README.rst b/README.rst index 8481382..e2d17a5 100644 --- a/README.rst +++ b/README.rst @@ -452,17 +452,6 @@ Receiving a CAPTCHA challenge

The moat server will respond with ``200 OK``.

-If there is no overlap with the transports which BridgeDB supports, the moat -server will respond with the list of transports which is *does* support:: - - { - "data": { - "version": "0.1.0", - "type": "moat-transports", - "supported": [ "TRANSPORT", "TRANSPORT", ... ], - } - } - If there is an overlap with what BridgeDB supports, the moat server will select the "best" transport from the list of supported transports, and respond with the following JSON containing a CAPTCHA challenge:: @@ -490,6 +479,20 @@ The challenge contains an encrypted-then-HMACed timestamp, and solutions submitted more than 30 minutes after requesting the CAPTCHA are considered invalid.

+If there is no overlap with the transports which BridgeDB supports, the moat +server will respond with the list of transports which is *does* support:: + + { + "data": { + "id": "1", + "type": "moat-challenge", + "version": "0.1.0", + "transport": [ "TRANSPORT", "TRANSPORT", ... ], + "image": "CAPTCHA", + "challenge": "CHALLENGE", + } + } +

Responding to a CAPTCHA challenge """""""""""""""""""""""""""""""""