jEEBus.SHIP

jEEBus.SHIP Changelog

Table of Contents

[3.0.1] - 2026-09-09

Fixed

  • Properly close and clean up connections with inactive websocket channels

[3.0.0] - 2026-09-02

Changed

  • Overhaul API
    • Introduce new configuration system:
      • Builder pattern with fluent methods
      • Reasonable default values
      • Value validation
      • Immutable config object
    • Deprecate ClientConnectedListener in favor of ConnectionHandler#clientConnected
    • Deprecate ShipConnectionInterface#requestAccessMethods as it happens automatically from now on
  • Close connection if remote SHIP nodes do not properly respond to AccessMethodRequests within 60 seconds
  • Run SHIP ConnectionDataPreparation on new connected remote clients by default
  • Drastically improve logging
  • Check for double connections at the TLS handshake and immediately cancel them if own SKI is greater
    • else, send out a WebSocket ping according to SHIP specification

Added

  • Overload Ship#openConnection:
    • to use InetSocketAddress and WSS path instead of address-strings
    • to return a CompletableFuture<ShipConnectionInterface> that that completes with a usable Interface or fails if the connection attempt was unsuccessful
    • to allow automatic authenication of expected SHIP ID and SKI
  • Introduce ShipService class to represent SHIP mDNS Services
  • Fully support brand, type and serial mDNS TXT-Record flags
  • Implement NetworkInterfaceScanner to refresh and recover server, mDNS service listeners and services according to changes in the available network interfaces.
  • Implement a fallback to add jmDNS scope IDs to IPv6 link-local addresses that lack network interface information
  • Analyze SKI field in remote certificates to prevent spoofing attacks

Removed

  • Discontinue the ship-cli subproject
  • Remove ShipNodeConfiguration in favor of ConfigBuilder
  • Remove property parsing from resources/config.properties

Fixed

  • Stop calling ConnectionHandler#serviceAdded when resolving the node’s own mDNS service
  • Fix trusted SKIs being stored statically
  • Stop announcing SHIP connections to users before they are ready and properly authenticated
  • Fix a NullPointerException when using auto accept mode

[2.3.0] - 2026-07-09

Changed

  • Deprecate ShipNodeConfiguration to be replaced with a ConfigBuilder in 3.0.0.
  • Deprecate several API members for renaming
  • Deprecate usage of IP-Address in the API

Added

  • Add CertificateStorage interface to allow custom storage implementations

Fixed

  • Update dependencies to fix vulnerabilities

[2.2.0] - 2026-04-08

First Open-Source Release under the EPL-2.0

Changed

  • Change project license to the Eclipse Public License 2.0 (EPL-2.0)
  • Overhaul SHIP Message Exchange (SME) State Machine
  • Overhaul certificate management
    • Improve Java KeyStore handling
    • Update KeyStore type to PKCS12
  • Improve logging for:
    • mDNS Service Discovery
    • Web Socket handling
    • Trust Levels of remote SHIP devices
    • Unsuccessfull SHIP client connections
  • Move example classes to demo subproject

Added

  • Use hardcoded values for brand, type and serial mDNS TXT-Record flags
  • Add option to publish SHIP mDNS services on all available network interfaces
  • Add clientOnly configuration option for debugging purposes

Fixed

  • Update dependencies to fix vulnerabilities
    • Drop guava dependency
  • Transmit the SHIP-ID in the AccessMethodsIdentification
  • Fix a bug where configured IP-Addresses were ignored causing the SHIP-Server being bound to all available addresses

[2.1.1] - 2024-08-06

First Open-Source Release under the AGPL

Fixed

  • Fix handling of messages split into multiple WebSocketFrames
  • Update dependencies to fix vulnerabilities

[2.1.0] - 2024-04-11

Changed

  • Consider established server connections before opening client connections to remote SHIP nodes
  • Streamline message logging

Added

  • Add option to configure the IP address of the network interface to be used for the SHIP node
  • Add a listener for the ConnectionDataExchange state of a SHIP connection

[2.0.0] - 2023-12-05

Changed

  • Enforce new package naming: org.openmuc.jeebus.ship

Added

  • Support for IPv6 addresses

Fixed

  • Resolve multiple javadoc issues
  • Fix possible ConcurrentModificationException on connection
  • Fix possible NullPointerException when adding trusted SKIs

[1.1.0] - 2023-07-28

Added

  • implement AMI state

Fixed

  • WebSocketHandler now notifies ConnectionHandler properly when closing a double connection
  • KeyManagement:
    • existing key store can be loaded
    • fix generating, storing and loading of keystore
    • fix asn1 encoding now using octet string instead of sequence
  • add SubjectKeyIdentifier to self-signed certificate
  • SME_PROT_H state: fix faulty parsing of messages in this state and add parsing for messageProtocolHandshakeError messages
  • replace polling for timers with ScheduledExecutors
  • CMI state is no longer skipped after reconnection

[1.0.0] - 2021-12-09

Initial release.

Added

  • implement SHIP v1.0.1
  • support secure TCP/IP connections using TLS/SSL Encryption (IETF RFC 5246) and WebSockets (IETF RFC 6455)
  • support Certificate-Based authentication
  • support non-blocking, asynchronous authentication process
  • support discovery of active nodes using mDNS (IETF RFC 6762) and DNS-Based Service Discovery (IETF RFC 676)