# fs-auth

> Auth beyond filesystem

Latest version **0.0.2** (published 2015-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install fs-auth
pnpm add fs-auth
yarn add fs-auth
bun add fs-auth
```

Provides the command `fa`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2015-01-06 |
| First published | 2015-01-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | fritx |
| Keywords | fs, file, auth, crypto, encrypt |

## Links

- npm: https://www.npmjs.com/package/fs-auth
- Repository: git@github.com:fritx/fs-auth
- Homepage: https://github.com/fritx/fs-auth
- Issues: https://github.com/fritx/fs-auth/issues
- npm.io page: https://npm.io/package/fs-auth

## Dependencies (3)

- [glob](https://npm.io/package/glob.md) ^4.3.2
- [async](https://npm.io/package/async.md) ^0.9.0
- [prompt](https://npm.io/package/prompt.md) ^0.2.14

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2015-01-06
- 0.0.1 — 2015-01-06

## README

# fs-auth

Auth beyond filesystem

## Demo

```
$ cat a.txt
> hello啊 world 你是大傻逼123 ahah

$ fa lock *.txt
password> (type one)
$ cat a.txt
> 77de54ccf56eb6f7dbf99e4d3be949ab9e˥ΟFʿ84ݧÓϖXóÔIúèKÚÚF³ëKåô9298i81Ûǟm

$ fa auth *.txt
password> (type randomly)
> [ [ 'a.txt', 'auth fail' ] ]

$ fa auth *.txt
password> (type correctly)
$ cat a.txt
> hello啊 world 你是大傻逼123 ahah
```

## CLI Usage

```
$ npm i -g fs-auth
```

```
$ fa lock *.txt
$ fa auth *.jpg
```

## API Usage

```
$ npm i fs-auth
```

```
var fa = require('fs-auth')
var encryptedBuf = fa.lock(originalBuf, pwd)
var _originalBuf = fs.auth(encryptedBuf, pwd)
```

---
_Source: https://npm.io/package/fs-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._