Browsing French translation

1672.

myapp_plugins.py

1673.

Once you have created this structure within your application, you can create the code for your cred plugin by building a factory class which implements <code class="API" base="twisted.cred.checkers">ICheckerFactory</code>. These factory classes should not consist of a tremendous amount of code. Most of the real application logic should reside in the cred checker itself. (For help on building those, scroll up.)

1674.

The core purpose of the CheckerFactory is to translate an <code class="python">argstring</code>, which is passed on the command line, into a suitable set of initialization parameters for a Checker class. In most cases this should be little more than constructing a dictionary or a tuple of arguments, then passing them along to a new checker instance.

1675.

from zope.interface import implements

from twisted import plugin
from twisted.cred import checkers
from myapp.cred import SpecialChecker

class SpecialCheckerFactory(object):
"""
A checker factory for a specialized (fictional) API.
"""
# The class needs to implement both of these interfaces
# for the plugin system to find our factory.
implements(checkers.ICheckerFactory, plugin.IPlugin)

# This tells AuthOptionsMixin how to find this factory.
authType = "special"

# This is a one-line explanation of what arguments, if any,
# your particular cred plugin requires at the command-line.
argStringFormat = "A colon-separated key=value list."

# This help text can be multiple lines. It will be displayed
# when someone uses the "--help-auth-type special" command.
authHelp = """Some help text goes here ..."""

# This will be called once per command-line.
def generateChecker(self, argstring=""):
argdict = dict((x.split('=') for x in argstring.split(':')))
return SpecialChecker(**dict)

# We need to instantiate our class for the plugin to work.
theSpecialCheckerFactory = SpecialCheckerFactory()

1676.

For more information on how your plugin can be used in your application (and by other application developers), please see the <a href="tap.xhtml">Writing a twistd plugin</a> document.

1677.

After reading through this tutorial, you should be able to

1678.

Understand how the cred architecture applies to your application

1679.

Integrate your application with cred's object model

1680.

Deploy an application that uses cred for authentication

1681.

Allow your users to use command-line authentication plugins