Difference between revisions of "TruxtonMedia"
(→Sample) |
|||
| Line 2: | Line 2: | ||
=Attributes and Methods= | =Attributes and Methods= | ||
| − | |||
==<code>addroot()</code>== | ==<code>addroot()</code>== | ||
This method will create a root file in the media. | This method will create a root file in the media. | ||
All other files will ultimately be children of this file. | All other files will ultimately be children of this file. | ||
The return value of this method is a [[TruxtonChildFileIO | child file object.]] | The return value of this method is a [[TruxtonChildFileIO | child file object.]] | ||
| + | |||
==<code>case</code>== | ==<code>case</code>== | ||
A case number for this media. | A case number for this media. | ||
Even though media came in under one case doesn't mean it can't be part of another. | Even though media came in under one case doesn't mean it can't be part of another. | ||
| − | This corresponds to the <code>CaseNumber</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[CaseNumber]</code> column of the <code>[Media]</code> table. |
==<code>configid</code>== | ==<code>configid</code>== | ||
This is the path the media took through the exploitation process. | This is the path the media took through the exploitation process. | ||
| − | This corresponds to the <code>LoadConfigurationID</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[LoadConfigurationID]</code> column of the <code>[Media]</code> table. |
| − | It should be set to one of the values in the <code>ID</code> column of the <code>LoadConfiguration</code> table or a predefined constant. | + | It should be set to one of the values in the <code>[ID]</code> column of the <code>[LoadConfiguration]</code> table or a predefined constant. |
==<code>created</code>== | ==<code>created</code>== | ||
When the media was created in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks. | When the media was created in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks. | ||
| − | This corresponds to the <code>Created</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[Created]</code> column of the <code>[Media]</code> table. |
==<code>description</code>== | ==<code>description</code>== | ||
A description of the media. | A description of the media. | ||
| − | This corresponds to the <code>Description</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[Description]</code> column of the <code>[Media]</code> table. |
==<code>evidencebag</code>== | ==<code>evidencebag</code>== | ||
A description of the media. | A description of the media. | ||
| − | This corresponds to the <code>EvidenceBag</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[EvidenceBag]</code> column of the <code>[Media]</code> table. |
==<code>expires</code>== | ==<code>expires</code>== | ||
When the media should be automatically purged from Truxton in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks. | When the media should be automatically purged from Truxton in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks. | ||
| − | This corresponds to the <code>Expires</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[Expires]</code> column of the <code>[Media]</code> table. |
By default, the expiration date of media is 99 years from the creation of the media. | By default, the expiration date of media is 99 years from the creation of the media. | ||
==<code>id</code>== | ==<code>id</code>== | ||
A [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] for the media. | A [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] for the media. | ||
| − | This corresponds to the <code>ID</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[ID]</code> column of the <code>[Media]</code> table. |
==<code>latitude</code>== | ==<code>latitude</code>== | ||
The [https://en.wikipedia.org/wiki/Latitude latitude] portion of the geographic coordinate using the [https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84 WGS84] ellipsoid of where this media was seized. | The [https://en.wikipedia.org/wiki/Latitude latitude] portion of the geographic coordinate using the [https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84 WGS84] ellipsoid of where this media was seized. | ||
| − | This corresponds to the <code>Latitude</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[Latitude]</code> column of the <code>[Media]</code> table. |
==<code>longitude</code>== | ==<code>longitude</code>== | ||
The [https://en.wikipedia.org/wiki/Longitude longitude] portion of the geographic coordinate using the [https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84 WGS84] ellipsoid of where this media was seized. | The [https://en.wikipedia.org/wiki/Longitude longitude] portion of the geographic coordinate using the [https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84 WGS84] ellipsoid of where this media was seized. | ||
Many thanks go to [https://en.wikipedia.org/wiki/John_Harrison John Harrison] for his work. | Many thanks go to [https://en.wikipedia.org/wiki/John_Harrison John Harrison] for his work. | ||
| − | This corresponds to the <code>Longitude</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[Longitude]</code> column of the <code>[Media]</code> table. |
==<code>name</code>== | ==<code>name</code>== | ||
This is a human friendly name for the media. | This is a human friendly name for the media. | ||
| − | This corresponds to the <code>Name</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[Name]</code> column of the <code>[Media]</code> table. |
==<code>originator</code>== | ==<code>originator</code>== | ||
The name of the organization or person who is responsible for this media. | The name of the organization or person who is responsible for this media. | ||
For example, if you are a regional center, this would identify the originating organization that asked you to look at the media. | For example, if you are a regional center, this would identify the originating organization that asked you to look at the media. | ||
| − | This corresponds to the <code>Originator</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[Originator]</code> column of the <code>[Media]</code> table. |
==<code>percentcomplete</code>== | ==<code>percentcomplete</code>== | ||
An estimation of how [[ETL Stages#ETLs and Their Stages | far along]] the system is in the exploitation of this media. | An estimation of how [[ETL Stages#ETLs and Their Stages | far along]] the system is in the exploitation of this media. | ||
| − | This corresponds to the <code>PercentComplete</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[PercentComplete]</code> column of the <code>[Media]</code> table. |
==<code>save()</code>== | ==<code>save()</code>== | ||
| − | This will commit the information to the <code>Media</code> table. | + | This will commit the information to the <code>[Media]</code> table. |
It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | ||
==<code>status</code>== | ==<code>status</code>== | ||
The represents the status of the media. | The represents the status of the media. | ||
| − | This corresponds to the <code>MediaStatusID</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[MediaStatusID]</code> column of the <code>[Media]</code> table. |
| − | It should be a value from the <code>ID</code> column of the <code>MediaStatus</code> table or a [[Media Status | predefined constant.]] | + | It should be a value from the <code>[ID]</code> column of the <code>[MediaStatus]</code> table or a [[Media Status | predefined constant.]] |
==<code>tag(tag, reason, origin)</code>== | ==<code>tag(tag, reason, origin)</code>== | ||
| Line 79: | Line 79: | ||
==<code>type</code>== | ==<code>type</code>== | ||
The is an identifier for the type of media that was loaded. | The is an identifier for the type of media that was loaded. | ||
| − | This corresponds to the <code>MediaTypeID</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[MediaTypeID]</code> column of the <code>[Media]</code> table. |
| − | It should be a value from the <code>ID</code> column of the <code>MediaType</code> table or a [[Media Types | predefined constant.]] | + | It should be a value from the <code>[ID]</code> column of the <code>[MediaType]</code> table or a [[Media Types | predefined constant.]] |
==<code>updated</code>== | ==<code>updated</code>== | ||
When the media was last updated in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks. | When the media was last updated in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks. | ||
| − | This corresponds to the <code>LastUpdated</code> column of the <code>Media</code> table. | + | This corresponds to the <code>[LastUpdated]</code> column of the <code>[Media]</code> table. |
=Sample= | =Sample= | ||
| − | + | <source lang="Python" highlight="28-36,75"> | |
| − | < | ||
import truxton | import truxton | ||
import shutil | import shutil | ||
| Line 172: | Line 171: | ||
if __name__ == "__main__": | if __name__ == "__main__": | ||
main() | main() | ||
| − | </ | + | </source> |
Revision as of 11:03, 1 December 2020
This class represents a piece of media in Truxton.
Contents
Attributes and Methods
addroot()
This method will create a root file in the media. All other files will ultimately be children of this file. The return value of this method is a child file object.
case
A case number for this media.
Even though media came in under one case doesn't mean it can't be part of another.
This corresponds to the [CaseNumber] column of the [Media] table.
configid
This is the path the media took through the exploitation process.
This corresponds to the [LoadConfigurationID] column of the [Media] table.
It should be set to one of the values in the [ID] column of the [LoadConfiguration] table or a predefined constant.
created
When the media was created in FILETIME ticks.
This corresponds to the [Created] column of the [Media] table.
description
A description of the media.
This corresponds to the [Description] column of the [Media] table.
evidencebag
A description of the media.
This corresponds to the [EvidenceBag] column of the [Media] table.
expires
When the media should be automatically purged from Truxton in FILETIME ticks.
This corresponds to the [Expires] column of the [Media] table.
By default, the expiration date of media is 99 years from the creation of the media.
id
A GUID for the media.
This corresponds to the [ID] column of the [Media] table.
latitude
The latitude portion of the geographic coordinate using the WGS84 ellipsoid of where this media was seized.
This corresponds to the [Latitude] column of the [Media] table.
longitude
The longitude portion of the geographic coordinate using the WGS84 ellipsoid of where this media was seized.
Many thanks go to John Harrison for his work.
This corresponds to the [Longitude] column of the [Media] table.
name
This is a human friendly name for the media.
This corresponds to the [Name] column of the [Media] table.
originator
The name of the organization or person who is responsible for this media.
For example, if you are a regional center, this would identify the originating organization that asked you to look at the media.
This corresponds to the [Originator] column of the [Media] table.
percentcomplete
An estimation of how far along the system is in the exploitation of this media.
This corresponds to the [PercentComplete] column of the [Media] table.
save()
This will commit the information to the [Media] table.
It will return True if the record was saved to the database, False if there was an error.
status
The represents the status of the media.
This corresponds to the [MediaStatusID] column of the [Media] table.
It should be a value from the [ID] column of the [MediaStatus] table or a predefined constant.
tag(tag, reason, origin)
This creates a tag associated with this media in Truxton.
The tag parameter is a short, one or two word, bit of text that will be displayed in the UI.
The reason a sentence explaining why this media was tagged.
The origin is either TAG_ORIGIN_AUTOMATIC (1) or TAG_ORIGIN_HUMAN (2).
It will return
True if the tag was associated with the media, False on failure.
type
The is an identifier for the type of media that was loaded.
This corresponds to the [MediaTypeID] column of the [Media] table.
It should be a value from the [ID] column of the [MediaType] table or a predefined constant.
updated
When the media was last updated in FILETIME ticks.
This corresponds to the [LastUpdated] column of the [Media] table.
Sample
import truxton
import shutil
from datetime import datetime
from calendar import timegm
from pathlib import Path
EPOCH_AS_FILETIME = 116444736000000000
HUNDREDS_OF_NANOSECONDS = 10000000
EVENT_TYPE_FBI = 20001
def date_to_filetime(dt):
return EPOCH_AS_FILETIME + (timegm(dt.timetuple()) * HUNDREDS_OF_NANOSECONDS)
def add_file(parent_truxton_file, filename):
source_file = open(filename, "rb")
child = parent_truxton_file.newchild()
child.name = Path(filename).name
shutil.copyfileobj(source_file, child)
source_file.close()
child.save()
return child
def add_media(t):
media = t.newmedia()
media.name = "Public Documents"
media.description = "Publicly available documents"
media.case = "DC-SNAFU-2016.2020"
media.evidencebag = "EV-0937459386623-a"
media.originator = "Jeffrey Jensen"
media.latitude = 38.897661
media.longitude = -77.036458
media.type = truxton.MEDIA_TYPE_LOGICAL_FILES
media.save()
return media
def add_cs(parent_file ):
child_file = add_file(parent_file, "cs.jpg")
gps = child_file.newlocation()
gps.type = truxton.LOCATION_TYPE_MEETING
gps.latitude = 51.487329
gps.longitude = -0.124057
gps.label = "HQ"
gps.when= date_to_filetime(datetime.fromisoformat("2016-04-01T12:00:00-05:00"))
gps.save()
def create_investigation(t):
investigation = t.newinvestigation()
investigation.name = "Collusion"
investigation.description = "United States vs. John Smith"
investigation.case = "DC-SNAFU-2016.2020"
investigation.status = truxton.INVESTIGATION_STATUS_OPEN
investigation.type = truxton.INVESTIGATION_TYPE_FRAUD
investigation.save()
return investigation
def main():
t = truxton.create()
new_type = t.neweventtype()
new_type.id = EVENT_TYPE_FBI
new_type.name = "FBI Actions"
new_type.save()
investigation = create_investigation(t)
media = add_media(t)
root_file = media.addroot()
root_file.save()
investigation.addmedia(media.id)
add_cs(root_file)
if __name__ == "__main__":
main()