From 044409dfe3d12aa6b61c2dbe4148ad702a6d5b0c Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Mon, 7 Oct 2019 16:01:56 -0400
Subject: [PATCH] RistrettoRedeemer docstring
---
src/_zkapauthorizer/controller.py | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/src/_zkapauthorizer/controller.py b/src/_zkapauthorizer/controller.py
index 89d08df..3d78b9d 100644
--- a/src/_zkapauthorizer/controller.py
+++ b/src/_zkapauthorizer/controller.py
@@ -220,6 +220,16 @@ class IssuerConfigurationMismatch(Exception):
@implementer(IRedeemer)
@attr.s
class RistrettoRedeemer(object):
+ """
+ An ``IRedeemer`` which speaks the Ristretto-flavored PrivacyPass protocol
+ described at
+ https://docs.rs/challenge-bypass-ristretto/1.0.0-pre.0/challenge_bypass_ristretto/#cryptographic-protocol
+
+ :ivar treq.client.HTTPClient _treq: An HTTP client to use to make calls to
+ the issuer.
+
+ :ivar URL _api_root: The root of the issuer HTTP API.
+ """
_log = Logger()
_treq = attr.ib()
--
GitLab