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
Qrypt's on-prem quantum entropy appliance is a server that is intentended for on-prem deployments. It exposes a REST API that clients can call to retrieve quantum entropy from the QRNG card installed on the server.
21
21
22
-
### [Quantum Readiness](quantumreadiness/)
23
-
24
-
Quantum readiness provides centralized deployment and management UI of all Qrypt products.
25
-
26
-
### [Post quantum TLS proxy](postquantumproxy/)
27
-
28
-
This post quantum TLS proxy allows for incoming TLS connections to use post quantum cryptography.
29
-
30
22
### [Quantum Entropy as a Service](/eaas/)
31
23
32
24
Qrypt's Quantum Entropy service measures quantum effects and converts those measurements into pure random numbers. The service leverages multiple Quantum Random Number Generators (QRNGs) developed in collaboration with national and international research labs to ensure the highest quality random.
33
25
34
26
### [Key Generation](sdk/)
35
27
36
28
Qrypt SDK includes client library SDKs, cloud-based REST services, command line clients and guidance to help integrate post-quantum security into your applications and services. You can add security features to your applications without being an expert in post-quantum cryptography.
37
-
38
-
### [Portable OpenSSH with Qrypt](openssh/)
39
-
40
-
This implementation of OpenSSH has been modified to provide additional security via the Qrypt Key Generation SDK. During key exchange negotiation, the Qrypt SDK will generate an additional quantum-secure secret that is added to the session key hash inputs.
Copy file name to clipboardExpand all lines: content/eaas/_index.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,12 @@ disableToc = "true"
8
8
9
9
## Using Qrypt's Quantum Entropy Service
10
10
11
-
Qrypt’s Entropy as a Service is a RESTful web service that allows you to generate random data (henceforth referred to as entropy or random) that is truly random—based on quantum-mechanical phenomena.
11
+
Qrypt’s Entropy as a Service is a RESTful web service that allows you to generate random data (henceforth referred to as entropy or random) that is truly random—based on quantum-mechanical phenomena.
12
12
13
-
This service requires an access token. Follow the steps in [Getting Started]({{< ref "/getting_started" >}}) to obtain an access token.
13
+
This service requires an access token. Please {{< externalLink link="https://www.qrypt.com/contact/" text="contact us" >}} to obtain one.
14
14
15
15
### Related Tools and Services
16
+
16
17
1.[RNG Tools]({{< ref "/eaas/rngd" >}}): Integrating Qrypt's Quantum Entropy service as a random source for system devices.
17
18
2.[Qseed]({{< ref "/eaas/pkcs11" >}}): Integrating Qrypt's Quantum Entropy service as a random source for PKCS#11 HSMs.
18
19
@@ -31,7 +32,7 @@ Follow these steps in your preferred tool or language of choice to request entro
31
32
1. Specify your access token and the desired number of kibibytes (1,024 bytes) of entropy in a web request. Use the following URL: {{< externalLink link="https://api-eus.qrypt.com/api/v1/quantum-entropy?size={kib_entropy}" text="https://api-eus.qrypt.com/api/v1/quantum-entropy?size={kib_entropy}" >}}.
32
33
2. Replace {**kib_entropy**} in the aforementioned URL with an integer indicating the number of kibibytes of entropy to return.
33
34
3. Include an HTTP **“Accept”** header field with a value of **“application/json”**</span>.
34
-
4. Include an HTTP **“Authorization”** header with a value of **“Bearer {access_token}”**, where {**access_token**} is the access token obtained from the Qrypt portal.
35
+
4. Include an HTTP **“Authorization”** header with a value of **“Bearer {access_token}”**, where {**access_token**} is the access token obtained from the Qrypt portal (contact us to get one).
35
36
5. Submit the HTTP request using the HTTP GET method.
36
37
6. If the HTTP request is successful, the JSON-formatted response will contain a structure containing two fields named **“random”** and **“size”**. The **“random”** field contains an array of base64-encoded strings (each of which—when decoded—contains 1,024 bytes of entropy). The **“size”** field contains the number of elements in the **“random”** field.
37
38
@@ -76,7 +77,7 @@ The following illustrates an example of JSON output as returned by a request for
76
77
## Examples
77
78
78
79
The following examples demonstrate how to submit a request and display the returned entropy.
79
-
In the following examples, _{subdomain}_ should be replaced with the subdomain for a server in the geographic location you would like to use (see Table 2), _{kib_entropy}_ should be replaced with an integer between 1 and 512, and _{qrypt_access_token}_ should be replaced with an access token generated using your Qrypt account.
80
+
In the following examples, _{subdomain}_ should be replaced with the subdomain for a server in the geographic location you would like to use (see Table 2), _{kib_entropy}_ should be replaced with an integer between 1 and 512, and _{qrypt_access_token}_ should be replaced with an access token.
Copy file name to clipboardExpand all lines: content/eaas/nist/_index.md
+18-7Lines changed: 18 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,14 @@ weight = 20
5
5
chapter = false
6
6
+++
7
7
8
-
9
8
## Using Qrypt's NIST Entropy Quality Tests
10
9
11
-
Qrypt’s NIST Entropy Quality Tests is a set of APIs that allows you to check the quality of Qrypt's entropy using the NIST Statistical Test Suite. Tests are conducted every 10 minutes against Qrypt's Quantum Entropy service. Accessing this service does not require a Qrypt account or access token.
10
+
Qrypt’s NIST Entropy Quality Tests is a set of APIs that allows you to check the quality of Qrypt's entropy using the NIST Statistical Test Suite. Tests are conducted every 10 minutes against Qrypt's Quantum Entropy service. Accessing this service does not require a Qrypt access token.
12
11
13
12
---
13
+
14
14
## About NIST Entropy Quality Tests
15
+
15
16
The NIST Entropy Quality Test suite uses the 15 statistical tests defined by the NIST Statistical Test Suite (STS). Each of these 15 tests is repeated over many samples. The APIs generate two test results:
16
17
17
18
1.**Total number of individual passing tests**: considered successful if a sufficient number of individual tests pass. The threshold varies based on the number of individual tests run and is based on an alpha value of 0.01. For example, 1000 individual tests requires a 98% pass rate to be considered successful.
@@ -20,27 +21,32 @@ The NIST Entropy Quality Test suite uses the 15 statistical tests defined by the
20
21
The tests are considered as succeeding overall if either of these criteria are met. This provides a metric for passing that is more robust to fluctuations than using either criterion alone. However, this standard does not catch certain randomness defects. For example, if the randomness was periodic with a period equal to the size used for batching, a sufficiently high portion of the tests might pass, but the P-values would not be uniform.
21
22
22
23
## NIST Entropy Quality Test Endpoints
23
-
There are three endpoints for obtaining NIST entropy quality test results.
24
+
25
+
There are three endpoints for obtaining NIST entropy quality test results.
26
+
24
27
1. NIST Logs: retrieves a specified number of recent test results
25
28
2. Failing NIST Logs: retrieves a specified number of recent failing test results
26
29
3. Failing NIST Random: retrieves random of recent failing tests
27
30
28
31
### NIST Logs
32
+
29
33
This API contains the most recent NIST test results. To get NIST test results, you must submit an HTTP request to the API, optionally providing the number of results to view and whether they should be shown in a simplified format.
30
34
31
35
1. Make a request to the following URL: {{< externalLink link="https://nist.qrypt.com/api/v1/logs?num={num}&simple={simple}" text="https://nist.qrypt.com/api/v1/logs?num={num}&simple={simple}" >}}.
32
36
2. Optionally replace {**num**} with the desired number of recent test results to show.
33
37
3. Optionally replace {**simple**} with a true or false to specify if you want a simplified test result output.
34
38
35
39
##### Request Parameters
40
+
36
41
{{< nist/logs/requestParameters >}}
37
42
38
43
##### Response Codes
44
+
39
45
{{< nist/logs/responseCodes >}}
40
46
41
47
##### JSON Response Fields
42
48
43
-
For a successful 200 response, the response contains a JSON-encoded structure with an array of test results with the following fields in each array element. Note that the simplified logs only contain 'tests_passed', 'time_of_completion' and 'time_of_completion_string' fields.
49
+
For a successful 200 response, the response contains a JSON-encoded structure with an array of test results with the following fields in each array element. Note that the simplified logs only contain 'tests_passed', 'time_of_completion' and 'time_of_completion_string' fields.
44
50
45
51
There are two main groupings of tests. One is prefixed 'nist' for the number of NIST STS tests that passed or failed, and the second is 'uniformity' for the uniformity of each NIST STS test's P-values.
46
52
@@ -67,19 +73,22 @@ The following illustrates an example of JSON output as returned by a request for
67
73
```
68
74
69
75
### NIST Failed Test Logs
76
+
70
77
This API contains the most recent failed NIST test results, where both the individual test rate and uniformity tests fail. To get failed NIST test results, you must submit an HTTP request to the API.
71
78
72
79
1. Make a request to the following URL: {{< externalLink link="https://nist.qrypt.com/api/v1/failing_logs?num={num}&simple={simple}&strict={strict}&include_random={include_random}&randsize={randsize}" text="https://nist.qrypt.com/api/v1/failing_logs?num={num}&simple={simple}&strict={strict}&include_random={include_random}&randsize={randsize}" >}}
73
80
2. Optionally replace {**num**} with the number of recent test results to show.
74
81
3. Optionally replace {**simple**} with 'true' to output simplified logs.
75
82
4. Optionally replace {**strict**} with 'false' specify if you want to show logs that failed either the test rate or uniformity.
76
-
4. Optionally replace {**include_random**} with 'true' to see failed random. Only applicable if 'strict' is 'true'.
77
-
5. Optionally replace {**randsize**} with the number of bits to show. Only applicable if 'include_random' is set to 'true'.
83
+
5. Optionally replace {**include_random**} with 'true' to see failed random. Only applicable if 'strict' is 'true'.
84
+
6. Optionally replace {**randsize**} with the number of bits to show. Only applicable if 'include_random' is set to 'true'.
78
85
79
86
##### Request Parameters
87
+
80
88
{{< nist/failing_logs/requestParameters >}}
81
89
82
90
##### Response Codes
91
+
83
92
{{< nist/failing_logs/responseCodes >}}
84
93
85
94
##### JSON Response Fields
@@ -109,18 +118,20 @@ The following illustrates an example of JSON output as returned by a request for
109
118
]
110
119
```
111
120
112
-
113
121
### NIST Failed Random
122
+
114
123
This API contains the random of the most recent strictly failing NIST tests. To get the random of failed NIST test results, you must submit an HTTP request to the API.
115
124
116
125
1. Make a request to the following URL: {{< externalLink link="https://nist.qrypt.com/api/v1/failing_random?num={num}&randsize={randsize}" text="https://nist.qrypt.com/api/v1/failing_random?num={num}&randsize={randsize}" >}}
117
126
2. Optionally replace {**num**} with the number of recent test results to show.
118
127
3. Optionally replace {**randsize**} with 'true' to output simplified logs.
Copy file name to clipboardExpand all lines: content/eaas/pkcs11/_index.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,18 @@ weight = 40
5
5
6
6
This page covers the [Qseed](https://github.com/QryptInc/qseed) application architecture that downloads quantum entropy from Qrypt's entropy service and injects it into a PKCS#11 compliant HSM (Hardware Security Modules) as seed random.
7
7
8
-
This service requires an access token. Follow the steps in [Getting Started]({{< ref "/getting_started" >}}) to obtain an access token.
8
+
This service requires an access token. Please {{< externalLink link="https://www.qrypt.com/contact/" text="contact us" >}} to obtain one.
9
9
10
10
## Technology Value
11
+
11
12
Many of the available HSMs use non-quantum entropy sources. Fortunately, the PKCS#11 Cryptoki interface provides a C_SeedRandom function to inject entropy into a PKCS#11 compliant HSM. Developers can inject Qrypt's quantum entropy into a HSM using the C_SeedRandom function. As a result, HSM keys can be pseudorandomly generated from quantum entropy.
12
13
13
14
## Overview
15
+
14
16
{{< figure src="images/inject-seedrandom.png" >}}
15
17
16
18
There are four components to the architecture diagram above.
19
+
17
20
1.**Qrypt Services**: Qrypt's entropy service that can provide quantum entropy via a REST API.
18
21
2.**Qseed Application**: Application that periodically retrieves entropy from Qrypt's entropy service and injects it into an HSM via a PKCS#11 Cryptoki interface (C_SeedRandom).
19
22
3.**Cryptoki Library**: A library that the HSM vendor provides that implements the PKCS#11 Cryptoki interface for their device.
@@ -44,4 +47,3 @@ The Qseed application only support Crypto User PINs. You will need to create a C
44
47
## References
45
48
46
49
More information about the PKCS#11 Cryptoki interface can be found at [Oasis PKCS#11 Specification](https://docs.oasis-open.org/pkcs11/pkcs11-base/v2.40/os/pkcs11-base-v2.40-os.html).
Copy file name to clipboardExpand all lines: content/eaas/rngd/_index.md
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,24 +8,26 @@ disableToc = "true"
8
8
9
9
## Using Qrypt's Quantum Entropy in RNG Tools
10
10
11
-
*rng-tools* is a utility that allows you to inject entropy from hardware sources, prngs, and http streams into system devices. Qrypt's Quantum Entropy service is a random source option in *rng-tools*, allowing you to inject quantum entropy into system devices such as '/dev/random', '/dev/urandom', and user-defined nodes or files.
11
+
_rng-tools_ is a utility that allows you to inject entropy from hardware sources, prngs, and http streams into system devices. Qrypt's Quantum Entropy service is a random source option in _rng-tools_, allowing you to inject quantum entropy into system devices such as '/dev/random', '/dev/urandom', and user-defined nodes or files.
12
12
13
-
This service requires an access token. Follow the steps in [Getting Started]({{< ref "/getting_started" >}}) to obtain an access token.
13
+
This service requires an access token. Please {{< externalLink link="https://www.qrypt.com/contact/" text="contact us" >}} to obtain one.
14
14
15
-
More information about *rng-tools* can be found on the {{< externalLink link="https://github.com/nhorman/rng-tools" text="rng-tools Github" >}} and the {{< externalLink link="https://wiki.archlinux.org/title/Rng-tools" text="rng-tools wiki page" >}}.
15
+
More information about _rng-tools_ can be found on the {{< externalLink link="https://github.com/nhorman/rng-tools" text="rng-tools Github" >}} and the {{< externalLink link="https://wiki.archlinux.org/title/Rng-tools" text="rng-tools wiki page" >}}.
16
16
17
17
---
18
18
19
19
## Installation
20
20
21
-
To use Qrypt's Quantum Entropy service in *rng-tools*, *rng-tools* must be installed and configured.
21
+
To use Qrypt's Quantum Entropy service in _rng-tools_, _rng-tools_ must be installed and configured.
22
+
23
+
Clone the latest _rng-tools_ master from GitHub.
22
24
23
-
Clone the latest *rng-tools* master from GitHub.
24
25
```bash
25
26
git clone https://github.com/nhorman/rng-tools
26
27
```
27
28
28
-
Install *rng-tools* dependencies. Additional packages may be required, depending on linux distro. The configure script below will name any missing packages it encounters.
29
+
Install _rng-tools_ dependencies. Additional packages may be required, depending on linux distro. The configure script below will name any missing packages it encounters.
30
+
29
31
```bash
30
32
sudo apt install \
31
33
make \
@@ -41,6 +43,7 @@ sudo apt install \
41
43
```
42
44
43
45
Add `--disable-dependency-tracking` to the './configure' command if needed.
46
+
44
47
```bash
45
48
./autogen.sh
46
49
./configure
@@ -49,11 +52,13 @@ sudo make install
49
52
```
50
53
51
54
Verify installation.
55
+
52
56
```bash
53
57
which rngd
54
58
```
55
59
56
60
## Command Line Usage
61
+
57
62
The resulting 'rngd' executable can run directly to start either a daemon or a foreground process. By default, 'rngd' will run as a background daemon and attempt to use the 'hwrng', 'errand', 'pkcs11', and 'rtlsdr' random sources.
58
63
59
64
To run 'rngd' using exclusively Qrypt's Quantum Entropy, run the following command. This will run 'rngd' as a foreground process with the Qrypt source enabled and all other entropy sources disabled. 'rngd' will send its random to the /dev/random device.
@@ -68,7 +73,8 @@ Command line options:
68
73
{{< rngd/rngd-options >}}
69
74
70
75
## Service Usage
71
-
*rng-tools* comes with a 'rngd.service' file for setting up a systemd service. To configure rngd to automatically start the Qrypt source on boot, follow these steps:
76
+
77
+
_rng-tools_ comes with a 'rngd.service' file for setting up a systemd service. To configure rngd to automatically start the Qrypt source on boot, follow these steps:
72
78
73
79
Save your Qrypt api token to a system-accessible directory, such as '/etc/rngd/qrypt.token'. Then, edit 'rngd.service' to add Qrypt arguments and options.
0 commit comments