Skip to content
README.rst 5.96 KiB
Newer Older
Build Status
ziirish's avatar
ziirish committed
============
.. image:: https://ci.ziirish.me/projects/1/status.png?ref=master
    :target: https://ci.ziirish.me/projects/1?ref=master
ziirish's avatar
ziirish committed
Introduction
============

ziirish's avatar
ziirish committed
Screenshots
-----------

ziirish's avatar
ziirish committed
.. image:: https://raw.githubusercontent.com/ziirish/burp-ui/master/pictures/burp-ui.gif
ziirish's avatar
ziirish committed
    :target: https://git.ziirish.me/ziirish/burp-ui/blob/master/pictures/burp-ui.gif
ziirish's avatar
ziirish committed


ziirish's avatar
ziirish committed
What's that?
------------

Let me introduce you ``Burp-UI``. It is a web-based UI to manage your
burp-servers.
You can view different reports about burp-servers, burp-clients, backups, etc.
ziirish's avatar
ziirish committed
``Burp-UI`` allows you to perform *on-the-fly* restorations and should allow
you to edit/manage your burp-server's conf file very soon.

It is actually an improvement of the burp status monitor (``burp -c /etc/burp/burp-server.conf -a s``).

In order to work properly, you must be running ``Burp-UI`` on the same host that
runs your burp-server (because the burp status port only listen on *localhost*).
If you don't want to, I developed a ``bui-agent`` that allows you to *proxify*
ziirish's avatar
ziirish committed
external commands to your burp status port.


Who are you?
------------

ziirish's avatar
ziirish committed
I'm `Ziirish <http://ziirish.info>`_, a French sysadmin who loves `Burp`_ and
would like to help its adoption by providing it a nice and powerful interface.
ziirish's avatar
ziirish committed
If you like my work, you can:

* Thank me by sending me an email or writing a nice comment
* Buy me a beer or some fries or both!
* Make a donation on my Paypal

ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Documentation
=============
ziirish's avatar
ziirish committed
The documentation is hosted on `readthedocs <https://readthedocs.org>`_ at the
following address: `burp-ui.readthedocs.org <https://burp-ui.readthedocs.org>`_
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Troubleshooting
ziirish's avatar
ziirish committed
===============
ziirish's avatar
ziirish committed

In case you encounter troubles with ``Burp-UI``, you should run it with the
``-d`` flag and paste the relevant output within your bug-report.
Please also give the version of ``burp`` AND ``Burp-UI``.
ziirish's avatar
ziirish committed
Since v0.0.6 you can use the ``-V`` or ``--version`` flag in order to get your
version number.


Notes
ziirish's avatar
ziirish committed
=====
Please feel free to report any issues on my `gitlab <https://git.ziirish.me/ziirish/burp-ui/issues>`_.
I have closed the *github tracker* to have a unique tracker system.

ziirish's avatar
ziirish committed
====
`Here <https://git.ziirish.me/ziirish/burp-ui/issues?label_name=todo>`_ is a
non-exhaustive list of things I'd like to add.
ziirish's avatar
ziirish committed
============
ziirish's avatar
ziirish committed
1. SSL issue

My new SSL certificate seem to be unknown on older systems like debian wheezy.
Thus, you may have some SSL failure while trying to clone my repository.
ziirish's avatar
ziirish committed
In order to fix this error, you can run the following command as root that will
add my certificate in your trust list:

::

   echo -n | openssl s_client -showcerts -connect git.ziirish.me:443 -servername git.ziirish.me 2>/dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' >>/etc/ssl/certs/ca-certificates.crt

2. SSH issue

People that would like to clone the repository over SSH will face an
authentication failure even if they added a valid SSH key in their user
settings.
ziirish's avatar
ziirish committed
The reason is I only have *one* public IP address so I must use port
redirections to have multiple SSH instances running.
ziirish's avatar
ziirish committed
To fix the issue, you should configure your SSH client by adding the following
lines in your ``~/.ssh/config`` file:
ziirish's avatar
ziirish committed
   Host git.ziirish.me
      Port 2222
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed

Licenses
ziirish's avatar
ziirish committed
========
ziirish's avatar
ziirish committed
``Burp-UI`` is released under the BSD 3-clause `License`_.

But this project is built on top of other tools listed here:

- `d3.js <http://d3js.org/>`_ (`BSD <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/d3/LICENSE>`__)
- `nvd3.js <http://nvd3.org/>`_ (`Apache <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/nvd3/LICENSE.md>`__)
- `jQuery <http://jquery.com/>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/jquery/MIT-LICENSE.txt>`__)
- `jQuery-UI <http://jqueryui.com/>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/jquery-ui/MIT-LICENSE.txt>`__)
- `fancytree <https://github.com/mar10/fancytree>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/fancytree/MIT-LICENSE.txt>`__)
- `bootstrap <http://getbootstrap.com/>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/bootstrap/LICENSE>`__)
- `typeahead <http://twitter.github.io/typeahead.js/>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/typeahead/LICENSE>`__)
- `bootswatch <http://bootswatch.com/>`_ theme ``Slate`` (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/bootstrap/bootswatch.LICENSE>`__)
- `angular-bootstrap-switch <https://github.com/frapontillo/angular-bootstrap-switch>`_ (`Apache <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/angular-bootstrap-switch/LICENSE>`__)
- `angular.js <https://angularjs.org/>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/angularjs/LICENSE>`__)
- `angular-ui-select <https://github.com/angular-ui/ui-select>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/angular-ui-select/LICENSE>`__)
ziirish's avatar
ziirish committed
- `AngularStrap <http://mgcrea.github.io/angular-strap/>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/angular-strap/LICENSE.md>`__)
ziirish's avatar
ziirish committed
- `lodash <https://github.com/lodash/lodash>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/lodash/LICENSE.txt>`__)
- `DataTables <http://datatables.net/>`_ (`MIT <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/DataTables/LICENSE.txt>`__)
ziirish's avatar
ziirish committed
- 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>`_
ziirish's avatar
ziirish committed
Also note that this project is made with the Awesome `Flask`_ micro-framework.
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Thanks
ziirish's avatar
ziirish committed
======

Special Thanks to Graham Keeling for its great software! This project would not
exist without `Burp`_.

.. _Flask: http://flask.pocoo.org/
.. _License: https://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE
.. _Burp: http://burp.grke.org/
ziirish's avatar
ziirish committed
.. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg