diff --git a/.gitattributes b/.gitattributes index 9a1ec9ca9cf63e734a8add25ac3506022bbab556..dac8acc88ece5382448422ad3d3919a767a489cc 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,6 @@ * text=auto !eol /Build.sh -text +/README.txt -text /SMPStaticAnalyzer.cpp -text /makefile -text /plugin.script -text diff --git a/README.txt b/README.txt new file mode 100644 index 0000000000000000000000000000000000000000..fb0457a03ed43a97fd91558109a4a30d166951f9 --- /dev/null +++ b/README.txt @@ -0,0 +1,43 @@ +The files in this directory implement the SMPStaticAnalyzer IDA Pro +plugin for the NICECAP SMP project. + +NICECAP = National Intelligence Community Enterprise Computing +Assurance Program + +SMP = Software Memory Protection + +1) BUILDING THE STATIC ANALYZER PLUGIN + +The variable IDAROOT in file "makefile" will need to be edited to suit +your IDA Pro installation. $IDAROOT should be the directory with +executables idal.exe, idaw.exe, and idag.exe. Often, though not +necessarily, this will be the location with subdirectory SDK +where the plugin development SDK is installed. + +The current value is $HOME/idastd, which matches the IDA Pro +installation on the user account "nicecap" as set up for common use by +SMP team members. + +The building of an IDA Pro plugin requires the SDK/include files. The +standard arrangement is to have an SDK/myplugins directory that holds +the Build.sh, makefile, plugin.script, and *.cpp +(e.g. SMPStaticAnalyzer.cpp) files. Thus, to build the plugin from +source, you would copy these files into the myplugins directory and +then type "Build.sh" there. The plugin builds and is copied into +$IDAROOT/plugins where it is automatically loaded by IDA Pro. + +2) RUNNING THE STATIC ANALYZER ON AN EXECUTABLE + +The file SMP-analyze.sh is invoked to run the plugin on an +executable. To analyze foo.exe, copy SMP-analyze.sh into whatever +directory you wish to work from, then type: + +SMP-analyze.sh foo.exe + +The resulting annotations will be found in "foo.annot" in the same +directory you worked from. + +NOTE: Currently, SMP is only targeted to x86/Linux. + +Clark Coleman +25-OCT-2007