UserObject

Description

At the top of the Unsniff food chain is the user object. This can be anything that is of great interest to the network analysis professional. You can write plugins to extract any type of user object from bserved traffic. Using the Unsniff Scripting API you can automate all aspects of user objects.

Some examples:

  • Save all images greater than 75K in size to a directory
  • Export all RTP audio conversations from a given SIP Phone to a directory

Properties

NameTypeAccessDescription
ID LongReadEach user object is assigned a unique ID by Unsniff
IIDStringReadThe GUID of the user object type. Each user object type must have a unique GUID. The GUID string is in registry format
NameStringReadThe user object full name.
TypeStringReadThe user object type. This is defined by the author of the user object type. Typically this type identifies the user object type. Examples: Image, HTML, RTP Media, File,etc
DescriptionStringRead/Write
PreferredFileNameStringRead/WriteSome Unsniff Plugins are very smart. They can figure out the most appropriate name for a user object based on the context in which it was created. For example: The preferred filename of a image transferred via HTML is that of the corresponding GET request. You can change this name if you want based on your analysis.
SenderAddressStringReadThe network address of the Sender of this User Object. This is a network name if this address has been resolved to a name
ReceiverAddressString ReadThe network address of the Receiver of this User Object. This is a network name if this address has been resolved to a name.
StreamIDLongReadIf this User Object was extracted from a stream. This contains the Stream ID. For user objects not associated with a stream -1 is returned
StreamSeekPosLongReadIf this User Object was extracted from a stream. This contains the Stream Seek Position. For user objects not associated with a stream -1 is returned
StreamDirectionStringReadIf this User Object was extracted from a stream. This contains the direction (“in” or “out”). For user objects not associated with a stream a null string is returned
LengthLongReadThe size in bytes of this user object.
HasErrorBooleanReadDoes this user object have an error. Typical errors are when user objects are not completed. You may want to check this property before proceeding to do too much with a given user object.
StateStringReadThe state of the user object.
CreateTimestampStringRead

Methods

NameParametersDescription
SaveToFileFileName (String)Save the user object to a file.
FileName: Can be a pathname or a relative filename
HasPatternPattern stringCheck if the pattern appears in the reconstructed user object
unsniff/objectref/userobj.txt · Last modified: 2014/09/11 23:23 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki