l.s.m.i.IMacaroonIssuerPublic(Interface) : interface documentation

Part of lp.services.macaroons.interfaces View In Hierarchy

Known subclasses: lp.services.macaroons.interfaces.IMacaroonIssuer

Public interface to a policy for verifying macaroons.
Attribute identifier An identifying name for this issuer.
Bool issuable_via_authserver Undocumented
Method verifyMacaroon Verify that macaroon is valid for context.
identifier =
An identifying name for this issuer.
issuable_via_authserver =
Undocumented
def verifyMacaroon(macaroon, context, require_context=True, errors=None, user=None, **kwargs):
Verify that macaroon is valid for context.
ParametersmacaroonA Macaroon.
contextThe context to check.
require_contextIf True (the default), fail verification if the context is None. If False and the context is None, only verify that the macaroon could be valid for some context. Use this in the authentication part of an authentication/authorisation API.
errorsIf non-None, any verification error messages will be appended to this list.
kwargsAdditional arguments that issuers may require to verify a macaroon.
ReturnsAn IMacaroonVerificationResult if macaroon is valid for context, otherwise None.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.