Examples

This page includes some basic examples of creating and parsing CybOX content.

There are a couple things we do in these examples for purposes of demonstration that shouldn't be done in production code:

When calling to_xml(), we use include_namespaces=False. This is to make the example output easier to read, but means the resulting output cannot be successfully parsed. The XML parser doesn't know what namespaces to use if they aren't included. In production code, you should explicitly set include_namespaces to True or omit it entirely (True is the default).
We use set_id_method(IDGenerator.METHOD_INT) to make IDs for Objects and Observables easier to read and cross-reference within the XML document. In production code, you should omit this statement, which causes random UUIDs to be created instead, or create explicit IDs yourself for objects and observables.

# This is necessary because Python 3 won't consider the UTF-8 encoded byte # literals returned from to_xml() to be equivalent to the testoutput:: # blocks, and this prevents us from needing to pass encoding=None to each # to_xml() call and explain to people why we've done that, but they don't # need to. # builtin_print = print # def print(s): # builtin_print(s.decode('utf-8'))

Creating Objects

The easiest way to create an object is to construct one and then set various properties on it.

from cybox.objects.file_object import File f = File() f.file_name = "malware.exe" f.file_path = "C:WindowsTempmalware.exe" print(f.to_xml(include_namespaces=False, encoding=None))

Which outputs:

<FileObj:FileObjectType xsi:type="FileObj:FileObjectType">: <FileObj:File_Name>malware.exe</FileObj:File_Name> <FileObj:File_Path>C:WindowsTempmalware.exe</FileObj:File_Path>

</FileObj:FileObjectType>

For some objects, such as the AddressObject, you can pass parameters direcly into the constructor.

from cybox.objects.address_object import Address a = Address("1.2.3.4", Address.CAT_IPV4) print(a.to_xml(include_namespaces=False, encoding=None))

<AddressObj:AddressObjectType xsi:type="AddressObj:AddressObjectType" category="ipv4-addr">: <AddressObj:Address_Value>1.2.3.4</AddressObj:Address_Value>

</AddressObj:AddressObjectType>

Creating Observables

Full CybOX documents are expected to have Observables as the root element. You can pass any object to the Observables constructor to generate the proper XML.

from mixbox.idgen import IDGenerator, set_id_method from cybox.core import Observables from cybox.objects.file_object import File set_id_method(IDGenerator.METHOD_INT) f = File() f.file_name = "malware.exe" f.file_path = "C:WindowsTempmalware.exe" print(Observables(f).to_xml(include_namespaces=False, encoding=None))

<cybox:Observables cybox_major_version="2" cybox_minor_version="1" cybox_update_version="0">

<cybox:Observable id="example:Observable-1">

<cybox:Object id="example:File-2">

<cybox:Properties xsi:type="FileObj:FileObjectType">: <FileObj:File_Name>malware.exe</FileObj:File_Name> <FileObj:File_Path>C:WindowsTempmalware.exe</FileObj:File_Path>

</cybox:Properties>

</cybox:Object>

</cybox:Observable>

</cybox:Observables>

To include multiple objects as individual Observables within one document, you can pass them as a list to the Observables constructor.

from mixbox.idgen import IDGenerator, set_id_method from cybox.core import Observables from cybox.objects.address_object import Address from cybox.objects.uri_object import URI set_id_method(IDGenerator.METHOD_INT) a = Address("1.2.3.4", Address.CAT_IPV4) u = URI("http://cybox.mitre.org/") print(Observables([a, u]).to_xml(include_namespaces=False, encoding=None))

<cybox:Observables cybox_major_version="2" cybox_minor_version="1" cybox_update_version="0">

<cybox:Observable id="example:Observable-1">

<cybox:Object id="example:Address-2">

<cybox:Properties xsi:type="AddressObj:AddressObjectType" category="ipv4-addr">: <AddressObj:Address_Value>1.2.3.4</AddressObj:Address_Value>

</cybox:Properties>

</cybox:Object>

</cybox:Observable> <cybox:Observable id="example:Observable-3"> <cybox:Object id="example:URI-4"> <cybox:Properties xsi:type="URIObj:URIObjectType"> <URIObj:Value>http://cybox.mitre.org/</URIObj:Value> </cybox:Properties> </cybox:Object> </cybox:Observable>

</cybox:Observables>

HTTP Message Body

When outputing XML, by default, reserved XML characters such as < and > are escaped by default.

http

from cybox.objects.http_session_object import HTTPMessage m = HTTPMessage() m.message_body = "<html><title>An HTML page</title><body>Body text</body></html>"

from cybox.objects.http_session_object import HTTPMessage m = HTTPMessage() m.message_body = "<html><title>An HTML page</title><body>Body text</body></html>" m.length = len(m.message_body.value) print(m.to_xml(include_namespaces=False, encoding=None))

<HTTPSessionObj:HTTPMessageType>: <HTTPSessionObj:Length>69</HTTPSessionObj:Length> <HTTPSessionObj:Message_Body><html><title>An HTML page</title><body>Body text</body></html></HTTPSessionObj:Message_Body>

</HTTPSessionObj:HTTPMessageType>

When you parse this content, these characters are converted back.

from cybox.bindings.http_session_object import parseString m2 = HTTPMessage.from_obj(parseString(m.to_xml(encoding=None))) print(m2.message_body)

HTTP User Agent

from cybox.objects.http_session_object import * fields = HTTPRequestHeaderFields() fields.user_agent = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:25.0) Gecko/20100101 Firefox/25.0'

header = HTTPRequestHeader() header.parsed_header = fields

request = HTTPClientRequest() request.http_request_header = header

req_res = HTTPRequestResponse() req_res.http_client_request = request

session = HTTPSession() session.http_request_response = [req_res]

print(session.to_xml(include_namespaces=False, encoding=None))

<HTTPSessionObj:HTTPSessionObjectType xsi:type="HTTPSessionObj:HTTPSessionObjectType">

<HTTPSessionObj:HTTP_Request_Response>

<HTTPSessionObj:HTTP_Client_Request>

<HTTPSessionObj:HTTP_Request_Header>

<HTTPSessionObj:Parsed_Header>: <HTTPSessionObj:User_Agent>Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:25.0) Gecko/20100101 Firefox/25.0</HTTPSessionObj:User_Agent>

</HTTPSessionObj:Parsed_Header>

</HTTPSessionObj:HTTP_Request_Header>

</HTTPSessionObj:HTTP_Client_Request>

</HTTPSessionObj:HTTP_Request_Response>

</HTTPSessionObj:HTTPSessionObjectType>

Objects with DateTime properties

When setting DateTime properties on objects, you can either use a native Python datetime.datetime or a string. The python-dateutil library is used to parse strings into dates, so a wide variety of formats is supported.

import datetime from cybox.objects.email_message_object import EmailMessage e = EmailMessage() e.from = "spammer@spam.com" e.subject = "This is not spam" e.date = datetime.datetime(2012, 1, 17, 8, 35, 6) print(e.to_xml(include_namespaces=False, encoding=None))

<EmailMessageObj:EmailMessageObjectType xsi:type="EmailMessageObj:EmailMessageObjectType">

<EmailMessageObj:Header>

<EmailMessageObj:From xsi:type="AddressObj:AddressObjectType" category="e-mail">: <AddressObj:Address_Value>spammer@spam.com</AddressObj:Address_Value>

</EmailMessageObj:From> <EmailMessageObj:Subject>This is not spam</EmailMessageObj:Subject> <EmailMessageObj:Date>2012-01-17T08:35:06</EmailMessageObj:Date>

</EmailMessageObj:Header>

</EmailMessageObj:EmailMessageObjectType>

from cybox.objects.email_message_object import EmailMessage e = EmailMessage() e.date = "Mon, 14 Oct, 2013 12:32:03 -0500" print(e.to_xml(include_namespaces=False, encoding=None))

<EmailMessageObj:EmailMessageObjectType xsi:type="EmailMessageObj:EmailMessageObjectType">

<EmailMessageObj:Header>: <EmailMessageObj:Date>2013-10-14T12:32:03-05:00</EmailMessageObj:Date>

</EmailMessageObj:Header>

</EmailMessageObj:EmailMessageObjectType>

Hashes

In many cases you can pass a dictionary or a list to create an instance of a CybOX type.

from cybox.common import HashList h = HashList.from_list([{'type' : 'MD5', 'simple_hash_value' : 'FFFFFF'}, {'type' : 'SHA1', 'simple_hash_value' : 'FFFFFF'}]) print(h.to_xml(include_namespaces=False, encoding=None))

<cyboxCommon:HashListType>

<cyboxCommon:Hash>: <cyboxCommon:Type>MD5</cyboxCommon:Type> <cyboxCommon:Simple_Hash_Value>FFFFFF</cyboxCommon:Simple_Hash_Value>

</cyboxCommon:Hash> <cyboxCommon:Hash> <cyboxCommon:Type>SHA1</cyboxCommon:Type> <cyboxCommon:Simple_Hash_Value>FFFFFF</cyboxCommon:Simple_Hash_Value> </cyboxCommon:Hash>

</cyboxCommon:HashListType>

This can easily be incorporated into constructing objects as well.

from cybox.objects.win_file_object import WinFile f = WinFile() f.file_name = "foo.exe" f.drive = "C:\" f.hashes = h print(f.to_xml(include_namespaces=False, encoding=None))

<WinFileObj:WindowsFileObjectType xsi:type="WinFileObj:WindowsFileObjectType">: <FileObj:File_Name>foo.exe</FileObj:File_Name> <FileObj:Hashes> <cyboxCommon:Hash> <cyboxCommon:Type>MD5</cyboxCommon:Type> <cyboxCommon:Simple_Hash_Value>FFFFFF</cyboxCommon:Simple_Hash_Value> </cyboxCommon:Hash> <cyboxCommon:Hash> <cyboxCommon:Type>SHA1</cyboxCommon:Type> <cyboxCommon:Simple_Hash_Value>FFFFFF</cyboxCommon:Simple_Hash_Value> </cyboxCommon:Hash> </FileObj:Hashes> <WinFileObj:Drive>C:</WinFileObj:Drive>

</WinFileObj:WindowsFileObjectType>

Object Subclasses

The WindowsFile object is a subclass of the File object. As you can see, the correct namepaces for the various properties are set.

from cybox.objects.win_file_object import WinFile f = WinFile() f.file_name = "blah.exe" f.drive = "C:\" print(f.to_xml(include_namespaces=False, encoding=None))

<WinFileObj:WindowsFileObjectType xsi:type="WinFileObj:WindowsFileObjectType">: <FileObj:File_Name>blah.exe</FileObj:File_Name> <WinFileObj:Drive>C:</WinFileObj:Drive>

</WinFileObj:WindowsFileObjectType>

As another example, the WinUser object is a refinement of the UserAccount object, which itself is a refinement of the Account object. As with Hashes, these can be constructed from a dictionary representation.

from cybox.objects.win_user_object import WinUser winuser_dict = { # Account-specific fields 'disabled': False, 'domain': 'ADMIN', # UserAccount-specific fields 'password_required': True, 'full_name': "Steve Ballmer", 'home_directory': "C:\Users\ballmer\", 'last_login': "2011-05-12T07:14:01+07:00", 'username': "ballmer", 'user_password_age': "P180D", # WinUser-specific fields 'security_id': "S-1-5-21-3623811015-3361044348-30300820-1013", 'security_type': "SidTypeUser", 'xsi:type': 'WindowsUserAccountObjectType', } print(WinUser.from_dict(winuser_dict).to_xml(include_namespaces=False, encoding=None))

<WinUserAccountObj:WindowsUserAccountObjectType xsi:type="WinUserAccountObj:WindowsUserAccountObjectType": disabled="false" password_required="true">
<AccountObj:Domain>ADMIN</AccountObj:Domain>: <UserAccountObj:Full_Name>Steve Ballmer</UserAccountObj:Full_Name> <UserAccountObj:Home_Directory>C:Usersballmer</UserAccountObj:Home_Directory> <UserAccountObj:Last_Login>2011-05-12T07:14:01+07:00</UserAccountObj:Last_Login> <UserAccountObj:Username>ballmer</UserAccountObj:Username> <UserAccountObj:User_Password_Age>P180D</UserAccountObj:User_Password_Age> <WinUserAccountObj:Security_ID>S-1-5-21-3623811015-3361044348-30300820-1013</WinUserAccountObj:Security_ID> <WinUserAccountObj:Security_Type>SidTypeUser</WinUserAccountObj:Security_Type>

</WinUserAccountObj:WindowsUserAccountObjectType>

ObservableCompositions

from mixbox.idgen import IDGenerator, set_id_method from cybox.core import Observable, Observables, ObservableComposition from cybox.objects.file_object import File from cybox.objects.process_object import Process set_id_method(IDGenerator.METHOD_INT)

observables = Observables()

proc = Process.from_dict(: {"name": "cmd.exe", "image_info": {"command_line": "cmd.exe /c blah.bat"}})

proc.name.condition = "Equals" proc.image_info.command_line.condition = "Contains" oproc = Observable(proc) observables.add(oproc)

f = File.from_dict({"file_name": "blah", "file_extension": "bat"}) f.file_name.condition = "Contains" f.file_extension.condition = "Equals" ofile = Observable(f) observables.add(ofile)

oproc_ref = Observable() oproc_ref.id = None oproc_ref.idref = oproc.id

ofile_ref = Observable() ofile_ref.id = None ofile_ref.idref = ofile.id

o_comp = ObservableComposition(operator="OR") o_comp.add(oproc_ref) o_comp.add(ofile_ref) observables.add(Observable(o_comp))

print(observables.to_xml(include_namespaces=False, encoding=None))

<cybox:Observables cybox_major_version="2" cybox_minor_version="1" cybox_update_version="0">

<cybox:Observable id="example:Observable-1">

<cybox:Object id="example:Process-2">

<cybox:Properties xsi:type="ProcessObj:ProcessObjectType">: <ProcessObj:Name condition="Equals">cmd.exe</ProcessObj:Name> <ProcessObj:Image_Info> <ProcessObj:Command_Line condition="Contains">cmd.exe /c blah.bat</ProcessObj:Command_Line> </ProcessObj:Image_Info>

</cybox:Properties>

</cybox:Object>

</cybox:Observable> <cybox:Observable id="example:Observable-3"> <cybox:Object id="example:File-4"> <cybox:Properties xsi:type="FileObj:FileObjectType"> <FileObj:File_Name condition="Contains">blah</FileObj:File_Name> <FileObj:File_Extension condition="Equals">bat</FileObj:File_Extension> </cybox:Properties> </cybox:Object> </cybox:Observable> <cybox:Observable id="example:Observable-7"> <cybox:Observable_Composition operator="OR"> <cybox:Observable idref="example:Observable-1"> </cybox:Observable> <cybox:Observable idref="example:Observable-3"> </cybox:Observable> </cybox:Observable_Composition> </cybox:Observable>

</cybox:Observables>

Parsing example

Just as you can call to_xml() to generate XML, you can call parseString to parse an XML string.

>>> import cybox.bindings.file_object as file_binding >>> from cybox.objects.file_object import File >>> a = """ ... <FileObj:FileObjectType ... xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ... xmlns:FileObj="http://cybox.mitre.org/objects#FileObject-2" ... xsi:type="FileObj:FileObjectType"> ... <FileObj:File_Name condition="Contains">bad.exe</FileObj:File_Name> ... </FileObj:FileObjectType> ... """ >>> file_obj = file_binding.parseString(a) >>> type(file_obj) <class 'cybox.bindings.file_object.FileObjectType'> >>> f = File.from_obj(file_obj) >>> f.file_name.value 'bad.exe' >>> str(f.file_name) 'bad.exe' >>> f.file_name.condition 'Contains'

Comparisons

CybOX objects can be compared for equality using the standard Python equality operator. By default, every field must be equal between the two objects. However, you can explicitly say that some fields should not be considered.

>>> from cybox.objects.file_object import File

>>> file_1 = File.from_dict({'file_name': 'abcd.dll', 'size_in_bytes': '25556'}) >>> file_2 = File.from_dict({'file_name': 'abcd.dll', 'size_in_bytes': '25556'}) >>> file_3 = File.from_dict({'file_name': 'abcd.dll', 'size_in_bytes': '1337'})

# First, disable the use of size_in_bytes comparisons. >>> File.size_in_bytes.comparable = False

>>> file_1 == file_2 True >>> file_1 == file_3 True

# Now, set it back to True (the default). >>> File.size_in_bytes.comparable = True

>>> file_1 == file_2 True >>> file_1 == file_3 False

Custom Objects

The CybOX Custom Object is used to specify objects which do not have their own object type in CybOX. These objects should be used with care, as they can make interoperability more challenging if both producer and consumer do not agree on the fields used in the Custom object.

from cybox.common.object_properties import CustomProperties, Property from cybox.objects.custom_object import Custom

c = Custom()

# This should be a QName with a prefix specific to the application # (i.e. not "example"). The prefix should be included in the output # namespaces. c.custom_name = "example:OfficePassword" c.description = "This is a string used as a password to protect an Microsoft Office document." c.custom_properties = CustomProperties()

p1 = Property() p1.name = "password" p1.description = "MS Office encryption password" p1.value = "SuP3rS3cr3T!" c.custom_properties.append(p1)

print(c.to_xml(include_namespaces=False, encoding=None))

<CustomObj:CustomObjectType xsi:type="CustomObj:CustomObjectType" custom_name="example:OfficePassword">

<cyboxCommon:Custom_Properties>: <cyboxCommon:Property name="password" description="MS Office encryption password">SuP3rS3cr3T!</cyboxCommon:Property>

</cyboxCommon:Custom_Properties> <CustomObj:Description>This is a string used as a password to protect an Microsoft Office document.</CustomObj:Description>

</CustomObj:CustomObjectType>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

examples.rst

examples.rst

Examples

Creating Objects

Creating Observables

HTTP Message Body

HTTP User Agent

Objects with DateTime properties

Hashes

Object Subclasses

ObservableCompositions

Parsing example

Comparisons

Custom Objects

Files

examples.rst

Latest commit

History

examples.rst

File metadata and controls

Examples

Creating Objects

Creating Observables

HTTP Message Body

HTTP User Agent

Objects with DateTime properties

Hashes

Object Subclasses

ObservableCompositions

Parsing example

Comparisons

Custom Objects