|
|
| Line 4: |
Line 4: |
| | | | |
| | =Attributes and Methods= | | =Attributes and Methods= |
| − | ==<code>addarg(argument)</code>== | + | ==<code>depotid</code>== |
| − | This is used to build the command line arguments for the process. Truxton will automatically parse the command line for you but this allows you to programmatically force command line options.
| + | ==<code>depotlength</code>== |
| − | | + | ==<code>depotname</code>== |
| − | ==<code>addtype(file_type)</code>== | + | ==<code>depotoffset</code>== |
| − | This is how you programmatically tell Truxton what types of files you want to process.
| + | ==<code>dontroute</code>== |
| − | It will cause Truxton to write records to the <code>[[ETLRoute Table | ETLRoute</code>]] table.
| + | ==<code>file()</code>== |
| − | A new record will be added (if one does not already exist) with the <code>ETLQueueName</code> column set to this ETL's queue name and the <code>FileTypeID</code> column set to the file type specified in this function call.
| + | ==<code>fileid</code>== |
| − | | + | ==<code>filetype</code>== |
| − | The <code>file_type</code> parameter should be the [[File Types Supported | type of file]] you'd like to process.
| + | ==<code>hash</code>== |
| − | | + | ==<code>mediaid</code>== |
| − | ==<code>depot</code>== | + | ==<code>parentid</code>== |
| − | This property is used in generating the depot filename.
| + | ==<code>priority</code>== |
| − | | + | ==<code>queueempty</code>== |
| − | ==<code>description</code>== | + | ==<code>routeid</code>== |
| − | This is a longer form description of what your ETL does.
| + | ==<code>signature</code>== |
| − | | |
| − | ==<code>dtype</code>==
| |
| − | The [[Depot Types | type of depot]] you will be writing to.
| |
| − | It should be one of the values stored in the <code>ID</code> column of the <code>DepotType</code> table in the database.
| |
| − | | |
| − | ==<code>expanderid</code>== | |
| − | This is an arbitrary value you choose to uniquely identify your ETL process.
| |
| − | This should be a fixed value that you never change.
| |
| − | It will be written to the <code>Expander</code> column of the <code>[[ExpandedFile Table | ExpandedFile]]</code> table.
| |
| − | | |
| − | ==<code>getmessage()</code>== | |
| − | This function halts the execution of your process until a message arrives on your message queue.
| |
| − | | |
| − | ==<code>name</code>== | |
| − | This gives your ETL a human friendly name.
| |
| − | | |
| − | ==<code>poly</code>== | |
| − | This property tells Truxton that your ETL handles data that resides in multiple files all of which must be processed as a single unit.
| |
| − | A Poly expander resides in the [[ETL_Stages#Semi-Chaotic | Semi-Chaotic]] stage of an exploitation effort.
| |
| − | By default, Truxton assumes that ETL processes are single-file. A poly-file expander is a process that requires multiple files in order to successfully expand.
| |
| − | An example of this situation is a spanned zip file where all of the pieces of the zip archive must be gathered before unzipping it.
| |
| − | | |
| − | ==<code>queue</code>== | |
| − | This tells Truxton which message queue to wait for messages for this ETL.
| |
| − | This name will be normalized to all lower case letters with spaces removed.
| |
| − | "My Queue" will be normalized to "myqueue"
| |
| − | | |
| − | ==<code>sendmefileid(file_id)</code>== | |
| − | This is used during the development of your exploitation program.
| |
| − | It will go to Truxton, find the file and place it into your message queue.
| |
| − | | |
| − | ==<code>sendmefiles(file_type, count)</code>== | |
| − | This is used during the development of your exploitation program.
| |
| − | It will go to Truxton, find the files that meet your criteria and place them into your message queue.
| |
| − | <code>file_type</code> is the [[File Types Supported | type of file]] you would like to process.
| |
| − | <code>count</code> is the maximum number of files that will be put into your message queue.
| |
| − | | |
| − | ==<code>sendmehash(hash)</code>== | |
| − | This is used during the development of your exploitation program.
| |
| − | It will go to Truxton, find the file with the given hash and place it into your message queue.
| |
| − | The <code>hash</code> value is a string representation of an [https://en.wikipedia.org/wiki/MD5 MD5] hash.
| |
| − | | |
| − | ==<code>sendmelocalfile(file_name, file_type, calculate_hash)</code>== | |
| − | This is used during the development of your exploitation program.
| |
| − | It will open the file and put a message into your message queue.
| |
| − | <code>file_name</code> is the path the file on your system that you want to process.
| |
| − | <code>file_type</code> is the [[File Types Supported | type of file]] you would like associated with this file's contents.
| |
| − | <code>calculate_hash</code> controls how the hash value associated with this file is calculated.
| |
| − | By default, Truxton will calculate the [https://en.wikipedia.org/wiki/MD5 MD5] hash of the file's contents before sending it to you.
| |
| − | However, this can take some time if you are dealing with large files.
| |
| − | If you don't care about the hash value, set <code>calculate_hash</code> to zero and the calculation of the hash will be skipped and a random value sent as the hash.
| |
| − | | |
| − | ==<code>stage</code>== | |
| − | The [[ETL Stages | stage number]] tells Truxton how your ETL fits into the overall exploitation process.
| |
| − | | |
| − | ==<code>version</code>== | |
| − | The optional version number of your ETL process.
| |
| − | It will be written to the <code>Version</code> column of the <code>[[ExpandedFile Table | ExpandedFile]]</code> table.
| |
| − | If you do not set the version number, Truxton will use a [https://github.com/SammyB428/WFC/blob/9427b0c3edee3046ca5183829773db74fb7a0ab5/SRC/wfc_check_digital_signature.cpp#L308 packed] version number based on the information in the [https://docs.microsoft.com/en-us/windows/win32/menurc/versioninfo-resource version resource] of your executable.
| |
| | | | |
| | =Sample= | | =Sample= |
