Skip to content

Commit b13d4fc

Browse files
author
John Bland
committed
remove unused files, make tests usable by single require statement, make project usable by single require statement, update README
1 parent 00e46f5 commit b13d4fc

File tree

17 files changed

+128
-1477
lines changed

17 files changed

+128
-1477
lines changed

README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# wolfCrypt Node.JS support
22

3-
Wrappers for wolfCrypt ciphers.
3+
Wrappers for various wolfCrypt functions.
44

55
## Building wolfSSL
66

@@ -20,18 +20,41 @@ Verify the .so (shared object) path and version in `binding.gyp`:
2020
],
2121
```
2222

23+
## Package Installation
24+
2325
Use npm to install and build:
2426

2527
```
2628
npm i
2729
npm run build
28-
node app.js
2930
```
3031

31-
## Example Output
32+
Place the package into your projects `node_modules` folder and require it:
33+
34+
```
35+
mv wolfcrypt_nodejs my_project/node_modules
36+
...
37+
const { wolfcrypt, WolfSSLEncryptionStream } = require( 'wolfcrypt_nodejs' )
38+
```
39+
40+
Alternatively you can require the module by specifying a path to it
3241

3342
```
34-
$ node app.js
43+
const { wolfcrypt, WolfSSLEncryptionStream } = require( 'path-to-library/wolfcrypt_nodejs' )
44+
```
45+
46+
Examples of how to use this library can be found in the tests directory
47+
48+
## Tests Output
49+
50+
```
51+
$ npm run test
52+
PASS ecc makeKey
53+
PASS ecc sharedSecret32
54+
PASS ecc sharedSecret64
55+
PASS ecc signVerify
56+
PASS ecc importExportx963
57+
PASS ecc importExportDer
3558
PASS evp encrypt
3659
PASS evp decrypt
3760
PASS evp encrypt_decrypt_odd
@@ -41,6 +64,12 @@ PASS evp encryptDecryptPipes
4164
PASS hmac hmac
4265
PASS hmac hmacStream
4366
PASS hmac hmacPipe
67+
PASS pbkdf2
68+
PASS pkcs7 addCertificate
69+
PASS pkcs7 encodeData
70+
PASS pkcs7 signVerify
71+
PASS pkcs7 getAttribute
72+
PASS pkcs7 getSid
4473
PASS rsa keyToDer
4574
PASS rsa keyToPublicDer
4675
PASS rsa privateKeyDecode
@@ -54,16 +83,4 @@ PASS sha sha384
5483
PASS sha sha512
5584
PASS sha sha512_224
5685
PASS sha sha512_256
57-
PASS ecc makeKey
58-
PASS ecc sharedSecret32
59-
PASS ecc sharedSecret64
60-
PASS ecc signVerify
61-
PASS ecc importExportx963
62-
PASS ecc importExportDer
63-
PASS pbkdf2
64-
PASS pkcs7 addCertificate
65-
PASS pkcs7 encodeData
66-
PASS pkcs7 signVerify
67-
PASS pkcs7 getAttribute
68-
PASS pkcs7 getSid
6986
```

WolfSSLEVP.js

Lines changed: 0 additions & 227 deletions
This file was deleted.

0 commit comments

Comments
 (0)