Skip to content

Commit 68b3c24

Browse files
committed
chore: move pgp verification instructions
Signed-off-by: Charles Moore <[email protected]>
1 parent fa8e4dd commit 68b3c24

File tree

2 files changed

+102
-99
lines changed

2 files changed

+102
-99
lines changed

README.md

Lines changed: 1 addition & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -177,105 +177,7 @@ You can download this package from:
177177

178178
### Verifying GitHub Releases
179179

180-
You can verify the authenticity of the release artifacts using the `gpg` command line tool.
181-
182-
1) Download the desired release artifacts from the GitHub releases page. Make sure to download the corresponding PGP signature file (ending with `.sig`) as well.
183-
For example, if you would like to verify your download of the wheel for version `1.2.3`, you should have the following files downloaded:
184-
```
185-
openjd_cli-1.2.3-py3-none-any.whl
186-
openjd_cli-1.2.3-py3-none-any.whl.sig
187-
```
188-
189-
2) Install the `gpg` command line tool. The installation process varies by operating system. Please refer to the GnuPG website for instructions: https://gnupg.org/download/
190-
191-
3) Save the following contents to a file called `openjobdescription-pgp.asc`:
192-
```
193-
-----BEGIN PGP PUBLIC KEY BLOCK-----
194-
195-
mQINBGXGjx0BEACdChrQ/nch2aYGJ4fxHNQwlPE42jeHECqTdlc1V/mug+7qN7Pc
196-
C4NQk4t68Y72WX/NG49gRfpAxPlSeNt18c3vJ9/sWTukmonWYGK0jQGnDWjuVgFT
197-
XtvJAAQBFilQXN8h779Th2lEuD4bQX+mGB7l60Xvh7vIehE3C4Srbp6KJXskPLPo
198-
dz/dx7a+GXRiyYCYbGX4JziXSjQZRc0tIaxLn/GDm7VnXpdHcUk3qJitree61oC8
199-
agtRHCH5s56E8wt8fXzyStElMkFIZsoLDlLp5lFqT81En9ho/+K6RLBkIj0mC8G7
200-
BafpHKlxkrIgNK3pWACL93GE6xihqwkZMCAeqloVvkOTdfAKDHuDSEHwKxHG3cZ1
201-
/e1YhtkPMVF+NMeoQavykUGVUT1bRoVNdk6bYsnbUjUI1A+JNf6MqvdRJyckZqEC
202-
ylkBekBp/SFpFHvQkRCpfVizm2GSrjdZKgXpm1ZlQJyMRVzc/XPbqdSWhz52r3IC
203-
eudwReHDc+6J5rs6tg3NbFfPVfCBMSqHlu1HRewWAllIp1+y6nfL4U3iEsUvZ1Y6
204-
IV3defHIP3kNPU14ZWf3G5rvJDZrIRnjoWhDcaVmivmB/cSdDzphL5FovSI8dsPm
205-
iU/JZGQb3EvZq+nl4pOiK32hETJ/fgCCzgUA3WqGeFNUNSI9KYZgBe6daQARAQAB
206-
tDRPcGVuIEpvYiBEZXNjcmlwdGlvbiA8b3BlbmpvYmRlc2NyaXB0aW9uQGFtYXpv
207-
bi5jb20+iQJXBBMBCABBFiEEvBcWYrv5OB7Tl2sZovDwWbzECYcFAmXGjx0DGy8E
208-
BQkDwmcABQsJCAcCAiICBhUKCQgLAgMWAgECHgcCF4AACgkQovDwWbzECYcSHRAA
209-
itPYx48xnJiT6tfnult9ZGivhcXhrMlvirVYOqEtRrt0l18sjr84K8mV71eqFwMx
210-
GS7e4iQP6guqW9biQfMA5/Id8ZjE7jNbF0LUGsY6Ktj+yOlAbTR+x5qr7Svb7oEs
211-
TMB/l9HBZ1WtIRzcUk9XYqzvYQr5TT997A63F28u32RchJ+5ECAz4g/p91aWxwVo
212-
HIfN10sGzttoukJCzC10CZAVscJB+nnoUbB/o3bPak6GUxBHpMgomb0K5g4Z4fXY
213-
4AZ9jKFoLgNcExdwteiUdSEnRorZ5Ny8sP84lwJziD3wuamVUsZ1C/KiQJBGTp5e
214-
LUY38J1oIwptw5fqjaAq2GQxEaIknWQ4fr3ZvNYUuGUt5FbHe5U5XF34gC8PK7v7
215-
bT/7sVdZZzKFScDLfH5N36M5FrXfTaXsVbfrRoa2j7U0kndyVEZyJsKVAQ8vgwbJ
216-
w/w2hKkyQLAg3l5yO5CHLGatsfSIzea4WoOAaroxiNtL9gzVXzqpw6qPEsH9hsws
217-
HsPEQWXHmDQvFTNUU14qic1Vc5fyxCBXIAGAPBd20b+219XznJ5uBKUgtvnqcItj
218-
nMYe6Btxh+pjrTA15X/p81z6sB7dkL1hPHfawLhCEzJbIPyyBTQYqY00/ap4Rj7t
219-
kzSiyzBejniFfAZ6eYBWsej7uXUsVndBF1ggZynPTeE=
220-
=iaEm
221-
-----END PGP PUBLIC KEY BLOCK-----
222-
```
223-
224-
4) Import the OpenPGP key for Open Job Description by running the following command:
225-
226-
```
227-
gpg --import --armor openjobdescription-pgp.asc
228-
```
229-
230-
5) Determine whether to trust the OpenPGP key. Some factors to consider when deciding whether or not to trust the above key are:
231-
232-
- The internet connection you’ve used to obtain the GPG key from this website is secure
233-
- The device that you are accessing this website on is secure
234-
235-
If you have decided to trust the OpenPGP key, then edit the key to trust with `gpg` like the following example:
236-
```
237-
$ gpg --edit-key A2F0F059BCC40987
238-
gpg (GnuPG) 2.0.22; Copyright (C) 2013 Free Software Foundation, Inc.
239-
This is free software: you are free to change and redistribute it.
240-
There is NO WARRANTY, to the extent permitted by law.
241-
242-
243-
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
244-
trust: unknown validity: unknown
245-
[ unknown] (1). Open Job Description <[email protected]>
246-
247-
gpg> trust
248-
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
249-
trust: unknown validity: unknown
250-
[ unknown] (1). Open Job Description <[email protected]>
251-
252-
Please decide how far you trust this user to correctly verify other users' keys
253-
(by looking at passports, checking fingerprints from different sources, etc.)
254-
255-
1 = I don't know or won't say
256-
2 = I do NOT trust
257-
3 = I trust marginally
258-
4 = I trust fully
259-
5 = I trust ultimately
260-
m = back to the main menu
261-
262-
Your decision? 5
263-
Do you really want to set this key to ultimate trust? (y/N) y
264-
265-
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
266-
trust: ultimate validity: unknown
267-
[ unknown] (1). Open Job Description <[email protected]>
268-
Please note that the shown key validity is not necessarily correct
269-
unless you restart the program.
270-
271-
gpg> quit
272-
```
273-
274-
6) Verify the signature of the Open Job Description release via `gpg --verify`. The command for verifying the example files from step 1 would be:
275-
276-
```
277-
gpg --verify ./openjd_cli-1.2.3-py3-none-any.whl.sig ./openjd_cli-1.2.3-py3-none-any.whl
278-
```
180+
See [VERIFYING_PGP_SIGNATURE](VERIFYING_PGP_SIGNATURE.md) for more information.
279181

280182
## Security
281183

VERIFYING_PGP_SIGNATURE.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
### Verifying GitHub Releases
2+
3+
You can verify the authenticity of the release artifacts using the `gpg` command line tool.
4+
5+
1) Download the desired release artifacts from the GitHub releases page. Make sure to download the corresponding PGP signature file (ending with `.sig`) as well.
6+
For example, if you would like to verify your download of the wheel for version `1.2.3`, you should have the following files downloaded:
7+
```
8+
openjd_cli-1.2.3-py3-none-any.whl
9+
openjd_cli-1.2.3-py3-none-any.whl.sig
10+
```
11+
12+
2) Install the `gpg` command line tool. The installation process varies by operating system. Please refer to the GnuPG website for instructions: https://gnupg.org/download/
13+
14+
3) Save the following contents to a file called `openjobdescription-pgp.asc`:
15+
```
16+
-----BEGIN PGP PUBLIC KEY BLOCK-----
17+
18+
mQINBGXGjx0BEACdChrQ/nch2aYGJ4fxHNQwlPE42jeHECqTdlc1V/mug+7qN7Pc
19+
C4NQk4t68Y72WX/NG49gRfpAxPlSeNt18c3vJ9/sWTukmonWYGK0jQGnDWjuVgFT
20+
XtvJAAQBFilQXN8h779Th2lEuD4bQX+mGB7l60Xvh7vIehE3C4Srbp6KJXskPLPo
21+
dz/dx7a+GXRiyYCYbGX4JziXSjQZRc0tIaxLn/GDm7VnXpdHcUk3qJitree61oC8
22+
agtRHCH5s56E8wt8fXzyStElMkFIZsoLDlLp5lFqT81En9ho/+K6RLBkIj0mC8G7
23+
BafpHKlxkrIgNK3pWACL93GE6xihqwkZMCAeqloVvkOTdfAKDHuDSEHwKxHG3cZ1
24+
/e1YhtkPMVF+NMeoQavykUGVUT1bRoVNdk6bYsnbUjUI1A+JNf6MqvdRJyckZqEC
25+
ylkBekBp/SFpFHvQkRCpfVizm2GSrjdZKgXpm1ZlQJyMRVzc/XPbqdSWhz52r3IC
26+
eudwReHDc+6J5rs6tg3NbFfPVfCBMSqHlu1HRewWAllIp1+y6nfL4U3iEsUvZ1Y6
27+
IV3defHIP3kNPU14ZWf3G5rvJDZrIRnjoWhDcaVmivmB/cSdDzphL5FovSI8dsPm
28+
iU/JZGQb3EvZq+nl4pOiK32hETJ/fgCCzgUA3WqGeFNUNSI9KYZgBe6daQARAQAB
29+
tDRPcGVuIEpvYiBEZXNjcmlwdGlvbiA8b3BlbmpvYmRlc2NyaXB0aW9uQGFtYXpv
30+
bi5jb20+iQJXBBMBCABBFiEEvBcWYrv5OB7Tl2sZovDwWbzECYcFAmXGjx0DGy8E
31+
BQkDwmcABQsJCAcCAiICBhUKCQgLAgMWAgECHgcCF4AACgkQovDwWbzECYcSHRAA
32+
itPYx48xnJiT6tfnult9ZGivhcXhrMlvirVYOqEtRrt0l18sjr84K8mV71eqFwMx
33+
GS7e4iQP6guqW9biQfMA5/Id8ZjE7jNbF0LUGsY6Ktj+yOlAbTR+x5qr7Svb7oEs
34+
TMB/l9HBZ1WtIRzcUk9XYqzvYQr5TT997A63F28u32RchJ+5ECAz4g/p91aWxwVo
35+
HIfN10sGzttoukJCzC10CZAVscJB+nnoUbB/o3bPak6GUxBHpMgomb0K5g4Z4fXY
36+
4AZ9jKFoLgNcExdwteiUdSEnRorZ5Ny8sP84lwJziD3wuamVUsZ1C/KiQJBGTp5e
37+
LUY38J1oIwptw5fqjaAq2GQxEaIknWQ4fr3ZvNYUuGUt5FbHe5U5XF34gC8PK7v7
38+
bT/7sVdZZzKFScDLfH5N36M5FrXfTaXsVbfrRoa2j7U0kndyVEZyJsKVAQ8vgwbJ
39+
w/w2hKkyQLAg3l5yO5CHLGatsfSIzea4WoOAaroxiNtL9gzVXzqpw6qPEsH9hsws
40+
HsPEQWXHmDQvFTNUU14qic1Vc5fyxCBXIAGAPBd20b+219XznJ5uBKUgtvnqcItj
41+
nMYe6Btxh+pjrTA15X/p81z6sB7dkL1hPHfawLhCEzJbIPyyBTQYqY00/ap4Rj7t
42+
kzSiyzBejniFfAZ6eYBWsej7uXUsVndBF1ggZynPTeE=
43+
=iaEm
44+
-----END PGP PUBLIC KEY BLOCK-----
45+
```
46+
47+
4) Import the OpenPGP key for Open Job Description by running the following command:
48+
49+
```
50+
gpg --import --armor openjobdescription-pgp.asc
51+
```
52+
53+
5) Determine whether to trust the OpenPGP key. Some factors to consider when deciding whether or not to trust the above key are:
54+
55+
- The internet connection you’ve used to obtain the GPG key from this website is secure
56+
- The device that you are accessing this website on is secure
57+
58+
If you have decided to trust the OpenPGP key, then edit the key to trust with `gpg` like the following example:
59+
```
60+
$ gpg --edit-key A2F0F059BCC40987
61+
gpg (GnuPG) 2.0.22; Copyright (C) 2013 Free Software Foundation, Inc.
62+
This is free software: you are free to change and redistribute it.
63+
There is NO WARRANTY, to the extent permitted by law.
64+
65+
66+
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
67+
trust: unknown validity: unknown
68+
[ unknown] (1). Open Job Description <[email protected]>
69+
70+
gpg> trust
71+
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
72+
trust: unknown validity: unknown
73+
[ unknown] (1). Open Job Description <[email protected]>
74+
75+
Please decide how far you trust this user to correctly verify other users' keys
76+
(by looking at passports, checking fingerprints from different sources, etc.)
77+
78+
1 = I don't know or won't say
79+
2 = I do NOT trust
80+
3 = I trust marginally
81+
4 = I trust fully
82+
5 = I trust ultimately
83+
m = back to the main menu
84+
85+
Your decision? 5
86+
Do you really want to set this key to ultimate trust? (y/N) y
87+
88+
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
89+
trust: ultimate validity: unknown
90+
[ unknown] (1). Open Job Description <[email protected]>
91+
Please note that the shown key validity is not necessarily correct
92+
unless you restart the program.
93+
94+
gpg> quit
95+
```
96+
97+
6) Verify the signature of the Open Job Description release via `gpg --verify`. The command for verifying the example files from step 1 would be:
98+
99+
```
100+
gpg --verify ./openjd_cli-1.2.3-py3-none-any.whl.sig ./openjd_cli-1.2.3-py3-none-any.whl
101+
```

0 commit comments

Comments
 (0)