Skip to content

Tuoni Plugin SDK version changelog

Tuoni Plugin SDK is available from Maven Central. It is recommended to always use the latest version of the SDK and to keep an eye on the changes reported on this page.

Plugin SDK versions will follow Tuoni versions, but SDK release may be skipped when there are no changes on the SDK side. Most of the time, the Plugin SDK version will be release ahead of the Tuoni release.

SDK Versions

0.4.2

Released only for internal use.

0.5.0 (2024-06-14)

🎉 First public release of Tuoni Plugin SDK 🎉

0.6.0 (2024-10-02)

New methods:

  • AgentMetadata - add ansiCodePage()
  • AgentMetadata.Builder - add ansiCodePage(Integer)
  • AgentInfo - add getType()

Type changes:

The following interfaces are moved to new location (previous location is still present, but deprecated):

  • AgentInfo - moves to com.shelldot.tuoni.plugin.sdk.common package
  • ListenerInfo - moves to com.shelldot.tuoni.plugin.sdk.common package
  • AgentType - moves to com.shelldot.tuoni.plugin.sdk.common package

Deprecations:

The following methods are now marked as deprecated and replaced with renamed methods.
Deprecated methods will be removed in future versions.

  • AgentMetadata#os_major() - use osMajor() instead
  • AgentMetadata#os_minor() - use osMinor() instead
  • AgentMetadata.Builder#os_major(Byte) - use osMajor(Byte) instead
  • AgentMetadata.Builder#os_minor(Byte) - use osMinor(Byte) instead

0.7.0 (2024-11-14)

New functionality:

Add PluginDataStore interface to allow plugins to store and retrieve key-value entries to the database. Each plugin has its own separate data store which only it can access.
Data Store supports storing and retrieving the following types: String, Long, Double, byte[], UUID.

The PluginDataStore is available through the PayloadPluginContext, ListenerPluginContext, and CommandPluginContext interfaces.

Type changes:

  • ShellcodeListener - implementations must now implement a new method getSupportedPayloadTypes() which must return a list of payload types the listener supports.
    This is necessary for server to understand whether a payload can be used with a listener or not.

New types:

  • PluginDataStore - provides functionality to store and retrieve key-value entries to/from the database.
  • PluginDataEntry - represents a key-value entry in the database.
  • DataStoreException - thrown when an error occurs while accessing the data store.

New methods:

  • PayloadInfo - add getStatus() method to get the status for payloads.
  • ListenerInfo - add getSupportedPayloadTypes() and supportsPayloadType(PayloadType) methods to get the supported payload types for listeners.
  • ListenerPluginContext - add getPluginDataStore() method.
  • PayloadPluginContext - add getPluginDataStore() method.
  • CommandPluginContext - add getPluginDataStore() method.

0.8.0 (2025-02-14)

New functionality:

Add DiscoveredDataManager to allow plugins to store and retrieve discovered data to the database. Types of discovered data are:

  • DiscoveredHost - information about a host IP address or hostname
  • DiscoveredService - information about a service running on a port on a host
  • DiscoveredCredential - information about a credential (username, password) for a host or realm

The DiscoveredDataManager is available through the PayloadPluginContext, ListenerPluginContext, and CommandPluginContext interfaces.

New types:

  • Page - represents a page of data with items
  • Pageable - for requesting a page of data
  • Sort - for defining sorting of pageable data.
  • DiscoveredDataManager - see above for details.
  • DiscoveredHost - see above for details.
  • DiscoveredService - see above for details.
  • DiscoveredCredential - see above for details.

New methods:

  • AgentMetadata - add methods integrity(), agentType(), agentVersion(), features(), payloadId()
  • AgentMetadata.Builder - add methods integrity(String), agentType(String), agentVersion(Integer), features(List<String>), payloadId(Long)

Removals:

  • Removed type AgentInfo (deprecated in 0.6.0, moved to com.shelldot.tuoni.plugin.sdk.common package)
  • Removed type ListenerInfo (deprecated in 0.6.0, moved to com.shelldot.tuoni.plugin.sdk.common package)
  • Removed type AgentType (deprecated in 0.6.0, moved to com.shelldot.tuoni.plugin.sdk.common package)
  • Removed method AgentMetadata#os_major() (deprecated in 0.6.0)
  • Removed method AgentMetadata#os_minor() (deprecated in 0.6.0)
  • Removed method AgentMetadata.Builder#os_major(Byte) (deprecated in 0.6.0)
  • Removed method AgentMetadata.Builder#os_minor(Byte) (deprecated in 0.6.0)

Deprecations:

The following methods are now marked as deprecated. Deprecated methods will be removed in future versions.

  • FilePart#getUniqueId() - use FilePart#getFileId() instead
  • FileResource#getRelativePath() - use FileResource#getUrlPath() instead
  • FileStorage#getFile(Path) - use FileStorage#getFile(String) instead
  • CommandResultEditor#addAllFrom(CommandResultCollection) - use individual set methods instead