Skip to content

Commit

Permalink
update RELEASE.md SECURITY.md
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Baentsch <[email protected]>
  • Loading branch information
baentsch committed Jun 9, 2024
1 parent bc006d0 commit cad0016
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 7 deletions.
6 changes: 4 additions & 2 deletions .github/workflows/linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,12 @@ jobs:
image: openquantumsafe/ci-ubuntu-jammy:latest
env:
MAKE_PARAMS: "-j 18"
LIBOQS_BRANCH="0.10.1"
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Full build
run: OQSPROV_CMAKE_PARAMS=${{ matrix.cmake-params}} LIBOQS_BRANCH=0.10.1 ../scripts/fullbuild.sh
run: OQSPROV_CMAKE_PARAMS=${{ matrix.cmake-params}} ../scripts/fullbuild.sh
- name: Enable sibling oqsprovider for testing
run: cd _build/lib && ln -s oqsprovider.so oqsprovider2.so
- name: Test
Expand All @@ -49,11 +50,12 @@ jobs:
image: ${{ matrix.container }}
env:
MAKE_PARAMS: "-j 18"
LIBOQS_BRANCH="0.10.1"
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Full build
run: OPENSSL_BRANCH=${{ matrix.ossl-branch }} LIBOQS_BRANCH=0.10.1 ./scripts/fullbuild.sh
run: OPENSSL_BRANCH=${{ matrix.ossl-branch }} ./scripts/fullbuild.sh
- name: Enable sibling oqsprovider for testing
run: cd _build/lib && ln -s oqsprovider.so oqsprovider2.so
- name: Test
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/standalone.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
- name: Checkout code
uses: actions/checkout@v2
- name: Full build
run: ./scripts/fullbuild.sh
run: LIBOQS_BRANCH=0.10.1 ./scripts/fullbuild.sh
- name: Test
run: ./scripts/runtests.sh -V

50 changes: 47 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,50 @@
# oqs-provider 0.6.1

## About

The **Open Quantum Safe (OQS) project** has the goal of developing and prototyping quantum-resistant cryptography. More information on OQS can be found on our website: https://openquantumsafe.org/ and on Github at https://github.com/open-quantum-safe/.

**oqs-provider** is a standalone [OpenSSL 3](https://github.com/openssl/openssl) [provider](https://www.openssl.org/docs/manmaster/man7/provider.html) enabling [liboqs](https://github.com/open-quantum-safe/liboqs)-based quantum-safe and [hybrid key exchange](https://datatracker.ietf.org/doc/draft-ietf-pquip-pqt-hybrid-terminology) for TLS 1.3, as well as quantum-safe and hybrid X.509 certificate generation, CMS, CMP and `dgst` (signature) operations.

When deployed, the `oqs-provider` binary (shared library) thus adds support for quantum-safe cryptographic operations to any standard OpenSSL(v3) installation. The ultimate goal is that all `openssl` functionality shall be [PQC-enabled](https://csrc.nist.gov/projects/post-quantum-cryptography).

In general, the oqs-provider `main` branch is meant to be usable in conjunction with the `main` branch of [liboqs](https://github.com/open-quantum-safe/liboqs) and the `master` branch of [OpenSSL](https://github.com/openssl/openssl).

Further details on building, testing and use can be found in [README.md](https://github.com/open-quantum-safe/oqs-provider/blob/main/README.md). See in particular limitations on intended use.

## Release notes

This is version 0.6.1 of oqs-provider.

Most important updates are fixed references to a security update to `liboqs`, fixes of potential buffer overrun errors in hybrid key decoding, adding of composite OID setting logic and several documentation updates.

### Security considerations

This fixes potential buffer overrun problems in hybrid key decoding. Use of prior versions is strongly discouraged.

## What's Changed
* reverting to dev mode [skip ci] by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/394
* add caveat regarding OpenSSL installs [skip ci] by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/402
* cpack x64 CI fix by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/401
* Add PKCS#12 test by @iyanmv in https://github.com/open-quantum-safe/oqs-provider/pull/400
* Fix CI (Add Ubuntu 24 support) by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/410
* Bump jinja2 from 3.1.3 to 3.1.4 in /oqs-template by @dependabot in https://github.com/open-quantum-safe/oqs-provider/pull/409
* Extra parentheses removed by @bencemali in https://github.com/open-quantum-safe/oqs-provider/pull/405
* No unwanted error left in queue from OBJ_create by @bencemali in https://github.com/open-quantum-safe/oqs-provider/pull/404
* update security issue reporting [skip ci] by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/414
* DECODE_UINT32 without lengths checked fixed by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/416
* add composite OIDs to getenv logic by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/419
* Switch to https for git access by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/423
* STANDARDS.md update by @baentsch in https://github.com/open-quantum-safe/oqs-provider/pull/420

## New Contributors
* @iyanmv made their first contribution in https://github.com/open-quantum-safe/oqs-provider/pull/400

**Full Changelog**: https://github.com/open-quantum-safe/oqs-provider/compare/0.6.0...0.6.1-rc1

Previous Release Notes
======================

# oqs-provider 0.6.0

## About
Expand Down Expand Up @@ -87,9 +134,6 @@ This release also makes available ready-to-run binaries for Windows (.dll) and M

**Full Changelog**: https://github.com/open-quantum-safe/oqs-provider/compare/0.5.3...0.6.0

Previous Release Notes
======================

# oqs-provider 0.5.3

This is a maintenance release not changing any `oqsprovider` functionality but only tracking a security update in `liboqs` (0.9.2).
Expand Down
3 changes: 2 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ We only support the most recent release.

| Version | Supported |
| ------- | ------------------ |
| 0.6.0 | :white_check_mark: |
| 0.6.1 | :white_check_mark: |
| 0.6.0 | :x: |
| 0.5.3 | :x: |
| 0.5.2 | :x: |
| 0.5.1 | :x: |
Expand Down

0 comments on commit cad0016

Please sign in to comment.