Difference between revisions of "AFF Development Task List"

From Forensics Wiki
Jump to: navigation, search
(High Priority)
(Added more bugs)
Line 22: Line 22:
  
 
* How about renaming the library to libaff? That would allow developers to link with <tt>-laff</tt> instead of <tt>-lafflib</tt>. To my knowledge, there is no existing library named AFF already.
 
* How about renaming the library to libaff? That would allow developers to link with <tt>-laff</tt> instead of <tt>-lafflib</tt>. To my knowledge, there is no existing library named AFF already.
 +
 +
* Is there a set of segment names that must be defined to have a ''valid'' AFF file?
 +
 +
* Document that <tt>af_open</tt> (when writing a file) does more than a standard <tt>fopen</tt> command. The command writes an AFF stub of some kind to the output file. Users should be cautioned not to use this function as a test, lest they overwrite data.
 +
 +
* Does <tt>af_open</tt> refuse to open a file for writing if it already exists? If so, what kind of error does it return?
 +
 +
* Document how to programmatically enumerate all segments and values in a file. That is, explain how to get the output of <tt>$ afinfo -a</tt>.
  
 
== Low Priority ==
 
== Low Priority ==

Revision as of 13:22, 24 July 2007

High Priority

  • Create man pages and/or documentation for AFF toolkit. To wit:
* aimage
* ident
* afcat
* afcompare
* afconvert
* affix
* affuse
* afinfo
* afstats
* afxml
* afsegment
  • Create man pages and/or documentation for AFF library functions (e.g. ,af_open, af_get_imagesize)
  • Build library as a shared library using libtool. This will allow developers using the library to just link to the AFF. Without it, developers must link to the static library and the individual libraries necessary on that machine. There is no good way to determine those extra libraries.

Medium Priority

  • How about renaming the library to libaff? That would allow developers to link with -laff instead of -lafflib. To my knowledge, there is no existing library named AFF already.
  • Is there a set of segment names that must be defined to have a valid AFF file?
  • Document that af_open (when writing a file) does more than a standard fopen command. The command writes an AFF stub of some kind to the output file. Users should be cautioned not to use this function as a test, lest they overwrite data.
  • Does af_open refuse to open a file for writing if it already exists? If so, what kind of error does it return?
  • Document how to programmatically enumerate all segments and values in a file. That is, explain how to get the output of $ afinfo -a.

Low Priority

  • Add library function to open standard input. Perhaps:
AFFILE * af_open_stdin(void);