pax_global_header 0000666 0000000 0000000 00000000064 14036072565 0014522 g ustar 00root root 0000000 0000000 52 comment=2a711f1cb4d4f59eb93f4c55043b94e5527e9348
libtaxii-1.1.119/ 0000775 0000000 0000000 00000000000 14036072565 0013501 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/.gitignore 0000664 0000000 0000000 00000000231 14036072565 0015465 0 ustar 00root root 0000000 0000000 *.pyc
*.swp
*.swo
build/
dist/
libtaxii.egg-info/
venv/
.pytest_cache
.tox
output.txt
libtaxii/test/output/
docs/_build/
.idea
.cache
.coverage
htmlcov/
libtaxii-1.1.119/.travis.yml 0000664 0000000 0000000 00000000731 14036072565 0015613 0 ustar 00root root 0000000 0000000 os: linux
language: python
cache: pip
dist: xenial
python:
- "2.7"
- "3.4"
- "3.5"
- "3.6"
- "3.7"
- "3.8"
matrix:
include:
# https://blog.travis-ci.com/2019-04-15-xenial-default-build-environment
# https://travis-ci.community/t/issue-with-python-2-6-on-linux/3861/2
- python: 2.6
dist: trusty
install:
- pip install -U pip setuptools
- pip install tox-travis
script: tox
notifications:
email:
- stix-commits-list@groups.mitre.org
libtaxii-1.1.119/LICENSE.txt 0000664 0000000 0000000 00000002770 14036072565 0015332 0 ustar 00root root 0000000 0000000 Copyright (c) 2017, The MITRE Corporation
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of The MITRE Corporation nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
libtaxii-1.1.119/MANIFEST.in 0000664 0000000 0000000 00000000300 14036072565 0015230 0 ustar 00root root 0000000 0000000 include LICENSE.txt
include README.rst
include libtaxii/xsd/*.xsd
include requirements.txt
recursive-include docs *
recursive-exclude docs *.pyc
recursive-exclude docs *.pyo
prune docs/_build
libtaxii-1.1.119/README.rst 0000664 0000000 0000000 00000004462 14036072565 0015176 0 ustar 00root root 0000000 0000000 libtaxii
========
A Python library for handling `Trusted Automated eXchange of Indicator Information (TAXII™) `_ v1.x Messages and invoking TAXII Services.
:Source: https://github.com/TAXIIProject/libtaxii/
:Documentation: https://libtaxii.readthedocs.io/
:Information: https://taxiiproject.github.io/
:Download: https://pypi.python.org/pypi/libtaxii/
|travis badge| |landscape.io badge| |version badge| |downloads badge|
.. |travis badge| image:: https://api.travis-ci.org/TAXIIProject/libtaxii.svg?branch=master
:target: https://travis-ci.org/TAXIIProject/libtaxii
:alt: Build Status
.. |landscape.io badge| image:: https://landscape.io/github/TAXIIProject/libtaxii/master/landscape.svg?style=flat
:target: https://landscape.io/github/TAXIIProject/libtaxii/master
:alt: Code Health
.. |version badge| image:: https://img.shields.io/pypi/v/libtaxii.svg?maxAge=3600
:target: https://pypi.python.org/pypi/libtaxii/
.. |downloads badge| image:: https://img.shields.io/pypi/dm/libtaxii.svg?maxAge=3600
:target: https://pypi.python.org/pypi/libtaxii/
Overview
--------
A primary goal of libtaxii is to remain faithful to both the TAXII
specifications and to customary Python practices. libtaxii is designed to be
intuitive both to Python developers and XML developers.
Installation
------------
Use pip to install or upgrade libtaxii::
$ pip install libtaxii [--upgrade]
For more information, see the `Installation instructions
`_.
Getting Started
---------------
Read the `Getting Started guide
`_.
Layout
------
The libtaxii repository has the following layout:
* ``docs/`` - Used to build the `documentation
`_.
* ``libtaxii/`` - The main libtaxii source.
* ``libtaxii/tests/`` - libtaxii tests.
* ``xsd/`` - A copy of the TAXII XML Schemas, used by libtaxii for validation.
Versioning
----------
Releases of libtaxii are given ``major.minor.revision`` version numbers, where
``major`` and ``minor`` correspond to the TAXII version being supported. The
``revision``` number is used to indicate new versions of libtaxii.
Feedback
--------
Please provide feedback and/or comments on open issues to taxii@mitre.org.
libtaxii-1.1.119/docs/ 0000775 0000000 0000000 00000000000 14036072565 0014431 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/docs/Makefile 0000664 0000000 0000000 00000015162 14036072565 0016076 0 ustar 00root root 0000000 0000000 # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make ' where is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/libtaxii.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/libtaxii.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/libtaxii"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/libtaxii"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
libtaxii-1.1.119/docs/api/ 0000775 0000000 0000000 00000000000 14036072565 0015202 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/docs/api/clients.rst 0000664 0000000 0000000 00000005402 14036072565 0017376 0 ustar 00root root 0000000 0000000 :mod:`libtaxii.clients` Module
==============================
.. module:: libtaxii.clients
Classes
-------
.. autoclass:: libtaxii.clients.HttpClient
:members: set_auth_type, set_auth_credentials, set_proxy, set_use_https,
set_verify_server, call_taxii_service2
Examples
--------
TAXII clients have three types of authentication credentials: None, HTTP Basic, and TLS Certificate. This section demonstrates usage of all three auth types.
All examples assume the following imports:
.. code-block:: python
import libtaxii as t
import libtaxii.messages_11 as tm11
import libtaxii.clients as tc
from libtaxii.common import generate_message_id
from libtaxii.constants import *
from dateutil.tz import tzutc
Using No Credentials
********************
.. code-block:: python
client = tc.HttpClient()
client.set_auth_type(tc.HttpClient.AUTH_NONE)
client.set_use_https(False)
discovery_request = tm11.DiscoveryRequest(generate_message_id())
discovery_xml = discovery_request.to_xml(pretty_print=True)
http_resp = client.call_taxii_service2('hailataxii.com', '/taxii-discovery-service', VID_TAXII_XML_11, discovery_xml)
taxii_message = t.get_message_from_http_response(http_resp, discovery_request.message_id)
print taxii_message.to_xml(pretty_print=True)
Using Basic HTTP Auth
*********************
.. code-block:: python
client = tc.HttpClient()
client.set_auth_type(tc.HttpClient.AUTH_BASIC)
client.set_auth_credentials({'username': 'guest', 'password': 'guest'})
discovery_request = tm11.DiscoveryRequest(generate_message_id())
discovery_xml = discovery_request.to_xml(pretty_print=True)
http_resp = client.call_taxii_service2('hailataxii.com', '/taxii-discovery-service', VID_TAXII_XML_11, discovery_xml)
taxii_message = t.get_message_from_http_response(http_resp, discovery_request.message_id)
print taxii_message.to_xml(pretty_print=True)
Using TLS Certificate Auth
**************************
Note: The following code is provided as an example of this authentication method, but will not work as-is, because Hail A Taxii does not support TLS.
.. code-block:: python
client = tc.HttpClient()
client.set_use_https(True)
client.set_auth_type(tc.HttpClient.AUTH_CERT)
client.set_auth_credentials({'key_file': '../PATH_TO_KEY_FILE.key', 'cert_file': '../PATH_TO_CERT_FILE.crt'})
discovery_request = tm11.DiscoveryRequest(generate_message_id())
discovery_xml = discovery_request.to_xml(pretty_print=True)
http_resp = client.call_taxii_service2('hailataxii.com', '/taxii-discovery-service/', VID_TAXII_XML_11, discovery_xml)
taxii_message = t.get_message_from_http_response(http_resp, discovery_request.message_id)
print taxii_message.to_xml(pretty_print=True)
libtaxii-1.1.119/docs/api/common.rst 0000664 0000000 0000000 00000000356 14036072565 0017230 0 ustar 00root root 0000000 0000000 :mod:`libtaxii.common` Module
=============================
.. automodule:: libtaxii.common
Functions
---------
.. autofunction:: get_xml_parser
.. autofunction:: set_xml_parser
Classes
-------
.. autoclass:: TAXIIBase
:members:
libtaxii-1.1.119/docs/api/constants.rst 0000664 0000000 0000000 00000013054 14036072565 0017753 0 ustar 00root root 0000000 0000000 :mod:`libtaxii.constants` Module
================================
.. module:: libtaxii.constants
Constants
---------
Version IDs
***********
The following constants can be used as TAXII Version IDs
.. autodata:: VID_TAXII_SERVICES_10
.. autodata:: VID_TAXII_SERVICES_11
.. autodata:: VID_TAXII_XML_10
.. autodata:: VID_TAXII_XML_11
.. autodata:: VID_TAXII_HTTP_10
.. autodata:: VID_TAXII_HTTPS_10
The following are third-party Version IDs included in libtaxii for convenience.
.. autodata:: VID_CERT_EU_JSON_10
Content Binding IDs
*******************
The following constants should be used as the Content Binding ID for STIX XML.
.. autodata:: CB_STIX_XML_10
.. autodata:: CB_STIX_XML_101
.. autodata:: CB_STIX_XML_11
.. autodata:: CB_STIX_XML_111
.. autodata:: CB_STIX_XML_12
These other Content Binding IDs are included for convenience as well.
.. autodata:: CB_CAP_11
.. autodata:: CB_XENC_122002
.. autodata:: CB_SMIME
Namespace Map
*************
This constant contains commonly namespaces and aliases in TAXII.
.. autodata:: NS_MAP
Message Types
*************
.. autodata:: MSG_STATUS_MESSAGE
.. autodata:: MSG_DISCOVERY_REQUEST
.. autodata:: MSG_DISCOVERY_RESPONSE
.. autodata:: MSG_FEED_INFORMATION_REQUEST
.. autodata:: MSG_FEED_INFORMATION_RESPONSE
.. autodata:: MSG_MANAGE_FEED_SUBSCRIPTION_REQUEST
.. autodata:: MSG_MANAGE_FEED_SUBSCRIPTION_RESPONSE
.. autodata:: MSG_POLL_REQUEST
.. autodata:: MSG_POLL_RESPONSE
.. autodata:: MSG_INBOX_MESSAGE
.. autodata:: MSG_TYPES_10
.. autodata:: MSG_POLL_FULFILLMENT_REQUEST
.. autodata:: MSG_COLLECTION_INFORMATION_REQUEST
.. autodata:: MSG_COLLECTION_INFORMATION_RESPONSE
.. autodata:: MSG_MANAGE_COLLECTION_SUBSCRIPTION_REQUEST
.. autodata:: MSG_MANAGE_COLLECTION_SUBSCRIPTION_RESPONSE
.. autodata:: MSG_TYPES_11
Status Types
************
These constants are used in :py:class:`StatusMessage`.
.. autodata:: ST_BAD_MESSAGE
.. autodata:: ST_DENIED
.. autodata:: ST_FAILURE
.. autodata:: ST_NOT_FOUND
.. autodata:: ST_POLLING_UNSUPPORTED
.. autodata:: ST_RETRY
.. autodata:: ST_SUCCESS
.. autodata:: ST_UNAUTHORIZED
.. autodata:: ST_UNSUPPORTED_MESSAGE_BINDING
.. autodata:: ST_UNSUPPORTED_CONTENT_BINDING
.. autodata:: ST_UNSUPPORTED_PROTOCOL
.. autodata:: ST_TYPES_10
.. autodata:: ST_ASYNCHRONOUS_POLL_ERROR
.. autodata:: ST_DESTINATION_COLLECTION_ERROR
.. autodata:: ST_INVALID_RESPONSE_PART
.. autodata:: ST_NETWORK_ERROR
.. autodata:: ST_PENDING
.. autodata:: ST_UNSUPPORTED_QUERY
.. autodata:: ST_TYPES_11
Subscription Actions
********************
These constants are used in :py:class:`ManageFeedSubscriptionRequest`
.. autodata:: ACT_SUBSCRIBE
.. autodata:: ACT_UNSUBSCRIBE
.. autodata:: ACT_STATUS
.. autodata:: ACT_TYPES_10
.. autodata:: ACT_PAUSE
.. autodata:: ACT_RESUME
.. autodata:: ACT_TYPES_11
Service Types
****************
These constants are used to indicate the type of service.
.. autodata:: SVC_INBOX
.. autodata:: SVC_POLL
.. autodata:: SVC_FEED_MANAGEMENT
.. autodata:: SVC_DISCOVERY
.. autodata:: SVC_TYPES_10
.. autodata:: SVC_COLLECTION_MANAGEMENT
.. autodata:: SVC_TYPES_11
Subscription Statuses
*********************
These constants are used in :py:class:`ManageCollectionSubscriptionResponse`
.. autodata:: SS_ACTIVE
.. autodata:: SS_PAUSED
.. autodata:: SS_UNSUBSCRIBED
.. autodata:: SS_TYPES_11
Response Types
**************
These constants are used to indicate the type of response returned.
.. autodata:: RT_FULL
.. autodata:: RT_COUNT_ONLY
.. autodata:: RT_TYPES_11
Collection Types
****************
These constants are used to indicate the type of collection.
.. autodata:: CT_DATA_FEED
.. autodata:: CT_DATA_SET
.. autodata:: CT_TYPES_11
Status Details
**************
These constants are used in :py:class:`StatusMessage`.
.. autodata:: SD_ACCEPTABLE_DESTINATION
.. autodata:: SD_MAX_PART_NUMBER
.. autodata:: SD_ITEM
.. autodata:: SD_ESTIMATED_WAIT
.. autodata:: SD_RESULT_ID
.. autodata:: SD_WILL_PUSH
.. autodata:: SD_SUPPORTED_BINDING
.. autodata:: SD_SUPPORTED_CONTENT
.. autodata:: SD_SUPPORTED_PROTOCOL
.. autodata:: SD_SUPPORTED_QUERY
.. autodata:: SD_TYPES_11
.. autodata:: SD_CAPABILITY_MODULE
.. autodata:: SD_PREFERRED_SCOPE
.. autodata:: SD_ALLOWED_SCOPE
.. autodata:: SD_TARGETING_EXPRESSION_ID
Query Formats
*************
These constants are used to indicate query format.
..autodata:: FID_TAXII_DEFAULT_QUERY_10
Query Capability Modules
************************
These constants are used to indicate TAXII Default Query Capability Modules
.. autodata:: CM_CORE
.. autodata:: CM_REGEX
.. autodata:: CM_TIMESTAMP
.. autodata:: CM_IDS
Query Operators
***************
These constants are used to identify the operator in :py:class`Criteria`
.. autodata:: OP_OR
.. autodata:: OP_AND
.. autodata:: OP_TYPES
Query Status Types
******************
TAXII Default Query 1.0 identifies three additional Status Types:
.. autodata:: ST_UNSUPPORTED_CAPABILITY_MODULE
.. autodata:: ST_UNSUPPORTED_TARGETING_EXPRESSION
.. autodata:: ST_UNSUPPORTED_TARGETING_EXPRESSION_ID
Query Parameters
****************
These constants are used to identify parameters.
.. autodata:: P_VALUE
.. autodata:: P_MATCH_TYPE
.. autodata:: P_CASE_SENSITIVE
.. autodata:: P_NAMES
Query Relationships
*******************
These constants are used to identify relationships
.. autodata:: R_EQUALS
.. autodata:: R_NOT_EQUALS
.. autodata:: R_GREATER_THAN
.. autodata:: R_GREATER_THAN_OR_EQUAL
.. autodata:: R_LESS_THAN
.. autodata:: R_LESS_THAN_OR_EQUAL
.. autodata:: R_DOES_NOT_EXIST
.. autodata:: R_EXISTS
.. autodata:: R_BEGINS_WITH
.. autodata:: R_ENDS_WITH
.. autodata:: R_CONTAINS
.. autodata:: R_MATCHES
.. autodata:: R_NAMES
libtaxii-1.1.119/docs/api/libtaxii.rst 0000664 0000000 0000000 00000000214 14036072565 0017536 0 ustar 00root root 0000000 0000000 :mod:`libtaxii` Module
=======================
.. module:: libtaxii
Functions
---------
.. autofunction:: get_message_from_http_response
libtaxii-1.1.119/docs/api/messages_10.rst 0000664 0000000 0000000 00000017325 14036072565 0020053 0 ustar 00root root 0000000 0000000 :mod:`libtaxii.messages_10` Module
==================================
.. automodule:: libtaxii.messages_10
.. note::
The examples on this page assume that you have run the equivalent of
.. code-block:: python
import datetime
from dateutil.tz import tzutc
import libtaxii as t
import libtaxii.messages_10 as tm10
from libtaxii.constants import *
.. testsetup::
import datetime
from dateutil.tz import tzutc
import libtaxii as t
import libtaxii.messages_10 as tm10
from libtaxii.constants import *
Status Message
--------------
.. autoclass:: StatusMessage
**Example:**
.. testcode::
status_message1 = tm10.StatusMessage(
message_id=tm10.generate_message_id(),
in_response_to="12345",
status_type=ST_SUCCESS,
status_detail='Machine-processable info here!',
message='This is a message.')
Discovery Request
-----------------
.. autoclass:: DiscoveryRequest
**Example:**
.. testcode::
ext_headers = {'name1': 'val1', 'name2': 'val2'}
discovery_request = tm10.DiscoveryRequest(
message_id=tm10.generate_message_id(),
extended_headers=ext_headers)
Discovery Response
------------------
.. autoclass:: DiscoveryResponse
.. autoclass:: ServiceInstance
**Example:**
.. testcode::
discovery_response = tm10.DiscoveryResponse(
message_id=tm10.generate_message_id(),
in_response_to=discovery_request.message_id)
service_instance = tm10.ServiceInstance(
service_type=SVC_INBOX,
services_version=VID_TAXII_SERVICES_10,
protocol_binding=VID_TAXII_HTTPS_10,
service_address='https://example.com/inbox/',
message_bindings=[VID_TAXII_XML_10],
inbox_service_accepted_content=[CB_STIX_XML_10],
available=True,
message='This is a sample inbox service instance')
discovery_response.service_instances.append(service_instance)
# Alternatively, you could define the service instance(s) first and use the
# following:
service_instance_list = [service_instance]
discovery_response = tm10.DiscoveryResponse(
message_id=tm10.generate_message_id(),
in_response_to=discovery_request.message_id,
service_instances=service_instance_list)
Feed Information Request
------------------------
.. autoclass:: FeedInformationRequest
**Example:**
.. testcode::
ext_headers = {'name1': 'val1', 'name2': 'val2'}
feed_information_request= tm10.FeedInformationRequest(
message_id=tm10.generate_message_id(),
extended_headers=ext_headers)
Feed Information Response
-------------------------
.. autoclass:: FeedInformationResponse
.. autoclass:: FeedInformation
.. autoclass:: PushMethod
.. autoclass:: PollingServiceInstance
.. autoclass:: SubscriptionMethod
**Example:**
.. testcode::
push_method1 = tm10.PushMethod(
push_protocol=VID_TAXII_HTTP_10,
push_message_bindings=[VID_TAXII_XML_10])
polling_service1 = tm10.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTP_10,
poll_address='http://example.com/PollService/',
poll_message_bindings=[VID_TAXII_XML_10])
subscription_service1 = tm10.SubscriptionMethod(
subscription_protocol=VID_TAXII_HTTP_10,
subscription_address='http://example.com/SubsService/',
subscription_message_bindings=[VID_TAXII_XML_10])
feed1 = tm10.FeedInformation(
feed_name='Feed1',
feed_description='Description of a feed',
supported_contents=[CB_STIX_XML_10],
available=True,
push_methods=[push_method1],
polling_service_instances=[polling_service1],
subscription_methods=[subscription_service1])
feed_information_response1 = tm10.FeedInformationResponse(
message_id=tm10.generate_message_id(),
in_response_to=tm10.generate_message_id(),
feed_informations=[feed1])
Manage Feed Subscription Request
--------------------------------
.. autoclass:: ManageFeedSubscriptionRequest
**Example:**
.. testcode::
delivery_parameters1 = tm10.DeliveryParameters(
inbox_protocol=VID_TAXII_HTTP_10,
inbox_address='http://example.com/inbox',
delivery_message_binding=VID_TAXII_XML_10,
content_bindings=[CB_STIX_XML_10])
manage_feed_subscription_request1 = tm10.ManageFeedSubscriptionRequest(
message_id=tm10.generate_message_id(),
feed_name='SomeFeedName',
action=ACT_UNSUBSCRIBE,
subscription_id='SubsId056',
delivery_parameters=delivery_parameters1)
Manage Feed Subscription Response
---------------------------------
.. autoclass:: ManageFeedSubscriptionResponse
.. autoclass:: SubscriptionInstance
.. autoclass:: PollInstance
**Example:**
.. testcode::
poll_instance1 = tm10.PollInstance(
poll_protocol=VID_TAXII_HTTP_10,
poll_address='http://example.com/poll',
poll_message_bindings=[VID_TAXII_XML_10])
subscription_instance1 = tm10.SubscriptionInstance(
subscription_id='SubsId234',
delivery_parameters=[delivery_parameters1],
poll_instances=[poll_instance1])
manage_feed_subscription_response1 = tm10.ManageFeedSubscriptionResponse(
message_id=tm10.generate_message_id(),
in_response_to="12345",
feed_name='Feed001',
message='This is a message',
subscription_instances=[subscription_instance1])
Poll Request
------------
.. autoclass:: PollRequest
**Example:**
.. testcode::
poll_request1 = tm10.PollRequest(
message_id=tm10.generate_message_id(),
feed_name='TheFeedToPoll',
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()),
subscription_id='SubsId002',
content_bindings=[CB_STIX_XML_10])
Poll Response
-------------
.. autoclass:: PollResponse
**Example:**
.. testcode::
poll_response1 = tm10.PollResponse(
message_id=tm10.generate_message_id(),
in_response_to="12345",
feed_name='FeedName',
inclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()),
subscription_id='SubsId001',
message='This is a message.',
content_blocks=[])
Inbox Message
-------------
.. autoclass:: InboxMessage
.. autoclass:: SubscriptionInformation
**Example:**
.. testcode::
cb1 = tm10.ContentBlock(CB_STIX_XML_11, "")
subscription_information1 = tm10.SubscriptionInformation(
feed_name='SomeFeedName',
subscription_id='SubsId021',
inclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()))
inbox_message1 = tm10.InboxMessage(
message_id=tm10.generate_message_id(),
message='This is a message.',
subscription_information=subscription_information1,
content_blocks=[cb1])
Other Classes
-------------
.. autoclass:: TAXIIMessage
.. autoclass:: ContentBlock
**Example:**
.. testcode::
cb1 = tm10.ContentBlock(
content_binding=CB_STIX_XML_10,
content='')
.. autoclass:: DeliveryParameters
Functions
---------
.. autofunction:: generate_message_id
.. autofunction:: validate_xml
.. autofunction:: get_message_from_xml
.. autofunction:: get_message_from_dict
.. autofunction:: get_message_from_json
libtaxii-1.1.119/docs/api/messages_11.rst 0000664 0000000 0000000 00000023515 14036072565 0020052 0 ustar 00root root 0000000 0000000 :mod:`libtaxii.messages_11` Module
==================================
.. automodule:: libtaxii.messages_11
.. note::
The examples on this page assume that you have run the equivalent of
.. code-block:: python
import datetime
from dateutil.tz import tzutc
import libtaxii as t
import libtaxii.messages_11 as tm11
from libtaxii.constants import *
.. testsetup::
import datetime
from dateutil.tz import tzutc
import libtaxii as t
import libtaxii.messages_11 as tm11
from libtaxii.constants import *
Status Message
--------------
.. autoclass:: StatusMessage
**Example:**
.. testcode::
sm03 = tm11.StatusMessage(
message_id='SM03',
in_response_to=tm11.generate_message_id(),
status_type=ST_DESTINATION_COLLECTION_ERROR,
status_detail={'ACCEPTABLE_DESTINATION': ['Collection1','Collection2']})
Discovery Request
-----------------
.. autoclass:: DiscoveryRequest
**Example:**
.. testcode::
headers={'ext_header1': 'value1', 'ext_header2': 'value2'}
discovery_request = tm11.DiscoveryRequest(
message_id=tm11.generate_message_id(),
extended_headers=headers)
Discovery Response
------------------
.. autoclass:: DiscoveryResponse
.. autoclass:: ServiceInstance
**Example:**
.. testcode::
discovery_response = tm11.DiscoveryResponse(
message_id=tm11.generate_message_id(),
in_response_to=discovery_request.message_id)
service_instance = tm11.ServiceInstance(
service_type=SVC_POLL,
services_version=VID_TAXII_SERVICES_11,
protocol_binding=VID_TAXII_HTTP_10,
service_address='http://example.com/poll/',
message_bindings=[VID_TAXII_XML_11],
available=True,
message='This is a message.',
#supported_query=[tdq1],
)
discovery_response.service_instances.append(service_instance)
# Alternatively, you could define the service instance(s) first and use the
# following:
service_instance_list = [service_instance]
discovery_response = tm11.DiscoveryResponse(
message_id=tm11.generate_message_id(),
in_response_to=discovery_request.message_id,
service_instances=service_instance_list)
Collection Information Request
------------------------------
.. autoclass:: CollectionInformationRequest
**Example:**
.. testcode::
ext_headers = {'name1': 'val1', 'name2': 'val2'}
collection_information_request = tm11.CollectionInformationRequest(
message_id='CIReq01',
extended_headers=ext_headers)
Collection Information Response
-------------------------------
.. autoclass:: CollectionInformationResponse
.. autoclass:: CollectionInformation
.. autoclass:: PushMethod
.. autoclass:: PollingServiceInstance
.. autoclass:: SubscriptionMethod
.. autoclass:: ReceivingInboxService
**Example:**
.. testcode::
push_method1 = tm11.PushMethod(
push_protocol=VID_TAXII_HTTP_10,
push_message_bindings=[VID_TAXII_XML_11])
poll_service1 = tm11.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/PollService1',
poll_message_bindings=[VID_TAXII_XML_11])
poll_service2 = tm11.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/PollService2',
poll_message_bindings=[VID_TAXII_XML_11])
subs_method1 = tm11.SubscriptionMethod(
subscription_protocol=VID_TAXII_HTTPS_10,
subscription_address='https://example.com/SubscriptionService',
subscription_message_bindings=[VID_TAXII_XML_11])
inbox_service1 = tm11.ReceivingInboxService(
inbox_protocol=VID_TAXII_HTTPS_10,
inbox_address='https://example.com/InboxService',
inbox_message_bindings=[VID_TAXII_XML_11],
supported_contents=None)
collection1 = tm11.CollectionInformation(
collection_name='collection1',
collection_description='This is a collection',
supported_contents=[tm11.ContentBinding(CB_STIX_XML_101)],
available=False,
push_methods=[push_method1],
polling_service_instances=[poll_service1, poll_service2],
subscription_methods=[subs_method1],
collection_volume=4,
collection_type=CT_DATA_FEED,
receiving_inbox_services=[inbox_service1])
collection_response1 = tm11.CollectionInformationResponse(
message_id='CIR01',
in_response_to='0',
collection_informations=[collection1])
Manage Collection Subscription Request
--------------------------------------
.. autoclass:: ManageCollectionSubscriptionRequest
**Example:**
.. testcode::
subscription_parameters1 = tm11.SubscriptionParameters()
push_parameters1 = tm11.PushParameters("", "", "")
subs_req1 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq01',
action=ACT_SUBSCRIBE,
collection_name='collection1',
subscription_parameters=subscription_parameters1,
push_parameters=push_parameters1)
Manage Collection Subscription Response
---------------------------------------
.. autoclass:: ManageCollectionSubscriptionResponse
.. autoclass:: SubscriptionInstance
.. autoclass:: PollInstance
**Example:**
.. testcode::
subscription_parameters1 = tm11.SubscriptionParameters()
push_parameters1 = tm11.PushParameters("", "", "")
poll_instance1 = tm11.PollInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/poll1/',
poll_message_bindings=[VID_TAXII_XML_11])
subs1 = tm11.SubscriptionInstance(
subscription_id='Subs001',
status=SS_ACTIVE,
subscription_parameters=subscription_parameters1,
push_parameters=push_parameters1,
poll_instances=[poll_instance1])
subs_resp1 = tm11.ManageCollectionSubscriptionResponse(
message_id='SubsResp01',
in_response_to='xyz',
collection_name='abc123',
message='Hullo!',
subscription_instances=[subs1])
Poll Request
------------
.. autoclass:: PollRequest
.. autoclass:: PollParameters
**Example:**
.. testcode::
delivery_parameters1 = tm11.DeliveryParameters(
inbox_protocol=VID_TAXII_HTTPS_10,
inbox_address='https://example.com/inboxAddress/',
delivery_message_binding=VID_TAXII_XML_11)
poll_params1 = tm11.PollParameters(
allow_asynch=False,
response_type=RT_COUNT_ONLY,
content_bindings=[tm11.ContentBinding(binding_id=CB_STIX_XML_11)],
#query=query1,
delivery_parameters=delivery_parameters1)
poll_req3 = tm11.PollRequest(
message_id='PollReq03',
collection_name='collection100',
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()),
poll_parameters=poll_params1)
Poll Response
-------------
.. autoclass:: PollResponse
**Example:**
.. testcode::
cb1 = tm11.ContentBlock(CB_STIX_XML_11, "")
cb2 = tm11.ContentBlock(CB_STIX_XML_11, "")
count = tm11.RecordCount(record_count=22, partial_count=False)
poll_resp1 = tm11.PollResponse(
message_id='PollResp1',
in_response_to='tmp',
collection_name='blah',
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()),
subscription_id='24',
message='This is a test message',
content_blocks=[cb1, cb2],
more=True,
result_id='123',
result_part_number=1,
record_count=count)
Inbox Message
-------------
.. autoclass:: InboxMessage
.. autoclass:: SubscriptionInformation
**Example:**
.. testcode::
cb1 = tm11.ContentBlock(CB_STIX_XML_11, "")
cb2 = tm11.ContentBlock(CB_STIX_XML_11, "")
subs_info1 = tm11.SubscriptionInformation(
collection_name='SomeCollectionName',
subscription_id='SubsId021',
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()))
inbox1 = tm11.InboxMessage(
message_id='Inbox1',
result_id='123',
destination_collection_names=['collection1','collection2'],
message='Hello!',
subscription_information=subs_info1,
record_count=tm11.RecordCount(22, partial_count=True),
content_blocks=[cb1, cb2])
Poll Fulfillment Request
------------------------
.. autoclass:: PollFulfillmentRequest
**Example:**
.. testcode::
pf1 = tm11.PollFulfillmentRequest(
message_id='pf1',
collection_name='1-800-collection',
result_id='123',
result_part_number=1)
Other Classes
-------------
.. autoclass:: TAXIIMessage
.. autoclass:: ContentBinding
.. autoclass:: ContentBlock
**Example:**
.. testcode::
cb001 = tm11.ContentBlock(
content_binding=tm11.ContentBinding(CB_STIX_XML_11),
content='',
timestamp_label=datetime.datetime.now(tzutc()),
message='Hullo!',
padding='The quick brown fox jumped over the lazy dogs.')
.. autoclass:: DeliveryParameters
.. autoclass:: PushParameters
.. autoclass:: RecordCount
.. autoclass:: SubscriptionParameters
Functions
---------
.. autofunction:: generate_message_id
.. autofunction:: validate_xml
.. autofunction:: get_message_from_xml
.. autofunction:: get_message_from_dict
.. autofunction:: get_message_from_json
libtaxii-1.1.119/docs/api/modules.rst 0000664 0000000 0000000 00000000253 14036072565 0017404 0 ustar 00root root 0000000 0000000 .. _apidoc:
API Documentation
-----------------
.. toctree::
libtaxii
common
constants
clients
messages_10
messages_11
query
validation
libtaxii-1.1.119/docs/api/query.rst 0000664 0000000 0000000 00000013227 14036072565 0017106 0 ustar 00root root 0000000 0000000 :mod:`libtaxii.taxii_default_query` Module
==========================================
.. automodule:: libtaxii.taxii_default_query
Classes
-------
Default Query
*************
.. autoclass:: DefaultQuery
:show-inheritance:
:members:
**Example**
.. code-block:: python
import libtaxii.taxii_default_query as tdq
from libtaxii.taxii_default_query import Test
from libtaxii.taxii_default_query import Criterion
from libtaxii.taxii_default_query import Criteria
from libtaxii.constants import *
import datetime
##############################################################################
# A Taxii Default Query *Test* gives the consumer granular control over the
# Target of a Query by applying unambiguos relationship requirements specified
# using a standardized vocabulary.
# Each Relationship (e.g. equals, matches, greater_than, etc.) in a Capability
# Module defines a set of paramater fields, capable of expressing that
# relation.
# The *equals* relationship, of the Core Capability Module, returns True if
# the target matches the value exactly. If the target merely contains the
# value (but does not match exactly) the relationship Test returns False.
test_equals = Test(capability_id=CM_CORE,
relationship='equals',
parameters={'value': 'Test value',
'match_type': 'case_sensitive_string'})
# The *matches* relationship, in the context of the Regular Expression
# Capability Module, returns true if the target matches the regular expression
# contained in the value.
test_matches = Test(capability_id=CM_REGEX,
relationship='matches',
parameters={'value': '[A-Z]*',
'case_sensitive': True})
# The *greater than* relationship, in the context of the Timestamp Capability
# Module returns True if the target's timestamp indicates a later time than
# that specified by this value. This relationship is only valid for timestamp
# comparisons.
test_timestamp = Test(capability_id=CM_TIMESTAMP,
relationship='greater_than',
parameters={'value': datetime.datetime.now()})
##############################################################################
# A *Criterion* specifies how a Target is evaluated against a Test. Within a
# Criterion, the Target is used to identify a specific region of a record to
# which the Test should be applied. Slash Notation Targeting Expression syntax,
# in conjunction with a Targeting Expression Vocabulary, are used to form a
# Targeting Expression
# A Multi-field Wildcard (**). This indicates any Node or series of Nodes,
# specified by double asterisks.
criterion1 = Criterion(target='**',
test=test_equals)
# Indicates that *id* fields in the STIX Indicator construct are in scope
criterion2 = Criterion(target='STIX_Package/Indicators/Indicator/@id',
test=test_matches)
# Indicates that all STIX Description fields are in scope
criterion3 = Criterion(target='**/Description',
test=test_timestamp)
##############################################################################
# *Criteria* consist of a logical operator (and/or) that should be applied to
# child Criteria and Criterion to determine whether content matches this query.
criteria1 = Criteria(operator=OP_AND,
criterion=[criterion1])
criteria2 = Criteria(operator=OP_OR,
criterion=[criterion1, criterion2, criterion3])
criteria3 = Criteria(operator=OP_AND,
criterion=[criterion1, criterion3],
criteria=[criteria2])
##############################################################################
# query1, query2 and query3 would be able to be used in TAXII requests that
# contain queries (e.g., PollRequest Messages)
query1 = tdq.DefaultQuery(targeting_expression_id=CB_STIX_XML_111,
criteria=criteria1)
query2 = tdq.DefaultQuery(targeting_expression_id=CB_STIX_XML_111,
criteria=criteria3)
query3 = tdq.DefaultQuery(targeting_expression_id=CB_STIX_XML_111,
criteria=criteria2)
Default Query Info
******************
.. autoclass:: DefaultQueryInfo
:show-inheritance:
:members:
**Example**
.. code-block:: python
import libtaxii.taxii_default_query as tdq
from libtaxii.taxii_default_query import TargetingExpressionInfo
from libtaxii.constants import *
##############################################################################
# *TargetingExpressionInfo* describes which expressions are available to
# a consumer when submitting a query to a taxii service. A
# `targetting_expression_id` indicates a suppoted targetting vocabulary
# TargetingExpressionInfo also contains the permissible scope of queries.
# This example has no preferred scope, and allows any scope
tei_01 = TargetingExpressionInfo(
targeting_expression_id=CB_STIX_XML_111,
preferred_scope=[],
allowed_scope=['**'])
# This example prefers the Indicator scope and allows no other scope
tei_02 = TargetingExpressionInfo(
targeting_expression_id=CB_STIX_XML_111,
preferred_scope=['STIX_Package/Indicators/Indicator/**'],
allowed_scope=[])
##############################################################################
# *DefaultQueryInfo* describes the TAXII Default Queries that are supported
# using a list of TargetExpressionInfo objects, and a list of capability
# module identifiers.
tdqi1 = tdq.DefaultQueryInfo(
targeting_expression_infos=[tei_01, tei_02],
capability_modules=[CM_CORE])
libtaxii-1.1.119/docs/api/validation.rst 0000664 0000000 0000000 00000001053 14036072565 0020065 0 ustar 00root root 0000000 0000000 :mod:`libtaxii.validation` Module
=================================
.. _apivalidation:
.. currentmodule:: libtaxii.validation
Validate TAXII Content
----------------------
.. autoclass:: SchemaValidator
:members:
:exclude-members: TAXII_10_SCHEMA, TAXII_11_SCHEMA
.. autodata:: TAXII_10_SCHEMA
:annotation: Use TAXII 1.0 schema for validation.
.. autodata:: TAXII_11_SCHEMA
:annotation: Use TAXII 1.1 schema for validation.
.. autoclass:: TAXII10Validator
:show-inheritance:
.. autoclass:: TAXII11Validator
:show-inheritance:
libtaxii-1.1.119/docs/changes.rst 0000664 0000000 0000000 00000037347 14036072565 0016611 0 ustar 00root root 0000000 0000000 Release Notes
=============
1.1.119 (2021-04-15)
--------------------
`(diff) `__
- #248 Writing content blocks should not be dependent on value of "more" (@brlogan)
1.1.118 (2020-10-19)
--------------------
`(diff) `__
- #247 [CVE-2020-27197] Avoid SSRF on parsing XML (@orsinium)
1.1.117 (2020-05-26)
--------------------
`(diff) `__
- #244 SSL Verify Server not working correctly (@motok) (@nschwane)
- #245 Unicode `lxml.etree.SerialisationError` on lxml 4.5.0+ (@advptr)
1.1.116 (2020-02-14)
--------------------
`(diff) `__
- #240 PY3 Compatibility changes for HTTP Response Body (@nschwane)
1.1.115 (2019-11-12)
--------------------
`(diff) `__
- #239 Convert the HTTP response body to a string type (PY3 this will be bytes) (@sddj)
1.1.114 (2019-07-26)
--------------------
`(diff) `__
- #237 Support converting dicts to content bindings (@danielsamuels)
- #238 Provide XMLParser copies instead of reusing the cached instance. Prevents future messages to lose namespace
1.1.113 (2019-04-11)
--------------------
`(diff) `__
- #234 Add ability to load a configuration file when executing a script
- #232 Fix TLS handshake failure when a server requires SNI (@marcelslotema)
1.1.112 (2018-11-27)
--------------------
`(diff) `__
- #227 Fixes to poll_client script (Python3 compatibility)
- #226 Clean-up documentation warnings
- #228 Fix 'HTTPMessage' has no attribute 'getheader' (Python3 compatibility)
- #225 Fix checks that involve xpath (lxml) to prevent FutureWarning message
- #230 Fix parsing status message round-trip (@danielsamuels)
1.1.111 (2017-06-07)
--------------------
`(diff) `__
- Fix #222, #224 - Update clients.py to work with Python 2.6, 3.3, 3.5, and 3.6.
- Fix #221 - Add Python 3.6 support.
- Fix #219 - Handle Unicode- and byte-strings consistently.
- Fix #214 - Add timeout parameter to call_taxii_service2 (@mbekavac)
- Fix #192 - Add support for STIX 1.2.
- Add user_agent parameter to call_taxii_service2 (@kralka)
1.1.110 (2016-09-08)
--------------------
`(diff) `__
- Fix #210 - Use hailataxii.com in examples instead of taxiitest.mitre.org (@clenk)
- Fix #183 - Update incorrect comment (@daybarr)
- Fix SMIME Content Binding ID typo (@brlogan)
1.1.109 (2015-11-16)
--------------------
`(diff) `__
- Fix #203 - Fix SSL context on older Python 2.7 versions (@traut)
1.1.108 (2015-10-29)
--------------------
`(diff) `__
- Support password-protected SSL keys (@traut)
- Fix #200 - Bad encodings no longer generate Exceptions (@MarkDavidson)
1.1.107 (2015-08-05)
--------------------
`(diff) `__
- Fix #184 - Use proxy for both HTTP and HTTPS (@nadavc)
- Fix #187 - Handle numeric values in taxii_default_query (@stkyle)
- Update Example Query documentation (@stkyle)
- Fix #189 - Update how constants are used and referenced (@stkyle)
- Show HTTP error code in StatusMessage.message (@ahippo)
- Python 3 compatibility (@rjprins)
1.1.106
-------
`(diff) `__
- Thank you to the multiple contributors for this release: @traut, @gtback, @wbolster, and @MarkDavidson, and thank you to those who filed issues that were fixed in this release.
- Timestamp labels can now be provided as a string or as a python datetime object. Previously, only datetime objects were permitted.
- Some big changes to TAXII Client command line args. Deprecated URL components (e.g., --host, --port) in favor of specifying a single url (--url)
- Added a TAXII Inbox 1.0 client
- Decreased the likelihood of future message ID collisions
- A variety of improvements in the following areas: data validation, typos, documentation, DRY-ness, overall repo quality (thanks @gtback)
- Multiple code cleanup changes (Thanks in part to @traut of IntelWorks)
1.1.105
-------
`(diff) `__
- Fixed multiple XML parsing related vulnerabilities (Thanks @guidovranken of IntelWorks for the vulnerability research!)
1.1.104
-------
`(diff) `__
- Fixed a bug where libtaxii did not properly handle XML values for Extended Headers
- Added checking for required status detail keys in Status Messages
- Improved data validation in various places, fixed various bugs, and improved documentation
- Improved filename generation in scripts (Thanks @guidovranken!)
1.1.103
-------
`(diff) `__
In terms of code organization, there are a few big changes beginning to
take place in this version of libtaxii. Constants and commonly used classes/functions
are being moved to common locations (libtaxii.constants and libtaxii.common, respectively).
Also, nested classes (e.g., messages_11.DiscoveryResponse.ServiceInstance) have been de-nested
(e.g., is now messages_11.ServiceInstance). All of these changes are intended to make
using libtaxii easier. For the time being, backward compatibility has been maintained, but
many of these changes may result in a backward compatibility breaking change in a future,
major release of libtaxii.
Major changes:
- libtaxii.constants, a new source file, was created. The definition for all constants in libtaxii have been moved to libtaxii.constants. Aliases to the previous definition locations have been retained for backward compatibility and may be removed in a future major release.
- libtaxii.common, a new source file for containing classes and methods common to TAXII, was created. Some common classes and functions have been moved into libtaxii.common, and more will be moved over time. Aliases to the previous classes and functions have been retained for backward compatibility and may be removed in a future major release. (Thanks, @gtback!)
- Promoted nested classes to module-level classes in messages_10, messages_11, and taxii_default_query. Aliases to the previous, nested, classes have been retained for backward compatibility and may be removed in a future major release. (Thanks, @gtback!)
- A ‘to_text()’ method has been added to all TAXII Message classes. ‘to_text()’ provides a “nicely formatted” human readable representation of a TAXII Message and its components. The ‘to_text()’ method was added to support libtaxii’s scripts. There is no ‘from_text()’ method as this is not intended to be a serialization/deserialization feature, but a readability feature.
- Lowered the required version of lxml to 2.2.3, the latest available on RHEL 6. (Thanks to @mblayman for raising this)
- Lowered the required version of python-dateutil to 1.4.1, the latest available on RHEL 6. (Thanks to @mblayman for raising this)
- TAXII 1.1 StatusMessages now raise a ValueError when required a Status Detail is not set.
- TAXII XML Validation has a new methodology: See validation.SchemaValidator (http://libtaxii.readthedocs.org/en/latest/api/validation.html#libtaxii.validation.SchemaValidator)
- Related: validate_xml(…) has been deprecated and may be removed in a future major release.
Minor changes:
- Tons of PEP8 improvements (Thanks, @gtback!)
- TAXII Scripts have been entirely reorganized to be more DRY.
- Added two constants for Proxy Settings (SYSTEM_PROXY and NO_PROXY). These supersede the need to use either None or ‘noproxy’, which were not as clear to developers.
- Improved documentation, Tox usage, and Travis-CI usage. (Thanks, @gtback!)
- SMIME Content Binding added (application/x-pks7-mime)
- For Python 2.6, argparse is now a requirement
- Added constants for TAXII Default Query Parameters and Relationships
Bug fixes:
- In messages_11.PollResponse, the result_part_number parameter is now set by the constructor.
1.1.102
-------
`(diff) `__
The biggest change was the addition of scripts to libtaxii. Now when you install libtaxii, you get
a number of scripts that are by default configured to hit the TAXII Test server (taxiitest.mitre.org).
You can specify a number of parameters on the command line to change where/how the scripts connect.
The scripts are:
- discovery_client - Calls a TAXII 1.1 Discovery Service
- fulfillment_client - Calls a TAXII 1.1 Poll Service for Poll Fulfillment
- inbox_client - Calls a TAXII 1.1 Inbox Service. Comes packaged with a STIX document to use by default.
- poll_client - Calls a TAXII 1.1 Poll Service
- poll_client_10 - Calls a TAXII 1.0 Poll Service (Note: Does not work with taxiitest.mitre.org, as taxiitest.mitre.org is TAXII 1.1 only)
- query_client - Calls a TAXII 1.1 Poll Service with a query on IP or File Hash (Note: As of 6/11/2014; Works with the master branch of YETI, and will work with YETI after the next release of YETI)
We also had a number of bug fixes and impprovements for this version of libtaxii:
- Unicode strings work round trip (Hat tip to Ben Yates for reporting the issue)
- Added TONS of documentation (http://libtaxii.readthedocs.org/en/latest/index.html). Big thanks to @gtback and @slsnow!
- Fixed some issues in ContentBlock.content where certain data was not serializing/deserializing properly
- Streamlined serialization of XML documents to avoid a double-parse in certain cases
- Added a Content Binding ID for STIX XML 1.1.1
- Added an optional pretty_print argument to all to_xml() functions. e.g., to_xml(pretty_print=True)
- Added the three TAXII Default Query Status Type to libtaxii.taxii_default_query
- Fixed a bug where custom Status Types were prohibited
- Added Travis CI
1.1.101
-------
`(diff) `__
Lots of changes in this release, including some important bug fixes.
- The equals method for all TAXII Messages was fixed (previous it would
incorrectly return True in many cases).
- Fixed various serialization/deserialization issues uncovered by the now
correctly implemented equals methods.
- Added a defined Content-Type for TAXII XML 1.1.
- Corrected the value of ST\_UNSUPPORTED\_PROTOCOL.
- Fixed a bug when parsing non-TAXII responses.
- Fixed a bug where the Subscription ID was not allowed to be none in
ManageFeedSubscriptionRequest (The Subscription ID must be None for
subscription requests with an action of SUBSCRIBE).
- Fixed a bug where DeliveryParameters were not permitted to be None in a
ManageFeedSubscriptionRequest.
- Added code to permit the setting of certain HTTP Headers (Accept,
X-TAXII-Accept).
- Improved libtaxii's handling of non-XML content that looks like XML
- Added Constants for TAXII Headers (and updated the code to use them).
- Improved handling of non-registered Query formats (now an exception is
raised; previously None was returned).
- libtaxii now provides an X-TAXII-Services header.
1.1.100
-------
`(diff) `__
*This version contains known bugs. Use a more recent version of libtaxii
when possible.*
- First release that supports TAXII 1.1.
- No changes to TAXII 1.0 code.
- Added documentation for Messages 1.1 API and TAXII Default Query.
1.0.107
-------
`(diff) `__
- Fixed an issue that was causing invalid TAXII XML to be generated
(Thanks [@JamesNK](https://github.com/JamesNK)).
- Fixed an issue in the messages test suite that caused the invalid XML
to not be caught.
1.0.106
-------
`(diff) `__
- Added validation to messages.py. This should not cause any backwards
compatibility issues, but there may be things we didn't catch. Please
report any instances of this via the issue tracker.
- Modified the internals of ``from_dict()`` and ``from_xml()`` in many
cases to support how validation now works.
- Added constructor arguments to HttpClient. Default behavior is still
the same.
- Added the ability to specify whether or not an HTTP Server's SSL
Certificate should be verified.
- Prettified some of the documentation.
- Added documentation in certain places where there was none previously.
1.0.105
-------
`(diff) `__
- Added support for JSON (Thanks to [@ics](https://github.com/ics),
Alex Ciobanu of CERT EU).
- callTaxiiService2 now supports user-specified content\_types (Thanks
to Alex Ciobanu of CERT EU).
- Fixed `Issue #18 `__,
libtaxii.messages now permits users to specify any lxml parser for
parsing XML. A default parser is used when one is not specified,
which is unchanged from previous usage.
1.0.104
-------
`(diff) `__
- Many of the comments were aligned with PEP8 guidelines (thanks
[@gtback](https://github.com/gtback)!)
- Added a new authentication mechanism (AUTH\_CERT\_BASIC) to
clients.py. This authentication mechanism supports Certificate
Authentication plus HTTP Basic authentication.
- Added clients.HttpClient.callTaxiiService2, which supersedes
callTaxiiService. The previous version of callTaxiiService couldn't
handle proxies well, which now have better support.
- Added better proxy support to client.HttpClient via the setProxy()
function.
1.0.103
-------
`(diff) `__
This version fixes a schema validation bug. Schema validation did not work
prior to this version.
1.0.102
-------
`(diff) `__
This version adds better proxy support to libtaxii in libtaxii.clients. A
function to set a proxy (setProxy) was added as well as a new callTaxiiService2
function that can properly use proxies. The original callTaxiiService function
did not support proxies well. The APIs have the full documentation for
callTaxiiService, callTaxiiService2, and setProxy (`Client API
`__).
1.0.101
-------
`(diff) `__
This version added missing source files for distribution on PyPI. No
functionality changes were made.
1.0.100
-------
`(diff) `__
Version 1.0.100 represents the first TAXII 1.0 compliant version of libtaxii.
This version removes all code not compliant with TAXII 1.0.
1.0.090
-------
`(diff) `__
This version of libtaxii has components that are TAXII 1.0 conformant and
experimental functionality that conforms to a draft version of TAXII. This
version should only be used to transition from 1.0.000draft to 1.0.100.
1.0.000draft
------------
This version of libtaxii represents experimental functionality that conforms to
a draft version of TAXII. This code should no longer be used. For those using
this code, you should upgrade to 1.0.090 and migrate your code to use the TAXII
1.0 components, then transition to 1.0.100.
libtaxii-1.1.119/docs/conf.py 0000664 0000000 0000000 00000002020 14036072565 0015722 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import os
import libtaxii
project = u'libtaxii'
copyright = u'2017, The MITRE Corporation'
version = libtaxii.__version__
release = version
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.ifconfig',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
]
intersphinx_mapping = {
'python': ('https://docs.python.org/', None),
}
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
rst_prolog = """
**Version**: {0}
""".format(release)
exclude_patterns = [
'_build',
]
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
else:
html_theme = 'default'
latex_elements = {}
latex_documents = [
('index', 'libtaxii.tex', u'libtaxii Documentation',
u'The MITRE Corporation', 'manual'),
]
libtaxii-1.1.119/docs/getting_started.rst 0000664 0000000 0000000 00000013627 14036072565 0020363 0 ustar 00root root 0000000 0000000 Getting Started
===============
This page gives an introduction to **libtaxii** and how to use it. Please note
that this page is being actively worked on and feedback is welcome.
Modules
-------
The libtaxii library contains the following modules:
* **libtaxii** - Contains version info and some methods for getting TAXII Messages
from HTTP responses. (Implemented in ``libtaxii/__init__.py``)
* **libtaxii.clients.** - TAXII HTTP and HTTPS clients. (Implemented in
``libtaxii/clients.py``)
* **libtaxii.common** - Contains functions and classes useful for all versions of TAXII
* **libtaxii.constants** - Contains constants for TAXII
* **libtaxii.messages_10** - Creating, handling, and parsing TAXII 1.0
messages. (Implemented in ``libtaxii/messages_10.py``)
* **libtaxii.messages_11** - Creating, handling, and parsing TAXII 1.1
messages. (Implemented in ``libtaxii/messages_11.py``)
* **libtaxii.taxii_default_query** - Creating, handling and parsing TAXII
Default Queries. (Implemented in ``libtaxii/taxii_default_query.py``) *New in
libtaxii 1.1.100*.
* **libtaxii.validation** - Common data validation functions used across
libtaxii. (Implemented in ``libtaxii/validation.py``)
TAXII Messages Module Structure
-------------------------------
In the TAXII message modules (:py:mod:`libtaxii.messages_10` and
:py:mod:`libtaxii.messages_11`), there is a class corresponding to each type of
TAXII message. For example, there is a ``DiscoveryRequest`` class for the
Discovery Request message:
.. code:: python
import libtaxii.messages_11 as tm11
discovery_request = tm11.DiscoveryRequest( ... )
For types that can been used across multiple messages (e.g., a Content Block
can exist in both Poll Response and Inbox Message), the corresponding class
(``ContentBlock``) is (and always has always been) defined at the module level.
.. code:: python
content_block = tm11.ContentBlock( ... )
Other types that are used exclusively within a particular TAXII message type
were previously defined as nested classes on the corresponding message class;
however, they are now defined at the top level of the module. For example, a
Service Instance is only used in a Discovery Response message, so the class
representing a Service Instance, now just ``ServiceInstance``, was previously
``DiscoveryResponse.ServiceInstance``. The latter name still works for backward
compatibilty reasons, but is deprecated and may be removed in the future.
.. code:: python
service_instance = tm11.ServiceInstance( ... )
service_instance = tm11.DiscoveryRequest.ServiceInstance( ... )
See the :ref:`API Documentation ` for proper constructor arguments for
each type above.
TAXII Message Serialization and Deserialization
-----------------------------------------------
Each class in the message modules has serialization and deserialization methods
for XML Strings, Python dictionaries, and LXML ElementTrees. All serialization
methods (``to_*()``) are instance methods called on specific objects (e.g.,
``discovery_request.to_xml()``). Deserialization methods (``from_*()``) are
class methods and should be called on the class itself (e.g.,
``tm11.DiscoveryRequest.from_xml(xml_string)``).
Each class in messages.py defines the following:
* ``from_xml(xml_string)`` - Creates an instance of the class from an XML String.
* ``to_xml()`` - Creates the XML representation of an instance of a class.
* ``from_dict(dictionary)`` - Creates an instance of the class from a Python dictionary.
* ``to_dict()`` - Creates the Python dictionary representation of an instance of a class.
* ``from_etree(lxml_etree)`` - Creates an instance of the class from an LXML Etree.
* ``to_etree()`` - Creates the LXML Etree representation of an instance of a class.
To create a TAXII Message from XML:
.. code:: python
xml_string = '' # Note: Invalid XML
discovery_response = tm11.DiscoveryResponse.from_xml(xml_string)
To create an XML string from a TAXII Message:
.. code:: python
new_xml_string = discovery_response.to_xml()
The same approach can be used for Python dictionaries:
.. code:: python
msg_dict = { ... } # Note: Invalid dictionary syntax
discovery_response = tm11.DiscoveryResponse.from_dict(msg_dict)
new_dict = discovery_response.to_dict()
and for LXML ElementTrees:
.. code:: python
msg_etree = etree.Element( ... ) # Note: Invalid Element constructor
discovery_response = tm11.DiscoveryResponse.from_etree(msg_etree)
new_etree = discovery_response.to_etree()
Schema Validating TAXII Messages
--------------------------------
You can use libtaxii to Schema Validate XML, etree, and file representations of TAXII Messages.
XML Schema validation cannot be performed on a TAXII Message Python object, since XML Schema validation
can only be performed on XML.
A full code example of XML Schema validation can be found in :ref:`API Documentation `
TAXII Clients
-------------
The **libtaxii.clients** module defines a single class ``HttpClient`` capable
of invoking TAXII services over both HTTP and HTTPS. The client is a fairly
straighforward wrapper around Python's builtin ``httplib`` and supports the use
of of both HTTP Basic and TLS Certificate authentication.
Example usage of clients:
.. code:: python
import libtaxii as t
import libtaxii.clients as tc
import libtaxii.messages_11 as tm11
from libtaxii.constants import *
client = tc.HttpClient()
client.set_auth_type(tc.HttpClient.AUTH_BASIC)
client.set_use_https(True)
client.set_auth_credentials({'username': 'MyUsername', 'password': 'MyPassword'})
discovery_request = tm11.DiscoveryRequest(tm11.generate_message_id())
discovery_xml = discovery_request.to_xml()
http_resp = client.call_taxii_service2('example.com', '/pollservice/', VID_TAXII_XML_11, discovery_xml)
taxii_message = t.get_message_from_http_response(http_resp, discovery_request.message_id)
print taxii_message.to_xml()
libtaxii-1.1.119/docs/index.rst 0000664 0000000 0000000 00000001446 14036072565 0016277 0 ustar 00root root 0000000 0000000 libtaxii |release| Documentation
================================
**libtaxii** is a Python library that provides:
1. An object representation of TAXII Messages
2. Serialization/deserialization to and from XML and Python dictionaries
3. An HTTP/HTTPS TAXII Client
.. toctree::
:maxdepth: 2
installation
getting_started
scripts
changes
API Reference
=============
.. toctree::
:maxdepth: 2
api/modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Offline Documentation
=====================
To download the latest documentation for offline use, please use one of these links:
* `PDF `_
* `HTML `_
libtaxii-1.1.119/docs/installation.rst 0000664 0000000 0000000 00000007351 14036072565 0017672 0 ustar 00root root 0000000 0000000 .. _installation:
Installation
============
Recommended Installation
------------------------
Use pip_:
.. code-block:: bash
$ pip install libtaxii
You might also want to consider using a virtualenv_.
.. _pip: http://pip.readthedocs.org/
.. _virtualenv: http://virtualenv.readthedocs.org/
Dependencies
------------
The libtaxii library is developed on Python 2.7 and tested against both
Python 2.6 and 2.7. Besides the Python Standard Library, libtaxii relies on
the following Python libraries:
* lxml_ - A Pythonic binding for the C libraries **libxml2** and
**libxslt**.
* python-dateutil_ - A library for parsing datetime information.
Each of these can be installed with ``pip`` or by manually downloading packages
from PyPI. On Windows, you will probably have the most luck using `pre-compiled
binaries`_ for ``lxml``. On Ubuntu (12.04 or 14.04), you should make sure the
following packages are installed before attempting to compile ``lxml`` from
source:
* libxml2-dev
* libxslt1-dev
* zlib1g-dev
.. note::
In libtaxii 1.0.101 and earlier, the M2Crypto library was also required.
This dependency was removed as of libtaxii 1.0.102.
.. warning::
Users have encountered errors with versions of libxml2 (a dependency of
lxml) prior to version 2.9.1. The default version of libxml2 provided on
Ubuntu 12.04 is currently 2.7.8. Users are encouraged to upgrade libxml2
manually if they have any issues. Ubuntu 14.04 provides libxml2 version
2.9.1.
.. _lxml: http://lxml.de/
.. _python-dateutil: http://labix.org/python-dateutil
.. _pre-compiled binaries: http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml
.. _M2Crypto: http://chandlerproject.org/Projects/MeTooCrypto
Manual Installation
-------------------
If you are unable to use pip, you can also install libtaxii with setuptools_.
If you don't already have setuptools installed, please install it before
continuing.
1. Download and install the dependencies_ above. Although setuptools will
generally install dependencies automatically, installing the dependencies
manually beforehand helps distinguish errors in dependency installation from
errors in libtaxii installation. Make sure you check to ensure the
versions you install are compatible with the version of libtaxii you plan
to install.
2. Download the desired version of libtaxii from PyPI_ or the GitHub releases_
page. The steps below assume you are using the |release| release.
3. Extract the downloaded file. This will leave you with a directory named
libtaxii-|release|.
.. parsed-literal::
$ tar -zxf libtaxii-|release|.tar.gz
$ ls
libtaxii-|release| libtaxii-|release|.tar.gz
OR
.. parsed-literal::
$ unzip libtaxii-|release|.zip
$ ls
libtaxii-|release| libtaxii-|release|.zip
4. Run the installation script.
.. parsed-literal::
$ cd libtaxii-|release|
$ python setup.py install
5. Test the installation.
.. parsed-literal::
$ python
Python 2.7.6 (default, Mar 22 2014, 22:59:56)
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import libtaxii
>>>
If you don't see an ``ImportError``, the installation was successful.
.. _setuptools: https://pypi.python.org/pypi/setuptools/
.. _PyPI: https://pypi.python.org/pypi/libtaxii/
.. _releases: https://github.com/TAXIIProject/libtaxii/releases
Further Information
-------------------
If you're new to installing Python packages, you can learn more at the `Python
Packaging User Guide`_, specifically the `Installing Python Packages`_ section.
.. _Python Packaging User Guide: http://python-packaging-user-guide.readthedocs.org/
.. _Installing Python Packages: http://python-packaging-user-guide.readthedocs.org/en/latest/tutorial.html#installing-python-packages
libtaxii-1.1.119/docs/make.bat 0000664 0000000 0000000 00000014477 14036072565 0016053 0 ustar 00root root 0000000 0000000 @ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^` where ^ is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\libtaxii.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\libtaxii.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
:end
libtaxii-1.1.119/docs/scripts.rst 0000664 0000000 0000000 00000014531 14036072565 0016656 0 ustar 00root root 0000000 0000000 Scripts
=======
This page provides documentation on the scripts that are included with libtaxii. All
clients are configured to use the Hail A TAXII server (http://hailataxii.com/) by
default; provide command line options for specifying most aspects of the script (e.g.,
host, port, client certs, username/password, HTTP or HTTPS, etc); and support TAXII 1.1
unless otherwise noted.
Note that the scripts *should* be callable from anywhere on the command line as long as you have
the python scripts directory on your path.
Script Listing
--------------
* **discovery_client** - Issues a Discovery Request to a Discovery Service
* **fulfillment_client** - Issues a Poll Fulfillment Request to a Poll Service and writes the resulting content to file
* **inbox_client** - Issues an Inbox Message with one Content Block to an Inbox Service
* **poll_client** - Issues a Poll Request to a Poll Service and writes the resulting content to file
* **poll_client_10** - Issues a Poll Request to a TAXII 1.0 Poll Service and writes the resulting content to file
* **query_client** - Issues a Query for an IP Address or Hash to a Poll Service and writes the resulting content to file
Common Command Line Arguments
-----------------------------
All scripts use these command line arguments:
* ``-h, --help`` - Shows help text
* ``-u, --url`` - Specified the URL to connect to.
* ``--cert`` - Specifies the file location of the certificate to use for
authentication. If provided, ``--key`` must also be provided.
* ``--key`` - Specifies the file location of the key to use for authentication.
* ``--username`` - Specifies the username to use for authentication. If
provided, ``--pass`` must also be provided.
* ``--pass`` - Specifies the password to use for authentication.
* ``--proxy`` - Specifies proxy settings (e.g. ``http://proxy.example.com:80/``,
or ``noproxy`` to not use any proxy). If omitted, the system's proxy settings
will be used.
* ``--xml-output`` - Specifies that the XML messages should be printed instead of the default textual representation
Note: As of libtaxii 1.1.106, the following arguments are now deprecated in favor of ``--url``
* ``--host`` - Specifies the host to connect to (e.g., ``hailataxii.com``)
* ``--port`` - Specifies the port to connect on (e.g., ``80``)
* ``--path`` - Specifies the path portion of the URL to connect to
(e.g., ``/services/discovery``)
* ``--https`` - Specifies whether to use HTTPS or not (e.g., True or False)
For example, to call the discovery_client using all these arguments, you would do:
``discovery_client --url http://hailataxii.com/taxii-discovery-service --cert MyCert.crt --key MyKey.key --username foo --pass bar --proxy http://myproxy.example.com:80 --xml-output``
Additional Discovery Client Command Line Arguments
--------------------------------------------------
The Discovery Client does not use any additional command line arguments.
Additional Poll Fulfillment Client Command Line Arguments
---------------------------------------------------------
In addition to the command line arguments listed above, the Poll Fulfillment Client uses these:
* ``--collection`` - The collection being requested
* ``--result_id`` - The result id being requested (required)
* ``--result_part_number`` - The result part number being requested (defaults to 1)
Example: ``fulfillment_client --collection MyCollection --result_id someId --result_part_number 1``
Additional Inbox Client Command Line Arguments
----------------------------------------------
In addition to the command line arguments listed above, the Inbox Client uses these:
* ``--content-binding`` - The Content Binding ID to use for the Content Block (Defaults to STIX XML 1.1)
* ``--subtype`` - The Content Binding ID subtype to use for the Content Block (Optional; Defaults to None)
* ``--content-file`` - The file location (e.g., /tmp/mydata) containing the data to send in the Content Block. Defaults to a built-in STIX 1.1 XML document.
* ``--dcn`` - The Destination Collection Name that is specified in the Inbox Message, requesting that the recipient
make the sent content available on the specified Destination Collection Name. TAXII supports multiple DCNs, but
this script only supports one.
Example: ``inbox_client --content-binding urn:stix.mitre.org:xml:1.1 --content-file stix_file.xml``
Additional Poll Client Command Line Arguments
---------------------------------------------
In addition to the command line arguments listed above, the Poll Client uses these:
* ``--collection`` - The Collection Name to Poll. Defaults to 'default'
* ``--begin_timestamp`` - The Begin Timestamp Label to used bound the Poll Request. Defaults to None.
* ``--end_timestamp`` - The End Timestamp Label to used bound the Poll Request. Defaults to None.
* ``--subscription-id`` - The Subscription ID for this Poll Request
* ``--dest-dir`` - The directory to save Content Blocks to. Defaults to the current directory.
Example: ``poll_client --collection MyCollection``
Additional Poll Client 1.0 Command Line Arguments
-------------------------------------------------
In addition to the command line arguments listed above, the Poll Client 1.0 uses these:
* ``--feed`` - The Data Feed to Poll. Defaults to 'default'
* ``--begin_timestamp`` - The Begin Timestamp Label to used bound the Poll Request. Defaults to None.
* ``--end_timestamp`` - The End Timestamp Label to used bound the Poll Request. Defaults to None.
* ``--subscription-id`` - The Subscription ID to use when polling
* ``--dest-dir`` - The directory to save Content Blocks to. Defaults to the current directory.
Example: ``poll_client_10 --feed MyFeedName --subscription-id SomeSubscriptionId``
Additional Query Client Command Line Arguments
----------------------------------------------
In addition to the command line arguments listed above, the Query Client uses these:
* ``--collection`` - The collection to Poll (recall that a query is part of a Poll Request). Defaults to 'default_queryable'.
* ``--allow_asynch`` - Whether asynchronous Polling is supported. Defaults to True (Use the Poll Fulfillment client to request asynchronous results!)
* ``--ip`` - The IP to query on. One of --ip or --hash must be specified.
* ``--hash`` - The file hash to query on. One of --ip or --hash must be specified.
* ``--dest-dir`` - The directory to save Content Blocks to. Defaults to the current directory.
Example: ``query_client --collection MyQueryCollection --ip 10.0.0.0``
libtaxii-1.1.119/libtaxii/ 0000775 0000000 0000000 00000000000 14036072565 0015306 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/__init__.py 0000664 0000000 0000000 00000014262 14036072565 0017424 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
"""
The main libtaxii module
"""
import six
from six.moves import urllib
import libtaxii.messages_10 as tm10
import libtaxii.messages_11 as tm11
import libtaxii.clients as tc
from .constants import *
import cgi
from .version import __version__ # noqa
def get_message_from_http_response(http_response, in_response_to):
"""Create a TAXII message from an HTTPResponse object.
This function parses the :py:class:`httplib.HTTPResponse` by reading the
X-TAXII-Content-Type HTTP header to determine if the message binding is
supported. If the X-TAXII-Content-Type header is present and the value
indicates a supported Message Binding, this function will attempt to parse
the HTTP Response body.
If the X-TAXII-Content-Type header is not present, this function will
attempt to build a Failure Status Message per the HTTP Binding 1.0
specification.
If the X-TAXII-Content-Type header is present and indicates an unsupported
Message Binding, this function will raise a ValueError.
Args:
http_response (httplib.HTTPResponse): the HTTP response to
parse
in_response_to (str): the default value for in_response_to
"""
if isinstance(http_response, six.moves.http_client.HTTPResponse):
return get_message_from_httplib_http_response(http_response, in_response_to)
elif isinstance(http_response, urllib.error.HTTPError):
return get_message_from_urllib2_httperror(http_response, in_response_to)
elif isinstance(http_response, urllib.response.addinfourl):
return get_message_from_urllib_addinfourl(http_response, in_response_to)
else:
raise ValueError('Unsupported response type: %s.' % http_response.__class__.__name__)
def get_message_from_urllib2_httperror(http_response, in_response_to):
""" This function should not be called by libtaxii users directly. """
info = http_response.info()
if hasattr(info, 'getheader'):
taxii_content_type = info.getheader('X-TAXII-Content-Type')
_, params = cgi.parse_header(info.getheader('Content-Type'))
else:
taxii_content_type = info.get('X-TAXII-Content-Type')
_, params = cgi.parse_header(info.get('Content-Type'))
encoding = params.get('charset', 'utf-8')
response_message = six.ensure_text(http_response.read(), errors='replace')
if taxii_content_type is None:
m = str(http_response) + '\r\n' + str(http_response.info()) + '\r\n' + response_message
return tm11.StatusMessage(message_id='0', in_response_to=in_response_to, status_type=ST_FAILURE, message=m)
elif taxii_content_type == VID_TAXII_XML_10: # It's a TAXII XML 1.0 message
return tm10.get_message_from_xml(response_message, encoding)
elif taxii_content_type == VID_TAXII_XML_11: # It's a TAXII XML 1.1 message
return tm11.get_message_from_xml(response_message, encoding)
elif taxii_content_type == VID_CERT_EU_JSON_10:
return tm10.get_message_from_json(response_message, encoding)
else:
raise ValueError('Unsupported X-TAXII-Content-Type: %s' % taxii_content_type)
def get_message_from_urllib_addinfourl(http_response, in_response_to):
""" This function should not be called by libtaxii users directly. """
info = http_response.info()
if hasattr(info, 'getheader'):
taxii_content_type = info.getheader('X-TAXII-Content-Type')
_, params = cgi.parse_header(info.getheader('Content-Type'))
else:
taxii_content_type = info.get('X-TAXII-Content-Type')
_, params = cgi.parse_header(info.get('Content-Type'))
encoding = params.get('charset', 'utf-8')
response_message = six.ensure_text(http_response.read(), errors='replace')
if taxii_content_type is None: # Treat it as a Failure Status Message, per the spec
message = []
header_dict = six.iteritems(http_response.info().dict)
for k, v in header_dict:
message.append(k + ': ' + v + '\r\n')
message.append('\r\n')
message.append(response_message)
m = ''.join(message)
return tm11.StatusMessage(message_id='0', in_response_to=in_response_to, status_type=ST_FAILURE, message=m)
elif taxii_content_type == VID_TAXII_XML_10: # It's a TAXII XML 1.0 message
return tm10.get_message_from_xml(response_message, encoding)
elif taxii_content_type == VID_TAXII_XML_11: # It's a TAXII XML 1.1 message
return tm11.get_message_from_xml(response_message, encoding)
elif taxii_content_type == VID_CERT_EU_JSON_10:
return tm10.get_message_from_json(response_message, encoding)
else:
raise ValueError('Unsupported X-TAXII-Content-Type: %s' % taxii_content_type)
def get_message_from_httplib_http_response(http_response, in_response_to):
""" This function should not be called by libtaxii users directly. """
if hasattr(http_response, 'getheader'):
taxii_content_type = http_response.getheader('X-TAXII-Content-Type')
_, params = cgi.parse_header(http_response.getheader('Content-Type'))
else:
taxii_content_type = http_response.get('X-TAXII-Content-Type')
_, params = cgi.parse_header(http_response.get('Content-Type'))
encoding = params.get('charset', 'utf-8')
response_message = six.ensure_text(http_response.read(), errors='replace')
if taxii_content_type is None: # Treat it as a Failure Status Message, per the spec
message = []
header_tuples = http_response.getheaders()
for k, v in header_tuples:
message.append(k + ': ' + v + '\r\n')
message.append('\r\n')
message.append(response_message)
m = ''.join(message)
return tm11.StatusMessage(message_id='0', in_response_to=in_response_to, status_type=ST_FAILURE, message=m)
elif taxii_content_type == VID_TAXII_XML_10: # It's a TAXII XML 1.0 message
return tm10.get_message_from_xml(response_message, encoding)
elif taxii_content_type == VID_TAXII_XML_11: # It's a TAXII XML 1.1 message
return tm11.get_message_from_xml(response_message, encoding)
else:
raise ValueError('Unsupported X-TAXII-Content-Type: %s' % taxii_content_type)
libtaxii-1.1.119/libtaxii/clients.py 0000664 0000000 0000000 00000052144 14036072565 0017327 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
"""
TAXII Clients
"""
import sys
import base64
import socket
import ssl
import warnings
from libtaxii.constants import *
import six
from six.moves import urllib
class HttpClient(object):
# Constants for authentication types
AUTH_NONE = 0 #: Do not offer any authentication credentials to the server
AUTH_BASIC = 1 #: Offer HTTP Basic authentication credentials to the server
AUTH_CERT = 2 #: Offer certificate based authentication credentials to the server
AUTH_CERT_BASIC = 3 #: Offer certificate based auth and HTTP Basic credentials
# Proxy values
SYSTEM_PROXY = None
NO_PROXY = 'noproxy'
# Proxy Constants
PROXY_HTTP = 'http'
PROXY_HTTPS = 'https'
# Header Constants
HEADER_ACCEPT = 'accept'
HEADER_CONTENT_TYPE = 'content-type'
HEADER_X_TAXII_ACCEPT = 'x-taxii-accept'
HEADER_X_TAXII_CONTENT_TYPE = 'x-taxii-content-type'
HEADER_X_TAXII_PROTOCOL = 'x-taxii-protocol'
HEADER_X_TAXII_SERVICES = 'x-taxii-services'
def __init__(self, auth_type=AUTH_NONE, auth_credentials=None, use_https=False):
self.use_https = use_https
self.auth_type = auth_type
self.auth_credentials = {}
if auth_credentials is not None:
self.set_auth_credentials(auth_credentials)
# These cannot currently be set in the constructor
self.proxy_string = None
self.verify_server = False
self.ca_file = None
def set_auth_type(self, auth_type):
"""Set the authentication type for this client.
:param string auth_type: Must be one of :attr:`AUTH_NONE`, :attr:`AUTH_BASIC`, or :attr:`AUTH_CERT`
"""
# If this isn't a change, don't do anything
if self.auth_type == auth_type:
return
if auth_type == HttpClient.AUTH_NONE:
self.auth_type = HttpClient.AUTH_NONE
elif auth_type == HttpClient.AUTH_BASIC:
self.auth_type = HttpClient.AUTH_BASIC
elif auth_type == HttpClient.AUTH_CERT:
self.auth_type = HttpClient.AUTH_CERT
elif auth_type == HttpClient.AUTH_CERT_BASIC:
self.auth_type = HttpClient.AUTH_CERT_BASIC
else:
raise Exception('Invalid auth_type specified. Must be one of HttpClient AUTH_NONE, AUTH_BASIC, or AUTH_CERT')
def set_verify_server(self, verify_server=False, ca_file=None):
"""
Tell libtaxii whether to verify the server's ssl certificate
using the provided ca_file.
:param bool verify_server: Flag indicating whether or not libtaxii should verify the server.
"""
if verify_server and ca_file is None:
raise ValueError('If verify_server is True, ca_file must not be None.')
self.verify_server = verify_server
self.ca_file = ca_file
@property
def basic_auth_header(self):
"""Returns a Base64-encoded HTTP Basic Authorization Header."""
credentials = '{}:{}'.format(
self.auth_credentials['username'],
self.auth_credentials['password']
).encode('utf-8')
return b'Basic ' + base64.b64encode(credentials)
def set_proxy(self, proxy_string=None):
"""
Set the proxy settings to use when making a connection.
:param string proxy_string: Proxy address formatted like http://proxy.example.com:80. Set to :attr:`SYSTEM_PROXY` to use the system proxy; set to :attr:`NO_PROXY` to use no proxy.
"""
self.proxy_string = proxy_string
def set_use_https(self, bool_):
"""Indicate whether the HttpClient should use HTTP or HTTPs. The default is HTTP.
:param bool bool: The new use_https value.
"""
if bool_ is True:
self.use_https = True
elif bool_ is False:
self.use_https = False
else:
raise Exception('Invalid argument value. Must be a boolean value of \'True\' or \'False\'.')
def set_auth_credentials(self, auth_credentials_dict):
"""Set the authentication credentials used later when making a request.
Note that it is possible to pass in one dict containing credentials for
different authentication types and swap between them later.
:param auth_credentials_dict dict: The dictionary containing authentication credentials. e.g.:
- {'key_file': '/path/to/key.key', 'cert_file': '/path/to/cert.crt'}
- {'username': 'abc', 'password': 'xyz'}
- Or both, if both username/password and certificate based auth are used
"""
if self.auth_type == HttpClient.AUTH_NONE:
req_fields = []
elif self.auth_type == HttpClient.AUTH_BASIC:
req_fields = ['username', 'password']
elif self.auth_type == HttpClient.AUTH_CERT:
req_fields = ['key_file', 'cert_file']
elif self.auth_type == HttpClient.AUTH_CERT_BASIC:
req_fields = ['key_file', 'cert_file', 'username', 'password']
for k in req_fields:
if k not in auth_credentials_dict:
raise Exception('Invalid auth credentials. Field %s is not present' % k)
self.auth_credentials = auth_credentials_dict
def call_taxii_service(self, host, path, message_binding, post_data, port=None, get_params_dict=None):
""" **DEPRECATED.** May be removed in the next version of `libtaxii`.
Use :func:`call_taxii_service2` instead.
Call a TAXII service.
"""
warnings.warn('Call to deprecated function: libtaxii.clients.HttpClient.call_taxii_service()',
category=DeprecationWarning)
if port is None: # If the caller did not specify a port, use the default
if self.use_https:
port = 443
else:
port = 80
if get_params_dict is not None: # Add the query params to the URL
path += '?' + urllib.parse.urlencode(get_params_dict)
header_dict = {'Content-Type': 'application/xml',
'User-Agent': 'libtaxii.httpclient'}
if self.auth_type == HttpClient.AUTH_CERT_BASIC:
raise Exception('AuthType AUTH_CERT_BASIC not supported by call_taxii_service. Use call_taxii_service2.')
if self.use_https:
header_dict['X-TAXII-Protocol'] = VID_TAXII_HTTPS_10
if self.auth_type == HttpClient.AUTH_NONE:
conn = six.moves.http_client.HTTPSConnection(host, port)
elif self.auth_type == HttpClient.AUTH_BASIC:
header_dict['Authorization'] = self.basic_auth_header
conn = six.moves.http_client.HTTPSConnection(host, port)
else: # AUTH_CERT
key_file = self.auth_credentials['key_file']
cert_file = self.auth_credentials['cert_file']
conn = six.moves.http_client.HTTPSConnection(host, port, key_file, cert_file)
else: # Not using https
header_dict['X-TAXII-Protocol'] = VID_TAXII_HTTP_10
if self.auth_type == HttpClient.AUTH_NONE:
conn = six.moves.http_client.HTTPConnection(host, port)
# TODO: Consider deleting because this is a terrible idea
elif self.auth_type == HttpClient.AUTH_BASIC: # Sending credentials in cleartext.. tsk tsk
header_dict['Authorization'] = self.basic_auth_header
conn = six.moves.http_client.HTTPConnection(host, port)
else: # AUTH_CERT
key_file = self.auth_credentials['key_file']
cert_file = self.auth_credentials['cert_file']
conn = six.moves.http_client.HTTPConnection(host, port, key_file, cert_file)
header_dict['Content-Type'] = 'application/xml'
header_dict['X-TAXII-Content-Type'] = message_binding
req = conn.request('POST', path, post_data, headers=header_dict)
response = conn.getresponse()
return response
def call_taxii_service2(self, host, path, message_binding, post_data, port=None, get_params_dict=None,
content_type=None, headers=None, user_agent=None, timeout=None):
"""Call a TAXII service.
**Note:** this uses urllib2 instead of httplib, and therefore returns
a different kind of object than :func:`call_taxii_service`.
:return: :class:`urllib2.Response`
"""
header_dict = {}
if headers is not None:
for k, v in six.iteritems(headers):
header_dict[k.lower()] = v
if user_agent is not None:
header_dict['User-Agent'] = user_agent
else:
header_dict['User-Agent'] = 'libtaxii.httpclient'
header_dict[HttpClient.HEADER_X_TAXII_CONTENT_TYPE] = message_binding
content_type_map = {VID_TAXII_XML_10: 'application/xml',
VID_TAXII_XML_11: 'application/xml',
VID_CERT_EU_JSON_10: 'application/json'}
if content_type is not None: # Set the content type to the user-provided value
header_dict[HttpClient.HEADER_CONTENT_TYPE] = content_type
else: # If the user did not provide a value, attempt to find a known value
if message_binding not in content_type_map:
raise ValueError("content_type not specified, and the message_binding is unrecognized")
header_dict[HttpClient.HEADER_CONTENT_TYPE] = content_type_map[message_binding]
# States of Accept and X-TAXII-Accept headers:
#
# 1. Accept and X-TAXII-Accept headers both set.
# - Do nothing. Assume user knows what they are doing
#
# 2. Accept header set and X-TAXII-Accept header not set
# - Do nothing. Assume user knows what they are doing
#
# 3. Accept header not set and X-TAXII-Accept header set
# - Do nothing. Bad practice, but not invalid.
# Assume user knows what they are doing.
#
# 4. Accept header not set and X-TAXII-Accept header not set
# - User hasn't specified anything. In this case, default behavior is:
# Accept = Content-Type and
# X-TAXII-Accept = X-TAXII-Content-Type.
# This means that the client will only accept messages
# in the same format that was sent.
#
# 5. Users of libtaxii that wish to accept everything should set the
# Accept header to '*/*'.
accept_set = header_dict.get(HttpClient.HEADER_ACCEPT) is not None
x_taxii_accept_set = header_dict.get(HttpClient.HEADER_X_TAXII_ACCEPT) is not None
if not accept_set and not x_taxii_accept_set:
header_dict[HttpClient.HEADER_ACCEPT] = header_dict[HttpClient.HEADER_CONTENT_TYPE]
header_dict[HttpClient.HEADER_X_TAXII_ACCEPT] = header_dict[HttpClient.HEADER_X_TAXII_CONTENT_TYPE]
# If the X-TAXII-Services header is not set by the user,
# Attempt to use the library's default mapping
services_map = {VID_TAXII_XML_10: VID_TAXII_SERVICES_10,
VID_TAXII_XML_11: VID_TAXII_SERVICES_11,
VID_CERT_EU_JSON_10: VID_TAXII_SERVICES_10}
if header_dict.get(HttpClient.HEADER_X_TAXII_SERVICES) is None: # The X-TAXII-Services header was not set by the user
if message_binding not in services_map:
raise ValueError('x-taxii-services header not specified, and the message_binding is unrecognized')
header_dict[HttpClient.HEADER_X_TAXII_SERVICES] = services_map[message_binding]
handler_list = []
if self.use_https:
header_dict[HttpClient.HEADER_X_TAXII_PROTOCOL] = VID_TAXII_HTTPS_10
if (self.auth_type == HttpClient.AUTH_CERT or
self.auth_type == HttpClient.AUTH_CERT_BASIC):
key_file = self.auth_credentials['key_file']
cert_file = self.auth_credentials['cert_file']
key_password = self.auth_credentials.get('key_password')
else:
key_file = None
cert_file = None
key_password = None
if (self.auth_type == HttpClient.AUTH_BASIC or
self.auth_type == HttpClient.AUTH_CERT_BASIC):
header_dict['Authorization'] = self.basic_auth_header
verify_server = self.verify_server
ca_file = self.ca_file
handler_list.append(LibtaxiiHTTPSHandler(
key_file=key_file,
cert_file=cert_file,
verify_server=verify_server,
ca_certs=ca_file,
key_password=key_password))
else: # Not using https
header_dict[HttpClient.HEADER_X_TAXII_PROTOCOL] = VID_TAXII_HTTP_10
if self.auth_type == HttpClient.AUTH_NONE:
handler_list.append(urllib.request.HTTPHandler())
elif self.auth_type == HttpClient.AUTH_BASIC:
header_dict['Authorization'] = self.basic_auth_header
elif self.auth_type == HttpClient.AUTH_CERT:
k = self.auth_credentials['key_file']
c = self.auth_credentials['cert_file']
handler_list.append(HTTPClientAuthHandler(k, c))
elif self.auth_type == HttpClient.AUTH_CERT_BASIC:
header_dict['Authorization'] = self.basic_auth_header
k = self.auth_credentials['key_file']
c = self.auth_credentials['cert_file']
handler_list.append(HTTPSClientAuthHandler(k, c))
handler_list.append(urllib.request.HTTPHandler())
if self.proxy_string is not None:
if self.proxy_string == 'noproxy':
# Dont use any proxy, including the system-specified proxy
handler_list.append(urllib.request.ProxyHandler({}))
else: # Use a specific proxy
handler_list.append(urllib.request.ProxyHandler({self.PROXY_HTTP: self.proxy_string, self.PROXY_HTTPS: self.proxy_string}))
opener = urllib.request.build_opener(*handler_list)
urllib.request.install_opener(opener)
if port is None: # If the caller did not specify a port, use the default
if self.use_https:
port = 443
else:
port = 80
if self.use_https:
scheme = 'https://'
else:
scheme = 'http://'
url = scheme + host + ':' + str(port) + path
if get_params_dict is not None:
url += '?' + urllib.parse.urlencode(get_params_dict)
req = urllib.request.Request(url, post_data, header_dict)
try:
if timeout is not None:
response = urllib.request.urlopen(req, timeout=timeout)
else: # Defaults to socket.getdefaulttimeout()
response = urllib.request.urlopen(req)
return response
except urllib.error.HTTPError as error:
return error
# Backwards compatibility
setAuthType = set_auth_type
setVerifyServer = set_verify_server
setProxy = set_proxy
setUseHttps = set_use_https
setAuthCredentials = set_auth_credentials
callTaxiiService = call_taxii_service
callTaxiiService2 = call_taxii_service2
# http://stackoverflow.com/questions/5896380/https-connection-using-pem-certificate
class LibtaxiiHTTPSHandler(urllib.request.HTTPSHandler):
def __init__(self, key_file=None, cert_file=None, verify_server=False,
ca_certs=None, key_password=None):
urllib.request.HTTPSHandler.__init__(self)
self.key_file = key_file
self.cert_file = cert_file
self.verify_server = verify_server
self.ca_certs = ca_certs
self.key_password = key_password
def https_open(self, req):
return self.do_open(self.get_connection, req)
def get_connection(self, host, timeout=0):
return VerifiableHTTPSConnection(host,
key_file=self.key_file,
cert_file=self.cert_file,
verify_server=self.verify_server,
ca_certs=self.ca_certs,
key_password=self.key_password)
class HTTPClientAuthHandler(urllib.request.HTTPSHandler): # TODO: Is this used / is this possible?
def __init__(self, key, cert):
urllib.request.HTTPSHandler.__init__(self)
self.key = key
self.cert = cert
def https_open(self, req):
return self.do_open(self.get_connection, req)
def get_connection(self, host, timeout=0):
return six.moves.http_client.HTTPSConnection(host, key_file=self.key, cert_file=self.cert, timeout=timeout)
class VerifiableHTTPSConnection(six.moves.http_client.HTTPSConnection):
"""
The default httplib HTTPSConnection does not verify certificates.
This class extends HTTPSConnection and requires certificate verification.
Borrowed from http://thejosephturner.com/blog/2011/03/19/https-certificate-verification-in-python-with-urllib2/
(moved to https://thejosephturner.com/blog/post/https-certificate-verification-in-python-with-urllib2/)
"""
def __init__(self, host, port=None, key_file=None, cert_file=None,
key_password=None, strict=None,
timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
source_address=None, verify_server=False, ca_certs=None):
# The httplib.HTTPSConnection init arguments have changed over different Python versions:
# Py 2.6: httplib.HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout]]]]])
# Py 2.7: httplib.HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout[, source_address[, context]]]]]]])
# Py 3.3: http.client.HTTPSConnection(host, port=None, key_file=None, cert_file=None[, strict][, timeout], source_address=None, *, context=None, check_hostname=None)
# Py 3.4-3.6: http.client.HTTPSConnection(host, port=None, key_file=None, cert_file=None, [timeout, ]source_address=None, *, context=None, check_hostname=None)
python_version = sys.version_info[0:2] # (e.g. 2.6, 2.7, 3.3, etc.)
self.context = None
if python_version == (2, 6):
six.moves.http_client.HTTPSConnection.__init__(
self, host, port, key_file, cert_file, strict, timeout)
if key_password:
warnings.warn('Key password is not supported in Python 2.6. Ignoring')
elif python_version == (2, 7) or six.PY3:
if hasattr(ssl, "create_default_context"):
self.context = ssl.create_default_context(
ssl.Purpose.SERVER_AUTH if verify_server else ssl.Purpose.CLIENT_AUTH,
cafile=ca_certs)
if cert_file or key_file:
self.context.load_cert_chain(
cert_file, key_file, password=key_password)
if not self.context and key_password:
warnings.warn('Key password is not supported in Python <2.7.9. Ignoring')
if python_version == (2, 7):
if self.context:
six.moves.http_client.HTTPSConnection.__init__(
self, host, port, strict=strict, timeout=timeout,
source_address=source_address, context=self.context)
else:
six.moves.http_client.HTTPSConnection.__init__(
self, host, port, strict=strict, timeout=timeout,
source_address=source_address)
elif six.PY3:
super(VerifiableHTTPSConnection, self).__init__(
host, port, timeout=timeout, source_address=source_address,
context=self.context)
else:
raise RuntimeError("Unsupported Python version: '{0}'".format(python_version))
self.cert_file = cert_file
self.key_file = key_file
if verify_server:
self.cert_reqs = ssl.CERT_REQUIRED
else:
self.cert_reqs = ssl.CERT_NONE
self.ca_certs = ca_certs
def connect(self):
# overrides the version in httplib so that we do
# certificate verification
if sys.version_info.major == 2 and sys.version_info.minor == 6:
# Python 2.6 socket.create_connection has no source_address argument:
sock = socket.create_connection(
(self.host, self.port), self.timeout)
else:
sock = socket.create_connection(
(self.host, self.port), self.timeout, self.source_address)
if self._tunnel_host:
self.sock = sock
self._tunnel()
server_hostname = self._tunnel_host
else:
server_hostname = self.host
if self.context:
self.sock = self.context.wrap_socket(
sock,
server_hostname=server_hostname)
else:
self.sock = ssl.wrap_socket(
sock,
keyfile=self.key_file,
certfile=self.cert_file,
cert_reqs=self.cert_reqs,
ca_certs=self.ca_certs,
server_hostname=server_hostname)
libtaxii-1.1.119/libtaxii/common.py 0000664 0000000 0000000 00000035674 14036072565 0017167 0 ustar 00root root 0000000 0000000 """
Common utility classes and functions used throughout libtaxii.
"""
from operator import attrgetter
import re
import sys
from uuid import uuid4
import dateutil.parser
from lxml import etree
import six
from six.moves.urllib.parse import urlparse
try:
import simplejson as json
except ImportError:
import json
from libtaxii.constants import *
_XML_PARSER = None
def parse(s, allow_file=True, allow_url=False):
"""
Uses the default parser to parse a string or file-like object
:param s: The XML String or File-like object to parse.
:param allow_file: Allow `s` to be a file path.
:param allow_url: Allow `s` to be a URL.
:return: an etree._Element
"""
# Do a simple validation that the given string (or URL)
# has no protocol specified. Anything without parseable protocol
# will be interpreted by lxml as string instead or path of external URL.
if not allow_url and isinstance(s, six.string_types):
parsed = urlparse(s)
if parsed.scheme:
raise ValueError('external URLs are not allowed')
parser = get_xml_parser()
# parse from string if no external paths allowed
if not allow_file and not allow_url:
return etree.fromstring(s, parser)
# try to parse from file or string if files are allowed
try:
return etree.parse(s, parser).getroot()
except IOError:
return etree.XML(s, parser)
def parse_xml_string(xmlstr):
"""Parse an XML string (binary or unicode) with the default parser.
:param xmlstr: An XML String to parse
:return: an etree._Element
"""
if isinstance(xmlstr, six.binary_type):
xmlstr = six.BytesIO(xmlstr)
elif isinstance(xmlstr, six.text_type):
# LXML doesn't accept Unicode strings with an explicit encoding, so
# try to detect and encode to bytes before passing to LXML.
encoding = re.findall(r'encoding="([0-9A-Za-z_\-]+)"', xmlstr[:50], re.I)
# re.findall returns a list of matching strings. We only care about the
# first one.
if encoding:
xmlstr = six.BytesIO(xmlstr.encode(encoding[0]))
else:
xmlstr = six.StringIO(xmlstr)
return parse(xmlstr, allow_file=True)
def get_xml_parser():
"""Return the XML parser currently in use.
If one has not already been set (via :py:func:`set_xml_parser()`), a new
``etree.XMLParser`` is constructed with ``no_network=True`` and
``huge_tree=False``.
"""
global _XML_PARSER
if _XML_PARSER is None:
_XML_PARSER = etree.XMLParser(
attribute_defaults=False,
dtd_validation=False,
load_dtd=False,
no_network=True,
ns_clean=True,
recover=False,
remove_blank_text=False,
remove_comments=False,
remove_pis=False,
strip_cdata=True,
compact=True,
# collect_ids=True,
resolve_entities=False,
huge_tree=False
)
return _XML_PARSER.copy()
def set_xml_parser(xml_parser=None):
"""Set the libtaxii.messages XML parser.
Args:
xml_parser (etree.XMLParser): The parser to use to parse TAXII XML.
"""
global _XML_PARSER
_XML_PARSER = xml_parser
def parse_datetime_string(datetime_string):
"""Parse a string into a :py:class:`datetime.datetime`.
libtaxii users should not need to use this function directly.
"""
if not datetime_string:
return None
return dateutil.parser.parse(datetime_string)
def generate_message_id(maxlen=5, version=VID_TAXII_SERVICES_10):
"""Generate a TAXII Message ID.
Args:
maxlen (int): maximum length of the ID, in characters
Example:
.. code-block:: python
msg_id = tm11.generate_message_id()
message = tm11.DiscoveryRequest(msg_id)
# Or...
message = tm11.DiscoveryRequest(tm11.generate_message_id())
"""
if version == VID_TAXII_SERVICES_10:
message_id = str(uuid4().int % sys.maxsize)
elif version == VID_TAXII_SERVICES_11:
message_id = str(uuid4())
else:
raise ValueError('Unknown TAXII Version: %s. Must be a TAXII Services Version ID!' % version)
return message_id
def append_any_content_etree(etree_elt, content):
"""
General method for adding content to an etree element. This method can handle:
* etree._ElementTree
* etree._Element
* any python type that can be cast to str
* str
:param etree_elt: The etree to append the content to
:param content: The content to append
:return: The etree_elt
"""
if isinstance(content, etree._ElementTree): # If content is an element tree, append the root element
etree_elt.append(content.getroot())
return etree_elt
if isinstance(content, etree._Element): # If content is an element, append it
etree_elt.append(content)
return etree_elt
if not isinstance(content, six.string_types): # If content is a non-string, cast it to string and set etree_elt.text
etree_elt.text = str(content)
return etree_elt
# If content is a string, need to check if it's XML or not
try:
etree_elt.append(etree.XML(content, get_xml_parser()))
except etree.XMLSyntaxError:
etree_elt.text = content
return etree_elt
def gen_filename(collection_name, format_part, date_string, extension):
"""
Creates a filename based on various properties of a Poll Request and Content Block
:param collection_name: The collection name
:param format_part: The format part (e.g., '_STIX_10_')
:param date_string: A datestring
:param extension: The file extension to use
:return: A string containing the generated filename
"""
if six.PY3:
return (collection_name.lstrip(".") +
format_part +
re.sub(r"[^a-zA-Z0-9]", "_", date_string) + extension
).translate('/\\:*?"<>|')
else:
return (collection_name.lstrip(".") +
format_part +
re.sub(r"[^a-zA-Z0-9]", "_", date_string) + extension
).translate(None, '/\\:*?"<>|')
class TAXIIBase(object):
"""
Base class for all TAXII Messages and Message component types.
libtaxii users should not need to use this class directly.
"""
@property
def sort_key(self):
"""
This property allows list of TAXII objects to be compared efficiently.
The __eq__ method uses this property to sort the lists before
comparisons are made.
Subclasses must implement this property.
"""
raise NotImplementedError()
def to_etree(self):
"""Create an etree representation of this class.
Subclasses must implement this method.
"""
raise NotImplementedError()
def to_dict(self):
"""Create a dictionary representation of this class.
Subclasses must implement this method.
"""
raise NotImplementedError()
def to_json(self):
"""Create a JSON object of this class.
Assumes any binary content will be UTF-8 encoded.
"""
content_dict = self.to_dict()
_decode_binary_fields(content_dict)
return json.dumps(content_dict)
def to_xml(self, pretty_print=False):
"""Create an XML representation of this class.
Subclasses should not need to implement this method.
"""
return etree.tostring(self.to_etree(), pretty_print=pretty_print, encoding='utf-8')
def to_text(self, line_prepend=''):
"""Create a nice looking (this is a subjective term!)
textual representation of this class. Subclasses should
implement this method.
Note that this is just a convenience method for making
TAXII Messages nice to read for humans and may change
drastically in future versions of libtaxii.
"""
raise NotImplementedError()
@classmethod
def from_etree(cls, src_etree):
"""Create an instance of this class from an etree.
Subclasses must implement this method.
"""
raise NotImplementedError()
@classmethod
def from_dict(cls, d):
"""Create an instance of this class from a dictionary.
Subclasses must implement this method.
"""
raise NotImplementedError()
@classmethod
def from_xml(cls, xml):
"""Create an instance of this class from XML.
Subclasses should not need to implement this method.
"""
etree_xml = parse_xml_string(xml)
return cls.from_etree(etree_xml)
# Just noting that there is not a from_text() method. I also
# don't think there will ever be one.
def __str__(self):
return self.to_xml(pretty_print=True)
def __eq__(self, other, debug=False):
"""
Generic method used to check equality of objects of any TAXII type.
Also allows for ``print``-based debugging output showing differences.
In order for subclasses to use this function, they must meet the
following criteria:
1. All class properties start with one underscore.
2. The sort_key property is implemented.
Args:
self (object): this object
other (object): the object to compare ``self`` against.
debug (bool): Whether or not to print debug statements as the
equality comparison is performed.
"""
if other is None:
if debug:
print('other was None!')
return False
if self.__class__.__name__ != other.__class__.__name__:
if debug:
print('class names not equal: %s != %s' % (self.__class__.__name__, other.__class__.__name__))
return False
# Get all member properties that start with '_'
members = [attr for attr in vars(self) if attr.startswith('_') and not attr.startswith('__')]
for member in members:
if debug:
print('member name: %s' % member)
self_value = getattr(self, member)
other_value = getattr(other, member)
if isinstance(self_value, TAXIIBase):
# A debuggable equals comparison can be made
eq = self_value.__eq__(other_value, debug)
elif isinstance(self_value, list):
# We have lists to compare
if len(self_value) != len(other_value):
# Lengths not equal
member = member + ' lengths'
self_value = len(self_value)
other_value = len(other_value)
eq = False
elif len(self_value) == 0:
# Both lists are of size 0, and therefore equal
eq = True
else:
# Equal sized, non-0 length lists. The list might contain
# TAXIIBase objects, or it might not. Peek at the first
# item to see whether it is a TAXIIBase object or not.
if isinstance(self_value[0], TAXIIBase):
# All TAXIIBase objects have the 'sort_key' property implemented
self_value = sorted(self_value, key=attrgetter('sort_key'))
other_value = sorted(other_value, key=attrgetter('sort_key'))
for self_item, other_item in six.moves.zip(self_value, other_value):
# Compare the ordered lists element by element
eq = self_item.__eq__(other_item, debug)
else:
# Assume they don't... just do a set comparison
eq = set(self_value) == set(other_value)
elif isinstance(self_value, dict):
# Dictionary to compare
if len(set(self_value.keys()) - set(other_value.keys())) != 0:
if debug:
print('dict keys not equal: %s != %s' % (self_value, other_value))
eq = False
for k, v in six.iteritems(self_value):
if other_value[k] != v:
if debug:
print('dict values not equal: %s != %s' % (v, other_value[k]))
eq = False
eq = True
elif isinstance(self_value, etree._Element):
# Non-TAXII etree element (i.e. STIX)
eq = (etree.tostring(self_value, encoding='utf-8') == etree.tostring(other_value, encoding='utf-8'))
else:
# Do a direct comparison
eq = (self_value == other_value)
# TODO: is this duplicate?
if not eq:
if debug:
print('%s was not equal: %s != %s' % (member, self_value, other_value))
return False
return True
def __ne__(self, other, debug=False):
return not self.__eq__(other, debug)
def get_required(etree_xml, xpath, ns_map):
elements = etree_xml.xpath(xpath, namespaces=ns_map)
if len(elements) == 0:
raise ValueError('Element "%s" is required' % xpath)
return elements[0]
def get_optional(etree_xml, xpath, ns_map):
try:
return get_required(etree_xml, xpath, ns_map)
except ValueError:
pass
def get_optional_text(etree_xml, xpath, ns_map):
try:
return get_required(etree_xml, xpath, ns_map).text
except ValueError:
pass
def _decode_binary_fields(dict_obj):
"""Given a dict, decode any binary values, assuming UTF-8 encoding.
Will recurse into nested dicts.
Modifies the values in-place.
"""
for key, value in dict_obj.items():
if isinstance(value, six.binary_type):
dict_obj[key] = value.decode('utf-8')
elif isinstance(value, dict):
_decode_binary_fields(value)
def stringify_content(content):
"""Always a string or raises an error.
Returns the string representation and whether the data is XML.
"""
# If it's an etree, it's definitely XML
if isinstance(content, etree._ElementTree):
return content.getroot(), True
if isinstance(content, etree._Element):
return content, True
if hasattr(content, 'read'): # The content is file-like
try: # Try to parse as XML
xml = parse(content, allow_file=True)
return xml, True
except etree.XMLSyntaxError: # Content is not well-formed XML; just treat as a string
return content.read(), False
else: # The Content is not file-like
try: # Attempt to parse string as XML
xml = parse_xml_string(content)
return xml, True
except etree.XMLSyntaxError: # Content is not well-formed XML; just treat as a string
if isinstance(content, six.string_types): # It's a string of some kind, unicode or otherwise
return content, False
else: # It's some other datatype that needs casting to string
return str(content), False
libtaxii-1.1.119/libtaxii/constants.py 0000664 0000000 0000000 00000032177 14036072565 0017706 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
#: Namespace map of namespaces libtaxii knows about
NS_MAP = {
'taxii': 'http://taxii.mitre.org/messages/taxii_xml_binding-1',
'taxii_11': 'http://taxii.mitre.org/messages/taxii_xml_binding-1.1',
'tdq': 'http://taxii.mitre.org/query/taxii_default_query-1',
}
#: alias for NS_MAP for backward compatibility
ns_map = NS_MAP
#: Constant identifying a Status Message
MSG_STATUS_MESSAGE = 'Status_Message'
#: Constant identifying a Discovery Request Message
MSG_DISCOVERY_REQUEST = 'Discovery_Request'
#: Constant identifying a Discovery Response Message
MSG_DISCOVERY_RESPONSE = 'Discovery_Response'
#: Constant identifying a Feed Information Request Message
MSG_FEED_INFORMATION_REQUEST = 'Feed_Information_Request'
#: Constant identifying a Feed Information Response Message
MSG_FEED_INFORMATION_RESPONSE = 'Feed_Information_Response'
#: Constant identifying a Subscription Management Request Message
MSG_MANAGE_FEED_SUBSCRIPTION_REQUEST = 'Subscription_Management_Request'
#: Constant identifying a Subscription Management Response Message
MSG_MANAGE_FEED_SUBSCRIPTION_RESPONSE = 'Subscription_Management_Response'
#: Constant identifying a Poll Request Message
MSG_POLL_REQUEST = 'Poll_Request'
#: Constant identifying a Poll Response Message
MSG_POLL_RESPONSE = 'Poll_Response'
#: Constant identifying a Inbox Message
MSG_INBOX_MESSAGE = 'Inbox_Message'
#: TAXII 1.0 Message Types
MSG_TYPES_10 = (MSG_STATUS_MESSAGE, MSG_DISCOVERY_REQUEST, MSG_DISCOVERY_RESPONSE,
MSG_FEED_INFORMATION_REQUEST, MSG_FEED_INFORMATION_RESPONSE,
MSG_MANAGE_FEED_SUBSCRIPTION_REQUEST,
MSG_MANAGE_FEED_SUBSCRIPTION_RESPONSE, MSG_POLL_REQUEST,
MSG_POLL_RESPONSE, MSG_INBOX_MESSAGE)
# New Message Types in TAXII 1.1
#: Constant identifying a Status Message
MSG_POLL_FULFILLMENT_REQUEST = 'Poll_Fulfillment'
#: Constant identifying a Collection Information Request
MSG_COLLECTION_INFORMATION_REQUEST = 'Collection_Information_Request'
#: Constant identifying a Collection Information Response
MSG_COLLECTION_INFORMATION_RESPONSE = 'Collection_Information_Response'
#: Constant identifying a Subscription Request
MSG_MANAGE_COLLECTION_SUBSCRIPTION_REQUEST = 'Subscription_Management_Request'
#: Constant identifying a Subscription Response
MSG_MANAGE_COLLECTION_SUBSCRIPTION_RESPONSE = 'Subscription_Management_Response'
#: Tuple of all TAXII 1.1 Message Types
MSG_TYPES_11 = (MSG_STATUS_MESSAGE, MSG_DISCOVERY_REQUEST, MSG_DISCOVERY_RESPONSE,
MSG_COLLECTION_INFORMATION_REQUEST, MSG_COLLECTION_INFORMATION_RESPONSE,
MSG_MANAGE_COLLECTION_SUBSCRIPTION_REQUEST,
MSG_MANAGE_COLLECTION_SUBSCRIPTION_RESPONSE, MSG_POLL_REQUEST,
MSG_POLL_RESPONSE, MSG_INBOX_MESSAGE, MSG_POLL_FULFILLMENT_REQUEST)
# TAXII 1.0 Status Types
#: Constant identifying a Status Type of Bad Message
ST_BAD_MESSAGE = 'BAD_MESSAGE'
#: Constant identifying a Status Type of Denied
ST_DENIED = 'DENIED'
#: Constant identifying a Status Type of Failure
ST_FAILURE = 'FAILURE'
#: Constant identifying a Status Type of Not Found
ST_NOT_FOUND = 'NOT_FOUND'
#: Constant identifying a Status Type of Polling Unsupported
ST_POLLING_UNSUPPORTED = 'POLLING_UNSUPPORTED'
#: Constant identifying a Status Type of Retry
ST_RETRY = 'RETRY'
#: Constant identifying a Status Type of Success
ST_SUCCESS = 'SUCCESS'
#: Constant identifying a Status Type of Unauthorized
ST_UNAUTHORIZED = 'UNAUTHORIZED'
#: Constant identifying a Status Type of Unsupported Message Binding
ST_UNSUPPORTED_MESSAGE_BINDING = 'UNSUPPORTED_MESSAGE'
#: Constant identifying a Status Type of Unsupported Content Binding
ST_UNSUPPORTED_CONTENT_BINDING = 'UNSUPPORTED_CONTENT'
#: Constant identifying a Status Type of Unsupported Protocol Binding
ST_UNSUPPORTED_PROTOCOL = 'UNSUPPORTED_PROTOCOL'
#: Tuple of all TAXII 1.0 Status Types
ST_TYPES_10 = (ST_BAD_MESSAGE, ST_DENIED, ST_FAILURE, ST_NOT_FOUND,
ST_POLLING_UNSUPPORTED, ST_RETRY, ST_SUCCESS, ST_UNAUTHORIZED,
ST_UNSUPPORTED_MESSAGE_BINDING, ST_UNSUPPORTED_CONTENT_BINDING,
ST_UNSUPPORTED_PROTOCOL)
# New Status Types in TAXII 1.1
#: Constant identifying a Status Type of Asynchronous Poll Error
ST_ASYNCHRONOUS_POLL_ERROR = 'ASYNCHRONOUS_POLL_ERROR'
#: Constant identifying a Status Type of Destination Collection Error
ST_DESTINATION_COLLECTION_ERROR = 'DESTINATION_COLLECTION_ERROR'
#: Constant identifying a Status Type of Invalid Response Part
ST_INVALID_RESPONSE_PART = 'INVALID_RESPONSE_PART'
#: Constant identifying a Status Type of Network Error
ST_NETWORK_ERROR = 'NETWORK_ERROR'
#: Constant identifying a Status Type of Pending
ST_PENDING = 'PENDING'
#: Constant identifying a Status Type of Unsupported Query Format
ST_UNSUPPORTED_QUERY = 'UNSUPPORTED_QUERY'
#: Tuple of all TAXII 1.1 Status types
ST_TYPES_11 = (ST_ASYNCHRONOUS_POLL_ERROR, ST_BAD_MESSAGE, ST_DENIED,
ST_DESTINATION_COLLECTION_ERROR, ST_FAILURE, ST_INVALID_RESPONSE_PART,
ST_NETWORK_ERROR, ST_NOT_FOUND, ST_PENDING, ST_POLLING_UNSUPPORTED,
ST_RETRY, ST_SUCCESS, ST_UNAUTHORIZED, ST_UNSUPPORTED_MESSAGE_BINDING,
ST_UNSUPPORTED_CONTENT_BINDING, ST_UNSUPPORTED_PROTOCOL,
ST_UNSUPPORTED_QUERY)
# TAXII 1.0 Action Types
#: Constant identifying an Action of Subscribe
ACT_SUBSCRIBE = 'SUBSCRIBE'
#: Constant identifying an Action of Unsubscribe
ACT_UNSUBSCRIBE = 'UNSUBSCRIBE'
#: Constant identifying an Action of Status
ACT_STATUS = 'STATUS'
#: Tuple of all TAXII 1.0 Action Types
ACT_TYPES_10 = (ACT_SUBSCRIBE, ACT_UNSUBSCRIBE, ACT_STATUS)
#: Constant identifying an Action of Pause
ACT_PAUSE = 'PAUSE'
#: Constant identifying an Action of Resume
ACT_RESUME = 'RESUME'
#: Tuple of all TAXII 1.1 Action types
ACT_TYPES_11 = (ACT_SUBSCRIBE, ACT_PAUSE, ACT_RESUME, ACT_UNSUBSCRIBE, ACT_STATUS)
# TAXII 1.0 Service Types
#: Constant identifying a Service Type of Inbox
SVC_INBOX = 'INBOX'
#: Constant identifying a Service Type of Poll
SVC_POLL = 'POLL'
#: Constant identifying a Service Type of Feed Management
SVC_FEED_MANAGEMENT = 'FEED_MANAGEMENT'
#: Constant identifying a Service Type of Discovery
SVC_DISCOVERY = 'DISCOVERY'
#: Tuple of all TAXII 1.0 Service Types
SVC_TYPES_10 = (SVC_INBOX, SVC_POLL, SVC_FEED_MANAGEMENT, SVC_DISCOVERY)
# Renamed Status Types in TAXII 1.1
#: Constant identifying a Service Type of Collection Management.
#: "Feed Management" was renamed to "Collection Management" in TAXII 1.1.
SVC_COLLECTION_MANAGEMENT = 'COLLECTION_MANAGEMENT'
#: Tuple of all TAXII 1.1 Service Types
SVC_TYPES_11 = (SVC_INBOX, SVC_POLL, SVC_COLLECTION_MANAGEMENT, SVC_DISCOVERY)
# TAXII 1.1 Subscription Statuses
#: Subscription Status of Active
SS_ACTIVE = 'ACTIVE'
#: Subscription Status of Paused
SS_PAUSED = 'PAUSED'
#: Subscription Status of Unsubscribed
SS_UNSUBSCRIBED = 'UNSUBSCRIBED'
#: Tuple of all TAXII 1.1 Subscription Statues
SS_TYPES_11 = (SS_ACTIVE, SS_PAUSED, SS_UNSUBSCRIBED)
# TAXII 1.1 Response Types
#: Constant identifying a response type of Full
RT_FULL = 'FULL'
#: Constant identifying a response type of Count only
RT_COUNT_ONLY = 'COUNT_ONLY'
#: Tuple of all TAXII 1.1 Response Types
RT_TYPES_11 = (RT_FULL, RT_COUNT_ONLY)
# TAXII 1.1 Response Types
#: Constant identifying a collection type of Data Feed
CT_DATA_FEED = 'DATA_FEED'
#: Constant identifying a collection type of Data Set
CT_DATA_SET = 'DATA_SET'
#: Tuple of all TAXII 1.1 Collection Types
CT_TYPES_11 = (CT_DATA_FEED, CT_DATA_SET)
# TAXII 1.1 Status Detail Keys
#: Constant Identifying the Acceptable Destination Status Detail
SD_ACCEPTABLE_DESTINATION = 'ACCEPTABLE_DESTINATION'
#: Constant Identifying the Max Part Number Status Detail
SD_MAX_PART_NUMBER = 'MAX_PART_NUMBER'
#: Constant Identifying the Item Status Detail
SD_ITEM = 'ITEM'
#: Constant Identifying the Estimated Wait Status Detail
SD_ESTIMATED_WAIT = 'ESTIMATED_WAIT'
#: Constant Identifying the Result ID Status Detail
SD_RESULT_ID = 'RESULT_ID'
#: Constant Identifying the Will Push Status Detail
SD_WILL_PUSH = 'WILL_PUSH'
#: Constant Identifying the Supported Binding Status Detail
SD_SUPPORTED_BINDING = 'SUPPORTED_BINDING'
#: Constant Identifying the Supported Content Status Detail
SD_SUPPORTED_CONTENT = 'SUPPORTED_CONTENT'
#: Constant Identifying the Supported Protocol Status Detail
SD_SUPPORTED_PROTOCOL = 'SUPPORTED_PROTOCOL'
#: Constant Identifying the Supported Query Status Detail
SD_SUPPORTED_QUERY = 'SUPPORTED_QUERY'
#: Tuple of all TAXII 1.1 Status Detail Keys
SD_TYPES_11 = (SD_ACCEPTABLE_DESTINATION, SD_MAX_PART_NUMBER, SD_ITEM,
SD_ESTIMATED_WAIT, SD_RESULT_ID, SD_WILL_PUSH,
SD_SUPPORTED_BINDING, SD_SUPPORTED_CONTENT, SD_SUPPORTED_PROTOCOL,
SD_SUPPORTED_QUERY)
#: (For TAXII Default Query) Constant identifying supported Capability Modules
SD_CAPABILITY_MODULE = 'CAPABILITY_MODULE'
#: (For TAXII Default Query) Constant identifying Preferred Scopes
SD_PREFERRED_SCOPE = 'PREFERRED_SCOPE'
#: (For TAXII Default Query) Constant identifying Allowed Scopes
SD_ALLOWED_SCOPE = 'ALLOWED_SCOPE'
#: (For TAXII Default Query) Constant identifying supported Targeting Expression IDs
SD_TARGETING_EXPRESSION_ID = 'TARGETING_EXPRESSION_ID'
#: Format ID for this version of TAXII Default Query
FID_TAXII_DEFAULT_QUERY_10 = 'urn:taxii.mitre.org:query:default:1.0'
# Capability Module IDs
#: Capability Module ID for Core
CM_CORE = 'urn:taxii.mitre.org:query:capability:core-1'
#: Capability Module ID for Regex
CM_REGEX = 'urn:taxii.mitre.org:query:capability:regex-1'
#: Capability Module ID for Timestamp
CM_TIMESTAMP = 'urn:taxii.mitre.org:query:capability:timestamp-1'
#: Tuple of all capability modules defined in TAXII Default Query 1.0
CM_IDS = (CM_CORE, CM_REGEX, CM_TIMESTAMP)
# Operators
#: Operator OR
OP_OR = 'OR'
#: Operator AND
OP_AND = 'AND'
#: Tuple of all operators
OP_TYPES = (OP_OR, OP_AND)
#: Status Type indicating an unsupported capability module
ST_UNSUPPORTED_CAPABILITY_MODULE = 'UNSUPPORTED_CAPABILITY_MODULE'
#: Status Type indicating an unsupported targeting expression
ST_UNSUPPORTED_TARGETING_EXPRESSION = 'UNSUPPORTED_TARGETING_EXPRESSION'
#: Status Type indicating an unsupported targeting expression id
ST_UNSUPPORTED_TARGETING_EXPRESSION_ID = 'UNSUPPORTED_TARGETING_EXPRESSION_ID'
#: Parameter name: value
P_VALUE = 'value'
#: Parameter name: match_type
P_MATCH_TYPE = 'match_type'
#: Parameter name: case_sensitive
P_CASE_SENSITIVE = 'case_sensitive'
#: Tuple of all parameter names
P_NAMES = (P_VALUE, P_MATCH_TYPE, P_CASE_SENSITIVE)
#: Relationship name: equals
R_EQUALS = 'equals'
#: Relationship name: not_requals
R_NOT_EQUALS = 'not_equals'
#: Relationship name: greater_than
R_GREATER_THAN = 'greater_than'
#: Relationship name: greater_than_or_equal
R_GREATER_THAN_OR_EQUAL = 'greater_than_or_equal'
#: Relationship name: less_than
R_LESS_THAN = 'less_than'
#: Relationship name: less_than_or_equal
R_LESS_THAN_OR_EQUAL = 'less_than_or_equal'
#: Relationship name: does_not_exist
R_DOES_NOT_EXIST = 'does_not_exist'
#: Relationship name: exists
R_EXISTS = 'exists'
#: Relationship name: begins_with
R_BEGINS_WITH = 'begins_with'
#: Relationship name: ends_with
R_ENDS_WITH = 'ends_with'
#: Relationship name: contains
R_CONTAINS = 'contains'
#: Relationship name: matches
R_MATCHES = 'matches'
#: Tuple of all relationship names
R_NAMES = (R_EQUALS, R_NOT_EQUALS, R_GREATER_THAN,
R_GREATER_THAN_OR_EQUAL, R_LESS_THAN,
R_LESS_THAN_OR_EQUAL, R_DOES_NOT_EXIST,
R_EXISTS, R_BEGINS_WITH, R_ENDS_WITH,
R_CONTAINS, R_MATCHES)
# TAXII Version IDs #
#: Version ID for the TAXII Services Specification 1.0
VID_TAXII_SERVICES_10 = 'urn:taxii.mitre.org:services:1.0'
#: Version ID for the TAXII Services Specification 1.1
VID_TAXII_SERVICES_11 = 'urn:taxii.mitre.org:services:1.1'
#: Version ID for the TAXII XML Message Binding Specification 1.0
VID_TAXII_XML_10 = 'urn:taxii.mitre.org:message:xml:1.0'
#: Version ID for the TAXII XML Message Binding Specification 1.1
VID_TAXII_XML_11 = 'urn:taxii.mitre.org:message:xml:1.1'
#: Version ID for the TAXII HTTP Protocol Binding Specification 1.0
VID_TAXII_HTTP_10 = 'urn:taxii.mitre.org:protocol:http:1.0'
#: Version ID for the TAXII HTTPS Protocol Binding Specification 1.0
VID_TAXII_HTTPS_10 = 'urn:taxii.mitre.org:protocol:https:1.0'
# Third Party Version IDs
#: Version ID for the CERT EU JSON Message Binding
VID_CERT_EU_JSON_10 = 'urn:cert.europa.eu:message:json:1.0'
# TAXII Content Bindings #
#: Content Binding ID for STIX XML 1.0
CB_STIX_XML_10 = 'urn:stix.mitre.org:xml:1.0'
#: Content Binding ID for STIX XML 1.0.1
CB_STIX_XML_101 = 'urn:stix.mitre.org:xml:1.0.1'
#: Content Binding ID for STIX XML 1.1
CB_STIX_XML_11 = 'urn:stix.mitre.org:xml:1.1'
#: Content Binding ID for STIX XML 1.1.1
CB_STIX_XML_111 = 'urn:stix.mitre.org:xml:1.1.1'
#: Content Binding ID for STIX XML 1.2
CB_STIX_XML_12 = 'urn:stix.mitre.org:xml:1.2'
#: Content Binding ID for CAP 1.1
CB_CAP_11 = 'urn:oasis:names:tc:emergency:cap:1.1'
#: Content Binding ID for XML Encryption
CB_XENC_122002 = 'http://www.w3.org/2001/04/xmlenc#'
#: Content Binding ID for SMIME
CB_SMIME = 'application/x-pkcs7-mime'
STD_INDENT = ' ' # A "Standard Indent" to use for to_text() methods
libtaxii-1.1.119/libtaxii/messages.py 0000664 0000000 0000000 00000000666 14036072565 0017477 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
"""Backwards compatibility for TAXII 1.0.
All TAXII Message classes used to be in this file. Since TAXII 1.1 support
was added (in messages_11.py), the contents of this file were moved to
messages_10.py. This file allows existing code (referring to libtaxii.messages)
to continue working as before.
"""
from libtaxii.messages_10 import *
libtaxii-1.1.119/libtaxii/messages_10.py 0000664 0000000 0000000 00000303577 14036072565 0020006 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
"""
Creating, handling, and parsing TAXII 1.0 messages.
"""
import six
try:
import simplejson as json
except ImportError:
import json
import os
import warnings
from lxml import etree
from .common import (parse, parse_datetime_string, append_any_content_etree, TAXIIBase,
get_required, get_optional, get_optional_text, parse_xml_string,
stringify_content)
from .validation import do_check, uri_regex, check_timestamp_label, message_id_regex_10
from .constants import *
def validate_xml(xml_string):
"""
Note that this function has been deprecated. Please see
libtaxii.validators.SchemaValidator.
Validate XML with the TAXII XML Schema 1.0.
Args:
xml_string (str): The XML to validate.
Example:
.. code-block:: python
is_valid = tm10.validate_xml(message.to_xml())
"""
warnings.warn('Call to deprecated function: libtaxii.messages_10.validate_xml()',
category=DeprecationWarning)
etree_xml = parse_xml_string(xml_string)
package_dir, package_filename = os.path.split(__file__)
schema_file = os.path.join(package_dir, "xsd", "TAXII_XMLMessageBinding_Schema.xsd")
taxii_schema_doc = parse(schema_file, allow_file=True)
xml_schema = etree.XMLSchema(taxii_schema_doc)
valid = xml_schema.validate(etree_xml)
if not valid:
return xml_schema.error_log.last_error
return valid
def get_message_from_xml(xml_string, encoding='utf_8'):
"""Create a TAXIIMessage object from an XML string.
This function automatically detects which type of Message should be created
based on the XML.
Args:
xml_string (str): The XML to parse into a TAXII message.
Example:
.. code-block:: python
message_xml = message.to_xml()
new_message = tm10.get_message_from_xml(message_xml)
"""
if isinstance(xml_string, six.binary_type):
xml_string = xml_string.decode(encoding, 'replace')
etree_xml = parse_xml_string(xml_string)
qn = etree.QName(etree_xml)
if qn.namespace != ns_map['taxii']:
raise ValueError('Unsupported namespace: %s' % qn.namespace)
message_type = qn.localname
if message_type == MSG_DISCOVERY_REQUEST:
return DiscoveryRequest.from_etree(etree_xml)
if message_type == MSG_DISCOVERY_RESPONSE:
return DiscoveryResponse.from_etree(etree_xml)
if message_type == MSG_FEED_INFORMATION_REQUEST:
return FeedInformationRequest.from_etree(etree_xml)
if message_type == MSG_FEED_INFORMATION_RESPONSE:
return FeedInformationResponse.from_etree(etree_xml)
if message_type == MSG_POLL_REQUEST:
return PollRequest.from_etree(etree_xml)
if message_type == MSG_POLL_RESPONSE:
return PollResponse.from_etree(etree_xml)
if message_type == MSG_STATUS_MESSAGE:
return StatusMessage.from_etree(etree_xml)
if message_type == MSG_INBOX_MESSAGE:
return InboxMessage.from_etree(etree_xml)
if message_type == MSG_MANAGE_FEED_SUBSCRIPTION_REQUEST:
return ManageFeedSubscriptionRequest.from_etree(etree_xml)
if message_type == MSG_MANAGE_FEED_SUBSCRIPTION_RESPONSE:
return ManageFeedSubscriptionResponse.from_etree(etree_xml)
raise ValueError('Unknown message_type: %s' % message_type)
def get_message_from_dict(d):
"""Create a TAXIIMessage object from a dictonary.
This function automatically detects which type of Message should be created
based on the 'message_type' key in the dictionary.
Args:
d (dict): The dictionary to build the TAXII message from.
Example:
.. code-block:: python
message_dict = message.to_dict()
new_message = tm10.get_message_from_dict(message_dict)
"""
if 'message_type' not in d:
raise ValueError('message_type is a required field!')
message_type = d['message_type']
if message_type == MSG_DISCOVERY_REQUEST:
return DiscoveryRequest.from_dict(d)
if message_type == MSG_DISCOVERY_RESPONSE:
return DiscoveryResponse.from_dict(d)
if message_type == MSG_FEED_INFORMATION_REQUEST:
return FeedInformationRequest.from_dict(d)
if message_type == MSG_FEED_INFORMATION_RESPONSE:
return FeedInformationResponse.from_dict(d)
if message_type == MSG_POLL_REQUEST:
return PollRequest.from_dict(d)
if message_type == MSG_POLL_RESPONSE:
return PollResponse.from_dict(d)
if message_type == MSG_STATUS_MESSAGE:
return StatusMessage.from_dict(d)
if message_type == MSG_INBOX_MESSAGE:
return InboxMessage.from_dict(d)
if message_type == MSG_MANAGE_FEED_SUBSCRIPTION_REQUEST:
return ManageFeedSubscriptionRequest.from_dict(d)
if message_type == MSG_MANAGE_FEED_SUBSCRIPTION_RESPONSE:
return ManageFeedSubscriptionResponse.from_dict(d)
raise ValueError('Unknown message_type: %s' % message_type)
def get_message_from_json(json_string, encoding='utf_8'):
"""Create a TAXIIMessage object from a JSON string.
This function automatically detects which type of Message should be created
based on the JSON.
Args:
json_string (str): The JSON to parse into a TAXII message.
"""
decoded_string = json_string.decode(encoding, 'replace')
return get_message_from_dict(json.loads(decoded_string))
class TAXIIBase10(TAXIIBase):
version = VID_TAXII_XML_10
class DeliveryParameters(TAXIIBase10):
"""Delivery Parameters.
Args:
inbox_protocol (str): identifies the protocol to be used when pushing
TAXII Data Feed content to a Consumer's TAXII Inbox Service
implementation. **Required**
inbox_address (str): identifies the address of the TAXII Daemon hosting
the Inbox Service to which the Consumer requests content for this
TAXII Data Feed to be delivered. **Required**
delivery_message_binding (str): identifies the message binding to be
used to send pushed content for this subscription. **Required**
content_bindings (list of str): contains Content Binding IDs
indicating which types of contents the Consumer requests to
receive for this TAXII Data Feed. **Optional**
"""
# TODO: Should the default arguments of these change? I'm not sure these are
# actually optional
def __init__(self, inbox_protocol=None, inbox_address=None,
delivery_message_binding=None, content_bindings=None):
self.inbox_protocol = inbox_protocol
self.inbox_address = inbox_address
self.delivery_message_binding = delivery_message_binding
self.content_bindings = content_bindings or []
@property
def sort_key(self):
return self.inbox_address
@property
def inbox_protocol(self):
return self._inbox_protocol
@inbox_protocol.setter
def inbox_protocol(self, value):
do_check(value, 'inbox_protocol', regex_tuple=uri_regex)
self._inbox_protocol = value
@property
def inbox_address(self):
return self._inbox_address
@inbox_address.setter
def inbox_address(self, value):
# TODO: Can inbox_address be validated?
self._inbox_address = value
@property
def delivery_message_binding(self):
return self._delivery_message_binding
@delivery_message_binding.setter
def delivery_message_binding(self, value):
do_check(value, 'delivery_message_binding', regex_tuple=uri_regex)
self._delivery_message_binding = value
@property
def content_bindings(self):
return self._content_bindings
@content_bindings.setter
def content_bindings(self, value):
do_check(value, 'content_bindings', regex_tuple=uri_regex)
self._content_bindings = value
def to_etree(self):
xml = etree.Element('{%s}Push_Parameters' % ns_map['taxii'])
if self.inbox_protocol is not None:
pb = etree.SubElement(xml, '{%s}Protocol_Binding' % ns_map['taxii'])
pb.text = self.inbox_protocol
if self.inbox_address is not None:
a = etree.SubElement(xml, '{%s}Address' % ns_map['taxii'])
a.text = self.inbox_address
if self.delivery_message_binding is not None:
mb = etree.SubElement(xml, '{%s}Message_Binding' % ns_map['taxii'])
mb.text = self.delivery_message_binding
for binding in self.content_bindings:
cb = etree.SubElement(xml, '{%s}Content_Binding' % ns_map['taxii'])
cb.text = binding
return xml
def to_dict(self):
d = {}
if self.inbox_protocol is not None:
d['inbox_protocol'] = self.inbox_protocol
if self.inbox_address is not None:
d['inbox_address'] = self.inbox_address
if self.delivery_message_binding is not None:
d['delivery_message_binding'] = self.delivery_message_binding
d['content_bindings'] = []
for binding in self.content_bindings:
d['content_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Push Parameters ===\n"
s += line_prepend + " Inbox Protocol: %s\n" % self.inbox_protocol
s += line_prepend + " Address: %s\n" % self.inbox_address
s += line_prepend + " Message Binding: %s\n" % self.delivery_message_binding
if len(self.content_bindings) > 0:
s += line_prepend + " Content Bindings: Any Content\n"
for cb in self.content_bindings:
s += line_prepend + " Content Binding: %s\n" % str(cb)
return s
@staticmethod
def from_etree(etree_xml):
inbox_protocol = get_optional_text(etree_xml, './taxii:Protocol_Binding', ns_map)
inbox_address = get_optional_text(etree_xml, './taxii:Address', ns_map)
delivery_message_binding = get_optional_text(etree_xml, './taxii:Message_Binding', ns_map)
content_bindings = []
for binding in etree_xml.xpath('./taxii:Content_Binding', namespaces=ns_map):
content_bindings.append(binding.text)
return DeliveryParameters(inbox_protocol, inbox_address, delivery_message_binding, content_bindings)
@staticmethod
def from_dict(d):
return DeliveryParameters(**d)
class TAXIIMessage(TAXIIBase10):
"""Encapsulate properties common to all TAXII Messages (such as headers).
This class is extended by each Message Type (e.g., DiscoveryRequest), with
each subclass containing subclass-specific information
"""
message_type = 'TAXIIMessage'
def __init__(self, message_id, in_response_to=None, extended_headers=None):
"""Create a new TAXIIMessage
Arguments:
- message_id (string) - A value identifying this message.
- in_response_to (string) - Contains the Message ID of the message to
which this is a response.
- extended_headers (dictionary) - A dictionary of name/value pairs for
use as Extended Headers
"""
self.message_id = message_id
self.in_response_to = in_response_to
if extended_headers is None:
self.extended_headers = {}
else:
self.extended_headers = extended_headers
@property
def message_id(self):
return self._message_id
@message_id.setter
def message_id(self, value):
do_check(value, 'message_id', regex_tuple=message_id_regex_10)
self._message_id = value
@property
def in_response_to(self):
return self._in_response_to
@in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=message_id_regex_10, can_be_none=True)
self._in_response_to = value
@property
def extended_headers(self):
return self._extended_headers
@extended_headers.setter
def extended_headers(self, value):
do_check(list(value.keys()), 'extended_headers.keys()', regex_tuple=uri_regex)
self._extended_headers = value
def to_etree(self):
"""Creates the base etree for the TAXII Message.
Message-specific constructs must be added by each Message class. In
general, when converting to XML, subclasses should call this method
first, then create their specific XML constructs.
"""
root_elt = etree.Element('{%s}%s' % (ns_map['taxii'], self.message_type), nsmap=ns_map)
root_elt.attrib['message_id'] = str(self.message_id)
if self.in_response_to is not None:
root_elt.attrib['in_response_to'] = str(self.in_response_to)
if len(self.extended_headers) > 0:
eh = etree.SubElement(root_elt, '{%s}Extended_Headers' % ns_map['taxii'])
for name, value in list(self.extended_headers.items()):
h = etree.SubElement(eh, '{%s}Extended_Header' % ns_map['taxii'])
h.attrib['name'] = name
append_any_content_etree(h, value)
# h.text = value
return root_elt
def to_xml(self, pretty_print=False):
"""Convert a message to XML.
Subclasses shouldn't implement this method, as it is mainly a wrapper
for cls.to_etree.
"""
return etree.tostring(self.to_etree(), pretty_print=pretty_print, encoding='utf-8')
def to_dict(self):
"""Create the base dictionary for the TAXII Message.
Message-specific constructs must be added by each Message class. In
general, when converting to dictionary, subclasses should call this
method first, then create their specific dictionary constructs.
"""
d = {}
d['message_type'] = self.message_type
d['message_id'] = self.message_id
if self.in_response_to is not None:
d['in_response_to'] = self.in_response_to
d['extended_headers'] = {}
for k, v in six.iteritems(self.extended_headers):
if isinstance(v, etree._Element) or isinstance(v, etree._ElementTree):
v = etree.tostring(v, encoding='utf-8')
elif not isinstance(v, six.string_types):
v = str(v)
d['extended_headers'][k] = v
return d
def to_text(self, line_prepend=''):
s = line_prepend + "Message Type: %s\n" % self.message_type
s += line_prepend + "Message ID: %s" % self.message_id
if self.in_response_to:
s += "; In Response To: %s" % self.in_response_to
s += "\n"
for k, v in six.iteritems(self.extended_headers):
s += line_prepend + "Extended Header: %s = %s" % (k, v)
return s
@classmethod
def from_etree(cls, src_etree, **kwargs):
"""Pulls properties of a TAXII Message from an etree.
Message-specific constructs must be pulled by each Message class. In
general, when converting from etree, subclasses should call this method
first, then parse their specific XML constructs.
"""
# Check namespace and element name of the root element
expected_tag = '{%s}%s' % (ns_map['taxii'], cls.message_type)
tag = src_etree.tag
if tag != expected_tag:
raise ValueError('%s != %s' % (tag, expected_tag))
# Get the message ID
message_id = get_required(src_etree, '/taxii:*/@message_id', ns_map)
# Get in response to, if present
in_response_to = get_optional(src_etree, '/taxii:*/@in_response_to', ns_map)
if in_response_to is not None:
kwargs['in_response_to'] = in_response_to
# Get the Extended headers
extended_header_list = src_etree.xpath('/taxii:*/taxii:Extended_Headers/taxii:Extended_Header', namespaces=ns_map)
extended_headers = {}
for header in extended_header_list:
eh_name = header.xpath('./@name')[0]
# eh_value = header.text
if len(header) == 0: # This has string content
eh_value = header.text
else: # This has XML content
eh_value = header[0]
extended_headers[eh_name] = eh_value
return cls(message_id, extended_headers=extended_headers, **kwargs)
@classmethod
def from_xml(cls, xml):
"""Parse a Message from XML.
Subclasses shouldn't implemnet this method, as it is mainly a wrapper
for cls.from_etree.
"""
etree_xml = parse_xml_string(xml)
return cls.from_etree(etree_xml)
@classmethod
def from_dict(cls, d, **kwargs):
"""Pulls properties of a TAXII Message from a dictionary.
Message-specific constructs must be pulled by each Message class. In
general, when converting from dictionary, subclasses should call this
method first, then parse their specific dictionary constructs.
"""
message_type = d['message_type']
if message_type != cls.message_type:
raise ValueError('%s != %s' % (message_type, cls.message_type))
message_id = d['message_id']
extended_headers = {}
for k, v in six.iteritems(d['extended_headers']):
try:
v = parse(v, allow_file=False)
except etree.XMLSyntaxError:
pass
extended_headers[k] = v
in_response_to = d.get('in_response_to')
if in_response_to:
kwargs['in_response_to'] = in_response_to
return cls(message_id, extended_headers=extended_headers, **kwargs)
@classmethod
def from_json(cls, json_string):
return cls.from_dict(json.loads(json_string))
class ContentBlock(TAXIIBase10):
"""A TAXII Content Block.
Args:
content_binding (str): a Content Binding ID or nesting expression
indicating the type of content contained in the Content field of this
Content Block. **Required**
content (string or etree): a piece of content of the type specified
by the Content Binding. **Required**
timestamp_label (datetime): the Timestamp Label associated with this
Content Block. **Optional**
padding (string): an arbitrary amount of padding for this Content
Block. **Optional**
"""
NAME = 'Content_Block'
def __init__(self, content_binding, content, timestamp_label=None, padding=None):
self.content_binding = content_binding
self.content = content
self.timestamp_label = timestamp_label
self.padding = padding
@property
def sort_key(self):
return self.content[:25]
@property
def content_binding(self):
return self._content_binding
@content_binding.setter
def content_binding(self, value):
do_check(value, 'content_binding', regex_tuple=uri_regex)
self._content_binding = value
@property
def content(self):
if self.content_is_xml:
return etree.tostring(self._content, encoding='utf-8')
else:
return self._content
@content.setter
def content(self, value):
do_check(value, 'content') # Just check for not None
self._content, self.content_is_xml = stringify_content(value)
@property
def content_is_xml(self):
return self._content_is_xml
@content_is_xml.setter
def content_is_xml(self, value):
do_check(value, 'content_is_xml', value_tuple=(True, False))
self._content_is_xml = value
@property
def timestamp_label(self):
return self._timestamp_label
@timestamp_label.setter
def timestamp_label(self, value):
value = check_timestamp_label(value, 'timestamp_label', can_be_none=True)
self._timestamp_label = value
def to_etree(self):
block = etree.Element('{%s}Content_Block' % ns_map['taxii'], nsmap=ns_map)
cb = etree.SubElement(block, '{%s}Content_Binding' % ns_map['taxii'])
cb.text = self.content_binding
c = etree.SubElement(block, '{%s}Content' % ns_map['taxii'])
if self.content_is_xml:
c.append(self._content)
else:
c.text = self._content
if self.timestamp_label:
tl = etree.SubElement(block, '{%s}Timestamp_Label' % ns_map['taxii'])
tl.text = self.timestamp_label.isoformat()
if self.padding is not None:
p = etree.SubElement(block, '{%s}Padding' % ns_map['taxii'])
p.text = self.padding
return block
def to_dict(self):
block = {}
block['content_binding'] = self.content_binding
if self.content_is_xml:
block['content'] = etree.tostring(self._content, encoding='utf-8')
else:
block['content'] = self._content
block['content_is_xml'] = self.content_is_xml
if self.timestamp_label:
block['timestamp_label'] = self.timestamp_label.isoformat()
if self.padding is not None:
block['padding'] = self.padding
return block
def to_text(self, line_prepend=''):
s = line_prepend + "=== Content Block ===\n"
s += line_prepend + " Content Binding: %s\n" % self.content_binding
s += line_prepend + " Content Length: %s\n" % len(self.content)
s += line_prepend + " (Only content length is shown for brevity)\n"
if self.timestamp_label:
s += line_prepend + " Timestamp Label: %s\n" % self.timestamp_label.isoformat()
s += line_prepend + " Padding: %s\n" % self.padding
return s
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['content_binding'] = get_required(etree_xml, './taxii:Content_Binding', ns_map).text
kwargs['padding'] = get_optional_text(etree_xml, './taxii:Padding', ns_map)
ts_text = get_optional_text(etree_xml, './taxii:Timestamp_Label', ns_map)
if ts_text:
kwargs['timestamp_label'] = parse_datetime_string(ts_text)
content = get_required(etree_xml, './taxii:Content', ns_map)
if len(content) == 0: # This has string content
kwargs['content'] = content.text
else: # This has XML content
kwargs['content'] = content[0]
return ContentBlock(**kwargs)
@staticmethod
def from_dict(d):
kwargs = {}
kwargs['content_binding'] = d['content_binding']
kwargs['padding'] = d.get('padding')
if d.get('timestamp_label'):
kwargs['timestamp_label'] = parse_datetime_string(d['timestamp_label'])
is_xml = d.get('content_is_xml', False)
if is_xml:
#FIXME: to parse or not to parse the content - this should be configurable
kwargs['content'] = parse(d['content'], allow_file=False)
else:
kwargs['content'] = d['content']
cb = ContentBlock(**kwargs)
return cb
@classmethod
def from_json(cls, json_string):
return cls.from_dict(json.loads(json_string))
# TAXII Message Classes #
class DiscoveryRequest(TAXIIMessage):
"""
A TAXII Discovery Request message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
"""
message_type = MSG_DISCOVERY_REQUEST
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value:
raise ValueError('in_response_to must be None')
self._in_response_to = value
class DiscoveryResponse(TAXIIMessage):
"""
A TAXII Discovery Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Optional**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
service_instances (list of `ServiceInstance`): a list of
service instances that this response contains. **Optional**
"""
message_type = MSG_DISCOVERY_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None, service_instances=None):
super(DiscoveryResponse, self).__init__(message_id, in_response_to, extended_headers)
self.service_instances = service_instances or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def service_instances(self):
return self._service_instances
@service_instances.setter
def service_instances(self, value):
do_check(value, 'service_instances', type=ServiceInstance)
self._service_instances = value
def to_etree(self):
xml = super(DiscoveryResponse, self).to_etree()
for service_instance in self.service_instances:
xml.append(service_instance.to_etree())
return xml
def to_dict(self):
d = super(DiscoveryResponse, self).to_dict()
d['service_instances'] = []
for service_instance in self.service_instances:
d['service_instances'].append(service_instance.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(DiscoveryResponse, self).to_text(line_prepend)
for si in self.service_instances:
s += si.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
msg = super(DiscoveryResponse, cls).from_etree(etree_xml)
msg.service_instances = []
for service_instance in etree_xml.xpath('./taxii:Service_Instance', namespaces=ns_map):
si = ServiceInstance.from_etree(service_instance)
msg.service_instances.append(si)
return msg
@classmethod
def from_dict(cls, d):
msg = super(DiscoveryResponse, cls).from_dict(d)
msg.service_instances = []
for service_instance in d['service_instances']:
si = ServiceInstance.from_dict(service_instance)
msg.service_instances.append(si)
return msg
class ServiceInstance(TAXIIBase10):
"""
The Service Instance component of a TAXII Discovery Response Message.
Args:
service_type (string): identifies the Service Type of this
Service Instance. **Required**
services_version (string): identifies the TAXII Services
Specification to which this Service conforms. **Required**
protocol_binding (string): identifies the protocol binding
supported by this Service. **Required**
service_address (string): identifies the network address of the
TAXII Daemon that hosts this Service. **Required**
message_bindings (list of strings): identifies the message
bindings supported by this Service instance. **Required**
inbox_service_accepted_content (list of strings): identifies
content bindings that this Inbox Service is willing to accept.
**Optional**
available (boolean): indicates whether the identity of the
requester (authenticated or otherwise) is allowed to access this
TAXII Service. **Optional**
message (string): contains a message regarding this Service
instance. **Optional**
The ``message_bindings`` list must contain at least one value.
"""
def __init__(self, service_type, services_version, protocol_binding,
service_address, message_bindings,
inbox_service_accepted_content=None, available=None,
message=None):
self.service_type = service_type
self.services_version = services_version
self.protocol_binding = protocol_binding
self.service_address = service_address
self.message_bindings = message_bindings
self.inbox_service_accepted_content = inbox_service_accepted_content or []
self.available = available
self.message = message
@property
def sort_key(self):
return self.service_address
@property
def service_type(self):
return self._service_type
@service_type.setter
def service_type(self, value):
do_check(value, 'service_type', value_tuple=SVC_TYPES)
self._service_type = value
@property
def services_version(self):
return self._services_version
@services_version.setter
def services_version(self, value):
do_check(value, 'services_version', regex_tuple=uri_regex)
self._services_version = value
@property
def protocol_binding(self):
return self._protocol_binding
@protocol_binding.setter
def protocol_binding(self, value):
do_check(value, 'protocol_binding', regex_tuple=uri_regex)
self._protocol_binding = value
@property
def service_address(self):
return self._service_address
@service_address.setter
def service_address(self, value):
self._service_address = value
@property
def message_bindings(self):
return self._message_bindings
@message_bindings.setter
def message_bindings(self, value):
do_check(value, 'message_bindings', regex_tuple=uri_regex)
self._message_bindings = value
@property
def inbox_service_accepted_content(self):
return self._inbox_service_accepted_content
@inbox_service_accepted_content.setter
def inbox_service_accepted_content(self, value):
do_check(value, 'inbox_service_accepted_content', regex_tuple=uri_regex)
self._inbox_service_accepted_content = value
@property
def available(self):
return self._available
@available.setter
def available(self, value):
do_check(value, 'available', value_tuple=(True, False), can_be_none=True)
self._available = value
def to_etree(self):
si = etree.Element('{%s}Service_Instance' % ns_map['taxii'])
si.attrib['service_type'] = self.service_type
si.attrib['service_version'] = self.services_version
if self.available:
si.attrib['available'] = str(self.available).lower()
protocol_binding = etree.SubElement(si, '{%s}Protocol_Binding' % ns_map['taxii'])
protocol_binding.text = self.protocol_binding
service_address = etree.SubElement(si, '{%s}Address' % ns_map['taxii'])
service_address.text = self.service_address
for mb in self.message_bindings:
message_binding = etree.SubElement(si, '{%s}Message_Binding' % ns_map['taxii'])
message_binding.text = mb
for cb in self.inbox_service_accepted_content:
content_binding = etree.SubElement(si, '{%s}Content_Binding' % ns_map['taxii'])
content_binding.text = cb
if self.message is not None:
message = etree.SubElement(si, '{%s}Message' % ns_map['taxii'])
message.text = self.message
return si
def to_dict(self):
d = {}
d['service_type'] = self.service_type
d['services_version'] = self.services_version
d['protocol_binding'] = self.protocol_binding
d['service_address'] = self.service_address
d['message_bindings'] = self.message_bindings
d['inbox_service_accepted_content'] = self.inbox_service_accepted_content
d['available'] = self.available
d['message'] = self.message
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Service Instance===\n"
s += line_prepend + " Service Type: %s\n" % self.service_type
s += line_prepend + " Services Version: %s\n" % self.services_version
s += line_prepend + " Protocol Binding: %s\n" % self.protocol_binding
s += line_prepend + " Address: %s\n" % self.service_address
for mb in self.message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
if len(self.inbox_service_accepted_content) == 0:
s += line_prepend + " Inbox Service Accepts: %s\n" % None
for isac in self.inbox_service_accepted_content:
s += line_prepend + " Inbox Service Accepts: %s\n" % isac
s += line_prepend + " Available: %s\n" % self.available
s += line_prepend + " Message: %s\n" % self.message
return s
@classmethod
def from_etree(cls, etree_xml): # Expects a taxii:Service_Instance element
service_type = etree_xml.attrib['service_type']
services_version = etree_xml.attrib['service_version']
available = None
if etree_xml.attrib.get('available'):
tmp_available = etree_xml.attrib['available']
available = tmp_available.lower() == 'true'
protocol_binding = get_required(etree_xml, './taxii:Protocol_Binding', ns_map).text
service_address = get_required(etree_xml, './taxii:Address', ns_map).text
message_bindings = []
for mb in etree_xml.xpath('./taxii:Message_Binding', namespaces=ns_map):
message_bindings.append(mb.text)
inbox_service_accepted_contents = []
for cb in etree_xml.xpath('./taxii:Content_Binding', namespaces=ns_map):
inbox_service_accepted_contents.append(cb.text)
message = get_optional_text(etree_xml, './taxii:Message', ns_map)
return ServiceInstance(service_type, services_version, protocol_binding,
service_address, message_bindings, inbox_service_accepted_contents,
available, message)
@staticmethod
def from_dict(d):
return ServiceInstance(**d)
class FeedInformationRequest(TAXIIMessage):
"""
A TAXII Feed Information Request message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
"""
message_type = MSG_FEED_INFORMATION_REQUEST
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value:
raise ValueError('in_response_to must be None')
self._in_response_to = value
class FeedInformationResponse(TAXIIMessage):
"""
A TAXII Feed Information Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
feed_informations (list of FeedInformation): A list
of FeedInformation objects to be contained in this response.
**Optional**
"""
message_type = MSG_FEED_INFORMATION_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None, feed_informations=None):
super(FeedInformationResponse, self).__init__(message_id, in_response_to, extended_headers=extended_headers)
self.feed_informations = feed_informations or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=message_id_regex_10)
self._in_response_to = value
@property
def feed_informations(self):
return self._feed_informations
@feed_informations.setter
def feed_informations(self, value):
do_check(value, 'feed_informations', type=FeedInformation)
self._feed_informations = value
def to_etree(self):
xml = super(FeedInformationResponse, self).to_etree()
for feed in self.feed_informations:
xml.append(feed.to_etree())
return xml
def to_dict(self):
d = super(FeedInformationResponse, self).to_dict()
d['feed_informations'] = []
for feed in self.feed_informations:
d['feed_informations'].append(feed.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(FeedInformationResponse, self).to_text(line_prepend)
for feed in self.feed_informations:
s += feed.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
msg = super(FeedInformationResponse, cls).from_etree(etree_xml)
msg.feed_informations = []
feed_informations = etree_xml.xpath('./taxii:Feed', namespaces=ns_map)
for feed in feed_informations:
msg.feed_informations.append(FeedInformation.from_etree(feed))
return msg
@classmethod
def from_dict(cls, d):
msg = super(FeedInformationResponse, cls).from_dict(d)
msg.feed_informations = []
for feed in d['feed_informations']:
msg.feed_informations.append(FeedInformation.from_dict(feed))
return msg
class FeedInformation(TAXIIBase10):
"""
The Feed Information component of a TAXII Feed Information Response
Message.
Arguments:
feed_name (str): the name by which this TAXII Data Feed is
identified. **Required**
feed_description (str): a prose description of this TAXII
Data Feed. **Required**
supported_contents (list of str): Content Binding IDs
indicating which types of content are currently expressed in this
TAXII Data Feed. **Required**
available (boolean): whether the identity of the requester
(authenticated or otherwise) is allowed to access this TAXII
Service. **Optional** Default: ``None``, indicating "unknown"
push_methods (list of PushMethod objects): the protocols that
can be used to push content via a subscription. **Optional**
polling_service_instances (list of PollingServiceInstance objects):
the bindings and address a Consumer can use to interact with a
Poll Service instance that supports this TAXII Data Feed.
**Optional**
subscription_methods (list of SubscriptionMethod objects): the
protocol and address of the TAXII Daemon hosting the Feed
Management Service that can process subscriptions for this TAXII
Data Feed. **Optional**
The absense of ``push_methods`` indicates no push methods. The absense
of ``polling_service_instances`` indicates no polling services. At
least one of ``push_methods`` and ``polling_service_instances`` must not
be empty. The absense of ``subscription_methods`` indicates no
subscription services.
"""
def __init__(self, feed_name, feed_description, supported_contents,
available=None, push_methods=None,
polling_service_instances=None, subscription_methods=None):
self.feed_name = feed_name
self.available = available
self.feed_description = feed_description
self.supported_contents = supported_contents
self.push_methods = push_methods or []
self.polling_service_instances = polling_service_instances or []
self.subscription_methods = subscription_methods or []
@property
def sort_key(self):
return self.feed_name
@property
def feed_name(self):
return self._feed_name
@feed_name.setter
def feed_name(self, value):
do_check(value, 'feed_name', regex_tuple=uri_regex)
self._feed_name = value
@property
def available(self):
return self._available
@available.setter
def available(self, value):
do_check(value, 'available', value_tuple=(True, False), can_be_none=True)
self._available = value
@property
def supported_contents(self):
return self._supported_contents
@supported_contents.setter
def supported_contents(self, value):
do_check(value, 'supported_contents', regex_tuple=uri_regex)
self._supported_contents = value
@property
def push_methods(self):
return self._push_methods
@push_methods.setter
def push_methods(self, value):
do_check(value, 'push_methods', type=PushMethod)
self._push_methods = value
@property
def polling_service_instances(self):
return self._polling_service_instances
@polling_service_instances.setter
def polling_service_instances(self, value):
do_check(value, 'polling_service_instances', type=PollingServiceInstance)
self._polling_service_instances = value
@property
def subscription_methods(self):
return self._subscription_methods
@subscription_methods.setter
def subscription_methods(self, value):
do_check(value, 'subscription_methods', type=SubscriptionMethod)
self._subscription_methods = value
def to_etree(self):
f = etree.Element('{%s}Feed' % ns_map['taxii'])
f.attrib['feed_name'] = self.feed_name
if self.available:
f.attrib['available'] = str(self.available).lower()
feed_description = etree.SubElement(f, '{%s}Description' % ns_map['taxii'])
feed_description.text = self.feed_description
for binding in self.supported_contents:
cb = etree.SubElement(f, '{%s}Content_Binding' % ns_map['taxii'])
cb.text = binding
for push_method in self.push_methods:
f.append(push_method.to_etree())
for polling_service in self.polling_service_instances:
f.append(polling_service.to_etree())
for subscription_method in self.subscription_methods:
f.append(subscription_method.to_etree())
return f
def to_dict(self):
d = {}
d['feed_name'] = self.feed_name
if self.available:
d['available'] = self.available
d['feed_description'] = self.feed_description
d['supported_contents'] = self.supported_contents
d['push_methods'] = []
for push_method in self.push_methods:
d['push_methods'].append(push_method.to_dict())
d['polling_service_instances'] = []
for polling_service in self.polling_service_instances:
d['polling_service_instances'].append(polling_service.to_dict())
d['subscription_methods'] = []
for subscription_method in self.subscription_methods:
d['subscription_methods'].append(subscription_method.to_dict())
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Data Feed ===\n"
s += line_prepend + " Feed Name: %s\n" % self.feed_name
if self.available:
s += line_prepend + " Available: %s\n" % self.available
s += line_prepend + " Feed Description: %s\n" % self.feed_description
for sc in self.supported_contents:
s += line_prepend + " Supported Content: %s\n" % sc
for pm in self.push_methods:
s += pm.to_text(line_prepend + STD_INDENT)
for ps in self.polling_service_instances:
s += ps.to_text(line_prepend + STD_INDENT)
for sm in self.subscription_methods:
s += sm.to_text(line_prepend + STD_INDENT)
return s
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['feed_name'] = etree_xml.attrib['feed_name']
kwargs['available'] = None
if 'available' in etree_xml.attrib:
tmp = etree_xml.attrib['available']
kwargs['available'] = tmp.lower() == 'true'
kwargs['feed_description'] = get_required(etree_xml, './taxii:Description', ns_map).text
kwargs['supported_contents'] = []
for binding_elt in etree_xml.xpath('./taxii:Content_Binding', namespaces=ns_map):
kwargs['supported_contents'].append(binding_elt.text)
kwargs['push_methods'] = []
for push_method_elt in etree_xml.xpath('./taxii:Push_Method', namespaces=ns_map):
kwargs['push_methods'].append(PushMethod.from_etree(push_method_elt))
kwargs['polling_service_instances'] = []
for polling_elt in etree_xml.xpath('./taxii:Polling_Service', namespaces=ns_map):
kwargs['polling_service_instances'].append(PollingServiceInstance.from_etree(polling_elt))
kwargs['subscription_methods'] = []
for subscription_elt in etree_xml.xpath('./taxii:Subscription_Service', namespaces=ns_map):
kwargs['subscription_methods'].append(SubscriptionMethod.from_etree(subscription_elt))
return FeedInformation(**kwargs)
@staticmethod
def from_dict(d):
kwargs = {}
kwargs['feed_name'] = d['feed_name']
kwargs['available'] = d.get('available')
kwargs['feed_description'] = d['feed_description']
kwargs['supported_contents'] = []
for binding in d.get('supported_contents', []):
kwargs['supported_contents'].append(binding)
kwargs['push_methods'] = []
for push_method in d.get('push_methods', []):
kwargs['push_methods'].append(PushMethod.from_dict(push_method))
kwargs['polling_service_instances'] = []
for polling in d.get('polling_service_instances', []):
kwargs['polling_service_instances'].append(PollingServiceInstance.from_dict(polling))
kwargs['subscription_methods'] = []
for subscription_method in d.get('subscription_methods', []):
kwargs['subscription_methods'].append(SubscriptionMethod.from_dict(subscription_method))
return FeedInformation(**kwargs)
class PushMethod(TAXIIBase10):
"""
The Push Method component of a TAXII Feed Information
component.
Args:
push_protocol (str): a protocol binding that can be used
to push content to an Inbox Service instance. **Required**
push_message_bindings (list of str): the message bindings that
can be used to push content to an Inbox Service instance
using the protocol identified in the Push Protocol field.
**Required**
"""
def __init__(self, push_protocol, push_message_bindings):
self.push_protocol = push_protocol
self.push_message_bindings = push_message_bindings
@property
def sort_key(self):
return self.push_protocol
@property
def push_protocol(self):
return self._push_protocol
@push_protocol.setter
def push_protocol(self, value):
do_check(value, 'push_protocol', regex_tuple=uri_regex)
self._push_protocol = value
@property
def push_message_bindings(self):
return self._push_message_bindings
@push_message_bindings.setter
def push_message_bindings(self, value):
do_check(value, 'push_message_bindings', regex_tuple=uri_regex)
self._push_message_bindings = value
def to_etree(self):
x = etree.Element('{%s}Push_Method' % ns_map['taxii'])
proto_bind = etree.SubElement(x, '{%s}Protocol_Binding' % ns_map['taxii'])
proto_bind.text = self.push_protocol
for binding in self.push_message_bindings:
b = etree.SubElement(x, '{%s}Message_Binding' % ns_map['taxii'])
b.text = binding
return x
def to_dict(self):
d = {}
d['push_protocol'] = self.push_protocol
d['push_message_bindings'] = []
for binding in self.push_message_bindings:
d['push_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Push Method ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.push_protocol
for mb in self.push_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
return s
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['push_protocol'] = get_required(etree_xml, './taxii:Protocol_Binding', ns_map).text
kwargs['push_message_bindings'] = []
for message_binding in etree_xml.xpath('./taxii:Message_Binding', namespaces=ns_map):
kwargs['push_message_bindings'].append(message_binding.text)
return PushMethod(**kwargs)
@staticmethod
def from_dict(d):
return PushMethod(**d)
class PollingServiceInstance(TAXIIBase10):
"""
The Polling Service Instance component of a TAXII Feed
Information component.
Args:
poll_protocol (str): the protocol binding supported by
this Poll Service instance. **Required**
poll_address (str): the address of the TAXII Daemon
hosting this Poll Service instance. **Required**
poll_message_bindings (list of str): the message bindings
supported by this Poll Service instance. **Required**
"""
NAME = 'Polling_Service'
def __init__(self, poll_protocol, poll_address, poll_message_bindings):
self.poll_protocol = poll_protocol
self.poll_address = poll_address
self.poll_message_bindings = poll_message_bindings
@property
def sort_key(self):
return self.poll_address
@property
def poll_protocol(self):
return self._poll_protocol
@poll_protocol.setter
def poll_protocol(self, value):
do_check(value, 'poll_protocol', regex_tuple=uri_regex)
self._poll_protocol = value
@property
def poll_message_bindings(self):
return self._poll_message_bindings
@poll_message_bindings.setter
def poll_message_bindings(self, value):
do_check(value, 'poll_message_bindings', regex_tuple=uri_regex)
self._poll_message_bindings = value
def to_etree(self):
x = etree.Element('{%s}Polling_Service' % ns_map['taxii'])
proto_bind = etree.SubElement(x, '{%s}Protocol_Binding' % ns_map['taxii'])
proto_bind.text = self.poll_protocol
address = etree.SubElement(x, '{%s}Address' % ns_map['taxii'])
address.text = self.poll_address
for binding in self.poll_message_bindings:
b = etree.SubElement(x, '{%s}Message_Binding' % ns_map['taxii'])
b.text = binding
return x
def to_dict(self):
d = {}
d['poll_protocol'] = self.poll_protocol
d['poll_address'] = self.poll_address
d['poll_message_bindings'] = []
for binding in self.poll_message_bindings:
d['poll_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Poll Service Instance ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.poll_protocol
s += line_prepend + " Address: %s\n" % self.poll_address
for mb in self.poll_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
return s
@classmethod
def from_etree(cls, etree_xml):
protocol = get_required(etree_xml, './taxii:Protocol_Binding', ns_map).text
addr = get_required(etree_xml, './taxii:Address', ns_map).text
bindings = []
for message_binding in etree_xml.xpath('./taxii:Message_Binding', namespaces=ns_map):
bindings.append(message_binding.text)
return cls(protocol, addr, bindings)
@classmethod
def from_dict(cls, d):
return cls(**d)
class SubscriptionMethod(TAXIIBase10):
"""
The Subscription Method component of a TAXII Feed Information
component.
Args:
subscription_protocol (str): the protocol binding supported by
this Feed Management Service instance. **Required**
subscription_address (str): the address of the TAXII Daemon
hosting this Feed Management Service instance.
**Required**.
subscription_message_bindings (list of str): the message
bindings supported by this Feed Management Service
Instance. **Required**
"""
NAME = 'Subscription_Service'
def __init__(self, subscription_protocol, subscription_address,
subscription_message_bindings):
self.subscription_protocol = subscription_protocol
self.subscription_address = subscription_address
self.subscription_message_bindings = subscription_message_bindings
@property
def sort_key(self):
return self.subscription_address
@property
def subscription_protocol(self):
return self._subscription_protocol
@subscription_protocol.setter
def subscription_protocol(self, value):
do_check(value, 'subscription_protocol', regex_tuple=uri_regex)
self._subscription_protocol = value
@property
def subscription_message_bindings(self):
return self._subscription_message_bindings
@subscription_message_bindings.setter
def subscription_message_bindings(self, value):
do_check(value, 'subscription_message_bindings', regex_tuple=uri_regex)
self._subscription_message_bindings = value
def to_etree(self):
x = etree.Element('{%s}%s' % (ns_map['taxii'], self.NAME))
proto_bind = etree.SubElement(x, '{%s}Protocol_Binding' % ns_map['taxii'])
proto_bind.text = self.subscription_protocol
address = etree.SubElement(x, '{%s}Address' % ns_map['taxii'])
address.text = self.subscription_address
for binding in self.subscription_message_bindings:
b = etree.SubElement(x, '{%s}Message_Binding' % ns_map['taxii'])
b.text = binding
return x
def to_dict(self):
d = {}
d['subscription_protocol'] = self.subscription_protocol
d['subscription_address'] = self.subscription_address
d['subscription_message_bindings'] = []
for binding in self.subscription_message_bindings:
d['subscription_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Subscription Method ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.subscription_protocol
s += line_prepend + " Address: %s\n" % self.subscription_address
for mb in self.subscription_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
return s
@classmethod
def from_etree(cls, etree_xml):
protocol = get_required(etree_xml, './taxii:Protocol_Binding', ns_map).text
addr = get_required(etree_xml, './taxii:Address', ns_map).text
bindings = []
for message_binding in etree_xml.xpath('./taxii:Message_Binding', namespaces=ns_map):
bindings.append(message_binding.text)
return cls(protocol, addr, bindings)
@classmethod
def from_dict(cls, d):
return cls(**d)
class PollRequest(TAXIIMessage):
"""
A TAXII Poll Request message.
Arguments:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
feed_name (str): the name of the TAXII Data Feed that is being
polled. **Required**
exclusive_begin_timestamp_label (datetime): a Timestamp Label
indicating the beginning of the range of TAXII Data Feed content the
requester wishes to receive. **Optional**
inclusive_end_timestamp_label (datetime): a Timestamp Label
indicating the end of the range of TAXII Data Feed content the
requester wishes to receive. **Optional**
subscription_id (str): the existing subscription the Consumer
wishes to poll. **Optional**
content_bindings (list of str): the type of content that is
requested in the response to this poll. **Optional**, defaults to
accepting all content bindings.
"""
message_type = MSG_POLL_REQUEST
def __init__(self, message_id, extended_headers=None,
feed_name=None, exclusive_begin_timestamp_label=None,
inclusive_end_timestamp_label=None, subscription_id=None,
content_bindings=None):
super(PollRequest, self).__init__(message_id, extended_headers=extended_headers)
self.feed_name = feed_name
self.exclusive_begin_timestamp_label = exclusive_begin_timestamp_label
self.inclusive_end_timestamp_label = inclusive_end_timestamp_label
self.subscription_id = subscription_id
self.content_bindings = content_bindings or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value:
raise ValueError('in_response_to must be None')
self._in_response_to = value
@property
def feed_name(self):
return self._feed_name
@feed_name.setter
def feed_name(self, value):
do_check(value, 'feed_name', regex_tuple=uri_regex)
self._feed_name = value
@property
def exclusive_begin_timestamp_label(self):
return self._exclusive_begin_timestamp_label
@exclusive_begin_timestamp_label.setter
def exclusive_begin_timestamp_label(self, value):
value = check_timestamp_label(value, 'exclusive_begin_timestamp_label', can_be_none=True)
self._exclusive_begin_timestamp_label = value
@property
def inclusive_end_timestamp_label(self):
return self._inclusive_end_timestamp_label
@inclusive_end_timestamp_label.setter
def inclusive_end_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_end_timestamp_label', can_be_none=True)
self._inclusive_end_timestamp_label = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex, can_be_none=True)
self._subscription_id = value
@property
def content_bindings(self):
return self._content_bindings
@content_bindings.setter
def content_bindings(self, value):
do_check(value, 'content_bindings', regex_tuple=uri_regex)
self._content_bindings = value
def to_etree(self):
xml = super(PollRequest, self).to_etree()
xml.attrib['feed_name'] = self.feed_name
if self.subscription_id is not None:
xml.attrib['subscription_id'] = self.subscription_id
if self.exclusive_begin_timestamp_label:
ebt = etree.SubElement(xml, '{%s}Exclusive_Begin_Timestamp' % ns_map['taxii'])
# TODO: Add TZ Info
ebt.text = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label:
iet = etree.SubElement(xml, '{%s}Inclusive_End_Timestamp' % ns_map['taxii'])
# TODO: Add TZ Info
iet.text = self.inclusive_end_timestamp_label.isoformat()
for binding in self.content_bindings:
b = etree.SubElement(xml, '{%s}Content_Binding' % ns_map['taxii'])
b.text = binding
return xml
def to_dict(self):
d = super(PollRequest, self).to_dict()
d['feed_name'] = self.feed_name
if self.subscription_id is not None:
d['subscription_id'] = self.subscription_id
if self.exclusive_begin_timestamp_label: # TODO: Add TZ Info
d['exclusive_begin_timestamp_label'] = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label: # TODO: Add TZ Info
d['inclusive_end_timestamp_label'] = self.inclusive_end_timestamp_label.isoformat()
d['content_bindings'] = []
for bind in self.content_bindings:
d['content_bindings'].append(bind)
return d
def to_text(self, line_prepend=''):
s = super(PollRequest, self).to_text(line_prepend)
s += line_prepend + " Feed Name: %s\n" % self.feed_name
if self.subscription_id:
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
if self.exclusive_begin_timestamp_label:
s += line_prepend + " Excl. Begin Timestamp Label: %s\n" % self.exclusive_begin_timestamp_label.isoformat()
else:
s += line_prepend + " Excl. Begin Timestamp Label: %s\n" % None
if self.inclusive_end_timestamp_label:
s += line_prepend + " Incl. End Timestamp Label: %s\n" % self.inclusive_end_timestamp_label.isoformat()
else:
s += line_prepend + " Incl. End Timestamp Label: %s\n" % None
if len(self.content_bindings) == 0:
s += line_prepend + " Content Binding: Any Content\n"
for cb in self.content_bindings:
s += line_prepend + " Content Binding: %s\n" % cb
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['feed_name'] = get_required(etree_xml, './@feed_name', ns_map)
kwargs['subscription_id'] = get_optional(etree_xml, './@subscription_id', ns_map)
ebt_text = get_optional_text(etree_xml, './taxii:Exclusive_Begin_Timestamp', ns_map)
if ebt_text:
kwargs['exclusive_begin_timestamp_label'] = parse_datetime_string(ebt_text)
iet_text = get_optional_text(etree_xml, './taxii:Inclusive_End_Timestamp', ns_map)
if iet_text:
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(iet_text)
kwargs['content_bindings'] = []
for binding in etree_xml.xpath('./taxii:Content_Binding', namespaces=ns_map):
kwargs['content_bindings'].append(binding.text)
msg = super(PollRequest, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['feed_name'] = d['feed_name']
kwargs['subscription_id'] = d.get('subscription_id')
kwargs['exclusive_begin_timestamp_label'] = None
if d.get('exclusive_begin_timestamp_label'):
kwargs['exclusive_begin_timestamp_label'] = parse_datetime_string(d['exclusive_begin_timestamp_label'])
kwargs['inclusive_end_timestamp_label'] = None
if d.get('inclusive_end_timestamp_label'):
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(d['inclusive_end_timestamp_label'])
kwargs['content_bindings'] = d.get('content_bindings', [])
msg = super(PollRequest, cls).from_dict(d, **kwargs)
return msg
class PollResponse(TAXIIMessage):
"""
A TAXII Poll Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
feed_name (str): the name of the TAXII Data Feed that was polled.
**Required**
inclusive_begin_timestamp_label (datetime): a Timestamp Label
indicating the beginning of the range this response covers.
**Optional**
inclusive_end_timestamp_label (datetime): a Timestamp Label
indicating the end of the range this response covers. **Required**
subscription_id (str): the Subscription ID for which this content
is being provided. **Optional**
message (str): additional information for the message recipient.
**Optional**
content_blocks (list of ContentBlock): piece of content
and additional information related to the content. **Optional**
"""
message_type = MSG_POLL_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None,
feed_name=None, inclusive_begin_timestamp_label=None,
inclusive_end_timestamp_label=None, subscription_id=None,
message=None, content_blocks=None):
super(PollResponse, self).__init__(message_id, in_response_to, extended_headers)
self.feed_name = feed_name
self.inclusive_end_timestamp_label = inclusive_end_timestamp_label
self.inclusive_begin_timestamp_label = inclusive_begin_timestamp_label
self.subscription_id = subscription_id
self.message = message
self.content_blocks = content_blocks or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def feed_name(self):
return self._feed_name
@feed_name.setter
def feed_name(self, value):
do_check(value, 'feed_name', regex_tuple=uri_regex)
self._feed_name = value
@property
def inclusive_end_timestamp_label(self):
return self._inclusive_end_timestamp_label
@inclusive_end_timestamp_label.setter
def inclusive_end_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_end_timestamp_label')
self._inclusive_end_timestamp_label = value
@property
def inclusive_begin_timestamp_label(self):
return self._inclusive_begin_timestamp_label
@inclusive_begin_timestamp_label.setter
def inclusive_begin_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_begin_timestamp_label', can_be_none=True)
self._inclusive_begin_timestamp_label = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex, can_be_none=True)
self._subscription_id = value
@property
def content_blocks(self):
return self._content_blocks
@content_blocks.setter
def content_blocks(self, value):
do_check(value, 'content_blocks', type=ContentBlock)
self._content_blocks = value
def to_etree(self):
xml = super(PollResponse, self).to_etree()
xml.attrib['feed_name'] = self.feed_name
if self.subscription_id is not None:
xml.attrib['subscription_id'] = self.subscription_id
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii'])
m.text = self.message
if self.inclusive_begin_timestamp_label:
ibt = etree.SubElement(xml, '{%s}Inclusive_Begin_Timestamp' % ns_map['taxii'])
ibt.text = self.inclusive_begin_timestamp_label.isoformat()
iet = etree.SubElement(xml, '{%s}Inclusive_End_Timestamp' % ns_map['taxii'])
iet.text = self.inclusive_end_timestamp_label.isoformat()
for block in self.content_blocks:
xml.append(block.to_etree())
return xml
def to_dict(self):
d = super(PollResponse, self).to_dict()
d['feed_name'] = self.feed_name
if self.subscription_id is not None:
d['subscription_id'] = self.subscription_id
if self.message is not None:
d['message'] = self.message
if self.inclusive_begin_timestamp_label:
d['inclusive_begin_timestamp_label'] = self.inclusive_begin_timestamp_label.isoformat()
d['inclusive_end_timestamp_label'] = self.inclusive_end_timestamp_label.isoformat()
d['content_blocks'] = []
for block in self.content_blocks:
d['content_blocks'].append(block.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(PollResponse, self).to_text(line_prepend)
s += line_prepend + " Feed Name: %s\n" % self.feed_name
if self.subscription_id:
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
s += line_prepend + " Message: %s\n" % self.message
if self.inclusive_begin_timestamp_label:
s += line_prepend + " Incl. Begin Timestamp Label: %s\n" % self.inclusive_begin_timestamp_label.isoformat()
else:
s += line_prepend + " Incl. Begin Timestamp Label: %s\n" % None
s += line_prepend + " Incl. End Timestamp Label: %s\n" % self.inclusive_end_timestamp_label.isoformat()
for cb in self.content_blocks:
s += cb.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['feed_name'] = get_required(etree_xml, './@feed_name', ns_map)
kwargs['subscription_id'] = get_optional(etree_xml, './@subscription_id', ns_map)
kwargs['message'] = get_optional_text(etree_xml, './taxii:Message', ns_map)
ibts_text = get_optional_text(etree_xml, './taxii:Inclusive_Begin_Timestamp', ns_map)
if ibts_text:
kwargs['inclusive_begin_timestamp_label'] = parse_datetime_string(ibts_text)
iets_text = get_required(etree_xml, './taxii:Inclusive_End_Timestamp', ns_map).text
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(iets_text)
kwargs['content_blocks'] = []
blocks = etree_xml.xpath('./taxii:Content_Block', namespaces=ns_map)
for block in blocks:
kwargs['content_blocks'].append(ContentBlock.from_etree(block))
msg = super(PollResponse, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['feed_name'] = d['feed_name']
kwargs['message'] = d.get('message')
kwargs['subscription_id'] = d.get('subscription_id')
kwargs['inclusive_begin_timestamp_label'] = None
if d.get('inclusive_begin_timestamp_label'):
kwargs['inclusive_begin_timestamp_label'] = parse_datetime_string(d['inclusive_begin_timestamp_label'])
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(d['inclusive_end_timestamp_label'])
kwargs['content_blocks'] = []
for block in d['content_blocks']:
kwargs['content_blocks'].append(ContentBlock.from_dict(block))
msg = super(PollResponse, cls).from_dict(d, **kwargs)
return msg
class StatusMessage(TAXIIMessage):
"""
A TAXII Status message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
status_type (str): One of the defined Status Types or a third-party-
defined Status Type. **Required**
status_detail (str): A field for additional information about
this status in a machine-readable format. **Optional or Prohibited**
depending on ``status_type``. See TAXII Specification for details.
message (str): Additional information for the status. There is no
expectation that this field be interpretable by a machine; it is
instead targeted to a human operator. **Optional**
"""
message_type = MSG_STATUS_MESSAGE
def __init__(self, message_id, in_response_to, extended_headers=None,
status_type=None, status_detail=None, message=None):
super(StatusMessage, self).__init__(message_id, in_response_to, extended_headers=extended_headers)
self.status_type = status_type
self.status_detail = status_detail
self.message = message
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def status_type(self):
return self._status_type
@status_type.setter
def status_type(self, value):
do_check(value, 'status_type')
self._status_type = value
# TODO: is it possible to check the status detail?
def to_etree(self):
xml = super(StatusMessage, self).to_etree()
xml.attrib['status_type'] = self.status_type
if self.status_detail is not None:
sd = etree.SubElement(xml, '{%s}Status_Detail' % ns_map['taxii'])
sd.text = self.status_detail
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii'])
m.text = self.message
return xml
def to_dict(self):
d = super(StatusMessage, self).to_dict()
d['status_type'] = self.status_type
if self.status_detail is not None:
d['status_detail'] = self.status_detail
if self.message is not None:
d['message'] = self.message
return d
def to_text(self, line_prepend=''):
s = super(StatusMessage, self).to_text(line_prepend)
s += line_prepend + " Status Type: %s\n" % self.status_type
if self.status_detail:
s += line_prepend + " Status Detail: %s\n" % self.status_detail
s += line_prepend + " Status Message: %s\n" % self.message
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = dict(
status_type=etree_xml.attrib['status_type'],
status_detail=get_optional_text(etree_xml, './taxii:Status_Detail', ns_map),
message=get_optional_text(etree_xml, './taxii:Message', ns_map),
)
msg = super(StatusMessage, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = dict(
status_type=d['status_type'],
status_detail=d.get('status_detail'),
message=d.get('message')
)
msg = super(StatusMessage, cls).from_dict(d, **kwargs)
return msg
class InboxMessage(TAXIIMessage):
"""
A TAXII Inbox message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
message (str): prose information for the message recipient. **Optional**
subscription_information (libtaxii.messages_10.SubscriptionInformation): This
field is only present if this message is being sent to provide
content in accordance with an existing TAXII Data Feed
subscription. **Optional**
content_blocks (list of ContentBlock): Inbox content. **Optional**
"""
message_type = MSG_INBOX_MESSAGE
def __init__(self, message_id, in_response_to=None, extended_headers=None,
message=None, subscription_information=None,
content_blocks=None):
super(InboxMessage, self).__init__(message_id, extended_headers=extended_headers)
self.subscription_information = subscription_information
self.message = message
self.content_blocks = content_blocks or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value:
raise ValueError('in_response_to must be None')
self._in_response_to = value
@property
def subscription_information(self):
return self._subscription_information
@subscription_information.setter
def subscription_information(self, value):
do_check(value, 'subscription_information', type=SubscriptionInformation, can_be_none=True)
self._subscription_information = value
@property
def content_blocks(self):
return self._content_blocks
@content_blocks.setter
def content_blocks(self, value):
do_check(value, 'content_blocks', type=ContentBlock)
self._content_blocks = value
def to_etree(self):
xml = super(InboxMessage, self).to_etree()
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii'])
m.text = self.message
if self.subscription_information:
xml.append(self.subscription_information.to_etree())
for block in self.content_blocks:
xml.append(block.to_etree())
return xml
def to_dict(self):
d = super(InboxMessage, self).to_dict()
if self.message is not None:
d['message'] = self.message
if self.subscription_information:
d['subscription_information'] = self.subscription_information.to_dict()
d['content_blocks'] = []
for block in self.content_blocks:
d['content_blocks'].append(block.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(InboxMessage, self).to_text(line_prepend)
s += line_prepend + " Message: %s\n" % self.message
if self.subscription_information:
s += self.subscription_information.to_text(line_prepend + STD_INDENT)
s += line_prepend + " Message has %s Content Blocks\n" % len(self.content_blocks)
for cb in self.content_blocks:
s += cb.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
msg = super(InboxMessage, cls).from_etree(etree_xml)
msg.message = get_optional_text(etree_xml, './taxii:Message', ns_map)
subs_info = get_optional(etree_xml, './taxii:Source_Subscription', ns_map)
if subs_info is not None:
msg.subscription_information = SubscriptionInformation.from_etree(subs_info)
content_blocks = etree_xml.xpath('./taxii:Content_Block', namespaces=ns_map)
msg.content_blocks = []
for block in content_blocks:
msg.content_blocks.append(ContentBlock.from_etree(block))
return msg
@classmethod
def from_dict(cls, d):
msg = super(InboxMessage, cls).from_dict(d)
msg.message = d.get('message')
msg.subscription_information = None
if 'subscription_information' in d:
msg.subscription_information = SubscriptionInformation.from_dict(d['subscription_information'])
msg.content_blocks = []
for block in d['content_blocks']:
msg.content_blocks.append(ContentBlock.from_dict(block))
return msg
class SubscriptionInformation(TAXIIBase10):
"""
The Subscription Information component of a TAXII Inbox message.
Arguments:
feed_name (str): the name of the TAXII Data Feed from
which this content is being provided. **Required**
subscription_id (str): the Subscription ID for which this
content is being provided. **Required**
inclusive_begin_timestamp_label (datetime): a Timestamp Label
indicating the beginning of the time range this Inbox Message
covers. **Optional**
inclusive_end_timestamp_label (datetime): a Timestamp Label
indicating the end of the time range this Inbox Message covers.
**Optional**
"""
def __init__(self, feed_name, subscription_id,
inclusive_begin_timestamp_label,
inclusive_end_timestamp_label):
self.feed_name = feed_name
self.subscription_id = subscription_id
self.inclusive_begin_timestamp_label = inclusive_begin_timestamp_label
self.inclusive_end_timestamp_label = inclusive_end_timestamp_label
@property
def feed_name(self):
return self._feed_name
@feed_name.setter
def feed_name(self, value):
do_check(value, 'feed_name', regex_tuple=uri_regex)
self._feed_name = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex)
self._subscription_id = value
@property
def inclusive_begin_timestamp_label(self):
return self._inclusive_begin_timestamp_label
@inclusive_begin_timestamp_label.setter
def inclusive_begin_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_begin_timestamp_label')
self._inclusive_begin_timestamp_label = value
@property
def inclusive_end_timestamp_label(self):
return self._inclusive_end_timestamp_label
@inclusive_end_timestamp_label.setter
def inclusive_end_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_end_timestamp_label')
self._inclusive_end_timestamp_label = value
def to_etree(self):
xml = etree.Element('{%s}Source_Subscription' % ns_map['taxii'])
xml.attrib['feed_name'] = self.feed_name
xml.attrib['subscription_id'] = self.subscription_id
ibtl = etree.SubElement(xml, '{%s}Inclusive_Begin_Timestamp' % ns_map['taxii'])
ibtl.text = self.inclusive_begin_timestamp_label.isoformat()
ietl = etree.SubElement(xml, '{%s}Inclusive_End_Timestamp' % ns_map['taxii'])
ietl.text = self.inclusive_end_timestamp_label.isoformat()
return xml
def to_dict(self):
d = {}
d['feed_name'] = self.feed_name
d['subscription_id'] = self.subscription_id
d['inclusive_begin_timestamp_label'] = self.inclusive_begin_timestamp_label.isoformat()
d['inclusive_end_timestamp_label'] = self.inclusive_end_timestamp_label.isoformat()
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Subscription Information ===\n"
s += line_prepend + " Feed Name: %s\n" % self.feed_name
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
s += line_prepend + " Incl. Begin TS Label: %s\n" % self.inclusive_begin_timestamp_label.isoformat()
s += line_prepend + " Incl. End TS Label: %s\n" % self.inclusive_end_timestamp_label.isoformat()
return s
@staticmethod
def from_etree(etree_xml):
feed_name = etree_xml.attrib['feed_name']
subscription_id = etree_xml.attrib['subscription_id']
ibtl = parse_datetime_string(get_required(etree_xml, './taxii:Inclusive_Begin_Timestamp', ns_map).text)
ietl = parse_datetime_string(get_required(etree_xml, './taxii:Inclusive_End_Timestamp', ns_map).text)
return SubscriptionInformation(feed_name, subscription_id, ibtl, ietl)
@staticmethod
def from_dict(d):
feed_name = d['feed_name']
subscription_id = d['subscription_id']
ibtl = parse_datetime_string(d['inclusive_begin_timestamp_label'])
ietl = parse_datetime_string(d['inclusive_end_timestamp_label'])
return SubscriptionInformation(feed_name, subscription_id, ibtl, ietl)
class ManageFeedSubscriptionRequest(TAXIIMessage):
"""
A TAXII Manage Feed Subscription Request message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
feed_name (str): the name of the TAXII Data Feed to which the
action applies. **Required**
action (str): the requested action to take. **Required**
subscription_id (str): the ID of a previously created subscription.
**Required** if ``action==``:py:data:`ACT_UNSUBSCRIBE`, else
**Prohibited**.
delivery_parameters (list of DeliveryParameters): the delivery parameters
for this request. **Optional** Absence means delivery is not requested.
"""
message_type = MSG_MANAGE_FEED_SUBSCRIPTION_REQUEST
def __init__(self, message_id, extended_headers=None,
feed_name=None, action=None, subscription_id=None,
delivery_parameters=None):
super(ManageFeedSubscriptionRequest, self).__init__(message_id, extended_headers=extended_headers)
self.feed_name = feed_name
self.action = action
self.subscription_id = subscription_id
self.delivery_parameters = delivery_parameters
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value:
raise ValueError('in_response_to must be None')
self._in_response_to = value
@property
def feed_name(self):
return self._feed_name
@feed_name.setter
def feed_name(self, value):
do_check(value, 'feed_name', regex_tuple=uri_regex)
self._feed_name = value
@property
def action(self):
return self._action
@action.setter
def action(self, value):
do_check(value, 'action', value_tuple=ACT_TYPES)
self._action = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex, can_be_none=True)
self._subscription_id = value
@property
def delivery_parameters(self):
return self._delivery_parameters
@delivery_parameters.setter
def delivery_parameters(self, value):
do_check(value, 'delivery_parameters', type=DeliveryParameters, can_be_none=True)
self._delivery_parameters = value
def to_etree(self):
xml = super(ManageFeedSubscriptionRequest, self).to_etree()
xml.attrib['feed_name'] = self.feed_name
xml.attrib['action'] = self.action
if self.subscription_id is not None:
xml.attrib['subscription_id'] = self.subscription_id
if self.delivery_parameters:
xml.append(self.delivery_parameters.to_etree())
return xml
def to_dict(self):
d = super(ManageFeedSubscriptionRequest, self).to_dict()
d['feed_name'] = self.feed_name
d['action'] = self.action
d['subscription_id'] = self.subscription_id
d['delivery_parameters'] = None
if self.delivery_parameters:
d['delivery_parameters'] = self.delivery_parameters.to_dict()
return d
def to_text(self, line_prepend=''):
s = super(ManageFeedSubscriptionRequest, self).to_text(line_prepend)
s += line_prepend + " Feed Name: %s\n" % self.feed_name
s += line_prepend + " Action: %s\n" % self.action
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
if self.delivery_parameters:
s += self.delivery_parameters.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = dict(
feed_name=get_required(etree_xml, './@feed_name', ns_map),
action=get_required(etree_xml, './@action', ns_map),
# subscription_id is not required for action 'SUBSCRIBE'
subscription_id=get_optional(etree_xml, './@subscription_id', ns_map),
)
# marked as required in spec but as optional is XSD
delivery = get_optional(etree_xml, './taxii:Push_Parameters', ns_map)
if delivery is not None:
kwargs['delivery_parameters'] = DeliveryParameters.from_etree(delivery)
msg = super(ManageFeedSubscriptionRequest, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = dict(
feed_name=d['feed_name'],
action=d['action'],
subscription_id=d['subscription_id'],
delivery_parameters=DeliveryParameters.from_dict(d['delivery_parameters'])
)
msg = super(ManageFeedSubscriptionRequest, cls).from_dict(d, **kwargs)
return msg
class ManageFeedSubscriptionResponse(TAXIIMessage):
"""
A TAXII Manage Feed Subscription Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
feed_name (str): the name of the TAXII Data Feed to which
the action applies. **Required**
message (str): additional information for the message recipient.
**Optional**
subscription_instances (list of SubscriptionInstance): **Optional**
"""
message_type = MSG_MANAGE_FEED_SUBSCRIPTION_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None,
feed_name=None, message=None, subscription_instances=None):
super(ManageFeedSubscriptionResponse, self).__init__(message_id, in_response_to, extended_headers=extended_headers)
self.feed_name = feed_name
self.message = message
self.subscription_instances = subscription_instances or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def feed_name(self):
return self._feed_name
@feed_name.setter
def feed_name(self, value):
do_check(value, 'feed_name', regex_tuple=uri_regex)
self._feed_name = value
@property
def subscription_instances(self):
return self._subscription_instances
@subscription_instances.setter
def subscription_instances(self, value):
do_check(value, 'subscription_instances', type=SubscriptionInstance)
self._subscription_instances = value
def to_etree(self):
xml = super(ManageFeedSubscriptionResponse, self).to_etree()
xml.attrib['feed_name'] = self.feed_name
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii'])
m.text = self.message
for subscription_instance in self.subscription_instances:
xml.append(subscription_instance.to_etree())
return xml
def to_dict(self):
d = super(ManageFeedSubscriptionResponse, self).to_dict()
d['feed_name'] = self.feed_name
if self.message is not None:
d['message'] = self.message
d['subscription_instances'] = []
for subscription_instance in self.subscription_instances:
d['subscription_instances'].append(subscription_instance.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(ManageFeedSubscriptionResponse, self).to_text(line_prepend)
s += line_prepend + " Feed Name: %s\n" % self.feed_name
s += line_prepend + " Message: %s\n" % self.message
for si in self.subscription_instances:
s += si.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['feed_name'] = etree_xml.attrib['feed_name']
kwargs['message'] = get_optional_text(etree_xml, './taxii:Message', ns_map)
kwargs['subscription_instances'] = []
for si in etree_xml.xpath('./taxii:Subscription', namespaces=ns_map):
kwargs['subscription_instances'].append(SubscriptionInstance.from_etree(si))
msg = super(ManageFeedSubscriptionResponse, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['feed_name'] = d['feed_name']
kwargs['message'] = d.get('message')
kwargs['subscription_instances'] = []
for instance in d['subscription_instances']:
kwargs['subscription_instances'].append(SubscriptionInstance.from_dict(instance))
msg = super(ManageFeedSubscriptionResponse, cls).from_dict(d, **kwargs)
return msg
class SubscriptionInstance(TAXIIBase10):
"""
The Subscription Instance component of the Manage Feed Subscription
Response message.
Args:
subscription_id (str): the id of the subscription. **Required**
delivery_parameters (libtaxii.messages_10.DeliveryParameters): the parameters
for this subscription. **Required** if responding to message
with ``action==``:py:data:`ACT_STATUS`, otherwise **Prohibited**
poll_instances (list of PollInstance): Each Poll
Instance represents an instance of a Poll Service that can be
contacted to retrieve content associated with the new
Subscription. **Optional**
"""
def __init__(self, subscription_id, delivery_parameters=None,
poll_instances=None):
self.subscription_id = subscription_id
self.delivery_parameters = delivery_parameters
self.poll_instances = poll_instances or []
@property
def sort_key(self):
return self.subscription_id
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex)
self._subscription_id = value
@property
def delivery_parameters(self):
return self._delivery_parameters
@delivery_parameters.setter
def delivery_parameters(self, value):
do_check(value, 'delivery_parameters', type=DeliveryParameters, can_be_none=True)
self._delivery_parameters = value
@property
def poll_instances(self):
return self._poll_instances
@poll_instances.setter
def poll_instances(self, value):
do_check(value, 'poll_instances', type=PollInstance, can_be_none=False)
self._poll_instances = value
def to_etree(self):
xml = etree.Element('{%s}Subscription' % ns_map['taxii'])
xml.attrib['subscription_id'] = self.subscription_id
if self.delivery_parameters:
xml.append(self.delivery_parameters.to_etree())
for poll_instance in self.poll_instances:
xml.append(poll_instance.to_etree())
return xml
def to_dict(self):
d = {}
d['subscription_id'] = self.subscription_id
if self.delivery_parameters:
d['delivery_parameters'] = self.delivery_parameters.to_dict()
else:
d['delivery_parameters'] = None
d['poll_instances'] = []
for poll_instance in self.poll_instances:
d['poll_instances'].append(poll_instance.to_dict())
return d
def to_text(self, line_indent=''):
s = line_indent + "=== Subscription Instance ===\n"
s += line_indent + " Subscription ID: %s\n" % self.subscription_id
if self.delivery_parameters:
s += self.delivery_parameters.to_text(line_indent + STD_INDENT)
for pi in self.poll_instances:
s += pi.to_text(line_indent + STD_INDENT)
return s
@staticmethod
def from_etree(etree_xml):
subscription_id = etree_xml.attrib['subscription_id']
_delivery_parameters = get_optional(etree_xml, './taxii:Push_Parameters', ns_map)
if _delivery_parameters is not None:
delivery_parameters = DeliveryParameters.from_etree(_delivery_parameters)
else:
delivery_parameters = None
poll_instances = []
for poll_instance in etree_xml.xpath('./taxii:Poll_Instance', namespaces=ns_map):
poll_instances.append(PollInstance.from_etree(poll_instance))
return SubscriptionInstance(subscription_id, delivery_parameters, poll_instances)
@staticmethod
def from_dict(d):
subscription_id = d['subscription_id']
if d.get('delivery_parameters'):
delivery_parameters = DeliveryParameters.from_dict(d['delivery_parameters'])
else:
delivery_parameters = None
poll_instances = []
for poll_instance in d['poll_instances']:
poll_instances.append(PollInstance.from_dict(poll_instance))
return SubscriptionInstance(subscription_id, delivery_parameters, poll_instances)
class PollInstance(TAXIIBase10):
"""
The Poll Instance component of the Manage Feed Subscription
Response message.
Args:
poll_protocol (str): The protocol binding supported by this
instance of a Polling Service. **Required**
poll_address (str): the address of the TAXII Daemon hosting
this Poll Service. **Required**
poll_message_bindings (list of str): one or more message bindings
that can be used when interacting with this Poll Service
instance. **Required**
"""
def __init__(self, poll_protocol, poll_address, poll_message_bindings=None):
self.poll_protocol = poll_protocol
self.poll_address = poll_address
self._poll_message_bindings = poll_message_bindings or []
@property
def sort_key(self):
return self.poll_address
@property
def poll_protocol(self):
return self._poll_protocol
@poll_protocol.setter
def poll_protocol(self, value):
do_check(value, 'poll_protocol', regex_tuple=uri_regex)
self._poll_protocol = value
@property
def poll_message_bindings(self):
return self._poll_message_bindings
@poll_message_bindings.setter
def poll_message_bindings(self, value):
do_check(value, 'poll_message_bindings', regex_tuple=uri_regex)
self._poll_message_bindings = value
def to_etree(self):
xml = etree.Element('{%s}Poll_Instance' % ns_map['taxii'])
pb = etree.SubElement(xml, '{%s}Protocol_Binding' % ns_map['taxii'])
pb.text = self.poll_protocol
a = etree.SubElement(xml, '{%s}Address' % ns_map['taxii'])
a.text = self.poll_address
for binding in self.poll_message_bindings:
b = etree.SubElement(xml, '{%s}Message_Binding' % ns_map['taxii'])
b.text = binding
return xml
def to_dict(self):
d = {}
d['poll_protocol'] = self.poll_protocol
d['poll_address'] = self.poll_address
d['poll_message_bindings'] = []
for binding in self.poll_message_bindings:
d['poll_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Poll Instance ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.poll_protocol
s += line_prepend + " Address: %s\n" % self.poll_address
for mb in self.poll_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
return s
@staticmethod
def from_etree(etree_xml):
poll_protocol = get_required(etree_xml, './taxii:Protocol_Binding', ns_map).text
address = get_required(etree_xml, './taxii:Address', ns_map).text
poll_message_bindings = []
for b in etree_xml.xpath('./taxii:Message_Binding', namespaces=ns_map):
poll_message_bindings.append(b.text)
return PollInstance(poll_protocol, address, poll_message_bindings)
@staticmethod
def from_dict(d):
return PollInstance(**d)
########################################################
# EVERYTHING BELOW HERE IS FOR BACKWARDS COMPATIBILITY #
########################################################
# Add top-level classes as nested classes for backwards compatibility
DiscoveryResponse.ServiceInstance = ServiceInstance
FeedInformationResponse.FeedInformation = FeedInformation
FeedInformation.PushMethod = PushMethod
FeedInformation.PollingServiceInstance = PollingServiceInstance
FeedInformation.SubscriptionMethod = SubscriptionMethod
ManageFeedSubscriptionResponse.PollInstance = PollInstance
ManageFeedSubscriptionResponse.SubscriptionInstance = SubscriptionInstance
InboxMessage.SubscriptionInformation = SubscriptionInformation
# Constants not imported in `from constants import *`
MSG_TYPES = MSG_TYPES_10
ST_TYPES = ST_TYPES_10
ACT_TYPES = ACT_TYPES_10
SVC_TYPES = SVC_TYPES_10
from .common import (generate_message_id)
libtaxii-1.1.119/libtaxii/messages_11.py 0000664 0000000 0000000 00000452153 14036072565 0020002 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
"""
Creating, handling, and parsing TAXII 1.1 messages.
"""
import collections
import six
try:
import simplejson as json
except ImportError:
import json
import os
import warnings
from lxml import etree
from .common import (parse, parse_datetime_string, append_any_content_etree, TAXIIBase,
get_required, get_optional, get_optional_text, parse_xml_string,
stringify_content)
from .validation import do_check, uri_regex, check_timestamp_label
from .constants import *
def validate_xml(xml_string):
"""
Note that this function has been deprecated. Please see
libtaxii.validators.SchemaValidator.
Validate XML with the TAXII XML Schema 1.1.
Args:
xml_string (str): The XML to validate.
Example:
.. code-block:: python
is_valid = tm11.validate_xml(message.to_xml())
"""
warnings.warn('Call to deprecated function: libtaxii.messages_11.validate_xml()',
category=DeprecationWarning)
etree_xml = parse_xml_string(xml_string)
package_dir, package_filename = os.path.split(__file__)
schema_file = os.path.join(package_dir, "xsd", "TAXII_XMLMessageBinding_Schema_11.xsd")
taxii_schema_doc = parse(schema_file, allow_file=True)
xml_schema = etree.XMLSchema(taxii_schema_doc)
valid = xml_schema.validate(etree_xml)
# TODO: Additionally, validate the Query stuff
if not valid:
return xml_schema.error_log.last_error
return valid
def get_message_from_xml(xml_string, encoding='utf_8'):
"""Create a TAXIIMessage object from an XML string.
This function automatically detects which type of Message should be created
based on the XML.
Args:
xml_string (str): The XML to parse into a TAXII message.
encoding (str): The encoding of the string; defaults to UTF-8
Example:
.. code-block:: python
message_xml = message.to_xml()
new_message = tm11.get_message_from_xml(message_xml)
"""
if isinstance(xml_string, six.binary_type):
xml_string = xml_string.decode(encoding, 'replace')
etree_xml = parse_xml_string(xml_string)
qn = etree.QName(etree_xml)
if qn.namespace != ns_map['taxii_11']:
raise ValueError('Unsupported namespace: %s' % qn.namespace)
message_type = qn.localname
if message_type == MSG_DISCOVERY_REQUEST:
return DiscoveryRequest.from_etree(etree_xml)
if message_type == MSG_DISCOVERY_RESPONSE:
return DiscoveryResponse.from_etree(etree_xml)
if message_type == MSG_COLLECTION_INFORMATION_REQUEST:
return CollectionInformationRequest.from_etree(etree_xml)
if message_type == MSG_COLLECTION_INFORMATION_RESPONSE:
return CollectionInformationResponse.from_etree(etree_xml)
if message_type == MSG_POLL_REQUEST:
return PollRequest.from_etree(etree_xml)
if message_type == MSG_POLL_RESPONSE:
return PollResponse.from_etree(etree_xml)
if message_type == MSG_STATUS_MESSAGE:
return StatusMessage.from_etree(etree_xml)
if message_type == MSG_INBOX_MESSAGE:
return InboxMessage.from_etree(etree_xml)
if message_type == MSG_MANAGE_COLLECTION_SUBSCRIPTION_REQUEST:
return ManageCollectionSubscriptionRequest.from_etree(etree_xml)
if message_type == MSG_MANAGE_COLLECTION_SUBSCRIPTION_RESPONSE:
return ManageCollectionSubscriptionResponse.from_etree(etree_xml)
if message_type == MSG_POLL_FULFILLMENT_REQUEST:
return PollFulfillmentRequest.from_etree(etree_xml)
raise ValueError('Unknown message_type: %s' % message_type)
def get_message_from_dict(d):
"""Create a TAXIIMessage object from a dictonary.
This function automatically detects which type of Message should be created
based on the 'message_type' key in the dictionary.
Args:
d (dict): The dictionary to build the TAXII message from.
Example:
.. code-block:: python
message_dict = message.to_dict()
new_message = tm11.get_message_from_dict(message_dict)
"""
if 'message_type' not in d:
raise ValueError('message_type is a required field!')
message_type = d['message_type']
if message_type == MSG_DISCOVERY_REQUEST:
return DiscoveryRequest.from_dict(d)
if message_type == MSG_DISCOVERY_RESPONSE:
return DiscoveryResponse.from_dict(d)
if message_type == MSG_COLLECTION_INFORMATION_REQUEST:
return CollectionInformationRequest.from_dict(d)
if message_type == MSG_COLLECTION_INFORMATION_RESPONSE:
return CollectionInformationResponse.from_dict(d)
if message_type == MSG_POLL_REQUEST:
return PollRequest.from_dict(d)
if message_type == MSG_POLL_RESPONSE:
return PollResponse.from_dict(d)
if message_type == MSG_STATUS_MESSAGE:
return StatusMessage.from_dict(d)
if message_type == MSG_INBOX_MESSAGE:
return InboxMessage.from_dict(d)
if message_type == MSG_MANAGE_COLLECTION_SUBSCRIPTION_REQUEST:
return ManageCollectionSubscriptionRequest.from_dict(d)
if message_type == MSG_MANAGE_COLLECTION_SUBSCRIPTION_RESPONSE:
return ManageCollectionSubscriptionResponse.from_dict(d)
if message_type == MSG_POLL_FULFILLMENT_REQUEST:
return PollFulfillmentRequest.from_dict(d)
raise ValueError('Unknown message_type: %s' % message_type)
def get_message_from_json(json_string, encoding='utf_8'):
"""Create a TAXIIMessage object from a JSON string.
This function automatically detects which type of Message should be created
based on the JSON.
Args:
json_string (str): The JSON to parse into a TAXII message.
"""
decoded_string = json_string.decode(encoding, 'replace')
return get_message_from_dict(json.loads(decoded_string))
def _sanitize_content_binding(binding):
"""
Takes in one of:
1. ContentBinding object
2. string
3. dict
and returns a ContentBinding object.
This supports function calls where a string or ContentBinding can be
used to specify a content binding.
"""
if isinstance(binding, ContentBinding): # It's already good to go
return binding
elif isinstance(binding, six.string_types): # Convert it to a ContentBinding
return ContentBinding.from_string(binding)
elif isinstance(binding, dict): # Convert it to a ContentBinding
return ContentBinding.from_dict(binding)
else: # Don't know what to do with it.
raise ValueError('Type cannot be converted to ContentBinding: %s' % binding.__class__.__name__)
def _sanitize_content_bindings(binding_list):
bindings = []
for item in binding_list:
bindings.append(_sanitize_content_binding(item))
return bindings
class UnsupportedQueryException(Exception):
def __init__(self, value):
self.value = value
def __str__(self):
return repr(self.value)
# Start with the 'default' deserializer
query_deserializers = {}
def register_query_format(format_id, query, query_info, schema=None):
"""
This function registers a query format with libtaxii.messages_11.
Arguments:
format_id (string) - The format ID of the query
query (messages_11.Query subclass) - the Query object associated with the format_id
query_info (messages_11.SupportedQuery subclass) - the SupportedQuery object associated with the format_id
schema (xml schema) - The XML schema for validating the query
"""
query_deserializers[format_id] = {'query': query, 'query_info': query_info, 'schema': schema}
def get_deserializer(format_id, type):
do_check(type, 'type', value_tuple=('query', 'query_info'))
if format_id not in query_deserializers:
raise UnsupportedQueryException('A deserializer for the query format \'%s\' is not registered.' % format_id)
return query_deserializers[format_id][type]
# TODO: Consider using this
# def _create_element(name, namespace=ns_map['taxii_11'], value=None, attrs=None, parent=None):
# """
# Helper method for appending a new element to an existing element.
# Assumes the namespace is TAXII 1.1
# Arguments:
# name (string) - The name of the element
# namespace (string) - The namespace of the element
# value (string) - The text value of the element
# attrs (dict) - A dictionary of attributes
# parent (Element) - The parent element
# """
# if value is None and attrs is None:
# return
# if parent is None:
# elt = etree.Element('{%s}%s' % (namespace, name), nsmap=ns_map)
# else:
# elt = etree.SubElement(parent, '{%s}%s' % (namespace, name), nsmap=ns_map)
# if value is not None:
# elt.text = value
# if attrs is not None:
# for k, v in attrs.items():
# elt.attrib[k] = v
# return elt
class TAXIIBase11(TAXIIBase):
version = VID_TAXII_XML_11
class SupportedQuery(TAXIIBase11):
"""
This class contains an instance of a supported query. It
is expected that, generally, messages_11.SupportedQuery
subclasses will be used in place of this class
to represent a query
"""
def __init__(self, format_id):
"""
Arguments:
format_id (string) - The format_id of this supported query
"""
self.format_id = format_id
@property
def sort_key(self):
return self.format_id
@property
def format_id(self):
return self._format_id
@format_id.setter
def format_id(self, value):
do_check(value, 'format_id', regex_tuple=uri_regex)
self._format_id = value
def to_etree(self):
q = etree.Element('{%s}Supported_Query' % ns_map['taxii_11'], nsmap=ns_map)
q.attrib['format_id'] = self.format_id
return q
def to_dict(self):
return {'format_id': self.format_id}
def to_text(self, line_prepend=''):
s = line_prepend + "=== Supported Query Information ===\n"
s += line_prepend + " Query Format: %s\n" % self.format_id
return s
@staticmethod
def from_etree(etree_xml):
format_id = get_required(etree_xml, './@format_id', ns_map)
return SupportedQuery(format_id)
@staticmethod
def from_dict(d):
return SupportedQuery(**d)
class Query(TAXIIBase11):
"""This class contains an instance of a query.
It is expected that, generally, messages_11.Query subclasses will be used
in place of this class to represent a query.
"""
def __init__(self, format_id):
"""
Arguments:
format_id (string) - The format_id of this query
"""
self.format_id = format_id
@property
def format_id(self):
return self._format_id
@format_id.setter
def format_id(self, value):
do_check(value, 'format_id', regex_tuple=uri_regex)
self._format_id = value
def to_etree(self):
q = etree.Element('{%s}Query' % ns_map['taxii_11'], nsmap=ns_map)
q.attrib['format_id'] = self.format_id
return q
def to_dict(self):
return {'format_id': self.format_id}
def to_text(self, line_prepend=''):
s = line_prepend + "=== Query ===\n"
s += line_prepend + " Query Format: %s\n" % self.format_id
return s
@classmethod
def from_etree(cls, etree_xml, kwargs):
format_id = get_required(etree_xml, './@format_id', ns_map)
return cls(format_id, **kwargs)
@classmethod
def from_dict(cls, d, kwargs):
return cls(d, **kwargs)
# A value can be one of:
# - a dictionary, where each key is a content_binding_id and each value is a list of subtypes
# (This is the default representation)
# - a "content_binding_id[>subtype]" structure
# - a list of "content_binding_id[>subtype]" structures
class ContentBinding(TAXIIBase11):
"""TAXII Content Binding component
Args:
binding_id (str): The content binding ID. **Required**
subtype_ids (list of str): the subtype IDs. **Required**
"""
def __init__(self, binding_id, subtype_ids=None):
self.binding_id = binding_id
self.subtype_ids = subtype_ids or []
def __str__(self):
s = self.binding_id
if len(self.subtype_ids) > 0:
s += '>' + ','.join(self.subtype_ids)
return s
@staticmethod
def from_string(s):
if '>' not in s:
return ContentBinding(s)
parts = s.split('>')
binding_id = parts[0]
subtype_ids = parts[1].split(',')
return ContentBinding(binding_id, subtype_ids)
@property
def sort_key(self):
return str(self)
@property
def binding_id(self):
return self._binding_id
@binding_id.setter
def binding_id(self, value):
do_check(value, 'binding_id', regex_tuple=uri_regex)
self._binding_id = value
@property
def subtype_ids(self):
return self._subtype_ids
@subtype_ids.setter
def subtype_ids(self, value):
do_check(value, 'subtype_ids', regex_tuple=uri_regex)
self._subtype_ids = value
def to_etree(self):
cb = etree.Element('{%s}Content_Binding' % ns_map['taxii_11'], nsmap=ns_map)
cb.attrib['binding_id'] = self.binding_id
for subtype_id in self.subtype_ids:
s = etree.SubElement(cb, '{%s}Subtype' % ns_map['taxii_11'], nsmap=ns_map)
s.attrib['subtype_id'] = subtype_id
return cb
def to_dict(self):
return {'binding_id': self.binding_id, 'subtype_ids': self.subtype_ids}
def to_text(self, line_prepend=''):
return line_prepend + str(self)
def __hash__(self):
return hash(str(self.to_dict()))
@classmethod
def from_etree(self, etree_xml):
binding_id = etree_xml.attrib['binding_id']
subtype_ids = []
subtype_elts = etree_xml.xpath('./taxii_11:Subtype', namespaces=ns_map)
for elt in subtype_elts:
subtype_ids.append(elt.attrib['subtype_id'])
return ContentBinding(binding_id, subtype_ids)
@classmethod
def from_dict(self, d):
return ContentBinding(**d)
class RecordCount(TAXIIBase11):
"""
Information summarizing the number of records.
Args:
record_count (int): The number of records
partial_count (bool): Whether the number of records is a partial count
"""
def __init__(self, record_count, partial_count=False):
self.record_count = record_count
self.partial_count = partial_count
@property
def record_count(self):
return self._record_count
@record_count.setter
def record_count(self, value):
do_check(value, 'record_count', type=int)
self._record_count = value
@property
def partial_count(self):
return self._partial_count
@partial_count.setter
def partial_count(self, value):
do_check(value, 'partial_count', value_tuple=(True, False), can_be_none=True)
self._partial_count = value
def to_etree(self):
xml = etree.Element('{%s}Record_Count' % ns_map['taxii_11'], nsmap=ns_map)
xml.text = str(self.record_count)
if self.partial_count is not None:
xml.attrib['partial_count'] = str(self.partial_count).lower()
return xml
def to_dict(self):
d = {}
d['record_count'] = self.record_count
if self.partial_count is not None:
d['partial_count'] = self.partial_count
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Record Count ===\n"
s += line_prepend + " Record Count: %s\n" % self.record_count
if self.partial_count:
s += line_prepend + " Partial Count: %s\n" % self.partial_count
return s
@staticmethod
def from_etree(etree_xml):
record_count = int(etree_xml.text)
partial_count = etree_xml.attrib.get('partial_count', 'false') == 'true'
return RecordCount(record_count, partial_count)
@staticmethod
def from_dict(d):
return RecordCount(**d)
class _GenericParameters(TAXIIBase11):
name = 'Generic_Parameters'
def __init__(self, response_type=RT_FULL, content_bindings=None, query=None):
self.response_type = response_type
self.content_bindings = content_bindings or []
self.query = query
@property
def response_type(self):
return self._response_type
@response_type.setter
def response_type(self, value):
do_check(value, 'response_type', value_tuple=(RT_FULL, RT_COUNT_ONLY), can_be_none=True)
self._response_type = value
@property
def content_bindings(self):
return self._content_bindings
@content_bindings.setter
def content_bindings(self, value):
value = _sanitize_content_bindings(value)
do_check(value, 'content_bindings', type=ContentBinding)
self._content_bindings = value
@property
def query(self):
return self._query
@query.setter
def query(self, value):
# TODO: Can i do more validation?
do_check(value, 'query', type=Query, can_be_none=True)
self._query = value
def to_etree(self):
xml = etree.Element('{%s}%s' % (ns_map['taxii_11'], self.name), nsmap=ns_map)
if self.response_type is not None:
rt = etree.SubElement(xml, '{%s}Response_Type' % ns_map['taxii_11'], nsmap=ns_map)
rt.text = self.response_type
for binding in self.content_bindings:
xml.append(binding.to_etree())
if self.query is not None:
xml.append(self.query.to_etree())
return xml
def to_dict(self):
d = {}
if self.response_type is not None:
d['response_type'] = self.response_type
d['content_bindings'] = []
for binding in self.content_bindings:
d['content_bindings'].append(binding.to_dict())
d['query'] = None
if self.query is not None:
d['query'] = self.query.to_dict()
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== %s ===\n" % self.name
for binding in self.content_bindings:
s += " Content Binding: %s\n" % str(binding)
if self.query:
s += self.query.to_text(line_prepend + STD_INDENT)
if self.response_type:
s += line_prepend + " Response type: %s\n" % str(self.response_type)
return s
@classmethod
def from_etree(cls, etree_xml, **kwargs):
response_type = get_optional_text(etree_xml, './taxii_11:Response_Type', ns_map)
if response_type is None:
response_type = RT_FULL
content_bindings = []
for binding in etree_xml.xpath('./taxii_11:Content_Binding', namespaces=ns_map):
content_bindings.append(ContentBinding.from_etree(binding))
query = None
query_el = get_optional(etree_xml, './taxii_11:Query', ns_map)
if query_el is not None:
format_id = query_el.attrib['format_id']
query = get_deserializer(format_id, 'query').from_etree(query_el)
return cls(response_type, content_bindings, query, **kwargs)
@classmethod
def from_dict(cls, d, **kwargs):
response_type = d.get('response_type', RT_FULL)
content_bindings = []
for binding in d['content_bindings']:
content_bindings.append(ContentBinding.from_dict(binding))
query = None
if 'query' in d and d['query'] is not None:
format_id = d['query']['format_id']
query = get_deserializer(format_id, 'query').from_dict(d['query'])
return cls(response_type, content_bindings, query, **kwargs)
class SubscriptionParameters(_GenericParameters):
"""
TAXII Subscription Parameters.
Args:
response_type (str): The requested response type. Must be either
:py:data:`RT_FULL` or :py:data:`RT_COUNT_ONLY`. **Optional**,
defaults to :py:data:`RT_FULL`
content_bindings (list of ContentBinding objects): A list of Content
Bindings acceptable in response. **Optional**
query (Query): The query for this poll parameters. **Optional**
"""
name = 'Subscription_Parameters'
class ContentBlock(TAXIIBase11):
"""A TAXII Content Block.
Args:
content_binding (ContentBinding): a Content Binding ID or nesting expression
indicating the type of content contained in the Content field of this
Content Block. **Required**
content (string or etree): a piece of content of the type specified
by the Content Binding. **Required**
timestamp_label (datetime): the Timestamp Label associated with this
Content Block. **Optional**
padding (string): an arbitrary amount of padding for this Content
Block. **Optional**
message (string): a message associated with this ContentBlock. **Optional**
"""
NAME = 'Content_Block'
def __init__(self, content_binding, content, timestamp_label=None,
padding=None, message=None):
self.content_binding = content_binding
self.content = content
self.timestamp_label = timestamp_label
self.message = message
self.padding = padding
@property
def sort_key(self):
return self.content[:25]
@property
def content_binding(self):
return self._content_binding
@content_binding.setter
def content_binding(self, value):
value = _sanitize_content_binding(value)
do_check(value, 'content_binding', type=ContentBinding)
self._content_binding = value
@property
def content(self):
if self.content_is_xml:
return etree.tostring(self._content, encoding='utf-8')
else:
return self._content
@content.setter
def content(self, value):
do_check(value, 'content') # Just check for not None
self._content, self.content_is_xml = stringify_content(value)
@property
def content_is_xml(self):
return self._content_is_xml
@content_is_xml.setter
def content_is_xml(self, value):
do_check(value, 'content_is_xml', value_tuple=(True, False))
self._content_is_xml = value
@property
def timestamp_label(self):
return self._timestamp_label
@timestamp_label.setter
def timestamp_label(self, value):
value = check_timestamp_label(value, 'timestamp_label', can_be_none=True)
self._timestamp_label = value
@property
def message(self):
return self._message
@message.setter
def message(self, value):
do_check(value, 'message', type=six.string_types, can_be_none=True)
self._message = value
def to_etree(self):
block = etree.Element('{%s}Content_Block' % ns_map['taxii_11'], nsmap=ns_map)
block.append(self.content_binding.to_etree())
c = etree.SubElement(block, '{%s}Content' % ns_map['taxii_11'])
if self.content_is_xml:
c.append(self._content)
else:
c.text = self._content
if self.timestamp_label is not None:
tl = etree.SubElement(block, '{%s}Timestamp_Label' % ns_map['taxii_11'])
tl.text = self.timestamp_label.isoformat()
if self.message is not None:
m = etree.SubElement(block, '{%s}Message' % ns_map['taxii_11'])
m.text = self.message
if self.padding is not None:
p = etree.SubElement(block, '{%s}Padding' % ns_map['taxii_11'])
p.text = self.padding
return block
def to_dict(self):
block = {}
block['content_binding'] = self.content_binding.to_dict()
if self.content_is_xml:
block['content'] = etree.tostring(self._content, encoding='utf-8')
else:
block['content'] = self._content
block['content_is_xml'] = self.content_is_xml
if self.timestamp_label is not None:
block['timestamp_label'] = self.timestamp_label.isoformat()
if self.message is not None:
block['message'] = self.message
if self.padding is not None:
block['padding'] = self.padding
return block
def to_text(self, line_prepend=''):
s = line_prepend + "=== Content Block ===\n"
s += line_prepend + " Content Binding: %s\n" % str(self.content_binding)
s += line_prepend + " Content length: %s\n" % len(self.content)
s += line_prepend + " (Content not printed for brevity)\n"
if self.timestamp_label:
s += line_prepend + " Timestamp Label: %s\n" % self.timestamp_label
s += line_prepend + " Message: %s\n" % self.message
s += line_prepend + " Padding: %s\n" % self.padding
return s
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['content_binding'] = ContentBinding.from_etree(
get_required(etree_xml, './taxii_11:Content_Binding', ns_map))
kwargs['padding'] = get_optional_text(etree_xml, './taxii_11:Padding', ns_map)
ts_text = get_optional_text(etree_xml, './taxii_11:Timestamp_Label', ns_map)
if ts_text:
kwargs['timestamp_label'] = parse_datetime_string(ts_text)
kwargs['message'] = get_optional_text(etree_xml, './taxii_11:Message', ns_map)
content = get_required(etree_xml, './taxii_11:Content', ns_map)
if len(content) == 0: # This has string content
kwargs['content'] = content.text
else: # This has XML content
kwargs['content'] = content[0]
return ContentBlock(**kwargs)
@staticmethod
def from_dict(d):
kwargs = {}
kwargs['content_binding'] = ContentBinding.from_dict(d['content_binding'])
kwargs['padding'] = d.get('padding')
if 'timestamp_label' in d:
kwargs['timestamp_label'] = parse_datetime_string(d['timestamp_label'])
kwargs['message'] = d.get('message')
is_xml = d.get('content_is_xml', False)
if is_xml:
kwargs['content'] = parse(d['content'], allow_file=False)
else:
kwargs['content'] = d['content']
cb = ContentBlock(**kwargs)
return cb
@classmethod
def from_json(cls, json_string):
return cls.from_dict(json.loads(json_string))
class PushParameters(TAXIIBase11):
"""Set up Push Parameters.
Args:
inbox_protocol (str): identifies the protocol to be used when pushing
TAXII Data Collection content to a Consumer's TAXII Inbox Service
implementation. **Required**
inbox_address (str): identifies the address of the TAXII Daemon hosting
the Inbox Service to which the Consumer requests content for this
TAXII Data Collection to be delivered. **Required**
delivery_message_binding (str): identifies the message binding to be
used to send pushed content for this subscription. **Required**
"""
name = 'Push_Parameters'
def __init__(self, inbox_protocol, inbox_address, delivery_message_binding):
self.inbox_protocol = inbox_protocol
self.inbox_address = inbox_address
self.delivery_message_binding = delivery_message_binding
@property
def sort_key(self):
return self.inbox_address
@property
def inbox_protocol(self):
return self._inbox_protocol
@inbox_protocol.setter
def inbox_protocol(self, value):
do_check(value, 'inbox_protocol', regex_tuple=uri_regex)
self._inbox_protocol = value
@property
def inbox_address(self):
return self._inbox_address
@inbox_address.setter
def inbox_address(self, value):
self._inbox_address = value
@property
def delivery_message_binding(self):
return self._delivery_message_binding
@delivery_message_binding.setter
def delivery_message_binding(self, value):
do_check(value, 'delivery_message_binding', regex_tuple=uri_regex)
self._delivery_message_binding = value
def to_etree(self):
xml = etree.Element('{%s}%s' % (ns_map['taxii_11'], self.name))
pb = etree.SubElement(xml, '{%s}Protocol_Binding' % ns_map['taxii_11'])
pb.text = self.inbox_protocol
a = etree.SubElement(xml, '{%s}Address' % ns_map['taxii_11'])
a.text = self.inbox_address
mb = etree.SubElement(xml, '{%s}Message_Binding' % ns_map['taxii_11'])
mb.text = self.delivery_message_binding
return xml
def to_dict(self):
d = {}
if self.inbox_protocol is not None:
d['inbox_protocol'] = self.inbox_protocol
if self.inbox_address is not None:
d['inbox_address'] = self.inbox_address
if self.delivery_message_binding is not None:
d['delivery_message_binding'] = self.delivery_message_binding
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Push Parameters ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.inbox_protocol
s += line_prepend + " Inbox Address: %s\n" % self.inbox_address
s += line_prepend + " Message Binding: %s\n" % self.delivery_message_binding
return s
@classmethod
def from_etree(cls, etree_xml):
inbox_protocol = get_optional_text(etree_xml, './taxii_11:Protocol_Binding', ns_map)
inbox_address = get_optional_text(etree_xml, './taxii_11:Address', ns_map)
delivery_message_binding = get_optional_text(etree_xml, './taxii_11:Message_Binding', ns_map)
return cls(inbox_protocol, inbox_address, delivery_message_binding)
@classmethod
def from_dict(cls, d):
return cls(**d)
# TODO: Check docstring
class DeliveryParameters(PushParameters):
"""Set up Delivery Parameters.
Args:
inbox_protocol (str): identifies the protocol to be used when pushing
TAXII Data Collection content to a Consumer's TAXII Inbox Service
implementation. **Required**
inbox_address (str): identifies the address of the TAXII Daemon hosting
the Inbox Service to which the Consumer requests content for this
TAXII Data Collection to be delivered. **Required**
delivery_message_binding (str): identifies the message binding to be
used to send pushed content for this subscription. **Required**
"""
name = 'Delivery_Parameters'
class TAXIIMessage(TAXIIBase11):
"""Encapsulate properties common to all TAXII Messages (such as headers).
This class is extended by each Message Type (e.g., DiscoveryRequest), with
each subclass containing subclass-specific information
"""
message_type = 'TAXIIMessage'
def __init__(self, message_id, in_response_to=None, extended_headers=None):
"""Create a new TAXIIMessage
Args:
message_id (str): A value identifying this message.
in_response_to (str): Contains the Message ID of the message to
which this is a response.
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers
"""
self.message_id = message_id
self.in_response_to = in_response_to
self.extended_headers = extended_headers or {}
@property
def message_id(self):
return self._message_id
@message_id.setter
def message_id(self, value):
do_check(value, 'message_id', regex_tuple=uri_regex)
self._message_id = value
@property
def in_response_to(self):
return self._in_response_to
@in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def extended_headers(self):
return self._extended_headers
@extended_headers.setter
def extended_headers(self, value):
do_check(list(value.keys()), 'extended_headers.keys()', regex_tuple=uri_regex)
self._extended_headers = value
def to_etree(self):
"""Creates the base etree for the TAXII Message.
Message-specific constructs must be added by each Message class. In
general, when converting to XML, subclasses should call this method
first, then create their specific XML constructs.
"""
root_elt = etree.Element('{%s}%s' % (ns_map['taxii_11'], self.message_type), nsmap=ns_map)
root_elt.attrib['message_id'] = str(self.message_id)
if self.in_response_to is not None:
root_elt.attrib['in_response_to'] = str(self.in_response_to)
if len(self.extended_headers) > 0:
eh = etree.SubElement(root_elt, '{%s}Extended_Headers' % ns_map['taxii_11'], nsmap=ns_map)
for name, value in list(self.extended_headers.items()):
h = etree.SubElement(eh, '{%s}Extended_Header' % ns_map['taxii_11'], nsmap=ns_map)
h.attrib['name'] = name
append_any_content_etree(h, value)
# h.text = value
return root_elt
def to_dict(self):
"""Create the base dictionary for the TAXII Message.
Message-specific constructs must be added by each Message class. In
general, when converting to dictionary, subclasses should call this
method first, then create their specific dictionary constructs.
"""
d = {}
d['message_type'] = self.message_type
d['message_id'] = self.message_id
if self.in_response_to is not None:
d['in_response_to'] = self.in_response_to
d['extended_headers'] = {}
for k, v in six.iteritems(self.extended_headers):
if isinstance(v, etree._Element) or isinstance(v, etree._ElementTree):
v = etree.tostring(v, encoding='utf-8')
elif not isinstance(v, six.string_types):
v = str(v)
d['extended_headers'][k] = v
return d
def to_text(self, line_prepend=''):
s = line_prepend + "Message Type: %s\n" % self.message_type
s += line_prepend + "Message ID: %s" % self.message_id
if self.in_response_to:
s += "; In Response To: %s" % self.in_response_to
s += "\n"
for k, v in six.iteritems(self.extended_headers):
s += line_prepend + "Extended Header: %s = %s\n" % (k, v)
return s
@classmethod
def from_etree(cls, src_etree, **kwargs):
"""Pulls properties of a TAXII Message from an etree.
Message-specific constructs must be pulled by each Message class. In
general, when converting from etree, subclasses should call this method
first, then parse their specific XML constructs.
"""
# Check namespace and element name of the root element
expected_tag = '{%s}%s' % (ns_map['taxii_11'], cls.message_type)
tag = src_etree.tag
if tag != expected_tag:
raise ValueError('%s != %s' % (tag, expected_tag))
# Get the message ID
message_id = get_required(src_etree, '/taxii_11:*/@message_id', ns_map)
# Get in response to, if present
in_response_to = get_optional(src_etree, '/taxii_11:*/@in_response_to', ns_map)
if in_response_to is not None:
kwargs['in_response_to'] = in_response_to
# Get the Extended headers
extended_header_list = src_etree.xpath('/taxii_11:*/taxii_11:Extended_Headers/taxii_11:Extended_Header', namespaces=ns_map)
extended_headers = {}
for header in extended_header_list:
eh_name = header.xpath('./@name')[0]
if len(header) == 0: # This has string content
eh_value = header.text
else: # This has XML content
eh_value = header[0]
extended_headers[eh_name] = eh_value
return cls(message_id, extended_headers=extended_headers, **kwargs)
@classmethod
def from_dict(cls, d, **kwargs):
"""Pulls properties of a TAXII Message from a dictionary.
Message-specific constructs must be pulled by each Message class. In
general, when converting from dictionary, subclasses should call this
method first, then parse their specific dictionary constructs.
"""
message_type = d['message_type']
if message_type != cls.message_type:
raise ValueError('%s != %s' % (message_type, cls.message_type))
message_id = d['message_id']
extended_headers = {}
for k, v in six.iteritems(d['extended_headers']):
try:
v = parse(v, allow_file=False)
except etree.XMLSyntaxError:
pass
extended_headers[k] = v
in_response_to = d.get('in_response_to')
if in_response_to:
kwargs['in_response_to'] = in_response_to
return cls(message_id, extended_headers=extended_headers, **kwargs)
@classmethod
def from_json(cls, json_string):
return cls.from_dict(json.loads(json_string))
class TAXIIRequestMessage(TAXIIMessage):
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value is not None:
raise ValueError('in_response_to must be None')
self._in_response_to = value
class DiscoveryRequest(TAXIIRequestMessage):
"""
A TAXII Discovery Request message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
"""
message_type = MSG_DISCOVERY_REQUEST
class DiscoveryResponse(TAXIIMessage):
"""
A TAXII Discovery Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Optional**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
service_instances (list of `ServiceInstance`): a list of
service instances that this response contains. **Optional**
"""
message_type = MSG_DISCOVERY_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None, service_instances=None):
super(DiscoveryResponse, self).__init__(message_id, in_response_to, extended_headers)
self.service_instances = service_instances or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def service_instances(self):
return self._service_instances
@service_instances.setter
def service_instances(self, value):
do_check(value, 'service_instances', type=ServiceInstance)
self._service_instances = value
def to_etree(self):
xml = super(DiscoveryResponse, self).to_etree()
for service_instance in self.service_instances:
xml.append(service_instance.to_etree())
return xml
def to_dict(self):
d = super(DiscoveryResponse, self).to_dict()
d['service_instances'] = []
for service_instance in self.service_instances:
d['service_instances'].append(service_instance.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(DiscoveryResponse, self).to_text()
for si in self.service_instances:
s += si.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['service_instances'] = []
service_instance_set = etree_xml.xpath('./taxii_11:Service_Instance', namespaces=ns_map)
for service_instance in service_instance_set:
si = ServiceInstance.from_etree(service_instance)
kwargs['service_instances'].append(si)
return super(DiscoveryResponse, cls).from_etree(etree_xml, **kwargs)
@classmethod
def from_dict(cls, d):
msg = super(DiscoveryResponse, cls).from_dict(d)
msg.service_instances = []
service_instance_set = d['service_instances']
for service_instance in service_instance_set:
si = ServiceInstance.from_dict(service_instance)
msg.service_instances.append(si)
return msg
class ServiceInstance(TAXIIBase11):
"""
The Service Instance component of a TAXII Discovery Response Message.
Args:
service_type (string): identifies the Service Type of this
Service Instance. **Required**
services_version (string): identifies the TAXII Services
Specification to which this Service conforms. **Required**
protocol_binding (string): identifies the protocol binding
supported by this Service. **Required**
service_address (string): identifies the network address of the
TAXII Daemon that hosts this Service. **Required**
message_bindings (list of strings): identifies the message
bindings supported by this Service instance. **Required**
inbox_service_accepted_content (list of ContentBinding objects): identifies
content bindings that this Inbox Service is willing to accept.
**Optional**
available (boolean): indicates whether the identity of the
requester (authenticated or otherwise) is allowed to access this
TAXII Service. **Optional**
message (string): contains a message regarding this Service
instance. **Optional**
supported_query (SupportedQuery): contains a structure indicating a
supported query. **Optional**
The ``message_bindings`` list must contain at least one value. The
``supported_query`` parameter is optional when
``service_type`` is :py:data:`SVC_POLL`.
"""
def __init__(self, service_type, services_version, protocol_binding,
service_address, message_bindings,
inbox_service_accepted_content=None, available=None,
message=None, supported_query=None):
self.service_type = service_type
self.services_version = services_version
self.protocol_binding = protocol_binding
self.service_address = service_address
self.message_bindings = message_bindings
self.inbox_service_accepted_content = inbox_service_accepted_content or []
self.available = available
self.message = message
self.supported_query = supported_query or []
@property
def sort_key(self):
return self.service_address
@property
def service_type(self):
return self._service_type
@service_type.setter
def service_type(self, value):
do_check(value, 'service_type', value_tuple=SVC_TYPES)
self._service_type = value
@property
def services_version(self):
return self._services_version
@services_version.setter
def services_version(self, value):
do_check(value, 'services_version', regex_tuple=uri_regex)
self._services_version = value
@property
def protocol_binding(self):
return self._protocol_binding
@protocol_binding.setter
def protocol_binding(self, value):
do_check(value, 'protocol_binding', regex_tuple=uri_regex)
self._protocol_binding = value
@property
def service_address(self):
return self._service_address
@service_address.setter
def service_address(self, value):
self._service_address = value
@property
def message_bindings(self):
return self._message_bindings
@message_bindings.setter
def message_bindings(self, value):
do_check(value, 'message_bindings', regex_tuple=uri_regex)
self._message_bindings = value
@property
def supported_query(self):
return self._supported_query
@supported_query.setter
def supported_query(self, value):
do_check(value, 'supported_query', type=SupportedQuery)
self._supported_query = value
@property
def inbox_service_accepted_content(self):
return self._inbox_service_accepted_content
@inbox_service_accepted_content.setter
def inbox_service_accepted_content(self, value):
value = _sanitize_content_bindings(value)
do_check(value, 'inbox_service_accepted_content', type=ContentBinding)
self._inbox_service_accepted_content = value
@property
def available(self):
return self._available
@available.setter
def available(self, value):
do_check(value, 'available', value_tuple=(True, False), can_be_none=True)
self._available = value
def to_etree(self):
si = etree.Element('{%s}Service_Instance' % ns_map['taxii_11'], nsmap=ns_map)
si.attrib['service_type'] = self.service_type
si.attrib['service_version'] = self.services_version
if self.available is not None:
si.attrib['available'] = str(self.available).lower()
protocol_binding = etree.SubElement(si, '{%s}Protocol_Binding' % ns_map['taxii_11'], nsmap=ns_map)
protocol_binding.text = self.protocol_binding
service_address = etree.SubElement(si, '{%s}Address' % ns_map['taxii_11'], nsmap=ns_map)
service_address.text = self.service_address
for mb in self.message_bindings:
message_binding = etree.SubElement(si, '{%s}Message_Binding' % ns_map['taxii_11'], nsmap=ns_map)
message_binding.text = mb
for sq in self.supported_query:
si.append(sq.to_etree())
for cb in self.inbox_service_accepted_content:
content_binding = cb.to_etree()
si.append(content_binding)
if self.message is not None:
message = etree.SubElement(si, '{%s}Message' % ns_map['taxii_11'], nsmap=ns_map)
message.text = self.message
return si
def to_dict(self):
d = {}
d['service_type'] = self.service_type
d['services_version'] = self.services_version
d['protocol_binding'] = self.protocol_binding
d['service_address'] = self.service_address
d['message_bindings'] = self.message_bindings
d['supported_query'] = []
for sq in self.supported_query:
d['supported_query'].append(sq.to_dict())
d['inbox_service_accepted_content'] = self.inbox_service_accepted_content
d['available'] = self.available
d['message'] = self.message
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Service Instance ===\n"
s += line_prepend + " Service Type: %s\n" % self.service_type
s += line_prepend + " Service Version: %s\n" % self.services_version
s += line_prepend + " Protocol Binding: %s\n" % self.protocol_binding
s += line_prepend + " Service Address: %s\n" % self.service_address
for mb in self.message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
if self.service_type == SVC_INBOX:
s += line_prepend + " Inbox Service AC: %s\n" % [ac.to_text() for ac in self.inbox_service_accepted_content]
s += line_prepend + " Available: %s\n" % self.available
s += line_prepend + " Message: %s\n" % self.message
for q in self.supported_query:
s += q.to_text(line_prepend + STD_INDENT)
return s
@staticmethod
def from_etree(etree_xml): # Expects a taxii_11:Service_Instance element
service_type = etree_xml.attrib['service_type']
services_version = etree_xml.attrib['service_version']
available = None
if etree_xml.attrib.get('available'):
tmp_available = etree_xml.attrib['available']
available = tmp_available == 'true'
protocol_binding = get_required(etree_xml, './taxii_11:Protocol_Binding', ns_map).text
service_address = get_required(etree_xml, './taxii_11:Address', ns_map).text
message_bindings = []
message_binding_set = etree_xml.xpath('./taxii_11:Message_Binding', namespaces=ns_map)
for mb in message_binding_set:
message_bindings.append(mb.text)
inbox_service_accepted_content = []
inbox_service_accepted_content_set = etree_xml.xpath('./taxii_11:Content_Binding', namespaces=ns_map)
for cb in inbox_service_accepted_content_set:
inbox_service_accepted_content.append(ContentBinding.from_etree(cb))
supported_query = []
supported_query_set = etree_xml.xpath('./taxii_11:Supported_Query', namespaces=ns_map)
for sq in supported_query_set:
format_id = sq.xpath('./@format_id')[0]
query_obj = get_deserializer(format_id, 'query_info').from_etree(sq)
supported_query.append(query_obj)
message = get_optional_text(etree_xml, './taxii_11:Message', ns_map)
return ServiceInstance(service_type,
services_version,
protocol_binding,
service_address,
message_bindings,
inbox_service_accepted_content,
available,
message,
supported_query)
@staticmethod
def from_dict(d):
service_type = d['service_type']
services_version = d['services_version']
protocol_binding = d['protocol_binding']
service_address = d['service_address']
message_bindings = d['message_bindings']
supported_query = []
sq_list = d.get('supported_query')
if sq_list is not None:
for sq in sq_list:
format_id = sq['format_id']
query_obj = get_deserializer(format_id, 'query_info').from_dict(sq)
supported_query.append(query_obj)
inbox_service_accepted_content = d.get('inbox_service_accepted_content')
available = d.get('available')
message = d.get('message')
return ServiceInstance(service_type,
services_version,
protocol_binding,
service_address,
message_bindings,
inbox_service_accepted_content,
available,
message,
supported_query)
class CollectionInformationRequest(TAXIIRequestMessage):
"""
A TAXII Collection Information Request message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
"""
message_type = MSG_COLLECTION_INFORMATION_REQUEST
class CollectionInformationResponse(TAXIIMessage):
"""
A TAXII Collection Information Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Optional**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
collection_informations (list of CollectionInformation objects): A list
of CollectionInformation objects to be contained in this response.
**Optional**
"""
message_type = MSG_COLLECTION_INFORMATION_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None, collection_informations=None):
super(CollectionInformationResponse, self).__init__(message_id, in_response_to, extended_headers=extended_headers)
self.collection_informations = collection_informations or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def collection_informations(self):
return self._collection_informations
@collection_informations.setter
def collection_informations(self, value):
do_check(value, 'collection_informations', type=CollectionInformation)
self._collection_informations = value
def to_etree(self):
xml = super(CollectionInformationResponse, self).to_etree()
for collection in self.collection_informations:
xml.append(collection.to_etree())
return xml
def to_dict(self):
d = super(CollectionInformationResponse, self).to_dict()
d['collection_informations'] = []
for collection in self.collection_informations:
d['collection_informations'].append(collection.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(CollectionInformationResponse, self).to_text(line_prepend)
s += line_prepend + "Contains %s Collection Informations\n" % len(self.collection_informations)
for collection in self.collection_informations:
s += collection.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
msg = super(CollectionInformationResponse, cls).from_etree(etree_xml)
msg.collection_informations = []
collection_informations = etree_xml.xpath('./taxii_11:Collection', namespaces=ns_map)
for collection in collection_informations:
msg.collection_informations.append(CollectionInformation.from_etree(collection))
return msg
@classmethod
def from_dict(cls, d):
msg = super(CollectionInformationResponse, cls).from_dict(d)
msg.collection_informations = []
for collection in d['collection_informations']:
msg.collection_informations.append(CollectionInformation.from_dict(collection))
return msg
class CollectionInformation(TAXIIBase11):
"""
The Collection Information component of a TAXII Collection Information
Response Message.
Arguments:
collection_name (str): the name by which this TAXII Data Collection is
identified. **Required**
collection_description (str): a prose description of this TAXII
Data Collection. **Required**
supported_contents (list of str): Content Binding IDs
indicating which types of content are currently expressed in this
TAXII Data Collection. **Optional**
available (boolean): whether the identity of the requester
(authenticated or otherwise) is allowed to access this TAXII
Service. **Optional** Default: ``None``, indicating "unknown"
push_methods (list of PushMethod objects): the protocols that
can be used to push content via a subscription. **Optional**
polling_service_instances (list of PollingServiceInstance objects):
the bindings and address a Consumer can use to interact with a
Poll Service instance that supports this TAXII Data Collection.
**Optional**
subscription_methods (list of SubscriptionMethod objects): the
protocol and address of the TAXII Daemon hosting the Collection
Management Service that can process subscriptions for this TAXII
Data Collection. **Optional**
collection_volume (int): the typical number of messages per day.
**Optional**
collection_type (str): the type ofo this collection. **Optional**,
defaults to :py:data:`CT_DATA_FEED`.
receiving_inbox_services (list of ReceivingInboxService objects):
TODO: FILL THIS IN. **Optional**
If ``supported_contents`` is omitted, then the collection supports all
content bindings. The absense of ``push_methods`` indicates no push
methods. The absense of ``polling_service_instances`` indicates no
polling services. The absense of ``subscription_methods`` indicates no
subscription services. The absense of ``receiving_inbox_services``
indicates no receiving inbox services.
"""
def __init__(self, collection_name, collection_description,
supported_contents=None, available=None, push_methods=None,
polling_service_instances=None, subscription_methods=None,
collection_volume=None, collection_type=CT_DATA_FEED,
receiving_inbox_services=None):
self.collection_name = collection_name
self.available = available
self.collection_description = collection_description
self.supported_contents = supported_contents or []
self.push_methods = push_methods or []
self.polling_service_instances = polling_service_instances or []
self.subscription_methods = subscription_methods or []
self.receiving_inbox_services = receiving_inbox_services or []
self.collection_volume = collection_volume
self.collection_type = collection_type
@property
def sort_key(self):
return self.collection_name
@property
def collection_name(self):
return self._collection_name
@collection_name.setter
def collection_name(self, value):
do_check(value, 'collection_name', regex_tuple=uri_regex)
self._collection_name = value
@property
def available(self):
return self._available
@available.setter
def available(self, value):
do_check(value, 'available', value_tuple=(True, False), can_be_none=True)
self._available = value
@property
def supported_contents(self):
return self._supported_contents
@supported_contents.setter
def supported_contents(self, value):
value = _sanitize_content_bindings(value)
do_check(value, 'supported_contents', type=ContentBinding)
self._supported_contents = value
@property
def push_methods(self):
return self._push_methods
@push_methods.setter
def push_methods(self, value):
do_check(value, 'push_methods', type=PushMethod)
self._push_methods = value
@property
def polling_service_instances(self):
return self._polling_service_instances
@polling_service_instances.setter
def polling_service_instances(self, value):
do_check(value, 'polling_service_instances', type=PollingServiceInstance)
self._polling_service_instances = value
@property
def subscription_methods(self):
return self._subscription_methods
@subscription_methods.setter
def subscription_methods(self, value):
do_check(value, 'subscription_methods', type=SubscriptionMethod)
self._subscription_methods = value
@property
def receiving_inbox_services(self):
return self._receiving_inbox_services
@receiving_inbox_services.setter
def receiving_inbox_services(self, value):
do_check(value, 'receiving_inbox_services', type=ReceivingInboxService)
self._receiving_inbox_services = value
@property
def collection_volume(self):
return self._collection_volume
@collection_volume.setter
def collection_volume(self, value):
do_check(value, 'collection_volume', type=int, can_be_none=True)
self._collection_volume = value
@property
def collection_type(self):
return self._collection_type
@collection_type.setter
def collection_type(self, value):
do_check(value, 'collection_type', value_tuple=CT_TYPES, can_be_none=True)
self._collection_type = value
def to_etree(self):
c = etree.Element('{%s}Collection' % ns_map['taxii_11'], nsmap=ns_map)
c.attrib['collection_name'] = self.collection_name
if self.collection_type is not None:
c.attrib['collection_type'] = self.collection_type
if self.available is not None:
c.attrib['available'] = str(self.available).lower()
collection_description = etree.SubElement(c, '{%s}Description' % ns_map['taxii_11'], nsmap=ns_map)
collection_description.text = self.collection_description
if self.collection_volume is not None:
collection_volume = etree.SubElement(c, '{%s}Collection_Volume' % ns_map['taxii_11'], nsmap=ns_map)
collection_volume.text = str(self.collection_volume)
for binding in self.supported_contents:
c.append(binding.to_etree())
for push_method in self.push_methods:
c.append(push_method.to_etree())
for polling_service in self.polling_service_instances:
c.append(polling_service.to_etree())
for subscription_method in self.subscription_methods:
c.append(subscription_method.to_etree())
for receiving_inbox_service in self.receiving_inbox_services:
c.append(receiving_inbox_service.to_etree())
return c
def to_dict(self):
d = {}
d['collection_name'] = self.collection_name
if self.collection_type is not None:
d['collection_type'] = self.collection_type
if self.available is not None:
d['available'] = self.available
d['collection_description'] = self.collection_description
if self.collection_volume is not None:
d['collection_volume'] = self.collection_volume
# TODO: I think this isn't a good serialization, I think a for loop is necessary
# This is probably a bug
d['supported_contents'] = self.supported_contents
d['push_methods'] = []
for push_method in self.push_methods:
d['push_methods'].append(push_method.to_dict())
d['polling_service_instances'] = []
for polling_service in self.polling_service_instances:
d['polling_service_instances'].append(polling_service.to_dict())
d['subscription_methods'] = []
for subscription_method in self.subscription_methods:
d['subscription_methods'].append(subscription_method.to_dict())
d['receiving_inbox_services'] = []
for receiving_inbox_service in self.receiving_inbox_services:
d['receiving_inbox_services'].append(receiving_inbox_service.to_dict())
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Data Collection Information ===\n"
s += line_prepend + " Collection Name: %s\n" % self.collection_name
s += line_prepend + " Collection Type: %s\n" % (self.collection_type if (None != self.collection_type) else CT_DATA_FEED)
s += line_prepend + " Available: %s\n" % self.available
s += line_prepend + " Collection Description: %s\n" % self.collection_description
if self.collection_volume:
s += line_prepend + " Volume: %s\n" % self.collection_volume
if len(self.supported_contents) == 0: # All contents supported:
s += line_prepend + " Supported Content: %s\n" % "All"
for contents in self.supported_contents:
s += line_prepend + " Supported Content: %s\n" % contents.to_text(line_prepend + STD_INDENT)
for psi in self.polling_service_instances:
s += psi.to_text(line_prepend + STD_INDENT)
for sm in self.subscription_methods:
s += sm.to_text(line_prepend + STD_INDENT)
for ris in self.receiving_inbox_services:
s += ris.to_text(line_prepend + STD_INDENT)
s += line_prepend + "==================================\n\n"
return s
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['collection_name'] = etree_xml.attrib['collection_name']
kwargs['collection_type'] = etree_xml.attrib.get('collection_type', None)
kwargs['available'] = None
if 'available' in etree_xml.attrib:
tmp = etree_xml.attrib['available']
kwargs['available'] = tmp.lower() == 'true'
kwargs['collection_description'] = get_required(etree_xml, './taxii_11:Description', ns_map).text
collection_volume_text = get_optional_text(etree_xml, './taxii_11:Collection_Volume', ns_map)
if collection_volume_text:
kwargs['collection_volume'] = int(collection_volume_text)
kwargs['supported_contents'] = []
supported_content_set = etree_xml.xpath('./taxii_11:Content_Binding', namespaces=ns_map)
for binding_elt in supported_content_set:
kwargs['supported_contents'].append(ContentBinding.from_etree(binding_elt))
kwargs['push_methods'] = []
push_method_set = etree_xml.xpath('./taxii_11:Push_Method', namespaces=ns_map)
for push_method_elt in push_method_set:
kwargs['push_methods'].append(PushMethod.from_etree(push_method_elt))
kwargs['polling_service_instances'] = []
polling_service_set = etree_xml.xpath('./taxii_11:Polling_Service', namespaces=ns_map)
for polling_elt in polling_service_set:
kwargs['polling_service_instances'].append(PollingServiceInstance.from_etree(polling_elt))
kwargs['subscription_methods'] = []
subscription_method_set = etree_xml.xpath('./taxii_11:Subscription_Service', namespaces=ns_map)
for subscription_elt in subscription_method_set:
kwargs['subscription_methods'].append(SubscriptionMethod.from_etree(subscription_elt))
kwargs['receiving_inbox_services'] = []
receiving_inbox_services_set = etree_xml.xpath('./taxii_11:Receiving_Inbox_Service', namespaces=ns_map)
for receiving_inbox_service in receiving_inbox_services_set:
kwargs['receiving_inbox_services'].append(ReceivingInboxService.from_etree(receiving_inbox_service))
return CollectionInformation(**kwargs)
@staticmethod
def from_dict(d):
kwargs = {}
kwargs['collection_name'] = d['collection_name']
kwargs['collection_type'] = d.get('collection_type')
kwargs['available'] = d.get('available')
kwargs['collection_description'] = d['collection_description']
kwargs['collection_volume'] = d.get('collection_volume')
kwargs['supported_contents'] = d.get('supported_contents', [])
kwargs['push_methods'] = []
for push_method in d.get('push_methods', []):
kwargs['push_methods'].append(PushMethod.from_dict(push_method))
kwargs['polling_service_instances'] = []
for polling in d.get('polling_service_instances', []):
kwargs['polling_service_instances'].append(PollingServiceInstance.from_dict(polling))
kwargs['subscription_methods'] = []
for subscription_method in d.get('subscription_methods', []):
kwargs['subscription_methods'].append(SubscriptionMethod.from_dict(subscription_method))
kwargs['receiving_inbox_services'] = []
receiving_inbox_services_set = d.get('receiving_inbox_services', [])
for receiving_inbox_service in receiving_inbox_services_set:
kwargs['receiving_inbox_services'].append(ReceivingInboxService.from_dict(receiving_inbox_service))
return CollectionInformation(**kwargs)
class PushMethod(TAXIIBase11):
"""
The Push Method component of a TAXII Collection Information
component.
Args:
push_protocol (str): a protocol binding that can be used
to push content to an Inbox Service instance. **Required**
push_message_bindings (list of str): the message bindings that
can be used to push content to an Inbox Service instance
using the protocol identified in the Push Protocol field.
**Required**
"""
def __init__(self, push_protocol, push_message_bindings):
self.push_protocol = push_protocol
self.push_message_bindings = push_message_bindings
@property
def sort_key(self):
return self.push_protocol
@property
def push_protocol(self):
return self._push_protocol
@push_protocol.setter
def push_protocol(self, value):
do_check(value, 'push_protocol', regex_tuple=uri_regex)
self._push_protocol = value
@property
def push_message_bindings(self):
return self._push_message_bindings
@push_message_bindings.setter
def push_message_bindings(self, value):
do_check(value, 'push_message_bindings', regex_tuple=uri_regex)
self._push_message_bindings = value
def to_etree(self):
x = etree.Element('{%s}Push_Method' % ns_map['taxii_11'], nsmap=ns_map)
proto_bind = etree.SubElement(x, '{%s}Protocol_Binding' % ns_map['taxii_11'], nsmap=ns_map)
proto_bind.text = self.push_protocol
for binding in self.push_message_bindings:
b = etree.SubElement(x, '{%s}Message_Binding' % ns_map['taxii_11'], nsmap=ns_map)
b.text = binding
return x
def to_dict(self):
d = {}
d['push_protocol'] = self.push_protocol
d['push_message_bindings'] = []
for binding in self.push_message_bindings:
d['push_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Push Method ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.push_protocol
for mb in self.push_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
return s
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['push_protocol'] = get_required(etree_xml, './taxii_11:Protocol_Binding', ns_map).text
kwargs['push_message_bindings'] = []
message_binding_set = etree_xml.xpath('./taxii_11:Message_Binding', namespaces=ns_map)
for message_binding in message_binding_set:
kwargs['push_message_bindings'].append(message_binding.text)
return PushMethod(**kwargs)
@staticmethod
def from_dict(d):
return PushMethod(**d)
class PollingServiceInstance(TAXIIBase11):
"""
The Polling Service Instance component of a TAXII Collection
Information component.
Args:
poll_protocol (str): the protocol binding supported by
this Poll Service instance. **Required**
poll_address (str): the address of the TAXII Daemon
hosting this Poll Service instance. **Required**
poll_message_bindings (list of str): the message bindings
supported by this Poll Service instance. **Required**
"""
NAME = 'Polling_Service'
def __init__(self, poll_protocol, poll_address, poll_message_bindings):
self.poll_protocol = poll_protocol
self.poll_address = poll_address
self.poll_message_bindings = poll_message_bindings
@property
def sort_key(self):
return self.poll_address
@property
def poll_protocol(self):
return self._poll_protocol
@poll_protocol.setter
def poll_protocol(self, value):
do_check(value, 'poll_protocol', regex_tuple=uri_regex)
self._poll_protocol = value
@property
def poll_message_bindings(self):
return self._poll_message_bindings
@poll_message_bindings.setter
def poll_message_bindings(self, value):
do_check(value, 'poll_message_bindings', regex_tuple=uri_regex)
self._poll_message_bindings = value
def to_etree(self):
x = etree.Element('{%s}Polling_Service' % ns_map['taxii_11'], nsmap=ns_map)
proto_bind = etree.SubElement(x, '{%s}Protocol_Binding' % ns_map['taxii_11'], nsmap=ns_map)
proto_bind.text = self.poll_protocol
address = etree.SubElement(x, '{%s}Address' % ns_map['taxii_11'], nsmap=ns_map)
address.text = self.poll_address
for binding in self.poll_message_bindings:
b = etree.SubElement(x, '{%s}Message_Binding' % ns_map['taxii_11'], nsmap=ns_map)
b.text = binding
return x
def to_dict(self):
d = {}
d['poll_protocol'] = self.poll_protocol
d['poll_address'] = self.poll_address
d['poll_message_bindings'] = []
for binding in self.poll_message_bindings:
d['poll_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Polling Service Instance ===\n"
s += line_prepend + " Poll Protocol: %s\n" % self.poll_protocol
s += line_prepend + " Poll Address: %s\n" % self.poll_address
for binding in self.poll_message_bindings:
s += line_prepend + " Message Binding: %s\n" % binding
return s
@classmethod
def from_etree(cls, etree_xml):
protocol = get_required(etree_xml, './taxii_11:Protocol_Binding', ns_map).text
addr = get_required(etree_xml, './taxii_11:Address', ns_map).text
bindings = []
message_binding_set = etree_xml.xpath('./taxii_11:Message_Binding', namespaces=ns_map)
for message_binding in message_binding_set:
bindings.append(message_binding.text)
return cls(protocol, addr, bindings)
@classmethod
def from_dict(cls, d):
return cls(**d)
class SubscriptionMethod(TAXIIBase11):
"""
The Subscription Method component of a TAXII Collection Information
component.
Args:
subscription_protocol (str): the protocol binding supported by
this Collection Management Service instance. **Required**
subscription_address (str): the address of the TAXII Daemon
hosting this Collection Management Service instance.
**Required**.
subscription_message_bindings (list of str): the message
bindings supported by this Collection Management Service
Instance. **Required**
"""
NAME = 'Subscription_Service'
def __init__(self, subscription_protocol, subscription_address,
subscription_message_bindings):
self.subscription_protocol = subscription_protocol
self.subscription_address = subscription_address
self.subscription_message_bindings = subscription_message_bindings
@property
def sort_key(self):
return self.subscription_address
@property
def subscription_protocol(self):
return self._subscription_protocol
@subscription_protocol.setter
def subscription_protocol(self, value):
do_check(value, 'subscription_protocol', regex_tuple=uri_regex)
self._subscription_protocol = value
@property
def subscription_message_bindings(self):
return self._subscription_message_bindings
@subscription_message_bindings.setter
def subscription_message_bindings(self, value):
do_check(value, 'subscription_message_bindings', regex_tuple=uri_regex)
self._subscription_message_bindings = value
def to_etree(self):
x = etree.Element('{%s}%s' % (ns_map['taxii_11'], self.NAME))
proto_bind = etree.SubElement(x, '{%s}Protocol_Binding' % ns_map['taxii_11'], nsmap=ns_map)
proto_bind.text = self.subscription_protocol
address = etree.SubElement(x, '{%s}Address' % ns_map['taxii_11'], nsmap=ns_map)
address.text = self.subscription_address
for binding in self.subscription_message_bindings:
b = etree.SubElement(x, '{%s}Message_Binding' % ns_map['taxii_11'], nsmap=ns_map)
b.text = binding
return x
def to_dict(self):
d = {}
d['subscription_protocol'] = self.subscription_protocol
d['subscription_address'] = self.subscription_address
d['subscription_message_bindings'] = []
for binding in self.subscription_message_bindings:
d['subscription_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Subscription Service ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.subscription_protocol
s += line_prepend + " Address: %s\n" % self.subscription_address
for mb in self.subscription_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
return s
@classmethod
def from_etree(cls, etree_xml):
protocol = get_required(etree_xml, './taxii_11:Protocol_Binding', ns_map).text
addr = get_required(etree_xml, './taxii_11:Address', ns_map).text
bindings = []
message_binding_set = etree_xml.xpath('./taxii_11:Message_Binding', namespaces=ns_map)
for message_binding in message_binding_set:
bindings.append(message_binding.text)
return cls(protocol, addr, bindings)
@classmethod
def from_dict(cls, d):
return cls(**d)
class ReceivingInboxService(TAXIIBase11):
"""
The Receiving Inbox Service component of a TAXII Collection
Information component.
Args:
inbox_protocol (str): Indicates the protocol this Inbox Service
uses. **Required**
inbox address (str): Indicates the address of this Inbox Service.
**Required**
inbox_message_bindings (list of str): Each string indicates a
message binding that this inbox service uses. **Required**
supported_contents (list of ContentBinding objects): Each object
indicates a Content Binding this inbox service can receive.
**Optional**. Setting to ``None`` means that all Content
Bindings are supported.
"""
def __init__(self, inbox_protocol, inbox_address,
inbox_message_bindings, supported_contents=None):
self.inbox_protocol = inbox_protocol
self.inbox_address = inbox_address
self.inbox_message_bindings = inbox_message_bindings
self.supported_contents = supported_contents or []
@property
def sort_key(self):
return self.inbox_address
@property
def inbox_protocol(self):
return self._inbox_protocol
@inbox_protocol.setter
def inbox_protocol(self, value):
do_check(value, 'inbox_protocol', type=six.string_types, regex_tuple=uri_regex)
self._inbox_protocol = value
@property
def inbox_address(self):
return self._inbox_address
@inbox_address.setter
def inbox_address(self, value):
self._inbox_address = value
@property
def inbox_message_bindings(self):
return self._inbox_message_bindings
@inbox_message_bindings.setter
def inbox_message_bindings(self, value):
do_check(value, 'inbox_message_bindings', regex_tuple=uri_regex)
self._inbox_message_bindings = value
@property
def supported_contents(self):
return self._supported_contents
@supported_contents.setter
def supported_contents(self, value):
value = _sanitize_content_bindings(value)
do_check(value, 'supported_contents', type=ContentBinding)
self._supported_contents = value
def to_etree(self):
xml = etree.Element('{%s}Receiving_Inbox_Service' % ns_map['taxii_11'], nsmap=ns_map)
pb = etree.SubElement(xml, '{%s}Protocol_Binding' % ns_map['taxii_11'])
pb.text = self.inbox_protocol
a = etree.SubElement(xml, '{%s}Address' % ns_map['taxii_11'])
a.text = self.inbox_address
for binding in self.inbox_message_bindings:
mb = etree.SubElement(xml, '{%s}Message_Binding' % ns_map['taxii_11'])
mb.text = binding
for binding in self.supported_contents:
xml.append(binding.to_etree())
return xml
def to_dict(self):
d = {}
d['inbox_protocol'] = self.inbox_protocol
d['inbox_address'] = self.inbox_address
d['inbox_message_bindings'] = self.inbox_message_bindings
d['supported_contents'] = []
for supported_content in self.supported_contents:
d['supported_contents'].append(supported_content.to_dict())
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Receiving Inbox Service ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.inbox_protocol
s += line_prepend + " Address: %s\n" % self.inbox_address
for mb in self.inbox_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
if len(self.supported_contents) == 0:
s += line_prepend + " Supported Contents: All\n"
for sc in self.supported_contents:
s += line_prepend + " Supported Content: %s\n" % str(sc)
return s
@staticmethod
def from_etree(etree_xml):
proto = get_required(etree_xml, './taxii_11:Protocol_Binding', ns_map).text
addr = get_required(etree_xml, './taxii_11:Address', ns_map).text
message_bindings = []
message_binding_set = etree_xml.xpath('./taxii_11:Message_Binding', namespaces=ns_map)
for mb in message_binding_set:
message_bindings.append(mb.text)
supported_contents = []
supported_contents_set = etree_xml.xpath('./taxii_11:Content_Binding', namespaces=ns_map)
for cb in supported_contents_set:
supported_contents.append(ContentBinding.from_etree(cb))
return ReceivingInboxService(proto, addr, message_bindings, supported_contents)
@staticmethod
def from_dict(d):
kwargs = {}
kwargs['inbox_protocol'] = d['inbox_protocol']
kwargs['inbox_address'] = d['inbox_address']
kwargs['inbox_message_bindings'] = d['inbox_message_bindings']
kwargs['supported_contents'] = []
for binding in d['supported_contents']:
kwargs['supported_contents'].append(ContentBinding.from_dict(binding))
return ReceivingInboxService(**kwargs)
class PollRequest(TAXIIRequestMessage):
"""
A TAXII Poll Request message.
Arguments:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
collection_name (str): the name of the TAXII Data Collection that is being
polled. **Required**
exclusive_begin_timestamp_label (datetime): a Timestamp Label
indicating the beginning of the range of TAXII Data Feed content the
requester wishes to receive. **Optional for a Data Feed, Prohibited
for a Data Set**
inclusive_end_timestamp_label (datetime): a Timestamp Label
indicating the end of the range of TAXII Data Feed content the
requester wishes to receive. **Optional for a Data Feed, Probited
for a Data Set**
subscription_id (str): the existing subscription the Consumer
wishes to poll. **Optional**
poll_parameters (list of PollParameters objects): the poll parameters
for this request. **Optional**
Exactly one of ``subscription_id`` and ``poll_parameters`` is **Required**.
"""
message_type = MSG_POLL_REQUEST
def __init__(self, message_id, extended_headers=None,
collection_name=None, exclusive_begin_timestamp_label=None,
inclusive_end_timestamp_label=None, subscription_id=None,
poll_parameters=None):
super(PollRequest, self).__init__(message_id, extended_headers=extended_headers)
self.collection_name = collection_name
self.exclusive_begin_timestamp_label = exclusive_begin_timestamp_label
self.inclusive_end_timestamp_label = inclusive_end_timestamp_label
self.subscription_id = subscription_id
self.poll_parameters = poll_parameters
if subscription_id is None and poll_parameters is None:
raise ValueError('One of subscription_id or poll_parameters must not be None')
if subscription_id is not None and poll_parameters is not None:
raise ValueError('Only one of subscription_id and poll_parameters can be present')
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', value_tuple=(None, None), can_be_none=True)
self._in_response_to = value
@property
def collection_name(self):
return self._collection_name
@collection_name.setter
def collection_name(self, value):
do_check(value, 'collection_name', regex_tuple=uri_regex)
self._collection_name = value
@property
def exclusive_begin_timestamp_label(self):
return self._exclusive_begin_timestamp_label
@exclusive_begin_timestamp_label.setter
def exclusive_begin_timestamp_label(self, value):
value = check_timestamp_label(value, 'exclusive_begin_timestamp_label', can_be_none=True)
self._exclusive_begin_timestamp_label = value
@property
def inclusive_end_timestamp_label(self):
return self._inclusive_end_timestamp_label
@inclusive_end_timestamp_label.setter
def inclusive_end_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_end_timestamp_label', can_be_none=True)
self._inclusive_end_timestamp_label = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex, can_be_none=True)
self._subscription_id = value
@property
def poll_parameters(self):
return self._poll_parameters
@poll_parameters.setter
def poll_parameters(self, value):
do_check(value, 'poll_parameters', type=PollParameters, can_be_none=True)
self._poll_parameters = value
def to_etree(self):
xml = super(PollRequest, self).to_etree()
xml.attrib['collection_name'] = self.collection_name
if self.exclusive_begin_timestamp_label is not None:
ebt = etree.SubElement(xml, '{%s}Exclusive_Begin_Timestamp' % ns_map['taxii_11'], nsmap=ns_map)
# TODO: Add TZ Info
ebt.text = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label is not None:
iet = etree.SubElement(xml, '{%s}Inclusive_End_Timestamp' % ns_map['taxii_11'], nsmap=ns_map)
# TODO: Add TZ Info
iet.text = self.inclusive_end_timestamp_label.isoformat()
if self.subscription_id is not None:
si = etree.SubElement(xml, '{%s}Subscription_ID' % ns_map['taxii_11'], nsmap=ns_map)
si.text = self.subscription_id
if self.poll_parameters is not None:
xml.append(self.poll_parameters.to_etree())
return xml
def to_dict(self):
d = super(PollRequest, self).to_dict()
d['collection_name'] = self.collection_name
if self.subscription_id is not None:
d['subscription_id'] = self.subscription_id
if self.exclusive_begin_timestamp_label is not None: # TODO: Add TZ Info
d['exclusive_begin_timestamp_label'] = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label is not None: # TODO: Add TZ Info
d['inclusive_end_timestamp_label'] = self.inclusive_end_timestamp_label.isoformat()
d['poll_parameters'] = None
if self.poll_parameters is not None:
d['poll_parameters'] = self.poll_parameters.to_dict()
return d
def to_text(self, line_prepend=''):
s = super(PollRequest, self).to_text(line_prepend)
s += line_prepend + " Collection Name: %s\n" % self.collection_name
if self.subscription_id:
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
s += line_prepend + " Excl. Begin TS Label: %s\n" % self.exclusive_begin_timestamp_label
s += line_prepend + " Incl. End TS Label: %s\n" % self.inclusive_end_timestamp_label
if self.poll_parameters:
s += self.poll_parameters.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['collection_name'] = get_required(etree_xml, './@collection_name', ns_map)
kwargs['exclusive_begin_timestamp_label'] = None
begin_ts_text = get_optional_text(etree_xml, './taxii_11:Exclusive_Begin_Timestamp', ns_map)
if begin_ts_text:
kwargs['exclusive_begin_timestamp_label'] = parse_datetime_string(begin_ts_text)
end_ts_text = get_optional_text(etree_xml, './taxii_11:Inclusive_End_Timestamp', ns_map)
if end_ts_text:
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(end_ts_text)
poll_parameter_el = get_optional(etree_xml, './taxii_11:Poll_Parameters', ns_map)
if poll_parameter_el is not None:
kwargs['poll_parameters'] = PollParameters.from_etree(poll_parameter_el)
kwargs['subscription_id'] = get_optional_text(etree_xml, './taxii_11:Subscription_ID', ns_map)
msg = super(PollRequest, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['collection_name'] = d['collection_name']
kwargs['subscription_id'] = d.get('subscription_id')
kwargs['exclusive_begin_timestamp_label'] = None
if 'exclusive_begin_timestamp_label' in d:
kwargs['exclusive_begin_timestamp_label'] = parse_datetime_string(d['exclusive_begin_timestamp_label'])
kwargs['inclusive_end_timestamp_label'] = None
if 'inclusive_end_timestamp_label' in d:
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(d['inclusive_end_timestamp_label'])
kwargs['poll_parameters'] = None
if 'poll_parameters' in d and d['poll_parameters'] is not None:
kwargs['poll_parameters'] = PollParameters.from_dict(d['poll_parameters'])
msg = super(PollRequest, cls).from_dict(d, **kwargs)
return msg
class PollParameters(_GenericParameters):
"""
The Poll Parameters component of a TAXII Poll Request message.
Args:
response_type (str): The requested response type. Must be either
:py:data:`RT_FULL` or :py:data:`RT_COUNT_ONLY`. **Optional**,
defaults to :py:data:`RT_FULL`
content_bindings (list of ContentBinding objects): A list of Content
Bindings acceptable in response. **Optional**
query (Query): The query for this poll parameters. **Optional**
allow_asynch (bool): Indicates whether the client supports
asynchronous polling. **Optional**, defaults to ``False``
delivery_parameters (libtaxii.messages_11.DeliveryParameters): The requested delivery
parameters for this object. **Optional**
If ``content_bindings`` in not provided, this indicates that all
bindings are accepted as a response.
"""
name = 'Poll_Parameters'
def __init__(self, response_type=RT_FULL, content_bindings=None,
query=None, allow_asynch=False, delivery_parameters=None):
super(PollParameters, self).__init__(response_type, content_bindings, query)
self.allow_asynch = allow_asynch
self.delivery_parameters = delivery_parameters
@property
def delivery_parameters(self):
return self._delivery_parameters
@delivery_parameters.setter
def delivery_parameters(self, value):
do_check(value, 'delivery_parameters', type=DeliveryParameters, can_be_none=True)
self._delivery_parameters = value
@property
def allow_asynch(self):
return self._allow_asynch
@allow_asynch.setter
def allow_asynch(self, value):
do_check(value, 'allow_asynch', value_tuple=(True, False), can_be_none=True)
self._allow_asynch = value
def to_etree(self):
xml = super(PollParameters, self).to_etree()
if self.allow_asynch is not None:
xml.attrib['allow_asynch'] = str(self.allow_asynch).lower()
if self.delivery_parameters is not None:
xml.append(self.delivery_parameters.to_etree())
return xml
def to_dict(self):
d = super(PollParameters, self).to_dict()
if self.allow_asynch is not None:
d['allow_asynch'] = str(self.allow_asynch).lower()
d['delivery_parameters'] = None
if self.delivery_parameters is not None:
d['delivery_parameters'] = self.delivery_parameters.to_dict()
return d
def to_text(self, line_prepend=''):
s = super(PollParameters, self).to_text(line_prepend)
if self.allow_asynch:
s += line_prepend + " Allow Asynch: %s\n" % self.allow_asynch
if self.delivery_parameters:
s += self.delivery_parameters.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
poll_parameters = super(PollParameters, cls).from_etree(etree_xml)
allow_asynch_el = get_optional(etree_xml, './@allow_asynch', ns_map)
poll_parameters.allow_asynch = allow_asynch_el == 'true'
delivery_parameters_el = get_optional(etree_xml, './taxii_11:Delivery_Parameters', ns_map)
if delivery_parameters_el is not None:
poll_parameters.delivery_parameters = DeliveryParameters.from_etree(delivery_parameters_el)
return poll_parameters
@classmethod
def from_dict(cls, d):
poll_parameters = super(PollParameters, cls).from_dict(d)
aa = d.get('allow_asynch')
if aa is not None:
poll_parameters.allow_asynch = aa == 'true'
delivery_parameters = d.get('delivery_parameters')
if delivery_parameters is not None:
poll_parameters.delivery_parameters = DeliveryParameters.from_dict(delivery_parameters)
return poll_parameters
class PollResponse(TAXIIMessage):
"""
A TAXII Poll Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Optional**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
collection_name (str): the name of the TAXII Data Collection that was
polled. **Required**
exclusive_begin_timestamp_label (datetime): a Timestamp Label
indicating the beginning of the range this response covers.
**Optional for a Data Feed, Prohibited for a Data Set**
inclusive_end_timestamp_label (datetime): a Timestamp Label
indicating the end of the range this response covers. **Optional
for a Data Feed, Prohibited for a Data Set**
subscription_id (str): the Subscription ID for which this content
is being provided. **Optional**
message (str): additional information for the message recipient.
**Optional**
content_blocks (list of ContentBlock): piece of content
and additional information related to the content. **Optional**
more (bool): Whether there are more result parts. **Optional**, defaults
to ``False``
result_id (str): The ID of this result. **Optional**
result_part_number (int): The result part number of this response.
**Optional**
record_count (RecordCount): The number of records and whether
the count is a lower bound. **Optional**
"""
message_type = MSG_POLL_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None,
collection_name=None, exclusive_begin_timestamp_label=None,
inclusive_end_timestamp_label=None, subscription_id=None,
message=None, content_blocks=None, more=False, result_id=None,
result_part_number=1, record_count=None):
super(PollResponse, self).__init__(message_id, in_response_to, extended_headers)
self.collection_name = collection_name
self.exclusive_begin_timestamp_label = exclusive_begin_timestamp_label
self.inclusive_end_timestamp_label = inclusive_end_timestamp_label
self.subscription_id = subscription_id
self.message = message
self.content_blocks = content_blocks or []
self.more = more
self.result_part_number = result_part_number
self.result_id = result_id
self.record_count = record_count
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def collection_name(self):
return self._collection_name
@collection_name.setter
def collection_name(self, value):
do_check(value, 'collection_name', regex_tuple=uri_regex)
self._collection_name = value
@property
def inclusive_end_timestamp_label(self):
return self._inclusive_end_timestamp_label
@inclusive_end_timestamp_label.setter
def inclusive_end_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_end_timestamp_label', can_be_none=True)
self._inclusive_end_timestamp_label = value
@property
def inclusive_begin_timestamp_label(self):
return self._inclusive_begin_timestamp_label
@inclusive_begin_timestamp_label.setter
def inclusive_begin_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_begin_timestamp_label', can_be_none=True)
self._inclusive_begin_timestamp_label = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex, can_be_none=True)
self._subscription_id = value
@property
def content_blocks(self):
return self._content_blocks
@content_blocks.setter
def content_blocks(self, value):
do_check(value, 'content_blocks', type=ContentBlock)
self._content_blocks = value
@property
def more(self):
return self._more
@more.setter
def more(self, value):
do_check(value, 'more', value_tuple=(True, False))
self._more = value
@property
def result_id(self):
return self._result_id
@result_id.setter
def result_id(self, value):
do_check(value, 'result_id', regex_tuple=uri_regex, can_be_none=True)
self._result_id = value
@property
def result_part_number(self):
return self._result_part_number
@result_part_number.setter
def result_part_number(self, value):
do_check(value, 'result_part_number', type=int, can_be_none=True)
self._result_part_number = value
@property
def record_count(self):
return self._record_count
@record_count.setter
def record_count(self, value):
do_check(value, 'record_count', type=RecordCount, can_be_none=True)
self._record_count = value
def to_etree(self):
xml = super(PollResponse, self).to_etree()
xml.attrib['collection_name'] = self.collection_name
if self.result_id is not None:
xml.attrib['result_id'] = self.result_id
if self.more is not None:
xml.attrib['more'] = str(self.more).lower()
if self.result_part_number is not None:
xml.attrib['result_part_number'] = str(self.result_part_number)
if self.subscription_id is not None:
si = etree.SubElement(xml, '{%s}Subscription_ID' % ns_map['taxii_11'])
si.text = self.subscription_id
if self.exclusive_begin_timestamp_label:
ibt = etree.SubElement(xml, '{%s}Exclusive_Begin_Timestamp' % ns_map['taxii_11'])
ibt.text = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label:
iet = etree.SubElement(xml, '{%s}Inclusive_End_Timestamp' % ns_map['taxii_11'])
iet.text = self.inclusive_end_timestamp_label.isoformat()
if self.record_count:
xml.append(self.record_count.to_etree())
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii_11'])
m.text = self.message
for block in self.content_blocks:
xml.append(block.to_etree())
return xml
def to_dict(self):
d = super(PollResponse, self).to_dict()
d['collection_name'] = self.collection_name
d['more'] = self.more
d['result_id'] = self.result_id
d['result_part_number'] = self.result_part_number
if self.record_count is not None:
d['record_count'] = self.record_count.to_dict()
if self.subscription_id is not None:
d['subscription_id'] = self.subscription_id
if self.message is not None:
d['message'] = self.message
if self.exclusive_begin_timestamp_label is not None:
d['exclusive_begin_timestamp_label'] = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label is not None:
d['inclusive_end_timestamp_label'] = self.inclusive_end_timestamp_label.isoformat()
d['content_blocks'] = []
for block in self.content_blocks:
d['content_blocks'].append(block.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(PollResponse, self).to_text(line_prepend)
s += line_prepend + " Collection Name: %s\n" % self.collection_name
s += line_prepend + " More: %s\n" % self.more
s += line_prepend + " Result ID: %s\n" % self.result_id
if self.result_part_number:
s += line_prepend + " Result Part Num: %s\n" % self.result_part_number
if self.record_count:
s += self.record_count.to_text(line_prepend + STD_INDENT)
if self.subscription_id:
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
if self.message:
s += line_prepend + " Message: %s\n" % self.message
if self.exclusive_begin_timestamp_label:
s += line_prepend + " Excl. Begin TS Label: %s\n" % self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label:
s += line_prepend + " Incl. End TS Label: %s\n" % self.inclusive_end_timestamp_label.isoformat()
for cb in self.content_blocks:
s += cb.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['collection_name'] = get_required(etree_xml, './@collection_name', ns_map)
kwargs['more'] = etree_xml.attrib.get('more', 'false') == 'true'
kwargs['subscription_id'] = None
kwargs['result_id'] = etree_xml.attrib.get('result_id')
rpn = etree_xml.attrib.get('result_part_number', None)
if rpn:
kwargs['result_part_number'] = int(rpn)
kwargs['subscription_id'] = get_optional_text(etree_xml, './taxii_11:Subscription_ID', ns_map)
kwargs['message'] = get_optional_text(etree_xml, './taxii_11:Message', ns_map)
ebts_text = get_optional_text(etree_xml, './taxii_11:Exclusive_Begin_Timestamp', ns_map)
if ebts_text:
kwargs['exclusive_begin_timestamp_label'] = parse_datetime_string(ebts_text)
iets_text = get_optional_text(etree_xml, './taxii_11:Inclusive_End_Timestamp', ns_map)
if iets_text:
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(iets_text)
kwargs['content_blocks'] = []
for block in etree_xml.xpath('./taxii_11:Content_Block', namespaces=ns_map):
kwargs['content_blocks'].append(ContentBlock.from_etree(block))
record_count_el = get_optional(etree_xml, './taxii_11:Record_Count', ns_map)
if record_count_el is not None:
kwargs['record_count'] = RecordCount.from_etree(record_count_el)
msg = super(PollResponse, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['collection_name'] = d['collection_name']
kwargs['result_id'] = d.get('result_id')
kwargs['result_part_number'] = d.get('result_part_number')
kwargs['message'] = None
if 'message' in d:
kwargs['message'] = d['message']
kwargs['subscription_id'] = d.get('subscription_id')
kwargs['more'] = d.get('more', False)
kwargs['exclusive_begin_timestamp_label'] = None
if 'exclusive_begin_timestamp_label' in d:
kwargs['exclusive_begin_timestamp_label'] = parse_datetime_string(d['exclusive_begin_timestamp_label'])
kwargs['record_count'] = None
if 'record_count' in d:
kwargs['record_count'] = RecordCount.from_dict(d['record_count'])
kwargs['inclusive_end_timestamp_label'] = None
if 'inclusive_end_timestamp_label' in d:
kwargs['inclusive_end_timestamp_label'] = parse_datetime_string(d['inclusive_end_timestamp_label'])
kwargs['content_blocks'] = []
for block in d['content_blocks']:
kwargs['content_blocks'].append(ContentBlock.from_dict(block))
msg = super(PollResponse, cls).from_dict(d, **kwargs)
return msg
_StatusDetail = collections.namedtuple('_StatusDetail', ['name', 'required', 'type', 'multiple'])
_DCE_AcceptableDestination = _StatusDetail(SD_ACCEPTABLE_DESTINATION, False, str, True)
_IRP_MaxPartNumber = _StatusDetail(SD_MAX_PART_NUMBER, True, int, False)
_NF_Item = _StatusDetail(SD_ITEM, False, str, False)
_P_EstimatedWait = _StatusDetail(SD_ESTIMATED_WAIT, True, int, False)
_P_ResultId = _StatusDetail(SD_RESULT_ID, True, str, False)
_P_WillPush = _StatusDetail(SD_WILL_PUSH, True, bool, False)
_R_EstimatedWait = _StatusDetail(SD_ESTIMATED_WAIT, False, int, False)
_UM_SupportedBinding = _StatusDetail(SD_SUPPORTED_BINDING, False, str, True)
_UC_SupportedContent = _StatusDetail(SD_SUPPORTED_CONTENT, False, ContentBinding, True)
_UP_SupportedProtocol = _StatusDetail(SD_SUPPORTED_PROTOCOL, False, str, True)
_UQ_SupportedQuery = _StatusDetail(SD_SUPPORTED_QUERY, False, str, True)
status_details = {
ST_ASYNCHRONOUS_POLL_ERROR: {},
ST_BAD_MESSAGE: {},
ST_DENIED: {},
ST_DESTINATION_COLLECTION_ERROR: {SD_ACCEPTABLE_DESTINATION: _DCE_AcceptableDestination},
ST_FAILURE: {},
ST_INVALID_RESPONSE_PART: {SD_MAX_PART_NUMBER: _IRP_MaxPartNumber},
ST_NETWORK_ERROR: {},
ST_NOT_FOUND: {SD_ITEM: _NF_Item},
ST_PENDING: {SD_ESTIMATED_WAIT: _P_EstimatedWait,
SD_RESULT_ID: _P_ResultId,
SD_WILL_PUSH: _P_WillPush},
ST_POLLING_UNSUPPORTED: {},
ST_RETRY: {SD_ESTIMATED_WAIT: _R_EstimatedWait},
ST_SUCCESS: {},
ST_UNAUTHORIZED: {},
ST_UNSUPPORTED_MESSAGE_BINDING: {SD_SUPPORTED_BINDING: _UM_SupportedBinding},
ST_UNSUPPORTED_CONTENT_BINDING: {SD_SUPPORTED_CONTENT: _UC_SupportedContent},
ST_UNSUPPORTED_PROTOCOL: {SD_SUPPORTED_PROTOCOL: _UP_SupportedProtocol},
ST_UNSUPPORTED_QUERY: {SD_SUPPORTED_QUERY: _UQ_SupportedQuery}
}
class StatusMessage(TAXIIMessage):
"""
A TAXII Status message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
status_type (str): One of the defined Status Types or a third-party-
defined Status Type. **Required**
status_detail (dict): A field for additional information about
this status in a machine-readable format. **Required or Optional**
depending on ``status_type``. See TAXII Specification for details.
message (str): Additional information for the status. There is no
expectation that this field be interpretable by a machine; it is
instead targeted to a human operator. **Optional**
"""
message_type = MSG_STATUS_MESSAGE
def __init__(self, message_id, in_response_to, extended_headers=None,
status_type=None, status_detail=None, message=None):
super(StatusMessage, self).__init__(message_id, in_response_to, extended_headers=extended_headers)
self.status_type = status_type
self.status_detail = status_detail or {}
self.message = message
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def status_type(self):
return self._status_type
@status_type.setter
def status_type(self, value):
do_check(value, 'status_type')
self._status_type = value
@property
def status_detail(self):
return self._status_detail
@status_detail.setter
def status_detail(self, value):
do_check(list(value.keys()), 'status_detail.keys()', regex_tuple=uri_regex)
detail_rules = status_details.get(self.status_type, {})
# Check defined status types for conformance
for sd_name, rules in six.iteritems(detail_rules):
do_check(value.get(sd_name, None),
'status_detail[\'%s\']' % sd_name,
type=rules.type,
can_be_none=(not rules.required))
self._status_detail = value
@property
def message(self):
return self._message
@message.setter
def message(self, value):
do_check(value, 'message', type=six.string_types, can_be_none=True)
self._message = value
def to_etree(self):
xml = super(StatusMessage, self).to_etree()
xml.attrib['status_type'] = self.status_type
if len(self.status_detail) > 0:
sd = etree.SubElement(xml, '{%s}Status_Detail' % ns_map['taxii_11'])
for k, v in six.iteritems(self.status_detail):
if not isinstance(v, list):
v = [v]
for item in v:
d = etree.SubElement(sd, '{%s}Detail' % ns_map['taxii_11'])
d.attrib['name'] = k
if item in (True, False):
d.text = str(item).lower()
else:
d.text = str(item)
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii_11'])
m.text = self.message
return xml
def to_dict(self):
d = super(StatusMessage, self).to_dict()
d['status_type'] = self.status_type
if self.status_detail is not None:
d['status_detail'] = self.status_detail
if self.message is not None:
d['message'] = self.message
return d
def to_text(self, line_prepend=''):
s = super(StatusMessage, self).to_text(line_prepend)
s += line_prepend + "Status Type: %s\n" % self.status_type
for k, v in six.iteritems(self.status_detail):
s += line_prepend + "Status Detail: %s = %s\n" % (k, v)
if self.message:
s += line_prepend + "Message: %s\n" % self.message
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
status_type = etree_xml.attrib['status_type']
kwargs['status_type'] = status_type
kwargs['status_detail'] = {}
detail_set = etree_xml.xpath('./taxii_11:Status_Detail/taxii_11:Detail', namespaces=ns_map)
for detail in detail_set:
# TODO: This seems kind of hacky and should probably be improved
name = detail.attrib['name']
if status_type in status_details and name in status_details[status_type]: # We have information for this status detail
detail_info = status_details[status_type][name]
else: # We don't have information, so make something up
detail_info = _StatusDetail('PlaceholderDetail', False, str, True)
if detail_info.type == bool:
v = detail.text.lower() == 'true'
else:
v = detail_info.type(detail.text)
if detail_info.multiple: # There can be multiple instances of this item
if name not in kwargs['status_detail']:
kwargs['status_detail'][name] = v
else: # It already exists
if not isinstance(kwargs['status_detail'][name], list):
kwargs['status_detail'][name] = [kwargs['status_detail'][name]] # Make it a list
kwargs['status_detail'][name].append(v)
else:
kwargs['status_detail'][name] = v
kwargs['message'] = None
m_set = etree_xml.xpath('./taxii_11:Message', namespaces=ns_map)
if len(m_set) > 0:
kwargs['message'] = m_set[0].text
msg = super(StatusMessage, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['status_type'] = d['status_type']
kwargs['status_detail'] = d.get('status_detail')
kwargs['message'] = d.get('message')
msg = super(StatusMessage, cls).from_dict(d, **kwargs)
return msg
class InboxMessage(TAXIIMessage):
"""
A TAXII Inbox message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
message (str): prose information for the message recipient. **Optional**
result_id (str): the result id. **Optional**
destination_collection_names (list of str): Each string indicates a
destination collection name. **Optional**
subscription_information (libtaxii.messages_11.SubscriptionInformation): This
field is only present if this message is being sent to provide
content in accordance with an existing TAXII Data Collection
subscription. **Optional**
record_count (RecordCount): The number of records and whether
the count is a lower bound. **Optional**
content_blocks (list of ContentBlock): Inbox content. **Optional**
"""
message_type = MSG_INBOX_MESSAGE
def __init__(self, message_id, in_response_to=None, extended_headers=None,
message=None, result_id=None, destination_collection_names=None,
subscription_information=None, record_count=None,
content_blocks=None):
super(InboxMessage, self).__init__(message_id, extended_headers=extended_headers)
self.subscription_information = subscription_information
self.message = message
self.result_id = result_id
self.destination_collection_names = destination_collection_names or []
self.subscription_information = subscription_information
self.record_count = record_count
self.content_blocks = content_blocks or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value is not None:
raise ValueError('in_response_to must be None')
self._in_response_to = value
@property
def subscription_information(self):
return self._subscription_information
@subscription_information.setter
def subscription_information(self, value):
do_check(value, 'subscription_information', type=SubscriptionInformation, can_be_none=True)
self._subscription_information = value
@property
def content_blocks(self):
return self._content_blocks
@content_blocks.setter
def content_blocks(self, value):
do_check(value, 'content_blocks', type=ContentBlock)
self._content_blocks = value
@property
def result_id(self):
return self._result_id
@result_id.setter
def result_id(self, value):
do_check(value, 'result_id', regex_tuple=uri_regex, can_be_none=True)
self._result_id = value
@property
def destination_collection_names(self):
return self._destination_collection_names
@destination_collection_names.setter
def destination_collection_names(self, value):
do_check(value, 'destination_collection_names', regex_tuple=uri_regex)
self._destination_collection_names = value
@property
def record_count(self):
return self._record_count
@record_count.setter
def record_count(self, value):
do_check(value, 'record_count', type=RecordCount, can_be_none=True)
self._record_count = value
def to_etree(self):
xml = super(InboxMessage, self).to_etree()
if self.result_id is not None:
xml.attrib['result_id'] = self.result_id
for dcn in self.destination_collection_names:
d = etree.SubElement(xml, '{%s}Destination_Collection_Name' % ns_map['taxii_11'], nsmap=ns_map)
d.text = dcn
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii_11'])
m.text = self.message
if self.subscription_information is not None:
xml.append(self.subscription_information.to_etree())
if self.record_count is not None:
xml.append(self.record_count.to_etree())
for block in self.content_blocks:
xml.append(block.to_etree())
return xml
def to_dict(self):
d = super(InboxMessage, self).to_dict()
if self.result_id is not None:
d['result_id'] = self.result_id
d['destination_collection_names'] = []
for dcn in self.destination_collection_names:
d['destination_collection_names'].append(dcn)
if self.message is not None:
d['message'] = self.message
if self.subscription_information is not None:
d['subscription_information'] = self.subscription_information.to_dict()
if self.record_count is not None:
d['record_count'] = self.record_count.to_dict()
d['content_blocks'] = []
for block in self.content_blocks:
d['content_blocks'].append(block.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(InboxMessage, self).to_text(line_prepend)
if self.result_id:
s += line_prepend + " Result ID: %s\n" % self.result_id
for dcn in self.destination_collection_names:
s += line_prepend + " Destination Collection Name: %s\n" % dcn
s += line_prepend + " Message: %s\n" % self.message
if self.subscription_information:
s += self.subscription_information.to_text(line_prepend + STD_INDENT)
if self.record_count:
s += self.record_count.to_text(line_prepend + STD_INDENT)
s += line_prepend + " Message has %s Content Blocks\n" % len(self.content_blocks)
for cb in self.content_blocks:
s += cb.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
result_id_set = etree_xml.xpath('./@result_id')
if len(result_id_set) > 0:
kwargs['result_id'] = result_id_set[0]
kwargs['destination_collection_names'] = []
dcn_set = etree_xml.xpath('./taxii_11:Destination_Collection_Name', namespaces=ns_map)
for dcn in dcn_set:
kwargs['destination_collection_names'].append(dcn.text)
msg_set = etree_xml.xpath('./taxii_11:Message', namespaces=ns_map)
if len(msg_set) > 0:
kwargs['message'] = msg_set[0].text
subs_infos = etree_xml.xpath('./taxii_11:Source_Subscription', namespaces=ns_map)
if len(subs_infos) > 0:
kwargs['subscription_information'] = SubscriptionInformation.from_etree(subs_infos[0])
record_count_set = etree_xml.xpath('./taxii_11:Record_Count', namespaces=ns_map)
if len(record_count_set) > 0:
kwargs['record_count'] = RecordCount.from_etree(record_count_set[0])
content_blocks = etree_xml.xpath('./taxii_11:Content_Block', namespaces=ns_map)
kwargs['content_blocks'] = []
for block in content_blocks:
kwargs['content_blocks'].append(ContentBlock.from_etree(block))
msg = super(InboxMessage, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['result_id'] = d.get('result_id')
kwargs['destination_collection_names'] = []
if 'destination_collection_names' in d:
for dcn in d['destination_collection_names']:
kwargs['destination_collection_names'].append(dcn)
kwargs['message'] = d.get('message')
kwargs['subscription_information'] = None
if 'subscription_information' in d:
kwargs['subscription_information'] = SubscriptionInformation.from_dict(d['subscription_information'])
if 'record_count' in d:
kwargs['record_count'] = RecordCount.from_dict(d['record_count'])
kwargs['content_blocks'] = []
for block in d['content_blocks']:
kwargs['content_blocks'].append(ContentBlock.from_dict(block))
msg = super(InboxMessage, cls).from_dict(d, **kwargs)
return msg
class SubscriptionInformation(TAXIIBase11):
"""
The Subscription Information component of a TAXII Inbox message.
Arguments:
collection_name (str): the name of the TAXII Data Collection from
which this content is being provided. **Required**
subscription_id (str): the Subscription ID for which this
content is being provided. **Required**
exclusive_begin_timestamp_label (datetime): a Timestamp Label
indicating the beginning of the time range this Inbox Message
covers. **Optional for a Data Feed, Prohibited for a Data Set**
inclusive_end_timestamp_label (datetime): a Timestamp Label
indicating the end of the time range this Inbox Message covers.
**Optional for a Data Feed, Prohibited for a Data Set**
"""
def __init__(self, collection_name, subscription_id, exclusive_begin_timestamp_label=None, inclusive_end_timestamp_label=None):
self.collection_name = collection_name
self.subscription_id = subscription_id
self.exclusive_begin_timestamp_label = exclusive_begin_timestamp_label
self.inclusive_end_timestamp_label = inclusive_end_timestamp_label
@property
def collection_name(self):
return self._collection_name
@collection_name.setter
def collection_name(self, value):
do_check(value, 'collection_name', regex_tuple=uri_regex)
self._collection_name = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex)
self._subscription_id = value
@property
def exclusive_begin_timestamp_label(self):
return self._exclusive_begin_timestamp_label
@exclusive_begin_timestamp_label.setter
def exclusive_begin_timestamp_label(self, value):
value = check_timestamp_label(value, 'exclusive_begin_timestamp_label', can_be_none=True)
self._exclusive_begin_timestamp_label = value
@property
def inclusive_end_timestamp_label(self):
return self._inclusive_end_timestamp_label
@inclusive_end_timestamp_label.setter
def inclusive_end_timestamp_label(self, value):
value = check_timestamp_label(value, 'inclusive_end_timestamp_label', can_be_none=True)
self._inclusive_end_timestamp_label = value
def to_etree(self):
xml = etree.Element('{%s}Source_Subscription' % ns_map['taxii_11'])
xml.attrib['collection_name'] = self.collection_name
si = etree.SubElement(xml, '{%s}Subscription_ID' % ns_map['taxii_11'])
si.text = self.subscription_id
if self.exclusive_begin_timestamp_label:
ebtl = etree.SubElement(xml, '{%s}Exclusive_Begin_Timestamp' % ns_map['taxii_11'])
ebtl.text = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label:
ietl = etree.SubElement(xml, '{%s}Inclusive_End_Timestamp' % ns_map['taxii_11'])
ietl.text = self.inclusive_end_timestamp_label.isoformat()
return xml
def to_dict(self):
d = {}
d['collection_name'] = self.collection_name
d['subscription_id'] = self.subscription_id
if self.exclusive_begin_timestamp_label:
d['exclusive_begin_timestamp_label'] = self.exclusive_begin_timestamp_label.isoformat()
if self.inclusive_end_timestamp_label:
d['inclusive_end_timestamp_label'] = self.inclusive_end_timestamp_label.isoformat()
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Source Subscription ===\n"
s += line_prepend + " Collection Name: %s\n" % self.collection_name
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
if self.exclusive_begin_timestamp_label:
s += line_prepend + " Excl. Begin TS Label: %s\n" % self.exclusive_begin_timestamp_label.isoformat()
else:
s += line_prepend + " Excl. Begin TS Label: %s\n" % None
if self.inclusive_end_timestamp_label:
s += line_prepend + " Incl. End TS Label: %s\n" % self.inclusive_end_timestamp_label.isoformat()
else:
s += line_prepend + " Incl. End TS Label: %s\n" % None
return s
@staticmethod
def from_etree(etree_xml):
collection_name = etree_xml.attrib['collection_name']
subscription_id = get_required(etree_xml, './taxii_11:Subscription_ID', ns_map).text
begin_ts_text = get_optional_text(etree_xml, './taxii_11:Exclusive_Begin_Timestamp', ns_map)
ebtl = parse_datetime_string(begin_ts_text) if begin_ts_text else None
end_ts_text = get_optional_text(etree_xml, './taxii_11:Inclusive_End_Timestamp', ns_map)
ietl = parse_datetime_string(end_ts_text) if end_ts_text else None
return SubscriptionInformation(collection_name, subscription_id, ebtl, ietl)
@staticmethod
def from_dict(d):
collection_name = d['collection_name']
subscription_id = d['subscription_id']
ebtl = parse_datetime_string(d.get('exclusive_begin_timestamp_label'))
ietl = parse_datetime_string(d.get('inclusive_end_timestamp_label'))
return SubscriptionInformation(collection_name, subscription_id, ebtl, ietl)
class ManageCollectionSubscriptionRequest(TAXIIRequestMessage):
"""
A TAXII Manage Collection Subscription Request message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
collection_name (str): the name of the TAXII Data Collection to which the
action applies. **Required**
action (str): the requested action to take. **Required**
subscription_id (str): the ID of a previously created subscription.
**Probibited** if ``action==``:py:data:`ACT_SUBSCRIBE`, else
**Required**
subscription_parameters (SubscriptionParameters): The parameters for
this subscription. **Optional**
push_parameters (list of PushParameter): the push parameters for this
request. **Optional** Absence means push is not requested.
"""
message_type = MSG_MANAGE_COLLECTION_SUBSCRIPTION_REQUEST
def __init__(self, message_id, extended_headers=None,
collection_name=None, action=None, subscription_id=None,
subscription_parameters=None, push_parameters=None):
super(ManageCollectionSubscriptionRequest, self).__init__(message_id, extended_headers=extended_headers)
self.collection_name = collection_name
self.action = action
self.subscription_id = subscription_id
self.subscription_parameters = subscription_parameters or SubscriptionParameters()
self.push_parameters = push_parameters
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
if value is not None:
raise ValueError('in_response_to must be None')
self._in_response_to = value
@property
def collection_name(self):
return self._collection_name
@collection_name.setter
def collection_name(self, value):
do_check(value, 'collection_name', regex_tuple=uri_regex)
self._collection_name = value
@property
def action(self):
return self._action
@action.setter
def action(self, value):
do_check(value, 'action', value_tuple=ACT_TYPES)
self._action = value
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex, can_be_none=True)
self._subscription_id = value
@property
def subscription_parameters(self):
return self._subscription_parameters
@subscription_parameters.setter
def subscription_parameters(self, value):
do_check(value, 'subscription_parameters', type=SubscriptionParameters, can_be_none=True)
self._subscription_parameters = value
@property
def push_parameters(self):
return self._push_parameters
@push_parameters.setter
def push_parameters(self, value):
do_check(value, 'push_parameters', type=PushParameters, can_be_none=True)
self._push_parameters = value
def to_etree(self):
xml = super(ManageCollectionSubscriptionRequest, self).to_etree()
xml.attrib['collection_name'] = self.collection_name
xml.attrib['action'] = self.action
if self.subscription_id is not None:
si = etree.SubElement(xml, '{%s}Subscription_ID' % ns_map['taxii_11'])
si.text = self.subscription_id
if self.action == ACT_SUBSCRIBE:
xml.append(self.subscription_parameters.to_etree())
if self.action == ACT_SUBSCRIBE and self.push_parameters:
xml.append(self.push_parameters.to_etree())
return xml
def to_dict(self):
d = super(ManageCollectionSubscriptionRequest, self).to_dict()
d['collection_name'] = self.collection_name
d['action'] = self.action
if self.subscription_id is not None:
d['subscription_id'] = self.subscription_id
if self.action == ACT_SUBSCRIBE:
d['subscription_parameters'] = self.subscription_parameters.to_dict()
if self.action == ACT_SUBSCRIBE and self.push_parameters:
d['push_parameters'] = self.push_parameters.to_dict()
return d
def to_text(self, line_prepend=''):
s = super(ManageCollectionSubscriptionRequest, self).to_text(line_prepend)
s += line_prepend + " Collection Name: %s\n" % self.collection_name
s += line_prepend + " Action: %s\n" % self.action
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
if self.action == ACT_SUBSCRIBE:
s += self.subscription_parameters.to_text(line_prepend + STD_INDENT)
if self.action == ACT_SUBSCRIBE and self.push_parameters:
s += self.push_parameters.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['collection_name'] = get_required(etree_xml, './@collection_name', ns_map)
kwargs['action'] = get_required(etree_xml, './@action', ns_map)
kwargs['subscription_id'] = get_optional_text(etree_xml, './taxii_11:Subscription_ID', ns_map)
subscription_parameters_el = get_optional(etree_xml, './taxii_11:Subscription_Parameters', ns_map)
if subscription_parameters_el is not None:
kwargs['subscription_parameters'] = SubscriptionParameters.from_etree(subscription_parameters_el)
push_parameters_el = get_optional(etree_xml, './taxii_11:Push_Parameters', ns_map)
if push_parameters_el is not None:
kwargs['push_parameters'] = PushParameters.from_etree(push_parameters_el)
msg = super(ManageCollectionSubscriptionRequest, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['collection_name'] = d['collection_name']
kwargs['action'] = d['action']
kwargs['subscription_id'] = d.get('subscription_id')
kwargs['subscription_parameters'] = None
if 'subscription_parameters' in d:
kwargs['subscription_parameters'] = SubscriptionParameters.from_dict(d['subscription_parameters'])
kwargs['push_parameters'] = None
if 'push_parameters' in d:
kwargs['push_parameters'] = PushParameters.from_dict(d['push_parameters'])
msg = super(ManageCollectionSubscriptionRequest, cls).from_dict(d, **kwargs)
return msg
class ManageCollectionSubscriptionResponse(TAXIIMessage):
"""
A TAXII Manage Collection Subscription Response message.
Args:
message_id (str): A value identifying this message. **Required**
in_response_to (str): Contains the Message ID of the message to
which this is a response. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
collection_name (str): the name of the TAXII Data Collection to which
the action applies. **Required**
message (str): additional information for the message recipient.
**Optional**
subscription_instances (list of SubscriptionInstance): **Optional**
"""
message_type = MSG_MANAGE_COLLECTION_SUBSCRIPTION_RESPONSE
def __init__(self, message_id, in_response_to, extended_headers=None, collection_name=None, message=None, subscription_instances=None):
super(ManageCollectionSubscriptionResponse, self).__init__(message_id, in_response_to, extended_headers=extended_headers)
self.collection_name = collection_name
self.message = message
self.subscription_instances = subscription_instances or []
@TAXIIMessage.in_response_to.setter
def in_response_to(self, value):
do_check(value, 'in_response_to', regex_tuple=uri_regex)
self._in_response_to = value
@property
def collection_name(self):
return self._collection_name
@collection_name.setter
def collection_name(self, value):
do_check(value, 'collection_name', regex_tuple=uri_regex)
self._collection_name = value
@property
def subscription_instances(self):
return self._subscription_instances
@subscription_instances.setter
def subscription_instances(self, value):
do_check(value, 'subscription_instances', type=SubscriptionInstance)
self._subscription_instances = value
def to_etree(self):
xml = super(ManageCollectionSubscriptionResponse, self).to_etree()
xml.attrib['collection_name'] = self.collection_name
if self.message is not None:
m = etree.SubElement(xml, '{%s}Message' % ns_map['taxii_11'])
m.text = self.message
for subscription_instance in self.subscription_instances:
xml.append(subscription_instance.to_etree())
return xml
def to_dict(self):
d = super(ManageCollectionSubscriptionResponse, self).to_dict()
d['collection_name'] = self.collection_name
if self.message is not None:
d['message'] = self.message
d['subscription_instances'] = []
for subscription_instance in self.subscription_instances:
d['subscription_instances'].append(subscription_instance.to_dict())
return d
def to_text(self, line_prepend=''):
s = super(ManageCollectionSubscriptionResponse, self).to_text(line_prepend)
s += line_prepend + " Collection Name: %s\n" % self.collection_name
s += line_prepend + " Message: %s\n" % self.message
for si in self.subscription_instances:
s += si.to_text(line_prepend + STD_INDENT)
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['collection_name'] = etree_xml.attrib['collection_name']
kwargs['message'] = get_optional_text(etree_xml, './taxii_11:Message', ns_map)
kwargs['subscription_instances'] = []
for si in etree_xml.xpath('./taxii_11:Subscription', namespaces=ns_map):
kwargs['subscription_instances'].append(SubscriptionInstance.from_etree(si))
msg = super(ManageCollectionSubscriptionResponse, cls).from_etree(etree_xml, **kwargs)
return msg
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['collection_name'] = d['collection_name']
kwargs['message'] = d.get('message')
kwargs['subscription_instances'] = []
for instance in d['subscription_instances']:
kwargs['subscription_instances'].append(SubscriptionInstance.from_dict(instance))
msg = super(ManageCollectionSubscriptionResponse, cls).from_dict(d, **kwargs)
return msg
class SubscriptionInstance(TAXIIBase11):
"""
The Subscription Instance component of the Manage Collection Subscription
Response message.
Args:
subscription_id (str): the id of the subscription. **Required**
status (str): One of :py:data:`SS_ACTIVE`, :py:data:`SS_PAUSED`, or
:py:data:`SS_UNSUBSCRIBED`. **Optional**, defaults to "ACTIVE"
subscription_parameters (SubscriptionParameters): the parameters
for this subscription. **Optional** If provided, should match
the request.
push_parameters (PushParameters): the push parameters for this
subscription. **Optional** If provided, should match the request.
poll_instances (list of PollInstance): The Poll Services that can be
polled to fulfill this subscription. **Optional**
"""
def __init__(self, subscription_id, status=SS_ACTIVE,
subscription_parameters=None, push_parameters=None,
poll_instances=None):
self.subscription_id = subscription_id
self.status = status
self.subscription_parameters = subscription_parameters
self.push_parameters = push_parameters
self.poll_instances = poll_instances or []
@property
def sort_key(self):
return self.subscription_id
@property
def subscription_id(self):
return self._subscription_id
@subscription_id.setter
def subscription_id(self, value):
do_check(value, 'subscription_id', regex_tuple=uri_regex)
self._subscription_id = value
@property
def status(self):
return self._status
@status.setter
def status(self, value):
do_check(value, 'status', value_tuple=SS_TYPES, can_be_none=True)
self._status = value
@property
def subscription_parameters(self):
return self._subscription_parameters
@subscription_parameters.setter
def subscription_parameters(self, value):
do_check(value, 'subscription_parameters', type=SubscriptionParameters, can_be_none=True)
self._subscription_parameters = value
@property
def push_parameters(self):
return self._push_parameters
@push_parameters.setter
def push_parameters(self, value):
do_check(value, 'push_parameters', type=PushParameters, can_be_none=True)
self._push_parameters = value
@property
def poll_instances(self):
return self._poll_instances
@poll_instances.setter
def poll_instances(self, value):
do_check(value, 'poll_instances', type=PollInstance)
self._poll_instances = value
def to_etree(self):
si = etree.Element('{%s}Subscription' % ns_map['taxii_11'], nsmap=ns_map)
if self.status is not None:
si.attrib['status'] = self.status
subs_id = etree.SubElement(si, '{%s}Subscription_ID' % ns_map['taxii_11'])
subs_id.text = self.subscription_id
if self.subscription_parameters is not None:
si.append(self.subscription_parameters.to_etree())
if self.push_parameters is not None:
si.append(self.push_parameters.to_etree())
for pi in self.poll_instances:
si.append(pi.to_etree())
return si
def to_dict(self):
d = {}
d['status'] = self.status
d['subscription_id'] = self.subscription_id
d['subscription_parameters'] = None
if self.subscription_parameters is not None:
d['subscription_parameters'] = self.subscription_parameters.to_dict()
d['push_parameters'] = None
if self.push_parameters is not None:
d['push_parameters'] = self.push_parameters.to_dict()
d['poll_instances'] = []
for pi in self.poll_instances:
d['poll_instances'].append(pi.to_dict())
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Subscription Instance ===\n"
s += line_prepend + " Status: %s\n" % self.status
s += line_prepend + " Subscription ID: %s\n" % self.subscription_id
if self.subscription_parameters:
s += self.subscription_parameters.to_text(line_prepend + STD_INDENT)
if self.push_parameters:
s += self.push_parameters.to_text(line_prepend + STD_INDENT)
for pi in self.poll_instances:
s += pi.to_text(line_prepend + STD_INDENT)
return s
@staticmethod
def from_etree(etree_xml):
status = get_optional(etree_xml, './@status', ns_map)
subscription_id = get_required(etree_xml, './taxii_11:Subscription_ID', ns_map).text
subscription_parameters = None
subscription_parameters_el = get_optional(etree_xml, './taxii_11:Subscription_Parameters', ns_map)
if subscription_parameters_el is not None:
subscription_parameters = SubscriptionParameters.from_etree(subscription_parameters_el)
push_parameters = None
push_parameters_el = get_optional(etree_xml, './taxii_11:Push_Parameters', ns_map)
if push_parameters_el is not None:
push_parameters = PushParameters.from_etree(push_parameters_el)
poll_instances = []
for pi in etree_xml.xpath('./taxii_11:Poll_Instance', namespaces=ns_map):
poll_instances.append(PollInstance.from_etree(pi))
return SubscriptionInstance(subscription_id, status, subscription_parameters, push_parameters, poll_instances)
@staticmethod
def from_dict(d):
subscription_id = d['subscription_id']
status = d.get('status')
subscription_parameters = None
if d.get('subscription_parameters') is not None:
subscription_parameters = SubscriptionParameters.from_dict(d['subscription_parameters'])
push_parameters = None
if d.get('push_parameters') is not None:
push_parameters = PushParameters.from_dict(d['push_parameters'])
poll_instances = []
if 'poll_instances' in d:
for pi in d['poll_instances']:
poll_instances.append(PollInstance.from_dict(pi))
return SubscriptionInstance(subscription_id, status, subscription_parameters, push_parameters, poll_instances)
class PollInstance(TAXIIBase11):
"""
The Poll Instance component of the Manage Collection Subscription
Response message.
Args:
poll_protocol (str): The protocol binding supported by this
instance of a Polling Service. **Required**
poll_address (str): the address of the TAXII Daemon hosting
this Poll Service. **Required**
poll_message_bindings (list of str): one or more message bindings
that can be used when interacting with this Poll Service
instance. **Required**
"""
def __init__(self, poll_protocol, poll_address, poll_message_bindings=None):
self.poll_protocol = poll_protocol
self.poll_address = poll_address
self.poll_message_bindings = poll_message_bindings or []
@property
def sort_key(self):
return self.poll_address
@property
def poll_protocol(self):
return self._poll_protocol
@poll_protocol.setter
def poll_protocol(self, value):
do_check(value, 'poll_protocol', regex_tuple=uri_regex)
self._poll_protocol = value
@property
def poll_message_bindings(self):
return self._poll_message_bindings
@poll_message_bindings.setter
def poll_message_bindings(self, value):
do_check(value, 'poll_message_bindings', regex_tuple=uri_regex)
self._poll_message_bindings = value
def to_etree(self):
xml = etree.Element('{%s}Poll_Instance' % ns_map['taxii_11'])
pb = etree.SubElement(xml, '{%s}Protocol_Binding' % ns_map['taxii_11'])
pb.text = self.poll_protocol
a = etree.SubElement(xml, '{%s}Address' % ns_map['taxii_11'])
a.text = self.poll_address
for binding in self.poll_message_bindings:
b = etree.SubElement(xml, '{%s}Message_Binding' % ns_map['taxii_11'])
b.text = binding
return xml
def to_dict(self):
d = {}
d['poll_protocol'] = self.poll_protocol
d['poll_address'] = self.poll_address
d['poll_message_bindings'] = []
for binding in self.poll_message_bindings:
d['poll_message_bindings'].append(binding)
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Poll Instance ===\n"
s += line_prepend + " Protocol Binding: %s\n" % self.poll_protocol
s += line_prepend + " Address: %s\n" % self.poll_address
for mb in self.poll_message_bindings:
s += line_prepend + " Message Binding: %s\n" % mb
return s
@staticmethod
def from_etree(etree_xml):
poll_protocol = get_required(etree_xml, './taxii_11:Protocol_Binding', ns_map).text
address = get_required(etree_xml, './taxii_11:Address', ns_map).text
poll_message_bindings = []
for b in etree_xml.xpath('./taxii_11:Message_Binding', namespaces=ns_map):
poll_message_bindings.append(b.text)
return PollInstance(poll_protocol, address, poll_message_bindings)
@staticmethod
def from_dict(d):
return PollInstance(**d)
class PollFulfillmentRequest(TAXIIRequestMessage):
"""
A TAXII Poll Fulfillment Request message.
Args:
message_id (str): A value identifying this message. **Required**
extended_headers (dict): A dictionary of name/value pairs for
use as Extended Headers. **Optional**
collection_name (str): the name of the TAXII Data Collection to which the
action applies. **Required**
result_id (str): The result id of the requested result. **Required**
result_part_number (int): The part number being requested. **Required**
"""
message_type = MSG_POLL_FULFILLMENT_REQUEST
def __init__(self, message_id, extended_headers=None,
collection_name=None, result_id=None, result_part_number=None):
super(PollFulfillmentRequest, self).__init__(message_id, extended_headers=extended_headers)
self.collection_name = collection_name
self.result_id = result_id
self.result_part_number = result_part_number
@property
def collection_name(self):
return self._collection_name
@collection_name.setter
def collection_name(self, value):
do_check(value, 'collection_name', regex_tuple=uri_regex)
self._collection_name = value
@property
def result_id(self):
return self._result_id
@result_id.setter
def result_id(self, value):
do_check(value, 'result_id', regex_tuple=uri_regex)
self._result_id = value
@property
def result_part_number(self):
return self._result_part_number
@result_part_number.setter
def result_part_number(self, value):
do_check(value, 'result_part_number', type=int)
self._result_part_number = value
def to_etree(self):
xml = super(PollFulfillmentRequest, self).to_etree()
xml.attrib['collection_name'] = self.collection_name
xml.attrib['result_id'] = self.result_id
xml.attrib['result_part_number'] = str(self.result_part_number)
return xml
def to_dict(self):
d = super(PollFulfillmentRequest, self).to_dict()
d['collection_name'] = self.collection_name
d['result_id'] = self.result_id
d['result_part_number'] = self.result_part_number
return d
def to_text(self, line_prepend=''):
s = super(PollFulfillmentRequest, self).to_text(line_prepend)
s += line_prepend + " Collection Name: %s\n" % self.collection_name
s += line_prepend + " Result ID: %s\n" % self.result_id
s += line_prepend + " Result Part Number: %s\n" % self.result_part_number
return s
@classmethod
def from_etree(cls, etree_xml):
kwargs = {}
kwargs['collection_name'] = etree_xml.attrib['collection_name']
kwargs['result_id'] = etree_xml.attrib['result_id']
kwargs['result_part_number'] = int(etree_xml.attrib['result_part_number'])
return super(PollFulfillmentRequest, cls).from_etree(etree_xml, **kwargs)
@classmethod
def from_dict(cls, d):
kwargs = {}
kwargs['collection_name'] = d['collection_name']
kwargs['result_id'] = d['result_id']
kwargs['result_part_number'] = int(d['result_part_number'])
return super(PollFulfillmentRequest, cls).from_dict(d, **kwargs)
########################################################
# EVERYTHING BELOW HERE IS FOR BACKWARDS COMPATIBILITY #
########################################################
# Add top-level classes as nested classes for backwards compatibility
DiscoveryResponse.ServiceInstance = ServiceInstance
CollectionInformationResponse.CollectionInformation = CollectionInformation
CollectionInformation.PushMethod = PushMethod
CollectionInformation.PollingServiceInstance = PollingServiceInstance
CollectionInformation.SubscriptionMethod = SubscriptionMethod
CollectionInformation.ReceivingInboxService = ReceivingInboxService
ManageCollectionSubscriptionResponse.PollInstance = PollInstance
ManageCollectionSubscriptionResponse.SubscriptionInstance = SubscriptionInstance
PollRequest.PollParameters = PollParameters
InboxMessage.SubscriptionInformation = SubscriptionInformation
# Constants not imported in `from constants import *`
MSG_TYPES = MSG_TYPES_11
ST_TYPES = ST_TYPES_11
ACT_TYPES = ACT_TYPES_11
SS_TYPES = SS_TYPES_11
RT_TYPES = RT_TYPES_11
CT_TYPES = CT_TYPES_11
SVC_TYPES = SVC_TYPES_11
SD_TYPES = SD_TYPES_11
from .common import (generate_message_id)
libtaxii-1.1.119/libtaxii/scripts/ 0000775 0000000 0000000 00000000000 14036072565 0016775 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/scripts/__init__.py 0000664 0000000 0000000 00000042032 14036072565 0021107 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import argparse
import io
import os
import sys
import traceback
import datetime
import libtaxii.clients as tc
import six
from six.moves.configparser import SafeConfigParser
from six.moves.urllib.parse import urlparse
import libtaxii as t
from libtaxii.common import gen_filename
from libtaxii.constants import *
EXIT_SUCCESS = 0
EXIT_FAILURE = 1
#: When writing content blocks, clobber any existing files
W_CLOBBER = 0
#: When writing content blocks, skip any existing files
W_SKIP = 1
#: When writing content blocks, prompt before clobbering any existing files
W_PROMPT = 2
#: Do not write any files
W_NONE = 3
W_CHOICES = (W_CLOBBER, W_PROMPT, W_SKIP, W_NONE)
MSG_FILE_OVERWRITTEN = "File overwritten: "
MSG_FILE_SKIPPED = "File write skipped: "
MSG_FILE_CREATED = "File created: "
def write_type(s):
s = s.lower()
if s == 'clobber':
return W_CLOBBER
elif s == 'skip':
return W_SKIP
elif s == 'prompt':
return W_PROMPT
elif s == 'none':
return W_NONE
else:
raise ValueError('Argument must be one of \'clobber\', \'skip\', \'prompt\', or \'none\'')
def add_poll_response_args(parser):
"""
Adds arguments to the parser that are commonly used for handling Poll Response messages:
- --dest-dir
- --write
:param parser:
:return:
"""
parser.add_argument("--dest-dir",
dest="dest_dir",
default="",
help="The directory to save Content Blocks to. Defaults to the current directory.")
parser.add_argument("--write",
dest="write_type",
default='clobber',
type=write_type,
help="The write type. Must be one of \'clobber\', \'skip\', \'prompt\', or \'none\'. Defaults "
"to \'clobber\'")
class ArgParserConfig(SafeConfigParser):
def as_args(self, section, raw=False, vars=None):
"""
Returns format friendly list for parse_args e.g., ["--url", "http://hailataxii.com:80", "--arg1", "something"]
"""
arg_list = []
for arg, val in self.items(section, raw, vars):
arg_list.append("--" + arg)
arg_list.append(val)
return arg_list
class ProxyAction(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
"""
Turns the 'None' string argument into the None object
that the API expects.
"""
if option_string == "--proxy" and values == "None":
values = None
setattr(namespace, self.dest, values)
class LoadFromFile(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
config_file = ArgParserConfig()
with values as f:
config_file.readfp(f)
# Overrides initial values if present on config file
parser.parse_known_args(config_file.as_args('libtaxii'), namespace=namespace)
class TaxiiScript(object):
#: taxii version to put in the request headers. Defaults to TAXII 1.1
taxii_version = VID_TAXII_XML_11
#: parser description
parser_description = ''
#: default path
path = '/'
def get_arg_parser(self,
parser_description,
path="/taxii-discovery-service",
host="hailataxii.com",
port="80",
https=False,
cert=None,
key=None,
username=None,
password=None,
proxy='noproxy',
xml_output=False,
from_file=None,
verify_server=None):
"""
Parser things common to all scripts. Parsers for specific TAXII Services should
add their own arguments.
"""
parser = argparse.ArgumentParser(description=parser_description)
url = "https" if https else "http" + "://" + host + ":" + str(port) + path
parser.add_argument("-u",
"--url",
dest="url",
default=url,
help="The URL to connect to. Defaults to %s." % url)
parser.add_argument("--host",
dest="host",
default=host,
help=argparse.SUPPRESS
)
parser.add_argument("--port",
dest="port",
default=port,
type=int,
help=argparse.SUPPRESS)
parser.add_argument("--path",
dest="path",
default=path,
help=argparse.SUPPRESS)
parser.add_argument("--https",
dest="https",
default=https,
type=bool,
help=argparse.SUPPRESS)
parser.add_argument("--cert",
dest="cert",
default=cert,
help="The file location of the certificate to use. Defaults to %s." % cert)
parser.add_argument("--key",
dest="key",
default=key,
help="The file location of the private key to use. Defaults to %s." % key)
parser.add_argument("--username",
dest="username",
default=username,
help="The username to authenticate with. Defaults to %s." % username)
parser.add_argument("--pass",
dest="password",
default=password,
help="The password to authenticate with. Defaults to %s." % password)
parser.add_argument("--proxy",
dest="proxy",
action=ProxyAction, default=proxy,
help="The proxy to use (e.g., http://myproxy.example.com:80/), or 'noproxy' to not use "
"any proxy. If omitted, 'noproxy' will be used.")
parser.add_argument("--xml-output",
dest="xml_output",
action='store_true',
default=xml_output,
help="If present, the raw XML of the response will be printed to standard out. "
"Otherwise, a \"Rich\" output will be presented.")
parser.add_argument("--from-file",
dest="from_file",
action=LoadFromFile,
default=from_file,
type=open,
help="Use a configuration file to load arguments into the script. The contents of the "
"configuration file will take precedence over passed flags.")
parser.add_argument("--verify-server",
dest="verify_server",
action="store",
default=verify_server,
metavar="CA-ROOT-FILE",
help="Specify ca-bundle file to verify server-side certification. "
"None (default) implies not to verify.")
return parser
def handle_response(self, response, args):
"""
Default response handler. Just prints the response
"""
print("Response:\n")
if args.xml_output is False:
print(response.to_text())
else:
print(response.to_xml(pretty_print=True))
def create_client(self, use_https, proxy, cert=None, key=None, username=None, password=None, verify_server=None):
client = tc.HttpClient()
client.set_use_https(use_https)
client.set_proxy(proxy)
tls = (cert is not None and key is not None)
basic = (username is not None and password is not None)
if tls and basic:
client.set_auth_type(tc.HttpClient.AUTH_CERT_BASIC)
client.set_auth_credentials({'key_file': key,
'cert_file': cert,
'username': username,
'password': password})
elif tls:
client.set_auth_type(tc.HttpClient.AUTH_CERT)
client.set_auth_credentials({'key_file': key, 'cert_file': cert})
elif basic:
client.set_auth_type(tc.HttpClient.AUTH_BASIC)
client.set_auth_credentials({'username': username, 'password': password})
if verify_server is not None:
client.set_verify_server(verify_server=True, ca_file=verify_server)
return client
@staticmethod
def get_write_and_message(filename, write_type_):
"""
Depending on whether the file exists and the write_type, decide whether the file should be created or not
and provide a message to be printed out to the user.
"""
file_exists = os.path.exists(filename)
if file_exists and write_type_ == W_CLOBBER:
write = True
message = MSG_FILE_OVERWRITTEN
elif file_exists and write_type_ == W_PROMPT:
var = None
while var not in ('y', 'n'):
var = six.moves.input("Overwrite file (%s)? (y/n): " % filename)
if var == 'y':
write = True
message = MSG_FILE_OVERWRITTEN
else:
write = False
message = MSG_FILE_SKIPPED
elif not file_exists and write_type_ in (W_CLOBBER, W_PROMPT):
write = True
message = MSG_FILE_CREATED
elif write_type_ in (W_SKIP, W_NONE): # This happens no matter if the file exists or not
write = False
message = MSG_FILE_SKIPPED
else:
raise ValueError("Unknown combination of file_exists (%s) and write_type (%s)" % (file_exists, write_type_))
return write, message
def write_cbs_from_poll_response_10(self, poll_response, dest_dir, write_type_=W_CLOBBER):
"""
This function writes content blocks to file from a TAXII 1.0 Poll Response
"""
for cb in poll_response.content_blocks:
if cb.content_binding == CB_STIX_XML_10:
format_ = '_STIX10_'
ext = '.xml'
elif cb.content_binding == CB_STIX_XML_101:
format_ = '_STIX101_'
ext = '.xml'
elif cb.content_binding == CB_STIX_XML_11:
format_ = '_STIX11_'
ext = '.xml'
elif cb.content_binding == CB_STIX_XML_111:
format_ = '_STIX111_'
ext = '.xml'
elif cb.content_binding == CB_STIX_XML_12:
format_ = '_STIX12_'
ext = '.xml'
else: # Format and extension are unknown
format_ = ''
ext = ''
if cb.timestamp_label:
date_string = 't' + cb.timestamp_label.isoformat()
else:
date_string = 's' + datetime.datetime.now().isoformat()
filename = gen_filename(
poll_response.collection_name,
format_,
date_string,
ext
)
filename = os.path.join(dest_dir, filename)
write, message = TaxiiScript.get_write_and_message(filename, write_type_)
if write:
with io.open(filename, 'wb') as f:
f.write(cb.content)
print("%s%s" % (message, filename))
def write_cbs_from_poll_response_11(self, poll_response, dest_dir, write_type_=W_CLOBBER):
"""
This function writes content blocks to file from a TAXII 1.1 Poll Response
"""
for cb in poll_response.content_blocks:
if cb.content_binding.binding_id == CB_STIX_XML_10:
format_ = '_STIX10_'
ext = '.xml'
elif cb.content_binding.binding_id == CB_STIX_XML_101:
format_ = '_STIX101_'
ext = '.xml'
elif cb.content_binding.binding_id == CB_STIX_XML_11:
format_ = '_STIX11_'
ext = '.xml'
elif cb.content_binding.binding_id == CB_STIX_XML_111:
format_ = '_STIX111_'
ext = '.xml'
elif cb.content_binding.binding_id == CB_STIX_XML_12:
format_ = '_STIX12_'
ext = '.xml'
else: # Format and extension are unknown
format_ = ''
ext = ''
if cb.timestamp_label:
date_string = 't' + cb.timestamp_label.isoformat()
else:
date_string = 's' + datetime.datetime.now().isoformat()
filename = gen_filename(
poll_response.collection_name,
format_,
date_string,
ext
)
filename = os.path.join(dest_dir, filename)
write, message = TaxiiScript.get_write_and_message(filename, write_type_)
if write:
with io.open(filename, 'wb') as f:
f.write(cb.content)
print("%s%s" % (message, filename))
def create_request_message(self, args):
"""
This function should create a request message.
Should be implemented by child classes.
"""
raise NotImplementedError
@staticmethod
def _parse_url_info(args, parser):
"""
In libtaxii 1.1.106, the command line args --port, --path, --host, and --https were deprecated in favor of
--url. This function performs the following actions:
1. Print a warning if any deprecated arguments are used (i.e., not one of the defaults).
2. Raise a ValueError if --url is used in combination with any deprecated argument
3. If deprecated arguments were used, translate them into the --url argument
"""
deprecated_args = ['port', 'path', 'host', 'https']
deprecated_arg_used = False
for arg in deprecated_args:
if str(getattr(args, arg)) != str(parser._optionals.get_default(arg)):
print("WARNING: use of deprecated argument: %s. Use --url instead!" % arg)
deprecated_arg_used = True
url_used = getattr(args, 'url') != parser._optionals.get_default('url')
if url_used and deprecated_arg_used:
raise ValueError("Error: Both --url and a deprecated argument was used. Please use one or the other!")
if deprecated_arg_used:
url = "https" if args.https else "http" + "://" + args.host + ":" + str(args.port) + args.path
args.url = url
print("Deprecated arguments transformed into: '--url %s'" % url)
def __call__(self):
"""
Invoke a TAXII Service based on the arguments
"""
try:
parser = self.get_arg_parser(parser_description=self.parser_description, path=self.path)
args = parser.parse_args()
TaxiiScript._parse_url_info(args, parser)
request_message = self.create_request_message(args)
url = urlparse(args.url)
client = self.create_client(url.scheme == 'https',
args.proxy,
args.cert,
args.key,
args.username,
args.password,
args.verify_server)
print("Request:\n")
if args.xml_output is False:
print(request_message.to_text())
else:
print(request_message.to_xml(pretty_print=True))
resp = client.call_taxii_service2(url.hostname,
url.path,
self.taxii_version,
request_message.to_xml(pretty_print=True),
url.port)
r = t.get_message_from_http_response(resp, '0')
self.handle_response(r, args)
except Exception as ex:
traceback.print_exc()
sys.exit(EXIT_FAILURE)
sys.exit(EXIT_SUCCESS)
# TODO: These are stubs that will eventually need to be moved out into their own files / scripts
class SubscriptionClient11Script(TaxiiScript):
parser_description = 'TAXII 1.1 Subscription Management Client'
path = '/services/collection-management/'
class SubscriptionClient10Script(TaxiiScript):
taxii_version = VID_TAXII_XML_10
parser_description = 'TAXII 1.0 Subscription Management Client'
path = '/services/feed-management/'
# No poll fulfillment in TAXII 1.0
libtaxii-1.1.119/libtaxii/scripts/collection_information_client.py 0000664 0000000 0000000 00000001623 14036072565 0025447 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import libtaxii.messages_11 as tm11
from libtaxii.scripts import TaxiiScript
class CollectionInformationClient11Script(TaxiiScript):
"""Collection Information Request Client"""
parser_description = \
'The TAXII 1.1 Collection Information Client sends a Collection Information Request ' \
'to a TAXII Server and then prints the resulting Collection Information Response to ' \
'standard out.'
path = '/taxii-data'
def create_request_message(self, args):
message_id = tm11.generate_message_id()
return tm11.CollectionInformationRequest(message_id)
def main():
"""Send a Collection Information Request to a Taxii 1.0 Service"""
script = CollectionInformationClient11Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/discovery_client.py 0000775 0000000 0000000 00000001361 14036072565 0022720 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
from libtaxii.scripts import TaxiiScript
import libtaxii.messages_11 as tm11
import libtaxii.taxii_default_query as tdq
class DiscoveryClient11Script(TaxiiScript):
parser_description = 'The TAXII 1.1 Discovery Client sends a Discovery Request message to a TAXII Server and ' \
'prints out the Discovery Response message to standard out.'
path = '/taxii-discovery-service'
def create_request_message(self, args):
return tm11.DiscoveryRequest(message_id=tm11.generate_message_id())
def main():
script = DiscoveryClient11Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/discovery_client_10.py 0000664 0000000 0000000 00000001466 14036072565 0023223 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
from libtaxii.scripts import TaxiiScript
import libtaxii.messages_10 as tm10
from libtaxii.common import generate_message_id
from libtaxii.constants import *
class DiscoveryClient10Script(TaxiiScript):
taxii_version = VID_TAXII_XML_10
parser_description = 'The TAXII 1.0 Discovery Client sends a Discovery Request message to a TAXII Server and ' \
'prints out the Discovery Response message to standard out.'
path = '/taxii-discovery-service'
def create_request_message(self, args):
return tm10.DiscoveryRequest(message_id=generate_message_id())
def main():
script = DiscoveryClient10Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/feed_information_client_10.py 0000664 0000000 0000000 00000001670 14036072565 0024521 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import libtaxii.messages_10 as tm10
from libtaxii.scripts import TaxiiScript
from libtaxii.constants import VID_TAXII_XML_10
class FeedInformationClient10Script(TaxiiScript):
"""Feed Information Request Client"""
taxii_version = VID_TAXII_XML_10
parser_description = \
'The TAXII 1.0 Feed Information Client sends a Feed Information ' \
'Request message to a TAXII Server and prints the Feed Information ' \
'Response message to standard out.'
path = '/taxii-data'
def create_request_message(self, args):
message_id = tm10.generate_message_id()
return tm10.FeedInformationRequest(message_id)
def main():
"""Send a Feed Information Request to a Taxii 1.0 Service"""
script = FeedInformationClient10Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/fulfillment_client.py 0000775 0000000 0000000 00000005205 14036072565 0023233 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import libtaxii.messages_11 as tm11
from libtaxii.scripts import TaxiiScript, add_poll_response_args
from libtaxii.constants import *
class FulfillmentClient11Script(TaxiiScript):
parser_description = 'The TAXII 1.1 Poll Fulfillment Client sends a Poll Fulfillment Request to a TAXII Server ' \
'and prints out the Poll Response to standard out, saving the Content Blocks to disk (' \
'depending on command line arguments).'
path = '/taxii-data'
def get_arg_parser(self, *args, **kwargs):
parser = super(FulfillmentClient11Script, self).get_arg_parser(*args, **kwargs)
parser.add_argument("--collection",
dest="collection",
default="default",
help="Data Collection that this Fulfillment request applies to. Defaults to 'default'.")
parser.add_argument("--result-id",
dest="result_id",
required=True, help="The result_id being requested.")
parser.add_argument("--result-part-number",
dest="result_part_number",
type=int,
default=1,
help="The part number being requested. Defaults to '1'.")
add_poll_response_args(parser)
return parser
def create_request_message(self, args):
poll_fulf_req = tm11.PollFulfillmentRequest(message_id=tm11.generate_message_id(),
collection_name=args.collection,
result_id=args.result_id,
result_part_number=args.result_part_number)
return poll_fulf_req
def handle_response(self, response, args):
super(FulfillmentClient11Script, self).handle_response(response, args)
if response.message_type == MSG_POLL_RESPONSE:
if response.more:
print("This response has More=True, to request additional parts, use the following command:")
print(" fulfillment_client --collection %s --result-id %s --result-part-number %s\r\n" % \
(response.collection_name, response.result_id, response.result_part_number + 1))
self.write_cbs_from_poll_response_11(response, dest_dir=args.dest_dir, write_type_=args.write_type)
def main():
script = FulfillmentClient11Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/inbox_client.py 0000775 0000000 0000000 00000013020 14036072565 0022023 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
from libtaxii.scripts import TaxiiScript
import libtaxii.messages_11 as tm11
from libtaxii.constants import *
class InboxClient11Script(TaxiiScript):
parser_description = 'The TAXII 1.1 Inbox Client sends an Inbox Message to a TAXII Server and prints the ' \
'Status Message response to standard out. The Inbox Client has a "built in" STIX document ' \
'that is sent by default.'
path = '/taxii-data'
# http://stix.mitre.org/language/version1.1.1/#samples
# http://stix.mitre.org/language/version1.1.1/stix_v1.0_samples_20130408.zip
stix_watchlist = '''
Example watchlist that contains domain information.
Indicators - Watchlist
Domain Watchlist
Sample domain Indicator for this watchlist
malicious1.example.com##comma##malicious2.example.com##comma##malicious3.example.com
'''
def get_arg_parser(self, *args, **kwargs):
parser = super(InboxClient11Script, self).get_arg_parser(*args, **kwargs)
parser.add_argument("--content-binding",
dest="content_binding",
default=CB_STIX_XML_111,
help="Content binding of the Content Block to send. Defaults to %s" % CB_STIX_XML_111)
parser.add_argument("--subtype",
dest="subtype",
default=None,
help="The subtype of the Content Binding. Defaults to None")
parser.add_argument("--content-file",
dest="content_file",
default=self.stix_watchlist,
help="Content of the Content Block to send. Defaults to a STIX watchlist.")
parser.add_argument("--dcn",
dest="dcn",
default=None,
help="The Destination Collection Name for this Inbox Message. Defaults to None. "
"This script only supports one Destination Collection Name")
return parser
def create_request_message(self, args):
if args.content_file is self.stix_watchlist:
data = self.stix_watchlist
else:
with open(args.content_file, 'r') as f:
data = f.read()
cb = tm11.ContentBlock(tm11.ContentBinding(args.content_binding), data)
if args.subtype is not None:
cb.content_binding.subtype_ids.append(args.subtype)
inbox_message = tm11.InboxMessage(message_id=tm11.generate_message_id(), content_blocks=[cb])
if args.dcn:
inbox_message.destination_collection_names.append(args.dcn)
return inbox_message
def main():
script = InboxClient11Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/inbox_client_10.py 0000664 0000000 0000000 00000012255 14036072565 0022331 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
from libtaxii.scripts import TaxiiScript
import libtaxii.messages_10 as tm10
from libtaxii.constants import *
from libtaxii.common import generate_message_id
class InboxClient10Script(TaxiiScript):
taxii_version = VID_TAXII_XML_10
parser_description = 'The TAXII 1.0 Inbox Client sends an Inbox Message to a TAXII Server and prints the ' \
'Status Message response to standard out. The Inbox Client has a "built in" STIX document ' \
'that is sent by default.'
path = '/taxii-data'
# http://stix.mitre.org/language/version1.1.1/#samples
# http://stix.mitre.org/language/version1.1.1/stix_v1.0_samples_20130408.zip
stix_watchlist = '''
Example watchlist that contains domain information.
Indicators - Watchlist
Domain Watchlist
Sample domain Indicator for this watchlist
malicious1.example.com##comma##malicious2.example.com##comma##malicious3.example.com
'''
def get_arg_parser(self, *args, **kwargs):
parser = super(InboxClient10Script, self).get_arg_parser(*args, **kwargs)
parser.add_argument("--content-binding",
dest="content_binding",
default=CB_STIX_XML_111,
help="Content binding of the Content Block to send. Defaults to %s" % CB_STIX_XML_111)
parser.add_argument("--subtype",
dest="subtype",
default=None,
help="The subtype of the Content Binding. Defaults to None")
parser.add_argument("--content-file",
dest="content_file",
default=self.stix_watchlist,
help="Content of the Content Block to send. Defaults to a STIX watchlist.")
return parser
def create_request_message(self, args):
if args.content_file is self.stix_watchlist:
data = self.stix_watchlist
else:
with open(args.content_file, 'r') as f:
data = f.read()
cb = tm10.ContentBlock(args.content_binding, data)
if args.subtype is not None:
cb.content_binding.subtype_ids.append(args.subtype)
inbox_message = tm10.InboxMessage(message_id=generate_message_id(), content_blocks=[cb])
return inbox_message
def main():
script = InboxClient10Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/poll_client.py 0000775 0000000 0000000 00000007774 14036072565 0021675 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
from libtaxii.scripts import TaxiiScript, add_poll_response_args
import libtaxii.messages_11 as tm11
import os
import sys
import dateutil.parser
import datetime
from libtaxii.common import gen_filename
from libtaxii.constants import *
class PollClient11Script(TaxiiScript):
parser_description = ('The TAXII 1.1 Poll Client sends a Poll Request to a TAXII Poll Service then, depending on'
' the provided command line arguments, writes the Content Blocks in the response to disk.'
' Various options for the Poll Request can be set on the command line.')
path = '/taxii-data'
def get_arg_parser(self, *args, **kwargs):
parser = super(PollClient11Script, self).get_arg_parser(*args, **kwargs)
parser.add_argument("--collection",
dest="collection",
default="default",
help="Data Collection to poll. Defaults to 'default'.")
parser.add_argument("--begin-timestamp",
dest="begin_ts",
default=None,
help="The begin timestamp (format: YYYY-MM-DDTHH:MM:SS.ssssss+/-hh:mm) "
"for the poll request. Defaults to None.")
parser.add_argument("--end-timestamp",
dest="end_ts",
default=None,
help="The end timestamp (format: YYYY-MM-DDTHH:MM:SS.ssssss+/-hh:mm) "
"for the poll request. Defaults to None.")
parser.add_argument("--subscription-id",
dest="subscription_id",
default=None,
help="The Subscription ID for the poll request. Defaults to None.")
add_poll_response_args(parser)
return parser
def create_request_message(self, args):
try:
if args.begin_ts:
begin_ts = dateutil.parser.parse(args.begin_ts)
if not begin_ts.tzinfo:
raise ValueError
else:
begin_ts = None
if args.end_ts:
end_ts = dateutil.parser.parse(args.end_ts)
if not end_ts.tzinfo:
raise ValueError
else:
end_ts = None
except ValueError:
print("Unable to parse timestamp value. Timestamp should include both date and time "
"information along with a timezone or UTC offset (e.g., YYYY-MM-DDTHH:MM:SS.ssssss+/-hh:mm). "
"Aborting poll.")
sys.exit()
create_kwargs = {'message_id': tm11.generate_message_id(),
'collection_name': args.collection,
'exclusive_begin_timestamp_label': begin_ts,
'inclusive_end_timestamp_label': end_ts}
if args.subscription_id:
create_kwargs['subscription_id'] = args.subscription_id
else:
create_kwargs['poll_parameters'] = tm11.PollRequest.PollParameters()
poll_req = tm11.PollRequest(**create_kwargs)
return poll_req
def handle_response(self, response, args):
super(PollClient11Script, self).handle_response(response, args)
if response.message_type == MSG_POLL_RESPONSE:
if response.more:
print("This response has More=True, to request additional parts, use the following command:")
print(" fulfillment_client --collection %s --result-id %s --result-part-number %s\r\n" %
(response.collection_name, response.result_id, response.result_part_number + 1))
self.write_cbs_from_poll_response_11(response, dest_dir=args.dest_dir, write_type_=args.write_type)
def main():
script = PollClient11Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/poll_client_10.py 0000664 0000000 0000000 00000006704 14036072565 0022162 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
from libtaxii.scripts import TaxiiScript, add_poll_response_args
import libtaxii.messages_10 as tm10
import dateutil.parser
import datetime
import sys
import os
from libtaxii.common import gen_filename
from libtaxii.constants import *
class PollClient10Script(TaxiiScript):
taxii_version = VID_TAXII_XML_10
parser_description = ('The TAXII 1.0 Poll Client sends a Poll Request message to a TAXII Server and then'
'prints the Poll Response message to standard out, saving the Content Blocks to disk ('
'depending on the command line arguments).')
path = '/taxii-data'
def get_arg_parser(self, *args, **kwargs):
parser = super(PollClient10Script, self).get_arg_parser(*args, **kwargs)
parser.add_argument("--feed",
dest="feed",
default="default",
help="Data Collection to poll. Defaults to 'default'.")
parser.add_argument("--begin-timestamp",
dest="begin_ts",
default=None,
help="The begin timestamp (format: YYYY-MM-DDTHH:MM:SS.ssssss+/-hh:mm) for the poll "
"request. Defaults to None.")
parser.add_argument("--end-timestamp",
dest="end_ts",
default=None,
help="The end timestamp (format: YYYY-MM-DDTHH:MM:SS.ssssss+/-hh:mm) for the poll request. "
"Defaults to None.")
parser.add_argument("--subscription-id",
dest="subs_id",
default=None,
help="The subscription ID to use. Defaults to None")
add_poll_response_args(parser)
return parser
def create_request_message(self, args):
try:
if args.begin_ts:
begin_ts = dateutil.parser.parse(args.begin_ts)
if not begin_ts.tzinfo:
raise ValueError
else:
begin_ts = None
if args.end_ts:
end_ts = dateutil.parser.parse(args.end_ts)
if not end_ts.tzinfo:
raise ValueError
else:
end_ts = None
except ValueError:
print("Unable to parse timestamp value. Timestamp should include both date and time information along "
"with a timezone or UTC offset (e.g., YYYY-MM-DDTHH:MM:SS.ssssss+/-hh:mm). Aborting poll.")
sys.exit()
poll_req = tm10.PollRequest(message_id=tm10.generate_message_id(),
feed_name=args.feed,
exclusive_begin_timestamp_label=begin_ts,
inclusive_end_timestamp_label=end_ts,
subscription_id=args.subs_id)
return poll_req
def handle_response(self, response, args):
super(PollClient10Script, self).handle_response(response, args)
if response.message_type == tm10.MSG_POLL_RESPONSE:
self.write_cbs_from_poll_response_10(response, dest_dir=args.dest_dir, write_type_=args.write_type)
def main():
script = PollClient10Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/scripts/query_client.py 0000775 0000000 0000000 00000011605 14036072565 0022060 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import libtaxii.taxii_default_query as tdq
from libtaxii.constants import *
from .poll_client import PollClient11Script
class QueryClient11Script(PollClient11Script):
parser_description = "The TAXII 1.1 Query Client sends a Poll Request message to a TAXII Server (queries are " \
"contained in Poll Request messages) and prints out the resulting Poll Response message" \
"to standard out. The Content Blocks are saved to disk (depending on the command line" \
"options)."
path = '/taxii-data'
def get_arg_parser(self, *args, **kwargs):
parser = super(QueryClient11Script, self).get_arg_parser(*args, **kwargs)
parser.add_argument("--tev",
dest="tev",
default=CB_STIX_XML_111,
help="Indicate which Targeting Expression Vocabulary is being used. Defaults to "
"STIX XML 1.1.1")
parser.add_argument("--target",
dest="target",
default="**/@id",
help="The targeting expression to use. Defaults to **/@id (Any id, anywhere).")
parser.add_argument("--rel",
dest="relationship",
default="equals",
help="The relationship to use (e.g., equals). Defaults to equals.")
parser.add_argument("--cm",
dest="capability_module",
default=CM_CORE,
help="The capability module to use. Defaults to CORE.")
# Parameters - optional depending on what relationship is chosen
parser.add_argument("--value",
dest=tdq.P_VALUE,
default=None,
help="The value to look for. Required (or not) and allowed values depend "
"on the relationship.")
parser.add_argument("--match-type",
dest=tdq.P_MATCH_TYPE,
default='case_insensitive_string',
choices=['case_sensitive_string', 'case_insensitive_string', 'number'],
help="The match type. Required (or not) and allowed values depend on the relationship. "
"Defaults to \'case_insensitive_string\'")
parser.add_argument("--case-sensitive",
dest=tdq.P_CASE_SENSITIVE,
default=None,
choices=[True, False],
help="Whether the match is case sensitive. Required (or not) and allowed values "
"depend on the relationship. Defaults to \'None\'")
return parser
def create_request_message(self, args):
msg = super(QueryClient11Script, self).create_request_message(args)
if args.subscription_id is not None:
return msg # Query goes in Poll Parameters, which can't be specified with a subscription
capability_module = tdq.capability_modules.get(args.capability_module, None)
if capability_module is None:
raise ValueError("Unknown Capability Module specified: %s" % args.capability_module)
relationship = capability_module.relationships.get(args.relationship, None)
if relationship is None:
raise ValueError("Unknown Relationship: %s" % args.relationship)
params = {}
for parameter in tdq.P_NAMES:
param_obj = relationship.parameters.get(parameter, None) # Will either be a parameter object or None
param_value = getattr(args, parameter) # Will either be a value or None
if param_obj and not param_value:
raise ValueError('The parameter "%s" is needed and was not specified. Specify using --%s ' %
(parameter, parameter.replace('_', '-')))
if param_value and not param_obj:
raise ValueError('The parameter %s was specified and is not needed' % parameter)
if param_obj:
param_obj.verify(param_value)
params[parameter] = param_value
test = tdq.Test(capability_id=capability_module.capability_module_id,
relationship=relationship.name,
parameters=params)
criterion = tdq.Criterion(target=args.target, test=test)
criteria = tdq.Criteria(operator=OP_AND, criterion=[criterion])
q = tdq.DefaultQuery(args.tev, criteria)
msg.poll_parameters.query = q
return msg
def main():
script = QueryClient11Script()
script()
if __name__ == "__main__":
main()
libtaxii-1.1.119/libtaxii/taxii_default_query.py 0000664 0000000 0000000 00000063611 14036072565 0021736 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
"""
Creating, handling, and parsing TAXII Default Queries.
"""
import numbers
import datetime
from operator import attrgetter
import os
import dateutil.parser
from lxml import etree
import libtaxii.messages_11 as tm11
from .common import TAXIIBase
from .validation import (do_check, uri_regex, targeting_expression_regex)
from .constants import *
import six
class CapabilityModule(object):
"""
A Capability Module has valid relationships
Each relationship has 0-n valid parameters
"""
def __init__(self, capability_module_id, relationships):
self.capability_module_id = capability_module_id
self.relationships = relationships
@property
def capability_module_id(self):
return self._capability_module_id
@capability_module_id.setter
def capability_module_id(self, value):
do_check(value, 'capability_module_id', type=six.string_types)
self._capability_module_id = value
@property
def relationships(self):
return self._relationships
@relationships.setter
def relationships(self, value):
do_check(value, 'relationships', type=Relationship)
self._relationships = {}
for item in value:
self._relationships[item.name] = item
class Relationship(object):
def __init__(self, name, parameters=None):
self.name = name
self.parameters = parameters or []
@property
def name(self):
return self._name
@name.setter
def name(self, value):
do_check(value, 'name', type=six.string_types)
self._name = value
@property
def parameters(self):
return self._parameters
@parameters.setter
def parameters(self, value):
do_check(value, 'parameters', type=Parameter)
self._parameters = {}
for item in value:
self._parameters[item.name] = item
class Parameter(object):
def __init__(self, name, type, value_tuple=None):
self.name = name
self.type = type
self.value_tuple = value_tuple
def verify(self, value):
do_check(value, 'value', type=self.type, value_tuple=self.value_tuple)
return True, 'OK'
# params - Define parameters for the Core/Regex/Timestamp capability modules
param_str_value = Parameter(P_VALUE, six.string_types)
param_float_value = Parameter(P_VALUE, float)
param_ts_value = Parameter(P_VALUE, datetime.datetime)
param_match_type = Parameter(P_MATCH_TYPE, six.string_types, ('case_sensitive_string', 'case_insensitive_string', 'number'))
param_case_sensitive = Parameter(P_CASE_SENSITIVE, bool, (True, False))
# CORE Relationships - Define relationships for the core capability module
rel_equals = Relationship(R_EQUALS, [param_str_value, param_match_type])
rel_not_equals = Relationship(R_NOT_EQUALS, [param_str_value, param_match_type])
rel_greater_than = Relationship(R_GREATER_THAN, [param_float_value])
rel_greater_than_or_equal = Relationship(R_GREATER_THAN_OR_EQUAL, [param_float_value])
rel_less_than = Relationship(R_LESS_THAN, [param_float_value])
rel_less_than_or_equal = Relationship(R_LESS_THAN_OR_EQUAL, [param_float_value])
rel_dne = Relationship(R_DOES_NOT_EXIST)
rel_ex = Relationship(R_EXISTS)
rel_begins_with = Relationship(R_BEGINS_WITH, [param_case_sensitive, param_str_value])
rel_ends_with = Relationship(R_ENDS_WITH, [param_case_sensitive, param_str_value])
rel_contains = Relationship(R_CONTAINS, [param_case_sensitive, param_str_value])
# REGEX relationships
rel_matches = Relationship(R_MATCHES, [param_case_sensitive, param_str_value])
# TIMESTAMP relationships
rel_ts_eq = Relationship(R_EQUALS, [param_ts_value])
rel_ts_gt = Relationship(R_GREATER_THAN, [param_ts_value])
rel_ts_gte = Relationship(R_GREATER_THAN_OR_EQUAL, [param_ts_value])
rel_ts_lt = Relationship(R_LESS_THAN, [param_ts_value])
rel_ts_lte = Relationship(R_LESS_THAN_OR_EQUAL, [param_ts_value])
# CORE - Define the Core Capability Module
cm_core = CapabilityModule(CM_CORE,
[rel_equals, rel_not_equals, rel_greater_than,
rel_greater_than_or_equal, rel_less_than,
rel_less_than_or_equal, rel_dne, rel_ex,
rel_begins_with, rel_contains, rel_ends_with]
)
# REGEX - Define the RegEx Capability Module
cm_regex = CapabilityModule(CM_REGEX, [rel_matches])
# TIMESTAMP - Define the timestamp Capability Module
cm_timestamp = CapabilityModule(CM_TIMESTAMP, [rel_ts_eq, rel_ts_gt, rel_ts_gte, rel_ts_lt, rel_ts_lte])
capability_modules = {CM_CORE: cm_core, CM_REGEX: cm_regex, CM_TIMESTAMP: cm_timestamp}
class DefaultQueryInfo(tm11.SupportedQuery):
""" Used to describe the TAXII Default Queries that are supported.
:param targeting_expression_infos: Describe the supported targeting expressions
:type targeting_expression_infos: :class:`list` of :class:`TargetingExpressionInfo` objects
:param capability_modules: Indicate the supported capability modules
:type capability_modules: :class:`list` of :class:`str`
"""
def __init__(self, targeting_expression_infos, capability_modules):
super(DefaultQueryInfo, self).__init__(FID_TAXII_DEFAULT_QUERY_10)
self.targeting_expression_infos = targeting_expression_infos
self.capability_modules = capability_modules
@property
def targeting_expression_infos(self):
return self._targeting_expression_infos
@targeting_expression_infos.setter
def targeting_expression_infos(self, value):
do_check(value, 'targeting_expression_infos', type=DefaultQueryInfo.TargetingExpressionInfo)
self._targeting_expression_infos = value
@property
def capability_modules(self):
return self._capability_modules
@capability_modules.setter
def capability_modules(self, value):
do_check(value, 'capability_modules', regex_tuple=uri_regex)
self._capability_modules = value
def to_etree(self):
q = super(DefaultQueryInfo, self).to_etree()
dqi = etree.SubElement(q, '{%s}Default_Query_Info' % ns_map['tdq'])
for expression_info in self.targeting_expression_infos:
dqi.append(expression_info.to_etree())
for cmod in self.capability_modules:
cm = etree.SubElement(dqi, '{%s}Capability_Module' % ns_map['tdq'], nsmap=ns_map)
cm.text = cmod
return q
def to_dict(self):
d = super(DefaultQueryInfo, self).to_dict()
d['targeting_expression_infos'] = []
for expression_info in self.targeting_expression_infos:
d['targeting_expression_infos'].append(expression_info.to_dict())
# TODO: This looks like a serialization bug
d['capability_modules'] = self.capability_modules
return d
def to_text(self, line_prepend=''):
s = super(DefaultQueryInfo, self).to_text(line_prepend)
for expression_info in self.targeting_expression_infos:
s += expression_info.to_text(line_prepend + STD_INDENT)
for capability_module in self.capability_modules:
s += line_prepend + " Capability Module: %s\n" % capability_module
return s
def __hash__(self):
return hash(str(self.to_dict()))
@staticmethod
def from_etree(etree_xml):
texpr_infos = etree_xml.xpath('./tdq:Default_Query_Info/tdq:Targeting_Expression_Info', namespaces=ns_map)
texpr_info_list = []
for texpr_info in texpr_infos:
texpr_info_list.append(DefaultQueryInfo.TargetingExpressionInfo.from_etree(texpr_info))
cms = etree_xml.xpath('./tdq:Default_Query_Info/tdq:Capability_Module', namespaces=ns_map)
cms_list = []
for cm in cms:
cms_list.append(cm.text)
return DefaultQueryInfo(texpr_info_list, cms_list)
@staticmethod
def from_dict(d):
kwargs = {}
kwargs['targeting_expression_infos'] = []
for expression_info in d['targeting_expression_infos']:
kwargs['targeting_expression_infos'].append(DefaultQueryInfo.TargetingExpressionInfo.from_dict(expression_info))
kwargs['capability_modules'] = d['capability_modules']
return DefaultQueryInfo(**kwargs)
class TargetingExpressionInfo(TAXIIBase):
"""This class describes supported Targeting Expressions
:param string targeting_expression_id: The supported targeting expression ID
:param preferred_scope: Indicates the preferred scope of queries
:type preferred_scope: :class:`list` of :class:`string`
:param allowed_scope: Indicates the allowed scope of queries
:type allowed_scope: :class:`list` of :class:`string`
"""
def __init__(self, targeting_expression_id, preferred_scope=None, allowed_scope=None):
self.targeting_expression_id = targeting_expression_id
self.preferred_scope = preferred_scope or []
self.allowed_scope = allowed_scope or []
@property
def sort_key(self):
return self.targeting_expression_id
@property
def targeting_expression_id(self):
return self._targeting_expression_id
@targeting_expression_id.setter
def targeting_expression_id(self, value):
do_check(value, 'targeting_expression_id', regex_tuple=uri_regex)
self._targeting_expression_id = value
@property
def preferred_scope(self):
return self._preferred_scope
@preferred_scope.setter
def preferred_scope(self, value):
do_check(value, 'preferred_scope', type=six.string_types, regex_tuple=targeting_expression_regex)
self._preferred_scope = value
@property
def allowed_scope(self):
return self._allowed_scope
@allowed_scope.setter
def allowed_scope(self, value):
do_check(value, 'allowed_scope', type=six.string_types, regex_tuple=targeting_expression_regex)
self._allowed_scope = value
def to_etree(self):
tei = etree.Element('{%s}Targeting_Expression_Info' % ns_map['tdq'])
tei.attrib['targeting_expression_id'] = self.targeting_expression_id
for scope in self.preferred_scope:
preferred = etree.SubElement(tei, '{%s}Preferred_Scope' % ns_map['tdq'])
preferred.text = scope
for scope in self.allowed_scope:
allowed = etree.SubElement(tei, '{%s}Allowed_Scope' % ns_map['tdq'])
allowed.text = scope
return tei
def to_dict(self):
d = {}
d['targeting_expression_id'] = self.targeting_expression_id
# TODO: Preferred / Allowed scope look like serialization bugs
d['preferred_scope'] = self.preferred_scope
d['allowed_scope'] = self.allowed_scope
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Targeting Expression Info ===\n"
s += line_prepend + " Targeting Expression ID: %s\n" % self.targeting_expression_id
for scope in self.preferred_scope:
s += line_prepend + " Preferred Scope: %s\n" % scope
for scope in self.allowed_scope:
s += line_prepend + " Allowed Scope: %s\n" % scope
return s
def __hash__(self):
return hash(str(self.to_dict()))
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['targeting_expression_id'] = etree_xml.xpath('./@targeting_expression_id', namespaces=ns_map)[0]
kwargs['preferred_scope'] = []
preferred_scope_set = etree_xml.xpath('./tdq:Preferred_Scope', namespaces=ns_map)
for preferred in preferred_scope_set:
kwargs['preferred_scope'].append(preferred.text)
kwargs['allowed_scope'] = []
allowed_scope_set = etree_xml.xpath('./tdq:Allowed_Scope', namespaces=ns_map)
for allowed in allowed_scope_set:
kwargs['allowed_scope'].append(allowed.text)
return DefaultQueryInfo.TargetingExpressionInfo(**kwargs)
@staticmethod
def from_dict(d):
return DefaultQueryInfo.TargetingExpressionInfo(**d)
class DefaultQuery(tm11.Query):
"""Conveys a TAXII Default Query.
:param string targeting_expression_id: The targeting_expression used in the query
:param criteria: The criteria of the query
:type criteria: :class:`DefaultQuery.Criteria`
"""
def __init__(self, targeting_expression_id, criteria):
super(DefaultQuery, self).__init__(FID_TAXII_DEFAULT_QUERY_10)
self.targeting_expression_id = targeting_expression_id
self.criteria = criteria
@property
def targeting_expression_id(self):
return self._targeting_expression_id
@targeting_expression_id.setter
def targeting_expression_id(self, value):
do_check(value, 'targeting_expression_id', regex_tuple=uri_regex)
self._targeting_expression_id = value
@property
def criteria(self):
return self._criteria
@criteria.setter
def criteria(self, value):
do_check(value, 'criteria', type=DefaultQuery.Criteria)
self._criteria = value
def to_etree(self):
q = super(DefaultQuery, self).to_etree()
dq = etree.SubElement(q, '{%s}Default_Query' % ns_map['tdq'], nsmap=ns_map)
dq.attrib['targeting_expression_id'] = self.targeting_expression_id
dq.append(self.criteria.to_etree())
return q
def to_dict(self):
d = super(DefaultQuery, self).to_dict()
d['targeting_expression_id'] = self.targeting_expression_id
d['criteria'] = self.criteria.to_dict()
return d
def to_text(self, line_prepend=''):
s = super(DefaultQuery, self).to_text(line_prepend)
s += line_prepend + " Targeting Expression ID: %s\n" % self.targeting_expression_id
s += self.criteria.to_text(line_prepend)
return s
@staticmethod
def from_etree(etree_xml):
tei = etree_xml.xpath('./tdq:Default_Query/@targeting_expression_id', namespaces=ns_map)[0] # attrib['targeting_expression_id']
criteria = DefaultQuery.Criteria.from_etree(etree_xml.xpath('./tdq:Default_Query/tdq:Criteria', namespaces=ns_map)[0])
return DefaultQuery(tei, criteria)
@staticmethod
def from_dict(d):
tei = d['targeting_expression_id']
criteria = DefaultQuery.Criteria.from_dict(d['criteria'])
return DefaultQuery(tei, criteria)
class Criteria(TAXIIBase):
"""Represents criteria for a :class:`DefaultQuery`. **Note**: At least one criterion OR criteria MUST be present
:param str operator: The logical operator (should be one of `OP_AND` or `OP_OR`)
:param criteria: The criteria for the query
:type criteria: :class:`DefaultQuery.Criteria`
:param criterion: The criterion for the query
:type criterion: :class:`DefaultQuery.Criterion`
"""
def __init__(self, operator, criteria=None, criterion=None):
self.operator = operator
self.criteria = criteria or []
self.criterion = criterion or []
@property
def sort_key(self):
key_list = []
ia = sorted(self.criteria, key=attrgetter('sort_key'))
ion = sorted(self.criterion, key=attrgetter('sort_key'))
for i in ia:
key_list.append(i.sort_key)
for i in ion:
key_list.append(i.sort_key)
return ''.join(key_list)
@property
def operator(self):
return self._operator
@operator.setter
def operator(self, value):
do_check(value, 'operator', value_tuple=OP_TYPES)
self._operator = value
@property
def criteria(self):
return self._criteria
@criteria.setter
def criteria(self, value):
do_check(value, 'critiera', type=DefaultQuery.Criteria)
self._criteria = value
@property
def criterion(self):
return self._criterion
@criterion.setter
def criterion(self, value):
do_check(value, 'criterion', type=DefaultQuery.Criterion)
self._criterion = value
def to_etree(self):
cr = etree.Element('{%s}Criteria' % ns_map['tdq'], nsmap=ns_map)
cr.attrib['operator'] = self.operator
for criteria in self.criteria:
cr.append(criteria.to_etree())
for criterion in self.criterion:
cr.append(criterion.to_etree())
return cr
def to_dict(self):
d = {}
d['operator'] = self.operator
d['criteria'] = []
for criteria in self.criteria:
d['criteria'].append(criteria.to_dict())
d['criterion'] = []
for criterion in self.criterion:
d['criterion'].append(criterion.to_dict())
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Criteria ===\n"
s += line_prepend + " Operator: %s\n" % self.operator
for criteria in self.criteria:
s += criteria.to_text(line_prepend + STD_INDENT)
for criterion in self.criterion:
s += criterion.to_text(line_prepend + STD_INDENT)
return s
@staticmethod
def from_etree(etree_xml):
kwargs = {}
kwargs['operator'] = etree_xml.attrib['operator']
kwargs['criteria'] = []
criteria_set = etree_xml.xpath('./tdq:Criteria', namespaces=ns_map)
for criteria in criteria_set:
kwargs['criteria'].append(DefaultQuery.Criteria.from_etree(criteria))
kwargs['criterion'] = []
criterion_set = etree_xml.xpath('./tdq:Criterion', namespaces=ns_map)
for criterion in criterion_set:
kwargs['criterion'].append(DefaultQuery.Criterion.from_etree(criterion))
return DefaultQuery.Criteria(**kwargs)
@staticmethod
def from_dict(d):
kwargs = {}
kwargs['operator'] = d['operator']
kwargs['criteria'] = []
criteria_set = d.get('criteria', [])
for criteria in criteria_set:
kwargs['criteria'].append(DefaultQuery.Criteria.from_dict(criteria))
kwargs['criterion'] = []
criterion_set = d.get('criterion', [])
for criterion in criterion_set:
kwargs['criterion'].append(DefaultQuery.Criterion.from_dict(criterion))
return DefaultQuery.Criteria(**kwargs)
class Criterion(TAXIIBase):
"""Represents criterion for a :class:`DefaultQuery.Criteria`
:param string target: A targeting expression identifying the target
:param test: The test to be applied to the target
:type test: :class:`DefaultQuery.Criterion.Test`
:param bool negate: Whether the result of applying the test to the target should be negated
"""
def __init__(self, target, test, negate=False):
self.negate = negate
self.target = target
self.test = test
@property
def sort_key(self):
return self.target
@property
def negate(self):
return self._negate
@negate.setter
def negate(self, value):
do_check(value, 'negate', value_tuple=(True, False), can_be_none=True)
self._negate = value
@property
def target(self):
return self._target
@target.setter
def target(self, value):
do_check(value, 'target', type=six.string_types)
self._target = value
@property
def test(self):
return self._test
@test.setter
def test(self, value):
do_check(value, value, type=DefaultQuery.Criterion.Test)
self._test = value
def to_etree(self):
cr = etree.Element('{%s}Criterion' % ns_map['tdq'], nsmap=ns_map)
if self.negate is not None:
cr.attrib['negate'] = str(self.negate).lower()
target = etree.SubElement(cr, '{%s}Target' % ns_map['tdq'], nsmap=ns_map)
target.text = self.target
cr.append(self.test.to_etree())
return cr
def to_dict(self):
d = {}
d['negate'] = None
if self.negate is not None:
d['negate'] = self.negate
d['target'] = self.target
d['test'] = self.test.to_dict()
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Criterion ===\n"
s += line_prepend + " Negate: %s\n" % (self.negate if (None != self.negate) else False)
s += line_prepend + " Target: %s\n" % self.target
s += self.test.to_text(line_prepend + STD_INDENT)
return s
@staticmethod
def from_etree(etree_xml):
negate_set = etree_xml.xpath('./@negate')
negate = None
if len(negate_set) > 0:
negate = negate_set[0] == 'true'
target = etree_xml.xpath('./tdq:Target', namespaces=ns_map)[0].text
test = DefaultQuery.Criterion.Test.from_etree(etree_xml.xpath('./tdq:Test', namespaces=ns_map)[0])
return DefaultQuery.Criterion(target, test, negate)
@staticmethod
def from_dict(d):
negate = d.get('negate', None)
target = d['target']
test = DefaultQuery.Criterion.Test.from_dict(d['test'])
return DefaultQuery.Criterion(target, test, negate)
class Test(TAXIIBase):
"""
:param string capability_id: The ID of the capability module that defines the relationship & parameters
:param string relationship: The relationship (e.g., equals)
:param parameters: The parameters for the relationship.
:type parameters: :class:`dict` of key/value pairs
"""
def __init__(self, capability_id, relationship, parameters=None):
self.capability_id = capability_id
self.relationship = relationship
self.parameters = parameters or {}
self.validate()
@property
def capability_id(self):
return self._capability_id
@capability_id.setter
def capability_id(self, value):
do_check(value, 'capability_id', regex_tuple=uri_regex)
self._capability_id = value
@property
def relationship(self):
return self._relationship
@relationship.setter
def relationship(self, value):
# TODO: For known capability IDs, check that the relationship is valid
# TODO: provide a way to register other capability IDs
do_check(value, 'relationship', type=six.string_types)
self._relationship = value
@property
def parameters(self):
return self._parameters
@parameters.setter
def parameters(self, value):
do_check(list(value.keys()), 'parameters.keys()', regex_tuple=uri_regex)
self._parameters = value
# TODO: Can this be done better?
def validate(self):
capability_module = capability_modules.get(self.capability_id)
if capability_module is None: # Nothing is defined for this, validation not possible
return True
relationship = capability_module.relationships.get(self.relationship)
if relationship is None:
raise Exception('relationship not in defined relationships. %s not in %s' % (self.relationship, list(capability_module.relationships.keys())))
for name, value in list(self.parameters.items()):
param = relationship.parameters.get(name)
if param is None:
raise Exception('name not valid. %s not in %s' % (name, list(relationship.parameters.keys())))
param.verify(value)
def to_etree(self):
t = etree.Element('{%s}Test' % ns_map['tdq'], nsmap=ns_map)
t.attrib['capability_id'] = self.capability_id
t.attrib['relationship'] = self.relationship
for k, v in list(self.parameters.items()):
p = etree.SubElement(t, '{%s}Parameter' % ns_map['tdq'])
p.attrib['name'] = k
if isinstance(v, bool):
p.text = str(v).lower()
elif isinstance(v, datetime.datetime):
p.text = v.isoformat()
elif isinstance(v, numbers.Number):
p.text = str(v)
else:
p.text = v
return t
def to_dict(self):
d = {}
d['capability_id'] = self.capability_id
d['relationship'] = self.relationship
d['parameters'] = self.parameters
return d
def to_text(self, line_prepend=''):
s = line_prepend + "=== Test ==\n"
s += line_prepend + " Capability ID: %s\n" % self.capability_id
s += line_prepend + " Relationship: %s\n" % self.relationship
for k, v in six.iteritems(self.parameters):
s += line_prepend + " Parameter: %s = %s\n" % (k, v)
return s
@staticmethod
def from_etree(etree_xml):
capability_id = etree_xml.attrib['capability_id']
relationship = etree_xml.attrib['relationship']
parameters = {}
cm = capability_modules.get(capability_id, None)
if cm is not None:
r = cm.relationships.get(relationship, None)
if r is None:
raise ValueError('Relationship (%s) not in CM (%s).' % (r, capability_id))
else:
r = None
for parameter in etree_xml.xpath('./tdq:Parameter', namespaces=ns_map):
k = parameter.attrib['name']
v = parameter.text
if v in ('true', 'false'): # bool is a special case
parameters[k] = v == 'true'
elif r is not None:
type_ = r.parameters[k].type
if type_ == six.string_types: # basestring can't be instantiated, but str can be
type_ = str
elif type_ == datetime.datetime:
# We can use this function to parse datetime strings.
type_ = dateutil.parser.parse
parameters[k] = type_(v)
else:
parameters[k] = v
return DefaultQuery.Criterion.Test(capability_id, relationship, parameters)
@staticmethod
def from_dict(d):
return DefaultQuery.Criterion.Test(**d)
DefaultQueryInfo.TargetingExpressionInfo = TargetingExpressionInfo
DefaultQuery.Criterion = Criterion
DefaultQuery.Criteria = Criteria
DefaultQuery.Criterion.Test = Test
package_dir, package_filename = os.path.split(__file__)
schema_file = os.path.join(package_dir, "xsd", "TAXII_DefaultQuery_Schema.xsd")
tm11.register_query_format(
format_id=FID_TAXII_DEFAULT_QUERY_10,
query=DefaultQuery,
query_info=DefaultQueryInfo,
schema=schema_file)
libtaxii-1.1.119/libtaxii/test/ 0000775 0000000 0000000 00000000000 14036072565 0016265 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/test/__init__.py 0000664 0000000 0000000 00000000000 14036072565 0020364 0 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/test/argument_parser_test.py 0000664 0000000 0000000 00000002674 14036072565 0023105 0 ustar 00root root 0000000 0000000 import os
import unittest
import libtaxii.scripts.poll_client as pc11
class ArgumentParserTests(unittest.TestCase):
def setUp(self):
self.module_path = os.path.dirname(__file__)
def test_valid_argument_passing_poll_client11(self):
script = pc11.PollClient11Script()
arg_parse = script.get_arg_parser(script.parser_description, path=script.path)
namespace = arg_parse.parse_args(
[
"--from-file", os.path.join(self.module_path, "data", "configuration.ini")
]
)
self.assertEqual(namespace.url, "http://hailataxii2.com:80")
self.assertEqual(namespace.path, "/taxii-data")
self.assertEqual(namespace.port, 80)
self.assertEqual(namespace.password, "myS3crEtp@asswOrd!")
def test_argument_override_poll_client11(self):
script = pc11.PollClient11Script()
arg_parse = script.get_arg_parser(script.parser_description, path=script.path)
namespace = arg_parse.parse_args(
[
"-u", "http://hailataxii.com:80",
"--from-file", os.path.join(self.module_path, "data", "configuration.ini")
]
)
self.assertEqual(namespace.url, "http://hailataxii2.com:80") # note the argument was overwritten
self.assertEqual(namespace.path, "/taxii-data")
self.assertEqual(namespace.port, 80)
self.assertEqual(namespace.password, "myS3crEtp@asswOrd!")
libtaxii-1.1.119/libtaxii/test/clients_test.py 0000664 0000000 0000000 00000003065 14036072565 0021343 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import datetime
from dateutil.tz import tzutc
import libtaxii as t
import libtaxii.clients as tc
import libtaxii.messages as tm
from libtaxii.constants import *
# NOTE: This cannot currently be run as a unit test because it needs a server
# to connect to.
def client_example():
# Create the TAXII HTTPS Client
client = tc.HttpClient()
# Uncomment to use HTTPS
client.set_use_https(True)
# Uncomment to use basic authentication
# client.set_auth_type(tc.HttpClient.AUTH_BASIC)
# client.set_auth_credentials({'username':'some_username', 'password':'some_password'})
# Uncomment to use certificate-based authentication
client.set_auth_type(tc.HttpClient.AUTH_CERT)
client.set_auth_credentials({'key_file': 'keyfile',
'cert_file': 'certfile'})
# Uncomment to set a proxy
# client.set_proxy(tc.HttpClient.PROXY_HTTP, 'http://proxy.company.com:80')
# Create the poll request
poll_request1 = tm.PollRequest(message_id=tm.generate_message_id(), feed_name='TheFeedToPoll')
# Call without a proxy
http_response = client.call_taxii_service2('hostname', '/poll_service_path/', VID_TAXII_XML_10, poll_request1.to_xml())
print(http_response.__class__.__name__)
taxii_message = t.get_message_from_http_response(http_response,
poll_request1.message_id)
print((taxii_message.to_xml()))
if __name__ == "__main__":
client_example()
libtaxii-1.1.119/libtaxii/test/data/ 0000775 0000000 0000000 00000000000 14036072565 0017176 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/test/data/configuration.ini 0000664 0000000 0000000 00000000105 14036072565 0022542 0 ustar 00root root 0000000 0000000 [libtaxii]
url = http://hailataxii2.com:80
pass = myS3crEtp@asswOrd!
libtaxii-1.1.119/libtaxii/test/input/ 0000775 0000000 0000000 00000000000 14036072565 0017424 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/test/input/1.1/ 0000775 0000000 0000000 00000000000 14036072565 0017723 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/test/input/1.1/Collection_Information_Response.xml 0000664 0000000 0000000 00000003320 14036072565 0026761 0 ustar 00root root 0000000 0000000
Warrgghghglble.
So improve information. Much amaze.
urn:taxii.mitre.org:protocol:http:1.0
https://example.com/inbox/
urn:taxii.mitre.org:message:xml:1.1
urn:taxii.mitre.org:protocol:http:1.0
https://example.com/inbox/
urn:taxii.mitre.org:message:xml:1.1
libtaxii-1.1.119/libtaxii/test/input/1.1/Discovery_Response.xml 0000664 0000000 0000000 00000003057 14036072565 0024277 0 ustar 00root root 0000000 0000000
urn:taxii.mitre.org:protocol:http:1.0
http://taxiitest.mitre.org/services/inbox/default
urn:taxii.mitre.org:message:xml:1.1
urn:taxii.mitre.org:protocol:http:1.0
http://taxiitest.mitre.org/services/poll
urn:taxii.mitre.org:message:xml:1.1
urn:taxii.mitre.org:protocol:http:1.0
http://taxiitest.mitre.org/services/discovery
urn:taxii.mitre.org:message:xml:1.1
libtaxii-1.1.119/libtaxii/test/input/1.1/Inbox_Message.xml 0000664 0000000 0000000 00000003132 14036072565 0023167 0 ustar 00root root 0000000 0000000
collection1
collection2
Hello!
SubsId021
2014-10-21T15:21:50.895-04:00
2014-10-21T15:21:50.895-04:00
22
2014-10-21T19:21:50.805Z
Hullo!
The quick brown fox jumped over the lazy dogs.
libtaxii-1.1.119/libtaxii/test/input/1.1/Subscription_Management_Request.xml 0000664 0000000 0000000 00000006102 14036072565 0026774 0 ustar 00root root 0000000 0000000
FULL
**
Test value
case_sensitive_string
**/Description
Tue Oct 21 15:34:33 EDT 2014
**
Test value
case_sensitive_string
STIX_Package/Indicators/Indicator/@id
[A-Z]*
true
**/Description
Tue Oct 21 15:34:33 EDT 2014
libtaxii-1.1.119/libtaxii/test/input/1.1/Subscription_Management_Response.xml 0000664 0000000 0000000 00000010412 14036072565 0027141 0 ustar 00root root 0000000 0000000
Hullo!
Subs001
COUNT_ONLY
**
Test value
case_sensitive_string
urn:taxii.mitre.org:protocol:https:1.0
https://example.com/inboxAddress/
urn:taxii.mitre.org:message:xml:1.1
urn:taxii.mitre.org:protocol:https:1.0
https://example.com/poll1/
urn:taxii.mitre.org:message:xml:1.1
urn:taxii.mitre.org:protocol:https:1.0
https://example.com/poll2/
urn:taxii.mitre.org:message:xml:1.1
urn:taxii.mitre.org:protocol:https:1.0
https://example.com/poll3/
urn:taxii.mitre.org:message:xml:1.1
Subs001
COUNT_ONLY
**
Test value
case_sensitive_string
urn:taxii.mitre.org:protocol:https:1.0
https://example.com/inboxAddress/
urn:taxii.mitre.org:message:xml:1.1
Subs001
libtaxii-1.1.119/libtaxii/test/messages_10_test.py 0000664 0000000 0000000 00000073245 14036072565 0022020 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
# This file has two purposes:
# 1. To provide a rough unit test of libtaxii.messages
# 2. To provide examples of how to use libtaxii.messages
import datetime
import unittest
import warnings
import inspect
from dateutil.tz import tzutc
from lxml import etree
import libtaxii as t
import libtaxii.messages_10 as tm10
from libtaxii.validation import SchemaValidator
from libtaxii.constants import *
import six
import sys
xml_taxii_message_10 = ''
json_taxii_message_10 = '{"extended_headers": {}, "message_type": "Discovery_Request", "message_id": "1"}'
full_stix_doc = """
Example watchlist that contains domain information.
Indicators - Watchlist
Domain Watchlist
Sample domain Indicator for this watchlist
malicious1.example.com##comma##malicious2.example.com##comma##malicious3.example.com
"""
full_stix_etree = etree.parse(six.StringIO(full_stix_doc)).getroot()
# TODO: This is bad practice. Refactor this.
# Set up some things used across multiple tests.
stix_etree = etree.parse(six.StringIO('')).getroot()
xml_content_block1 = tm10.ContentBlock(
content_binding=CB_STIX_XML_10, # Required
content=full_stix_etree, # Required. Can be etree or string
padding='ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789', # Optional
timestamp_label=datetime.datetime.now(tzutc())) # Optional
string_content_block1 = tm10.ContentBlock(
content_binding='string', # Required
content='Sample content', # Required
padding='ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789', # Optional
timestamp_label=datetime.datetime.now(tzutc())) # Optional
delivery_parameters1 = tm10.DeliveryParameters(
inbox_protocol=VID_TAXII_HTTP_10, # Required if requesting push messaging
inbox_address='http://example.com/inbox', # Yes, if requesting push messaging
delivery_message_binding=VID_TAXII_XML_10, # Required if requesting push messaging
content_bindings=[CB_STIX_XML_10]) # Optional - absence means accept all content bindings
def round_trip_message(taxii_message):
if not isinstance(taxii_message, tm10.TAXIIMessage):
raise ValueError('taxii_message was not an instance of TAXIIMessage')
print('***** Message type = %s; id = %s' % (taxii_message.message_type, taxii_message.message_id))
xml_string = taxii_message.to_xml()
# This is the old, deprecated way of validating
with warnings.catch_warnings():
warnings.simplefilter('ignore', DeprecationWarning)
valid = tm10.validate_xml(xml_string)
if valid is not True:
raise Exception('\tFailure of test #1 - XML not schema valid: %s' % valid)
# The new way of validating
sv = SchemaValidator(SchemaValidator.TAXII_10_SCHEMA)
try:
result = sv.validate_string(xml_string)
except etree.XMLSyntaxError:
raise
if not result.valid:
errors = [item for item in result.error_log]
raise Exception('\tFailure of test #1 - XML not schema valid: %s' % errors)
msg_from_xml = tm10.get_message_from_xml(xml_string)
dictionary = taxii_message.to_dict()
msg_from_dict = tm10.get_message_from_dict(dictionary)
taxii_message.to_text()
if taxii_message != msg_from_xml:
print('\t Failure of test #2 - running equals w/ debug:')
taxii_message.__eq__(msg_from_xml, True)
raise Exception('Test #2 failed - taxii_message != msg_from_xml')
if taxii_message != msg_from_dict:
print('\t Failure of test #3 - running equals w/ debug:')
taxii_message.__eq__(msg_from_dict, True)
raise Exception('Test #3 failed - taxii_message != msg_from_dict')
if msg_from_xml != msg_from_dict:
print('\t Failure of test #4 - running equals w/ debug:')
msg_from_xml.__eq__(msg_from_dict, True)
raise Exception('Test #4 failed - msg_from_xml != msg_from_dict')
print('***** All tests completed!')
def round_trip_content_block(content_block):
if not isinstance(content_block, tm10.ContentBlock):
raise ValueError('content_block was not an instance of ContentBlock')
print('***** Starting Content Block tests')
xml_string = content_block.to_xml()
block_from_xml = tm10.ContentBlock.from_xml(xml_string)
dictionary = content_block.to_dict()
block_from_dict = tm10.ContentBlock.from_dict(dictionary)
json_string = content_block.to_json()
block_from_json = tm10.ContentBlock.from_json(json_string)
content_block.to_text()
if content_block != block_from_xml:
print('\t Failure of test #1 - running equals w/ debug:')
content_block.__equals(block_from_xml, True)
raise Exception('Test #1 failed - content_block != block_from_xml')
if content_block != block_from_dict:
print('\t Failure of test #2 - running equals w/ debug:')
content_block.__eq__(block_from_dict, True)
raise Exception('Test #2 failed - content_block != block_from_dict')
if block_from_xml != block_from_dict:
print('\t Failure of test #3 - running equals w/ debug:')
block_from_xml.__eq__(block_from_dict, True)
raise Exception('Test #3 failed - block_from_xml != block_from_dict')
if block_from_json != block_from_dict:
print('\t Failure of test #3 - running equals w/ debug:')
block_from_json.__eq__(block_from_dict, True)
raise Exception('Test #3 failed - block_from_json != block_from_dict')
print('***** All tests completed!')
class DiscoveryRequestTests(unittest.TestCase):
def test_discovery_request(self):
discovery_request1 = tm10.DiscoveryRequest(
message_id=tm10.generate_message_id(), # Required
# Extended headers are optional for every message type, but only demonstrated here
extended_headers={'ext_header1': 'value1', 'ext_header2': 'value2'}) # Optional.
round_trip_message(discovery_request1)
class DiscoveryResponseTests(unittest.TestCase):
def test_discovery_response(self):
service_instance1 = tm10.ServiceInstance(
service_type=SVC_INBOX, # Required
services_version=VID_TAXII_SERVICES_10, # Required
protocol_binding=VID_TAXII_HTTP_10, # Required
service_address='http://example.com/inboxservice/', # Required
message_bindings=[VID_TAXII_XML_10], # Required, must have at least one value in the list
inbox_service_accepted_content=[CB_STIX_XML_10], # Optional for service_type=SVC_INBOX, prohibited otherwise
# If this is absent and service_type=SVC_INBOX,
# It means the inbox service accepts all content
available=True, # Optional - defaults to None, which means 'Unknown'
message='This is a message.') # Optional
# Create the discovery response
discovery_response1 = tm10.DiscoveryResponse(
message_id=tm10.generate_message_id(), # Required
in_response_to=tm10.generate_message_id(), # Required. This should be the ID of the corresponding request
service_instances=[service_instance1]) # Optional.
round_trip_message(discovery_response1)
def test_discovery_response_deprecated(self):
# Test nested-class form:
# DiscoveryResponse.ServiceInstance
service_instance1 = tm10.DiscoveryResponse.ServiceInstance(
service_type=SVC_INBOX,
services_version=VID_TAXII_SERVICES_10,
protocol_binding=VID_TAXII_HTTP_10,
service_address='http://example.com/inboxservice/',
message_bindings=[VID_TAXII_XML_10])
discovery_response1 = tm10.DiscoveryResponse(
message_id=tm10.generate_message_id(),
in_response_to=tm10.generate_message_id(),
service_instances=[service_instance1])
round_trip_message(discovery_response1)
class FeedInformationRequestTests(unittest.TestCase):
def test_feed_information_request1(self):
feed_information_request1 = tm10.FeedInformationRequest(
message_id=tm10.generate_message_id()) # Required
round_trip_message(feed_information_request1)
class FeedInformationResponseTests(unittest.TestCase):
def test_feed_information_response1(self):
push_method1 = tm10.PushMethod(
push_protocol=VID_TAXII_HTTP_10, # Required
push_message_bindings=[VID_TAXII_XML_10]) # Required
polling_service1 = tm10.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTP_10, # Required
poll_address='http://example.com/PollService/', # Required
poll_message_bindings=[VID_TAXII_XML_10]) # Required
subscription_service1 = tm10.SubscriptionMethod(
subscription_protocol=VID_TAXII_HTTP_10, # Required
subscription_address='http://example.com/SubsService/', # Required
subscription_message_bindings=[VID_TAXII_XML_10]) # Required
feed1 = tm10.FeedInformation(
feed_name='Feed1', # Required
feed_description='Description of a feed', # Required
supported_contents=[CB_STIX_XML_10], # Required. List of supported content binding IDs
available=True, # Optional. Defaults to None (aka Unknown)
push_methods=[push_method1], # Required if there are no polling_services. Optional otherwise
polling_service_instances=[polling_service1], # Required if there are no push_methods. Optional otherwise.
subscription_methods=[subscription_service1]) # Optional
feed_information_response1 = tm10.FeedInformationResponse(
message_id=tm10.generate_message_id(), # Required
in_response_to=tm10.generate_message_id(), # Required. This should be the ID of the corresponding request
feed_informations=[feed1]) # Optional
round_trip_message(feed_information_response1)
def test_feed_information_response_deprecated(self):
# Test nested-class forms:
# FeedInformationResponse.FeedInformation
# FeedInformationResponse.FeedInformation.PushMethod
# FeedInformationResponse.FeedInformation.PollingServiceInstance
# FeedInformationResponse.FeedInformation.SubscriptionMethod
push_method1 = tm10.FeedInformationResponse.FeedInformation.PushMethod(
push_protocol=VID_TAXII_HTTP_10,
push_message_bindings=[VID_TAXII_XML_10])
polling_service1 = tm10.FeedInformationResponse.FeedInformation.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTP_10,
poll_address='http://example.com/PollService/',
poll_message_bindings=[VID_TAXII_XML_10])
subscription_service1 = tm10.FeedInformationResponse.FeedInformation.SubscriptionMethod(
subscription_protocol=VID_TAXII_HTTP_10,
subscription_address='http://example.com/SubsService/',
subscription_message_bindings=[VID_TAXII_XML_10])
feed1 = tm10.FeedInformationResponse.FeedInformation(
feed_name='Feed1',
feed_description='Description of a feed',
supported_contents=[CB_STIX_XML_10],
push_methods=[push_method1],
polling_service_instances=[polling_service1],
subscription_methods=[subscription_service1])
feed_information_response1 = tm10.FeedInformationResponse(
message_id=tm10.generate_message_id(),
in_response_to=tm10.generate_message_id(),
feed_informations=[feed1])
round_trip_message(feed_information_response1)
class PollResponseTests(unittest.TestCase):
def test_poll_request1(self):
poll_request1 = tm10.PollRequest(
message_id=tm10.generate_message_id(), # Required
feed_name='TheFeedToPoll', # Required
subscription_id='SubsId002', # Optional
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional - Absence means 'no lower bound'
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()), # Optional - Absence means 'no upper bound'
content_bindings=[CB_STIX_XML_10]) # Optional - defaults to accepting all content bindings
round_trip_message(poll_request1)
class PollResponseTests(unittest.TestCase):
def test_poll_response1(self):
poll_response1 = tm10.PollResponse(
message_id=tm10.generate_message_id(), # Required
in_response_to=tm10.generate_message_id(), # Required - this should be the ID of the corresponding request
feed_name='FeedName', # Required
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()), # Required
inclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional
subscription_id='SubsId001', # Optional
message='This is a message.', # Optional
content_blocks=[xml_content_block1]) # Optional
round_trip_message(poll_response1)
def test_poll_response1(self):
poll_response2 = tm10.PollResponse(
message_id=tm10.generate_message_id(), # Required
in_response_to=tm10.generate_message_id(), # Required - this should be the ID of the corresponding request
feed_name='FeedName', # Required
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()), # Required
inclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional
subscription_id='SubsId001', # Optional
message='This is a message.', # Optional
content_blocks=[string_content_block1]) # Optional
round_trip_message(poll_response2)
class StatusMessageTests(unittest.TestCase):
def test_status_message(self):
status_message1 = tm10.StatusMessage(
message_id=tm10.generate_message_id(), # Required
in_response_to=tm10.generate_message_id(), # Required. Should be the ID of the corresponding request
status_type=ST_SUCCESS, # Required
status_detail='Machine-processable info here!', # May be optional or not allowed, depending on status_type
message='This is a message.') # Optional
round_trip_message(status_message1)
def test_xml_ext_header(self):
"""
Tests an XML extended header value of etree._Element
:return:
"""
eh = {'my_ext_header_1': etree.XML(''
''
'')}
sm = tm10.StatusMessage(message_id='1',
in_response_to='2',
status_type=ST_SUCCESS,
extended_headers=eh)
round_trip_message(sm)
def test_xml_ext_header2(self):
"""
Tests an XML extended header value of etree._Element
:return:
"""
eh = {'my_ext_header_1': etree.parse(six.StringIO(''
''
''))}
sm = tm10.StatusMessage(message_id='1',
in_response_to='2',
status_type=ST_SUCCESS,
extended_headers=eh)
round_trip_message(sm)
# print etree.tostring(etree.XML(sm.to_xml(pretty_print=True)), pretty_print=True)
def test_xml_ext_header3(self):
"""
Tests an XML extended header value of string
:return:
"""
eh = {'my_ext_header_1': ''
''
''}
sm = tm10.StatusMessage(message_id='1',
in_response_to='2',
status_type=ST_SUCCESS,
extended_headers=eh)
round_trip_message(sm)
# print etree.tostring(etree.XML(sm.to_xml(pretty_print=True)), pretty_print=True)
class InboxMessageTests(unittest.TestCase):
def setUp(self):
self.subscription_information1 = tm10.SubscriptionInformation(
feed_name='SomeFeedName', # Required
subscription_id='SubsId021', # Required
inclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional - Absence means 'no lower bound'
inclusive_end_timestamp_label=datetime.datetime.now(tzutc())) # Optional - Absence means 'no upper bound'
def test_inbox_message1(self):
inbox_message1 = tm10.InboxMessage(
message_id=tm10.generate_message_id(), # Required
message='This is a message.', # Optional
subscription_information=self.subscription_information1, # Optional
content_blocks=[xml_content_block1]) # Optional
round_trip_message(inbox_message1)
def test_inbox_message2(self):
inbox_message2 = tm10.InboxMessage(
message_id=tm10.generate_message_id(), # Required
message='This is a message.', # Optional
subscription_information=self.subscription_information1, # Optional
content_blocks=[string_content_block1]) # Optional
round_trip_message(inbox_message2)
def test_inbox_message_deprecated(self):
# Test nested-class form:
# InboxMessage.SubscriptionInformation
sub_info = tm10.InboxMessage.SubscriptionInformation(
feed_name='SomeFeedName',
subscription_id='SubsId021',
inclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()))
inbox_msg = tm10.InboxMessage(
message_id=tm10.generate_message_id(),
subscription_information=sub_info,
content_blocks=[xml_content_block1])
round_trip_message(inbox_msg)
class ManageFeedSubscriptionRequestTests(unittest.TestCase):
def test_feed_subscription_request(self):
manage_feed_subscription_request1 = tm10.ManageFeedSubscriptionRequest(
message_id=tm10.generate_message_id(), # Required
feed_name='SomeFeedName', # Required
action=ACT_UNSUBSCRIBE, # Required
subscription_id='SubsId056', # Required for unsubscribe, prohibited otherwise
delivery_parameters=delivery_parameters1) # Required
round_trip_message(manage_feed_subscription_request1)
class ManageFeedSubscriptionResponseTests(unittest.TestCase):
def test_manage_feed_subscription_response(self):
poll_instance1 = tm10.PollInstance(
poll_protocol=VID_TAXII_HTTP_10, # Required
poll_address='http://example.com/poll', # Required
poll_message_bindings=[VID_TAXII_XML_10]) # Required
subscription_instance1 = tm10.SubscriptionInstance(
subscription_id='SubsId234', # required
delivery_parameters=delivery_parameters1, # Required if message is responding to a status action. Optional otherwise
poll_instances=[poll_instance1]) # Required if action was polling subscription. Optional otherwise
manage_feed_subscription_response1 = tm10.ManageFeedSubscriptionResponse(
message_id=tm10.generate_message_id(), # Required
in_response_to=tm10.generate_message_id(), # Required - Should be the ID of the corresponding request
feed_name='Feed001', # Required
message='This is a message', # Optional
subscription_instances=[subscription_instance1]) # Required
round_trip_message(manage_feed_subscription_response1)
def test_manage_feed_subscription_response_deprecated(self):
# Test nested-class forms:
# ManageFeedSubscriptionResponse.PollInstance
# ManageFeedSubscriptionResponse.SubscriptionInstance
poll = tm10.ManageFeedSubscriptionResponse.PollInstance(
poll_protocol=VID_TAXII_HTTP_10,
poll_address='http://example.com/poll',
poll_message_bindings=[VID_TAXII_XML_10])
subscription = tm10.ManageFeedSubscriptionResponse.SubscriptionInstance(
subscription_id='SubsId234',
delivery_parameters=delivery_parameters1,
poll_instances=[poll])
response = tm10.ManageFeedSubscriptionResponse(
message_id=tm10.generate_message_id(),
in_response_to=tm10.generate_message_id(),
feed_name='Feed001',
subscription_instances=[subscription])
round_trip_message(response)
class SubscriptionInformationTests(unittest.TestCase):
# See https://github.com/TAXIIProject/libtaxii/issues/110
def test_inclusive_begin_timestamp_label_must_be_datetime(self):
params = {
'feed_name': 'myfeed',
'subscription_id': 'foo',
'inclusive_begin_timestamp_label': '100',
'inclusive_end_timestamp_label': datetime.datetime.now(tzutc())
}
self.assertRaises(ValueError, tm10.SubscriptionInformation, **params)
# See https://github.com/TAXIIProject/libtaxii/issues/110
def test_inclusive_end_timestamp_label_must_be_datetime(self):
params = {
'feed_name': 'myfeed',
'subscription_id': 'foo',
'inclusive_begin_timestamp_label': datetime.datetime.now(tzutc()),
'inclusive_end_timestamp_label': '200'
}
self.assertRaises(ValueError, tm10.SubscriptionInformation, **params)
class ContentBlockTests(unittest.TestCase):
def test_content_block1(self):
cb1 = tm10.ContentBlock(content_binding=CB_STIX_XML_10,
content='')
round_trip_content_block(cb1)
def test_content_block2(self):
cb2 = tm10.ContentBlock(content_binding=CB_STIX_XML_10,
content=six.StringIO(''))
round_trip_content_block(cb2)
def test_content_block3(self):
cb3 = tm10.ContentBlock(content_binding=CB_STIX_XML_10,
content=etree.parse(six.StringIO('')))
round_trip_content_block(cb3)
def test_content_block4(self):
cb4 = tm10.ContentBlock(content_binding=CB_STIX_XML_10,
content='
Example watchlist that contains domain information.
Indicators - Watchlist
Domain Watchlist
Sample domain Indicator for this watchlist
malicious1.example.com##comma##malicious2.example.com##comma##malicious3.example.com
"""
xml_taxii_message_11 = ''
json_taxii_message_11 = '{"extended_headers": {}, "message_type": "Discovery_Request", "message_id": "1"}'
# Note that the "*_old" tests are just to make sure that backward-compatible aliases exist
test1 = tdq.Test(capability_id=CM_CORE, # Required
relationship='equals', # Required
parameters={'value': 'Test value',
'match_type': 'case_sensitive_string'} # Each relationship defines which params are and are not required
)
test1_old = tdq.DefaultQuery.Criterion.Test(capability_id=CM_CORE, # Required
relationship='equals', # Required
parameters={'value': 'Test value',
'match_type': 'case_sensitive_string'} # Each relationship defines which params are and are not required
)
test2 = tdq.Test(capability_id=CM_REGEX, # Required
relationship='matches', # Required
parameters={'value': '[A-Z]*',
'case_sensitive': True}) # Each relationship defines which params are and are not required
test2_old = tdq.DefaultQuery.Criterion.Test(capability_id=CM_REGEX, # Required
relationship='matches', # Required
parameters={'value': '[A-Z]*',
'case_sensitive': True}) # Each relationship defines which params are and are not required
test3 = tdq.Test(capability_id=CM_TIMESTAMP, # Required
relationship='greater_than', # Required
parameters={'value': datetime.datetime.now()}) # Each relationship defines which params are and are not required
test3_old = tdq.DefaultQuery.Criterion.Test(capability_id=CM_TIMESTAMP, # Required
relationship='greater_than', # Required
parameters={'value': datetime.datetime.now()}) # Each relationship defines which params are and are not required
criterion1 = tdq.Criterion(target='**', test=test1)
criterion2 = tdq.Criterion(target='STIX_Package/Indicators/Indicator/@id', test=test2)
criterion3 = tdq.Criterion(target='**/Description', test=test3)
criterion1_old = tdq.DefaultQuery.Criterion(target='**', test=test1)
criterion2_old = tdq.DefaultQuery.Criterion(target='STIX_Package/Indicators/Indicator/@id', test=test2)
criterion3_old = tdq.DefaultQuery.Criterion(target='**/Description', test=test3)
criteria1 = tdq.Criteria(operator=OP_AND, criterion=[criterion1])
criteria2 = tdq.Criteria(operator=OP_OR, criterion=[criterion1, criterion2, criterion3])
criteria3 = tdq.Criteria(operator=OP_AND, criterion=[criterion1, criterion3], criteria=[criteria2])
criteria1_old = tdq.DefaultQuery.Criteria(operator=OP_AND, criterion=[criterion1])
criteria2_old = tdq.DefaultQuery.Criteria(operator=OP_OR, criterion=[criterion1, criterion2, criterion3])
criteria3_old = tdq.DefaultQuery.Criteria(operator=OP_AND, criterion=[criterion1, criterion3], criteria=[criteria2])
query1 = tdq.DefaultQuery(CB_STIX_XML_11, criteria1)
query2 = tdq.DefaultQuery(CB_STIX_XML_11, criteria3)
subscription_parameters1 = tm11.SubscriptionParameters(
response_type=RT_COUNT_ONLY, # Optional, defaults to FULL
content_bindings=[tm11.ContentBinding(CB_STIX_XML_11)], # Optional. Absence means no restrictions on returned data
query=query1) # Optional. Absence means no query
push_parameters1 = tm11.PushParameters(
inbox_protocol=VID_TAXII_HTTPS_10, # Required
inbox_address='https://example.com/inboxAddress/', # Required
delivery_message_binding=VID_TAXII_XML_11) # Required
cb001 = tm11.ContentBlock(
content_binding=tm11.ContentBinding(CB_STIX_XML_11, subtype_ids=['test1']), # Required
content='', # Required (This isn't real STIX)
timestamp_label=datetime.datetime.now(tzutc()), # Optional
message='Hullo!', # Optional
padding='The quick brown fox jumped over the lazy dogs.') # Optional
cb002 = tm11.ContentBlock(
content_binding=tm11.ContentBinding(CB_STIX_XML_11), # Required
content=full_stix_doc) # Required
def round_trip_message(taxii_message, print_xml=False):
if not isinstance(taxii_message, tm11.TAXIIMessage):
raise ValueError('taxii_message was not an instance of TAXIIMessage')
# print '***** Message type = %s; id = %s' % (taxii_message.message_type, taxii_message.message_id)
xml_string = taxii_message.to_xml()
# The old way of validating
with warnings.catch_warnings():
warnings.simplefilter('ignore', DeprecationWarning)
valid = tm11.validate_xml(xml_string)
if valid is not True:
print('Bad XML was:')
try:
print(etree.tostring(taxii_message.to_etree(), pretty_print=True, encoding='utf-8'))
except Exception as e:
print(xml_string)
raise Exception('\tFailure of test #1 - XML not schema valid: %s' % valid)
# The new way of validating
sv = SchemaValidator(SchemaValidator.TAXII_11_SCHEMA)
try:
result = sv.validate_string(xml_string)
except etree.XMLSyntaxError:
raise
if not result.valid:
errors = [item for item in result.error_log]
raise Exception('\tFailure of test #1 - XML not schema valid: %s' % errors)
if print_xml:
print(etree.tostring(taxii_message.to_etree(), pretty_print=True, encoding='utf-8'))
msg_from_xml = tm11.get_message_from_xml(xml_string)
dictionary = taxii_message.to_dict()
msg_from_dict = tm11.get_message_from_dict(dictionary)
taxii_message.to_text() # to_text() returns a string, this just makes sure the call succeeds but doesn't validate the response
if taxii_message != msg_from_xml:
print('\t Failure of test #2 - running equals w/ debug:')
taxii_message.__eq__(msg_from_xml, True)
raise Exception('Test #2 failed - taxii_message != msg_from_xml')
if taxii_message != msg_from_dict:
print('\t Failure of test #3 - running equals w/ debug:')
taxii_message.__eq__(msg_from_dict, True)
raise Exception('Test #3 failed - taxii_message != msg_from_dict')
if msg_from_xml != msg_from_dict:
print('\t Failure of test #4 - running equals w/ debug:')
msg_from_xml.__eq__(msg_from_dict, True)
raise Exception('Test #4 failed - msg_from_xml != msg_from_dict')
# print '***** All tests completed!'
def round_trip_content_block(content_block):
if not isinstance(content_block, tm11.ContentBlock):
raise ValueError('content_block was not an instance of ContentBlock')
# print '***** Starting Content Block tests'
xml_string = content_block.to_xml()
block_from_xml = tm11.ContentBlock.from_xml(xml_string)
dictionary = content_block.to_dict()
block_from_dict = tm11.ContentBlock.from_dict(dictionary)
json_string = content_block.to_json()
block_from_json = tm11.ContentBlock.from_json(json_string)
content_block.to_text()
if content_block != block_from_xml:
print('\t Failure of test #1 - running equals w/ debug:')
content_block.__eq__(block_from_xml, True)
raise Exception('Test #1 failed - content_block != block_from_xml')
if content_block != block_from_dict:
print('\t Failure of test #2 - running equals w/ debug:')
content_block.__eq__(block_from_dict, True)
raise Exception('Test #2 failed - content_block != block_from_dict')
if block_from_xml != block_from_dict:
print('\t Failure of test #3 - running equals w/ debug:')
block_from_xml.__eq__(block_from_dict, True)
raise Exception('Test #3 failed - block_from_xml != block_from_dict')
if block_from_json != block_from_dict:
print('\t Failure of test #3 - running equals w/ debug:')
block_from_json.__eq__(block_from_dict, True)
raise Exception('Test #3 failed - block_from_json != block_from_dict')
# print '***** All tests completed!'
class GenericParametersTests(unittest.TestCase):
# https://github.com/TAXIIProject/libtaxii/issues/165
def test_typo_165(self):
# Explicitly set `response_type` to None.
sub_params = tm11.SubscriptionParameters(response_type=None)
params_xml = sub_params.to_xml()
# When parsing from XML, if no response_type is provided, it should be
# set to RT_FULL.
new_params = tm11.SubscriptionParameters.from_xml(params_xml)
self.assertEqual(RT_FULL, new_params.response_type)
class StatusMessageTests(unittest.TestCase):
def test_status_message_01(self):
sm01 = tm11.StatusMessage(
message_id='SM01', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_SUCCESS, # Required
status_detail={'custom_status_detail_name': 'Custom status detail value',
'Custom_detail_2': ['this one has', 'multiple values']}, # Required depending on Status Type. See spec for details
message='This is a test message' # Optional
)
round_trip_message(sm01)
def test_status_message_02(self):
sm02 = tm11.StatusMessage(
message_id='SM02', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_SUCCESS, # Required
status_detail=None, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm02)
def test_status_message_03(self):
sm03 = tm11.StatusMessage(
message_id='SM03', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_DESTINATION_COLLECTION_ERROR, # Required
status_detail={'ACCEPTABLE_DESTINATION': ['Collection1', 'Collection2']}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm03)
def test_status_message_04(self):
sm04 = tm11.StatusMessage(
message_id='SM04', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_INVALID_RESPONSE_PART, # Required
status_detail={'MAX_PART_NUMBER': 4}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm04)
def test_status_message_05(self):
sm05 = tm11.StatusMessage(
message_id='SM05', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_NOT_FOUND, # Required
status_detail={'ITEM': 'Collection1'}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm05)
def test_status_message_06(self):
sm06 = tm11.StatusMessage(
message_id='SM06', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_PENDING, # Required
status_detail={'ESTIMATED_WAIT': 900, 'RESULT_ID': 'Result1', 'WILL_PUSH': False}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm06)
def test_status_message_07(self):
sm07 = tm11.StatusMessage(
message_id='SM07', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_RETRY, # Required
status_detail={'ESTIMATED_WAIT': 900}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm07)
def test_status_message_08(self):
sm08 = tm11.StatusMessage(
message_id='SM08', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_UNSUPPORTED_MESSAGE_BINDING, # Required
status_detail={'SUPPORTED_BINDING': [VID_TAXII_XML_10, VID_TAXII_XML_11]}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm08)
def test_status_message_09(self):
sm09 = tm11.StatusMessage(
message_id='SM09', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_UNSUPPORTED_CONTENT_BINDING, # Required
status_detail={'SUPPORTED_CONTENT': tm11.ContentBinding(binding_id=CB_STIX_XML_101, subtype_ids=['subtype1', 'subtype2'])}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm09)
def test_status_message_10(self):
sm09 = tm11.StatusMessage(
message_id='SM10', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_UNSUPPORTED_CONTENT_BINDING, # Required
status_detail={'SUPPORTED_CONTENT': [tm11.ContentBinding(binding_id=CB_STIX_XML_101, subtype_ids=['subtype1', 'subtype2']), tm11.ContentBinding(binding_id=CB_STIX_XML_11)]}, # Required/optional depending on Status Type. See spec for details
message=None # Optional
)
round_trip_message(sm09)
def test_status_message_11(self):
# Per https://github.com/TAXIIProject/libtaxii/issues/111
kwargs = {'message_id': '1', 'in_response_to': '2', 'status_type': ST_FAILURE, 'message': {}}
self.assertRaises(ValueError, tm11.StatusMessage, **kwargs)
def test_status_message_12(self):
# https://github.com/TAXIIProject/libtaxii/issues/230
collections = ['Collection1', 'Collection2', 'Collection3']
sm12 = tm11.StatusMessage(
message_id='SM12', # Required
in_response_to=tm11.generate_message_id(), # Required, should be the ID of the message that this is in response to
status_type=ST_DESTINATION_COLLECTION_ERROR, # Required
status_detail={'ACCEPTABLE_DESTINATION': collections}, # Add 3 collections to trigger the bug
message=None # Optional
)
round_trip_message(sm12)
self.assertEqual(sm12.status_detail['ACCEPTABLE_DESTINATION'], collections)
# Parse the XML
parsed_sm12 = tm11.StatusMessage.from_xml(sm12.to_xml())
# If the bug is present the value returned will be:
# [['Collection1', 'Collection2'], 'Collection3']
self.assertEqual(parsed_sm12.status_detail['ACCEPTABLE_DESTINATION'], collections)
# TODO: TEst the query status types
def test_xml_ext_header(self):
"""
Tests an XML extended header value of etree._Element
:return:
"""
eh = {'my_ext_header_1': parse(''
''
'')}
sm = tm11.StatusMessage(message_id='1',
in_response_to='2',
status_type=ST_SUCCESS,
extended_headers=eh)
round_trip_message(sm)
def test_xml_ext_header2(self):
"""
Tests an XML extended header value of etree._Element
:return:
"""
eh = {'my_ext_header_1': parse(''
''
'')}
sm = tm11.StatusMessage(message_id='1',
in_response_to='2',
status_type=ST_SUCCESS,
extended_headers=eh)
round_trip_message(sm)
# print etree.tostring(etree.XML(sm.to_xml(pretty_print=True)), pretty_print=True)
def test_xml_ext_header3(self):
"""
Tests an XML extended header value of string
:return:
"""
eh = {'my_ext_header_1': ''
''
''}
sm = tm11.StatusMessage(message_id='1',
in_response_to='2',
status_type=ST_SUCCESS,
extended_headers=eh)
round_trip_message(sm)
# print etree.tostring(etree.XML(sm.to_xml(pretty_print=True)), pretty_print=True)
class DiscoveryRequestTests(unittest.TestCase):
def test_discovery_request(self):
discovery_request1 = tm11.DiscoveryRequest(
message_id=tm11.generate_message_id(), # Required
# Extended headers are optional for every message type, but demonstrated here
extended_headers={'ext_header1': 'value1', 'ext_header2': 'value2'}) # Optional.
round_trip_message(discovery_request1)
class DiscoveryResponseTests(unittest.TestCase):
def setUp(self):
# Create query information to use in the ServiceInstances
tei_01 = tdq.DefaultQueryInfo.TargetingExpressionInfo(
targeting_expression_id=CB_STIX_XML_10, # Required. Indicates a supported targeting vocabulary (in this case STIX 1.1)
preferred_scope=[], # At least one of Preferred/Allowed must be present. Indicates Preferred and allowed search scope.
allowed_scope=['**']) # This example has no preferred scope, and allows any scope
tei_02 = tdq.DefaultQueryInfo.TargetingExpressionInfo(
targeting_expression_id=CB_STIX_XML_11, # required. Indicates a supported targeting vocabulary (in this case STIX 1.1)
preferred_scope=['STIX_Package/Indicators/Indicator/**'], # At least one of Preferred/Allowed must be present. Indicates Preferred and allowed search scope.
allowed_scope=[]) # This example prefers the Indicator scope and allows no other scope
tdq1 = tdq.DefaultQueryInfo(
targeting_expression_infos=[tei_01, tei_02], # Required, 1-n. Indicates what targeting expressions are supported
capability_modules=[CM_CORE]) # Required, 1-n. Indicates which capability modules can be used.
tdq2 = tdq.DefaultQueryInfo(
targeting_expression_infos=[tei_02], # Required, 1-n. Indicates what targeting expressions are supported
capability_modules=[CM_REGEX]) # Required, 1-n. Indicates which capability modules can be used.
# Create ServiceInstances to use in tests
self.si1 = tm11.ServiceInstance(
service_type=SVC_POLL, # Required
services_version=VID_TAXII_SERVICES_11, # Required
protocol_binding=VID_TAXII_HTTP_10, # Required
service_address='http://example.com/poll/', # Required
message_bindings=[VID_TAXII_XML_11], # Required, must have at least one value in the list
available=True, # Optional - defaults to None, which means 'Unknown'
message='This is a message.',
supported_query=[tdq1]) # Optional for service_type=POLL
self.si2 = tm11.ServiceInstance(
service_type=SVC_POLL, # Required
services_version=VID_TAXII_SERVICES_11, # Required
protocol_binding=VID_TAXII_HTTP_10, # Required
service_address='http://example.com/poll/', # Required
message_bindings=[VID_TAXII_XML_11], # Required, must have at least one value in the list
available=True, # Optional - defaults to None, which means 'Unknown'
message='This is a message.',
supported_query=[tdq1, tdq2]) # Optional for service_type=POLL
self.si3 = tm11.ServiceInstance(
service_type=SVC_INBOX, # Required
services_version=VID_TAXII_SERVICES_11, # Required
protocol_binding=VID_TAXII_HTTP_10, # Required
service_address='http://example.com/inbox/', # Required
message_bindings=[VID_TAXII_XML_11], # Required, must have at least one value in the list
inbox_service_accepted_content=[tm11.ContentBinding(CB_STIX_XML_11),
tm11.ContentBinding(CB_STIX_XML_101),
tm11.ContentBinding(CB_STIX_XML_10)], # Optional. Defaults to "accepts all content"
available=False, # Optional - defaults to None, which means 'Unknown'
message='This is a message. Yipee!') # optional
self.si4 = tm11.ServiceInstance(
service_type=SVC_DISCOVERY, # Required
services_version=VID_TAXII_SERVICES_11, # Required
protocol_binding=VID_TAXII_HTTP_10, # Required
service_address='http://example.com/discovery/', # Required
message_bindings=[VID_TAXII_XML_11], # Required, must have at least one value in the list
message='This is a message. Yipee!') # optional
self.si5 = tm11.ServiceInstance(
service_type=SVC_COLLECTION_MANAGEMENT, # Required
services_version=VID_TAXII_SERVICES_11, # Required
protocol_binding=VID_TAXII_HTTP_10, # Required
service_address='http://example.com/collection_management/', # Required
message_bindings=[VID_TAXII_XML_11], # Required, must have at least one value in the list
message='This is a message. Yipee!') # optional
def test_discovery_response_01(self):
# Create and test various discovery responses
discovery_response01 = tm11.DiscoveryResponse(
message_id='DR01', # Required
in_response_to='TheSecondIdentifier', # Required. This should be the ID of the corresponding request
service_instances=None) # Optional.
round_trip_message(discovery_response01)
def test_discovery_response_02(self):
discovery_response02 = tm11.DiscoveryResponse(
message_id='DR02', # Required
in_response_to='TheSecondIdentifier', # Required. This should be the ID of the corresponding request
service_instances=[self.si1, self.si3, self.si5]) # Optional.
round_trip_message(discovery_response02)
def test_discovery_response_03(self):
discovery_response03 = tm11.DiscoveryResponse(
message_id='DR03', # Required
in_response_to='TheSecondIdentifier', # Required. This should be the ID of the corresponding request
service_instances=[self.si2, self.si4]) # Optional.
round_trip_message(discovery_response03)
def test_discovery_response_04(self):
discovery_response04 = tm11.DiscoveryResponse(
message_id='DR04', # Required
in_response_to='TheSecondIdentifier', # Required. This should be the ID of the corresponding request
service_instances=[self.si1, self.si2, self.si4]) # Optional.
round_trip_message(discovery_response04)
def test_discovery_response_05(self):
discovery_response05 = tm11.DiscoveryResponse(
message_id='DR05', # Required
in_response_to='TheSecondIdentifier', # Required. This should be the ID of the corresponding request
service_instances=[self.si1, self.si2, self.si3, self.si4, self.si5]) # Optional.
round_trip_message(discovery_response05)
def test_discovery_response_deprecated(self):
# Test deprecated nested form:
# DiscoveryResponse.ServiceInstance
service = tm11.DiscoveryResponse.ServiceInstance(
service_type=SVC_COLLECTION_MANAGEMENT,
services_version=VID_TAXII_SERVICES_11,
protocol_binding=VID_TAXII_HTTP_10,
service_address='http://example.com/collection_management/',
message_bindings=[VID_TAXII_XML_11])
response = tm11.DiscoveryResponse(
message_id='DR05',
in_response_to='TheSecondIdentifier',
service_instances=[service])
round_trip_message(response)
class CollectionInformationRequestTests(unittest.TestCase):
def test_collection_information_request_01(self):
cir01 = tm11.CollectionInformationRequest(
message_id='CIReq01' # Required
)
round_trip_message(cir01)
class CollectionInformationResponseTests(unittest.TestCase):
def setUp(self):
# Instantiate a push methods
push_method1 = tm11.PushMethod(
push_protocol=VID_TAXII_HTTP_10, # Required
push_message_bindings=[VID_TAXII_XML_11]) # Required
# Instantiate Poll Services
poll_service1 = tm11.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTPS_10, # Required
poll_address='https://example.com/TheGreatestPollService', # Required
poll_message_bindings=[VID_TAXII_XML_11]) # Required, at least one item must be present in the list
poll_service2 = tm11.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTP_10, # Required
poll_address='http://example.com/TheOtherPollService', # Required
poll_message_bindings=[VID_TAXII_XML_11]) # Required, at least one item must be present in the list
# Instantiate Subscription Methods
subs_method1 = tm11.SubscriptionMethod(
subscription_protocol=VID_TAXII_HTTPS_10, # Required
subscription_address='https://example.com/TheSubscriptionService/', # Required
subscription_message_bindings=[VID_TAXII_XML_11]) # Required - at least one item must be present in the list
subs_method2 = tm11.SubscriptionMethod(
subscription_protocol=VID_TAXII_HTTP_10, # Required
subscription_address='http://example.com/TheSubscriptionService/', # Required
subscription_message_bindings=[VID_TAXII_XML_11]) # Required - at least one item must be present in the list
# Instantiate Inbox Services
inbox_service1 = tm11.ReceivingInboxService(
inbox_protocol=VID_TAXII_HTTPS_10, # required
inbox_address='https://example.com/inbox/', # Required
inbox_message_bindings=[VID_TAXII_XML_11], # Required
supported_contents=None) # Optional - None means "all are supported"
inbox_service2 = tm11.ReceivingInboxService(
inbox_protocol=VID_TAXII_HTTPS_10, # required
inbox_address='https://example.com/inbox/', # Required
inbox_message_bindings=[VID_TAXII_XML_11], # Required
supported_contents=[tm11.ContentBinding(CB_STIX_XML_11, subtype_ids=['exmaple1', 'example2'])]) # Optional - None means "all are supported"
# Instantiate collections
self.collection1 = tm11.CollectionInformation(
collection_name='collection1', # Required
collection_type=CT_DATA_FEED, # Optional. Defaults to 'Data Feed'
available=False, # Optional. Defaults to None, which means "unknown"
collection_description='This is a collection', # Required
collection_volume=4, # Optional - indicates typical number of messages per day
supported_contents=[tm11.ContentBinding(CB_STIX_XML_101)], # Optional, absence indicates all content bindings
push_methods=[push_method1], # Optional - absence indicates no push methods
polling_service_instances=[poll_service1, poll_service2], # Optional - absence indicates no polling services
subscription_methods=[subs_method1, subs_method2], # optional - absence means no subscription services
receiving_inbox_services=[inbox_service1, inbox_service2]) # Optional - absence indicates no receiving inbox services
self.collection2 = tm11.CollectionInformation(
collection_name='collection2', # Required
collection_type=CT_DATA_SET, # Optional. Defaults to 'Data Feed'
collection_description='Warrgghghglble.') # Required
self.collection3 = tm11.CollectionInformation(
collection_name='collection3', # Required
collection_description='You must pay all the dollars to have this information.', # Required
supported_contents=[tm11.ContentBinding(CB_STIX_XML_10), tm11.ContentBinding(CB_STIX_XML_11)], # Optional
polling_service_instances=[poll_service2], # Optional - absence indicates no polling services
subscription_methods=[subs_method2], # optional - absence means no subscription services
receiving_inbox_services=[inbox_service2]) # Optional - absence indicates no receiving inbox services
self.collection4 = tm11.CollectionInformation(
collection_name='collection4', # Required
collection_description='So improve information. Much amaze.', # Required
supported_contents=[tm11.ContentBinding(CB_STIX_XML_101, subtype_ids=['ex1', 'ex2', 'ex3'])], # Optional
receiving_inbox_services=[inbox_service1, inbox_service2]) # Optional - absence indicates no receiving inbox services
def test_collection_information_response_01(self):
collection_response1 = tm11.CollectionInformationResponse(
message_id='CIR01', # Required
in_response_to='0', # Required - should be the ID of the message tha this message is a response to
collection_informations=[self.collection1]) # Optional - absence means "no collections"
round_trip_message(collection_response1)
def test_collection_information_response_02(self):
collection_response2 = tm11.CollectionInformationResponse(
message_id='CIR02', # Required
in_response_to='0', # Required - should be the ID of the message tha this message is a response to
collection_informations=[self.collection1, self.collection2, self.collection3, self.collection4]) # Optional - absence means "no collections"
round_trip_message(collection_response2)
def test_collection_information_response_03(self):
collection_response3 = tm11.CollectionInformationResponse(
message_id='CIR03', # Required
in_response_to='0') # Required - should be the ID of the message tha this message is a response to
round_trip_message(collection_response3)
def test_collection_information_response_04(self):
collection_response4 = tm11.CollectionInformationResponse(
message_id='CIR04', # Required
in_response_to='0', # Required - should be the ID of the message tha this message is a response to
collection_informations=[self.collection1, self.collection4]) # Optional - absence means "no collections"
round_trip_message(collection_response4)
def test_collection_information_response_05(self):
collection_response5 = tm11.CollectionInformationResponse(
message_id='CIR05', # Required
in_response_to='0', # Required - should be the ID of the message tha this message is a response to
collection_informations=[self.collection2, self.collection4]) # Optional - absence means "no collections"
round_trip_message(collection_response5)
def test_collection_information_response_deprecated(self):
# Test deprecated nested forms:
# CollectionInformationResponse.CollectionInformation
# CollectionInformationResponse.CollectionInformation.PushMethod
# CollectionInformationResponse.CollectionInformation.PollingServiceInstance
# CollectionInformationResponse.CollectionInformation.SubscriptionMethod
# CollectionInformationResponse.CollectionInformation.ReceivingInboxService
push_method = tm11.CollectionInformationResponse.CollectionInformation.PushMethod(
push_protocol=VID_TAXII_HTTP_10,
push_message_bindings=[VID_TAXII_XML_11])
poll_service = tm11.CollectionInformationResponse.CollectionInformation.PollingServiceInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/TheGreatestPollService',
poll_message_bindings=[VID_TAXII_XML_11])
subs_method = tm11.CollectionInformationResponse.CollectionInformation.SubscriptionMethod(
subscription_protocol=VID_TAXII_HTTPS_10,
subscription_address='https://example.com/TheSubscriptionService/',
subscription_message_bindings=[VID_TAXII_XML_11])
inbox_service = tm11.CollectionInformationResponse.CollectionInformation.ReceivingInboxService(
inbox_protocol=VID_TAXII_HTTPS_10,
inbox_address='https://example.com/inbox/',
inbox_message_bindings=[VID_TAXII_XML_11])
collection = tm11.CollectionInformationResponse.CollectionInformation(
collection_name='collection1',
collection_description='This is a collection',
push_methods=[push_method],
polling_service_instances=[poll_service],
subscription_methods=[subs_method],
receiving_inbox_services=[inbox_service])
response = tm11.CollectionInformationResponse(
message_id='CIR05',
in_response_to='0',
collection_informations=[collection])
round_trip_message(response)
class ManageCollectionSubscriptionRequestTests(unittest.TestCase):
def test_subs_req1(self):
subs_req1 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq01', # Required
action=ACT_SUBSCRIBE, # Required
collection_name='collection1', # Required
# subscription_id = None, #Prohibited for action = SUBSCRIBE
subscription_parameters=subscription_parameters1, # optional - absence means there are not any subscription parameters
push_parameters=push_parameters1) # Optional - absence means push messaging not requested
round_trip_message(subs_req1)
def test_subs_req2(self):
subscription_parameters2 = tm11.SubscriptionParameters(
response_type=RT_FULL, # Optional, defaults to FULL
# content_bindings = [tm11.ContentBinding(CB_STIX_XML_11)],#Optional. Absence means no restrictions on returned data
query=query2) # Optional. Absence means no query
subs_req2 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq02', # Required
action=ACT_SUBSCRIBE, # Required
collection_name='collection2', # Required
# subscription_id = None, #Prohibited for action = SUBSCRIBE
subscription_parameters=subscription_parameters2) # optional - absence means there are not any subscription parameters
# delivery_parameters = None)#Optional - absence means push messaging not requested
round_trip_message(subs_req2)
def test_subs_req3(self):
subscription_parameters3 = tm11.SubscriptionParameters() # Use all the defaults
subs_req3 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq03', # Required
action=ACT_SUBSCRIBE, # Required
collection_name='collection2', # Required
# subscription_id = None, #Prohibited for action = SUBSCRIBE
subscription_parameters=subscription_parameters3) # optional - absence means there are not any subscription parameters
# delivery_parameters = None)#Optional - absence means push messaging not requested
round_trip_message(subs_req3)
def test_subs_req4(self):
subs_req4 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq04', # Required
action=ACT_SUBSCRIBE, # Required
collection_name='collection2') # Required
# subscription_id = None, #Prohibited for action = SUBSCRIBE
# subscription_parameters = subscription_parameters2,#optional - absence means there are not any subscription parameters
# delivery_parameters = None)#Optional - absence means push messaging not requested
round_trip_message(subs_req4)
def test_subs_req5(self):
subs_req5 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq05', # Required
action=ACT_STATUS, # Required
collection_name='collection2', # Required
subscription_id='id1') # Optional for ACT_STATUS
# subscription_parameters, delivery_parameters prohibited if action != SUBSCRIBE
round_trip_message(subs_req5)
def test_subs_req6(self):
subs_req6 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq06', # Required
action=ACT_STATUS, # Required
collection_name='collection2') # Required
# subscription_id = 'id1') #Optional for ACT_STATUS
# subscription_parameters, delivery_parameters prohibited if action != SUBSCRIBE
round_trip_message(subs_req6)
def test_subs_req7(self):
subs_req7 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq07', # Required
action=ACT_PAUSE, # Required
collection_name='collection2', # Required
subscription_id='id1') # Optional for ACT_STATUS
# subscription_parameters, delivery_parameters prohibited if action != SUBSCRIBE
round_trip_message(subs_req7)
def test_subs_req8(self):
subs_req8 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq08', # Required
action=ACT_RESUME, # Required
collection_name='collection2', # Required
subscription_id='id1') # Optional for ACT_STATUS
# subscription_parameters, delivery_parameters prohibited if action != SUBSCRIBE
round_trip_message(subs_req8)
def test_subs_req9(self):
# https://github.com/TAXIIProject/libtaxii/pull/237
subscription = """{"content_bindings": [{"binding_id": "urn:stix.mitre.org:xml:1.2"}], "query": null, "response_type": "FULL"}"""
subscription_dict = json.loads(subscription)
subscription_parameters9 = tm11.SubscriptionParameters(**subscription_dict) # Use all the defaults
subs_req9 = tm11.ManageCollectionSubscriptionRequest(
message_id='SubsReq09', # Required
action=ACT_SUBSCRIBE, # Required
collection_name='collection2', # Required
# subscription_id = None, #Prohibited for action = SUBSCRIBE
subscription_parameters=subscription_parameters9) # optional - absence means there are not any subscription parameters
# delivery_parameters = None)#Optional - absence means push messaging not requested
round_trip_message(subs_req9)
class ManageCollectionSubscriptionResponseTests(unittest.TestCase):
def setUp(self):
poll_instance1 = tm11.PollInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/poll1/',
poll_message_bindings=[VID_TAXII_XML_11])
poll_instance2 = tm11.PollInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/poll2/',
poll_message_bindings=[VID_TAXII_XML_11])
poll_instance3 = tm11.PollInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/poll3/',
poll_message_bindings=[VID_TAXII_XML_11])
self.subs1 = tm11.SubscriptionInstance(
status=SS_ACTIVE, # Optional, defaults to ACTIVE
subscription_id='Subs001', # Required
subscription_parameters=subscription_parameters1, # Optional - should be an echo of the request
push_parameters=push_parameters1, # Optional - should be an echo of the request
poll_instances=[poll_instance1, poll_instance2, poll_instance3], # Optional
)
def test_subs_resp1(self):
subs2 = tm11.SubscriptionInstance(
status=SS_PAUSED, # Optional, defaults to ACTIVE
subscription_id='Subs001', # Required
subscription_parameters=subscription_parameters1, # Optional - should be an echo of the request
push_parameters=push_parameters1, # Optional - should be an echo of the request
# poll_instances = [poll_instance1, poll_instance2, poll_instance3],#Optional
)
subs3 = tm11.SubscriptionInstance(
status=SS_PAUSED, # Optional, defaults to ACTIVE
subscription_id='Subs001', # Required
# subscription_parameters = subscription_parameters1,#Optional - should be an echo of the request
# push_parameters = delivery_parameters1,#Optional - should be an echo of the request
# poll_instances = [poll_instance1, poll_instance2, poll_instance3],#Optional
)
subs_resp1 = tm11.ManageCollectionSubscriptionResponse(
message_id='SubsResp01', # Required
in_response_to='xyz', # Required - should be the ID of the message that this is a response to
collection_name='abc123', # Required
message='Hullo!', # Optional
subscription_instances=[self.subs1, subs2, subs3], # Optional
)
round_trip_message(subs_resp1)
def test_subs_resp2(self):
subs_resp2 = tm11.ManageCollectionSubscriptionResponse(
message_id='SubsResp02', # Required
in_response_to='xyz', # Required - should be the ID of the message that this is a response to
collection_name='abc123', # Required
# message = 'Hullo!', #Optional
# subscription_instances = [subs1, subs2, subs3],#Optional
)
round_trip_message(subs_resp2)
def test_subs_resp3(self):
subs_resp3 = tm11.ManageCollectionSubscriptionResponse(
message_id='SubsResp03', # Required
in_response_to='xyz', # Required - should be the ID of the message that this is a response to
collection_name='abc123', # Required
# message = 'Hullo!', #Optional
subscription_instances=[self.subs1], # Optional
)
round_trip_message(subs_resp3)
def test_subs_resp4(self):
subs_resp4 = tm11.ManageCollectionSubscriptionResponse(
message_id='SubsResp04', # Required
in_response_to='xyz', # Required - should be the ID of the message that this is a response to
collection_name='abc123', # Required
message='Hullo!', # Optional
# subscription_instances = [subs1, subs2, subs3],#Optional
)
round_trip_message(subs_resp4)
def test_subs_resp_deprecated(self):
# Test deprecated nested forms:
# ManageCollectionSubscriptionResponse.PollInstance
# ManageCollectionSubscriptionResponse.SubscriptionInstance
poll = tm11.ManageCollectionSubscriptionResponse.PollInstance(
poll_protocol=VID_TAXII_HTTPS_10,
poll_address='https://example.com/poll1/',
poll_message_bindings=[VID_TAXII_XML_11])
subscription = tm11.ManageCollectionSubscriptionResponse.SubscriptionInstance(
subscription_id='Subs001',
subscription_parameters=subscription_parameters1,
push_parameters=push_parameters1,
poll_instances=[poll])
subs_resp = tm11.ManageCollectionSubscriptionResponse(
message_id='SubsResp01',
in_response_to='xyz',
collection_name='abc123',
subscription_instances=[subscription])
round_trip_message(subs_resp)
class PollRequestTests(unittest.TestCase):
def test_poll_req1(self):
poll_req1 = tm11.PollRequest(
message_id='PollReq01', # Required
collection_name='collection100', # Required
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional for a Data Feed, prohibited for a Data Set
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()), # Optional for a Data Feed, prohibited for a Data Set
subscription_id='12345', # Optional - one of this or poll_parameters MUST be present.
poll_parameters=None) # Optional - one of this or subscription_id MUST be present
round_trip_message(poll_req1)
def test_poll_req2(self):
poll_req2 = tm11.PollRequest(
message_id='PollReq02', # Required
collection_name='collection100', # Required
subscription_id='Kenneth Coal Collection', # Optional - one of this or poll_parameters MUST be present.
poll_parameters=None) # Optional - one of this or subscription_id MUST be present
round_trip_message(poll_req2)
def test_poll_req3(self):
delivery_parameters1 = tm11.DeliveryParameters(
inbox_protocol=VID_TAXII_HTTPS_10, # Required
inbox_address='https://example.com/inboxAddress/', # Required
delivery_message_binding=VID_TAXII_XML_11) # Required
poll_params1 = tm11.PollParameters(
allow_asynch=False, # Optional, defaults to False
response_type=RT_COUNT_ONLY, # Optional, defaults to RT_FULL
content_bindings=[tm11.ContentBinding(binding_id=CB_STIX_XML_11)], # Optional, defaults to None, which means "all bindings are accepted in response"
query=query1, # Optional - defaults to None
delivery_parameters=delivery_parameters1) # Optional - defaults to None
poll_req3 = tm11.PollRequest(
message_id='PollReq03', # Required
collection_name='collection100', # Required
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional for a Data Feed, prohibited for a Data Set
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()), # Optional for a Data Feed, prohibited for a Data Set
poll_parameters=poll_params1) # Optional - one of this or subscription_id MUST be present
round_trip_message(poll_req3)
def test_poll_req4(self):
poll_params2 = tm11.PollParameters()
poll_req4 = tm11.PollRequest(
message_id='PollReq04', # Required
collection_name='collection100', # Required
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()), # Optional for a Data Feed, prohibited for a Data Set
poll_parameters=poll_params2) # Optional - one of this or subscription_id MUST be present
round_trip_message(poll_req4)
def test_poll_req5(self):
poll_params3 = tm11.PollParameters(query=query1) # Optional - defaults to None)#Optional - defaults to None
poll_req5 = tm11.PollRequest(
message_id='PollReq05', # Required
collection_name='collection100', # Required
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional for a Data Feed, prohibited for a Data Set
poll_parameters=poll_params3) # Optional - one of this or subscription_id MUST be present
round_trip_message(poll_req5)
def test_poll_req_deprecated(self):
# Test deprecated nested form:
# PollRequest.PollParameters
params = tm11.PollRequest.PollParameters()
poll = tm11.PollRequest(
message_id='PollReq05',
collection_name='collection100',
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()),
poll_parameters=params)
round_trip_message(poll)
class PollResponseTests(unittest.TestCase):
def test_poll_resp1(self):
poll_resp1 = tm11.PollResponse(
message_id='PollResp1', # Required
in_response_to='tmp', # Required. Must be the message that this is a response to
collection_name='blah', # Required
more=True, # Optional - defaults to false
result_id='123', # Optional
result_part_number=1, # optional
subscription_id='24', # optional
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional for data feeds, prohibited for data sets
inclusive_end_timestamp_label=datetime.datetime.now(tzutc()), # required for data feeds, prohibited for data sets
record_count=tm11.RecordCount(record_count=22, partial_count=False),
message='Woooooooo', # optional
content_blocks=[]) # optional
round_trip_message(poll_resp1)
def test_poll_resp2(self):
poll_resp2 = tm11.PollResponse(
message_id='PollResp2', # Required
in_response_to='tmp', # Required. Must be the message that this is a response to
collection_name='blah') # Required
round_trip_message(poll_resp2)
def test_poll_resp3(self):
poll_resp3 = tm11.PollResponse(
message_id='PollResp3', # Required
in_response_to='tmp', # Required. Must be the message that this is a response to
collection_name='blah', # Required
result_id='123', # Optional
subscription_id='24', # optional
record_count=tm11.RecordCount(record_count=22),
content_blocks=[]) # optional
round_trip_message(poll_resp3)
def test_poll_resp4(self):
poll_resp4 = tm11.PollResponse(
message_id='PollResp4', # Required
in_response_to='tmp', # Required. Must be the message that this is a response to
collection_name='blah', # Required
# content_blocks = [cb001, cb002])#optional
content_blocks=[]) # optional
round_trip_message(poll_resp4)
def test_poll_resp5(self):
poll_resp5 = tm11.PollResponse(
message_id='PollResp5',
in_response_to='blah',
collection_name='foo',
result_part_number=10,
content_blocks=[])
round_trip_message(poll_resp5)
class InboxMessageTests(unittest.TestCase):
def test_inbox1(self):
subs_info1 = tm11.SubscriptionInformation(
collection_name='SomeCollectionName', # Required
subscription_id='SubsId021', # Required
exclusive_begin_timestamp_label=datetime.datetime.now(tzutc()), # Optional for data feeds, prohibited for data sets
inclusive_end_timestamp_label=datetime.datetime.now(tzutc())) # Optional for data feeds, prohibited for data sets
inbox1 = tm11.InboxMessage(
message_id='Inbox1', # Required
result_id='123', # Optional
destination_collection_names=['collection1', 'collection2'], # Optional
message='Hello!', # Optional
subscription_information=subs_info1, # Optional
record_count=tm11.RecordCount(22, partial_count=True), # Optional
content_blocks=[cb001, cb002])
round_trip_message(inbox1)
def test_inbox2(self):
inbox2 = tm11.InboxMessage(message_id='Inbox1') # Required
round_trip_message(inbox2)
def test_inbox3(self):
subs_info2 = tm11.SubscriptionInformation(
collection_name='SomeCollectionName', # Required
subscription_id='SubsId021') # Required
inbox3 = tm11.InboxMessage(
message_id='Inbox3', # Required
result_id='123', # Optional
destination_collection_names=['collection1', 'collection2'], # Optional
subscription_information=subs_info2, # Optional
content_blocks=[cb002])
round_trip_message(inbox3)
def test_inbox_deprecated(self):
# Test deprecated nested form:
# InboxMessage.SubscriptionInformation
subscription = tm11.InboxMessage.SubscriptionInformation(
collection_name='SomeCollectionName',
subscription_id='SubsId021')
inbox = tm11.InboxMessage(
message_id='InboxMsg0001',
subscription_information=subscription,
content_blocks=[cb002])
round_trip_message(inbox)
class PollFulfillmentTests(unittest.TestCase):
def test_poll_fulfillment1(self):
pf1 = tm11.PollFulfillmentRequest(
message_id='pf1', # required
collection_name='1-800-collection', # required
result_id='123', # required
result_part_number=1) # required
round_trip_message(pf1)
class SubscriptionInformationTests(unittest.TestCase):
# See https://github.com/TAXIIProject/libtaxii/issues/110
def test_exclusive_begin_timestamp_label_must_be_datetime(self):
params = {
'collection_name': 'foo',
'subscription_id': 'baz',
'exclusive_begin_timestamp_label': '100'
}
self.assertRaises(ValueError, tm11.SubscriptionInformation, **params)
# See https://github.com/TAXIIProject/libtaxii/issues/110
def test_110_2(self):
"""
Test for https://github.com/TAXIIProject/libtaxii/issues/110
:return:
"""
params = {
'collection_name': 'foo',
'subscription_id': 'baz',
'inclusive_end_timestamp_label': '100'
}
self.assertRaises(ValueError, tm11.SubscriptionInformation, **params)
class ContentBlockTests(unittest.TestCase):
def test_content_block01(self):
cb1 = tm11.ContentBlock(content_binding=tm11.ContentBinding(CB_STIX_XML_10),
content='')
round_trip_content_block(cb1)
def test_content_block02(self):
cb2 = tm11.ContentBlock(content_binding=tm11.ContentBinding(CB_STIX_XML_10),
content=six.StringIO(''))
round_trip_content_block(cb2)
def test_content_block03(self):
cb3 = tm11.ContentBlock(content_binding=tm11.ContentBinding(CB_STIX_XML_10),
content=parse(''))
round_trip_content_block(cb3)
def test_content_block04(self):
cb4 = tm11.ContentBlock(content_binding=tm11.ContentBinding(CB_STIX_XML_10),
content='
]>
&lol1;"""
e = parse(billion_laughs)
if e.text is not None:
raise ValueError("The text of e was not None, meaning a real attack would have succeeded!")
def test_guadratic_blowup(self):
"""
Tests a "safe" variant of the quadratic blowup attack
http://msdn.microsoft.com/en-us/magazine/ee335713.aspx
:return:
"""
q_blowup = """
]>
&a;
"""
e = parse(q_blowup)
if e.text is not None:
raise ValueError('The text of e was not None, meaning a real attack would have succeeded!')
def test_xee_remote(self):
"""
Tests a "safe" variant of the remote XEE attack
https://www.owasp.org/index.php/XML_External_Entity_(XXE)_Processing
:return:
"""
xee_remote = """
]>
&xxe;
"""
# If an XML Syntax Error is received, an attack would have succeeded
try:
e = parse(xee_remote)
except etree.XMLSyntaxError:
raise ValueError("An XML Syntax Error was raised, meaning a real attack would have succeeded!")
def test_xee_local(self):
"""
Tests a "safe" variant of the local XEE attack
https://www.owasp.org/index.php/XML_External_Entity_(XXE)_Processing
:return:
"""
xee_local = """
]>
&xxe;
"""
# If an XML Syntax Error is received, an attack would have succeeded
try:
e = parse(xee_local)
except etree.XMLSyntaxError:
raise ValueError("An XML Syntax Error was raised, meaning a real attack would have succeeded!")
def test_ssrf(self):
"""
Tests that external URLs are forbidden by default.
https://github.com/TAXIIProject/libtaxii/issues/246
"""
try:
parse("http://localhost/")
except ValueError:
pass
else:
raise AssertionError("oh no!")
try:
parse("ftp://localhost/")
except ValueError:
pass
else:
raise AssertionError("oh no!")
def test_local_filesystem_access(self):
"""No access to files allowed with allow_file=False
"""
try:
parse("file:///etc/hosts/", allow_file=False, allow_url=True)
except etree.XMLSyntaxError:
pass
else:
raise AssertionError("oh no!")
try:
parse("/etc/hosts/", allow_file=False)
except etree.XMLSyntaxError:
pass
else:
raise AssertionError("oh no!")
def test_dtd_retrieval(self):
pass
def test_gzip_bomb(self):
pass
def test_xpath(self):
pass
def test_xslt(self):
pass
def test_xinclude(self):
pass
class VersionsTest(unittest.TestCase):
def test_01(self):
"""
Tests that all tm10 objects have a version attribute
:return:
"""
for name, obj in inspect.getmembers(tm11, inspect.isclass):
# Certain classes are excluded from this test:
if name in ('TAXIIBase', 'UnsupportedQueryException', '_StatusDetail'):
continue
obj.version
# Encodings pulled from: https://docs.python.org/2/library/codecs.html
PYTHON_ENCODINGS = ['ascii',
'big5',
'big5hkscs',
'cp037',
'cp424',
'cp437',
'cp500',
'cp720',
'cp737',
'cp775',
'cp850',
'cp852',
'cp855',
'cp856',
'cp857',
'cp858',
'cp860',
'cp861',
'cp862',
'cp863',
'cp864',
'cp865',
'cp866',
'cp869',
'cp874',
'cp875',
'cp932',
'cp949',
'cp950',
'cp1006',
'cp1026',
'cp1140',
'cp1250',
'cp1251',
'cp1252',
'cp1253',
'cp1254',
'cp1255',
'cp1256',
'cp1257',
'cp1258',
'euc_jp',
'euc_jis_2004',
'euc_jisx0213',
'euc_kr',
'gb2312',
'gbk',
'gb18030',
'hz',
'iso2022_jp',
'iso2022_jp_1',
'iso2022_jp_2',
'iso2022_jp_2004',
'iso2022_jp_3',
'iso2022_jp_ext',
'iso2022_kr',
'latin_1',
'iso8859_2',
'iso8859_3',
'iso8859_4',
'iso8859_5',
'iso8859_6',
'iso8859_7',
'iso8859_8',
'iso8859_9',
'iso8859_10',
'iso8859_13',
'iso8859_14',
'iso8859_15',
'iso8859_16',
'johab',
'koi8_r',
'koi8_u',
'mac_cyrillic',
'mac_greek',
'mac_iceland',
'mac_latin2',
'mac_roman',
'mac_turkish',
'ptcp154',
'shift_jis',
'shift_jis_2004',
'shift_jisx0213',
'utf_32',
'utf_32_be',
'utf_32_le',
'utf_16',
'utf_16_be',
'utf_16_le',
'utf_7',
'utf_8',
'utf_8_sig',
]
class EncodingsTest(unittest.TestCase):
def test_01(self):
"""
Test all the encodings for TAXII 1.1 XML
"""
for encoding in PYTHON_ENCODINGS:
if encoding in ('cp720', 'cp858', 'iso8859_11') and (sys.version_info[0] == 2 and sys.version_info[1] == 6):
continue # This encoding is not supported in Python 2.6
encoded_doc = xml_taxii_message_11.encode(encoding, 'strict')
try:
msg = tm11.get_message_from_xml(encoded_doc, encoding)
except Exception as e:
print('Bad codec was: %s' % encoding)
raise
def test_02(self):
"""
Test all the encodings for TAXII 1.1 JSON
"""
for encoding in PYTHON_ENCODINGS:
if encoding in ('cp720', 'cp858', 'iso8859_11') and (sys.version_info[0] == 2 and sys.version_info[1] == 6):
continue # This encoding is not supported in Python 2.6
encoded_doc = json_taxii_message_11.encode(encoding, 'strict')
try:
msg = tm11.get_message_from_json(encoded_doc, encoding)
except Exception as e:
print('Bad codec was: %s' % encoding)
raise
if __name__ == "__main__":
unittest.main()
libtaxii-1.1.119/libtaxii/test/output/ 0000775 0000000 0000000 00000000000 14036072565 0017625 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/test/output/1.1/ 0000775 0000000 0000000 00000000000 14036072565 0020124 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/test/output/1.1/readme.md 0000664 0000000 0000000 00000000042 14036072565 0021677 0 ustar 00root root 0000000 0000000 Placeholder for Test output files. libtaxii-1.1.119/libtaxii/test/test_clients.py 0000664 0000000 0000000 00000000527 14036072565 0021343 0 ustar 00root root 0000000 0000000 from __future__ import unicode_literals
from lxml import etree
from libtaxii.clients import VerifiableHTTPSConnection
def test_connection():
# This is a basic test just to confirm that we pass the right arguments
# in the right order to a (non-TAXII) HTTPS server
conn = VerifiableHTTPSConnection("https://httpbin.org/", 443)
libtaxii-1.1.119/libtaxii/test/test_xml_encoding.py 0000664 0000000 0000000 00000010151 14036072565 0022342 0 ustar 00root root 0000000 0000000 from __future__ import unicode_literals
from lxml import etree
from libtaxii.common import parse_xml_string
from libtaxii.constants import CB_STIX_XML_111
from libtaxii.messages_10 import ContentBlock as ContentBlock10
from libtaxii.messages_11 import get_message_from_xml, ContentBlock as ContentBlock11
discovery_request_with_encoding_bytes = b"""
"""
discovery_request_with_encoding_unicode = """
"""
stix_package_bytes = b"""
Test Package
"""
stix_package_unicode = """
Test Package
"""
def test_parsing_byte_string_with_encoding():
x = parse_xml_string(b"""""")
assert x.tag == "foo"
def test_parsing_byte_string_without_encoding():
x = parse_xml_string(b"""""")
assert x.tag == "bar"
def test_parsing_unicode_string_with_encoding():
x = parse_xml_string("""""")
assert x.tag == "baz"
def test_parsing_unicode_string_without_encoding():
x = parse_xml_string("""""")
assert x.tag == "quz"
def test_get_xml_from_byte_string():
req = get_message_from_xml(discovery_request_with_encoding_bytes)
assert req is not None
assert req.message_id == "331bf15a-76a0-4e29-8444-6e986e514e29"
def test_get_xml_from_unicode_string():
req = get_message_from_xml(discovery_request_with_encoding_unicode)
assert req is not None
assert req.message_id == "331bf15a-76a0-4e29-8444-6e986e514e29"
def test_content_block_11_bytes():
content_block = ContentBlock11(CB_STIX_XML_111, stix_package_bytes)
assert content_block.content_is_xml is True
assert b"Indicator-ba1d406e-937c-414f-9231-6e1dbe64fe8b" in content_block.content
def test_content_block_11_unicode():
content_block = ContentBlock11(CB_STIX_XML_111, stix_package_unicode)
assert content_block.content_is_xml is True
# Content is always in bytes
assert b"Indicator-ba1d406e-937c-414f-9231-6e1dbe64fe8b" in content_block.content
def test_content_block_10_bytes():
content_block = ContentBlock10(CB_STIX_XML_111, stix_package_bytes)
assert content_block.content_is_xml is True
assert isinstance(content_block._content, etree._Element)
assert b"Indicator-ba1d406e-937c-414f-9231-6e1dbe64fe8b" in content_block.content
def test_content_block_10_unicode():
content_block = ContentBlock10(CB_STIX_XML_111, stix_package_unicode)
assert content_block.content_is_xml is True
# Content is always in bytes
assert isinstance(content_block._content, etree._Element)
assert b"Indicator-ba1d406e-937c-414f-9231-6e1dbe64fe8b" in content_block.content
libtaxii-1.1.119/libtaxii/test/to_text_11_test.py 0000664 0000000 0000000 00000001761 14036072565 0021672 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import glob
import os
import libtaxii.messages_11 as tm11
input_path = os.path.join('input', '1.1')
output_path = os.path.join('output', '1.1')
def main():
input_fns = glob.glob(os.path.join(input_path, '*.xml'))
for input_fn in input_fns:
with open(input_fn, 'r') as f:
text = f.read()
# parse the file to a TAXII message/object
msg = tm11.get_message_from_xml(text)
# create the output files
basename = os.path.splitext(os.path.basename(input_fn))[0]
# write XML and text to files.
xml_out = os.path.join(output_path, basename + ".xml")
with open(xml_out, 'w') as f:
f.write(msg.to_xml(pretty_print=True))
txt_out = os.path.join(output_path, basename + ".txt")
with open(txt_out, 'w') as f:
f.write(msg.to_text())
if __name__ == '__main__':
main()
libtaxii-1.1.119/libtaxii/test/validation_test.py 0000664 0000000 0000000 00000001374 14036072565 0022035 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
import unittest
from libtaxii.validation import do_check, message_id_regex_10
class ValidationTests(unittest.TestCase):
def test_numeric_regex_valid(self):
# This message ID is valid. It should not raise an exception
do_check("12345", "Test Value", regex_tuple=message_id_regex_10)
# See: https://github.com/TAXIIProject/libtaxii/issues/166
def test_numeric_regex_invalid_end(self):
# This message ID is not valid.
args = ("12345abcd", "Message ID")
kwargs = {'regex_tuple': message_id_regex_10}
self.assertRaises(ValueError, do_check, *args, **kwargs)
if __name__ == '__main__':
unittest.main()
libtaxii-1.1.119/libtaxii/validation.py 0000664 0000000 0000000 00000017173 14036072565 0020023 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
"""
Common data validation functions used across libtaxii
"""
import collections
import re
import datetime
from lxml import etree
import os
from .common import (parse, parse_datetime_string)
import six
# General purpose helper methods #
RegexTuple = collections.namedtuple('_RegexTuple', ['regex', 'title'])
# URI regex per http://tools.ietf.org/html/rfc3986
uri_regex = RegexTuple("(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?", "URI Format")
message_id_regex_10 = RegexTuple("^[0-9]+$", "Numbers only")
targeting_expression_regex = RegexTuple("^(@?\w+|\*{1,2})(/(@?\w+|\*{1,2}))*$", "Targeting Expression Syntax")
_none_error = "%s is not allowed to be None and the provided value was None"
_type_error = "%s must be of type %s. The incorrect value was of type %s"
_regex_error = "%s must be a string conforming to %s. The incorrect value was: %s"
_tuple_error = "%s must be one of %s. The incorrect value was %s"
def do_check(var, varname, type=None, regex_tuple=None, value_tuple=None, can_be_none=False):
"""
Checks supplied var against all of the supplied checks using the following
process:
1. If var is iterable, call this function for every item in the iterable object
2. If the var is none and can be none, return
3. If the var is none and cannot be none, raise ValueError
4. If a type is specified, and the var is not of the specified type, raise ValueError
5. If a regex is specified, and the var doesn't match the regex, raise ValueError
6. If a value_tuple is specified, and the var is not in the value_tuple, raise ValueError
varname is used in the error messages
"""
if isinstance(var, list) or isinstance(var, set) or isinstance(var, tuple):
x = 0
for item in var:
do_check(item, "%s[%s]" % (varname, x), type, regex_tuple, value_tuple, can_be_none)
x = x + 1
return
if var is None and can_be_none:
return
if var is None and not can_be_none:
raise ValueError(_none_error % varname)
if type is not None:
if not isinstance(var, type):
bad_type = var.__class__.__name__
raise ValueError(_type_error % (varname, type, bad_type))
if regex_tuple is not None:
if not isinstance(var, six.string_types):
raise ValueError('%s was about to undergo a regex check, but is not of type basestring! Regex check was not performed' % (varname))
if re.match(regex_tuple.regex, var) is None:
raise ValueError(_regex_error % (varname, regex_tuple.title, var))
if value_tuple is not None:
if var not in value_tuple:
raise ValueError(_tuple_error % (varname, value_tuple, var))
return
def check_timestamp_label(timestamp_label, varname, can_be_none=False):
"""
Checks the timestamp_label to see if it is a valid timestamp label
using the following process:
1. If the timestamp_label is None and is allowed to be None, Pass
2. If the timestamp_label is None and is not allowed to be None, Fail
3. If the timestamp_label arg is a string, convert to datetime
4. If the timestamp_label does not have a tzinfo attribute, Fail
5. Pass
"""
if timestamp_label is None and can_be_none:
return
if timestamp_label is None and not can_be_none:
raise ValueError(_none_error % varname)
if isinstance(timestamp_label, six.string_types):
timestamp_label = parse_datetime_string(timestamp_label)
do_check(timestamp_label, varname, type=datetime.datetime, can_be_none=can_be_none)
if timestamp_label.tzinfo is None:
raise ValueError('%s.tzinfo must not be None!' % varname)
return timestamp_label
class SchemaValidationResult(object):
"""A wrapper for the results of schema validation."""
def __init__(self, valid, error_log):
self.valid = valid
self.error_log = error_log
_pkg_dir = os.path.dirname(__file__)
#: Automatically-calculated path to the bundled TAXII 1.0 schema.
TAXII_10_SCHEMA = os.path.join(_pkg_dir, "xsd", "TAXII_XMLMessageBinding_Schema.xsd")
#: Automatically-calculated path to the bundled TAXII 1.1 schema.
TAXII_11_SCHEMA = os.path.join(_pkg_dir, "xsd", "TAXII_XMLMessageBinding_Schema_11.xsd")
class SchemaValidator(object):
"""
A helper class for TAXII Schema Validation.
Example:
See validate_etree(...) for an example how to use this class
"""
# Create class-level variables equal to module-level variables for
# backwards-compatibility
TAXII_10_SCHEMA = TAXII_10_SCHEMA
TAXII_11_SCHEMA = TAXII_11_SCHEMA
def __init__(self, schema_file):
"""
Args:
schema_file (str) - The file location of the schema to
validate against. Use the TAXII_11_SCHEMA
and TAXII_10_SCHEMA constants to validate
against TAXII 1.1 / 1.0. This schema file
will be used when validate_file/string/etree
is used.
"""
schema_doc = parse(schema_file, allow_file=True)
self.xml_schema = etree.XMLSchema(schema_doc)
def validate_file(self, file_location):
"""
A wrapper for validate_etree. Parses file_location,
turns it into an etree, then calls validate_etree( ... )
"""
with open(file_location, 'r') as f:
etree_xml = parse(f, allow_file=True)
return self.validate_etree(etree_xml)
def validate_string(self, xml_string):
"""
A wrapper for validate_etree. Parses xml_string,
turns it into an etree, then calls validate_etree( ... )
"""
etree_xml = parse(xml_string, allow_file=False)
return self.validate_etree(etree_xml)
def validate_etree(self, etree_xml):
"""Validate an LXML etree with the specified schema_file.
Args:
etree_xml (etree): The XML to validate.
schema_file (str): The schema file to validate against
Returns:
A SchemaValidationResult object
Raises:
lxml.etree.XMLSyntaxError: When the XML to be validated is not well formed
Example:
.. code-block:: python
from libtaxii import messages_11
from libtaxii.validation import SchemaValidator, TAXII_11_SCHEMA
from lxml.etree import XMLSyntaxError
sv = SchemaValidator(TAXII_11_SCHEMA)
try:
result = sv.validate_etree(some_etree)
# Note that validate_string() and validate_file() can also be used
except XMLSyntaxError:
# Handle this exception, which occurs when
# some_xml_string is not valid XML (e.g., 'foo')
if not result.valid:
for error in result.error_log:
print error
sys.exit(1)
# At this point, the XML is schema valid
do_something(some_xml_string)
"""
valid = self.xml_schema.validate(etree_xml)
return SchemaValidationResult(valid, self.xml_schema.error_log)
class TAXII10Validator(SchemaValidator):
"""A :py:class:`SchemaValidator` that uses the TAXII 1.0 Schemas"""
def __init__(self):
super(TAXII10Validator, self).__init__(TAXII_10_SCHEMA)
class TAXII11Validator(SchemaValidator):
"""A :py:class:`SchemaValidator` that uses the TAXII 1.1 Schemas"""
def __init__(self):
super(TAXII11Validator, self).__init__(TAXII_11_SCHEMA)
libtaxii-1.1.119/libtaxii/version.py 0000664 0000000 0000000 00000000171 14036072565 0017344 0 ustar 00root root 0000000 0000000 # Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
__version__ = "1.1.119"
libtaxii-1.1.119/libtaxii/xsd/ 0000775 0000000 0000000 00000000000 14036072565 0016104 5 ustar 00root root 0000000 0000000 libtaxii-1.1.119/libtaxii/xsd/TAXII_DefaultQuery_Schema.xsd 0000664 0000000 0000000 00000016472 14036072565 0023466 0 ustar 00root root 0000000 0000000
An XML element. Its body consists only of the indicated XML fields.
An XML AnyURI indicating the Targeting Expression Vocabulary that will be used in this query’s Target field(s).
The element name indicates that this is a Targeting Expression Information field. Its body consists only of the indicated XML Fields.
An XML AnyURI indicating a Capability Module.
An XML element. This element MUST consist only of the indicated XML fields. The subfields of this Criteria are the same as the parent Criteria (e.g., this is a recursive field), though they are not listed here.
An XML element. This element MUST consist only of the indicated XML fields.
An XML string containing an operator. Must be one of "AND" or "OR".
An XML string containing a Targeting Expression identifying the region of the record that is being targeted.
An XML element containing the Test. This element MUST consist only of the indicated XML fields.
An XML boolean indicating whether the result of the Criterion should be negated. The default value for this field is ‘false’.
An XML string containing the value of this parameter.
An XML AnyURI indicating the Capability Module used in this Test.
An XML string containing the relationship.
An XML string containing the name of this parameter.
An XML String containing a Targeting Expression. At least one of Preferred_Scope or Allowed_Scope MUST be present (though this is not schema enforced).
An XML String containing a Targeting Expression. At least one of Preferred_Scope or Allowed_Scope MUST be present (though this is not schema enforced).
An XML AnyURI containing a Targeting Expression Vocabulary ID.
The element name indicates that this is a TAXII Default Query. Its body MUST consist of only the indicated XML Fields.
The element name indicates that this is a query information structure. Its body consists only of the indicated fields.
libtaxii-1.1.119/libtaxii/xsd/TAXII_XMLMessageBinding_Schema.xsd 0000664 0000000 0000000 00000133532 14036072565 0024311 0 ustar 00root root 0000000 0000000
TAXII XML Message Binding Schema
1.0 Draft
4/30/2013
The following specifies the fields and types of the TAXII XML Message Binding.
Copyright (c) 2012 - 2013, The MITRE Corporation. All rights reserved. The contents of this file are subject to the terms of the TAXII License located at http://taxii.mitre.org/about/termsofuse.html. See the TAXII License for the specific language governing permissions and limitations for use of this schema. When distributing copies of the TAXII XML Message Binding Schema, this license header must be included.
XML schema associated with the TAXII XML Message Binding Specification. Note that in case of conflict, the specification is considered normative.
XML Digital Signature schema imported to support signatures of messages and contents.
The root of all TAXII messages. This is used to define header fields. This will never be instantiated directly but the TAXII Message Body types all extend this type.
Represents any number of extended headers for this message.
Hold the message-id value for this message.
Holds one or more extended headers for the message.
Each instance of Extended_Header represents one extended header for the message.
Holds a single extended header value.
The name of the extended header.
The base type of request messages.
The base type of request messages.
All responses must include an in_response_to attribute indicating the message id to which they are responding.
The Protocol Binding, network address, and one or more Message Bindings. This set of information frequently appears together.
The supported protocol, identified using a TAXII Protocol Binding Version ID string or some other string value denoting a non-standard protocol.
The address used to contact the identified service using the given protocol. Should be a valid address using the identified protocol binding.
One or more supported message bindings, identified using a TAXII Message Binding Version ID string or some other string value denoting a non-standard message binding.
Information on how to contact a particular service.
Type for fields that may contain any string and may contain additional XML.
Contains one piece of content as a content.
Indicates the binding of the contents in the Content field.
The content being transported.
An optional field containing the timestamp label assigned to this specific piece of content.
Optional padding to obfuscate the size of the content.
An XML Digital Signature scoped to this Content_Block.
Type used by TAXII Status Messages.
Machine-readable information about this message. See the specification for details.
An additional message intended for human consumption.
An XML Digital Signature scoped to this message.
This identifies the type of status conveyed in this message. Can either be one of the defined Status Types or a user-defined value.
This identifies the type of status conveyed in this Status Message. Can either be one of the defined Status Types or a user-defined value.
A status type defined by a third party. All must conform to URI syntax.
The defined TAXII status message types.
Bad Message - Recipient could not interpret the message.
Denied - Rejected for reasons other than authentication failure.
Failure - General indication of failure.
Not Found - Request was for an unknown target.
Polling Not Supported - Request for polling of content cannot be supported.
Retry - Unable to respond within current session but may be successfuly at a later time.
Success - Message successfully received and processed.
Unauthorized - Authentication missing or incorrect.
Unsupported Message Binding - Requested Message Binding not supported.
Unsupported Content Binding - Requested Content Binding not supported.
Unsupported Protocol - Requested Protocol Binding not supported.
Request to a Discovery Service for a listing of services.
An XML Digital Signature scoped to this message.
Response to a Discovery Request. Contains 0 or more Service records.
Each instance holds one service record.
An XML Digital Signature scoped to this message.
Describes one TAXII service.
The Protocol and Message bindings supported by this service.
Ignored if @service_version has a value other than INBOX. If @service_version=INBOX and these fields are present, indicates a list of supported content bindings and version, identified using the appropriate Content Binding IDs. If @service_version=INBOX and these fields are not present, this indicates that the Inbox Service accepts all content types.
A message with regard to the named service.
The type of the service.
True if the requester is known to be allowed to use the given service. False if the requester is not allowed. If attribute is absent, treat access as unknown.
Identify the TAXII Services version that defines this service using a TAXII Services Version ID value.
The defined TAXII services.
Discovery Service
Feed Management Service
Inbox Service
Poll Service
A request for information about offered feeds from a Feed Management Service.
An XML Digital Signature scoped to this message.
A response to a Feed Information Request. Contains 0 or more feed records.
One element provided for each feed in the response.
An XML Digital Signature scoped to this message.
A record for a data feed.
A prose description of this TAXII Data Feed.
One or more content bindings used in this Data Feed as indicated by Content Binding Identifiers.
Ensure that at least one of Push_Method and Polling_Service are present.
Identify one or more ways that content from this Data Feed can be pushed.
Identify zero or more ways to contact a Poll service to collect information for this Data Feed.
Identify one or more ways to contact a Poll service to collect information for this Data Feed.
Identify zero or more Feed Management Services to use when establishing a subscription to this Data Feed.
A locally unique name for this TAXII Data Feed.
True if the requester is known to be allowed to use the given service. False if the requester is not allowed access. If attribute is absent, treat access as unknown.
Information on the protocols and message types that can be used to push content from a TAXII Data Feed.
The supported protocol, identified using a TAXII Protocol Binding Version ID string or some other string value denoting a non-standard protocol.
One or more supported message bindings, identified using a TAXII Message Binding Version ID string or some other string value denoting a non-standard message binding.
Request management of a feed subscription (including creation of a new subscription).
This field is only relevant if the action type is SUBSCRIBE and is ignored otherwise. If action type is SUBSCRIBE, and this field is present, its sub-fields indicate how the subscriber wishes to have Data Feed content pushed to their Inbox Service. If action type is SUBSCRIBE and this field is not present, this indicates that the subscriber does not wish to have content pushed and instead will poll for content.
An XML Digital Signature scoped to this message.
The action to take on this feed.
A locally unique name for this TAXII Data Feed.
The subscription ID being managed. This attribute MUST be present if the action is UNSUBSCRIBE and is ignored otherwise.
A list of possible subscription management actions.
Create a new subscription.
Delete an existing subscription.
Ask about the requester's established subscriptions for this feed.
Parameters describing how Data Feed content is to be pushed to a Consumer's Inbox Service.
The supported protocol, identified using a TAXII Protocol Binding Version ID string or some other string value denoting a non-standard protocol.
The address used to contact the Inbox service using the given protocol. Should be a valid address using the identified protocol binding.
The supported message binding, identified using a TAXII Message Binding Version ID string or some other string value denoting a non-standard message binding.
Lists the content bindings that the indicated Inbox Service can receive using Content Binding Identifier values. If there are no instances of this field, this indicates that any content bindings are acceptable.
Indicates a successful response to a Feed Management Request message.
An additional message intended for human consumption.
If this message is in response to a message with an action type of SUBSCRIBE or UNSUBSCRIBE, this element MUST be present exactly once. If this message is in response to a message with an action type of STATUS, this element may appear 0 or more times, with each instance describing a different subscription the requester has to the named Data Feed.
An XML Digital Signature scoped to this message.
A locally unique name for this TAXII Data Feed.
Contains a description of an established (or formerly established if there was an UNSUBSCRIBE action) subscription to a Data Feed.
This field SHOULD NOT be included by a sender and MUST be ignored by a recipient if this response message is sent in response to a request with an action value other than STATUS. This field and its subfields exactly duplicate the Push_Parameters structure in the request message that established this subscription. Note that if there was no Push_Parameters structure in the request establishing this subscription (i.e., the subscriber did not want content pushed and instead would be polling for content) then that would mean this element was also absent, mirroring the request structure.
For actions other than UNSUBSCRIBE, this field MUST be present if the request that established this subscription did not contain a Push_Parameters field. This field SHOULD NOT be present if in response to an UNSUBSCRIBE action. This field MAY be present in all other circumstances.
The subscription ID being managed.
A request to Poll a data feed.
The earliest timestamp of content to retrieve. If absent, indicates no lower bound.
The latest timestamp of content to retrieve. If absent, indicates no upper bound.
Lists the content bindings that can be returned in the Poll Response using Content Binding Identifier values. If there are no instances of this field, this indicates that any content bindings are acceptable.
An XML Digital Signature scoped to this message.
A locally unique name for this TAXII Data Feed.
The subscription ID being managed.
Type for the Poll Response Messages.
An additional message intended for human consumption.
The earliest timestamp of content considered. If absent, indicates the earliest content in the Data Feed was considered.
The latest timestamp of content considered.
Returned content.
An XML Digital Signature scoped to this message.
A locally unique name for this TAXII Data Feed.
The subscription ID being managed.
Push message to exchange content.
An additional message intended for human consumption.
If this message is being sent in service of an existing subscription, this field SHOULD be present and provide information about the subscription being serviced.
Returned content.
An XML Digital Signature scoped to this message.
Describes a subscription to a feed, and the portion of that feed that is being serviced by a message.
The earliest timestamp of content considered. If absent, indicates the earliest content in the Data Feed was considered.
The latest timestamp of content considered.
A locally unique name for this TAXII Data Feed.
The subscription ID being managed.
Abstract super-type of all message elements.
libtaxii-1.1.119/libtaxii/xsd/TAXII_XMLMessageBinding_Schema_11.xsd 0000664 0000000 0000000 00000206224 14036072565 0024611 0 ustar 00root root 0000000 0000000
TAXII XML Message Binding Schema
1.1 RC 1
12/20/2013
The following specifies the fields and types of the TAXII XML Message Binding.
Copyright (c) 2012 - 2013, The MITRE Corporation. All rights reserved. The contents of this file are subject to the terms of the TAXII License located at http://taxii.mitre.org/about/termsofuse.html. See the TAXII License for the specific language governing permissions and limitations for use of this schema. When distributing copies of the TAXII XML Message Binding Schema, this license header must be included.
XML schema associated with the TAXII XML Message Binding Specification. Note that in case of conflict, the specification is considered normative.
XML Digital Signature schema imported to support signatures of messages and contents.
The root of all TAXII messages. This is used to define header fields. This will never be instantiated directly but the TAXII Message Body types all extend this type.
Represents any number of extended headers for this message.
Hold the message-id value for this message.
Holds one or more extended headers for the message.
Each instance of Extended_Header represents one extended header for the message.
Holds a single extended header value.
The name of the extended header.
The base type of request messages.
The base type of response messages.
All responses must include an in_response_to attribute indicating the message id to which they are responding.
Identifies a content binding and multiple possible subtypes
Identifies one or more Content Binding Subtypes
A Content Binding ID.
Identifies a Content Binding Subtype
A Content Binding Subtype ID
The Protocol Binding, network address, and one or more Message Bindings. This set of information frequently appears together.
The supported protocol, identified using a TAXII Protocol Binding Version ID string or some other string value denoting a non-standard protocol.
The address used to contact the identified service using the given protocol. Should be a valid address using the identified protocol binding.
One or more supported message bindings, identified using a TAXII Message Binding Version ID string or some other string value denoting a non-standard message binding.
Information on how to contact a particular service.
Type for fields that may contain any string and may contain additional XML.
Contains one piece of content as a content.
Indicates the binding of the contents in the Content field.
The content being transported.
An optional field containing the timestamp label assigned to this specific piece of content.
This field contains prose information for the message recipient. This message is not required to be machine readable and is usually a message for a human operator.
Optional padding to obfuscate the size of the content.
An XML Digital Signature scoped to this Content_Block.
Contains a Query expression
Contains the Query Format ID of a particular Query Format
Contains information about the number of applicable records in a
result set.
If true, indicats that the true number of applicable
records in this result set may exceed the number provided.
Indicate the type of response (full content or count only).
Indicate the acceptable Content Bindings for this subscription
A Query expression associated with this subscription.
The possible types of responses to a poll/subscription.
A request for only the number of applicable records.
A request for the full content of all applicable records.
Type used by TAXII Status Messages.
Machine-readable information about this message. See the specification for details.
An additional message intended for human consumption.
An XML Digital Signature scoped to this message.
This identifies the type of status conveyed in this message. Can either be one of the defined Status Types or a user-defined value.
This identifies the type of status conveyed in this Status Message. Can either be one of the defined Status Types or a user-defined value.
A status type defined by a third party. All must conform to URI syntax.
The defined TAXII status message types.
Asynchronous Poll Error - An error was detected while creating
an Asynchronous Poll result.
Bad Message - Recipient could not interpret the message.
Denied - Rejected for reasons other than authentication failure.
Destination Collection Error - indicates an error in the
specification of a destination Data Collection
Failure - General indication of failure.
Invalid Response Part - Indicates that a request was made for
an invalid response part.
Network Error - Encapsulates an error encountered at the
network transport layer.
Not Found - Request was for an unknown target.
Pending - Indicates that a result set was not immediately
available but will be created and made available at a later time.
Polling Not Supported - Request for polling of content cannot be supported.
Retry - Unable to respond within current session but may be successfuly at a later time.
Success - Message successfully received and processed.
Unauthorized - Authentication missing or incorrect.
Unsupported Message Binding - Requested Message Binding not supported.
Unsupported Content Binding - Requested Content Binding not supported.
Unsupported Protocol - Requested Protocol Binding not supported.
Unsupported Query - Indicates the presence of a Query
expression that used an unsupported Query Format.
Contains machine readable information about a Status Message.
Contains one piece of machine-readable information about a
Status Message
Contains one piece of machine readable information about a Status
Message
Contains the name of this status detail.
Request to a Discovery Service for a listing of services.
An XML Digital Signature scoped to this message.
Response to a Discovery Request. Contains 0 or more Service records.
Each instance holds one service record.
An XML Digital Signature scoped to this message.
Describes one TAXII service.
The Protocol and Message bindings supported by this service.
Identifies a supported query format and specifies parameters
for that format.
Ignored if @service_version has a value other than INBOX. If @service_version=INBOX and these fields are present, indicates a list of supported content bindings and version, identified using the appropriate Content Binding IDs. If @service_version=INBOX and these fields are not present, this indicates that the Inbox Service accepts all content types.
A message with regard to the named service.
The type of the service.
True if the requester is known to be allowed to use the given service. False if the requester is not allowed. If attribute is absent, treat access as unknown.
Identify the TAXII Services version that defines this service using a TAXII Services Version ID value.
The defined TAXII services.
Discovery Service
Collection Management Service
Inbox Service
Poll Service
Contains paramters for a particular Query Format
Contains the Query Format ID of a particular Query Format
A request for information about offered collection from a Collection Management Service.
An XML Digital Signature scoped to this message.
A response to a Collection Information Request. Contains 0 or more Collection records.
One element provided for each Data Collection in the response.
An XML Digital Signature scoped to this message.
A record for a data collection.
A prose description of this TAXII Data Collection.
This field indicates the typical number of daily records subscribers can expect to receive from this Data Collection.
The content bindings used in this Data Collection as indicated by Content Binding Identifiers.
Identify ways that content from this Data Collection can be pushed.
Identify ways to contact a Poll service to collect information for this Data Collection.
Identify Collection Management Services to use when establishing a subscription to this Data Collection.
Identify Inbox Services to which content bound for
this Data Collection may be pushed.
A locally unique name for this TAXII Data Collection.
The type of this Data Collection (Data Feed or Data Set).
True if the requester is known to be allowed to use the given service. False if the requester is not allowed access. If attribute is absent, treat access as unknown.
Contains binding information for an Inbox Service
Identify Content Bindings acceptable to this Inbox Service
The types of Data Collections supported by TAXII
An ordered Data Collection
An unordered Data Collection
Information on the protocols and message types that can be used to
push content from a TAXII Data Collection.
The supported protocol, identified using a TAXII Protocol
Binding Version ID string or some other URI value denoting a non-standard protocol.
The supported message bindings, identified using a TAXII
Message Binding Version ID string or some other URI value denoting a non-standard message binding.
Request management of a Data Collection subscription (including creation of a new subscription).
The subscription ID being managed. This attribute MUST
be present if the action is UNSUBSCRIBE, PAUSE, or RESUME. It MAY be
present if the action is STATUS. It is ignored if the action is
SUBSCRIBE.
Parameters associated with this subscription.
This field is only relevant if the action type is
SUBSCRIBE and is ignored otherwise. If action type is SUBSCRIBE, and
this field is present, its sub-fields indicate how the subscriber
wishes to have Data Collection content pushed to their Inbox
Service. If action type is SUBSCRIBE and this field is not present,
this indicates that the subscriber does not wish to have content pushed and instead will poll for content.
An XML Digital Signature scoped to this message.
The action to take on this collection.
A locally unique name for this TAXII Data Collection.
A list of possible subscription management actions.
Create a new subscription.
Delete an existing subscription.
Pause delivery of an existing subscription.
Resume delivery of an existing subscription.
Ask about the requester's established subscriptions for this collection.
Parameters describing how Data Collection content is to be pushed to a Consumer's Inbox Service.
The supported protocol, identified using a TAXII Protocol Binding Version ID string or some other string value denoting a non-standard protocol.
The address used to contact the Inbox service using the given protocol. Should be a valid address using the identified protocol binding.
The supported message binding, identified using a TAXII Message Binding Version ID string or some other string value denoting a non-standard message binding.
Indicates a successful response to a Collection Management Request message.
An additional message intended for human consumption.
If this message is in response to a message with an
action type of SUBSCRIBE or UNSUBSCRIBE, this element MUST be
present exactly once. If this message is in response to a message
with an action type of STATUS, this element may appear 0 or more
times, with each instance describing a different subscription the
requester has to the named Data Collection.
An XML Digital Signature scoped to this message.
A locally unique name for this TAXII Data Collection.
Contains a description of an established (or formerly established if
there was an UNSUBSCRIBE action) subscription to a Data Collection.
The Subscription ID associated with this subscription.
The parameters associated with this subscription
This field describes the push parameters (if any) associated
with this subscription.
Identifies relevant Poll Service(s) that can be contacted for
fulfillment of this subscription.
Identify the current status of the subscription
Describe the current status of a subscription.
The subscription is in an active state
The subscription is in a paused state
The subscription has just been unsubscribed
A request to Poll a data collection.
The earliest timestamp of content to retrieve.
Irrelevant on a Data Set. If absent when polling a Data Feed, this
indicates no lower bound.
The latest timestamp of content to retrieve.
Irrelevant on a Data Set. If absent when polling a Data Feed, this
indicates no upper bound.
Exactly one of Subscription_ID or Poll_Parameters MUST
be present to provide the parameters for this request.
The subscription ID of the subscription that is
being polled.
Parameters associated with this Poll Request.
An XML Digital Signature scoped to this message.
A locally unique name for this TAXII Data Collection.
Contains parameters for a Poll Request
Indicate the type of response (full content or count only).
Indicate the acceptable Content Bindings for the response
A Query expression associated with this poll request.
Parameters for the delivery of Asynchronous Poll results, if this is
supported and necessary.
Indicate whether the requester supports Asynchronous Polling.
Type for the Poll Response Messages.
The Subscription ID of the subscription associated
with this Poll Response (if applicable)
The earliest timestamp of content considered.
Irrelevant if polling a Data Set. If absent when polling a Data
Feed, this indicates the earliest content in the Data Feed was
considered.
The latest timestamp of content considered. Irrelevant
if polling a Data Set. This field MUST be present if a Data Feed was
polled.
Information about the number of applicable records in
the result set.
An additional message intended for human consumption.
Returned content.
An XML Digital Signature scoped to this message.
A locally unique name for this TAXII Data Collection.
A flag to indicate whether there are more parts to this
result set to be retrieved.
Identifies the Result ID of the result set, if applicable.
This attribute MUST be present if the more field is set to true.
Contains the part number of a multi-part response.
Identifies a content binding and possible single subtype
Identifies zero or one Content Binding Subtypes
A Content Binding ID.
Push message to exchange content.
This field indicates the name of the TAXII Data
Collection(s) to which this message’s content is being sent.
An additional message intended for human consumption.
If this message is being sent in service of an existing subscription, this field SHOULD be present and provide information about the subscription being serviced.
A count of the number of applicable records.
Returned content.
An XML Digital Signature scoped to this message.
The Result ID for the result set of which this content is
a part.
Describes a subscription to a collection, and the portion of that
collection that is being serviced by a message.
The Subscription ID of the subscription being fulfilled by
this message.
The earliest timestamp of content considered. This field is
irrelevant if the content comes from a Data Set. If absent for content sent
from a Data Feed, indicates the earliest content in the Data Feed was considered.
The latest timestamp of content considered. This field is
irrelevant if the content comes from a Data Set. This field MUST be present
if the message is servicing a subscription to a Data Feed.
A locally unique name for this TAXII Data Collection.
A request to to collect a prepared result set.
An XML Digital Signature scoped to this message.
Contains the name of the TAXII Data Collection associated with
this request.
Contains the Result ID of the result set being collected.
The portion of the result set that is being requested.
Abstract super-type of all message elements.
libtaxii-1.1.119/libtaxii/xsd/xmldsig-core-schema.xsd 0000664 0000000 0000000 00000024065 14036072565 0022466 0 ustar 00root root 0000000 0000000
]>
libtaxii-1.1.119/requirements.txt 0000664 0000000 0000000 00000000131 14036072565 0016760 0 ustar 00root root 0000000 0000000 Sphinx==1.6.1
sphinx_rtd_theme==0.2.4
pytest==3.0.7
tox==2.7.0
bumpversion==0.5.3
-e .
libtaxii-1.1.119/setup.cfg 0000664 0000000 0000000 00000000312 14036072565 0015316 0 ustar 00root root 0000000 0000000 [bumpversion]
current_version = 1.1.119
tag_name = {new_version}
commit = True
tag = True
[bumpversion:file:libtaxii/version.py]
[metadata]
license_file = LICENSE.txt
[bdist_wheel]
universal = True
libtaxii-1.1.119/setup.py 0000664 0000000 0000000 00000010077 14036072565 0015220 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2017, The MITRE Corporation
# For license information, see the LICENSE.txt file
from io import open
from os.path import abspath, dirname, join
import sys
from setuptools import setup, find_packages
BASE_DIR = dirname(abspath(__file__))
VERSION_FILE = join(BASE_DIR, 'libtaxii', 'version.py')
def get_version():
with open(VERSION_FILE) as f:
for line in f.readlines():
if line.startswith("__version__"):
version = line.split()[-1].strip('"')
return version
raise AttributeError("Package does not have a __version__")
def get_long_description():
with open('README.rst', encoding='utf-8') as f:
return f.read()
py_maj, py_minor = sys.version_info[:2]
if (py_maj, py_minor) < (2, 6) or (py_maj == 3 and py_minor < 3):
raise Exception('libtaxii requires Python 2.6, 2.7 or 3.3+')
install_requires = [
'python-dateutil>=1.4.1',
'six>=1.9.0',
]
# lxml has dropped support for Python 2.6, 3.3 after version 4.2.6
if (py_maj, py_minor) == (2, 6) or (py_maj, py_minor) == (3, 3):
install_requires.append('lxml>=2.2.3,<4.3.0')
# lxml has dropped support for Python 2.6, 3.3, 3.4 after version 4.4.0
elif (py_maj, py_minor) == (2, 6) or (py_maj, py_minor) == (3, 4):
install_requires.append('lxml>=2.2.3,<4.4.0')
else:
install_requires.append('lxml>=2.2.3')
if (py_maj, py_minor) < (2, 7):
install_requires.append('argparse')
setup(
name='libtaxii',
description='TAXII 1.X Library.',
author='The MITRE Corporation',
author_email='taxii@mitre.org',
url='https://taxiiproject.github.io/',
version=get_version(),
packages=find_packages(),
license='BSD',
install_requires=install_requires,
scripts=[
'libtaxii/scripts/collection_information_client.py',
'libtaxii/scripts/discovery_client.py',
'libtaxii/scripts/fulfillment_client.py',
'libtaxii/scripts/inbox_client.py',
'libtaxii/scripts/inbox_client_10.py',
'libtaxii/scripts/poll_client.py',
'libtaxii/scripts/query_client.py',
'libtaxii/scripts/discovery_client_10.py',
'libtaxii/scripts/feed_information_client_10.py',
'libtaxii/scripts/poll_client_10.py',
],
entry_points={
'console_scripts': [
'collection_information_client = libtaxii.scripts.collection_information_client:main',
'discovery_client = libtaxii.scripts.discovery_client:main',
'fulfillment_client = libtaxii.scripts.fulfillment_client:main',
'inbox_client = libtaxii.scripts.inbox_client:main',
'inbox_client_10 = libtaxii.scripts.inbox_client_10:main',
'poll_client = libtaxii.scripts.poll_client:main',
'query_client = libtaxii.scripts.query_client:main',
'discovery_client_10 = libtaxii.scripts.discovery_client_10:main',
'feed_information_client_10 = libtaxii.scripts.feed_information_client_10:main',
'poll_client_10 = libtaxii.scripts.poll_client_10:main',
],
},
package_data={'libtaxii': ['xsd/*.xsd']},
long_description=get_long_description(),
keywords='taxii libtaxii',
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
],
project_urls={
'Documentation': 'https://libtaxii.readthedocs.io/',
'Source Code': 'https://github.com/TAXIIProject/libtaxii/',
'Bug Tracker': 'https://github.com/TAXIIProject/libtaxii/issues/',
},
)
libtaxii-1.1.119/tox.ini 0000664 0000000 0000000 00000001437 14036072565 0015021 0 ustar 00root root 0000000 0000000 [tox]
envlist = py26, py27, rhel26, py34, py35, py36, py37, py38, docs, packaging
[testenv]
commands =
pytest libtaxii
sphinx-build -b doctest docs docs/_build/doctest
sphinx-build -b html docs docs/_build/html
deps = -rrequirements.txt
[testenv:py26]
commands =
pytest libtaxii
deps = pytest
[testenv:rhel26]
commands =
pytest libtaxii
deps =
lxml==2.2.3
python-dateutil==1.4.1
six==1.9.0
pytest
[testenv:docs]
commands =
sphinx-build -b doctest docs docs/_build/doctest
sphinx-build -b html docs docs/_build/html
[testenv:packaging]
deps =
readme_renderer
commands =
python setup.py check -r -s
[travis]
python =
2.6: py26, rhel26
2.7: py27, docs, packaging
3.4: py34
3.5: py35
3.6: py36, docs, packaging
3.7: py37
3.8: py38