https://github.com/pedrouid/eccrypto-js

Elliptic curve cryptography library (NodeJS, Browser and Pure JS)
https://github.com/pedrouid/eccrypto-js

Last synced: about 2 months ago
JSON representation

Elliptic curve cryptography library (NodeJS, Browser and Pure JS)

• Host: GitHub
• URL: https://github.com/pedrouid/eccrypto-js
• Owner: pedrouid
• License: mit
• Created: 2020-02-03T20:36:38.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-01T04:22:07.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T12:47:15.603Z (3 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/eccrypto-js
• Size: 2.17 MB
• Stars: 28
• Watchers: 5
• Forks: 11
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eccrypto-js [![npm version](https://badge.fury.io/js/eccrypto-js.svg)](https://badge.fury.io/js/eccrypto-js)

Elliptic curve cryptography library (NodeJS, Browser and Pure JS)

## Description

This library is a port from [eccrypto](https://github.com/bitchan/eccrypto) it makes use of native libraries on NodeJS and Browser enviroments with pure javascript fallbacks.

## Usage

### RandomBytes

```typescript

import * as eccryptoJS from 'eccrypto-js';

const length = 32;

const key = eccryptoJS.randomBytes(length);

// key.length === length

```

### AES

```typescript

import * as eccryptoJS from 'eccrypto-js';

const key = eccryptoJS.randomBytes(32);

const iv = eccryptoJS.randomBytes(16);

const str = 'test message to encrypt';

const msg = eccryptoJS.utf8ToBuffer(str);

const ciphertext = await eccryptoJS.aesCbcEncrypt(iv, key, msg);

const decrypted = await eccryptoJS.aesCbcDecrypt(iv, key, ciphertext);

// decrypted.toString() === str

```

### HMAC

```typescript

import * as eccryptoJS from 'eccrypto-js';

const key = eccryptoJS.randomBytes(32);

const iv = eccryptoJS.randomBytes(16);

const macKey = eccryptoJS.concatBuffers(iv, key);

const dataToMac = eccryptoJS.concatBuffers(iv, key, msg);

const mac = await eccryptoJS.hmacSha256Sign(macKey, dataToMac);

const result = await eccryptoJS.hmacSha256Verify(macKey, dataToMac, mac);

// result will return true if match

```

### SHA2

```typescript

import * as eccryptoJS from 'eccrypto-js';

// SHA256

const str = 'test message to hash';

const msg = eccryptoJS.utf8ToBuffer(str);

const hash = await eccryptoJS.sha256(str);

// SHA512

const str = 'test message to hash';

const msg = eccryptoJS.utf8ToBuffer(str);

const hash = await eccryptoJS.sha512(str);

```

### SHA3

```typescript

import * as eccryptoJS from 'eccrypto-js';

// SHA3

const str = 'test message to hash';

const msg = eccryptoJS.utf8ToBuffer(str);

const hash = await eccryptoJS.sha3(str);

// KECCAK256

const str = 'test message to hash';

const msg = eccryptoJS.utf8ToBuffer(str);

const hash = await eccryptoJS.keccak256(str);

```

### ECDSA

```typescript

import * as eccryptoJS from 'eccrypto-js';

const keyPair = eccryptoJS.generateKeyPair();

const str = 'test message to hash';

const msg = eccryptoJS.utf8ToBuffer(str);

const hash = await eccryptoJS.sha256(str);

const sig = await eccryptoJS.sign(keyPair.privateKey, hash);

await eccryptoJS.verify(keyPair.publicKey, msg, sig);

// verify will throw if signature is BAD

```

### ECDH

```typescript

import * as eccryptoJS from 'eccrypto-js';

const keyPairA = eccryptoJS.generateKeyPair();

const keyPairB = eccryptoJS.generateKeyPair();

const sharedKey1 = await eccryptoJS.derive(

  keyPairA.privateKey,

  keyPairB.publicKey

);

const sharedKey2 = await eccryptoJS.derive(

  keyPairB.privateKey,

  keyPairA.publicKey

);

// sharedKey1.toString('hex') === sharedKey2.toString('hex')

```

### ECIES

```typescript

import * as eccryptoJS from 'eccrypto-js';

const keyPair = eccryptoJS.generateKeyPair();

const str = 'test message to encrypt';

const msg = eccryptoJS.utf8ToBuffer(str);

const encrypted = await eccryptoJS.encrypt(keyPairB.publicKey, msg);

const decrypted = await eccryptoJS.decrypt(keyPairB.privateKey, encrypted);

// decrypted.toString() === str

```

### PBKDF2

```typescript

import * as eccryptoJS from 'eccrypto-js';

const password = 'password';

const buffer = eccryptoJS.utf8ToBuffer(str);

const key = await eccryptoJS.pbkdf2(buffer);

// key.length === 32

```

## React-Native Support

This library is intended for use in a Browser or NodeJS environment, however it is possible to use in a React-Native environment if NodeJS modules are polyfilled with `react-native-crypto`, read more [here](https://github.com/tradle/react-native-crypto).

## License

[MIT License](LICENSE.md)