Update readme with log details
This commit is contained in:
mattvaldes
parent
2f91d29cb8
commit
67e2a35d8f
78
README.md
78
README.md
|
|
@ -49,12 +49,10 @@ Syntribos can be [installed with pip](https://pypi.python.org/pypi/pip) from the
|
|||
|
||||
Configuration
|
||||
--------------
|
||||
Create .opencafe directory. Then, create .opencafe/data and .opencafe/configs directories. Copy the Syntribos data directory to OpenCafe. This directory contains the fuzz string files. Copy the example configuration file to .opencafe/configs directory.
|
||||
Copy the Syntribos data directory to OpenCafe. This directory contains the fuzz string files. Copy the example configuration file to .opencafe/configs directory.
|
||||
|
||||
```
|
||||
$mkdir .opencafe
|
||||
$cp syntribos/data/* .opencafe/data/
|
||||
mkdir .opencafe/configs
|
||||
$cp syntribos/examples/configs/keystone.config .opencafe/configs/.
|
||||
```
|
||||
|
||||
|
|
@ -154,6 +152,80 @@ To run syntribos against all payload files, just specify the payload directory:
|
|||
$ syntribos keystone.config payloads/keystone/
|
||||
```
|
||||
|
||||
Syntribos Logging
|
||||
-------
|
||||
Syntribos takes advantage of the OpenCafe logging facility. Logs are found in `.opencafe/logs/`
|
||||
Logs are then arranged in directories based on each Syntribos configuration file, and then by date and time.
|
||||
Each log filename has an easy to follow naming convention.
|
||||
```
|
||||
$ls .opencafe/logs/keystone.config/2015-08-18_14_44_04.333088/
|
||||
cafe.master.log
|
||||
syntribos.tests.fuzz.integer_overflow.(domains_post.txt)_(INT_OVERFLOW_BODY)_(integer-overflow.txt)_str1_model1.log
|
||||
syntribos.tests.fuzz.integer_overflow.(domains_post.txt)_(INT_OVERFLOW_BODY)_(integer-overflow.txt)_str1_model2.log
|
||||
syntribos.tests.fuzz.integer_overflow.(domains_post.txt)_(INT_OVERFLOW_BODY)_(integer-overflow.txt)_str1_model3.log
|
||||
syntribos.tests.fuzz.integer_overflow.(domains_post.txt)_(INT_OVERFLOW_BODY)_(integer-overflow.txt)_str2_model1.log
|
||||
syntribos.tests.fuzz.integer_overflow.(domains_post.txt)_(INT_OVERFLOW_BODY)_(integer-overflow.txt)_str2_model2.log
|
||||
syntribos.tests.fuzz.integer_overflow.(domains_post.txt)_(INT_OVERFLOW_BODY)_(integer-overflow.txt)_str2_model3.log
|
||||
```
|
||||
Each log file includes the request details:
|
||||
```
|
||||
------------
|
||||
REQUEST SENT
|
||||
------------
|
||||
request method..: POST
|
||||
request url.....: https://yourapiendpoint/v3/domains
|
||||
request params..:
|
||||
request headers.: {'Content-Length': '46', 'Accept-Encoding': 'gzip, deflate', 'Connection': 'keep-alive', 'Accept': 'application/json', 'User-Agent': 'python-requests/2.7.0 CPython/2.7.9 Darwin/11.4.2', 'Host': 'yourapiendpoint', 'X-Auth-Token': u'9b1ed3d1cc69491ab914dcb6ced00440', 'Content-type': 'application/json'}
|
||||
request body....: {"domain": {"description": "Domain description","enabled": "-1","name": u'ce9871c4-a0a1-4fbe-88db-f0729b43172c'}}
|
||||
|
||||
2015-08-18 14:44:12,464: DEBUG: cafe.engine.http.client:
|
||||
```
|
||||
and the response:
|
||||
```
|
||||
-----------------
|
||||
RESPONSE RECEIVED
|
||||
-----------------
|
||||
response status..: <Response [406]>
|
||||
response time....: 1.32309699059
|
||||
response headers.: {'content-length': '112', 'server': 'nginx', 'connection': 'keep-alive', 'date': 'Tue, 18 Aug 2015 19:44:11 GMT', 'content-type': 'application/json; charset=UTF-8'}
|
||||
response body....: {"message": "The server could not comply with the request since it is either malformed or otherwise incorrect."}
|
||||
-------------------------------------------------------------------------------
|
||||
2015-08-18 14:44:12,465: INFO: root: ========================================================
|
||||
2015-08-18 14:44:12,465: INFO: root: Test Case....: test_case
|
||||
2015-08-18 14:44:12,465: INFO: root: Created At...: 2015-08-18 14:44:11.139070
|
||||
2015-08-18 14:44:12,465: INFO: root: No Test description.
|
||||
2015-08-18 14:44:12,465: INFO: root: ========================================================
|
||||
2015-08-18 14:44:12,465: WARNING: cafe.engine.models.data_interfaces.ConfigParserDataSource: No section: 'fuzz'. Using default value '200.0' instead
|
||||
2015-08-18 14:44:12,465: DEBUG: root: Validate Length:
|
||||
Initial request length: 52
|
||||
Initial response length: 112
|
||||
Request length: 46
|
||||
Response length: 112
|
||||
Request difference: -6
|
||||
Response difference: 0
|
||||
Precent difference: 0.0
|
||||
Config percent: 200.0
|
||||
```
|
||||
and data related to the test results:
|
||||
```
|
||||
2015-08-18 14:44:12,466: INFO: root: ========================================================
|
||||
2015-08-18 14:44:12,466: INFO: root: Test Case......: test_case
|
||||
2015-08-18 14:44:12,466: INFO: root: Result.........: Passed
|
||||
2015-08-18 14:44:12,466: INFO: root: Start Time.....: 2015-08-18 14:44:12.464843
|
||||
2015-08-18 14:44:12,466: INFO: root: Elapsed Time...: 0:00:00.001203
|
||||
2015-08-18 14:44:12,466: INFO: root: ========================================================
|
||||
2015-08-18 14:44:12,467: INFO: root: ========================================================
|
||||
2015-08-18 14:44:12,467: INFO: root: Fixture........: syntribos.tests.fuzz.all_attacks.(agent_patch.txt)_(ALL_ATTACKS_BODY)_(all-attacks.txt)_str1_model1
|
||||
2015-08-18 14:44:12,467: INFO: root: Result.........: Passed
|
||||
2015-08-18 14:44:12,467: INFO: root: Start Time.....: 2015-08-18 14:44:11.139070
|
||||
2015-08-18 14:44:12,467: INFO: root: Elapsed Time...: 0:00:01.328030
|
||||
2015-08-18 14:44:12,468: INFO: root: Total Tests....: 1
|
||||
2015-08-18 14:44:12,468: INFO: root: Total Passed...: 1
|
||||
2015-08-18 14:44:12,468: INFO: root: Total Failed...: 0
|
||||
2015-08-18 14:44:12,468: INFO: root: Total Errored..: 0
|
||||
2015-08-18 14:44:12,468: INFO: root: ========================================================
|
||||
```
|
||||
|
||||
Basic Syntribos Test Anatomy
|
||||
-------------------------------
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue