https://github.com/questnetwork/quest-crypto-js
Crypto For The Quest Network
https://github.com/questnetwork/quest-crypto-js
Last synced: about 1 year ago
JSON representation
Crypto For The Quest Network
- Host: GitHub
- URL: https://github.com/questnetwork/quest-crypto-js
- Owner: QuestNetwork
- License: agpl-3.0
- Created: 2020-09-17T16:32:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-20T18:13:22.000Z (over 5 years ago)
- Last Synced: 2025-03-13T23:16:12.343Z (over 1 year ago)
- Language: JavaScript
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quest Crypto JS
> Shared Crypto Interface For The Quest Network
## Lead Maintainer
[StationedInTheField](https://github.com/StationedInTheField)
## Description
The Crypto class for the [Quest Network Operating System](https://github.com/QuestNetwork/quest-os-js) offers shared crypto functionality.
## Installation & Usage
```
npm install @questnetwork/quest-utilities-js@0.9.4
```
## API
### aes
#### generatePassphrase(length)
Returns a new secure AES passphrase.
```javascript
let pwd = .crypto.aes.generatePassphrase(length);
```
#### hashSecret(message,newSecret, rounds = 10)
Hashes a secret for the specified amount of rounds, anything below 5000 rounds will default to 5000.
```javascript
let hashed = .crypto.aes.hashSecret(message,newSecret, rounds = 10);
```
#### encrypt(utf8OrObject, whistle = undefined)
Encrypts an object or utf8 string either with the whistle supplied or with a generated new whistle.
Returns Base64.
```javascript
let { secret, aesEncryptedB64 } = .crypto.aes.encrypt('test');
```
#### decryptB64(aesEncryptedB64, secret, format = 'utf8')
Decrypts a B64 string with the whistle
Returns String or Object.
```javascript
let { secret, aesEncryptedB64 } = .crypto.aes.decryptB64(aesEncryptedB64, secret, format = 'utf8')
```
#### decryptHex(enc,secret, format = 'utf8'
Decrypts a Hex string with the whistle
Returns String or Object.
```javascript
let { secret, aesEncryptedB64 } = .crypto.aes.decryptHex(aesEncryptedHex, secret, format = 'utf8')
```
### convert
#### stringToArrayBuffer(string,format)
Returns an ArrayBuffer of the input string.
```javascript
let aB = .crypto.convert.stringToArrayBuffer(string,'utf8');
```
#### bufferToArrayBuffer(buf)
Returns an ArrayBuffer of the input butter
```javascript
let hashed = .crypto.convert.bufferToArrayBuffer(buf);
```
#### async importKey(alg,format,keyenc,key)
Imports a key for WebCrypto.
```javascript
await .crypto.convert.importKey(alg,format,keyenc,key);
```
### ec
#### async digest(algo,data)
Digests data using the supplied algorithm.
```javascript
let digest = await .crypto.ec.digest('SHA-256',data);
```
#### async generateKeyPair()
Generates an EC keypair with maximum security according to the Quest Network protocol.
```javascript
let keys = await .crypto.ec.generateKeyPair();
```
#### async sign(obj, keyHex)
Signs an object with an EC private Hex key according to the Quest Network protocol.
```javascript
let signedObject = await .crypto.ec.sign(obj,keyHex);
```
#### verify(obj, keyHex)
Verifies a signed object with an EC public Hex key according to the Quest Network protocol.
```javascript
if(await .crypto.ec.verify(obj,keyHex)){
console.log('Signature Checks Out!');
}
```
### rsa
#### async generateKeyPair()
Generates an RSA keypair with maximum security according to the Quest Network protocol.
```javascript
let keys = await .crypto.rsa.generateKeyPair();
```
#### async fullEncrypt(plain,pubKey)
Encrypts a string with an RSA private key
```javascript
let encrypted = await .crypto.rsa.fullEncrypt(plain,pubKey);
```
#### async fullDecrypt(enc,pk)
Decrypts a string with an RSA public key
```javascript
let decrypted = await .crypto.rsa.fullDecrypt(encrypted,pk);
```
## Support Us
Please consider supporting us, so that we can build a non-profit for this project (ツ)
| Ethereum| Bitcoin |
|---|---|
| `0xBC2A050E7B87610Bc29657e7e7901DdBA6f2D34E` | `bc1qujrqa3s34r5h0exgmmcuf8ejhyydm8wwja4fmq` |
| 
| 
|
## License
GNU AGPLv3