*1fdZddlZddlZddlZddlmZmZddlmZm Z m Z ddl m Z m Z mZejeZGddejZGdd ejjejje ZdS) 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 filenamereturnNcdd|_||_tdS)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__s1 $( "* 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|jrtdt|tst dt jj|vrtd||_ dS)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-sl ; LJKK K(C(( OMNN N 7;( " "STT T#+   rcdS)zAMethod that commits the file and fixes the final filename for useNrs rclosezFileHandlerInterface.close8rc6d}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<sBh  Dw$#  rc|SNr%rs r __enter__zFileHandlerInterface.__enter__Hs rc||||dStd|jdt ||dS)NzFile z could not be written: )r&vollogwarningrr)rexc_type exc_value tracebacks r__exit__zFileHandlerInterface.__exit__Ksh   1i6G JJLLLLL NNY0YYYYY    JJLLLLLr)__name__ __module__ __qualname____doc__rrpropertyrsetterrr& staticmethodr.r1r8 __classcell__rs@rr r s ((X( ,3,,,,PP^P C C   \ rr c eZdZUdZdZeeeefed< ddej j de de j ddffd Zed Zd eeddfd Zedeejjffd ZedejjfdZxZS)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_callbackrcrt|||pd|_|||r.tdt jd|D]$}|j |j vr|j |j |j <%t|_ dS)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 cdSr0r%)fss rz*PluginInterface.__init__..sTrzPlugin failed validationz+The plugin configuration failed to validateN)rr_progress_callback unsatisfiedr3r4rPluginRequirementExceptionget_requirementsnameconfigdefaultr _file_handler)rrErFrG requirementrs rrzPluginInterface.__init__ts +..."3"J8I8I   G[ 1 1  NN5 6 6 67=  0022 D DKt{220;0C K,-9Mrc|jS)z:Returns a context manager and thus can be called like open)rTrs ropenzPluginInterface.opens !!rhandlerc\t|tstd||_dS)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_methods3'#788 WUVV V$rcDtS)z6Returns a list of Requirement objects for this plugin.)rrP)clsrs rrPz PluginInterface.get_requirementssww'')))rcdS)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}!5AAA{ 9= NN#4NN%5 N  NNNNNN:""X"%t,@'A%d%%%% *j&>&S!T*****[* Z)2   ^     rrC) metaclass)r<iologgingr abcrrtypingrrrvolatility3.frameworkrr r getLoggerr9r3 RawIOBaser reConfigurableInterfaceVersionableInterfacerCr%rrrss  ''''''''$$$$$$$$$$CCCCCCCCCC  8 $ $<<<<<2<<<<ZF F F F F 21F F F F F F r