Skip to content

Latest commit

 

History

History
401 lines (346 loc) · 20.2 KB

CHANGELOG.md

File metadata and controls

401 lines (346 loc) · 20.2 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

TODO for 0.5.0

  • Metadata: BW/Latency/Geo/Notes!

  • API do drop current path or even use most diverse one. -> To be called if application detects interruption (but no SCMP errors arrive?) -> Do not drop, but move to end of list (or attach time for retry (in 10secs or so). They may become valid/valuable again. Especially if the problem is actually the remote server and not the path itself.

Post-0.5.0

TODO

** BREAKING CHANGES **

  • Minor: Some methods have throw IOException removed from their declaration. For example: Path.getFirstHopAddress(), DatagramChannel.setPathPolicy()
  • Medium: PathPolicy.filter(...) now returns List<Path> instead of Path.

Added

  • Added Path construction tests for tiny4. #146
  • Added experimental support for STUN / NAT traversal. This also reduces network calls by starting SHIM w/o service. #142
  • Added LICENCE file to packaged jar. #152
  • Added keep-alive protocol for NAT. #151
  • Added implementation of STUN responder (currently not needed) #154
  • Path policies PplPolicy and PplPolicyGroup created from Path Policy Language #158
  • Path policies JSON import export #170

Changed

  • Cleaned up test topologies. #145
  • Changed checkstyle rules. #153
  • BREAKING CHANGE PathPolicy.filter(..) to return a List of paths. #159
  • Policy filters should not need to throw Exceptions when the path list is empty. #160
  • PplPolicy refactoring #169
    • renamed PplPolicy to PplSubPolicy
    • renamed PplPolicyGroup to PplPolicy
    • renamed "group" to "destinations"
    • added requirements: minMtu, minValidity, minBandwidth
    • added ordering: hops_asc, hops_desc, meta_latency_asc, meta_bandwidth_desc

Fixed

  • SHIM should not crash when receiving unparseable packet (e.g. dstPort = -1). Also, SHIM should parse SCMP error packets correctly. Cleaned up test topologies. #148
  • Fixed disabled SHIM tests and general test cleanup.
    #149
  • Fixed parsing of /etc/hosts #150
  • Fixed warning when dnsjava parses /etc/hosts with SCION adresses #155
  • Cleanup: TestUtil class for string output and sleep() #156
  • Stop contacting daemon of every received packet #157
  • Fixed troubleshooting documentation for slf4j #161, #162
  • Fixed Android problems with grpc-netty-shaded jar. #165
  • Stabilized some NAT unit tests that kept failing on MacOS #166
  • Fixed missing expiration time for Segments from control server #171

0.4.1 - 2024-11-22

Fixed

  • No path constructed for single UP segment in case there is only a single core AS. #144

Changed

  • Post 0.4.0 release updates. #143
  • Pre 0.4.1 release updates. #147

0.4.0 - 2024-11-19

BREAKING CHANGE

  • The SHIM now occupies port 30041. This means any application trying to use that port will fail.
    • Solution #1: Just use any other port instead, the SHIM will forward traffic to it.
    • Solution #2: Disable the SHIM with org.scion.shim = false or SCION_SHIM = false.

Added

  • Add a SHIM, required for #130 (topo file port range support). #131
  • ManagedThread unit test helper. #136
  • Support for dispatched_ports in topo files. Deprecated configureRemoteDispatcher(). #130
  • Bootstrapping: use reverse domain lookup to find NAPTR records. #138

Changed

  • Buildified PingPong test helper. #132
  • Server to use BR addresses instead of received addresses. #133
  • MockNetwork should use topofiles. #134
  • MockNetwork should really use topofiles. #135

Fixed

  • Do not start SHIM if dispatcher port range is ALL #139
  • Cleanup and fixed SHIM tests and other tests #140
  • Cleanup in AbstractDatagramChannel #137
    • buildHeader()
    • undeprecate SCION_TRAFFIC_CLASS
    • Cleanup Selector.open() usages
    • Caching for getExternalIP()
    • ShowpathsDemo output
    • Spurious failures of SCMP exception handling tests

Removed

  • Removed deprecated code, e.g. ScmpChannel and public ScionAddress #141

0.3.1 - 2024-10-11

Added

  • Better troubleshooting for connection problems. #127
  • Auto-add port to discovery server setting + better error message. #128

Fixed

  • Do not immediately fail if discovery server is missing in topo file. #126

0.3.0 - 2024-10-09

Added

  • Support for bootstrapper TRC metadata. #110
  • Added copy(...) method for paths. #111
  • Added Scenario builder for unit tests. #112
  • Path construction fixes: #104
    • Support shortcut and on-path detection during path construction
    • Path lists are ordered by hop count
    • Path lists contain no duplicates
    • Fixed MTU calculations for link level MTU
    • Fixed some issues with IPv6 ASes
    • New option EXPERIMENTAL_SCION_RESOLVER_MINIMIZE_REQUESTS
  • "Integration" test for scionproto "default". #114
  • Improved path duplication filtering. #117
  • Added environment variable / property for DNS search domain. #118
  • New SCMP API: #119
    • separate ScmpSender/ScmpResponder
    • non-blocking ScmpSenderAsync
    • deprecated old ScmpChannel

Changed

  • Clean up TODO and deprecation info. #100
  • Separate topo file parser #103
  • BREAKING CHANGE: Changed argument and return type of setScmpErrorListener() in ScionDatagramChannel and ScmpChannel to Scmp.ErrorMessage. #124
  • 0.3.0 preparation. #122
    • Updated dependencies to latest versions

Fixed

  • Remove use of 0.0.0.0 and "::". #103
  • Remove use of getHostName() in ScionAddress. #106
  • SocketConcurrency test takes too long. #108
  • Fixed useless error message when providing incorrect daemon address. Also: made port optional (default = 30255) #114
  • Fixed SCMP packet loss on SCMP receive #120
  • Fixed problem, with parsing IPv6 addresses in topo files 123

Removed

  • Removed some useless IP printing functions. #105
  • 0.3.0 preparation. #122
    • Removed deprecated code

0.2.0 - 2024-06-24

Added

  • SCMP echo responder #78
  • Maven Java executor #80
  • Dev environment setup hints doc #82
  • Added SCION_GETTING_STARTED.md #59

Changed

  • Some API changes: #67
    • Rename DatagramChannel to ScionDatagramChannel
    • Rename DatagramSocket to ScionDatagramSopcketl and move it to main package
    • Rename ScionSocketOptions starting with SN_ to SCION_
  • SCMP API changes. #71
  • BREAKING CHANGE: DatagramChannel.receive() returns a subclass of InetSocketAddress #86
  • Internal cleanup. #88
  • Deprecated getPaths(InetSocketAddress) because it wasn't clear that it did a SCION lookup. #89
  • BREAKING CHANGE: ScionDatagramChannel.send(buffer, path) returns int. #92
  • BREAKING CHANGE: Path metadata has been moved to PathMetadata. #93
  • BREAKING CHANGE: receive() returns ScionSocketAddress; ResponseAddress and ResponsePath are removed from from public API. #94
  • BREAKING CHANGE: removed RequestPath and ScionAddress from public API. #95
  • Better error message for SCMP echo in local AS #96

Fixed

  • Fixed locking and resizing of buffers. #68
  • Fixed unhelpful error & log message when with topo file has wrong permissions. #74
  • Topology file parser support for new "local" attribute. #72
  • Fixed path lookup error when destination isn't reachable. #70
  • Fixed internal raw path parsing and IP parsing. #77
  • Improved bootstrap logging #83
  • Fixed SCMP meta data reporting wrong remote port. #79

0.1.1 - 2024-05-10

Fixed

  • Fixed spurious CI failures, esp. Windows. #61
  • Fix SCM references in pom file + clean up. #60
  • DNS lookup caused by InetAddress.getByName(). #63
  • DNS lookup caused by InetAddress.getHostName(). #64
  • JPAN renaming cleanup. #65
  • Clean up PingPong framework + spurious CI failures. #62
  • Missing tests for "decimal:decimal" style ISD/AS codes. #66

0.1.0 - 2024-04-29

Added

  • Code coverage. #11
  • Global JUnit callback for initial setup. THis allows setting global properties before centrally before running any tests. #38
  • Support for /etc/scion/hosts and for OS search domains (e.g. /etc/resolv.conf). #40
  • CI builds for Windows and MacOS. #41
  • Added support communicating with a dispatcher-endhost in the local AS, see DatagramChannel.configureRemoteDispatcher. #46
  • Support for comments, multiple spaces and tabs in /etc/scion/hosts. #47
  • Added helper methods for ScmpChannel and ScionUtil.toStringPath(). #48,
  • Demo cleanup an new ScmpShowpathsDemo. #49
  • Channel demo cleanup. #52
  • Address/ISD/AS caching. #54
  • DatagramSocket #31
  • setOverrideSourceAddress() #58

Changed

  • BREAKING CHANGE: Changed maven artifactId to "client" #9
  • BREAKING CHANGE: SCMP refactoring, renamed several SCMP related classes. #14, #15, #17, #19, #20
  • BREAKING CHANGE:ScionService instances created via Scion.newXYZ will not be considered by Scion.defaultService(). Also, DatagramChannel.getService() does not create a service if none exists. #18
  • Doc cleanup #22
  • BREAKING CHANGE: getCurrentPath() renamed to getConnectionPath() #30
  • Cleaned up MultiMap utility class #34
  • Cleaned up DatagramChannel: Fixed connect()/disconnect(), improved concurrency, fixed buffer resizing wrt MTU, general clean up. #35
  • BREAKING CHANGE: Renamed project to jpan. #43, #45
  • BREAKING CHANGE: Path now returns InetAddress instead of byte[] #44
  • BREAKING CHANGE: Changed Path API: destination->remote and source->local #55

Fixed

  • Fixed: SCMP problem when pinging local AS. #16,
  • Fixed SCMP timeout and error handling (IOExceptions + SCMP errors). #13
  • CI (only) failures on JDK 8. #10
  • Sporadic CI (only) failures. #12
  • Small fixes for 0.1.0 release. #32
  • Fix NPE after 2nd send() in unconnected channel + cleanup. #33
  • Fixed traffic class not set. #36
  • Fixed handling of channel options. #37
  • Merged SCION_DAEMON_HOST and SCION_DAEMON_PORT into a single SCION_DAEMON property. #39
  • Some cleanup on to hosts file parser. #42
  • Added proper error when ports 30255 or 31000 are in use when running tests #50
  • Fix Unsupported platform: protoc-3.11.4-osx-aarch_64.exe. #53
  • Fixed spurious CI failure and SimpleCache packet name. #55

Removed

  • Removed all code related to DatagramSockets #21

0.1.0-ALPHA - 2024-02-01

Added

  • DatagramSocket #7
  • Path, RequestPath, ResponsePath #7
  • Scion, ScionService #7
  • ScmpChannel for SCMP #7

Changed

  • Nothing

Fixed

  • Nothing

Removed

  • Nothing