Changeset 105 for wiki


Ignore:
Timestamp:
07/13/16 13:18:34 (8 years ago)
Author:
tim
Message:

.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • wiki/Overview.wiki

    r86 r105  
    11Here you will find a brief overview of the tools and libraries provided by Bletchley.  For further details, see the individual tool usage statements, pydoc documentation, and of course the <a href="https://github.com/ecbftw/bletchley">source code</a>.
    22
    3 = Installation =
     3<h1>Installation</h1>
    44See: <a href="https://github.com/ecbftw/bletchley/blob/master/trunk/INSTALL">INSTALL</a>
    55
    6 = Command Line Tools =
     6<h1>Command Line Tools</h1>
    77
    8 == bletchley-analyze ==
     8<h2> bletchley-analyze </h2>
    99
    1010Analyzes samples of encrypted data in an attempt to decode samples to
    … …  
    3939As an example, several tokens were encrypted using ECB mode and encoded
    4040using base64, and then percent (URL) encoded:
    41 {{{
     41<pre>
    4242zRW5bHxcRYHHqi0nriqOzg%3D%3D
    4343meU8SyxVHE3Hqi0nriqOzg%3D%3D
    4444vTA9eA4hhbFlktsbYI4hIg%3D%3D
    4545meU8SyxVHE1lktsbYI4hIg%3D%3D
    46 }}}
     46</pre>
    4747
    4848These tokens were then fed to <code>bletchley-analyze</code>:
    49 <img src="https://raw.githubusercontent.com/ecbftw/bletchley/master/wiki/images/bletchley-analyze.png" />
     49<img src="https://code.blindspotsecurity.com/trac/bletchley/export/head/wiki/images/bletchley-analyze.png" />
    5050
    51511. <i>Bletchley's blobtools module currently supports 36 encoding variants,
    … …  
    5454
    5555
    56 == bletchley-encode ==
     56<h2> bletchley-encode </h2>
    5757A simple tool to encode arbitrary data using a specified encoding chain.
    5858See the usage statement for more information.  A quick example:
    59 {{{
     59<pre>
    6060$ echo 'Mallory Is My Friend.' | bletchley-encode -e percent/upper-plus,base64/rfc3548
    6161TWFsbG9yeSBJcyBNeSBGcmllbmQuCg%3D%3D
    62 }}}
     62</pre>
    6363
    6464NOTE: The encoding chain is applied from right to left in order to be consistent with other tools. 
    … …  
    6767
    6868
    69 == bletchley-decode ==
     69<h2> bletchley-decode </h2>
    7070A simple tool to decode data using a specified encoding chain.  See the
    7171usage statement for more information.  A quick example:
    72 {{{
     72<pre>
    7373$ echo 'TWFsbG9yeSBJcyBNeSBGcmllbmQuCg%3D%3D' | bletchley-decode -e percent/upper-plus,base64/rfc3548
    7474Mallory Is My Friend.
    75 }}}
     75</pre>
    7676
    77 == bletchley-http2py ==
     77<h2> bletchley-http2py </h2>
    7878This script parses an HTTP request (provided via stdin or as a text
    7979file) and generates a Python script that sends (approximately) the same
    … …  
    8282browser.  For more information, see the script's usage statement.
    8383
    84 == bletchley-nextrand ==
     84<h2> bletchley-nextrand </h2>
    8585A simple program which computes the state of a Java Random class
    8686instance given two sequential outputs of
    … …  
    8989
    9090
    91 = Libraries =
     91<h1>Libraries</h1>
    9292
    9393Start with '<code>pydoc3 bletchley</code>'.  The following provides a brief overview of what each module is for.
    9494
    9595
    96 == blobtools ==
     96<h2> blobtools </h2>
    9797This module contains the code which handles base analysis of encrypted
    9898token encodings.  It can be used to automatically detect the most likely
    … …  
    101101
    102102
    103 == buffertools ==
     103<h2> buffertools </h2>
    104104This module contains a collection of tools mean to help one manipulate
    105105binary buffers of ciphertext.
    106106
    107107
    108 == CBC ==
     108<h2> CBC </h2>
    109109The CBC module contains various tools for attacking CBC encrypted data.
    110110In particular, it contains the POA class which automates padding oracle
    … …  
    115115
    116116
    117 = Support =
     117<h1>Support</h1>
    118118
    119 Having trouble?  Submit an issue <a href="https://github.com/ecbftw/bletchley/issues">here</a>, or
     119Having trouble?  Submit an issue <a href="/trac/bletchley/newticket">here</a>, or
    120120ask on the <a href="https://groups.google.com/d/forum/bletchley-devel">email list</a>.
    121121
    122122
    123 = Contributing =
     123<h1>Contributing</h1>
    124124
    125125We welcome any kind of help with the project, from new tools to bug
    126 fixes and documentation.  You might want to start with our
    127 <a href="https://github.com/ecbftw/bletchley/blob/master/trunk/doc/TODO">TODO</a>
     126fixes and documentation.  You might want to start with our <a href="/trunk/doc/TODO">TODO</a>
    128127list.  Note that the GitHub repository is currently just a static mirror, so please don't submit pull requests.
    129128To submit a patch, please post an issue or submit it to the <a href="https://groups.google.com/d/forum/bletchley-devel">email list</a> and we'll merge it.
Note: See TracChangeset for help on using the changeset viewer.