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

encrypt-cookie

v1.1.5

Published

Node module for encrypted cookies, can be used as middleware for express/socket.io or manually.

Downloads

98

Readme

encrypt-cookie

npm npm code style: prettier TypeScript

Easy to use cookie encryption middleware for express and socket.io

Installation

npm install --save encrypt-cookie
yarn add encrypt-cookie

Features

  • Strong encryption AES 256 GCM
  • Derive unique encryption key for each cookie from master
  • Node.js middleware
  • Socket.io middleware

Node Express middleware

The express middleware automatically encrypts and decrypts the cookies.

import express from 'express';
import cookieParser from 'cookie-parser';
import { encryptCookieNodeMiddleware } from 'encrypt-cookie';

const expressApp = express();
expressApp.use(cookieParser(signatureSecret));
expressApp.use(encryptCookieNodeMiddleware(encryptionSecret));

// Set new cookie as usual
response.cookie(cookieName, cookieValue, cookieOptions);

Socket.io middleware

The middleware for socket.io just parses and decrypts the cookies. Since there exist no HTTP response you can not set any headers to submit new cookie values to the browser. The socket handshake includes the cookie values that exist when the handshake is created. To include newer cookies, you need to reset the socket connection. (Any workaround?)

import socketIO from 'socket.io';
import { decryptCookieSocketMiddleware } from 'encrypt-cookie';

this.httpServer = http.createServer(this.expressApp);
this.socketServer = socketIO(this.httpServer); // often defined as `io`
this.socketServer.use(decryptCookieSocketMiddleware(signatureSecret, encryptionSecret));

Set cookie with socket.io

The new cookie value only remains in the current handshake. It will not be submitted to the browsers cookie cache. The value will be deleted when the handshake is recreated.

cookieOptions will be mostly ignored, because the socked does not include any meta information about the cookies. Currently the only noticed value for cookieOptions is {sign: true} to sign the cookie.

import { setSocketCookie } from 'encrypt-cookie';

const cookieOptions = {sign: true};
setSocketCookie(socket: SocketIO.Socket, signaturePassword: string, cookieName: string, cookieValue: any, cookieOptions: express.CookieOptions): void

Encryption/Decryption methods

You can access the encryption methods to use it anywhere

import { decryptAesGcm, encryptAesGcm } from 'encrypt-cookie';

type Password = string | Buffer | NodeJS.TypedArray | DataView;

decryptAesGcm(cipherText: string, password: Password): string | undefined
encryptAesGcm(plainText: string | object, password: Password): string | undefined