Home

Awesome

#<a id="top"></a>Anonymouth

Document Anonymization Tool, Version 0.5<br>

The Privacy, Security and Automation Lab (PSAL)<br> Drexel University, Philadelphia PA<br> http://psal.cs.drexel.edu/

#Index

  1. Set Up
  2. Development
  3. Credits

#Set Up

###<a id="introduction"></a>Introduction

Anonymouth is a Java-based application that aims to give users to tools and knowledge needed to begin anonymizing documents they have written.

It does this by firing up JStylo libraries (an author detection application also develped by PSAL) to detect stylometric patterns and determine features (like word length, bigrams, trigrams, etc.) that the user should remove/add to help obsure their style and identity.

Though Anonymouth and it's team works hard to provide you with tools to help remove your identity from documents you have written, WE CAN IN NO WAY GUARANTEE THAT YOUR DOCUMENT IS ANONYMOUS OR NOT ANONYMOUS. Anonymouth is always giving you it's best guess, it's best idea of where your document stands, though that should not any any time be taken as an absolute (for example, you could have forgotten to remove your name from the document and Anonymouth has no way to know that that's your name and should remove it). What we can say is Anonymouth is only as good as you make it, and when used right can be helpful in guiding your document towards the right direction.

Back to top

###<a id="dependencies"></a>Dependencies

Java 7 is required to run Anonymouth. If you don't yet have it, get it at <a href="http://java.com/en/download/index.jsp">Oracle's website here</a> and follow the installation instructions provided there.

If you are unsure whether or not you have it installed, follow these steps to see:

If you are using Eclipse, also make sure that Java 7 is your selected compiler by checking Preferences/Java/Compiler and is an included Library in your java Build Path (Not sure how to do this? Google is your friend).

Anonymouth requires the included jsan_resources directory in it's running directory (The main Anonymouth directory containing lib, src, etc.). It should be in the correct directy by default.

Anonymouth requires a corpus (basically a database of other authors and documents they have written) to run. It needs this so it can classify your documents with respect to these other documents and their styles so that Anonymouth can give you an idea of how anonymous it thinks your document is and what features to remove/add to help you get there. Three different corpi are included in the project directory for you to choose and are located at:

Though we included corpi, you are more than welcome to use any other corpus you may have. It is recommended to use many different combinations of authors so you can get the best posisble picture of where your document stands anonymously with respect to others.

Anonymouth also needs the following jars in the lib directory (everything should already be included):

<table> <tr> <th>Package Name</th><th>Version</th> </tr> <tr> <td>weka</td><td>3.7.9</td> </tr> <tr> <td>fasttag</td><td>2.0</td> </tr> <tr> <td>Jama</td><td>1.0.3</td> </tr> <tr> <td>jaws</td><td>1.3</td> </tr> <tr> <td>jcommon</td><td>1.0</td> </tr> <tr> <td>freechart</td><td>1.0.14</td> </tr> <tr> <td>jgaap</td><td>5.4.0</td> </tr> <tr> <td>microsoft translator</td><td>0.6.1</td> </tr> <tr> <td>miglayout</td><td>4.0</td> </tr> <tr> <td>tt4j</td><td>1.0.15</td> </tr> <tr> <td>Stanford postagger</td><td>-</td> </tr> <tr> <td>ui</td><td>-</td> </tr> </table>

Back to top

###<a id="installation"></a>Installation

There quickest and easiest way to install Anonymouth is to clone or download the zip of the <a href="https://github.com/psal/anonymouth">Anonymouth github project here</a>

And then import this project as an existing project into Eclipse (or clone and import directly within Eclipse if you have the Eclipse eGit plugin).

This is currently the only ready way to compile and run Anonymouth. We will be including a updated build file soon so that you may build and run Anonymouth easily within the command land, but sadly it hasn't been done yet so this is the only option currently

Back to top

###<a id="how-to-build-and-run"></a>How to Build and Run

Once Anonymouth is all set up in Eclipse, you need only run ThePresident from the package edu.drexel.psal.anonymouth.gooie to begin using it.

Please note that there are two main package categories, JStylo and Anonymouth. The majority of Anonymouth developement should be in the Anonymouth packages as Anonymouth simply uses the JStylo libraries for parts of the initial document process, so beginners need only concern themselves with the Anonymouth packages.

Back to top

#Development

###<a id="basic-logic-flow"></a>Basic Logic Flow

#####↓ ---LAUNCH---

<b>Setup and start up:</b> anonymouth.gooie.ThePresident

Should never be accessed in any other class (or at least limit it). It's only purpose is to initialize the main class and other start up classes.

#####↓ ---AUTOMATICALLY DISPLAYS---

<b>Start up window:</b> anonymouth.gooie.StartWindow

The first window that shows up (not counting the splash screen) when Anonymouth loads up. Allows the user to change advanced processing settings, access the pre process set up wizard, or start Anonymouth

#####↓ ---USER CLICKED START BUTTON---

<b>Initial document processing begins immediately with: </b>anonymouth.engine.DocumentProcessor

Inititalized within GUIMain as should nearly all Anonymouth class instances, this holds the main method and thread that handles processing and reprocessing documents. All processing events can be traced back to this class.

#####↓ ---PROCESSING COMPLETE---

<b>Main GUI Code:</b> anonymouth.gooie.GUIMain

The main gui window is displayed. This is also the central "hub" for Anonymouth. This should be the main instance center, and anytime you want to access code from other classes from another class you more than likely will be going through this.

<b>From here the logic flow depends largely on what the user does:</b>

Back to top

###<a id="basic-class-structure"></a>Basic Class Structure

#####---Naming Convention---

For the most part, Anonymouth splits UI objects into two classes: [Class name]Panel/Window and [Class name]Driver. By convention and a general guideline, the Panel/Window class:

While the cooresponding Driver class:

Again, these are just general guidelines. Sometimes it makes more sense to just have one class handle everything if it's a small object, or sometimes it doesn't make sense to have a seperate Panel/Window class but it does to have a Driver class, etc. You just need to use your best judgement on what will make things more organized and easier to understand.

#####---Package / Organizing Convention---

Anonymouth loosly follows these guidelines for class organization in packages:

There are still quite a few classes that are clearly where they don't belong, so feel free to oragnize Anonymouth so that it best fits these guidelines.

Back to top

###<a id="to-do-list"></a>To Do List Add features as they are conceived and strikethrough as they are completed ([1] means most important and [5] means relatively small and not particularly a priority at the moment)

Back to top

###<a id="known-bugs"></a>Known Bugs Add bugs as they are discovered and strikethrough as they are completed ([1] means fatal or breaks usability and [5] means relatively small and does not have much of an impact on usability)

Back to top

#Credits

###<a id="developers"></a>Developers

P.I. Dr. Rachel Greenstadt:

Developed by:

Back to top

###<a id="license"></a>License

Anonymouth was released by the Privacy, Security and Automation lab at Drexel University in 2011 under the AGPLv3 license. A copy of this license is included with the repository/program. If for some reason it is absent, it can be viewed <a href="http://www.gnu.org/licenses/agpl.html">here</a>.

Back to top