Skip to content

CHANGELOG.md

Latest commit

 

History

History
184 lines (140 loc) · 7.1 KB

CHANGELOG.md

File metadata and controls

184 lines (140 loc) · 7.1 KB

Changelog

All major changes to Constellation will be recorded here.

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

0.3.0 - 2018-02-08

Added

  • workdir command line and configuration option to set the directory in which files specified in other command-line arguments, as well as auto-generated files, will be placed.

  • TLS certificate auto-generation and mutual authentication using a whitelist, certificate authority, or trust-on-first-use model. See sample.conf for more information.

Changed

  • Node API: The from parameter to /send is now optional. If unset, the first public key listed in publickeys will be used.

  • Argon2id is now the default for password-based key locking.

Fixed

  • Sending to (and trying to encrypt for) your own public key will now fail more intuitively.

0.2.0 - 2017-11-06

Added

  • A dir storage engine which stores payloads as individual files in a folder, suitable for use with FUSE connectors. (Note that, if used with Quorum and a distributed file system, it should have strong read-after-create consistency to avoid unexpected behavior. In other words, after a file is created, other nodes should immediately be able to read it.)

    The dir storage engine uses Base32-encoded filenames to ensure compatibility with most file systems.

  • (Experimental) A sqlite storage engine. See related discussion at Consensys#37

  • (Experimental) A leveldb storage engine. See related discussion at Consensys#37

  • A non-persistent memory storage engine.

  • Ability to choose a storage engine in configs and on the command line:

    • --storage=bdb:path: bdb storage engine using the path folder.
    • --storage=dir:path: dir storage engine using the path folder.
    • --storage=leveldb:path: leveldb storage engine using the path folder.
    • --storage=memory: non-persistent memory storage engine.
    • --storage=sqlite:path: sqlite storage engine using the path folder.
    • --storage=path: Default storage engine (bdb) using the path folder.

  • The to field of Send requests may now be empty. When there are no recipients, the payload will be encrypted using a throwaway public key, and the encrypted payload will not be sent to any external nodes.

Changed

  • Node API:
    • /sendRaw is now /sendraw
    • /receiveRaw is now /receiveraw
    • The from and to headers for the /sendraw and /receiveraw endpoints are now c11n-from and c11n-to respectively.

0.1.0 - 2017-06-06

This release includes changes to the configuration file format. Backward compatibility is maintained, but we recommend users migrate to the new format as soon as it's convenient. Please see the Changed section below and sample.conf for more information.

Added

  • Ability to specify any configuration file parameter on the command line, e.g. --storage=data. If a configuration file is given as an argument, the command line options will override the options specified in the file. A configuration file is no longer necessary to launch constellation-node.

  • Ability to set an IPv4/IPv6 whitelist for simple access control using ipwhitelist.

  • Ability to specify -v [NUM] or -vv, -vvv to control verbosity level.

  • Ability to generate a key pair using --generatekeys, removing the need for a separate constellation-enclave-keygen binary.

  • Ability to define a number of public keys that will always be added to the recipient list for all transactions, e.g. for backup purposes, using alwayssendto.

  • Ability to output Constellation version and exit using --version.

  • Ability to specify a file containing passwords for the private keys given (if locked) with passwords. Each line contains a password for a key in the same sequence they were given in privatekeys. If a key is not locked, but others are, add a blank line for that key's entry in the passwords file.

  • Support for deleting payloads and addition of delete method for the private API. (Thanks to Conor Svensson.)

  • Addition of sendRaw and receiveRaw methods to the private API which forego base64-encoding and the associated overhead. (Thanks to Conor Svensson.)

  • scripts/db-list-keys.py for listing keys in a payload database, for aiding in troubleshooting.

  • build-linux-static.dockerfile for building binaries statically using musl inside an Alpine Linux container.

Changed

  • Most configuration options, e.g. the IPC socket path, are now optional, in anticipation of later adding runtime configuration ability. port must always be specified either in the configuration file or with --port.

  • Ability to specify multiple public/private key pairs using publickeys and privatekeys in the configuration file, or --publickeys and --privatekeys on the command line. (The ordering of the public and private keys must match.)

  • Some options have been renamed:

    • socketPath is now socket
    • otherNodeUrls is now othernodes
    • publicKeyPath is now publickeys (a list -- see previous)
    • privateKeyPath is now privatekeys (a list -- see previous)
    • storagePath is now storage
    • ipWhitelist is now ipwhitelist

    Constellation remains backwards compatible with configuration files using the old naming conventions, however the new and old naming should not be mixed, and we recommend switching to the new naming as soon as possible.

    If you were previously making use of archival keys, we suggest putting the public/private archival keys in publickeys and privatekeys respectively, then adding the archival public key to alwayssendto, which will emulate the same behavior. (Note, however, that this key will be advertised as available on this node to the rest of the network.)

    If you're using Constellation with Quorum 1.1.0 or earlier and pointing to the new configuration file in PRIVATE_CONFIG, add socketPath and publicKeyPath to the bottom of the file in order for geth to load properly, then remove those options after upgrading to a later release.

Deprecated

  • The camel case configuration options socketPath, otherNodeUrls, publicKeyPath, privateKeyPath, storagePath, ipWhitelist archivalPrivateKeyPath and archivalPublicKeyPath. (please see Changed section above for details.)

Fixed

  • Any newlines will be ignored in key files.

  • Nodes now attempt to synchronize with each other more aggressively in the first few minutes after startup, which should address issues with "Unknown recipient" errors shortly after startup.

0.0.1 - 2016-11-14

Added

  • Initial Constellation release.