Giter Club home page Giter Club logo

fernet-web's Introduction

Fernet Encryption Library for Web Crypto API

This library provides an implementation of the Fernet symmetric encryption algorithm using the Web Crypto API. Fernet is a simple and secure way to encrypt and decrypt messages using symmetric encryption.

It should be noted that while Fernet encryption can be a secure way to encrypt data, using it in the browser is inhernetly insecure. Since the secret key used for encryption is stored in the client's browser, it can be accessed by anyone with knowledge of how to inspect the page source.

Installation

To use this library, you can install it via npm:

```node
npm install fernet-web
```

Usage

Here is an example of how to use this library to encrypt and decrypt a message:

```typescript 
import Fernet, { InvalidTokenError } from 'fernet';

// Create a new Fernet instance using a secret key
const fernet = await Fernet.create("-lf4DsgLkOaE1GbtIQKNGU1NPQByMDKP2a6Enl9rclE=");

// Encrypt a message
const encryptedToken = await fernet.encrypt("Hello world!");

// Decrypt the encrypted message
const decryptedMessage = await fernet.decrypt(encryptedToken);

// Print the decrypted message
console.log(decryptedMessage); // Hello world!
```

API

Fernet

The Fernet class is used to create and use Fernet encryption instances.

create(secretKey_b64: string | null): Promise<Fernet>

Creates a new instance of the Fernet class with the provided secret key. If secretKey_b64 is null, a new secret key is generated.

Parameters:

  • secretKey_b64: A base64-encoded string representation of the secret key to use. If null, a new secret key will be generated.

Returns:

A promise that resolves with a new Fernet instance.

encrypt(plainText: string): Promise<string>

Encrypt a message into a Fernet token.

Parameters

  • plainText: The message to encrypt.

Returns:

A promise that resolves with a base64-encoded Fernet token.

decrypt(token_b64: string): Promise<string>

Decrypt a Fernet token and return the plain text message.

Parameters

  • token_b64: A base64-encoded Fernet token.

Returns:

The decrypted message as a string.

License

This code is provided as is, without any warranty or guarantees. Use at your own risk.

Author

Written by Rich Miles ([email protected]) on December 05, 2022.

fernet-web's People

Contributors

richmiles avatar

Watchers

 avatar

fernet-web's Issues

Fernet web encryption a zip file

Hello! I had a question,

I was wondering if it was possible to encrypt a zipped file. If so how would you go about it?

Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.