Skip to content

Commit 1d0c8fb

Browse files
wmcrobertsqwmcrobertsq
committed
Merge branch 'cpp-sdk-docs'
2 parents 2d07a3f + 7a2e1de commit 1d0c8fb

File tree

27 files changed

+683
-558
lines changed

27 files changed

+683
-558
lines changed

‎content/sdk/overview/_index.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,12 @@ The C++ SDK is built using the following compilers.
2323
|---|---|---|
2424
| Linux | Clang 9.0.0 | x64 |
2525
| Macos | AppleClang 12.0.0.12000032 | x64 |
26-
| Windows | Clang 9.0.0 with MSVC-like command-line | x64 |
26+
| Windows | Clang 9.0.0 with MSVC-like command-line | x64 |
27+
28+
**Macos Security Warning**
29+
30+
Mac users will need to allow use of the library in the Security & Privacy settings. This will be fixed in a future release.
31+
32+
*Reference*
33+
34+
https://support.apple.com/en-us/HT202491

‎content/sdk/quickstarts/cpp/keygendistributed/index.md‎

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Find the finalized code for this quickstart on [GitHub](https://github.com/Qrypt
1717

1818
## Setup
1919
1. Clone the repo containing this quickstart to a local folder on a Linux, Mac or Windows platform.
20-
1. Retrieve a token from the [Qrypt Portal](https://portal.qrypt.com/) and create an environment variable **QRYPT_TOKEN** for it.
20+
1. Retrieve a token from the [Qrypt Portal](https://portal.qrypt.com/) with the scope **KEYGEN**.
21+
1. (Optional) Create an environment variable **QRYPT_TOKEN** for it. For simplicity, the commands below will be referencing a **QRYPT_TOKEN** environment variable but you can also just use the token direclty in the commands below.
2122
1. Download the Qrypt Security SDK for your platform.
2223
1. Create a lib folder and extract the Qrypt Security SDK into it.
2324

@@ -31,31 +32,68 @@ Find the finalized code for this quickstart on [GitHub](https://github.com/Qrypt
3132
/lib
3233
/res (Windows)
3334

35+
**Macos Security Warning**
36+
37+
Mac users will need to allow use of the library in the Security & Privacy settings. This will be fixed in a future release.
38+
39+
*Reference*
40+
41+
https://support.apple.com/en-us/HT202491
3442
## Build
35-
In a terminal, change to the KeyGenDistributed folder and enter the following to build the KeyGenDistibuted console application.
43+
To change to the KeyGenDistributed folder:
44+
45+
vm@vm:~$ cd KeyGenDistributed
3646

37-
./build.sh --build_type=Debug
47+
To make a (debug) build:
48+
49+
vm@vm:~/KeyGenDistributed$ ./build.sh --build_type=Debug
3850

39-
Upon a successful build, the KeyGenDistributed console application can be found in the build/Debug folder.
51+
To find the build folder (if it built successfully):
4052

41-
Enter the following command for a complete set of build options:
53+
*For linux/mac*
54+
55+
vm@vm:~/KeyGenDistributed$ ls -d build
56+
57+
*For windows*
4258

43-
./build.sh --help
59+
vm@vm:~/KeyGenDistributed$ ls -d build/Debug/
60+
61+
To see more build options:
62+
63+
vm@vm:~/KeyGenDistributed$ ./build.sh --help
4464

4565
## Run
4666
### Run as Alice
47-
This will display the shared key and write out the metadata file for Bob.
67+
To change to the KeyGenDistributed build folder:
68+
69+
*For linux/mac*
70+
71+
vm@vm:~$ cd KeyGenDistributed/build
72+
73+
*for windows*
4874

49-
Change to the *KeyGenDistributed/build/Debug* folder and enter the following command:
75+
vm@vm:~$ cd KeyGenDistributed/build/Debug
5076

51-
./KeyGenDistributed --user=alice --token=${QRYPT_TOKEN} --key-type=aes --filename=metadata.bin
77+
78+
To run as Alice:
79+
80+
./KeyGenDistributed --user=alice --token=${QRYPT_TOKEN} --key-type=aes --metadata-filename=metadata.bin
5281

5382
### Run as Bob
54-
This will consume the metadata file created by Alice above and display the shared key.
83+
To change to the KeyGenDistributed build folder:
84+
85+
*For linux/mac*
86+
87+
vm@vm:~$ cd KeyGenDistributed/build
5588

56-
Make sure you are still in the *KeyGenDistributed/build/Debug* folder and enter the following command:
89+
*for windows*
90+
91+
vm@vm:~$ cd KeyGenDistributed/build/Debug
92+
93+
94+
To run as Alice:
5795

58-
./KeyGenDistributed --user=bob --token=${QRYPT_TOKEN} --filename=metadata.bin
96+
./KeyGenDistributed --user=bob --token=${QRYPT_TOKEN} --metadata-filename=metadata.bin
5997

6098
## Debug
6199
If you open the folder KeyGenDistributed In Visual Studio Code, you will find debug setups for running as Alice and Bob.

‎content/sdk/quickstarts/cpp/keygenlocal/index.md‎

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Find the finalized code for this quickstart on [GitHub](https://github.com/Qrypt
1717

1818
# Setup
1919
1. Clone the repo containing this quickstart to a local folder on a Linux, Mac or Windows platform.
20-
1. Retrieve a token from the [Qrypt Portal](https://portal.qrypt.com/) and create an environment variable **QRYPT_TOKEN** for it.
20+
1. Retrieve a token from the [Qrypt Portal](https://portal.qrypt.com/) with the scope **ENTROPY**.
21+
1. (Optional) Create an environment variable **QRYPT_TOKEN** for it. For simplicity, the commands below will be referencing a **QRYPT_TOKEN** environment variable but you can also just use the token direclty in the commands below.
2122
1. Download the Qrypt Security SDK for your platform.
2223
1. Create a lib folder and extract the Qrypt Security SDK into it.
2324

@@ -31,23 +32,51 @@ Find the finalized code for this quickstart on [GitHub](https://github.com/Qrypt
3132
/lib
3233
/res (Windows)
3334

35+
**Macos Security Warning**
36+
37+
Mac users will need to allow use of the library in the Security & Privacy settings. This will be fixed in a future release.
38+
39+
*Reference*
40+
41+
https://support.apple.com/en-us/HT202491
3442
## Build
35-
In a terminal, change to the KeyGenLocal folder and enter the following to build the KeyGenLocal console application.
43+
To change to the KeyGenLocal folder:
44+
45+
vm@vm:~$ cd KeyGenLocal
46+
47+
To make a (debug) build:
48+
49+
vm@vm:~/KeyGenLocal$ ./build.sh --build_type=Debug
3650

37-
./build.sh --build_type=Debug
51+
To find the build folder (if it built successfully):
3852

39-
Upon a successful build, the KeyGenLocal console application can be found in the build/Debug folder.
53+
*For linux/mac*
54+
55+
vm@vm:~/KeyGenLocal$ ls -d build
56+
57+
*For windows*
4058

41-
Enter the following command for a complete set of build options:
59+
vm@vm:~/KeyGenLocal$ ls -d build/Debug/
4260

43-
./build.sh --help
61+
To see more build options:
62+
63+
vm@vm:~/KeyGenLocal$ ./build.sh --help
4464

4565
## Run
46-
This will display the locally generated AES key.
66+
To change to the KeyGenLocal build folder:
67+
68+
*For linux/mac*
69+
70+
vm@vm:~$ cd KeyGenLocal/build
71+
72+
*for windows*
73+
74+
vm@vm:~$ cd KeyGenLocal/build/Debug
75+
4776

48-
Change to the *KeyGenLocal/build/Debug* folder and enter the following command:
77+
To create and dspaly the locally generated AES key:
4978

50-
./KeyGenLocal ${QRYPT_TOKEN}
79+
./KeyGenLocal --token=${QRYPT_TOKEN}
5180

5281
## Debug
5382
If you open the folder KeyGenLocal In Visual Studio Code, you will find a debug setup for KeyGenLocal.

‎docs/404.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
<title>404 Page not found</title>
1010

1111

12-
<link href="/css/nucleus.css?1644009160" rel="stylesheet">
13-
<link href="/css/fontawesome-all.min.css?1644009160" rel="stylesheet">
14-
<link href="/css/hybrid.css?1644009160" rel="stylesheet">
15-
<link href="/css/featherlight.min.css?1644009160" rel="stylesheet">
16-
<link href="/css/perfect-scrollbar.min.css?1644009160" rel="stylesheet">
17-
<link href="/css/theme.css?1644009160" rel="stylesheet">
18-
<link href="/css/hugo-theme.css?1644009160" rel="stylesheet">
12+
<link href="/css/nucleus.css?1644347559" rel="stylesheet">
13+
<link href="/css/fontawesome-all.min.css?1644347559" rel="stylesheet">
14+
<link href="/css/hybrid.css?1644347559" rel="stylesheet">
15+
<link href="/css/featherlight.min.css?1644347559" rel="stylesheet">
16+
<link href="/css/perfect-scrollbar.min.css?1644347559" rel="stylesheet">
17+
<link href="/css/theme.css?1644347559" rel="stylesheet">
18+
<link href="/css/hugo-theme.css?1644347559" rel="stylesheet">
1919

20-
<link href="/css/theme-mine.css?1644009160" rel="stylesheet">
20+
<link href="/css/theme-mine.css?1644347559" rel="stylesheet">
2121

2222
<style>
2323
:root #header + #content > #left > #rlblock_left {

‎docs/categories/index.html‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@
1212
<title>Categories :: Qrypt</title>
1313

1414

15-
<link href="/css/nucleus.css?1644009159" rel="stylesheet">
16-
<link href="/css/fontawesome-all.min.css?1644009159" rel="stylesheet">
17-
<link href="/css/hybrid.css?1644009159" rel="stylesheet">
18-
<link href="/css/featherlight.min.css?1644009159" rel="stylesheet">
19-
<link href="/css/perfect-scrollbar.min.css?1644009159" rel="stylesheet">
20-
<link href="/css/auto-complete.css?1644009159" rel="stylesheet">
21-
<link href="/css/atom-one-dark-reasonable.css?1644009159" rel="stylesheet">
22-
<link href="/css/theme.css?1644009159" rel="stylesheet">
23-
<link href="/css/tabs.css?1644009159" rel="stylesheet">
24-
<link href="/css/hugo-theme.css?1644009159" rel="stylesheet">
15+
<link href="/css/nucleus.css?1644347559" rel="stylesheet">
16+
<link href="/css/fontawesome-all.min.css?1644347559" rel="stylesheet">
17+
<link href="/css/hybrid.css?1644347559" rel="stylesheet">
18+
<link href="/css/featherlight.min.css?1644347559" rel="stylesheet">
19+
<link href="/css/perfect-scrollbar.min.css?1644347559" rel="stylesheet">
20+
<link href="/css/auto-complete.css?1644347559" rel="stylesheet">
21+
<link href="/css/atom-one-dark-reasonable.css?1644347559" rel="stylesheet">
22+
<link href="/css/theme.css?1644347559" rel="stylesheet">
23+
<link href="/css/tabs.css?1644347559" rel="stylesheet">
24+
<link href="/css/hugo-theme.css?1644347559" rel="stylesheet">
2525

26-
<link href="/css/theme-mine.css?1644009159" rel="stylesheet">
26+
<link href="/css/theme-mine.css?1644347559" rel="stylesheet">
2727

2828

2929

30-
<script src="/js/jquery-3.3.1.min.js?1644009159"></script>
30+
<script src="/js/jquery-3.3.1.min.js?1644347559"></script>
3131

3232
<style>
3333
:root #header + #content > #left > #rlblock_left{
@@ -53,14 +53,14 @@
5353
<span data-search-clear=""><i class="fas fa-times"></i></span>
5454
</div>
5555

56-
<script type="text/javascript" src="/js/lunr.min.js?1644009159"></script>
57-
<script type="text/javascript" src="/js/auto-complete.js?1644009159"></script>
56+
<script type="text/javascript" src="/js/lunr.min.js?1644347559"></script>
57+
<script type="text/javascript" src="/js/auto-complete.js?1644347559"></script>
5858
<script type="text/javascript">
5959

6060
var baseurl = "https:\/\/QryptInc.github.io";
6161

6262
</script>
63-
<script type="text/javascript" src="/js/search.js?1644009159"></script>
63+
<script type="text/javascript" src="/js/search.js?1644347559"></script>
6464

6565

6666
</div>
@@ -1031,19 +1031,19 @@ <h1>
10311031
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
10321032
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
10331033
</div>
1034-
<script src="/js/clipboard.min.js?1644009159"></script>
1035-
<script src="/js/perfect-scrollbar.min.js?1644009159"></script>
1036-
<script src="/js/perfect-scrollbar.jquery.min.js?1644009159"></script>
1037-
<script src="/js/jquery.sticky.js?1644009159"></script>
1038-
<script src="/js/featherlight.min.js?1644009159"></script>
1039-
<script src="/js/highlight.pack.js?1644009159"></script>
1034+
<script src="/js/clipboard.min.js?1644347559"></script>
1035+
<script src="/js/perfect-scrollbar.min.js?1644347559"></script>
1036+
<script src="/js/perfect-scrollbar.jquery.min.js?1644347559"></script>
1037+
<script src="/js/jquery.sticky.js?1644347559"></script>
1038+
<script src="/js/featherlight.min.js?1644347559"></script>
1039+
<script src="/js/highlight.pack.js?1644347559"></script>
10401040
<script>hljs.initHighlightingOnLoad();</script>
1041-
<script src="/js/modernizr.custom-3.6.0.js?1644009159"></script>
1042-
<script src="/js/learn.js?1644009159"></script>
1043-
<script src="/js/hugo-learn.js?1644009159"></script>
1041+
<script src="/js/modernizr.custom-3.6.0.js?1644347559"></script>
1042+
<script src="/js/learn.js?1644347559"></script>
1043+
<script src="/js/hugo-learn.js?1644347559"></script>
10441044

10451045

1046-
<script src="/mermaid/mermaid.js?1644009159"></script>
1046+
<script src="/mermaid/mermaid.js?1644347559"></script>
10471047

10481048
<script>
10491049
mermaid.initialize({ startOnLoad: true });

‎docs/data_at_rest/concepts/index.html‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@
1212
<title>Concepts :: Qrypt</title>
1313

1414

15-
<link href="/css/nucleus.css?1644009159" rel="stylesheet">
16-
<link href="/css/fontawesome-all.min.css?1644009159" rel="stylesheet">
17-
<link href="/css/hybrid.css?1644009159" rel="stylesheet">
18-
<link href="/css/featherlight.min.css?1644009159" rel="stylesheet">
19-
<link href="/css/perfect-scrollbar.min.css?1644009159" rel="stylesheet">
20-
<link href="/css/auto-complete.css?1644009159" rel="stylesheet">
21-
<link href="/css/atom-one-dark-reasonable.css?1644009159" rel="stylesheet">
22-
<link href="/css/theme.css?1644009159" rel="stylesheet">
23-
<link href="/css/tabs.css?1644009159" rel="stylesheet">
24-
<link href="/css/hugo-theme.css?1644009159" rel="stylesheet">
15+
<link href="/css/nucleus.css?1644347559" rel="stylesheet">
16+
<link href="/css/fontawesome-all.min.css?1644347559" rel="stylesheet">
17+
<link href="/css/hybrid.css?1644347559" rel="stylesheet">
18+
<link href="/css/featherlight.min.css?1644347559" rel="stylesheet">
19+
<link href="/css/perfect-scrollbar.min.css?1644347559" rel="stylesheet">
20+
<link href="/css/auto-complete.css?1644347559" rel="stylesheet">
21+
<link href="/css/atom-one-dark-reasonable.css?1644347559" rel="stylesheet">
22+
<link href="/css/theme.css?1644347559" rel="stylesheet">
23+
<link href="/css/tabs.css?1644347559" rel="stylesheet">
24+
<link href="/css/hugo-theme.css?1644347559" rel="stylesheet">
2525

26-
<link href="/css/theme-mine.css?1644009159" rel="stylesheet">
26+
<link href="/css/theme-mine.css?1644347559" rel="stylesheet">
2727

2828

2929

30-
<script src="/js/jquery-3.3.1.min.js?1644009159"></script>
30+
<script src="/js/jquery-3.3.1.min.js?1644347559"></script>
3131

3232
<style>
3333
:root #header + #content > #left > #rlblock_left{
@@ -53,14 +53,14 @@
5353
<span data-search-clear=""><i class="fas fa-times"></i></span>
5454
</div>
5555

56-
<script type="text/javascript" src="/js/lunr.min.js?1644009159"></script>
57-
<script type="text/javascript" src="/js/auto-complete.js?1644009159"></script>
56+
<script type="text/javascript" src="/js/lunr.min.js?1644347559"></script>
57+
<script type="text/javascript" src="/js/auto-complete.js?1644347559"></script>
5858
<script type="text/javascript">
5959

6060
var baseurl = "https:\/\/QryptInc.github.io";
6161

6262
</script>
63-
<script type="text/javascript" src="/js/search.js?1644009159"></script>
63+
<script type="text/javascript" src="/js/search.js?1644347559"></script>
6464

6565

6666
</div>
@@ -1048,19 +1048,19 @@ <h4 id="one-time-pad-otpotp"><a href="otp/">One-Time Pad (OTP)</a></h4>
10481048
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
10491049
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
10501050
</div>
1051-
<script src="/js/clipboard.min.js?1644009159"></script>
1052-
<script src="/js/perfect-scrollbar.min.js?1644009159"></script>
1053-
<script src="/js/perfect-scrollbar.jquery.min.js?1644009159"></script>
1054-
<script src="/js/jquery.sticky.js?1644009159"></script>
1055-
<script src="/js/featherlight.min.js?1644009159"></script>
1056-
<script src="/js/highlight.pack.js?1644009159"></script>
1051+
<script src="/js/clipboard.min.js?1644347559"></script>
1052+
<script src="/js/perfect-scrollbar.min.js?1644347559"></script>
1053+
<script src="/js/perfect-scrollbar.jquery.min.js?1644347559"></script>
1054+
<script src="/js/jquery.sticky.js?1644347559"></script>
1055+
<script src="/js/featherlight.min.js?1644347559"></script>
1056+
<script src="/js/highlight.pack.js?1644347559"></script>
10571057
<script>hljs.initHighlightingOnLoad();</script>
1058-
<script src="/js/modernizr.custom-3.6.0.js?1644009159"></script>
1059-
<script src="/js/learn.js?1644009159"></script>
1060-
<script src="/js/hugo-learn.js?1644009159"></script>
1058+
<script src="/js/modernizr.custom-3.6.0.js?1644347559"></script>
1059+
<script src="/js/learn.js?1644347559"></script>
1060+
<script src="/js/hugo-learn.js?1644347559"></script>
10611061

10621062

1063-
<script src="/mermaid/mermaid.js?1644009159"></script>
1063+
<script src="/mermaid/mermaid.js?1644347559"></script>
10641064

10651065
<script>
10661066
mermaid.initialize({ startOnLoad: true });

0 commit comments

Comments
 (0)