Difference between revisions of "TruxtonArtifact"
| Line 3: | Line 3: | ||
==<code>datatype</code>== | ==<code>datatype</code>== | ||
| + | The raw [[DATA_TYPE | data type]] of the representation of the entity. | ||
| + | This corresponds to the <code>DataTypeID</code> column of the [[Entity Table | <code>Entity</code>]] table. | ||
| + | |||
==<code>fileid</code>== | ==<code>fileid</code>== | ||
| − | The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this | + | The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this artifact came from. |
| − | This corresponds to the <code>FileID</code> column of the <code> | + | This corresponds to the <code>FileID</code> column of the [[Entity Table | <code>Entity</code>]] table. |
| + | |||
==<code>id</code>== | ==<code>id</code>== | ||
| + | This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the record. | ||
| + | It becomes non-zero after <code>save()</code> has been called. | ||
| + | This corresponds to the <code>ID</code> column of the [[Entity Table | <code>Entity</code>]] table. | ||
| + | |||
==<code>length</code>== | ==<code>length</code>== | ||
| + | The number of bytes in the raw representation of the artifact. | ||
| + | This corresponds to the <code>Length</code> column of the [[Entity Table | <code>Entity</code>]] table. | ||
| + | |||
==<code>mediaid</code>== | ==<code>mediaid</code>== | ||
| + | This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media this artifact came from. | ||
| + | This corresponds to the <code>MediaID</code> column of the [[Entity Table | <code>Entity</code>]] table. | ||
| + | |||
==<code>objectid</code>== | ==<code>objectid</code>== | ||
==<code>objecttype</code>== | ==<code>objecttype</code>== | ||
| + | The type of the object. | ||
| + | This corresponds to the <code>ObjectTypeID</code> column of the [[Entity Table | <code>Entity</code>]] table. | ||
| + | |||
==<code>offset</code>== | ==<code>offset</code>== | ||
==<code>type</code>== | ==<code>type</code>== | ||
==<code>value</code>== | ==<code>value</code>== | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==<code>localfilename</code>== | ==<code>localfilename</code>== | ||
The path to the file the browser uses to cache the contents of the page retrieved by the URL. | The path to the file the browser uses to cache the contents of the page retrieved by the URL. | ||
| − | |||
| − | |||
| − | |||
| − | |||
==<code>method</code>== | ==<code>method</code>== | ||
| Line 54: | Line 57: | ||
It will return | It will return | ||
[https://docs.python.org/3.8/library/constants.html?highlight=false#True True] if the tag was associated with the file, [https://docs.python.org/3.8/library/constants.html?highlight=false#False False] on failure. | [https://docs.python.org/3.8/library/constants.html?highlight=false#True True] if the tag was associated with the file, [https://docs.python.org/3.8/library/constants.html?highlight=false#False False] on failure. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=Sample= | =Sample= | ||
Revision as of 12:18, 28 May 2020
This class lets you add to the Entity table in Truxton.
Contents
Attributes and Methods
datatype
The raw data type of the representation of the entity.
This corresponds to the DataTypeID column of the Entity table.
fileid
The GUID of the file this artifact came from.
This corresponds to the FileID column of the Entity table.
id
This is the GUID of the record.
It becomes non-zero after save() has been called.
This corresponds to the ID column of the Entity table.
length
The number of bytes in the raw representation of the artifact.
This corresponds to the Length column of the Entity table.
mediaid
This is the GUID of the media this artifact came from.
This corresponds to the MediaID column of the Entity table.
objectid
objecttype
The type of the object.
This corresponds to the ObjectTypeID column of the Entity table.
offset
type
value
localfilename
The path to the file the browser uses to cache the contents of the page retrieved by the URL.
method
The reason this URL was retrieved.
It corresponds to the WebsiteMethodID column of the WebsiteVisit table.
The value must match a value in the ID column in the WebsiteMethod table.
You can also use one of the predefined constants.
offset
The offset in the file where this URL was found. It should be the offset of the first character in the URL.
save()
This will commit the information to the WebsiteVisit table.
It will return True if the record was saved to the database, False if there was an error.
tag(tag, reason, origin)
This creates a tag associated with this visit 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 visit 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 file, False on failure.
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 create_event_type(t, id, name):
event_type = t.neweventtype()
event_type.id = id
event_type.name = name
event_type.save()
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_event(parent_file, start, end, title, description, type):
event = parent_file.newevent()
event.start = date_to_filetime(datetime.fromisoformat(start))
event.end = date_to_filetime(datetime.fromisoformat(end))
event.title = title
event.description = description
event.type = type
event.save()
return event
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
if media.save():
print("Media saved")
else:
print("Media not saved")
return media
def add_ec(parent_file ):
child_file = add_file(parent_file, "JW-v-DOJ-reply-02743.pdf")
url = child_file.newurl()
url.url = "https://www.judicialwatch.org/documents/jw-v-doj-reply-02743/"
url.localfilename = "JW-v-DOJ-reply-02743.pdf"
url.type = truxton.URL_TYPE_FIREFOX
url.method = truxton.URL_METHOD_TYPE_CLICKED_ON_A_LINK
url.format = truxton.URL_FORMAT_ASCII
url.when = date_to_filetime(datetime.fromisoformat("2020-05-20T00:00:00-05:00"))
url.save()
add_event( child_file, "2016-07-31T12:00:00-05:00", "2016-07-31T12:00:00-05:00", "Crossfire Hurricane Created", "At FBI HQ", EVENT_TYPE_FBI )
add_event( child_file, "2016-07-27T12:00:00-05:00", "2016-07-27T12:00:00-05:00", "Legat called needing to meet US ambassador", "In London", EVENT_TYPE_FBI )
add_event( child_file, "2016-07-29T12:00:00-05:00", "2016-07-29T12:00:00-05:00", "FBI Receives Downer Info from Legat", "Probably legat London", EVENT_TYPE_FBI )
def main():
t = truxton.create()
create_event_type(t, EVENT_TYPE_FBI, "FBI Actions" )
media = add_media(t)
root_file = media.addroot()
root_file.save()
add_ec(root_file)
if __name__ == "__main__":
main()