X fjldZddlZddlZddlZddlmZmZmZmZm Z m Z m Z ddl m Z mZddlmZmZejeZGddejjZGdd ejjZGd d ejjZGd d ejjZGddeZGddejjZGddejjZGddejjZGddeejj ej!Z"Gdde"Z#Gddejj$ejj Z%Gddejj$ejj Z&Gdd ejjZ'Gd!d"e'Z(Gd#d$ejj$ejj Z)dS)%a_Contains standard Requirement types that all adhere to the :class:`~volatili ty.framework.interfaces.configuration.RequirementInterface`. These requirement types allow plugins to request simple information types (such as strings, integers, etc) as well as indicating what they expect to be in the context (such as particular layers or symboltables). N)AnyClassVarDictListOptionalTupleType)parserequest) constants interfacesc^eZdZdZdejjdedeeej j ffdZ dS)MultiRequirementzClass to hold multiple requirements. Technically the Interface could handle this, but it's an interface, so this is a concrete implementation. context config_pathreturnc.|||S)N)unsatisfied_childrenselfrrs b/home/panchajanya/Development/work/volatility3/volatility3/framework/configuration/requirements.py unsatisfiedzMultiRequirement.unsatisfieds((+>>>N) __name__ __module__ __qualname____doc__r rContextInterfacestrr configurationRequirementInterfacerrrrrs` ?!):?IL? c:+@@ A??????rrceZdZdZdS)BooleanRequirementz1A requirement type that contains a boolean value.N)rrrrr"rrr$r$#s;;;;rr$c.eZdZUdZeZeeed<dS)IntRequirementz2A requirement type that contains a single integer. instance_typeN) rrrrintr'rr __annotations__r"rrr&r&)s,<<$'M8D>'''''rr&c.eZdZUdZeZeeed<dS)StringRequirementz9A requirement type that contains a single unicode string.r'N) rrrrrr'rr r)r"rrr+r+/s.CC%(M8D>'''''rr+c2eZdZdZededefdZdS)URIRequirementzQA requirement type that contains a single unicode string that is a valid URI.filenamerc @tj|d}|jdkst|jdkrVtjtjdt jtj |}|jdkrrtj t j |js>'"67K"L"LMM E"/0DEEY$%WXXX !C!C!CDDD000rN)rrrr classmethodrrAr"rrr-r-6sL  1#1#111[111rr-c.eZdZUdZeZeeed<dS)BytesRequirementz/A requirement type that contains a byte string.r'N) rrrrbytesr'rr r)r"rrrDrDUs,99$)M8D>)))))rrDc eZdZdZeddfdeejjde e de e ddffd Z d ej j d edeeejjffd ZxZS) ListRequirementaAllows for a list of a specific type of requirement (all of which must be met for this requirement to be met) to be specified. This roughly correlates to allowing a number of arguments to follow a command line parameter, such as a list of integers or a list of strings. It is distinct from a multi-requirement which stores the subrequirements in a dictionary, not a list, and does not allow for a dynamic number of values. rN element_type max_elements min_elementsrctj|i|t|tjjst d||_|pd|_||_ dS)a3Constructs the object. Args: element_type: The (requirement) type of each element within the list max_elements; The maximum number of acceptable elements this list can contain min_elements: The minimum number of acceptable elements this list can contain zGListRequirements can only be populated with simple InstanceRequirementsrN) super__init__ issubclassr r BasicTypes TypeErrorrHrJrI)rrHrIrJargskwargs __class__s rrMzListRequirement.__init__fss $)&))), (@(KLL Y #/!-!2+7rrrcntj|j}d}|||}|s4jdkr)t tj d|iS|0j s)t tj d|iS| g|j |<t|tstdt|jt!|ks)t tj d|iSjrAt!|jks)t tj d|iSt%fd|Ds)t tj d |iSiS) z|Check the types on each of the returned values and their number and then call the element type's check for each one.NrzGListRequirement Unsatisfied - ListRequirement has non-zero min_elementsz5ListRequirement Unsatisfied - Value was not specifiedzUnexpected config value found: z3TypeError - Too few values provided to list option.z4TypeError - Too many values provided to list option.c:g|]}t|jSr") isinstancerH).0elementrs r z/ListRequirement.unsatisfied..s&PPPwJw(9::PPPrzHTypeError - At least one element in the list is not of the correct type.)r r path_joinname config_valuerJvolloglogr LOGLEVEL_VoptionalconfigrVlistrPreprr5rIall)rrrdefaultvalues` rrzListRequirement.unsatisfied~s !.88diPP !!';@@ '*Q.. JJ$Y    & & == JJ$G    & & ]*,GN; '%&& MKd5kkKKLL L!SZZ// JJ$E    & &   'c%jj43D&D&D JJ$F    & &PPPP%PPPQQ ' JJ$Z    & & r)rrrrrr r r SimpleTypesrr(rMrrrr!r __classcell__rSs@rrGrG[sDG&'&* 88:3?@8sm8sm 8 8888880,!):,IL, c:+@@ A,,,,,,,,rrGceZdZdZdeeddffd Zdejj dede eej j ffdZ xZS) ChoiceRequirementz$Allows one from a choice of strings.choicesrNctj|i|t|trt d|Drt d||_dS)z}Constructs the object. Args: choices: A list of possible string options that can be chosen from c:g|]}t|t Sr")rVr)rWchoices rrYz.ChoiceRequirement.__init__..s% ? ? ?VFC(( ( ? ? ?rz4ChoiceRequirement takes a list of strings as choicesN)rLrMrVrbanyrPrl)rrlrQrRrSs rrMzChoiceRequirement.__init__ss $)&)))'4(( TC ? ?w ? ? ?- -  TRSS S rrrctj||j}|||}||jvr)t tj d||iSiS)RValidates the provided value to ensure it is one of the available choices.z=ValueError - Value is not within the set of available choices) r r rZr[r\rlr]r^r r_rrrrfs rrzChoiceRequirement.unsatisfiedsq !.88diPP !!';77  $ $ JJ$O    & & r)rrrrrrrMr rrrr r!rrhris@rrkrks.. S t       !): IL  c:+@@ A        rrkc`eZdZdZdejjdedeeej j fffd Z e de ej j fdZejdejjdeddfdZejdej j fd Zdejjded edej jfd ZxZS) ComplexListRequirementz.Allows a variable length list of requirements.rrrc<tj||j}t ||}|r|S|||d4||tj|dr||iSiS)rrNnumber_of_elements)r r rZr[rLrr\)rrrret_listrSs rrz"ComplexListRequirement.unsatisfieds !.88diPP 77&&w <<  O   Wk4 8 8 @DDUDU   $ . .{

EE  #+7F' (<(( - -**1--$$S)))'5??CH  **:t<<$MM#(GN5,A,U,U,W,WXXX',F38$ r)rrrrr rrrrr r!rrBrr}abcabstractmethodrrrrrrhris@rrurus] 98!):IL c:+@@ A  j&>&S!T   [  !!):!IL! !!!!  E (@(UEEEE!):ILQT  ! 2rru) metaclasscZeZdZdZdejjdeddfdZdej j fdZ dS)LayerListRequirementz8Allows a variable length list of layers that must exist.rrrNctj||j}tj|d}|j|}t |t stdt|D]_}|j |jt|zd}|+t |tr| ||`dS)rrwz#Number of layers must be an integerN)r r rZr[rarVr(rPr requirementsrrTranslationLayerRequirementr)rrrnew_config_pathnum_layers_pathnumber_of_layersr layer_reqs rrzLayerListRequirement.constructs %2<<[$)TT$2<< 1  #>/:*C00 CABB B'(( > >A)--di#a&&.@$GGI$6**$##G_===  > >rcPt|jt|zddS)z:Constructs a new requirement based on the specified index.zLayer for swap spaceF)r[rzr`)rr[rrs rrz$LayerListRequirement.new_requirement*s/*SZZ'.    r) rrrrr rrrrr r!rr"rrrrsmBB>!):>IL> >>>>, (@(U      rrceZdZdZ ddededejjdede d e d dffd Z d ej j d ed e eejjffdZd ej j d ed dfdZd ej j deded ejjfdZxZS)rzXClass maintaining the limitations on what sort of translation layers are acceptable.NFr[rzrer`oses architecturesrc||g}|g}||_||_t||||dS)aoConstructs a Translation Layer Requirement. The configuration option's value will be the name of the layer once it exists in the store Args: name: Name of the configuration requirement description: Description of the configuration requirement default: A default value (should not be used for TranslationLayers) optional: Whether the translation layer is required or not oses: A list of valid operating systems which can satisfy this requirement architectures: A list of valid architectures which can satisfy this requirement N)rrrLrM)rr[rzrer`rrrSs rrMz$TranslationLayerRequirement.__init__:sM* <D  M * {GX>>>>>rrrctj||j}|||d}t |t r||jvr,t tj d|||iS|j rY|j|j dd|j vr,t tj d|||iS|jrY|j|j dd|jvr,t tj d|||iSiS|9t tj dt!|||iS||tj|t tj d|||iS) zeValidate that the value is a valid layer name and that the layer adheres to the requirements.Nz.IndexError - Layer not found in memory space: r8z*TypeError - Layer is not the required OS: architecturez4TypeError - Layer is not the required Architecture: zFTypeError - Translation Layer Requirement only accepts string labels: (IndexError - No configuration provided: )r r rZr[r\rVrrr]r^r r_rmetadatarrrc_validate_class parent_pathrss rrz'TranslationLayerRequirement.unsatisfiedWs !.88diPP !!';== eS ! ! GN** (LULL$T**  +N5)266tTBB$)SS (HHH$T**" +N5)266~tLL)** (R5RR$T**I   JJ$fY]^cYdYdff    & & Wj&>&J&J;&W&WXXX  D{ D D   T""rctj|j|j}d}|jvr%|jt |z}|dz }|jv%|d}t fd|jDrdS| |}|4t|tjj r |dS)zRConstructs the appropriate layer and adds it based on the class parameter.r1rrr[cJg|]}|j | Sr"r`rrWsubreqrrs rrYz9TranslationLayerRequirement.construct..A    ""7K88   rN) r r rZr[rrrprvalues_construct_classrVDataLayerInterface add_layerrrrr[counterrQobjs `` rrz%TranslationLayerRequirement.constructs !.88diPP ygn$$9s7||+D qLGgn$$#;MM      "/6688      4##G[$?? ?z#z/@/STT?   c " " "trrrfc@|j|SzKBuilds the appropriate configuration for the specified requirement.)rrrrrrfs rrz/TranslationLayerRequirement.build_configurations ~e$88:::r)NNFNN)rrrrrr r ConfigSimpleTypeboolrrMrrrr!rrrrrrhris@rrr3s]  =A"????): ?  ?  ?? ??????:3#!):3#IL3# c:+@@ A3#3#3#3#j!):IL @;!):;?B;KN;  ! 2;;;;;;;;rrceZdZdZdejjdedeeej j ffdZ dejjdeddfdZ dejjded e dej jfd ZdS) SymbolTableRequirementzSClass maintaining the limitations on what sort of symbol spaces are acceptable.rrrcjtj||j}|||d}t |t s;|9ttj dt|||iS|r ||j vriS|r:ttj d |pd||tj|ttj d|||iS)z[Validate that the value is a valid within the symbol space of the provided context.Nz?TypeError - SymbolTableRequirement only accepts string labels: z6IndexError - Value not present in the symbol space: {}r0z,Symbol table requirement not yet fulfilled: )r r rZr[r\rVrr]r^r r_rc symbol_spaceformatrrrss rrz"SymbolTableRequirement.unsatisfieds? !.88diPP !!';==%%% '%*; JJ$_RVW\R]R]__    & &  Ug222I   JJ$HOOKR    Wj&>&J&J;&W&WXXX  H; H H   T""rNchtj|jj|j}|d}t fd|jDrdSt|jdtjj s:td t|jd|jdj}|dSj}|D]5}|j|jvr%|jdkr|j|j||j<6||}|9t|tjjrj|dS)zTConstructs the symbol space within the context based on the subrequirements.rcJg|]}|j | Sr"rrs rrYz4SymbolTableRequirement.construct..rrNclassz5Class requirement is not of type ClassRequirement: {})r r rZr[rfree_table_namerprrrVClassRequirementrPrrcr?rabranchr}datarsymbolsSymbolTableInterfaceappend) rrrr[rQr? node_configrrs `` rrz SymbolTableRequirement.constructs !.88diPP #33DI>>";MM      "/6688      4  g & (@(Q   GNN*7344  (, ;4n++K88 '')) < >@@@r)rrrrr rrrrr r!rrrrrr"rrrrs#!):#IL# c:+@@ A####B(!):(IL( ((((TA!):A?BAKNA  ! 2AAAAAArrceZdZ ddededededeejjde e e d fd dffd Z d ej jd ed eeejjffdZede e d fde e e e fd efdZxZS)VersionRequirementNFr[rzrer` componentversion.rct|||||td||_|td||_dS)Nr[rzrer`zComponent cannot be NonezVersion cannot be None)rLrMrP _component_version)rr[rzrer`rrrSs rrMzVersionRequirement.__init__sl ;(      677 7OX ?455 5 rrrctj||j}||j|jjs||iSd|jtj||j<iS)NT) r r rZr[matches_requiredrrrrars rrzVersionRequirement.unsatisfied"ss!.88diPP $$T]DO4KLL '& &  z/99+tyQQR rrequiredct|dkr|d|dkrdSt|dkr|d|dkrdSdS)NrFr1T)r5)r?rrs rrz#VersionRequirement.matches_required.sY x==1  x{!:!:5 x==1  hqk!9!95trNFFNN)rrrrrr r r VersionableInterfacerrr(rMrrrr!rrBrrhris@rrrs< IM-1         0EF  %S/*        & !): IL  c:+@@ A    S#X16sC}1E [rrceZdZ d dededededeejjde e e d fd dffd Z xZ S) PluginRequirementNFr[rzrer`pluginr.rcVt||||||dS)N)r[rzrer`rr)rLrM)rr[rzrer`rrrSs rrMzPluginRequirement.__init__:sB #      rr)rrrrrr r pluginsPluginInterfacerrr(rMrhris@rrr9s ;?-1        Z'78  %S/*            rrc eZdZ ddedededeeedef fd Zed ee j j fd Z d d d ed e ee j j ffdZd e jjd ed dfdZd d deded e j jfdZxZS)ModuleRequirementNFr[rzrerr`ct|||||td||t ddS)Nr layer_name)r[rsymbol_table_namer[)rLrMrrr)rr[rzrerr`rSs rrMzModuleRequirement.__init__Qs ;(      '\ W W W    39LMMMNNNNNrrc$tdgS)Noffsetrr{r|s rr}z"ModuleRequirement.get_requirementsas  ) ) )  rrz#interfaces.context.ContextInterfacerctj||j}|||d}t |t r7||jvr,t tj d|||iSiS|It tj d t|||iSi}|jD]:}|j|||}|r||;|s,t tj d|||i}||tj||S)z)Validate that the value is a valid moduleNz*IndexError - Module not found in context: z=TypeError - Module Requirement only accepts string labels: {}r)r r rZr[r\rVrmodulesr]r^r r_rrc _requirementsrupdaterr)rrrrfrrreq_unsatisfieds rrzModuleRequirement.unsatisfiedgs!.88diPP !!';== eS ! ! GO++ (HHH$T**I   JJ$OVVKK     & &( / /F"08DDO / o... ) JJ$H;HH   "4(F Wj&>&J&J;&W&WXXX rctj|j|j}d}|jvr%|jt |z}|dz }|jv%|d}t fd|jDrdS| |}|4t|tj j r |dS)zJConstructs the appropriate layer and adds it based on the class parameter.rr1rcJg|]}|j | Sr"rrs rrYz/ModuleRequirement.construct..rrN)r r rZr[rrrprrrrVrModuleInterface add_modulers `` rrzModuleRequirement.constructs!.88diPP ygo%%9s7||+D qLGgo%%#;MM      "/6688      4##G[$?? ?z#z/A/QRR?   s # # #trrrfc@|j|Sr)rrrs rrz%ModuleRequirement.build_configurations u%99;;;r)NFNF)rrrrrrrrMrBr r r!r}rrrrrrrrrhris@rrrMsp -1 OOOO O  S * O  OOOOOO  j&>&S!T   [ *<*KN* c:+@@ A****X!):IL ><<rs  CCCCCCCCCCCCCCCCCC!!!!!!!!77777777  8 $ $ ? ? ? ? ?z/D ? ? ?<<<<<1G<<< (((((Z-C((( ((((( 0F(((11111&111>*****z/E*** OOOOOj.COOOd 0E@AAAAA=kAAAAH     1   D~;~;~;~;~;>=~;~;~;BWAWAWAWAWA>=WAWAWAt(((((1F(((V     *   (j<j<j<j<j<>=j<j<j<j<j