<commit_before>
         **WARNING: ScrambleSuit is NOT YET SAFE for practical use!**
-------------------------------------------------------------------------------

Overview
========

ScrambleSuit is a pluggable transport protocol for `obfsproxy`.  It is written
in pure Python and solves two problems:

* Protection against active probing attacks by requiring a *shared secret*
  between the client and the server.  This secret is communicated *out-of-band*
  via Tor's BridgeDB.
* Rudimentary defence against traffic analysis attacks by *altering flow
  features*.  In particular, ScrambleSuit alters its inter-arrival times and
  packet length distribution.

Besides, ScrambleSuit's payload is computationally indistinguishable from
randomness.  Clients can authenticate themselves towards a ScrambleSuit bridge
by conducting a modified UniformDH handshake or by redeeming a special session
ticket.

For the detailed design of ScrambleSuit, please have a look at the project
page available at <http://www.cs.kau.se/philwint/scramblesuit/>.

Installation and Testing
========================
<commit_msg>Provide more useful links in the overview section and fix markup bug.<commit_after>**WARNING: ScrambleSuit is NOT YET SAFE for practical use!**
------------------------------------------------------------

Overview
========

ScrambleSuit is a pluggable transport protocol for `obfsproxy`.  It is written
in pure Python and solves two problems:

* Protection against active probing attacks by requiring a *shared secret*
  between the client and the server.  This secret is communicated *out-of-band*
  via Tor's BridgeDB.
* Rudimentary defence against traffic analysis attacks by *altering flow
  features*.  In particular, ScrambleSuit alters its inter-arrival times and
  packet length distribution.

Besides, ScrambleSuit's payload is computationally indistinguishable from
randomness.  Clients can authenticate themselves towards a ScrambleSuit bridge
by conducting a modified UniformDH handshake or by redeeming a special session
ticket.

For a more detailed overview of ScrambleSuit, please have a look at the project
page available at <http://www.cs.kau.se/philwint/scramblesuit/>.  The research
paper is available at <http://www.cs.kau.se/philwint/pdf/wpes2013.pdf>.
Finally, the directory "doc/" in this repository contains the protocol
specification of ScrambleSuit.

Installation and Testing
========================

{'fraction_non_alphanumeric': 0.1297208538587849, 'fraction_numerical': 0.0016420361247947454, 'mean_word_length': 3.650763358778626, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 3, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1706146', 'n_tokens_mistral': 646, 'n_tokens_neox': 583, 'n_words': 277}