{"_id":"@dennisameling/signal-client","_rev":"1-63b8ee82b94712593b654ac67be884a3","name":"@dennisameling/signal-client","dist-tags":{"latest":"0.6.0"},"versions":{"0.6.0":{"name":"@dennisameling/signal-client","version":"0.6.0","license":"AGPL-3.0-only","main":"node/dist/index.js","types":"node/dist/index.d.ts","scripts":{"install":"node-gyp-build","build":"node-gyp build","tsc":"tsc -b node && yarn cpy node/*.d.ts node/dist/","clean":"rimraf node/dist build prebuilds","test":"electron-mocha --recursive node/dist/test --require source-map-support/register","lint":"cd node && eslint . --ext .js,.jsx,.ts,.tsx","format":"p() { prettier ${@:- --write} package.json '*.js' 'node/**/*.{css,js,json,md,scss,ts,tsx}'; }; p"},"dependencies":{"node-gyp-build":"^4.2.3","uuid":"^8.3.0"},"devDependencies":{"@types/bindings":"^1.3.0","@types/chai":"4.2.15","@types/chai-as-promised":"^7.1.3","@types/mocha":"5.2.7","@types/node":"13.1.8","@types/uuid":"^8.3.0","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0","chai":"4.2.0","chai-as-promised":"^7.1.1","cpy-cli":"^3.0.0","electron":"11.2.3","electron-mocha":"8.1.1","eslint":"^7.12.1","eslint-config-prettier":"6.15.0","eslint-plugin-header":"^3.1.0","eslint-plugin-import":"^2.22.1","eslint-plugin-mocha":"^8.0.0","eslint-plugin-more":"^1.0.0","mocha":"7.1.1","node-gyp":"^7.1.2","prettier":"1.19.1","rimraf":"3.0.1","source-map-support":"^0.5.19","typescript":"3.7.4"},"gitHead":"5ff676208609d826e6858f163786db75bbefac68","description":"libsignal-client contains platform-agnostic APIs useful for Signal client apps, exposed as a Java,\r Swift, or TypeScript library. The underlying implementations are written in Rust:","_id":"@dennisameling/signal-client@0.6.0","_nodeVersion":"14.16.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-DZou3BvFSN9cgOO+pLWOo/XGfnNVylxyC8MapAzzllW36JlLTGenAUr4Sa+U/f1gmndiZdKTcPsnowpVciFngg==","shasum":"9bb05608ebb9a242a0a61f1a551193871fad12ca","tarball":"https://registry.npmjs.org/@dennisameling/signal-client/-/signal-client-0.6.0.tgz","fileCount":16,"unpackedSize":21997217,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgq/m/CRA9TVsSAnZWagAAuFUP/0v+eoXr512HtUXs5Yfs\n+Eq6g4AnMAQDPHkhwo5+ahC7MDXyFR9Ri8VP3L5isfOMz7S60aJqJ8g5+2bA\nRxxsSViGJBDiYap5Xg38KNGBjCfUv0trY/ve3SA4OBxBMiahl2cEUDJQqhtj\netp58RnjEBciQgLxLdk6XkA87T4u1vxoBUcTNaSvc2T0F4fFJqkFDkh4zvvv\ncXkWqkInAhkDVL0wzo/fgfD3EyU/3vPpdjv4O8NYOdrh8hTpVenmmaXauih/\nH43ZSLHEsZRlvhFCY3Ax8Gb0969NT6wN5uTG8hA5SqBN6l3z9O5KpFuUKui5\nfLi3NATU4hxSnovdGCkmX9JVGUbNkpJa7mT8U79Tb30CAVhIWNsZ4JHoy4Oo\ncoFrMG7FZdmrULkiYJti2YItYr27TYsOHmk5P7mf/bHEFuZPeovnlgRERsl9\ntWMPI86x89LbKo2znaLIGtf5+R8cWYdtLaWTAaxjc0IDKacwU+CLjT66Uvdc\nzNv8+fO48y/iYjrGJsMFzRMMseg+xXZDnCUCFFMu6Y0bdo8PXiUUnwwkGC0a\nbvO2Wl9FMw1pkLC17YbHqXnN2YNmnGSmHvDw9m5j/XkUNOjbwFgWxIMaVk+V\njzA18ITWTQJ8ZvGI1d566gH2Y5IMRe3Mx+BSBvfdz1hk6UAiR/m2juDaKb21\nGg2l\r\n=aKXN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC9NS6A/7Ss3bEvjfOABMh39C0ah5tBjKt3NNQgzh1RUAIhAMLJ1zebMUrW5TjXt09v5rKiffkNbO+oSxGZ6zW1IIKb"}]},"_npmUser":{"name":"dennisameling","email":"dennis@dennisameling.nl"},"directories":{},"maintainers":[{"name":"dennisameling","email":"dennis@dennisameling.nl"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/signal-client_0.6.0_1621883326458_0.9604688298570896"},"_hasShrinkwrap":false}},"time":{"created":"2021-05-24T19:08:46.416Z","0.6.0":"2021-05-24T19:08:47.195Z","modified":"2022-04-05T03:45:18.589Z"},"maintainers":[{"name":"dennisameling","email":"dennis@dennisameling.nl"}],"description":"libsignal-client contains platform-agnostic APIs useful for Signal client apps, exposed as a Java,\r Swift, or TypeScript library. The underlying implementations are written in Rust:","license":"AGPL-3.0-only","readme":"# Overview\r\n\r\nlibsignal-client contains platform-agnostic APIs useful for Signal client apps, exposed as a Java,\r\nSwift, or TypeScript library. The underlying implementations are written in Rust:\r\n\r\n- libsignal-protocol: Implements the Signal protocol, including the [Double Ratchet algorithm][]. A\r\n  replacement for [libsignal-protocol-java][] and [libsignal-metadata-java][].\r\n- signal-crypto: Cryptographic primitives such as AES-GCM-SIV. We use [RustCrypto][]'s where we can\r\n  but sometimes have differing needs.\r\n- device-transfer: Support logic for Signal's device-to-device transfer feature.\r\n- poksho: Utilities for implementing zero-knowledge proofs; stands for \"proof-of-knowledge, stateful-hash-object\". See [zkgroup][].\r\n\r\nThis repository is used by the Signal client apps ([Android][], [iOS][], and [Desktop][]). Use\r\noutside of Signal is unsupported. In particular, the products of this repository are the Java,\r\nSwift, and TypeScript libraries that wrap the underlying Rust implementations. Those underlying\r\nimplementations are subject to change without notice, as are the JNI, C, and Node add-on \"bridge\"\r\nlayers.\r\n\r\n[Double Ratchet algorithm]: https://signal.org/docs/\r\n[libsignal-protocol-java]: https://github.com/signalapp/libsignal-protocol-java\r\n[libsignal-metadata-java]: https://github.com/signalapp/libsignal-metadata-java\r\n[RustCrypto]: https://github.com/RustCrypto\r\n[zkgroup]: https://github.com/signalapp/zkgroup\r\n[Android]: https://github.com/signalapp/Signal-Android\r\n[iOS]: https://github.com/signalapp/Signal-iOS\r\n[Desktop]: https://github.com/signalapp/Signal-Desktop\r\n\r\n\r\n# Building\r\n\r\nTo build anything in this repository you must have [Rust](https://rust-lang.org) installed.\r\nThe build currently uses a specific version of the Rust nightly compiler, which\r\nwill be downloaded automatically by cargo. To build and test the basic protocol\r\nlibraries:\r\n\r\n```shell\r\n$ cargo build\r\n...\r\n$ cargo test\r\n...\r\n```\r\n\r\n## Java/Android\r\n\r\nTo build for Android you must install several additional packages including a JDK,\r\nthe Android NDK/SDK, and add the Android targets to the Rust compiler, using\r\n\r\n```rustup target add armv7-linux-androideabi aarch64-linux-android i686-linux-android x86_64-linux-android```\r\n\r\nas well as the Cargo NDK tool using\r\n\r\n```cargo install --version=1.0.0 cargo-ndk```\r\n\r\nTo build the Java/Android ``jar`` and ``aar``, and run the tests:\r\n\r\n```shell\r\n$ cd java\r\n$ ./gradlew test\r\n```\r\n\r\nAlternately, a build system using Docker is available:\r\n\r\n```shell\r\n$ cd java\r\n$ make java_test\r\n```\r\n\r\nLocal Java testing is also supported with `gradlew test` if none of the `ANDROID_*` environment\r\nvariables are set.\r\n\r\nWhen exposing new APIs to Java, you will need to run `rust/bridge/jni/bin/gen_java_decl.py` in\r\naddition to rebuilding.\r\n\r\n\r\n## Swift\r\n\r\nTo learn about the Swift build process see [``swift/README.md``](swift/)\r\n\r\n\r\n## Node\r\n\r\nYou'll need Node installed to build. If you have [nvm][], you can run `nvm use` to select an\r\nappropriate version automatically.\r\n\r\nWe use [`yarn`](https://classic.yarnpkg.com/) as our package manager. The Rust library will automatically be built when you run `yarn install`.\r\n\r\n```shell\r\n$ nvm use\r\n$ yarn install\r\n$ yarn tsc\r\n$ yarn test\r\n```\r\n\r\nWhen testing changes locally, you can use `yarn build` to do an incremental rebuild of the Rust library.\r\n\r\nWhen exposing new APIs to Node, you will need to run `rust/bridge/node/bin/gen_ts_decl.py` in\r\naddition to rebuilding.\r\n\r\n[nvm]: https://github.com/nvm-sh/nvm\r\n\r\n\r\n# Contributions\r\n\r\nSignal does accept external contributions to this project. However unless the change is\r\nsimple and easily understood, for example fixing a bug or portability issue, adding a new\r\ntest, or improving performance, first open an issue to discuss your intended change as not\r\nall changes can be accepted.\r\n\r\nContributions that will not be used directly by one of Signal's official client apps may still be\r\nconsidered, but only if they do not pose an undue maintenance burden or conflict with the goals of\r\nthe project.\r\n\r\nSigning a [CLA (Contributor License Agreement)](https://signal.org/cla/) is required for all contributions.\r\n\r\n# Legal things\r\n## Cryptography Notice\r\n\r\nThis distribution includes cryptographic software. The country in which you currently reside may have restrictions on\r\nthe import, possession, use, and/or re-export to another country, of encryption software.  BEFORE using any encryption\r\nsoftware, please check your country's laws, regulations and policies concerning the import, possession, or use, and\r\nre-export of encryption software, to see if this is permitted.  See <http://www.wassenaar.org/> for more information.\r\n\r\nThe U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as\r\nExport Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing\r\ncryptographic functions with asymmetric algorithms.  The form and manner of this distribution makes it eligible for\r\nexport under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export\r\nAdministration Regulations, Section 740.13) for both object code and source code.\r\n\r\n## License\r\n\r\nCopyright 2020-2021 Signal Messenger, LLC\r\n\r\nLicensed under the AGPLv3: https://www.gnu.org/licenses/agpl-3.0.html\r\n","readmeFilename":"README.md"}