Narnia's Poofy Meatcleaver

    kyber-node

    0.1.3 • Public • Published

    kyber-node

    A sample library for implementing encryption and decryption with CRYSTALS-Kyber in Node.js. CRYSTALS-Kyber is on the standardization track as part of NIST's Post-Quantum Cryptography project.

    This project was implemented as a proof-of-concept for Evervault.

    This project was bootstrapped by create-neon.

    Installing kyber-node from npm

    Installing kyber-node requires a supported version of Node and Rust.

    You can install the project with npm. In the project directory, run:

    $ npm install kyber-node

    This fully installs the project, including installing any dependencies and running the build.

    Building kyber-node

    If you have already installed the project and only want to run the build, run:

    $ npm run build

    This command uses the cargo-cp-artifact utility to run the Rust build and copy the built library into ./index.node.

    Exploring kyber-node

    After building kyber-node, you can explore its exports at the Node REPL:

    $ npm install
    $ node
    > require('.').encrypt("Hello, world!")
    "ev:pq:Uznds/JrabXgAUPz:7aTkgHZ8Qr/LI3Em9fWuKRm9dEDRoa4HT/d9uKcKnbPSDpNSDK25LKBCqAucg6Cy/ttpvrcOlA8dWK235R1M83h+eNJzwxf5X/cmCJ3XFJu99xVMkCs+FlUVOuuHSQganq4KE07AaZOa71ChGje8OJU/dA777djZkCq8k7fvuD7umpSVVBOHg8IihkGaVgbMnGr/lxAp6jlUQhGcUwwvSuECT+r+pqCTbNnRyg+qf69USr9c8TJuu3A2DiBgKNHyG/FnOiBkTPcn9PKZb/CBCCCcJ3AmqD0dOKaC+EmyC/P9o+eyfENqqdluoLYhqcZE/25BcbPy7/5Exgi+uRycMDf5FmczxdexkxKRKDsp+hurfm4uIFAxjVbcYPpnYLu9gQpjiRau+1QuC9eJC38K+bAL66NWL89CsULGNkqYdX1co4OGuIZTJupwi6ZYUmkSTen61RHdt+nleuqsDXCHrOCtIfqNhF5oYmQczaxE0AG06obcvPChUe0YJxV+ZV/ifyMdzTPfrmo7aNcA8Sx3Qv/6LCZtZtLCrtIMy3uy7GBs/TEfHSjB9LBZToEilmuA/RQK9h7TFxovze9EqDBJC4Uu0NcON2wab2kHlXj4pcfeWX6qKeb/ZIiBqLigkUA1HeozB4Av6w+imhi9dxV5cc+OW9DtuAgZCeK51p8NrORepaLyaJGRj2tplD9HpLoKbkIT89uMf6CWISu2smw2OBJqRkNHwUX++LijAld80MoA/obpy/cFegJhzQdGueZGuQSRVR/TfwWILAXbGuf8H8EkwfK/S9gC+c6R7NuoT80Bg3Suaqn3D4GVwKD+OMSaFUIABEZG8BCEovqvGCC8B9GXFb8uIMksje+6pGlSu2M0c59xLmwj31LF9t0oc62psI+MaNYsWf5CKAMEizffc1hLGmVDRmBvp/d+eOtNJYQhtmEVUbdF/Agx2v5Ec3591Cc+sDngkztMAmQGf7h7jhipU0BXz2ZptqbmAzonaeX+FKY6ZIfXxuS4SKQeWhtv:GsLWJKx3nddj6bzo54xUMjOz1Eb1vnQac1HjK8E=:$"

    Available Scripts

    In the project directory, you can run:

    npm install

    Installs the project, including running npm run build.

    npm build

    Builds the Node addon (index.node) from source.

    Additional cargo build arguments may be passed to npm build and npm build-* commands. For example, to enable a cargo feature:

    npm run build -- --feature=beetle
    

    npm build-debug

    Alias for npm build.

    npm build-release

    Same as npm build but, builds the module with the release profile. Release builds will compile slower, but run faster.

    npm test

    Runs the unit tests by calling cargo test.

    Project Layout

    The directory structure of this project is:

    kyber-node/
    ├── Cargo.toml
    ├── README.md
    ├── index.node
    ├── package.json
    ├── src/
    |   └── lib.rs
    └── target/
    

    Cargo.toml

    The Cargo manifest file, which informs the cargo command.

    README.md

    This file.

    index.node

    The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the "main" key in package.json.

    Under the hood, a Node addon is a dynamically-linked shared object. The "build" script produces this file by copying it from within the target/ directory, which is where the Rust build produces the shared object.

    package.json

    The npm manifest file, which informs the npm command.

    src/

    The directory tree containing the Rust source code for the project.

    src/lib.rs

    The Rust library's main module.

    target/

    Binary artifacts generated by the Rust build.

    Learn More

    To learn more about Neon, see the Neon documentation.

    To learn more about Rust, see the Rust documentation.

    To learn more about Node, see the Node documentation.

    To learn more about Evervault, see the Evervault documentation.

    Keywords

    none

    Install

    npm i kyber-node

    DownloadsWeekly Downloads

    6

    Version

    0.1.3

    License

    ISC

    Unpacked Size

    591 kB

    Total Files

    8

    Last publish

    Collaborators

    • narruc