*1fdZddlZddlZddlZddlmZmZddlmZm Z m Z ddl m Z m Z mZejeZGddej$ZGdd ej(j*ej(j,e Zy) zPlugins are the `functions` of the volatility framework. They are called and carry out some algorithms on data stored in layers using objects constructed from symbols. N)ABCMetaabstractmethod)ListTupleType) exceptions constants interfacesceZdZdZdeddffd ZedZejdefdZe dZ e dedefd Z d Z d ZxZS) FileHandlerInterfacezClass for storing Files in the plugin as a means to output a file when necessary. This can be used as ContextManager that will close/produce the file automatically when exiting the context block filenamereturnNc>d|_||_t| y)zsCreates a FileHandler Args: filename: The requested name of the filename for the data N)_preferred_filenamepreferred_filenamesuper__init__)selfr __class__s Z/home/panchajanya/Development/work/volatility3/volatility3/framework/interfaces/plugins.pyrzFileHandlerInterface.__init__s $( "* c|jS)zThe preferred filename to save the data to. Until this file has been written, this value may not be the final filename the data is written to. )rrs rrz'FileHandlerInterface.preferred_filename&s '''rc|jr tdt|ts t dt j j|vr td||_ y)zSets the preferred filenamez.FileHandler name cannot be changed once closedz/FileHandler preferred filenames must be stringsz4FileHandler filenames cannot contain path separatorsN) closedIOError isinstancestr TypeErrorospathsep ValueErrorr)rr s rrz'FileHandlerInterface.preferred_filename-sQ ;;JK K(C(MN N 77;;( "ST T#+ rcy)zAMethod that commits the file and fixes the final filename for useNrs rclosezFileHandlerInterface.close8rc:d}d}|D]}||vr||z } |dz }|S)z]Sanititizes the filename to ensure only a specific whitelist of characters is allowed throughzSabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.- ()[]{}!$%^:#~?<>,|?r%)r allowedresultchars rsanitize_filenamez&FileHandlerInterface.sanitize_filename<s>h Dw$#     rc|SNr%rs r __enter__zFileHandlerInterface.__enter__Hs rc||||jytjd|jdt ||jy)NzFile z could not be written: )r&vollogwarningrr)rexc_type exc_value tracebacks r__exit__zFileHandlerInterface.__exit__KsO   1i6G JJL NN0011HYHXY  JJLr)__name__ __module__ __qualname____doc__rrpropertyrsetterrr& staticmethodr.r1r8 __classcell__rs@rr r s (( ,3,,PP C C  rr c >eZdZUdZdZeeeefed< ddejjde de jddffd Zed Zd eeddfd Zedeej,j.ffd Zedej4j6fdZxZS)PluginInterfaceaUClass that defines the basic interface that all Plugins must maintain. The constructor must only take a `context` and `config_path`, so that plugins can be launched automatically. As such all configuration information must be provided through the requirements and configuration information in the context it is passed. )rrr_required_framework_versionNcontext config_pathprogress_callbackrcnt||||xsd|_|j||r*tj dt jd|jD]>}|j|jvs|j|j|j<@t|_ y)a Args: context: The context that the plugin will operate within config_path: The path to configuration data within the context configuration data progress_callback: A callable that can provide feedback at progress points cyr0r%)fss rz*PluginInterface.__init__..r'rzPlugin failed validationz+The plugin configuration failed to validateN)rr_progress_callback unsatisfiedr3r4rPluginRequirementExceptionget_requirementsnameconfigdefaultr _file_handler)rrErFrG requirementrs rrzPluginInterface.__init__ts +."3"J8I   G[ 1 NN5 677=  002 DKt{{20;0C0C K,,- D:Nrc|jS)z:Returns a context manager and thus can be called like open)rTrs ropenzPluginInterface.opens!!!rhandlercHt|ts td||_y)z0Sets the file handler to be used by this plugin.z6FileHandler must be a subclass of FileHandlerInterfaceN) issubclassr r#rT)rrXs rset_open_methodzPluginInterface.set_open_methods!'#78UV V$rc t|S)z6Returns a list of Requirement objects for this plugin.)rrP)clsrs rrPz PluginInterface.get_requirementssw'))rcy)aExecutes the functionality of the code. .. note:: This method expects `self.validate` to have been called to ensure all necessary options have been provided Returns: A TreeGrid object that can then be passed to a Renderer. Nr%rs rrunzPluginInterface.runr'rr0)r9r:r;r<rDrint__annotations__r rEContextInterfacerr ProgressCallbackrr=rWrr r[ classmethodr configurationRequirementInterfacerPr renderersTreeGridr_r@rAs@rrCrCcs 9BsC}!5A{ 9= N##44NN%55 N  N:""%t,@'A%d% *j&>&>&S&S!T** Z))22  rrC) metaclass)r<iologgingr abcrrtypingrrrvolatility3.frameworkrr r getLoggerr9r3 RawIOBaser reConfigurableInterfaceVersionableInterfacerCr%rrrsst  '$$CC   8 $<2<<<ZF 2211F r