Truxton etl send me local file - Revision history

Sam: /* Sample */

2021-02-10T15:29:17Z

Sample

Sam at 08:11, 5 December 2020

2020-12-05T08:11:11Z

Sam at 11:27, 8 November 2020

2020-11-08T11:27:55Z

Sam: /* calculate_hash */

2020-06-12T10:13:56Z

calculate_hash

Sam at 10:43, 10 June 2020

2020-06-10T10:43:47Z

Sam: Created page with "This is used during the development of your exploitation program. It will open the file and put a message into your message queue. =Syntax= void tr..."

2020-05-26T14:03:54Z

Created page with "This is used during the development of your exploitation program. It will open the file and put a message into your message queue. =Syntax= <syntaxhighlight lang="C"> void tr..."

New page

This is used during the development of your exploitation program.
It will open the file and put a message into your message queue.

=Syntax=
<syntaxhighlight lang="C">
void truxton_etl_send_me_local_file( uint64_t etl_handle, uint16_t file_type, uint16_t calculate_hash, char const * file_name )
</syntaxhighlight>

=Parameters=
==<code>etl_handle</code>==

The handle created by the [[truxton_etl_create]] call.

==<code>file_type</code>==
The file will be tagged with this [[File Types Supported | file type]] in the incoming message.

==<code>calculate_hash</code>==
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>file_name</code>==
The path to the file to open and send to the message queue.

=Sample=

<syntaxhighlight lang="C" highlight="17">
#include <TruxtonCAPI.h>

void main( void )
{
char file_id[ 65 ];

int exit_loop = 0;

uint64_t message = 0;
uint64_t app = truxton_etl_create();

truxton_etl_set_application_name( app, "Sample C ETL" );
truxton_etl_set_depot_type_name( app, "custom" );
truxton_etl_set_queue_name( app, "SampleC" );

// FOR TESTING PURPOSES ONLY!
truxton_etl_send_me_local_file( app, Type_MPEG4Video , 0, "C:\\Test Files\\Video\\Fragmented\\Recovered Video.mp4");

while( exit_loop == 0 )
{
message = truxton_etl_get_message( app );

if ( message != 0 )
{
// Do something with the message

memset( file_id, 0x00, sizeof( file_id ) );
truxton_message_get_file_id( message, file_id, sizeof( file_id ) );

printf( "Received file id %s\n", file_id );

truxton_message_destroy( message );
}
else
{
exit_loop = 1;
}
}

truxton_etl_destroy( app );
}
</syntaxhighlight>

@@ Line 39: / Line 39: @@
      // FOR TESTING PURPOSES ONLY!
-     truxton_etl_send_me_local_file( app, Type_MPEG4Video , 0, "C:\\Test Files\\Video\\Fragmented\\Recovered Video.mp4");
+     truxton_etl_send_me_local_file( app, Type_MPEG4Video , 0, "C:\\Test Files\\Video\\Fragmented\\Recovered Video.mp4" );
      // Pause here until we get a message from the "SampleC" message queue

@@ Line 3: / Line 3: @@
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 void truxton_etl_send_me_local_file( uint64_t etl_handle, uint16_t file_type, uint16_t calculate_hash, char const * file_name );
-</syntaxhighlight>
+</source>
 =Parameters=
 ==<code>etl_handle</code>==
 The handle created by the [[truxton_etl_create]] call.
@@ Line 25: / Line 24: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="17">
+<source lang="C" highlight="15">
 #include <TruxtonCAPI.h>
@@ Line 31: / Line 30: @@
+{
      char file_id[ 65 ];
      uint64_t message = 0;
@@ Line 44: / Line 41: @@
      truxton_etl_send_me_local_file( app, Type_MPEG4Video , 0, "C:\\Test Files\\Video\\Fragmented\\Recovered Video.mp4");
-     while( exit_loop == 0 )
+    // Pause here until we get a message from the "SampleC" message queue
+     {
-         message = truxton_etl_get_message( app );
+         // Do something with the message
-         if ( message != 0 )
+         memset( file_id, 0x00, sizeof( file_id ) );
+         truxton_message_get_file_id( message, file_id, sizeof( file_id ) );
-            memset( file_id, 0x00, sizeof( file_id ) );
+        printf( "Received file id %s\n", file_id );
-            printf( "Received file id %s\n", file_id );
+        truxton_message_destroy( message );
-            truxton_message_destroy( message );
+        // Pause here until we get another message from the "SampleC" message queue
+         message = truxton_etl_get_message( app );
+     }
      truxton_etl_destroy( app );
+}
-</syntaxhighlight>
+</source>

@@ Line 13: / Line 13: @@
 ==<code>file_type</code>==
-The file will be tagged with this [[File Types Supported | file type]] in the incoming message.
+The <code>[[Message Bus Messages#file_type|file_type]]</code> field of the incoming [[Message Bus Messages#Message Structure|message]] will be tagged set to this [[File Types Supported|value]].
 ==<code>calculate_hash</code>==
-By default, Truxton will calculate the [https://en.wikipedia.org/wiki/MD5 MD5] hash of the file's contents before sending it to you.
+By default, Truxton will calculate the [https://en.wikipedia.org/wiki/MD5 MD5] hash of the file's contents to populate the <code>[[Message Bus Messages#md5|md5]]</code> member of the [[Message Bus Messages#Message Structure|message]] 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 hash will be replaced with a random value.
 ==<code>file_name</code>==
-The path to the file to open and send to the message queue.
+The path to the file to open and send to your message queue.
 =Sample=