bases Package

bases Package

destination Module

class lemur.plugins.bases.destination.DestinationPlugin

Bases: lemur.plugins.base.v1.Plugin

requires_key = True

sync_as_source = False

sync_as_source_name = ''

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 = [{'name': 'exportPlugin', 'type': 'export-plugin', 'required': True, 'helpMessage': 'Export plugin to use before sending data to destination.'}]

export(body, private_key, cert_chain, options)

property 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 = [{'name': 'interval', 'type': 'int', 'required': True, 'validation': '^\\d+$', 'helpMessage': 'Number of days to be alert before expiration.'}, {'name': 'unit', 'type': 'select', 'required': True, 'validation': '', 'available': ['days', 'weeks', 'months'], 'helpMessage': 'Interval unit'}]

property 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, excluded_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.

filter_recipients(options, excluded_recipients)

Given a set of options (which should include configured recipient info), filters out recipients that we do NOT want to notify.

For any notification types where recipients can’t be dynamically modified, this returns an empty list.

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 = [{'name': 'pollRate', 'type': 'int', 'required': False, 'helpMessage': 'Rate in seconds to poll source for new information.', 'default': '60'}]

get_certificates(options, **kwargs)

get_endpoints(options, **kwargs)

property 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'