bases Package

bases Package

destination Module

class lemur.plugins.bases.destination.DestinationPlugin

Bases: lemur.plugins.base.v1.Plugin

requires_key = True

type = 'destination'

upload(name, body, private_key, cert_chain, options, **kwargs)

class lemur.plugins.bases.destination.ExportDestinationPlugin

Bases: lemur.plugins.bases.destination.DestinationPlugin

default_options = [{'helpMessage': 'Export plugin to use before sending data to destination.', 'required': True, 'type': 'export-plugin', 'name': 'exportPlugin'}]

export(body, private_key, cert_chain, options)

options

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

upload(name, body, private_key, cert_chain, options, **kwargs)

issuer Module

class lemur.plugins.bases.issuer.IssuerPlugin

Bases: lemur.plugins.base.v1.Plugin

This is the base class from which all of the supported issuers will inherit from.

cancel_ordered_certificate(pending_cert, **kwargs)

create_authority(options)

create_certificate(csr, issuer_options)

get_ordered_certificate(certificate)

revoke_certificate(certificate, comments)

type = 'issuer'

notification Module

class lemur.plugins.bases.notification.ExpirationNotificationPlugin

Bases: lemur.plugins.bases.notification.NotificationPlugin

This is the base class for all expiration notification plugins. It contains some default options that are needed for all expiration notification plugins.

default_options = [{'validation': '^\\d+$', 'required': True, 'type': 'int', 'name': 'interval', 'helpMessage': 'Number of days to be alert before expiration.'}, {'helpMessage': 'Interval unit', 'required': True, 'name': 'unit', 'available': ['days', 'weeks', 'months'], 'validation': '', 'type': 'select'}]

options

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

send(notification_type, message, targets, options, **kwargs)

class lemur.plugins.bases.notification.NotificationPlugin

Bases: lemur.plugins.base.v1.Plugin

This is the base class from which all of the supported issuers will inherit from.

send(notification_type, message, targets, options, **kwargs)

type = 'notification'

source Module

class lemur.plugins.bases.source.SourcePlugin

Bases: lemur.plugins.base.v1.Plugin

clean(certificate, options, **kwargs)

default_options = [{'helpMessage': 'Rate in seconds to poll source for new information.', 'required': False, 'default': '60', 'type': 'int', 'name': 'pollRate'}]

get_certificates(options, **kwargs)

get_endpoints(options, **kwargs)

options

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

type = 'source'