Skip to content

Commit

Permalink
Version 0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
vsoftco committed Nov 28, 2020
1 parent b34d127 commit cc1b1d6
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 16 deletions.
3 changes: 1 addition & 2 deletions .travis/install_liboqs.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
#!/bin/sh

git clone --branch main --single-branch --depth 1 https://github.com/open-quantum-safe/liboqs.git
git clone --branch main --single-branch --depth 1 https://github.com/open-quantum-safe/liboqs
cd liboqs
git checkout master
mkdir build && cd build
cmake -GNinja -DBUILD_SHARED_LIBS=ON -DOQS_BUILD_ONLY_LIB=ON ..
ninja
Expand Down
4 changes: 4 additions & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Version 0.4.0 - November 28, 2020
- Bugfixes
- Renamed 'master' branch to 'main'

Version 0.3.0 - June 10, 2020
- Full Windows support and AppVeyor continuous integration
- Disabled unit testing for McEliece and Rainbow-IIIc/Vc under Windows
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
liboqs-go: Go bindings for liboqs
=================================

[![Build status - Linux/macOS](https://api.travis-ci.com/open-quantum-safe/liboqs-go.svg?branch=master)](https://travis-ci.com/open-quantum-safe/liboqs-go)
[![Build status - Linux/macOS](https://api.travis-ci.com/open-quantum-safe/liboqs-go.svg?branch=main)](https://travis-ci.com/open-quantum-safe/liboqs-go)
[![Build status](https://ci.appveyor.com/api/projects/status/x4d2quphnr1c2emf?svg=true)](https://ci.appveyor.com/project/vsoftco/liboqs-go)
[![Go Report Card](https://goreportcard.com/badge/github.com/open-quantum-safe/liboqs-go)](https://goreportcard.com/report/github.com/open-quantum-safe/liboqs-go)
[![Documentation](https://godoc.org/github.com/open-quantum-safe/liboqs-go/oqs?status.svg)](https://pkg.go.dev/github.com/open-quantum-safe/liboqs-go/oqs)
Expand Down Expand Up @@ -37,7 +37,7 @@ liboqs-go is a Go package. The project contains the following files and director
<a name="usage"></a>Usage
----

The examples in the [`examples`](https://github.com/open-quantum-safe/liboqs-go/tree/master/examples) directory are self-explanatory and provide more details about the wrapper's API.
The examples in the [`examples`](https://github.com/open-quantum-safe/liboqs-go/tree/main/examples) directory are self-explanatory and provide more details about the wrapper's API.

<a name="posix"></a>Running/building on POSIX (Linux/UNIX-like) platforms
----
Expand All @@ -55,7 +55,7 @@ Download/clone the `liboqs-go` wrapper repository in the directory of your choic

cd $HOME && git clone https://github.com/open-quantum-safe/liboqs-go

Next, you must modify the following lines in [`$HOME/liboqs-go/.config/liboqs.pc`](https://github.com/open-quantum-safe/liboqs-go/tree/master/.config/liboqs.pc)
Next, you must modify the following lines in [`$HOME/liboqs-go/.config/liboqs.pc`](https://github.com/open-quantum-safe/liboqs-go/tree/main/.config/liboqs.pc)

LIBOQS_INCLUDE_DIR=/usr/local/include
LIBOQS_LIB_DIR=/usr/local/lib
Expand Down Expand Up @@ -105,7 +105,7 @@ To simplify the instructions to follow, export the path to the wrapper in the `L

In my case `LIBOQSGO_INSTALL_PATH` is set to `$HOME/go/src/github.com/open-quantum-safe/liboqs-go`.

Next, you must modify the following lines in [`$LIBOQSGO_INSTALL_PATH/.config/liboqs.pc`](https://github.com/open-quantum-safe/liboqs-go/tree/master/.config/liboqs.pc)
Next, you must modify the following lines in [`$LIBOQSGO_INSTALL_PATH/.config/liboqs.pc`](https://github.com/open-quantum-safe/liboqs-go/tree/main/.config/liboqs.pc)

LIBOQS_INCLUDE_DIR=/usr/local/include
LIBOQS_LIB_DIR=/usr/local/lib
Expand Down Expand Up @@ -149,7 +149,7 @@ As mentioned in the [Pre-requisites](#pre-requisites) section, we assume you hav

> gcc (Rev3, Built by MSYS2 project) 9.1.0
Next, similarly to the [POSIX instructions](#modules), modify the corresponding lines in [`liboqs-go\.config\liboqs.pc`](https://github.com/open-quantum-safe/liboqs-go/tree/master/.config/liboqs.pc) to point to the correct locations, **using forward slashes `/` and not back-slashes**, e.g.
Next, similarly to the [POSIX instructions](#modules), modify the corresponding lines in [`liboqs-go\.config\liboqs.pc`](https://github.com/open-quantum-safe/liboqs-go/tree/main/.config/liboqs.pc) to point to the correct locations, **using forward slashes `/` and not back-slashes**, e.g.

LIBOQS_INCLUDE_DIR=C:/some/dir/liboqs/build/include
LIBOQS_LIB_DIR=C:/some/dir/liboqs/build/lib
Expand All @@ -171,7 +171,7 @@ and/or

go test -v .\oqstests

If you do not get any errors and the example (unit tests) is (are) successfully run, then your installation was successful. For more details about command-line configuration under Windows see the AppVeyor CI configuration file [`appveyor.yml`](https://github.com/open-quantum-safe/liboqs-go/tree/master/appveyor.yml).
If you do not get any errors and the example (unit tests) is (are) successfully run, then your installation was successful. For more details about command-line configuration under Windows see the AppVeyor CI configuration file [`appveyor.yml`](https://github.com/open-quantum-safe/liboqs-go/tree/main/appveyor.yml).

<a name="documentation"></a>Documentation
----
Expand All @@ -196,9 +196,9 @@ if using Go modules, or

if not using Go modules.

For [GoDoc](https://godoc.org) automatically-generated documentation in HTML format, click [here](https://godoc.org/github.com/open-quantum-safe/liboqs-go/oqs).
For automatically-generated documentation in HTML format, click [here](https://pkg.go.dev/github.com/open-quantum-safe/liboqs-go/oqs).

For the RNG-related documentation, click [here](https://godoc.org/github.com/open-quantum-safe/liboqs-go/oqs/rand).
For the RNG-related documentation, click [here](https://pkg.go.dev/github.com/open-quantum-safe/liboqs-go/oqs/rand).

<a name="limitations"></a>Limitations and security
----
Expand All @@ -209,12 +209,12 @@ We believe that the NIST Post-Quantum Cryptography standardization project is cu

We acknowledge that some parties may want to begin deploying post-quantum cryptography prior to the conclusion of the NIST standardization project. We strongly recommend that any attempts to do make use of so-called **hybrid cryptography**, in which post-quantum public-key algorithms are used alongside traditional public key algorithms (like RSA or elliptic curves) so that the solution is at least no less secure than existing traditional cryptography.

Just like liboqs, liboqs-go is provided "as is", without warranty of any kind. See [LICENSE](https://github.com/open-quantum-safe/liboqs-go/blob/master/LICENSE) for the full disclaimer.
Just like liboqs, liboqs-go is provided "as is", without warranty of any kind. See [LICENSE](https://github.com/open-quantum-safe/liboqs-go/blob/main/LICENSE) for the full disclaimer.

License
-------

liboqs-go is licensed under the MIT License; see [LICENSE](https://github.com/open-quantum-safe/liboqs-go/blob/master/LICENSE) for details.
liboqs-go is licensed under the MIT License; see [LICENSE](https://github.com/open-quantum-safe/liboqs-go/blob/main/LICENSE) for details.

Team
----
Expand Down
8 changes: 4 additions & 4 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
liboqs-go version 0.3.0
liboqs-go version 0.4.0
=======================

About
Expand All @@ -8,14 +8,14 @@ The **Open Quantum Safe (OQS) project** has the goal of developing and prototypi

**liboqs** is an open source C library for quantum-resistant cryptographic algorithms. See more about liboqs at [https://github.com/open-quantum-safe/liboqs/](https://github.com/open-quantum-safe/liboqs/), including a list of supported algorithms.

**liboqs-go** is an open source Go wrapper for the liboqs C library for quantum-resistant cryptographic algorithms. Details about liboqs-go can be found in [README.md](https://github.com/open-quantum-safe/liboqs-go/blob/master/README.md). See in particular limitations on intended use.
**liboqs-go** is an open source Go wrapper for the liboqs C library for quantum-resistant cryptographic algorithms. Details about liboqs-go can be found in [README.md](https://github.com/open-quantum-safe/liboqs-go/blob/main/README.md). See in particular limitations on intended use.

Release notes
=============

This release of liboqs-go was released on June 10, 2020. Its release page on GitHub is https://github.com/open-quantum-safe/liboqs-go/releases/tag/0.3.0.
This release of liboqs-go was released on November 28, 2020. Its release page on GitHub is https://github.com/open-quantum-safe/liboqs-go/releases/tag/0.4.0.

What's New
----------

This is the seventh release of liboqs-go. For a list of changes see [CHANGES.txt](https://github.com/open-quantum-safe/liboqs-go/blob/master/CHANGES.txt).
This is the eight release of liboqs-go. For a list of changes see [CHANGES.txt](https://github.com/open-quantum-safe/liboqs-go/blob/main/CHANGES.txt).

0 comments on commit cc1b1d6

Please sign in to comment.