Skip to content

Commit 99946e8

Browse files
moorec-awsmiabatta
authored andcommitted
chore: update openpgp key documentation (OpenJobDescription#215)
Signed-off-by: Charles Moore <122481442+moorec-aws@users.noreply.github.com>
1 parent a420ae8 commit 99946e8

1 file changed

Lines changed: 1 addition & 99 deletions

File tree

README.md

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

290290
### Verifying GitHub Releases
291291

292-
You can verify the authenticity of the release artifacts using the `gpg` command line tool.
293-
294-
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.
295-
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:
296-
```
297-
openjd_model-1.2.3-py3-none-any.whl
298-
openjd_model-1.2.3-py3-none-any.whl.sig
299-
```
300-
301-
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/
302-
303-
3) Save the following contents to a file called `openjobdescription-pgp.asc`:
304-
```
305-
-----BEGIN PGP PUBLIC KEY BLOCK-----
306-
307-
mQINBGXGjx0BEACdChrQ/nch2aYGJ4fxHNQwlPE42jeHECqTdlc1V/mug+7qN7Pc
308-
C4NQk4t68Y72WX/NG49gRfpAxPlSeNt18c3vJ9/sWTukmonWYGK0jQGnDWjuVgFT
309-
XtvJAAQBFilQXN8h779Th2lEuD4bQX+mGB7l60Xvh7vIehE3C4Srbp6KJXskPLPo
310-
dz/dx7a+GXRiyYCYbGX4JziXSjQZRc0tIaxLn/GDm7VnXpdHcUk3qJitree61oC8
311-
agtRHCH5s56E8wt8fXzyStElMkFIZsoLDlLp5lFqT81En9ho/+K6RLBkIj0mC8G7
312-
BafpHKlxkrIgNK3pWACL93GE6xihqwkZMCAeqloVvkOTdfAKDHuDSEHwKxHG3cZ1
313-
/e1YhtkPMVF+NMeoQavykUGVUT1bRoVNdk6bYsnbUjUI1A+JNf6MqvdRJyckZqEC
314-
ylkBekBp/SFpFHvQkRCpfVizm2GSrjdZKgXpm1ZlQJyMRVzc/XPbqdSWhz52r3IC
315-
eudwReHDc+6J5rs6tg3NbFfPVfCBMSqHlu1HRewWAllIp1+y6nfL4U3iEsUvZ1Y6
316-
IV3defHIP3kNPU14ZWf3G5rvJDZrIRnjoWhDcaVmivmB/cSdDzphL5FovSI8dsPm
317-
iU/JZGQb3EvZq+nl4pOiK32hETJ/fgCCzgUA3WqGeFNUNSI9KYZgBe6daQARAQAB
318-
tDRPcGVuIEpvYiBEZXNjcmlwdGlvbiA8b3BlbmpvYmRlc2NyaXB0aW9uQGFtYXpv
319-
bi5jb20+iQJXBBMBCABBFiEEvBcWYrv5OB7Tl2sZovDwWbzECYcFAmXGjx0DGy8E
320-
BQkDwmcABQsJCAcCAiICBhUKCQgLAgMWAgECHgcCF4AACgkQovDwWbzECYcSHRAA
321-
itPYx48xnJiT6tfnult9ZGivhcXhrMlvirVYOqEtRrt0l18sjr84K8mV71eqFwMx
322-
GS7e4iQP6guqW9biQfMA5/Id8ZjE7jNbF0LUGsY6Ktj+yOlAbTR+x5qr7Svb7oEs
323-
TMB/l9HBZ1WtIRzcUk9XYqzvYQr5TT997A63F28u32RchJ+5ECAz4g/p91aWxwVo
324-
HIfN10sGzttoukJCzC10CZAVscJB+nnoUbB/o3bPak6GUxBHpMgomb0K5g4Z4fXY
325-
4AZ9jKFoLgNcExdwteiUdSEnRorZ5Ny8sP84lwJziD3wuamVUsZ1C/KiQJBGTp5e
326-
LUY38J1oIwptw5fqjaAq2GQxEaIknWQ4fr3ZvNYUuGUt5FbHe5U5XF34gC8PK7v7
327-
bT/7sVdZZzKFScDLfH5N36M5FrXfTaXsVbfrRoa2j7U0kndyVEZyJsKVAQ8vgwbJ
328-
w/w2hKkyQLAg3l5yO5CHLGatsfSIzea4WoOAaroxiNtL9gzVXzqpw6qPEsH9hsws
329-
HsPEQWXHmDQvFTNUU14qic1Vc5fyxCBXIAGAPBd20b+219XznJ5uBKUgtvnqcItj
330-
nMYe6Btxh+pjrTA15X/p81z6sB7dkL1hPHfawLhCEzJbIPyyBTQYqY00/ap4Rj7t
331-
kzSiyzBejniFfAZ6eYBWsej7uXUsVndBF1ggZynPTeE=
332-
=iaEm
333-
-----END PGP PUBLIC KEY BLOCK-----
334-
```
335-
336-
4) Import the OpenPGP key for Open Job Description by running the following command:
337-
338-
```
339-
gpg --import --armor openjobdescription-pgp.asc
340-
```
341-
342-
5) Determine whether to trust the OpenPGP key. Some factors to consider when deciding whether or not to trust the above key are:
343-
344-
- The internet connection you’ve used to obtain the GPG key from this website is secure
345-
- The device that you are accessing this website on is secure
346-
347-
If you have decided to trust the OpenPGP key, then edit the key to trust with `gpg` like the following example:
348-
```
349-
$ gpg --edit-key A2F0F059BCC40987
350-
gpg (GnuPG) 2.0.22; Copyright (C) 2013 Free Software Foundation, Inc.
351-
This is free software: you are free to change and redistribute it.
352-
There is NO WARRANTY, to the extent permitted by law.
353-
354-
355-
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
356-
trust: unknown validity: unknown
357-
[ unknown] (1). Open Job Description <openjobdescription@amazon.com>
358-
359-
gpg> trust
360-
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
361-
trust: unknown validity: unknown
362-
[ unknown] (1). Open Job Description <openjobdescription@amazon.com>
363-
364-
Please decide how far you trust this user to correctly verify other users' keys
365-
(by looking at passports, checking fingerprints from different sources, etc.)
366-
367-
1 = I don't know or won't say
368-
2 = I do NOT trust
369-
3 = I trust marginally
370-
4 = I trust fully
371-
5 = I trust ultimately
372-
m = back to the main menu
373-
374-
Your decision? 5
375-
Do you really want to set this key to ultimate trust? (y/N) y
376-
377-
pub 4096R/BCC40987 created: 2024-02-09 expires: 2026-02-08 usage: SCEA
378-
trust: ultimate validity: unknown
379-
[ unknown] (1). Open Job Description <openjobdescription@amazon.com>
380-
Please note that the shown key validity is not necessarily correct
381-
unless you restart the program.
382-
383-
gpg> quit
384-
```
385-
386-
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:
387-
388-
```
389-
gpg --verify ./openjd_model-1.2.3-py3-none-any.whl.sig ./openjd_model-1.2.3-py3-none-any.whl
390-
```
292+
See [Verifying GitHub Releases](https://github.com/OpenJobDescription/openjd-model-for-python?tab=security-ov-file#verifying-github-releases) for more information.
391293

392294
## Security
393295

0 commit comments

Comments
 (0)