lp.services.macaroons.model.MacaroonIssuerBase : API documentation

@property
def identifier(self):

See IMacaroonIssuer.

@property
def _primary_caveat_name(self):

overridden in lp.soyuz.model.binarypackagebuild.BinaryPackageBuildMacaroonIssuer

The name of the primary context caveat issued by this issuer.

@property
def _root_secret(self):

overridden in lp.code.model.codeimportjob.CodeImportJobMacaroonIssuer, lp.code.model.gitrepository.GitRepositoryMacaroonIssuer

Undocumented

def checkIssuingContext(self, context, **kwargs):

overridden in lp.code.model.codeimportjob.CodeImportJobMacaroonIssuer, lp.code.model.gitrepository.GitRepositoryMacaroonIssuer, lp.code.xmlrpc.tests.test_git.DummyMacaroonIssuer, lp.services.authserver.tests.test_authserver.DummyMacaroonIssuer, lp.snappy.model.snapbuild.SnapBuildMacaroonIssuer, lp.soyuz.model.binarypackagebuild.BinaryPackageBuildMacaroonIssuer

Check that the issuing context is suitable.

Concrete implementations may implement this method to check that the context of a macaroon issuance is suitable. The returned context is used to create the primary caveat, and may be the same context that was passed in or an adapted one.

Parameters	context	The context to check.
	kwargs	Additional arguments that issuers may require to issue a macaroon.
Returns	The context to use to create the primary caveat.
Raises	BadMacaroonContext	if the context is unsuitable.

def issueMacaroon(self, context, **kwargs):

overridden in lp.code.model.gitrepository.GitRepositoryMacaroonIssuer

See IMacaroonIssuer.

def checkVerificationContext(self, context, **kwargs):

overridden in lp.code.model.codeimportjob.CodeImportJobMacaroonIssuer, lp.code.model.gitrepository.GitRepositoryMacaroonIssuer, lp.code.xmlrpc.tests.test_git.DummyMacaroonIssuer, lp.services.authserver.tests.test_authserver.DummyMacaroonIssuer, lp.snappy.model.snapbuild.SnapBuildMacaroonIssuer, lp.soyuz.model.binarypackagebuild.BinaryPackageBuildMacaroonIssuer

Check that the verification context is suitable.

Concrete implementations may implement this method to check that the context of a macaroon verification is suitable. The returned context is passed to individual caveat checkers, and may be the same context that was passed in or an adapted one.

Parameters	context	The context to check.
	kwargs	Additional arguments that issuers may require to verify a macaroon.
Returns	The context to pass to individual caveat checkers.
Raises	BadMacaroonContext	if the context is unsuitable.

def verifyPrimaryCaveat(self, verified, caveat_value, context, **kwargs):

overridden in lp.code.model.codeimportjob.CodeImportJobMacaroonIssuer, lp.code.model.gitrepository.GitRepositoryMacaroonIssuer, lp.code.xmlrpc.tests.test_git.DummyMacaroonIssuer, lp.services.authserver.tests.test_authserver.DummyMacaroonIssuer, lp.snappy.model.snapbuild.SnapBuildMacaroonIssuer, lp.soyuz.model.binarypackagebuild.BinaryPackageBuildMacaroonIssuer

Verify the primary context caveat on one of this issuer's macaroons.

Parameters	verified	An `IMacaroonVerificationResult`. Implementations of this method may update this with additional information resulting from the verification process.
	caveat_value	The text of the caveat with the caveat name removed.
	context	The context to check.
	kwargs	Additional arguments that issuers may require to verify a macaroon.
Returns	True if this caveat is allowed, otherwise False.

def verifyMacaroon(self, macaroon, context, require_context=True, errors=None, **kwargs):

See IMacaroonIssuer.

Method	identifier	See `IMacaroonIssuer`.
Method	checkIssuingContext	Check that the issuing context is suitable.
Method	issueMacaroon	See `IMacaroonIssuer`.
Method	checkVerificationContext	Check that the verification context is suitable.
Method	verifyPrimaryCaveat	Verify the primary context caveat on one of this issuer's macaroons.
Method	verifyMacaroon	See `IMacaroonIssuer`.
Method	_primary_caveat_name	The name of the primary context caveat issued by this issuer.
Method	_root_secret	Undocumented

l.s.m.m.MacaroonIssuerBase : class documentation