Kepler's Key Generation Library
Javascript Library for generating Kepler IDs and Ed25519-based Kepler keys to use with Kepler.
$ yarn add kepler-keys$ npm i kepler-keysvar kKey = require("kepler-keys");
var goKepler = kKey.goKep();
console.log(goKepler);output:
{ kID: '7v4wYLQLoWYc8UzqWn5t5T',
kVKey: '4mbYnygwKEvwSWXoDeFWpSAZWcmst7HUkTzTPAV749KY',
uniKey: 'EL9GJAxDbf86cqZAZ8ySH8Q7hkXkhB1FBSAodKcvU6fS',
secret:
{ kSeed: '0e238e4f6589893e32ac1b84e17e32acd4c510f5c5587462d40b0702b638f4ec',
kSigKey: 'xC9ufU5zsfuSED7VzLbsq15VA8xpJsv5zk21aCkoNzF',
secKey: 'xC9ufU5zsfuSED7VzLbsq15VA8xpJsv5zk21aCkoNzF' } }Generates a new KeplerID, Kepler VKey, Kepler SigKey, and also gives you the Kepler Seed used to generate them. It also includes the public and private key used for encryption.
{
kID: "<base58 did>",
kVKey: "<base58 publicKey>",
kUniKey: "<base58 publicKey>",
secret: {
kSeed: "<hex encoded 32-byte seed>",
kSigKey: "<base58 secretKey>",
kSecKey: "<base58 privateKey>"
}
}Same as .goKep() except you supply the Kepler seed. The seed should be a 32-byte Uint8Array (i.e. Buffer).
Example:
var seed = Buffer.from("0e238e4f6589893e32ac1b84e17e32acd4c510f5c5587462d40b0702b638f4ec", "hex");
var goKepler = kKey.fromKSeed(seed);
console.log(goKepler);
Result:
{ kID: '7v4wYLQLoWYc8UzqWn5t5T',
kVKey: '4mbYnygwKEvwSWXoDeFWpSAZWcmst7HUkTzTPAV749KY',
uniKey: 'EL9GJAxDbf86cqZAZ8ySH8Q7hkXkhB1FBSAodKcvU6fS',
secret:
{ kSeed: '0e238e4f6589893e32ac1b84e17e32acd4c510f5c5587462d40b0702b638f4ec',
kSigKey: 'xC9ufU5zsfuSED7VzLbsq15VA8xpJsv5zk21aCkoNzF',
secKey: 'xC9ufU5zsfuSED7VzLbsq15VA8xpJsv5zk21aCkoNzF' } }The output is the same as the .goKep() example.
Signs a message with the given kSigKey and kVKey.
- The message should be a string.
- Both the kSigKey and kVKey should be the kSigKey and kVKey given from the
goKep()orfromSeed(seed)methods
Returns a signed message as a Uint8Array (i.e. Buffer).
Example:
var kKey = kID.goKep();
var kSigKey = kKey.secret.kSigKey;
var kVKey = kKey.kVKey;
var message = "One giant step.";
var signedMessage = kID.signMessage(message, kSigKey, kVKey);
console.log(signedMessage);Result:
Uint8Array [
138,
81,
246,
216,
169,
233,
24,
198,
215,
169,
186,
1,
91,
69,
248,
185,
254,
241,
186,
87,
62,
75,
236,
20,
215,
204,
125,
45,
17,
186,
125,
227,
155,
60,
220,
181,
200,
227,
246,
24,
153,
214,
131,
49,
238,
182,
242,
156,
161,
115,
173,
163,
180,
81,
9,
1,
85,
196,
121,
185,
17,
180,
73,
2,
79,
110,
101,
32,
103,
105,
97,
110,
116,
32,
115,
116,
101,
112,
46 ]Verifies that the given message has been signed by the possessor of the given keplerVKey.
- The signedMessage should be what is returned from
signMessage(message, keplerSigKey, keplerVKey) - The keplerVKey should be the keplerVKey given from the
goKep()orfromKeplerSeed(seed)methods
Returns the original message if the message was signed by the owner of the keplerVKey false otherwise.
Example:
var kKey = kID.goKep();
var kKey2 = kID.goKep();
var kSigKey = kKey.secret.kSigKey;
var kVKey = kKey.kVKey;
var kVKey = kKey2.kVKey;
var message = "One giant step.";
var signedMessage = kID.signMessage(message, kSigKey, kVKey);
console.log(kID.verifySignedMessage(signedMessage, kVKey));
console.log(kID.verifySignedMessage(signedMessage, kVKey2));Output:
One giant step.
false
Returns a key pair that is valid to use for encrypting.
- The kSigKey should be the kSigKey given from the object given from
goKep()orfromKSeed()
Example:
var kID = require("kepler-keys");
var kKeys = kID.goKep();
var kSigKey = kKeys.secret.kSigKey;
var kKeyPair = kID.getKeyPairFromSignKey(kSigKey);
console.log(kKeyPair);Output:
{ uniKey:
Uint8Array [
50,
111,
225,
48,
221,
247,
136,
248,
1,
33,
161,
20,
22,
108,
219,
254,
152,
95,
17,
245,
241,
168,
189,
117,
200,
251,
175,
40,
89,
223,
3,
84 ],
secKey:
Uint8Array [
105,
239,
239,
152,
27,
246,
151,
16,
29,
94,
193,
138,
215,
178,
239,
89,
198,
113,
112,
212,
43,
147,
234,
160,
158,
105,
215,
160,
104,
228,
36,
129 ] }Returns a random nonce as a Uint8Array that can be used for encrypting.
Example:
var kepNonce = kID.getKNonce();Results:
Uint8Array [
162,
147,
161,
66,
195,
246,
249,
163,
54,
194,
74,
56,
93,
6,
136,
216,
78,
230,
31,
131,
101,
9,
233,
83 ]Computes a sharedSecret to be used for encryption.
- theirKVKey should be the publicKey given from the
getKeyPairFromSignKey(kSigKey)method or the uniKey string given from thegoKep()method. - myKSigKey should be the secretKey given from the
getKeyPairFromSignKey(kSigKey)method or the secKey given from thegoKep()method.
Example:
var k1 = kID.goKep();
var k2 = kID.goKep();
// Using the strings given via the goKep() method
var sharedSecret1 = kID.getSharedSecret(k2.UniKey, k1.secret.SecKey);
var sharedSecret2 = kID.getSharedSecret(k1.UniKey, k2.secret.SecKey);
var kSigKey1 = k1.secret.kSigKey;
var kSigKey2 = k2.secret.kSigKey;
var keyPair1 = kID.getKeyPairFromSignKey(kSigKey1);
var keyPair2 = kID.getKeyPairFromSignKey(kSigKey2);
// Using the buffer given from the getKeyPairFromSignKey(signKey2) method
var sharedSecret3 = kID.getSharedSecret(keyPair2.uniKey, keyPair1.secKey);
var sharedSecret4 = kID.getSharedSecret(keyPair1.uniKey, keyPair2.secKey);Encrypts a the given message using a precomputed sharedSecret.
- message should be given as a string
- nonce should be a nonce from the
getNonce()method- Note: The nonce used for encrypting and decrypting need to be the same
- sharedSecret should be computed using the
getSharedSecret(theirVerifyKey, mySigningKey)method
Example:
var k1 = kID.goKep();
var k2 = kID.goKep();
var signKey1 = k1.secret.signKey;
var signKey2 = k2.secret.signKey;
var keyPair1 = kID.getKeyPairFromSignKey(kSigKey1);
var keyPair2 = kID.getKeyPairFromSignKey(kSigKey2);
var sharedSecret1To2 = kID.getSharedSecret(keyPair2.uniKey, keyPair1.secKey);
var message = "One giant step.";
var kNonce = kID.getKNonce();
var encryptedMessage = kID.encryptMessage(message, kNonce, sharedSecret1To2);Verifies and decrypts a previously encrypted message.
- encryptedMessage should be what is returned from the
encryptMessage(message, nonce, sharedSecret)method - nonce should be a nonce given from the
getKNonce()method- Note: The nonce used for encrypting and decrypting need to be the same
- sharedSecret should be computed using the
getSharedSecret(theirVerifyKey, mySigningKey)method
Example:
var kSigKey1 = "86kefAkSMwkoxVgdAcR6oJMihyEbh6tjpLiccp2tsyzH";
var kSigKey2 = "8NkBTbsB2wRN37gqZqyBdcQjfEtFjGMTdj9tZHrpJTTL";
var kSigKey3 = "xC9ufU5zsfuSED7VzLbsq15VA8xpJsv5zk21aCkoNzF";
var keyPair1 = kID.getKeyPairFromSignKey(kSigKey1);
var keyPair2 = kID.getKeyPairFromSignKey(kSigKey2);
var keyPair3 = kID.getKeyPairFromSignKey(kSigKey3);
var sharedSecret1To2 = kID.getSharedSecret(keyPair2.uniKey, keyPair1.secKey);
var sharedSecret2To1 = kID.getSharedSecret(keyPair1.uniKey, keyPair2.secKey);
var sharedSecret3To1 = kID.getSharedSecret(keyPair3.uniKey, keyPair1.secKey);
var message = "One giant step.";
var kNonce = kID.getKNonce();
var encryptedMessage = kID.encryptMessage(message, kNonce, sharedSecret1To2);
var decryptedMessage = kID.decryptMessage(encryptedMessage, kNonce, sharedSecret2To1);
var attemptedDecryption = kID.decryptMessage(encryptedMessage, kNonce, sharedSecret3To1);
console.log(decryptedMessage);
console.log(attemptedDecryption);Output:
One giant step.
false
benOS is a decentralized operating system, originally based on Linux, uses some design strategies from RedoxOS and even some design concepts from OpenStack, Ethereum and EOS. Although we utilize some of their design strategies, benOS is completely custom from a codebase perspective.
benOS has many components that make the wheels turn. Below are a list of those components:
Nova - Global Decentralized Hypervisor For The Bench Network
Kepler - Global Decentralized Identity Management For The Bench Network
- Kepler-CLI - Kepler's Official Command Line Client
- KeplerUUID - Kepler's UUID Javascript Library
- KeplerKeys - Key Generation Javascript Library For Kepler
Designate - Global Decentralized Naming Service For The Bench Network
Flutter - Global Decentralized Image Service For The Bench Network
Neutron - Global Network Creation & Management For The Bench Network
- BenchCore - Core Decentralized Network Component For The Bench Network
- BenchChain - Neutron's RootChain On The Bench Network
Aero - Global Object Storage Distributor & Manager For The Bench Network
Explorer - Global dApp Distributor, Manager and Viewer For The Bench Network
benFS - benOS FileSystem
dappJS - dApp Development Kit For The Bench Network
Mercury - benOS Graphical User Interface
Asteroid - benOS Native Programming Language
Meteor - benOS Native IDE for dApp Development
benOS-Microkernel - benOS Microkernel
benOS-Bootloader - benOS Bootloader
ParseArgs - benOS-based Argument Parsing
X - benOS Graphical User Interface
NOTE: There are other pieces under development as well, as our development team grows.
benOS may use software from other open source libraries. For a full list of software credits and acknowledgements, please visit https://github.com/benchlab/benOS/blob/master/ATTRIBUTES.md. The original LICENSE or LICENSES for the originating software(s) and library or libraries that were used to create KeplerKeys are still active, although, considering this Bench software and the softwares and/or libraries/packages it is imported into may be used to issue illegal securities, the BENCH LICENSE is activated for this purpose. This does not take away the credits, disable the originating LICENSE or in any way disown the original creation, creators, developers or organizations that originally developed many of the libaries used throughout Bench's large array of software libraries packaged together for the purposes of building a decentralized operating system (benOS)
1.0.0
BENCH LICENSE
For KeplerKeys
Copyright (c) 2018 Bench Computer, Inc. [email protected]
Permission to use, copy, modify, and distribute this blockchain-related
software or blockchain-based software for any purpose with or without
fee is hereby granted, provided that the above copyright notice and this
permission notice appear in all copies.
THE USAGE OF THIS BLOCKCHAIN-RELATED OR BLOCKCHAIN-BASED SOFTWARE WITH THE PURPOSE OF CREATING ICOS OR "INITIAL COIN OFFERINGS", UNREGISTERED SECURITIES SPECIFICALLY IN THE UNITED STATES OR IN OTHER COUNTRIES THAT HAVE A LEGAL FRAMEWORK FOR SECURITIES, IS PROHIBITED. BENCH FOUNDATION, LLC RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST ANY AND ALL COMPANIES OR INDIVIDUALS WHO USE THIS BLOCKCHAIN-RELATED OR BLOCKCHAIN-BASED SOFTWARE FOR THE PURPOSE OF DISTRIBUTING CRYPTOCURRENCIES WHERE THOSE CRYPTOCURRENCIES AND THEIR METHOD OF DISTRIBUTION ARE IN DIRECT VIOLATION OF UNITED STATES SECURITIES LAWS. IF A GOVERNMENT BODY TAKES ACTION AGAINST ANY USERS, DEVELOPERS, MARKETERS, ORGANIZATIONS, FOUNDATIONS OR ANY PROFESSIONAL ENTITY WHO CHOOSES TO UTILIZE THIS SOFTWARE FOR THE DISTRIBUTION OF ILLEGAL SECURITIES, BENCH COMPUTER INC. WILL NOT BE HELD LIABLE FOR ANY ACTIONS TAKEN BY THE USERS, DEVELOPERS, MARKETERS, ORGANIZATIONS, FOUNDATIONS OR ANY PROFESSIONAL ENTITIES WHO CHOOSE TO DO SO.
UNITED STATES SECURITIES VIOLATIONS SPECIFICALLY REFER TO ANY VIOLATIONS OF SECTION 10(b) OF THE SECURITIES EXCHANGE ACT OF 1934 [15 U.S.C. § 78j(b)] AND RULE 10b-5(b) PROMULGATED THEREUNDER [17 C.F.R. § 240.10b-5(b)], AND SECTIONS 5(a), 5(c), and 17(a)(2) OF THE SECURITIES ACT OF 1933 [15 U.S.C. §§ 77e(a), 77e(c), and 77q(a)(2)]; BY MAKING USE OF ANY MEANS OR INSTRUMENTS OF TRANSPORTATION OR COMMUNICATION IN INTERSTATE COMMERCE OR OF THE MAILS TO SELL THROUGH THE USE OR MEDIUM OF ANY WRITTEN CONTRACT, OFFERING DOCUMENT, PROSPECTUS, WHITEPAPER, OR OTHERWISE, ANY SECURITY AS TO WHICH NO REGISTRATION STATEMENT WAS IN EFFECT. OR FOR THE PURPOSE OF SALE OR DELIVERY AFTER SALE, CARRYING OR CAUSING TO BE CARRIED THROUGH THE MAILS OR IN INTERSTATE COMMERCE, BY MEANS OR INSTRUMENTS OF TRANSPORTATION OR COMMUNICATION IN INTERSTATE COMMERCE OR OF THE MAILS TO OFFER TO SELL OR OFFER TO BUY THROUGH THE USE OR MEDIUM OF ANY WRITTEN CONTRACT, OFFERING DOCUMENT, PROSPECTUS, WHITEPAPER, OR OTHERWISE, SECURITIES AS TO WHICH NO REGISTRATION STATEMENT HAS BEEN FILED.
OUTSIDE OF THESE LEGAL REQUIREMENTS, THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.