Balbuzard
=========

`Balbuzard <http://www.decalage.info/python/balbuzard>`_ is a package of
malware analysis tools in python to extract patterns of interest from
suspicious files (IP addresses, domain names, known file headers,
interesting strings, etc). It can also crack malware obfuscation such as
XOR, ROL, etc by bruteforcing and checking for those patterns.

Quick links:
`Download <http://bitbucket.org/decalage/balbuzard/downloads>`_ -
`Install <https://bitbucket.org/decalage/balbuzard/wiki/Installation>`_
- `Documentation <https://bitbucket.org/decalage/balbuzard/wiki>`_ -
`Contact <http://www.decalage.info/contact>`_ - `Report
issues <https://bitbucket.org/decalage/balbuzard/issues?status=new&status=open>`_
- `Updates on Twitter <https://twitter.com/decalage2>`_

Balbuzard tools:
----------------

-  `balbuzard <https://bitbucket.org/decalage/balbuzard/wiki/balbuzard/>`_
   is a tool to extract patterns of interest from malicious files, such
   as IP addresses, URLs, embedded files and typical malware strings. It
   is easily extensible with new patterns, regular expressions and Yara
   rules.
-  `bbcrack <https://bitbucket.org/decalage/balbuzard/wiki/bbcrack/>`_
   uses a new algorithm based on patterns of interest to bruteforce
   typical malware obfuscation such as XOR, ROL, ADD and various
   combinations, in order to guess which algorithms/keys have been used.
-  `bbharvest <https://bitbucket.org/decalage/balbuzard/wiki/bbharvest/>`_
   extracts all patterns of interest found when applying typical malware
   obfuscation transforms such as XOR, ROL, ADD and various
   combinations, trying all possible keys. It is especially useful when
   several keys or several transforms are used in a single file.
-  `bbtrans <https://bitbucket.org/decalage/balbuzard/wiki/bbtrans/>`_
   can apply any of the transforms from bbcrack (XOR, ROL, ADD and
   various combinations) to a file.

When to use these tools:
------------------------

-  If you need to analyze a new malicious file, you can first try
   `balbuzard <https://bitbucket.org/decalage/balbuzard/wiki/balbuzard/>`_
   to extract strings/patterns of interest and detect embedded files in
   cleartext.
-  Then if you think the malicious file might use an obfuscation
   algorithm such as XOR to hide interesting data (e.g. an embedded
   executable file), try
   `bbcrack <https://bitbucket.org/decalage/balbuzard/wiki/bbcrack/>`_
   to find the algorithm and the key(s).
-  Alternatively, if bbcrack is not successful, or if you think the file
   may use several algorithms and/or keys, try
   `bbharvest <https://bitbucket.org/decalage/balbuzard/wiki/bbharvest/>`_.
   bbharvest is especially targeted at single strings obfuscated within
   an executable or malicious file.

5 minutes demo
--------------

See the `Demo <https://bitbucket.org/decalage/balbuzard/wiki/Demo/>`_
page to see examples and test the tools by yourself in a few minutes
using the provided samples.

Help wanted:
------------

-  if you have malware samples or malicious documents with known
   obfuscation algorithms such as XOR, please `contact
   me <http://www.decalage.info/contact>`_. That will help me a lot to
   improve bbcrack and bbharvest.
-  if you know other strings, patterns, file headers useful for malware
   analysis that Balbuzard should support, or other obfuscation
   algorithms, please `contact me <http://www.decalage.info/contact>`_.

See http://www.decalage.info/python/balbuzard for more info and other
tools.

--------------

News
====

Follow all updates and news on Twitter: https://twitter.com/decalage2

-  2014-03-23 v0.19: bugfix when Yara is not installed, improved
   `documentation <https://bitbucket.org/decalage/balbuzard/wiki>`_.
-  2014-02-26 v0.18: Initial release of Balbuzard tools
-  2013-03-15: added harvest mode (bbharvest)
-  2011-05-06: added bruteforce functions (bbcrack)
-  2008-06-06: first public release as
   `reScan <http://decalage.info/rescan>`_ for
   `SSTIC08 <http://decalage.info/sstic08>`_
-  2007-07-11: first versions of reScan
-  see changelog in source code for more info.

Download
========

The archive is available on `the project page on
Bitbucket <https://bitbucket.org/decalage/balbuzard/downloads>`_.

Installation
============

See the `installation
instructions <https://bitbucket.org/decalage/balbuzard/wiki/Installation>`_.

How to contribute / report bugs / ask for help:
===============================================

These are open-source tools developed on my spare time. Any contribution
such as code improvements, ideas, bug reports, additional patterns or
transforms would be highly appreciated. You may contact me using `this
online form <http://www.decalage.info/contact>`_, by e-mail (decalage at
laposte.net) or use the `issue page on
Bitbucket <https://bitbucket.org/decalage/balbuzard/issues?status=new&status=open>`_
to report bugs/ideas, or clone the project then send me pull requests to
suggest changes.

License
=======

This license applies to the whole Balbuzard package including balbuzard,
bbcrack, bbharvest and bbtrans, apart from the thirdparty and plugins
folders which contain third-party files published with their own
license.

The Balbuzard package is copyright (c) 2007-2014, Philippe Lagadec
(http://www.decalage.info) All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

-  Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
-  Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
