README.rst 4.9 KB
Newer Older
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
1 2
Burp-UI
=======
3

4
.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/master/build.svg
5
    :target: https://git.ziirish.me/ziirish/burp-ui/pipelines
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
6 7
    :alt: Build Status

8
.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/master/coverage.svg
9 10 11
    :target: https://git.ziirish.me/ziirish/burp-ui/pipelines
    :alt: Test coverage

12 13
.. image:: https://readthedocs.org/projects/burp-ui/badge/?version=latest
    :target: https://readthedocs.org/projects/burp-ui/?badge=latest
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
14
    :alt: Documentation Status
15

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
16 17
.. contents::

18
Introduction
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
19
------------
20

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
21
Screenshots
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
22
^^^^^^^^^^^
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
23

24 25
.. image:: https://git.ziirish.me/ziirish/burp-ui/raw/master/docs/_static/burp-ui.gif
    :target: https://git.ziirish.me/ziirish/burp-ui/blob/master/docs/_static/burp-ui.gif
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
26

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
27
Demo
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
28
^^^^
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
29 30 31

A screenshot is worth a thousand words, but a Demo is worth a thousand
screenshots.
32 33
You can now play with ``Burp-UI`` at
`demo.burp-ui.org <https://demo.burp-ui.org/>`_
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
34 35 36

Credentials:

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
37
- *admin* / *admin* to play with ``Burp-UI`` as an administrator
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
38
- *moderator* / *moderator* to play with ``Burp-UI`` as a moderator
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
39
- *demo* / *demo* to play with ``Burp-UI`` as a regular user
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
40

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
41
What's that?
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
42
^^^^^^^^^^^^
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
43 44

Let me introduce you ``Burp-UI``. It is a web-based UI to manage your
45 46
burp-servers.
You can view different reports about burp-servers, burp-clients, backups, etc.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
47
``Burp-UI`` allows you to perform *online* restorations and to edit/manage
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
48
your burp-server's configuration files.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
49 50

Who are you?
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
51
^^^^^^^^^^^^
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
52

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
53
I'm `Ziirish <http://ziirish.info>`__, a French *DevOps* who loves `Burp`_ and
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
54
who'd like to help its adoption by providing it a nice and powerful interface.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
55 56
If you like my work, you can:

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
57 58 59
* Thank me by sending me an email or writing nice comments
* Buy me a beer or some fries (or both!)
* Make a donation on my `Paypal <http://ziirish.info>`__
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
60

61
Documentation
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
62
-------------
63

64
The documentation is hosted on `readthedocs <https://readthedocs.org>`_ at the
65
following address: `burp-ui.readthedocs.io`_
66

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
67
FAQ
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
68
---
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
69

70
A `FAQ`_ is available with the documentation.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
71

72
Community
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
73
---------
74

75
Please refer to the `Contributing`_ page.
76

77
Notes
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
78
-----
79

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
80 81
Feel free to report any issues on my `gitlab
<https://git.ziirish.me/ziirish/burp-ui/issues>`_.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
82

83
I have closed the *github tracker* to have a unique tracker system.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
84

85 86
Also please, read the `Contributing`_ page before reporting any issue to make
sure we have all the informations to help you.
87 88
Bug report that don't comply with the rules will likely be **ignored** because
my spare time is quite limited.
89

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
90
See also
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
91
--------
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
92

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
93 94
Starting with burp-ui v0.3.0, I introduced you `burp_server_report
<https://github.com/pablodav/burp_server_reports>`_
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
95 96 97 98 99
a project lead by Pablo Estigarribia.

Pablo also contributed to other interesting projects to automate burp and burp-ui
deployments through Ansible:

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
100 101
- `burpui_server <https://galaxy.ansible.com/CoffeeITWorks/burpui_server/>`_
- `burp2_server <https://galaxy.ansible.com/CoffeeITWorks/burp2_server/>`_
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
102

103 104 105 106 107
@qm2k contributed some scripts/config to tweak your setup. You can found them here:

- `burp-ui_integration <https://github.com/qm2k/burp-ui_integration>`_
- `burp_integration <https://github.com/qm2k/burp_integration>`_

108
Licenses
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
109
--------
110

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
111
``Burp-UI`` is released under the BSD 3-clause `License`_.
112

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
113
But this project is built on top of other tools. Here is a non exhaustive list:
114

115 116 117 118 119 120 121 122 123 124 125 126 127 128
- `d3.js <http://d3js.org/>`_
- `nvd3.js <http://nvd3.org/>`_
- `jQuery <http://jquery.com/>`_
- `jQuery-UI <http://jqueryui.com/>`_
- `fancytree <https://github.com/mar10/fancytree>`_
- `bootstrap <http://getbootstrap.com/>`_
- `typeahead <http://twitter.github.io/typeahead.js/>`_
- `bootswatch <http://bootswatch.com/>`_ theme ``Slate``
- `angular-bootstrap-switch <https://github.com/frapontillo/angular-bootstrap-switch>`_
- `angular.js <https://angularjs.org/>`_
- `angular-ui-select <https://github.com/angular-ui/ui-select>`_
- `AngularStrap <http://mgcrea.github.io/angular-strap/>`_
- `lodash <https://github.com/lodash/lodash>`_
- `DataTables <http://datatables.net/>`_
129
- Home-made `favicon <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/images/favicon.ico>`_ based on pictures from `simpsoncrazy <http://www.simpsoncrazy.com/pictures/homer>`_
130

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
131
Also note that this project is made with the Awesome `Flask`_ micro-framework.
132

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
133
Thanks
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
134
------
135

Benjamin "Ziirish" SANS's avatar
typo  
Benjamin "Ziirish" SANS committed
136
Thank you all for your feedbacks and bug reports. Those are making the project
137
moving forward.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
138

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
139
Thank you to the `Flask`_ developers and community.
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
140

Benjamin "Ziirish" SANS's avatar
typo  
Benjamin "Ziirish" SANS committed
141
Special Thanks to Graham Keeling for his great piece of software! This project
Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
142
would not exist without `Burp`_.
143

Benjamin "Ziirish" SANS's avatar
Benjamin "Ziirish" SANS committed
144

145
.. _Flask: http://flask.pocoo.org/
146
.. _License: https://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE
147
.. _Burp: http://burp.grke.org/
148 149 150 151
.. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg
.. _burp-ui.readthedocs.io: https://burp-ui.readthedocs.io/en/latest/
.. _FAQ: https://burp-ui.readthedocs.io/en/latest/faq.html
.. _Contributing: https://burp-ui.readthedocs.io/en/latest/contributing.html