libnmap.plugins.s3.NmapS3Plugin

class documentation

class NmapS3Plugin(NmapBackendPlugin): (source)

View In Hierarchy

This plugin save the reports on S3 and compatible.

Method __init__ - create the conn object - create the bucket (if it doesn't exist) - if not given, awsaccessKey_nmapreport - may raise exception (ie in case of conflict bucket name) - sample : To connect to walrus: from libnmap...
Method delete delete an obj from the backend
Method get select a NmapReport by Id.
Method getall :rtype: List of tuple :return: list of key/report :todo: add a filter capability
Method insert create a json string from an NmapReport instance and push it to S3 bucket.
Instance Variable bucket Undocumented
Instance Variable bucket_name Undocumented
Instance Variable conn Undocumented

Inherited from NmapBackendPlugin:

Instance Variable dbname Undocumented
Instance Variable store Undocumented
def __init__(self, **kwargs): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.__init__

- create the conn object - create the bucket (if it doesn't exist) - if not given, awsaccessKey_nmapreport - may raise exception (ie in case of conflict bucket name) - sample : To connect to walrus: from libnmap.plugins.backendpluginFactory import BackendPluginFactory walrusBackend = BackendPluginFactory.create( plugin_name='s3', host="walrus.ecc.eucalyptus.com", path="/services/Walrus",port=8773, is_secure=False, aws_access_key_id='UU72FLVJCAYRATLXI70YH', aws_secret_access_key= 'wFg7gP5YFHjVlxakw1g1uCC8UR2xVW5ax9ErZCut') To connect to S3: mybackend_S3 = BackendPluginFactory.create( plugin_name='s3', is_secure=True, aws_access_key_id='MYACCESSKEY', aws_secret_access_key='MYSECRET')

def delete(self, report_id=None): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.delete

delete an obj from the backend :param str: id :return: dict document with result or None

def get(self, str_report_id=None): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.get

select a NmapReport by Id. :param str: id :rtype: NmapReport :return: NmapReport object

def getall(self, dict_filter=None): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.getall

:rtype: List of tuple :return: list of key/report :todo: add a filter capability

def insert(self, report): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.insert

create a json string from an NmapReport instance and push it to S3 bucket. :param NmapReport: obj to insert :rtype: string :return: str id :todo: Add tagging option

bucket = (source)

Undocumented

bucket_name = (source)

Undocumented

conn = (source)

Undocumented