The CyberGhost Plugin Interface offers 3rd Party developers to extend CyberGhost with additional functionality. The Plugin Interface is supported for the following platforms at the moment:
- CyberGhost 5 Windows Client Version >22.214.171.124
How does a plugin work?
Basically a plugin is made by an configuration file and an optionally an executable file. The configuration file will define the commands, which will be executed by the CyberGhost 5 client depending on the event. The file MUST be a ZIP compressed archive and MUST have the extension ".cgp".
The archive MUST contain at least a file "plugin.ini", which will contain necessary configuration options for the plugin. The archive CAN contain an executable which SHOULD be digitally signed. Non-signed executables will result in a warning message upon installation of the plugin.
The plugin.ini MUST contain the following 2 sections:
[INFO] name=Name of the plugin author=Author of the plugin website=Website with support/information about the plugin description=Short description about the plugin's functionality
configurecommand=Shell command to be executed, to optionally configure this plugin, if it contains an attached executable file
[COMMAND_0] event=Event type command=Path to executable file result_type=EXITCODE|DELAY result_value=Command Exit Code | Delay in seconds
Additional commands can be added by adding sections like [COMMAND_1] etc.
The following event types can be linked with a command:
|BEFORE_CONNECT||Will be fired before an VPN connection will be established|
|AFTER_CONNECT||Will be fired after a VPN connection has succesfully been established|
|BEFORE_DISCONNECT||Will be fired before a VPN connection got disconnected|
|AFTER_DISCONNECT||Will be fired after a VPN connection has been disconnected|
In order to specify wether CyberGhost should wait for the command to return or wait a fixed time before continuing the action, there are several additional configuration options
|EXITCODE||Command Exit Code||Will wait for the command/application to be terminated with the specified exit code|
|DELAY||Value||Will wait for Value seconds before proceeding|
If the plugin archive contains an executable file, which is used for the command, the command must use the %PLUGINDIR% placeholder:
name=Starts Browser in privacy mode
description=This will start the configured Browser in Privacy Mode.
If started with "/configure" it will open a configuration dialog, to specify the browser type and choose the path of the executable browser file.
Distribute your plugin
You can offer your plugin on your homepage or give us a notice via firstname.lastname@example.org to put it in our Plugin Repository, where CyberGhost users can download it for free.