https://github.com/constantiner/cram-md5-digest-js

CRAM-MD5 digester implementation in JavaScript
https://github.com/constantiner/cram-md5-digest-js

base64 client-server client-side cryptography digester hash javascript library md5

Last synced: 26 days ago
JSON representation

CRAM-MD5 digester implementation in JavaScript

• Host: GitHub
• URL: https://github.com/constantiner/cram-md5-digest-js
• Owner: Constantiner
• License: mit
• Created: 2018-02-26T21:10:44.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:32:34.000Z (almost 2 years ago)
• Last Synced: 2024-12-02T01:23:46.851Z (about 1 month ago)
• Topics: base64, client-server, client-side, cryptography, digester, hash, javascript, library, md5
• Language: JavaScript
• Size: 1.74 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cram-md5-digest-js

[![Build Status](https://travis-ci.org/Constantiner/cram-md5-digest-js.svg?branch=master)](https://travis-ci.org/Constantiner/cram-md5-digest-js) [![codecov](https://codecov.io/gh/Constantiner/cram-md5-digest-js/branch/master/graph/badge.svg)](https://codecov.io/gh/Constantiner/cram-md5-digest-js)

[CRAM-MD5](https://en.wikipedia.org/wiki/CRAM-MD5) digester implementation in JavaScript with zero dependencies.

It uses a digest string from server and generates a hash using a secret (usually, password).

The library supports converting the resulting hash to Base64-encoded string.

- [Installation](#installation)

- [Changelog](#changelog)

- [Usage](#usage)

- [Documentation](#documentation)

	- [cramMd5Digest](#crammd5digest)

	- [cramMd5DigestBase64](#crammd5digestbase64)

## Installation

```

npm install @constantiner/cram-md5-digest

```

## Changelog

Versions [changelog](CHANGELOG.md).

## Usage

```javascript

import { cramMd5DigestBase64 } from "@constantiner/cram-md5-digest";

cramMd5DigestBase64("voxjx70j131lv9g645j6Znx8535l5Xb1nkl6CF0489lE2Gc^b*H&F5jn", "1$G15/iw");

```

## Documentation

### cramMd5Digest

```javascript

import { cramMd5Digest } from "@constantiner/cram-md5-digest";

```

Generates MD5 hash from `passwordString` and `cramKey`.

It has the following parameters:

* `passwordString` Is a secret (password) to hash (`String`).

* `cramKey` Is a key (digest) to hash password with (`String`).

It returns a 32 symbols length string with calculated hash.

### cramMd5DigestBase64

```javascript

import { cramMd5DigestBase64 } from "@constantiner/cram-md5-digest";

```

Generates MD5 hash from `passwordString` and `cramKey` and encodes it in Base64.

It has the following parameters:

* `passwordString` Is a secret (password) to hash (`String`).

* `cramKey` Is a key (digest) to hash password with (`String`).

* `padding` (optional, default value is `false`) if `true` there is Base64 padding (=) added.

It returns a string with Base64-encoded hash (with padding or not).