Skip to content

WebCrypt stateless session utility using signed and encrypted cookies to store data greatly influenced from @vvo/iron-session.

Notifications You must be signed in to change notification settings

toyamarinyon/webcrypt-session

Repository files navigation

WebCrypt Session

demo: https://webcrypt-session.sat0shi.workers.dev/

🛠 Stateless session utility using signed and encrypted cookies to store data. Works with WebCrypt API on Cloudflare Workers.

Features

  • 🧙‍♂️ TypeSafe - Written in 100% TypeScript.
  • 📝 With Scheme - You can define the session scheme and you can use static typesafty & autocommpletion for the session.
  • 🍃 Light - No database required. (You don't need to use CloudFlare R2 or CloudFlare DurableObjects)

How to use

See the ./examples for more practical examples.

Install

pnpm add webcrypt-session
npm i webcrypt-session
yarn add webcrypt-session

Basic Usage

import { createWebCryptSession } from "webcrypt-session";
import { z } from "zod";

const sessionScheme = z.object({
  username: z.string(),
});
export default {
  async fetch(request: Request): Promise<Response> {
    const webCryptSession = await createWebCryptSession(
      sessionScheme,
      request,
      {
        password: "IF4B#t69!WlX$uS22blaxDvzJJ%$vEh%",
      }
    );
    return new Response(`Hello ${webCryptSession.username}`, {
      headers: {
        "Set-Cookie": webCryptSession.toHeaderValue(),
      },
    });
  },
};

Acknowledgment

This package is greatly influenced by iron-session developed by @vvoyer. iron-session is quite cool library that it allows to manage a stateless session.

I'd like to use iron-session on CloudFlare worker, but it could not run it because it requires Node.js runtime.

So, I started to develop a library that it allows to manage a stateless session on Cloudflare Worker, using iron-session's api design and implementation as a reference.

About

WebCrypt stateless session utility using signed and encrypted cookies to store data greatly influenced from @vvo/iron-session.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published