1API Coverage
2============
3
4The *python-cybox* APIs currently provide ⚠ partial coverage of all CybOX-defined constructs. Development is ongoing toward the goal of providing ✓ full CybOX language support in the APIs. Until such time that full coverage is provided, an overview of which constructs are available in these APIs will be maintained below.
5
6
7CybOX Features
8--------------
9
10=============================   ==========================  ==========================================
11CybOX Construct                  API Coverage                Documentation
12=============================   ==========================  ==========================================
13Composite Observable            ✓ Full                      :class:`cybox.core.observable.ObservableComposition`
14Event                           ✓ Full                      :class:`cybox.core.event.Event`
15Object                          ✓ Full                      :class:`cybox.core.object.Object`
16Observables                     ✓ Full                      :class:`cybox.core.observable.Observables`
17Observable                      ✓ Full                      :class:`cybox.core.observable.Observable`
18Relationships                   ✓ Full                      :class:`cybox.core.object.RelatedObject`
19=============================   ==========================  ==========================================
20
21CybOX Objects
22-------------
23
24==================================  =====================   ==========================================================================================
25CybOX Construct                     API Coverage            Documentation
26==================================  =====================   ==========================================================================================
27Account Object                      ✓ Full                  :class:`cybox.objects.account_object.Account`
28Address Object                      ✓ Full                  :class:`cybox.objects.address_object.Address`
29API Object                          ✓ Full                  :class:`cybox.objects.api_object.API`
30Archive File Object                 ✓ Full                  :class:`cybox.objects.archive_file_object.ArchiveFile`
31ARP Cache Object                    ✓ Full                  :class:`cybox.objects.arp_cache_object.ARPCache`
32Artifact Object                     ✓ Full                  :class:`cybox.objects.artifact_object.Artifact`
33AS Object                           ✓ Full                  :class:`cybox.objects.as_object.AutonomousSystem`
34Code Object                         ✓ Full                  :class:`cybox.objects.code_object.Code`
35Custom Object                       ✓ Full                  :class:`cybox.objects.custom_object.Custom`
36Device Object                       ✓ Full                  :class:`cybox.objects.device_object.Device`
37Disk Object                         ✓ Full                  :class:`cybox.objects.disk_object.Disk`
38Disk Partition Object               ✓ Full                  :class:`cybox.objects.disk_partition_object.DiskPartition`
39DNS Cache Object                    ✓ Full                  :class:`cybox.objects.dns_cache_object.DNSCache`
40DNS Query Object                    ✓ Full                  :class:`cybox.objects.dns_query_object.DNSQuery`
41DNS Record Object                   ✓ Full                  :class:`cybox.objects.dns_record_object.DNSRecord`
42Domain Name Object                  ✓ Full                  :class:`cybox.objects.domain_name_object.DomainName`
43Email Message Object                ✓ Full                  :class:`cybox.objects.email_message_object.EmailMessage`
44File Object                         ✓ Full                  :class:`cybox.objects.file_object.File`
45GUI Dialogbox Object                ✓ Full                  :class:`cybox.objects.gui_dialogbox_object.GUIDialogbox`
46GUI Object                          ✓ Full                  :class:`cybox.objects.gui_object.GUI`
47GUI Window Object                   ✓ Full                  :class:`cybox.objects.gui_window_object.GUIWindow`
48HTTP Session Object                 ✓ Full                  :class:`cybox.objects.http_session_object.HTTPSession`
49Hostname Object                     ✓ Full                  :class:`cybox.objects.hostname_object.Hostname`
50Image File Object                   ✓ Full                  :class:`cybox.objects.image_file_object.ImageFile`
51Library Object                      ✓ Full                  :class:`cybox.objects.library_object.Library`
52Link Object                         ✓ Full                  :class:`cybox.objects.link_object.Link`
53Linux Package Object                ✓ Full                  :class:`cybox.objects.linux_package_object.LinuxPackage`
54Memory Object                       ✓ Full                  :class:`cybox.objects.memory_object.Memory`
55Mutex Object                        ✓ Full                  :class:`cybox.objects.mutex_object.Mutex`
56Network Connection Object           ✓ Full                  :class:`cybox.objects.network_connection_object.NetworkConnection`
57Network Flow Object                 ✓ Full                  :class:`cybox.objects.network_flow_object.NetworkFlow`
58Network Packet Object               ✓ Full                  :class:`cybox.objects.network_packet_object.NetworkPacket`
59Network Route Entry Object          ✓ Full                  :class:`cybox.objects.network_route_entry_object.NetworkRouteEntry`
60Network Route Object                ✓ Full                  :class:`cybox.objects.network_route_object.NetRoute`
61Network Socket Object               ✓ Full                  :class:`cybox.objects.network_socket_object.NetworkSocket`
62Network Subnet Object               ✓ Full                  :class:`cybox.objects.network_subnet_object.NetworkSubnet`
63PDF File Object                     ✓ Full                  :class:`cybox.objects.pdf_file_object.PDFFile`
64Pipe Object                         ✓ Full                  :class:`cybox.objects.pipe_object.Pipe`
65Port Object                         ✓ Full                  :class:`cybox.objects.port_object.Port`
66Process Object                      ✓ Full                  :class:`cybox.objects.process_object.Process`
67Product Object                      ✓ Full                  :class:`cybox.objects.product_object.Product`
68Semaphore Object                    ✓ Full                  :class:`cybox.objects.semaphore_object.Semaphore`
69SMS Message Object                  ✓ Full                  :class:`cybox.objects.sms_message_object.SMSMessage`
70Socket Address Object               ✓ Full                  :class:`cybox.objects.socket_address_object.SocketAddress`
71System Object                       ✓ Full                  :class:`cybox.objects.system_object.System`
72URI Object                          ✓ Full                  :class:`cybox.objects.uri_object.URI`
73URL History Object                  ✓ Full                  :class:`cybox.objects.url_history.URLHistory`
74Unix File Object                    ✓ Full                  :class:`cybox.objects.unix_file_object.UnixFile`
75Unix Network Route Entry Object     ✓ Full                  :class:`cybox.objects.unix_network_route_entry_object.UnixNetworkRouteEntry`
76Unix Pipe Object                    ✓ Full                  :class:`cybox.objects.unix_pipe_object.UnixPipe`
77Unix Process Object                 ✓ Full                  :class:`cybox.objects.unix_process_object.UnixProcess`
78Unix User Account Object            ✓ Full                  :class:`cybox.objects.unix_user_account_object.UnixUserAccount`
79Unix Volume Object                  ✓ Full                  :class:`cybox.objects.unix_volume_object.UnixVolume`
80User Account Object                 ✓ Full                  :class:`cybox.objects.user_account_object.UserAccount`
81User Session Object                 ✓ Full                  :class:`cybox.objects.user_session_object.UserSession`
82Volume Object                       ✓ Full                  :class:`cybox.objects.volume_object.Volume`
83Whois Object                        ✓ Full                  :class:`cybox.objects.whois_object.WhoisEntry`
84Win Computer Account Object         ✓ Full                  :class:`cybox.objects.win_computer_account_object.WinComputerAccount`
85Win Critical Section Object         ✓ Full                  :class:`cybox.objects.win_critical_section_object.WinCriticalSection`
86Win Driver Object                   ✓ Full                  :class:`cybox.objects.win_driver_object.WinDriver`
87Win Event Log Object                ✓ Full                  :class:`cybox.objects.win_event_log_object.WinEventLog`
88Win Event Object                    ✓ Full                  :class:`cybox.objects.win_event_object.WinEvent`
89Win Executable File Object          ✓ Full                  :class:`cybox.objects.win_executable_file_object.WinExecutableFile`
90Win File Object                     ✓ Full                  :class:`cybox.objects.win_file_object.WinFile`
91Win Filemapping Object              ✓ Full                  :class:`cybox.objects.win_filemapping_object.WinFilemapping`
92Win Handle Object                   ✓ Full                  :class:`cybox.objects.win_handle_object.WinHandle`
93Win Hook Object                     ✓ Full                  :class:`cybox.objects.win_hook_object.WinHook`
94Win Kernel Hook Object              ✓ Full                  :class:`cybox.objects.win_kernel_hook_object.WinKernelHook`
95Win Kernel Object                   ✓ Full                  :class:`cybox.objects.win_kernel_object.WinKernel`
96Win Mailslot Object                 ✓ Full                  :class:`cybox.objects.win_mailslot_object.WinMailslot`
97Win Memory Page Region Object       ✓ Full                  :class:`cybox.objects.win_memory_page_region_object.WinMemoryPageRegion`
98Win Mutex Object                    ✓ Full                  :class:`cybox.objects.win_mutex_object.WinMutex`
99Win Network Route Entry Object      ✓ Full                  :class:`cybox.objects.win_network_route_entry_object.WinNetworkRouteEntry`
100Win Network Share Object            ✓ Full                  :class:`cybox.objects.win_network_share_object.WinNetworkShare`
101Win Pipe Object                     ✓ Full                  :class:`cybox.objects.win_pipe_object.WinPipe`
102Win Prefetch Object                 ✓ Full                  :class:`cybox.objects.win_prefetch_object.WinPrefetch`
103Win Process Object                  ✓ Full                  :class:`cybox.objects.win_process_object.WinProcess`
104Win Registry Key Object             ✓ Full                  :class:`cybox.objects.win_registry_key_object.WinRegistryKey`
105Win Semaphore Object                ✓ Full                  :class:`cybox.objects.win_semaphore_object.WinSemaphore`
106Win Service Object                  ✓ Full                  :class:`cybox.objects.win_service_object.WinService`
107Win System Object                   ✓ Full                  :class:`cybox.objects.win_system_object.WinSystem`
108Win System Restore Object           ✓ Full                  :class:`cybox.objects.win_system_restore_object.WinSystemRestore`
109Win Task Object                     ✓ Full                  :class:`cybox.objects.win_task_object.WinTask`
110Win Thread Object                   ✓ Full                  :class:`cybox.objects.win_thread_object.WinThread`
111Win User Account Object             ✓ Full                  :class:`cybox.objects.win_user_account_object.WinUser`
112Win Volume Object                   ✓ Full                  :class:`cybox.objects.win_volume_object.WinVolume`
113Win Waitable Timer Object           ✓ Full                  :class:`cybox.objects.win_waitable_timer_object.WinWaitableTimer`
114X509 Certificate Object             ✓ Full                  :class:`cybox.objects.x509_certificate_object.X509Certificate`
115==================================  =====================   ==========================================================================================
116
117CybOX Vocabularies
118------------------
119
120=========================================   ========================================    ===========================================================
121CybOX Construct                              API Coverage                                Documentation
122=========================================   ========================================    ===========================================================
123ActionArgumentNameVocab-1.0                 ✓ Full                                      :class:`cybox.common.vocabs.ActionArgumentName`
124ActionNameVocab-1.0                         × None *(replaced by version 1.1)*
125ActionNameVocab-1.1                         ✓ Full                                      :class:`cybox.common.vocabs.ActionName`
126ActionObjectAssociationTypeVocab-1.0        ✓ Full                                      :class:`cybox.common.vocabs.AssociationType`
127ActionRelationshipTypeVocab-1.0             × None
128ActionTypeVocab-1.0                         ✓ Full                                      :class:`cybox.common.vocabs.ActionType`
129CharacterEncodingVocab-1.0                  ✓ Full                                      :class:`cybox.common.vocabs.CharacterEncoding`
130EventTypeVocab-1.0                          × None *(replaced by version 1.0.1)*
131EventTypeVocab-1.0.1                        ✓ Full                                      :class:`cybox.common.vocabs.EventType`
132HashNameVocab-1.0                           ✓ Full                                      :class:`cybox.common.vocabs.HashName`
133InformationSourceTypeVocab-1.0              ✓ Full                                      :class:`cybox.common.vocabs.InformationSourceType`
134ObjectRelationshipVocab-1.0                 × None *(replaced by version 1.1)*
135ObjectRelationshipVocab-1.1                 ✓ Full                                      :class:`cybox.common.vocabs.ObjectRelationship`
136ObjectStateVocab-1.0                        ✓ Full                                      :class:`cybox.common.vocabs.ObjectState`
137ToolTypeVocab-1.0                           × None *(replaced by version 1.1)*
138ToolTypeVocab-1.1                           ✓ Full                                      :class:`cybox.common.vocabs.ToolType`
139=========================================   ========================================    ===========================================================
140