Skip to content

Commit cc1b1d6

Browse files
committed
Version 0.4.0
1 parent b34d127 commit cc1b1d6

File tree

4 files changed

+19
-16
lines changed

4 files changed

+19
-16
lines changed

.travis/install_liboqs.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
#!/bin/sh
22

3-
git clone --branch main --single-branch --depth 1 https://github.com/open-quantum-safe/liboqs.git
3+
git clone --branch main --single-branch --depth 1 https://github.com/open-quantum-safe/liboqs
44
cd liboqs
5-
git checkout master
65
mkdir build && cd build
76
cmake -GNinja -DBUILD_SHARED_LIBS=ON -DOQS_BUILD_ONLY_LIB=ON ..
87
ninja

CHANGES.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
Version 0.4.0 - November 28, 2020
2+
- Bugfixes
3+
- Renamed 'master' branch to 'main'
4+
15
Version 0.3.0 - June 10, 2020
26
- Full Windows support and AppVeyor continuous integration
37
- Disabled unit testing for McEliece and Rainbow-IIIc/Vc under Windows

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
liboqs-go: Go bindings for liboqs
22
=================================
33

4-
[![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)
4+
[![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)
55
[![Build status](https://ci.appveyor.com/api/projects/status/x4d2quphnr1c2emf?svg=true)](https://ci.appveyor.com/project/vsoftco/liboqs-go)
66
[![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)
77
[![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)
@@ -37,7 +37,7 @@ liboqs-go is a Go package. The project contains the following files and director
3737
<a name="usage"></a>Usage
3838
----
3939

40-
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.
40+
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.
4141

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

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

58-
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)
58+
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)
5959

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

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

108-
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)
108+
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)
109109

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

150150
> gcc (Rev3, Built by MSYS2 project) 9.1.0
151151
152-
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.
152+
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.
153153

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

172172
go test -v .\oqstests
173173

174-
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).
174+
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).
175175

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

197197
if not using Go modules.
198198

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

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

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

210210
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.
211211

212-
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.
212+
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.
213213

214214
License
215215
-------
216216

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

219219
Team
220220
----

RELEASE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
liboqs-go version 0.3.0
1+
liboqs-go version 0.4.0
22
=======================
33

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

99
**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.
1010

11-
**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.
11+
**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.
1212

1313
Release notes
1414
=============
1515

16-
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.
16+
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.
1717

1818
What's New
1919
----------
2020

21-
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).
21+
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 commit comments

Comments
 (0)