bases Package¶
bases
Package¶
destination
Module¶
- class lemur.plugins.bases.destination.DestinationPlugin
Bases:
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:
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
Gets/sets options for the plugin.
- Returns
- upload(name, body, private_key, cert_chain, options, **kwargs)
issuer
Module¶
- class lemur.plugins.bases.issuer.IssuerPlugin
Bases:
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)
- deactivate_certificate(certificate)
- get_ordered_certificate(certificate)
- revoke_certificate(certificate, reason)
- type = 'issuer'
notification
Module¶
- class lemur.plugins.bases.notification.ExpirationNotificationPlugin
Bases:
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
Gets/sets options for the plugin.
- Returns
- send(notification_type, message, excluded_targets, options, **kwargs)
- class lemur.plugins.bases.notification.NotificationPlugin
Bases:
Plugin
This is the base class from which all of the supported issuers will inherit from.
- get_recipients(options, additional_recipients)
Given a set of options (which should include configured recipient info), returns the parsed list of recipients from those options plus the additional recipients specified. The returned value has no duplicates.
For any notification types where recipients can’t be dynamically modified, this returns only the additional recipients.
- send(notification_type, message, targets, options, **kwargs)
- type = 'notification'
source
Module¶
- class lemur.plugins.bases.source.SourcePlugin
Bases:
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
Gets/sets options for the plugin.
- Returns
- type = 'source'