{"id":22878911,"url":"https://github.com/oasis-open/cti-taxii-server","last_synced_at":"2025-04-05T00:09:11.469Z","repository":{"id":24673091,"uuid":"99020025","full_name":"oasis-open/cti-taxii-server","owner":"oasis-open","description":"OASIS TC Open Repository: TAXII 2 Server Library Written in Python","archived":false,"fork":false,"pushed_at":"2024-04-15T20:59:55.000Z","size":881,"stargazers_count":128,"open_issues_count":20,"forks_count":73,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-28T23:07:19.540Z","etag":null,"topics":["cti","cyber-threat-intelligence","oasis","python","python-script","server","taxii","taxii2"],"latest_commit_sha":null,"homepage":"https://medallion.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oasis-open.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.txt","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-01T16:08:09.000Z","updated_at":"2025-03-13T12:16:24.000Z","dependencies_parsed_at":"2024-06-20T18:57:40.715Z","dependency_job_id":null,"html_url":"https://github.com/oasis-open/cti-taxii-server","commit_stats":{"total_commits":640,"total_committers":25,"mean_commits":25.6,"dds":0.559375,"last_synced_commit":"2a588aa0dcdaaa80b6b9542d63dc7a15ef20dadf"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oasis-open%2Fcti-taxii-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oasis-open%2Fcti-taxii-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oasis-open%2Fcti-taxii-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oasis-open%2Fcti-taxii-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oasis-open","download_url":"https://codeload.github.com/oasis-open/cti-taxii-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247266564,"owners_count":20910836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cti","cyber-threat-intelligence","oasis","python","python-script","server","taxii","taxii2"],"created_at":"2024-12-13T16:35:37.585Z","updated_at":"2025-04-05T00:09:11.449Z","avatar_url":"https://github.com/oasis-open.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"|Build_Status| |Coverage| |Version| |Documentation_Status|\n\ncti-taxii-server\n================\n\nThis is an `OASIS TC Open Repository \u003chttps://www.oasis-open.org/resources/open-repositories/\u003e`_.\nSee the `Governance`_ section for more information.\n\nTrusted Automated Exchange of Intelligence Information (TAXII™) is an application layer\nprotocol for the communication of cyber threat information in a simple and scalable manner.\n\n*Medallion* is a minimal implementation of a TAXII 2.1 Server in Python.\n\n**WARNING:** *medallion* was designed as a prototype and reference\nimplementation of TAXII 2.1, and is not intended for production use.\n\n*medallion* has been designed to be a simple front-end REST server providing\naccess to the endpoints defined in that specification.\nIt uses the python framework - `Flask \u003chttp://flask.pocoo.org/\u003e`_.  *medallion*\ndepends on back-end \"plugins\" which handle the persistence of the TAXII data and\nmetadata. The TAXII specification is agnostic to what type of data a TAXII\nserver stores, but this will usually be STIX 2 content.\n\nTwo back-end plugins are provided with *medallion*: the Memory back-end and the\nMongoDB back-end.  The Memory back-end persists data \"in memory\".  It is\ninitialized using a json file that contains TAXII data and metadata.\nIt is possible to save the current state of the in memory store, but this\nback-end is really intended only for testing purposes.  The MongoDB backend is\nsomewhat more robust and makes use of a MongoDB server, installed independently.\nThe MongoDB back-end can only be used if the pymongo python package is\ninstalled. An error message will result if it is used without that package.\n\nFor more information, see `the documentation \u003chttps://medallion.readthedocs.io/\u003e`__ on\nReadTheDocs.\n\nInstallation\n------------\n\nThe easiest way to install *medallion* is with pip\n\n.. code-block:: bash\n\n  $ pip install medallion\n\nUsage\n-----\n\nAs a script\n-----------\n\nMedallion provides a command-line interface to start the TAXII Server\n\n.. code-block:: text\n\n    usage: medallion [-h] [--host HOST] [--port PORT] [--debug-mode]\n                     [--log-level {DEBUG,INFO,WARN,ERROR,CRITICAL}]\n                     [-c CONF_FILE] [--conf-dir CONF_DIR | --no-conf-dir]\n                     [--conf-check] [CONFIG_PATH]\n\n    medallion v3.0.0\n\n    positional arguments:\n      CONFIG_PATH           Deprecated argument for specifying a single\n                            JSON configuration file. Do not specify this\n                            and `--conf-file`.\n\n    optional arguments:\n      -h, --help            show this help message and exit\n\n      --host HOST           The host to listen on.\n\n      --port PORT           The port of the web server.\n\n      --debug-mode          If set, start application in debug mode.\n\n      --log-level {DEBUG,INFO,WARN,ERROR,CRITICAL}\n                            The logging output level for medallion.\n\n      -c CONF_FILE, --conf-file CONF_FILE\n                            Path to a single configuration file. Defaults to the\n                            value of the MEDALLION_CONFFILE environment variable\n                            or /etc/xdg/medallion/3/medallion.conf.\n\n      --conf-dir CONF_DIR   Path to a directory containing JSON configuration\n                            files with names ending in .json or .conf. Defaults to\n                            the value of the MEDALLION_CONFDIR environment\n                            variable or /etc/xdg/medallion/3/config.d.\n\n      --no-conf-dir         Disable the use of any configuration directory as\n                            described for --conf-dir. This may be used to ensure\n                            that the default or some value from the environment is\n                            not used.\n\n      --conf-check          Evaluate medallion configuration without running the\n                            server.\n\nTo run *medallion*\n\n.. code-block:: bash\n\n    $ python medallion/scripts/run.py --conf-file \u003cconfig-file\u003e\n\nMake 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 `--port` option, for example\n\n.. code-block:: bash\n\n    $ medallion --port 80 --conf-file config_file.json\n\nThe \u003cconfig_file\u003e contains:\n\n- configuration information for the backend plugin\n- a simple user name/password dictionary\n\nTo use the Memory back-end plug, include the following in the \u003cconfig-file\u003e:\n\n.. code-block:: json\n\n    {\n        \"backend\": {\n            \"module_class\": \"MemoryBackend\",\n            \"filename\": \"\u003cpath to json file with initial data\u003e\"\n        }\n    }\n\nTo use the Mongo DB back-end plug, include the following in the \u003cconfig-file\u003e:\n\n.. code-block:: json\n\n    {\n         \"backend\": {\n            \"module_class\": \"MongoBackend\",\n            \"uri\": \"\u003cMongo DB server url\u003e  # e.g., 'mongodb://localhost:27017/'\"\n         }\n    }\n\n*Note: A Mongo DB should be available at some URL when using the Mongo DB back-end*\n\nA description of the Mongo DB structure expected by the mongo db backend code is\ndescribed in `the documentation \u003chttps://medallion.readthedocs.io/en/latest/mongodb_schema.html\u003e`_.\n\nAs required by the TAXII specification, *medallion* supports HTTP Basic\nauthorization.  However, the user names and passwords are currently stored in\nthe \u003cconfig_file\u003e in plain text.\n\nHere is an example:\n\n.. code-block:: json\n\n    {\n        \"users\": {\n           \"admin\": \"Password0\",\n           \"user1\": \"Password1\",\n           \"user2\": \"Password2\"\n        }\n    }\n\nThe authorization is enabled using the python package\n`flask_httpauth \u003chttps://flask-httpauth.readthedocs.io\u003e`_.\nAuthorization could be enhanced by changing the method \"decorated\" using\n@auth.get_password in medallion/__init__.py\n\nConfigs may also contain a \"taxii\" section as well, as shown below:\n\n.. code-block:: json\n\n    {\n        \"taxii\": {\n           \"max_page_size\": 100\n           \"interop_requirements\": true\n        }\n    }\n\nAll TAXII servers require a config, though if any of the sections specified above\nare missing, they will be filled with default values.\n\nThe ``interop_requirements`` option will enforce additional requireemnts from\nthe TAXII 2.1 Interoperability specification. It defaults to ``false``.\n\nWe welcome contributions for other back-end plugins.\n\nDocker\n------\n\nWe also provide a Docker image to make it easier to run *medallion*\n\n.. code-block:: bash\n\n    $ docker build . -t medallion -f docker_utils/Dockerfile\n\nIf operating behind a proxy, add the following option (replacing `\u003cproxy\u003e` with\nyour proxy location and port): ``--build-arg https_proxy=\u003cproxy\u003e``.\n\nThen run the image\n\n.. code-block:: bash\n\n    $ docker run --rm -p 5000:5000 -v \u003cdirectory\u003e:/var/taxii medallion\n\nReplace ``\u003cdirectory\u003e`` with the full path to the directory containing your\nmedallion configuration.\n\nGovernance\n----------\n\nThis GitHub public repository (\n**https://github.com/oasis-open/cti-taxii-server** ) was created at the request\nof the `OASIS Cyber Threat Intelligence (CTI) TC \u003chttps://www.oasis-open.org/committees/cti/\u003e`__\nas an `OASIS TC Open Repository \u003chttps://www.oasis-open.org/resources/open-repositories/\u003e`__ to support\ndevelopment of open source resources related to Technical Committee work.\n\nWhile this TC Open Repository remains associated with the sponsor TC, its\ndevelopment priorities, leadership, intellectual property terms, participation\nrules, and other matters of governance are `separate and distinct\n\u003chttps://github.com/oasis-open/cti-taxii-server/blob/master/CONTRIBUTING.md#governance-distinct-from-oasis-tc-process\u003e`__\nfrom the OASIS TC Process and related policies.\n\nAll contributions made to this TC Open Repository are subject to open source\nlicense terms expressed in the `BSD-3-Clause License\n\u003chttps://www.oasis-open.org/sites/www.oasis-open.org/files/BSD-3-Clause.txt\u003e`__.\nThat license was selected as the declared `\"Applicable License\"\n\u003chttps://www.oasis-open.org/resources/open-repositories/licenses\u003e`__ when the\nTC Open Repository was created.\n\nAs documented in `\"Public Participation Invited \u003chttps://github.com/oasis-open/cti-taxii-server/blob/master/CONTRIBUTING.md#public-participation-invited\u003e`__\",\ncontributions to this OASIS TC Open Repository are invited from all parties,\nwhether affiliated with OASIS or not. Participants must have a GitHub account,\nbut no fees or OASIS membership obligations are required. Participation is\nexpected to be consistent with the `OASIS TC Open Repository Guidelines and Procedures \u003chttps://www.oasis-open.org/policies-guidelines/open-repositories\u003e`__, the open\nsource `LICENSE \u003chttps://github.com/oasis-open/cti-taxii-server/blob/master/LICENSE\u003e`__\ndesignated for this particular repository, and the requirement for an\n`Individual Contributor License Agreement \u003chttps://www.oasis-open.org/resources/open-repositories/cla/individual-cla\u003e`__\nthat governs intellectual property.\n\nMaintainers\n-----------\n\nTC Open Repository `Maintainers \u003chttps://www.oasis-open.org/resources/open-repositories/maintainers-guide\u003e`__\nare responsible for oversight of this project's community development\nactivities, including evaluation of GitHub `pull requests \u003chttps://github.com/oasis-open/cti-taxii-server/blob/master/CONTRIBUTING.md#fork-and-pull-collaboration-model\u003e`__\nand `preserving \u003chttps://www.oasis-open.org/policies-guidelines/open-repositories#repositoryManagement\u003e`__\nopen source principles of openness and fairness. Maintainers are recognized and\ntrusted experts who serve to implement community goals and consensus design\npreferences.\n\nInitially, the associated TC members have designated one or more persons to\nserve as Maintainer(s); subsequently, participating community members may select\nadditional or substitute Maintainers, per `consensus agreements \u003chttps://www.oasis-open.org/resources/open-repositories/maintainers-guide#additionalMaintainers\u003e`__.\n\nCurrent Maintainers of this TC Open Repository\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n-  `Chris Lenk \u003cmailto:clenk@mitre.org\u003e`__; GitHub ID: https://github.com/clenk/; WWW: `MITRE Corporation \u003chttps://www.mitre.org/\u003e`__\n-  `Rich Piazza \u003cmailto:rpiazza@mitre.org\u003e`__; GitHub ID: https://github.com/rpiazza/; WWW: `MITRE Corporation \u003chttps://www.mitre.org/\u003e`__\n-  `Zach Rush \u003cmailto:zrush@mitre.org\u003e`__; GitHub ID: https://github.com/zrush-mitre/; WWW: `MITRE Corporation \u003chttps://www.mitre.org/\u003e`__\n-  `Jason Keirstead \u003cmailto:Jason.Keirstead@ca.ibm.com\u003e`__; GitHub ID: https://github.com/JasonKeirstead; WWW: `IBM \u003chttp://www.ibm.com/\u003e`__\n\nAbout OASIS TC Open Repositories\n--------------------------------\n\n-  `TC Open Repositories: Overview and Resources \u003chttps://www.oasis-open.org/resources/open-repositories/\u003e`__\n-  `Frequently Asked Questions \u003chttps://www.oasis-open.org/resources/open-repositories/faq\u003e`__\n-  `Open Source Licenses \u003chttps://www.oasis-open.org/resources/open-repositories/licenses\u003e`__\n-  `Contributor License Agreements (CLAs) \u003chttps://www.oasis-open.org/resources/open-repositories/cla\u003e`__\n-  `Maintainers' Guidelines and Agreement \u003chttps://www.oasis-open.org/resources/open-repositories/maintainers-guide\u003e`__\n\nFeedback\n--------\n\nQuestions or comments about this TC Open Repository's activities should be composed\nas GitHub issues or comments. If use of an issue/comment is not possible or\nappropriate, questions may be directed by email to the Maintainer(s) `listed\nabove \u003c#currentMaintainers\u003e`__. Please send general questions about Open\nRepository participation to OASIS Staff at repository-admin@oasis-open.org and\nany specific CLA-related questions to repository-cla@oasis-open.org.\n\n.. |Build_Status| image:: https://github.com/oasis-open/cti-taxii-server/workflows/cti-taxii-server%20test%20harness/badge.svg\n   :target: https://github.com/oasis-open/cti-taxii-server/actions?query=workflow%3A%22cti-taxii-server+test+harness%22\n   :alt: Build Status\n.. |Coverage| image:: https://codecov.io/gh/oasis-open/cti-taxii-server/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/oasis-open/cti-taxii-server\n   :alt: Codecov Coverage\n.. |Version| image:: https://img.shields.io/pypi/v/medallion.svg?maxAge=3600\n   :target: https://pypi.python.org/pypi/medallion/\n   :alt: PyPI Version 3.0.0\n.. |Documentation_Status| image:: https://readthedocs.org/projects/medallion/badge/?version=latest\n   :target: https://medallion.readthedocs.io/en/latest/\n   :alt: ReadTheDocs Documentation Status\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foasis-open%2Fcti-taxii-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foasis-open%2Fcti-taxii-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foasis-open%2Fcti-taxii-server/lists"}