lp.services.authserver.interfaces.IAuthServer : API documentation

Method	getUserAndSSHKeys	Get details about a person, including their SSH keys.
Method	issueMacaroon	Issue a macaroon of type `issuer_name` for `context`.
Method	verifyMacaroon	Verify that `macaroon_raw` grants access to `context`.

def getUserAndSSHKeys(name):

Get details about a person, including their SSH keys.

Parameters	name	The username to look up.
Returns	A dictionary {id: person-id, username: person-name, keys: [(key-type, key-text)]}, or NoSuchPersonWithName if there is no person with the given name.

def issueMacaroon(issuer_name, context_type, context):

Issue a macaroon of type issuer_name for context.

Parameters	issuer_name	An `IMacaroonIssuer` name. Only issuers where `issuable_via_authserver` is True are permitted.
	context_type	A string identifying the type of context for which to issue the macaroon. Currently only 'LibraryFileAlias' and 'SnapBuild' are supported.
	context	The context for which to issue the macaroon. Note that this is passed over XML-RPC, so it should be plain data (e.g. an ID) rather than a database object.
Returns	A serialised macaroon or a fault.

def verifyMacaroon(macaroon_raw, context_type, context):

Verify that macaroon_raw grants access to context.

Parameters	macaroon_raw	A serialised macaroon.
	context_type	A string identifying the type of context to check. Currently only 'LibraryFileAlias' and 'SnapBuild' are supported.
	context	The context to check. Note that this is passed over XML-RPC, so it should be plain data (e.g. an ID) rather than a database object.
Returns	True if the macaroon grants access to `context`, otherwise an `Unauthorized` fault.

l.s.a.i.IAuthServer(Interface) : interface documentation