v0.4.0

ekzhang/borev0.4.0Apr 22, 2022by github-actions[bot]

AI Summary

This release marks a major milestone by distributing the CLI via prebuilt binaries, enabling instant installation without building from source. It also secures the server by using `tokio-util` codecs to prevent unbounded memory usage during malicious frame streaming.

Key Highlights

  • Prebuilt binaries distribution for easy installation
  • Memory security fix using tokio-util codecs
  • Fixed Windows cargo test issues
  • GitHub Actions CI/CD setup for releases

New Features

  • Prebuilt binaries distribution

Full Release Notes

This release of `bore` finally distributes the CLI via prebuilt binaries! If you scroll down to the "Assets" attached to the release, you can now download `bore` and install instantly it by just adding a single file to your PATH. No need to build from source using Rust (`cargo install`) anymore. Big thanks to @praveenperera for making this happen.

<img width="902" alt="image" src="https://user-images.githubusercontent.com/7550632/164807393-9a3872a3-733a-4112-8c98-a69d25c8f5d7.png">

This release also makes internal improvements, using the `tokio-util` codec library to avoid possibly unbounded memory usage if a malicious client were to stream arbitrarily long frames to the server.

## What's Changed
* Fix Windows cargo test by @BxOxSxS in https://github.com/ekzhang/bore/pull/35
* use framed codecs to avoid unbounded buffer by @cedric05 and @ekzhang in https://github.com/ekzhang/bore/pull/33
* GitHub actions CI/CD releases by @praveenperera in https://github.com/ekzhang/bore/pull/10

## New Contributors
* @BxOxSxS made their first contribution in https://github.com/ekzhang/bore/pull/35
* @cedric05 made their first contribution in https://github.com/ekzhang/bore/pull/33
* @praveenperera made their first contribution in https://github.com/ekzhang/bore/pull/10

**Full Changelog**: https://github.com/ekzhang/bore/compare/v0.3.0...v0.4.0