Boot CD Plugins

From SpybotWiki
Revision as of 16:54, 13 March 2009 by PepiMK (talk | contribs) (New page: Boot CD plugins are XML files that offer instructions on how to locate and insert specific applications into bootable CD images created by our Boot CD Creator. =appplugin= This is the roo...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Boot CD plugins are XML files that offer instructions on how to locate and insert specific applications into bootable CD images created by our Boot CD Creator.


This is the root node of any plugin file, no attributes required.


This part contains the generic information about the application.

   <displayname>Spybot - Search & Destroy</displayname>
   <purpose>Malware detection and removal.</purpose>


A short, simple name for the application for internal use. No spaces or special characters, keep it as simple as possible.


A nicer name that is used in places visible to the user.


A short explanation of the application.


A unique ID that identifies the application. Using the one the application uses for its Uninstall entry is a good decision usually.


Not yet implemented, this would control dependencies. If this application depends on another plugins one to be installed, adding a depency for that ones name would ensure consistency.


Files are either required or optional and specify single files, or, by using wildcards, groups of files.

   <optional>Default configuration.ini</optional>
   <optional group="Resident">SDHelper.dll</optional>
   <optional group="Resident">SDMain.exe</optional>
   <optional menuitem="Secure Shredder" group="Shredder">SDShred.exe</optional>
   <required menuitem="Spybot-S&D Update">SDUpdate.exe</required>

Each file can have a group attribute pointing to a filegroup for logical structuring, and a menuitem defining that a shortcut to it should be added to the menu.


File groups are just a tool for logical structuring of files. The can be used by applying a group attribute to files nodes.

    <filegroup id="Shredder">Secure Shredder as an external application.</filegroup>
    <filegroup id="Resident">Files for resident protection, useless on PE.</filegroup>


Changes that should be applied to the registry of the bootable CDs Operating System. Example:

   <value method="copy">HKEY_CURRENT_USER\Software\Safer Networking Limited\SpybotSnD\Language</value>
   <value method="set" type="string" data="[$DESTDIR]">HKEY_CURRENT_USER\Software\Safer Networking Limited\SpybotSnD\Path</value>


A registry value is the smallest unit that this deals with.


This entry controls where the item would be listed in a structured menu.



The name of the group this application should be listed under.


This group of nodes defines how the application should be detected. Every sub-node here has to be named detector to be recognized. An example:

   <detector type="regpath">HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\{B4092C6D-E886-4CB2-BA68-FE5A88D31DE6}_is1\InstallLocation</detector>
   <detector type="regpathbyfile">HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\{B4092C6D-E886-4CB2-BA68-FE5A88D31DE6}_is1\DisplayIcon</detector>
   <detector type="filesys">[$PROGRAMFILES]\Spybot - Search & Destroy\</detector>

There are three detector types available currently:


A registry path to a REG_SZ or REG_EXPAND_SZ that lists the installation path of the application.


Similar to regpath, except that the entry would contain a fully qualified filename, from which the path would be taken.


Locate th application through the filesystem. This supports path templates, with the exception that they are to be put into square brackets, as seen in the example.