diff options
Diffstat (limited to 'macaroonbakery/third_party.py')
-rw-r--r-- | macaroonbakery/third_party.py | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/macaroonbakery/third_party.py b/macaroonbakery/third_party.py index d43b8ad..91eacaf 100644 --- a/macaroonbakery/third_party.py +++ b/macaroonbakery/third_party.py @@ -16,38 +16,42 @@ def legacy_namespace(): class ThirdPartyCaveatInfo(namedtuple( 'ThirdPartyCaveatInfo', 'condition, first_party_public_key, third_party_key_pair, root_key, ' - 'caveat, version, namespace')): + 'caveat, version, id, namespace')): '''ThirdPartyCaveatInfo holds the information decoded from a third party caveat id. - :param: condition holds the third party condition to be discharged. + @param condition holds the third party condition to be discharged. This is the only field that most third party dischargers will - need to consider. + need to consider. {str} - :param: first_party_public_key holds the nacl public key of the party - that created the third party caveat. + @param first_party_public_key holds the public key of the party + that created the third party caveat. {PublicKey} - :param: third_party_key_pair holds the nacl private used to decrypt - the caveat - the key pair of the discharging service. + @param third_party_key_pair holds the nacl private used to decrypt + the caveat - the key pair of the discharging service. {PrivateKey} - :param: root_key bytes holds the secret root key encoded by the caveat. + @param root_key holds the secret root key encoded by the caveat. {bytes} - :param: caveat holds the full encoded base64 string caveat id from - which all the other fields are derived. + @param caveat holds the full caveat id from + which all the other fields are derived. {bytes} - :param: version holds the version that was used to encode - the caveat id. + @param version holds the version that was used to encode + the caveat id. {number} - :param: namespace object that holds the namespace of the first party + @param id holds the id of the third party caveat (the id that the + discharge macaroon should be given). This will differ from Caveat + when the caveat information is encoded separately. {bytes} + + @param namespace object that holds the namespace of the first party that created the macaroon, as encoded by the party that added the - third party caveat. + third party caveat. {checkers.Namespace} ''' class ThirdPartyInfo(namedtuple('ThirdPartyInfo', 'version, public_key')): ''' ThirdPartyInfo holds information on a given third party discharge service. - version holds latest the bakery protocol version supported - by the discharger. - public_key holds the public nacl key of the third party. + @param version The latest bakery protocol version supported + by the discharger {number} + @param public_key Public key of the third party {PublicKey} ''' |