Basic Deno support

[Hexagon]

Related to Discussion #1447

Changes made:

• Update README.md to indicate experimental support for Deno
• Add extra checks in src/*, to avoid directly accessing objects/properties not defined in a Deno environment, specifically navigator.userAgent and navigator.hardwareCurrency

Tested with:

• npm test
• npm run browsertest
• npm run lint
• Example 1-3 from README.md#examples, using Deno 1.16.4, both JavaScript and TypeScript mode

Testable by:

1. Make sure openpgpjs is checked out locally
2. If not already done - run npm run build to generate dist/openpgp.mjs
3. Create a test application - test.js - (in this example in a directory adjacent to openpgpjs ../denotest)

// Import locally
import * as openpgp from '../openpgpjs/dist/openpgp.mjs';

(async () => {
    const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x01, 0x01]) });
    const encrypted = await openpgp.encrypt({
        message, // input as Message object
        passwords: ['secret stuff'], // multiple passwords possible
        format: 'binary' // don't ASCII armor (for Uint8Array output)
    });
    console.log(encrypted); // Uint8Array

    const encryptedMessage = await openpgp.readMessage({
        binaryMessage: encrypted // parse encrypted bytes
    });
    const { data: decrypted } = await openpgp.decrypt({
        message: encryptedMessage,
        passwords: ['secret stuff'], // decrypt with password
        format: 'binary' // output as Uint8Array
    });
    console.log(decrypted); // Uint8Array([0x01, 0x01, 0x01])
})();

3. Run test application deno run test.js
4. It works (or should, at least)!
5. If implemented, this would be a fully working deno application

import * as openpgp from '<deno land url>/openpgp/dist/openpgp.mjs';
p
(async () => {
    const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x01, 0x01]) });
    const encrypted = await openpgp.encrypt({
        message, // input as Message object
        passwords: ['secret stuff'], // multiple passwords possible
        format: 'binary' // don't ASCII armor (for Uint8Array output)
    });
    console.log(encrypted); // Uint8Array

    const encryptedMessage = await openpgp.readMessage({
        binaryMessage: encrypted // parse encrypted bytes
    });
    const { data: decrypted } = await openpgp.decrypt({
        message: encryptedMessage,
        passwords: ['secret stuff'], // decrypt with password
        format: 'binary' // output as Uint8Array
    });
    console.log(decrypted); // Uint8Array([0x01, 0x01, 0x01])
})();

[Hexagon]

All tests passing now, force pushed some fixes as no one seem to have looked at it yet.

[Hexagon]

Another force push fixing linting

[clo4]

navigator.hardwareConcurrency is actually available in stable Deno, from 1.13 (August)

[Hexagon]

navigator.hardwareConcurrency is actually available in stable Deno, from 1.13 (August)

Oh! Got an error (in Deno) saying navigator isn't defined, so I made an assumption that everything following navigator is undefined. Need to have a closer look at what was going on.

[Hexagon]

Slightly simplified after feedback from @separaterecords, thanks!

[twiss]

Hello 👋 Thanks for the PR! Some small comments below.

[twiss]

For a security-related module like OpenPGP.js, I would prefer not to suggest to use a CDN, at least without something like Subresource Integrity (don't know if it's possible to add it here?)

[Hexagon]

Maybe deno.land/x can be seen as a more trusted source? This will require a maintaner to register the module at https://deno.land/x, and add a webhook to github.

For now, maybe we can keep it anonymous, with an example showing a local import?

Edit: Suggested a more anonymous approach in latest commit, see new single comment.

[twiss]

Alrighty, yeah. We can do that after merging this.

[Hexagon]

Sweet 👍

[renatoathaydes]

Hi, I am not sure if this is related as I am not using Deno, but I see that one of the problems in this issue was references to navigator. That's probably also causing errors when I try to use this lib in a Cloudflare Worker, as pointed out to me by @twiss on Gitter.

My question on StackOverflow has more details.

I have imports like this:

import { encrypt, readKey, createMessage, decryptKey, readPrivateKey } from 'openpgp/lightweight';

And my npm dependency is on this merged branch, so I expected it would work:

    "node_modules/openpgp": {
      "version": "5.1.0",
      "resolved": "git+ssh://git@github.com/openpgpjs/openpgpjs.git#bd13edfc884cf6b6b7f715099529ac6a656733c6",
      "license": "LGPL-3.0+",
      "dependencies": {
        "asn1.js": "^5.0.0"
      },
      "engines": {
        "node": ">= 8.0.0"
      }
    },

The error I get when I run wrangler dev:

webpack 5.67.0 compiled successfully in 1785 ms
Error: Something went wrong with the request to Cloudflare...
Uncaught ReferenceError: navigator is not defined
  at line 782 in ./node_modules/openpgp/dist/lightweight/openpgp.min.mjs
  at line 808 in __webpack_require__
  at line 528 in ./src/crypto.ts
  at line 808 in __webpack_require__
  at line 652 in ./src/handler.ts
  at line 808 in __webpack_require__
  at line 1047
  at line 1052
  at line 1054
 [API code: 10021]

This happens with openpgp/lightweight and openpgp.

If you think this is unrelated, I can open a new issue.

[twiss]

@renatoathaydes Yeah, please create a separate issue or PR for this :)