You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
liboqs-go: Go bindings for liboqs
2
2
=================================
3
3
4
-
[](https://travis-ci.com/open-quantum-safe/liboqs-go)
4
+
[](https://travis-ci.com/open-quantum-safe/liboqs-go)
@@ -37,7 +37,7 @@ liboqs-go is a Go package. The project contains the following files and director
37
37
<aname="usage"></a>Usage
38
38
----
39
39
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.
41
41
42
42
<aname="posix"></a>Running/building on POSIX (Linux/UNIX-like) platforms
43
43
----
@@ -55,7 +55,7 @@ Download/clone the `liboqs-go` wrapper repository in the directory of your choic
55
55
56
56
cd $HOME && git clone https://github.com/open-quantum-safe/liboqs-go
57
57
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)
59
59
60
60
LIBOQS_INCLUDE_DIR=/usr/local/include
61
61
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
105
105
106
106
In my case `LIBOQSGO_INSTALL_PATH` is set to `$HOME/go/src/github.com/open-quantum-safe/liboqs-go`.
107
107
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)
109
109
110
110
LIBOQS_INCLUDE_DIR=/usr/local/include
111
111
LIBOQS_LIB_DIR=/usr/local/lib
@@ -149,7 +149,7 @@ As mentioned in the [Pre-requisites](#pre-requisites) section, we assume you hav
149
149
150
150
> gcc (Rev3, Built by MSYS2 project) 9.1.0
151
151
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.
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).
175
175
176
176
<aname="documentation"></a>Documentation
177
177
----
@@ -196,9 +196,9 @@ if using Go modules, or
196
196
197
197
if not using Go modules.
198
198
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).
200
200
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).
202
202
203
203
<aname="limitations"></a>Limitations and security
204
204
----
@@ -209,12 +209,12 @@ We believe that the NIST Post-Quantum Cryptography standardization project is cu
209
209
210
210
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.
211
211
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.
213
213
214
214
License
215
215
-------
216
216
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.
@@ -8,14 +8,14 @@ The **Open Quantum Safe (OQS) project** has the goal of developing and prototypi
8
8
9
9
**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.
10
10
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.
12
12
13
13
Release notes
14
14
=============
15
15
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.
17
17
18
18
What's New
19
19
----------
20
20
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