Skip to content

Commit 12ec664

Browse files
authored
docs(NODE-6236): add release integrity section (#32)
1 parent 1c9b74a commit 12ec664

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,34 @@ You can install `mongodb-client-encryption` with the following:
2323
npm install mongodb-client-encryption
2424
```
2525

26+
### Release Integrity
27+
28+
Releases are created automatically and signed using the [Node team's GPG key](https://pgp.mongodb.com/node-driver.asc). This applies to the git tag as well as all release packages provided as part of a GitHub release. To verify the provided packages, download the key and import it using gpg:
29+
30+
```
31+
gpg --import node-driver.asc
32+
```
33+
34+
The GitHub release contains a detached signature file for the NPM package (named
35+
`mongodb-client-encryption-X.Y.Z.tgz.sig`).
36+
37+
The following command returns the link npm package.
38+
```shell
39+
npm view mongodb-client-encryption@vX.Y.Z dist.tarball
40+
```
41+
42+
Using the result of the above command, a `curl` command can return the official npm package for the release.
43+
44+
To verify the integrity of the downloaded package, run the following command:
45+
```shell
46+
gpg --verify mongodb-client-encryption-X.Y.Z.tgz.sig mongodb-client-encryption-X.Y.Z.tgz
47+
```
48+
49+
>[!Note]
50+
No verification is done when using npm to install the package. The contents of the Github tarball and npm's tarball are identical.
51+
52+
To verify the native `.node` packages, follow the same steps as above using `mongodb-client-encryption-X.Y.Z-platform.tgz` and the corresponding `.sig` file.
53+
2654
### Development
2755

2856
#### Setup

0 commit comments

Comments
 (0)