sandmark.obfuscate.addbogusfields
Class AddBogusFields

java.lang.Object
  |
  +--sandmark.Algorithm
        |
        +--sandmark.obfuscate.GeneralObfuscator
              |
              +--sandmark.obfuscate.ClassObfuscator
                    |
                    +--sandmark.obfuscate.addbogusfields.AddBogusFields

public class AddBogusFields

extends ClassObfuscator

The AddBogusFields obfuscator changes adds a bogus field to each class in an application and through out the class makes assignments to the field.

Author:

Ginger Myles and Miriam Miklofsky

Constructor Summary

AddBogusFields()
Constructor.

Method Summary

void	apply(ClassFileCollection cfc, java.lang.String className) Applies this obfuscator to the given class.
java.lang.String	getAlgHTML() Gives a description of what the algorithm does.
java.lang.String	getAlgURL() Specifies the URL of where the user can find more information about the algorithm.
java.lang.String	getAuthor() Specifies the author of the algorithm.
java.lang.String	getAuthorEmail() Specifies the email address author of the algorithm.
ConfigProperties	getConfigProperties() Gets the ConfigProperties object which specifies the parameters for this run of the algorithm.
java.lang.String	getDescription() Specifies what this algorithm does, briefly.
java.lang.String	getLongName() Specifies this algorithm's long name.
ModificationProperty[]	getMutations() Specifies the types of modifications that the algorithm makes.
java.lang.String	getShortName() Specifies this algorithm's short name.
void	setConfigProperties(ConfigProperties props) Set the properties of AddBogusFields

Methods inherited from class sandmark.obfuscate.ClassObfuscator

toString

Methods inherited from class sandmark.Algorithm

getPostprohibited, getPostrequisites, getPostsuggestions, getPreprohibited, getPrerequisites, getPresuggestions, getReferences

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AddBogusFields

public AddBogusFields()

Constructor.

Method Detail

getShortName

public java.lang.String getShortName()

Description copied from class: Algorithm

Specifies this algorithm's short name. A short name should be no longer than 20 characters, and contain capitalized space delimited words (i.e. title case). For example, an obfuscation that sets all of the fields in a jar file to public scoping should have a short name like "Set Fields Public".

Specified by:

getShortName in class Algorithm

Returns:

the short name for this algorithm

getLongName

public java.lang.String getLongName()

Description copied from class: Algorithm

Specifies this algorithm's long name. There is no limit on the size of the long name, but it should be in title case.

Specified by:

getLongName in class Algorithm

Returns:

the long name for this algorithm

getConfigProperties

public ConfigProperties getConfigProperties()

Description copied from class: Algorithm

Gets the ConfigProperties object which specifies the parameters for this run of the algorithm.

Specified by:

getConfigProperties in class Algorithm

Returns:

the parameters for this run of the algorithm

setConfigProperties

public void setConfigProperties(ConfigProperties props)

Set the properties of AddBogusFields

Specified by:

setConfigProperties in class Algorithm

Parameters:

props -

getAlgHTML

public java.lang.String getAlgHTML()

Description copied from class: Algorithm

Gives a description of what the algorithm does. This should not be a long description of what your code does, rather a brief description as to what effect it has on the program. For example, a good algorithm description would be "Set Fields Public changes the scope of all static and non-static fields to public."; a bad algorithm description would be "Set Fields Public creates a BCEL object for each class and makes modifications to it, then stores it back into the jar file."

Specified by:

getAlgHTML in class Algorithm

Returns:

an HTML formatted description of what the algorithm does.

getAuthor

public java.lang.String getAuthor()

Description copied from class: Algorithm

Specifies the author of the algorithm.

Specified by:

getAuthor in class Algorithm

Returns:

the name of the author of the algorithm

getAuthorEmail

public java.lang.String getAuthorEmail()

Description copied from class: Algorithm

Specifies the email address author of the algorithm.

Specified by:

getAuthorEmail in class Algorithm

Returns:

the email address of the author of the algorithm

getDescription

public java.lang.String getDescription()

Description copied from class: Algorithm

Specifies what this algorithm does, briefly. This description is displayed to the user in the log of execution in Sandmark.

Specified by:

getDescription in class Algorithm

Returns:

a brief description of the algorithm

getMutations

public ModificationProperty[] getMutations()

Description copied from class: Algorithm

Specifies the types of modifications that the algorithm makes. For more information see ModificationProperty.

Specified by:

getMutations in class Algorithm

Returns:

a list of mutations that this algorithm may do on the code

getAlgURL

public java.lang.String getAlgURL()

Description copied from class: Algorithm

Specifies the URL of where the user can find more information about the algorithm. This URL should point to the help.html file in the doc directory where the algorithm resides, starting from the sandmark directory. For example, the URL for the static_template watermarking sample would be sandmark/watermark/static_template/doc/help.html

Specified by:

getAlgURL in class Algorithm

Returns:

a URL to the help.html file for the algorithm

apply

public void apply(ClassFileCollection cfc,
                  java.lang.String className)
           throws java.lang.Exception

Applies this obfuscator to the given class.

Specified by:

apply in class ClassObfuscator

Parameters:

cfc -

className -

java.lang.Exception