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

rclone

v1.4.0

Published

Decrypt filenames in the browser

Downloads

188

Readme

rclone-js Travis Build Codecov

Pure Javascript implementation of the cipher used in rclone (crypt-mount).

Installation

Node

npm install rclone

Browser

You can find a browser bundle here: https://unpkg.com/rclone/dist/rclone.umd.min.js
Use window.rclone.Rclone to access the constructor function.

Getting Started

Examples

Encrypt/Decrypt Paths

import { Rclone } from 'rclone';

// Create Rclone instance 
Rclone({
    password: 'UmyLSdRHfew6aual28-ggx78qHqSfQ',
    salt: 'Cj3gLa5PVwc2aot0QpKiOZ3YEzs3Sw'
})
.then(rclone => { 
   
  // Decryption
  console.log(
    rclone.Path.decrypt("dk7voi2247uqbgbuh439j13eo0/p0q5lhi767fsplsdjla7j7uv60") // Hello World
  );
  
  // Encryption
  console.log(
    rclone.Path.encrypt("Hello/World") // dk7voi2247uqbgbuh439j13eo0/p0q5lhi767fsplsdjla7j7uv60
  );
  
})
.catch(error => {
  // Catch error creating rclone instance 
})

Decrypt Files

Concept

To decrypt files in the browser rclone-js is using a node concept called Streams in the browser using readable-stream. You can create a decrypting ReadableStream by using the function rclone.File.createReadStream which will take a function that needs to return a ReadableStream representing the decrypted file. To provide random access rclone will pass an options object to the function like used by the node fs module. An important additon to these options is the chunkSize propertie, it is needed because rclone uses a block cipher and can only operate on a integer multiple of this size. These options need to be taken into account for the creation of the underyling ReadableStream returned from the function.

Example

Fetch Stream

Using fetch and range headers to decrypt files from amazon s3