npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

clostridium

v0.0.1

Published

libtorrent node.js bindings

Downloads

1

Readme

Natrium

libsodium node.js bindings

Browser version - link

Install

npm i --save natrium

Requirements

  • Build tools
    • G++ (you can change this to clang++ in node_modules/naio/makefile)
    • Make
    • Node.js/io.js v3.0.0 or newer
    • Npm 3.2.2 or newer
  • Libraries

Building the native module tested only on Linux

Usage

Import / Require

import natrium from 'natrium';
// OR
var natrium = require('natrium').default;

Await the promises!!

The examples below demonstrate the usage with promises. With ecmascript 7, you can await the promises to get the result as in synchronous code. This works for all the code below. To use the await keyword, it must be contained inside an async function.

// Generate a random buffer
let random = await natrium.random(16);
console.log(random);
// <Buffer fa 17 e8 b5 bb e5 72 6b 9d 41 ec 3a 91 97 07 f4>

Random buffers

// Generate a random buffer
natrium.random(16).then(console.log);
// <Buffer fa 17 e8 b5 bb e5 72 6b 9d 41 ec 3a 91 97 07 f4>

// Generate a random buffer with the correct size for a signature seed
natrium.random_seed().then(console.log);
// <Buffer dc 0e 74 90 54 43 10 55 ea 21 96 6c a5 9b 16 59 71 e5 77 e2 ca 04 02 af 05 ed 98 93 29 32 d2 a1>

Encrypt & Decrypt

natrium.box_keypair().then(function (alice) {
    return natrium.box_keypair().then(function (bob) {
        // This generates a shared key, which is the exact same both ways
        // alice.secret, bob.public === bob.secret, alice.public
        return natrium.box_key(alice.secret, bob.public).then(function (key) {
            // DO NOT ever transport the key
            // DO transport alice.public and bob.public

            let message = new Buffer('Drop me from the space!');
            console.log(message);
            // <Buffer 44 72 6f 70 20 6d 65 20 66 72 6f 6d 20 74 68 65 20 73 70 61 63 65 21>

            return natrium.encrypt(key, message).then(function (encrypted) {
                console.log(encrypted);
				// <Buffer 79 17 df 17 fb b0 79 12 e2 55 3a c7 19 85 f7 42 f0 45 a7 6b 3f 9e c3 8f 6d 01 31 1c ea 8c 7f 11 49 8b 01 d9 1f 7b 21 56 3b 13 a4 80 10 2b 35 29 ef bf ... >

                return natrium.decrypt(key, encrypted).then(function (decrypted) {
                    console.log(decrypted);
                    // <Buffer 44 72 6f 70 20 6d 65 20 66 72 6f 6d 20 74 68 65 20 73 70 61 63 65 21>
                });
            });
        });
    });
});

Secret key // Encrypt & Decrypt

natrium.secretbox_key().then(function (key) {
	let message = new Buffer('Drop me from the space!');
	console.log(message);
	// <Buffer 44 72 6f 70 20 6d 65 20 66 72 6f 6d 20 74 68 65 20 73 70 61 63 65 21>

	return natrium.secretbox_encrypt(key, message).then(function (encrypted) {
		console.log(encrypted);
		// <Buffer 03 7d 3f d6 27 cc f2 77 4f cf fe 9c 37 0b 84 cd e6 b9 3a f4 5d 85 f4 bf d9 d4 81 ae d2 1f 84 88 5b 78 fd 7a 6d 89 5c d4 4c fd 70 7d 8c ec a5 26 29 d6 ... >

		return natrium.secretbox_decrypt(key, encrypted).then(function (decrypted) {
			console.log(decrypted);
			// <Buffer 44 72 6f 70 20 6d 65 20 66 72 6f 6d 20 74 68 65 20 73 70 61 63 65 21>
		});
	});
});

Sign & Verify

natrium.new_sign_keypair().then(function (key) {
    // NOTICE key.seed can be saved and later passed
    // to natrium.sign_keypair(key.seed) to generate
    // the exact same key pair.

    let message = new Buffer('I\'m the ROOT... trust me.');
    console.log(message);
    // <Buffer 49 27 6d 20 74 68 65 20 52 4f 4f 54 2e 2e 2e 20 74 72 75 73 74 20 6d 65 2e>

    return natrium.sign(key.secret, message).then(function (signature) {
        console.log(signature);
        // <Buffer 66 5a e8 dc 25 90 e6 ba 3a 75 2e 7a d9 8f 80 8f d1 dd 3a f1 b3 fb 20 90 13 82 3a a8 74 47 aa 20 d5 77 f8 4b 83 5f 15 cc 5f fc 20 66 af ea 11 c5 1f c3 ... >

        return natrium.verify(key.public, signature, message).then(function() {
            // Success! Message verified
            // On fail the error is handled in Promise's catch(), not here
        });
    });
});