mirror of
https://github.com/the-djmaze/snappymail.git
synced 2024-09-20 07:35:55 +08:00
OpenPGP.js v5.11.1
This commit is contained in:
parent
a0e7bf790e
commit
d04f2166d9
12
vendors/openpgp-5/README.md
vendored
12
vendors/openpgp-5/README.md
vendored
|
@ -75,7 +75,7 @@ library to convert back and forth between them.
|
|||
|
||||
* If the user's browser supports [native WebCrypto](https://caniuse.com/#feat=cryptography) via the `window.crypto.subtle` API, this will be used. Under Node.js the native [crypto module](https://nodejs.org/api/crypto.html#crypto_crypto) is used.
|
||||
|
||||
* The library implements the [IETF proposal](https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-10) for authenticated encryption using native AES-EAX, OCB, or GCM. This makes symmetric encryption up to 30x faster on supported platforms. Since the specification has not been finalized and other OpenPGP implementations haven't adopted it yet, the feature is currently behind a flag. **Note: activating this setting can break compatibility with other OpenPGP implementations, and also with future versions of OpenPGP.js. Don't use it with messages you want to store on disk or in a database.** You can enable it by setting `openpgp.config.aeadProtect = true`.
|
||||
* The library implements the [RFC4880bis proposal](https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-10) for authenticated encryption using native AES-EAX, OCB, or GCM. This makes symmetric encryption up to 30x faster on supported platforms. Since the specification has not been finalized and other OpenPGP implementations haven't adopted it yet, the feature is currently behind a flag. **Note: activating this setting can break compatibility with other OpenPGP implementations, and also with future versions of OpenPGP.js. Don't use it with messages you want to store on disk or in a database.** You can enable it by setting `openpgp.config.aeadProtect = true`.
|
||||
|
||||
You can change the AEAD mode by setting one of the following options:
|
||||
|
||||
|
@ -172,6 +172,16 @@ import * as openpgp from './openpgp.min.mjs';
|
|||
|
||||
To offload cryptographic operations off the main thread, you can implement a Web Worker in your application and load OpenPGP.js from there. For an example Worker implementation, see `test/worker/worker_example.js`.
|
||||
|
||||
#### TypeScript
|
||||
|
||||
Since TS is not fully integrated in the library, TS-only dependencies are currently listed as `devDependencies`, so to compile the project you’ll need to add `@openpgp/web-stream-tools` manually (NB: only versions below v0.12 are compatible with OpenPGP.js v5):
|
||||
|
||||
```sh
|
||||
npm install --save-dev @openpgp/web-stream-tools@0.0.11-patch-0
|
||||
```
|
||||
|
||||
If you notice missing or incorrect type definitions, feel free to open a PR.
|
||||
|
||||
### Examples
|
||||
|
||||
Here are some examples of how to use OpenPGP.js v5. For more elaborate examples and working code, please check out the [public API unit tests](https://github.com/openpgpjs/openpgpjs/blob/main/test/general/openpgp.js). If you're upgrading from v4 it might help to check out the [changelog](https://github.com/openpgpjs/openpgpjs/wiki/V5-Changelog) and [documentation](https://github.com/openpgpjs/openpgpjs#documentation).
|
||||
|
|
6100
vendors/openpgp-5/dist/openpgp.js
vendored
6100
vendors/openpgp-5/dist/openpgp.js
vendored
File diff suppressed because it is too large
Load diff
Loading…
Reference in a new issue