From b094274d98104e368a9236b8536fdd2503b58b08 Mon Sep 17 00:00:00 2001 From: larabr <7375870+larabr@users.noreply.github.com> Date: Wed, 17 May 2023 13:42:25 +0200 Subject: [PATCH] Remove @private JSDoc directives interfering with TS --- src/crypto/aes_kw.js | 1 - src/crypto/cipher/index.js | 1 - src/crypto/crypto.js | 1 - src/crypto/hash/index.js | 1 - src/crypto/hkdf.js | 1 - src/crypto/index.js | 1 - src/crypto/mode/cfb.js | 1 - src/crypto/mode/gcm.js | 1 - src/crypto/mode/ocb.js | 1 - src/crypto/pkcs1.js | 1 - src/crypto/public_key/dsa.js | 1 - src/crypto/public_key/elgamal.js | 1 - src/crypto/public_key/elliptic/ecdh.js | 1 - src/crypto/public_key/elliptic/ecdh_x.js | 1 - src/crypto/public_key/elliptic/ecdsa.js | 1 - src/crypto/public_key/elliptic/eddsa.js | 1 - src/crypto/public_key/elliptic/eddsa_legacy.js | 1 - src/crypto/public_key/elliptic/index.js | 1 - src/crypto/public_key/elliptic/indutnyKey.js | 1 - src/crypto/public_key/elliptic/oid_curves.js | 1 - src/crypto/public_key/index.js | 1 - src/crypto/public_key/prime.js | 1 - src/crypto/public_key/rsa.js | 1 - src/crypto/random.js | 1 - src/crypto/signature.js | 1 - src/encoding/base64.js | 1 - src/key/helper.js | 1 - src/key/user.js | 1 - src/packet/packet.js | 1 - src/type/ecdh_symkey.js | 1 - src/type/keyid.js | 1 - src/type/oid.js | 1 - src/type/s2k/generic.js | 1 - src/util.js | 1 - 34 files changed, 34 deletions(-) diff --git a/src/crypto/aes_kw.js b/src/crypto/aes_kw.js index d9bbbb3e..e747ecc3 100644 --- a/src/crypto/aes_kw.js +++ b/src/crypto/aes_kw.js @@ -19,7 +19,6 @@ * @fileoverview Implementation of RFC 3394 AES Key Wrap & Key Unwrap funcions * @see module:crypto/public_key/elliptic/ecdh * @module crypto/aes_kw - * @private */ import * as cipher from './cipher'; diff --git a/src/crypto/cipher/index.js b/src/crypto/cipher/index.js index 4f96ef38..d40c8e08 100644 --- a/src/crypto/cipher/index.js +++ b/src/crypto/cipher/index.js @@ -1,7 +1,6 @@ /** * @fileoverview Symmetric cryptography functions * @module crypto/cipher - * @private */ import aes from './aes'; diff --git a/src/crypto/crypto.js b/src/crypto/crypto.js index 0cb86be1..aa6e6f34 100644 --- a/src/crypto/crypto.js +++ b/src/crypto/crypto.js @@ -21,7 +21,6 @@ * @fileoverview Provides functions for asymmetric encryption and decryption as * well as key generation and parameter handling for all public-key cryptosystems. * @module crypto/crypto - * @private */ import publicKey from './public_key'; diff --git a/src/crypto/hash/index.js b/src/crypto/hash/index.js index 0765881e..d5752841 100644 --- a/src/crypto/hash/index.js +++ b/src/crypto/hash/index.js @@ -3,7 +3,6 @@ * @see {@link https://github.com/asmcrypto/asmcrypto.js|asmCrypto} * @see {@link https://github.com/indutny/hash.js|hash.js} * @module crypto/hash - * @private */ import { Sha1 } from '@openpgp/asmcrypto.js/dist_es8/hash/sha1/sha1'; diff --git a/src/crypto/hkdf.js b/src/crypto/hkdf.js index a14d751c..cf531aed 100644 --- a/src/crypto/hkdf.js +++ b/src/crypto/hkdf.js @@ -1,7 +1,6 @@ /** * @fileoverview This module implements HKDF using either the WebCrypto API or Node.js' crypto API. * @module crypto/hkdf - * @private */ import enums from '../enums'; diff --git a/src/crypto/index.js b/src/crypto/index.js index ab6b166a..460140c1 100644 --- a/src/crypto/index.js +++ b/src/crypto/index.js @@ -7,7 +7,6 @@ * @see module:crypto/random * @see module:crypto/hash * @module crypto - * @private */ import * as cipher from './cipher'; diff --git a/src/crypto/mode/cfb.js b/src/crypto/mode/cfb.js index e16f88b6..a1bdb526 100644 --- a/src/crypto/mode/cfb.js +++ b/src/crypto/mode/cfb.js @@ -19,7 +19,6 @@ /** * @module crypto/mode/cfb - * @private */ import { AES_CFB } from '@openpgp/asmcrypto.js/dist_es8/aes/cfb'; diff --git a/src/crypto/mode/gcm.js b/src/crypto/mode/gcm.js index 25c7a059..c5b5e332 100644 --- a/src/crypto/mode/gcm.js +++ b/src/crypto/mode/gcm.js @@ -19,7 +19,6 @@ * @fileoverview This module wraps native AES-GCM en/decryption for both * the WebCrypto api as well as node.js' crypto api. * @module crypto/mode/gcm - * @private */ import { AES_GCM } from '@openpgp/asmcrypto.js/dist_es8/aes/gcm'; diff --git a/src/crypto/mode/ocb.js b/src/crypto/mode/ocb.js index 868b0ebc..3cd1926c 100644 --- a/src/crypto/mode/ocb.js +++ b/src/crypto/mode/ocb.js @@ -18,7 +18,6 @@ /** * @fileoverview This module implements AES-OCB en/decryption. * @module crypto/mode/ocb - * @private */ import * as ciphers from '../cipher'; diff --git a/src/crypto/pkcs1.js b/src/crypto/pkcs1.js index db981322..229081e8 100644 --- a/src/crypto/pkcs1.js +++ b/src/crypto/pkcs1.js @@ -21,7 +21,6 @@ * @see module:crypto/public_key/elliptic/ecdh * @see PublicKeyEncryptedSessionKeyPacket * @module crypto/pkcs1 - * @private */ import { getRandomBytes } from './random'; diff --git a/src/crypto/public_key/dsa.js b/src/crypto/public_key/dsa.js index 7fa69649..286adb64 100644 --- a/src/crypto/public_key/dsa.js +++ b/src/crypto/public_key/dsa.js @@ -18,7 +18,6 @@ /** * @fileoverview A Digital signature algorithm implementation * @module crypto/public_key/dsa - * @private */ import { getRandomBigInteger } from '../random'; import util from '../../util'; diff --git a/src/crypto/public_key/elgamal.js b/src/crypto/public_key/elgamal.js index bcd41efe..2f69e6f0 100644 --- a/src/crypto/public_key/elgamal.js +++ b/src/crypto/public_key/elgamal.js @@ -18,7 +18,6 @@ /** * @fileoverview ElGamal implementation * @module crypto/public_key/elgamal - * @private */ import util from '../../util'; diff --git a/src/crypto/public_key/elliptic/ecdh.js b/src/crypto/public_key/elliptic/ecdh.js index 11238f71..e37fb633 100644 --- a/src/crypto/public_key/elliptic/ecdh.js +++ b/src/crypto/public_key/elliptic/ecdh.js @@ -18,7 +18,6 @@ /** * @fileoverview Key encryption and decryption for RFC 6637 ECDH * @module crypto/public_key/elliptic/ecdh - * @private */ import nacl from '@openpgp/tweetnacl/nacl-fast-light'; diff --git a/src/crypto/public_key/elliptic/ecdh_x.js b/src/crypto/public_key/elliptic/ecdh_x.js index 3b66c0c0..1e0b3861 100644 --- a/src/crypto/public_key/elliptic/ecdh_x.js +++ b/src/crypto/public_key/elliptic/ecdh_x.js @@ -1,7 +1,6 @@ /** * @fileoverview Key encryption and decryption for RFC 6637 ECDH * @module crypto/public_key/elliptic/ecdh - * @private */ import nacl from '@openpgp/tweetnacl/nacl-fast-light'; diff --git a/src/crypto/public_key/elliptic/ecdsa.js b/src/crypto/public_key/elliptic/ecdsa.js index a11e49c2..19412aa1 100644 --- a/src/crypto/public_key/elliptic/ecdsa.js +++ b/src/crypto/public_key/elliptic/ecdsa.js @@ -18,7 +18,6 @@ /** * @fileoverview Implementation of ECDSA following RFC6637 for Openpgpjs * @module crypto/public_key/elliptic/ecdsa - * @private */ import enums from '../../../enums'; diff --git a/src/crypto/public_key/elliptic/eddsa.js b/src/crypto/public_key/elliptic/eddsa.js index e38cbb96..413f967f 100644 --- a/src/crypto/public_key/elliptic/eddsa.js +++ b/src/crypto/public_key/elliptic/eddsa.js @@ -18,7 +18,6 @@ /** * @fileoverview Implementation of EdDSA following RFC4880bis-03 for OpenPGP * @module crypto/public_key/elliptic/eddsa - * @private */ import sha512 from 'hash.js/lib/hash/sha/512'; diff --git a/src/crypto/public_key/elliptic/eddsa_legacy.js b/src/crypto/public_key/elliptic/eddsa_legacy.js index 63929ea7..726d7ce0 100644 --- a/src/crypto/public_key/elliptic/eddsa_legacy.js +++ b/src/crypto/public_key/elliptic/eddsa_legacy.js @@ -19,7 +19,6 @@ * @fileoverview Implementation of legacy EdDSA following RFC4880bis-03 for OpenPGP. * This key type has been deprecated by the crypto-refresh RFC. * @module crypto/public_key/elliptic/eddsa_legacy - * @private */ import sha512 from 'hash.js/lib/hash/sha/512'; diff --git a/src/crypto/public_key/elliptic/index.js b/src/crypto/public_key/elliptic/index.js index 562918b9..61a75a23 100644 --- a/src/crypto/public_key/elliptic/index.js +++ b/src/crypto/public_key/elliptic/index.js @@ -22,7 +22,6 @@ * @see module:crypto/public_key/elliptic/ecdsa * @see module:crypto/public_key/elliptic/eddsa * @module crypto/public_key/elliptic - * @private */ import { CurveWithOID, generate, getPreferredHashAlgo } from './oid_curves'; diff --git a/src/crypto/public_key/elliptic/indutnyKey.js b/src/crypto/public_key/elliptic/indutnyKey.js index aa7565c5..ddfc6aa7 100644 --- a/src/crypto/public_key/elliptic/indutnyKey.js +++ b/src/crypto/public_key/elliptic/indutnyKey.js @@ -18,7 +18,6 @@ /** * @fileoverview Wrapper for a KeyPair of an curve from indutny/elliptic library * @module crypto/public_key/elliptic/indutnyKey - * @private */ import config from '../../../config'; diff --git a/src/crypto/public_key/elliptic/oid_curves.js b/src/crypto/public_key/elliptic/oid_curves.js index e8d563ef..dab26436 100644 --- a/src/crypto/public_key/elliptic/oid_curves.js +++ b/src/crypto/public_key/elliptic/oid_curves.js @@ -18,7 +18,6 @@ /** * @fileoverview Wrapper of an instance of an Elliptic Curve * @module crypto/public_key/elliptic/curve - * @private */ import nacl from '@openpgp/tweetnacl/nacl-fast-light'; diff --git a/src/crypto/public_key/index.js b/src/crypto/public_key/index.js index 94714eb4..ac34ab76 100644 --- a/src/crypto/public_key/index.js +++ b/src/crypto/public_key/index.js @@ -1,7 +1,6 @@ /** * @fileoverview Asymmetric cryptography functions * @module crypto/public_key - * @private */ import nacl from '@openpgp/tweetnacl/nacl-fast-light'; diff --git a/src/crypto/public_key/prime.js b/src/crypto/public_key/prime.js index 3755d08e..a7b7cba0 100644 --- a/src/crypto/public_key/prime.js +++ b/src/crypto/public_key/prime.js @@ -18,7 +18,6 @@ /** * @fileoverview Algorithms for probabilistic random prime generation * @module crypto/public_key/prime - * @private */ import util from '../../util'; diff --git a/src/crypto/public_key/rsa.js b/src/crypto/public_key/rsa.js index 2b24a152..0a17ff06 100644 --- a/src/crypto/public_key/rsa.js +++ b/src/crypto/public_key/rsa.js @@ -18,7 +18,6 @@ /** * @fileoverview RSA implementation * @module crypto/public_key/rsa - * @private */ import { randomProbablePrime } from './prime'; diff --git a/src/crypto/random.js b/src/crypto/random.js index 022bb4aa..ffef7d65 100644 --- a/src/crypto/random.js +++ b/src/crypto/random.js @@ -20,7 +20,6 @@ /** * @fileoverview Provides tools for retrieving secure randomness from browsers or Node.js * @module crypto/random - * @private */ import util from '../util'; diff --git a/src/crypto/signature.js b/src/crypto/signature.js index b4d2aed3..00c7086c 100644 --- a/src/crypto/signature.js +++ b/src/crypto/signature.js @@ -1,7 +1,6 @@ /** * @fileoverview Provides functions for asymmetric signing and signature verification * @module crypto/signature - * @private */ import publicKey from './public_key'; diff --git a/src/encoding/base64.js b/src/encoding/base64.js index dfea632d..ee95d56b 100644 --- a/src/encoding/base64.js +++ b/src/encoding/base64.js @@ -13,7 +13,6 @@ /** * @module encoding/base64 - * @private */ import * as stream from '@openpgp/web-stream-tools'; diff --git a/src/key/helper.js b/src/key/helper.js index 05a83331..a8bc7cf9 100644 --- a/src/key/helper.js +++ b/src/key/helper.js @@ -1,7 +1,6 @@ /** * @fileoverview Provides helpers methods for key module * @module key/helper - * @private */ import { diff --git a/src/key/user.js b/src/key/user.js index c1e22eb0..49159c5a 100644 --- a/src/key/user.js +++ b/src/key/user.js @@ -1,6 +1,5 @@ /** * @module key/User - * @private */ import enums from '../enums'; diff --git a/src/packet/packet.js b/src/packet/packet.js index b42e4edf..c40082f5 100644 --- a/src/packet/packet.js +++ b/src/packet/packet.js @@ -18,7 +18,6 @@ /** * @fileoverview Functions for reading and writing packets * @module packet/packet - * @private */ import * as stream from '@openpgp/web-stream-tools'; diff --git a/src/type/ecdh_symkey.js b/src/type/ecdh_symkey.js index 71d05983..e23fdd84 100644 --- a/src/type/ecdh_symkey.js +++ b/src/type/ecdh_symkey.js @@ -19,7 +19,6 @@ * Encoded symmetric key for ECDH (incl. legacy x25519) * * @module type/ecdh_symkey - * @private */ import util from '../util'; diff --git a/src/type/keyid.js b/src/type/keyid.js index 2abf6ae0..76da3e00 100644 --- a/src/type/keyid.js +++ b/src/type/keyid.js @@ -17,7 +17,6 @@ /** * @module type/keyid - * @private */ import util from '../util'; diff --git a/src/type/oid.js b/src/type/oid.js index 20278c8a..370f583a 100644 --- a/src/type/oid.js +++ b/src/type/oid.js @@ -30,7 +30,6 @@ * is constructed by omitting the first two octets. Only the truncated * sequence of octets is the valid representation of a curve OID. * @module type/oid - * @private */ import util from '../util'; diff --git a/src/type/s2k/generic.js b/src/type/s2k/generic.js index ab9b2855..76b81f5b 100644 --- a/src/type/s2k/generic.js +++ b/src/type/s2k/generic.js @@ -25,7 +25,6 @@ * private keyring, and to convert passphrases to encryption keys for * symmetrically encrypted messages. * @module type/s2k - * @private */ import defaultConfig from '../../config'; diff --git a/src/util.js b/src/util.js index 255d020f..47a02f95 100644 --- a/src/util.js +++ b/src/util.js @@ -20,7 +20,6 @@ /** * This object contains utility functions * @module util - * @private */ import * as stream from '@openpgp/web-stream-tools';