Package: medallion
cti-taxii-serverThis is anOASIS TC Open Repository.
See theGovernancesection for more information.Trusted Automated Exchange of Intelligence Information (TAXII™) is an application layer
protocol for the communication of cyber threat information in a simple and scalable manner.Medallionis a minimal implementation of a TAXII 2.1 Server in Python.WARNING:medallionwas designed as a prototype and reference
implementation of TAXII 2.1, and is not intended for production use.medallionhas been designed to be a simple front-end REST server providing
access to the endpoints defined in that specification.
It uses the python framework -Flask.medalliondepends on back-end “plugins” which handle the persistence of the TAXII data and
metadata. The TAXII specification is agnostic to what type of data a TAXII
server stores, but this will usually be STIX 2 content.Two back-end plugins are provided withmedallion: the Memory back-end and the
MongoDB back-end.  The Memory back-end persists data “in memory”.  It is
initialized using a json file that contains TAXII data and metadata.
It is possible to save the current state of the in memory store, but this
back-end is really intended only for testing purposes.  The MongoDB backend is
somewhat more robust and makes use of a MongoDB server, installed independently.
The MongoDB back-end can only be used if the pymongo python package is
installed. An error message will result if it is used without that package.For more information, seethe documentationon
ReadTheDocs.InstallationThe easiest way to installmedallionis with pip$pipinstallmedallionUsageAs a scriptMedallion provides a command-line interface to start the TAXII Serverusage: medallion [-h]
    [--host HOST]
    [--port PORT]
    [--debug-mode]
    [--log-level {DEBUG,INFO,WARN,ERROR,CRITICAL}]
    CONFIG_PATH

medallion v3.0.0

positional arguments:
  CONFIG_PATH           The location of the JSON configuration file to use.

optional arguments:
  -h, --help            show this help message and exit

  --host HOST           The host to listen on.

  --port PORT           The port of the web server.

  --debug-mode          If set, start application in debug mode.

  --log-level {DEBUG,INFO,WARN,ERROR,CRITICAL}
                        The logging output level for medallion.To runmedallion$pythonmedallion/scripts/run.py<config-file>Make sure medallion is using the same port that your TAXII client will be connecting on. You can specify which port medallion runs on using the–portoption, for example$medallion--port80config_file.jsonThe <config_file> contains:configuration information for the backend plugina simple user name/password dictionaryTo use the Memory back-end plug, include the following in the <config-file>:{"backend":{"module":"medallion.backends.memory_backend","module_class":"MemoryBackend","filename":"<path to json file with initial data>"}}To use the Mongo DB back-end plug, include the following in the <config-file>:{"backend":{"module":"medallion.backends.mongodb_backend","module_class":"MongoBackend","uri":"<Mongo DB server url>  # e.g., 'mongodb://localhost:27017/'"}}Note: A Mongo DB should be available at some URL when using the Mongo DB back-endA description of the Mongo DB structure expected by the mongo db backend code is
described inthe documentation.As required by the TAXII specification,medallionsupports HTTP Basic
authorization.  However, the user names and passwords are currently stored in
the <config_file> in plain text.Here is an example:{"users":{"admin":"Password0","user1":"Password1","user2":"Password2"}}The authorization is enabled using the python packageflask_httpauth.
Authorization could be enhanced by changing the method “decorated” using
@auth.get_password in medallion/__init__.pyConfigs may also contain a “taxii” section as well, as shown below:{"taxii":{"max_page_size":100}}All TAXII servers require a config, though if any of the sections specified above
are missing, they will be filled with default values.We welcome contributions for other back-end plugins.DockerWe also provide a Docker image to make it easier to runmedallion$dockerbuild.-tmedallionIf operating behind a proxy, add the following option (replacing<proxy>with
your proxy location and port):--build-arghttps_proxy=<proxy>.Then run the image$dockerrun--rm-p5000:5000-v<directory>:/var/taxiimedallionReplace<directory>with the full path to the directory containing your
medallion configuration.GovernanceThis GitHub public repository (https://github.com/oasis-open/cti-taxii-server) was created at the request
of theOASIS Cyber Threat Intelligence (CTI) TCas anOASIS TC Open Repositoryto support
development of open source resources related to Technical Committee work.While this TC Open Repository remains associated with the sponsor TC, its
development priorities, leadership, intellectual property terms, participation
rules, and other matters of governance areseparate and distinctfrom the OASIS TC Process and related policies.All contributions made to this TC Open Repository are subject to open source
license terms expressed in theBSD-3-Clause License.
That license was selected as the declared“Applicable License”when the
TC Open Repository was created.As documented in“Public Participation Invited”,
contributions to this OASIS TC Open Repository are invited from all parties,
whether affiliated with OASIS or not. Participants must have a GitHub account,
but no fees or OASIS membership obligations are required. Participation is
expected to be consistent with theOASIS TC Open Repository Guidelines and Procedures, the open
sourceLICENSEdesignated for this particular repository, and the requirement for anIndividual Contributor License Agreementthat governs intellectual property.MaintainersTC Open RepositoryMaintainersare responsible for oversight of this project’s community development
activities, including evaluation of GitHubpull requestsandpreservingopen source principles of openness and fairness. Maintainers are recognized and
trusted experts who serve to implement community goals and consensus design
preferences.Initially, the associated TC members have designated one or more persons to
serve as Maintainer(s); subsequently, participating community members may select
additional or substitute Maintainers, perconsensus agreements.Current Maintainers of this TC Open RepositoryChris Lenk; GitHub ID:https://github.com/clenk/; WWW:MITRE CorporationRich Piazza; GitHub ID:https://github.com/rpiazza/; WWW:MITRE CorporationEmmanuelle Vargas-Gonzalez; GitHub ID:https://github.com/emmanvg/; WWW:MITRE CorporationJason Keirstead; GitHub ID:https://github.com/JasonKeirstead; WWW:IBMAbout OASIS TC Open RepositoriesTC Open Repositories: Overview and ResourcesFrequently Asked QuestionsOpen Source LicensesContributor License Agreements (CLAs)Maintainers’ Guidelines and AgreementFeedbackQuestions or comments about this TC Open Repository’s activities should be composed
as GitHub issues or comments. If use of an issue/comment is not possible or
appropriate, questions may be directed by email to the Maintainer(s)listed
above. Please send general questions about Open
Repository participation to OASIS Staff atrepository-admin@oasis-open.organd
any specific CLA-related questions torepository-cla@oasis-open.org.