https://github.com/madarche/mcf-js

Modular Crypt Format
https://github.com/madarche/mcf-js

Last synced: 2 months ago
JSON representation

Modular Crypt Format

• Host: GitHub
• URL: https://github.com/madarche/mcf-js
• Owner: madarche
• License: mit
• Created: 2015-01-04T20:00:47.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T02:52:38.000Z (about 2 years ago)
• Last Synced: 2024-10-15T16:35:22.694Z (3 months ago)
• Language: JavaScript
• Size: 186 KB
• Stars: 5
• Watchers: 2
• Forks: 15
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

Modular Crypt Format

====================

[![NPM version](http://img.shields.io/npm/v/mcf.svg)](https://www.npmjs.org/package/mcf)

[![Dependency Status](https://david-dm.org/madarche/mcf-js.svg)](https://david-dm.org/madarche/mcf-js)

[![devDependency Status](https://david-dm.org/madarche/mcf-js/dev-status.svg)](https://david-dm.org/madarche/mcf-js#info=devDependencies)

[![Build Status](https://travis-ci.org/madarche/mcf-js.svg?branch=master)](https://travis-ci.org/madarche/mcf-js)

[![Coverage Status](https://coveralls.io/repos/github/madarche/mcf-js/badge.svg?branch=master)](https://coveralls.io/github/madarche/mcf-js?branch=master)

This modules reads (deserialize) and writes (serialize) password fields in

databases following the Modular Crypt Format (MCF).

The modular crypt format (MCF) is a standard for encoding password hash strings

in order to defend a database against attacks (dictionary attacks, pre-computed

rainbow table attacks, etc.).

The Modular Crypt Format is described in detail in

https://passlib.readthedocs.io/en/stable/modular_crypt_format.html

Format

------

A password field in the Modular Crypt Format is of the following form:

    $identifier$cost$salt$derived_key

Install

-------

```shell

npm install mcf

```

API

---

```javascript

deserialize(mcf_field)

```

```javascript

serialize(identifier, cost, salt, derived_key)

```

Usage

-----

Reading the format from the database:

```javascript

const mcf = require('mcf')

let mcf_field = user.get('password')

try {

    let obj = mcf.deserialize(mcf_field)

    let identifier = obj.identifier

    let cost = obj.cost

    let salt = obj.salt

    let derived_key = obj.derived_key

} catch(err) {

    if (err instanceof mcf.McfError) {

        console.log("Format error in the database", err)

    } else {

        console.log("Unexpected fail")

    }

}

```

Creating the format to write in the database:

```javascript

const mcf = require('mcf')

let mcf_field = mcf.serialize('pbkdf2', cost, salt, derived_key)

```

Development

-----------

To run the tests:

```shell

npm test

```

To compute test coverage:

```shell

npm run test:coverage

```

Contributions

-------------

Pull Requests and contributions in general are welcome as long as they follow

the [Node aesthetic].

[Node aesthetic]: http://substack.net/node_aesthetic