Updating the Project Structure documentation

-updating the structure.rst file, specifically providing the details
for scripts in Project Structure
-deleting the fuzzdGen.py file, since not using it anymore for Syntribos

Change-Id: Ia37c82a42ba05107fc42d3b0e63d9066200e9f30

doc/source/structure.rst

@@ -5,18 +5,29 @@ Project Structure
 - ``data/`` (textfiles containing data for use by syntribos tests)
 - ``doc/source/`` (Sphinx documentation files)
 - ``examples/`` (example syntribos request templates, config files)
-    - ``configs/`` (examples of syntribos configs; currently only Keystone)
-    - ``templates/`` (examples of request templates; currently only Keystone/Solum)
-- ``scripts/`` (?)
+    - ``configs/`` (examples of syntribos configs)
+    - ``templates/`` (examples of request templates)
+- ``scripts/`` (helper Python scripts for managing the project)
+    - ``readme.py`` (Python file for creating/updating the README.rst)
 - ``syntribos/`` (core syntribos code)
     - ``clients/`` (clients for making calls, e.g. HTTP)
         - ``http/`` (clients for making HTTP requests)
+    - ``checks/`` (for analyzing HTTP response and returning a signal if it detects
+                   something that it knows about)
     - ``extensions/`` (extensions that can be called in request templates)
         - ``identity/`` (extension for interacting with Keystone/identity)
         - ``random_data/`` (extension for generating random test data)
+        - ``cinder/`` (extension for interacting with Cinder/block storage)
+        - ``glance/`` (extension for interacting with Glance/image)
+        - ``neutron/`` (extension for interacting with Neutron/network)
+        - ``nova/`` (extension for interacting with Nova/compute)
     - ``formatters/`` (output formatters, e.g. JSON, XML/XUnit)
     - ``tests/`` (location of tests that syntribos can run against a target)
         - ``auth/`` (tests related to authentication/authorization)
         - ``fuzz/`` (tests that "fuzz" API requests)
+        - ``debug/`` (internal syntribos tests, these will not be included in a
+                      normal run of syntribos)
+        - ``headers/`` (tests related to insecure HTTP headers)
+        - ``transport_layer/`` (tests related to SSL and TLS vulnerabilities)
     - ``utils/`` (utility methods)
 - ``tests/unit/`` (unittests for testing syntribos itself)

scripts/fuzzdbGen.py

@@ -1,26 +0,0 @@
-# Copyright 2015 Rackspace
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-import os
-import sys
-
-fuzzdb_path = "{fuzzdb_dir}/attack-payloads".format(
-    fuzzdb_dir=sys.argv[1])
-syntribos_data_path = "{data_dir}".format(data_dir=sys.argv[2])
-
-for directory in os.listdir(fuzzdb_path):
-    os.system(
-        'find {0} | grep .txt$ | egrep -v "readme|exploit" | xargs cat |'
-        'egrep -v "^#|^$" > {1}'.format(
-            os.path.join(fuzzdb_path, directory),
-            os.path.join(syntribos_data_path, "{0}.txt".format(directory))))