Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix genKeyPair() generates not-fully-256bits private key #5

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
dist
78 changes: 9 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,19 @@
# sm.js
# sm-series-crypto

SM series cryptography in javascript implementation.

SM2 signature and SM3 hash are implemented.
SM2 signature, encrypt/decrypt, SM3 hash, SM4 encrypt/decrypted are implemented.

## install
Reference repos:

`sm.js` is available in npm.
[https://github.com/AlverLyu/sm.js](https://github.com/AlverLyu/sm.js)

```sh
npm install sm.js
```

## Usage

### SM2 key pair

Generate a key pair

```js
var sm2 = require('sm.js').sm2;

var key = sm2.genKeyPair();
```

The public key can be converted to a string or a byte array, for storing or
transmitting on network.

```js
var pubKeyString = key.pubToString();
var pubKeyBytes = key.pubToBytes('compress');
```

Note that there are 3 conversion modes: compress, nocompress and mex.
The default mode is nocompress.

To parse the public key string/array, simply use the key pair constructor

```
var key = new sm2.SM2KeyPair(pubKeyString);
```
[https://github.com/JuneAndGreen/sm-crypto](https://github.com/JuneAndGreen/sm-crypto)

[https://github.com/pecliu/gm-crypt](https://github.com/pecliu/gm-crypt)

### SM2 signature
**Currently code needs refactor because the codes are come from three repos,but the function of this repo is complete. I'm going to refactor it using Buffer.**

The key pair can be used to sign message or verify the signature.

```js
var msg = 'abc';
var signature = key.sign(msg);

if (key.verify(msg, signature.r, signature.s)) {
console.log('PASS');
}
```

Note that `key.pri` should not be null when signing, as well as `key.pub` for
verifying.

`sign` will combine the input message with extra infos(a constant ID, the curve
parameters and the public key), and use SM3 as the hash algorithm. While there
is a function pair `signRaw` and `verifyRaw` which do not use the extra infos.
Also there is a function pair `signDigest` and `verifyDigest` use the message
digest as the input, allowing for custom hashing.


### SM3 hash algorithm

The sm3 module is used to generate digest using SM3 hash algorithm.

```js
var sm3 = require('sm.js').sm3;

var msg = 'abc';
var hash = new sm3();
var digest = hash.sum(msg);
```
## Usage

See tests for details.
Loading