From f8993aa0002973a14b911029a048a3cd8412c39e Mon Sep 17 00:00:00 2001 From: Vinay Potluri Date: Mon, 18 Jul 2016 15:12:15 -0500 Subject: [PATCH] Removed OpenCafe installation instructions Removed Cafe installation instructions from docs and Cafe mappings from sphinx docs Change-Id: I7968c244cebda6811e3de5c11ddc42cc571a0198 --- README.rst | 41 ++++++------------------------------ doc/source/conf.py | 9 +------- doc/source/configuration.rst | 17 +-------------- doc/source/contributing.rst | 3 --- doc/source/index.rst | 3 +-- doc/source/installation.rst | 16 -------------- doc/source/logging.rst | 1 + doc/source/test.anatomy.rst | 2 +- requirements.txt | 1 - 9 files changed, 12 insertions(+), 81 deletions(-) diff --git a/README.rst b/README.rst index 0641b898..18a513ac 100644 --- a/README.rst +++ b/README.rst @@ -31,8 +31,8 @@ Syntribos, An Automated API Security Testing Tool :target: https://pypi.python.org/pypi/syntribos/ :alt: Downloads -Syntribos is an Automated API Security Testing Tool utilizing the `Open -CAFE Framework `__. +Syntribos is an automated API security testing tool that is maintained by +members of the `OpenStack Security Project `__. Given a simple configuration file and an example HTTP request, Syntribos can replace any API URL, URL parameter, HTTP header and request body @@ -80,34 +80,15 @@ pip `__ from the git repository. $ . scripts/syntribos-completion -- Create a directory named .opencafe in the user's home directory, or in the case of a python virtualenv, in the virtualenv root folder. - -:: - - $ cafe-config init - -- Install the http library that gives you the minimum plugins required to use Syntribos. - -:: - - $ cafe-config plugins install http - Configuration ------------- -Copy the data files from Syntribos data directory to .opencafe/data directory created during "cafe-config init". This directory contains the fuzz string files. Copy the example configuration file to .opencafe/configs directory created during "cafe-config init". - -:: - - $ cp syntribos/data/* .opencafe/data/ - $ cp syntribos/examples/configs/keystone.config .opencafe/configs/. - Modify the configuration files to update your keystone URL, API endpoint and user credentials. :: - $ vi .opencafe/configs/keystone.config + $ vi syntribos/examples/configs/keystone.config Example configuration file: @@ -155,18 +136,9 @@ Example configuration file: endpoint=http://localhost:5000 -You can create a templates directory inside .opencafe directory to store the request templates for the resources -being tested. The templates under the `examples` directory can give you a quick -start. - -:: - - $ mkdir .opencafe/templates - $ mkdir .opencafe/templates/keystone - $ cp syntribos/examples/templates/keystone/* .opencafe/templates/keystone - Running Syntribos ----------------- +(**This section will be updated shortly**) To execute a Syntribos test, run ``syntribos`` specifying the configuration file and template file(s) you want to use. @@ -184,6 +156,7 @@ directory: Syntribos Logging ----------------- +(**This section will be updated shortly**) Syntribos takes advantage of the OpenCafe logging facility. Logs are found in ``.opencafe/logs/`` Logs are then arranged in directories based @@ -297,13 +270,13 @@ For SQL injection tests against the template body only, use: :: - $ syntribos keystone.config template/keystone/domains_post.txt -t SQL_INJECTION_BODY + $ syntribos keystone.config templates/keystone/domains_post.txt -t SQL_INJECTION_BODY For all tests against HTTP headers only, use: :: - $ syntribos keystone.config template/keystone/domains_post.txt -t HEADERS + $ syntribos keystone.config templates/keystone/domains_post.txt -t HEADERS **Call External** diff --git a/doc/source/conf.py b/doc/source/conf.py index 30249838..15e475cd 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -75,11 +75,4 @@ latex_documents = [ # Example configuration for intersphinx: refer to the Python standard library. # intersphinx_mapping = {'http://docs.python.org/': None} -intersphinx_mapping = {'cafe': ('http://opencafe.readthedocs.org/en/latest', None), - 'requests': ('http://docs.python-requests.org/en/master', None)} - -# autodoc_mock_imports = [ -# 'cafe', -# 'cafe.engine.http.client', -# 'cafe.drivers.unittest.arguments' -# ] +intersphinx_mapping = {'requests': ('http://docs.python-requests.org/en/master', None)} diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 566e771c..92e05e05 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -1,22 +1,12 @@ Configuration ============= -Copy the data files from Syntribos data directory to ``.opencafe/data`` -directory created during ``cafe-config init``. This directory contains the fuzz -string files. Next, copy the example configuration file to the -``.opencafe/configs`` directory. - -:: - - $ cp data/* .opencafe/data/ - $ cp examples/configs/keystone.config .opencafe/configs/ - Modify the configuration files to update your Keystone URL, API endpoint and user credentials. :: - $ vi .opencafe/configs/keystone.config + $ vi examples/configs/keystone.config Example configuration file: @@ -62,8 +52,3 @@ Example configuration file: # endpoint=http://localhost:5000 - - -You can create a templates directory inside .opencafe directory to store the request templates for the resources -being tested. The templates under the `examples` directory can give you a quick -start. diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 66e4c30d..ea5ca60d 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -7,9 +7,6 @@ Contributing Guidelines `RST format `__ 3. All new code should have appropriate unittests (place them in the ``tests/unit`` folder) -4. No new code will be accepted if it adds a new dependency on OpenCAFE, or adds - on top of existing CAFE functionality IF it cannot stand on its own without - CAFE. Anyone wanting to contribute to OpenStack must follow `the OpenStack development workflow `__ diff --git a/doc/source/index.rst b/doc/source/index.rst index 4dc721d2..e6640724 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,8 +1,7 @@ Syntribos ========= -Syntribos is an Automated API Security Testing Tool utilizing the `Open -CAFE Framework `__. +Syntribos is an automated API security testing tool Given a simple configuration file and an example HTTP request, Syntribos can replace any API URL, URL parameter, HTTP header and request body diff --git a/doc/source/installation.rst b/doc/source/installation.rst index f23765bb..cd0b121d 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -13,19 +13,3 @@ pip `__ from the git repository. $ pip install . --upgrade - To enable autocomplete for Syntribos, run the command. - -:: - - $ . scripts/syntribos-completion - -- Create a directory named .opencafe in the user's home directory, or in the case of a python virtualenv, in the virtualenv root folder. - -:: - - $ cafe-config init - -- Install the http library that gives you the minimum plugins required to use Syntribos. - -:: - - $ cafe-config plugins install http diff --git a/doc/source/logging.rst b/doc/source/logging.rst index aec56384..33b0cfa2 100644 --- a/doc/source/logging.rst +++ b/doc/source/logging.rst @@ -1,5 +1,6 @@ Syntribos logging ================= +(**This section will be updated shortly**) Syntribos takes advantage of the OpenCafe logging facility. Logs are found in ``.opencafe/logs/`` Logs are then arranged in directories based diff --git a/doc/source/test.anatomy.rst b/doc/source/test.anatomy.rst index e3e6c06b..857e39c1 100644 --- a/doc/source/test.anatomy.rst +++ b/doc/source/test.anatomy.rst @@ -53,7 +53,7 @@ To use this extension, you can add the following to your template file: X-Auth-Token: CALL_EXTERNAL|syntribos.extensions.identity.client:get_token_v3:["user"]| The "user" string indicates the data from the configuration file we -added in ``opencafe/configs/keystone.config`` +added in ``examples/configs/keystone.config`` Another example is found in ``random_data/client.py`` . This returns a UUID when random but unique data is needed. This can be used in place of diff --git a/requirements.txt b/requirements.txt index 41eeecdf..32eb0684 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ -opencafe>=0.2.4,<0.2.5 six>=1.9.0 requests>=2.9.0 oslo.config>=3.10.0 # Apache-2.0