on 21d372d help sign in
bridge/src/lib/keys.js
181 lines 4.2 kB history raw
1import BN from 'bn.js';
2import { Just, Nothing } from 'folktale/maybe';
4import * as noun from '../nockjs/noun';
5import * as serial from '../nockjs/serial';
6import * as kg from 'urbit-key-generation/dist';
8import { eqAddr, addHexPrefix } from './wallet';
10// the curve param for the network keys
11export const NETWORK_KEY_CURVE_PARAMETER = '42';
12// the current crypto suite version
13export const CRYPTO_SUITE_VERSION = 1;
15export const CURVE_ZERO_ADDR =
16 '0x0000000000000000000000000000000000000000000000000000000000000000';
18// ctsy joemfb
19const b64 = buf => {
20 let hex = buf.reverse().toString('hex');
21 let n = new BN(hex, 'hex');
22 let c = [];
23 while (1 === n.cmpn(0)) {
24 c.push(n.andln(0x3f));
25 n = n.shrn(6);
26 }
28 // prettier-ignore
29 const trans = j =>
30 10 > j
31 ? j + 48
32 : 36 > j
33 ? j + 87
34 : 62 > j
35 ? j + 29
36 : 62 === j
37 ? 45
38 : 126;
40 return (
41 '0w' +
42 c.reduce(
43 (a, b, i) =>
44 String.fromCharCode(trans(b)) + (i && 0 === i % 5 ? '.' : '') + a,
45 ''
46 )
47 );
48};
50const jam = seed => {
51 const hex = serial
52 .jam(seed)
53 .toString()
54 .slice(2);
55 const pad = hex.length % 2 === 0 ? hex : '0' + hex;
56 return Buffer.from(pad, 'hex').reverse();
57};
59// simple alias to avoid importing kg into component scope
60export const deriveNetworkKeys = seed => kg.deriveNetworkKeys(seed);
62/**
63 * @param {object} pair
64 * @param {number} point
65 * @param {number} revision
66 * @return {string}
67 */
68export const compileNetworkingKey = (pair, point, revision) => {
69 const bnsec = new BN(
70 pair.crypt.private + pair.auth.private + NETWORK_KEY_CURVE_PARAMETER,
71 'hex'
72 );
74 const sed = noun.dwim(
75 noun.Atom.fromInt(point),
76 noun.Atom.fromInt(revision),
77 noun.Atom.fromString(bnsec.toString()),
78 noun.Atom.yes
79 );
81 return b64(jam(sed));
82};
84/**
85 * @param {object} urbitWallet
86 * @param {number} revision
87 * @return {Promise<Maybe<string>>}
88 */
89export const deriveNetworkSeedFromUrbitWallet = async (
90 urbitWallet,
91 revision = 1
92) => {
93 return await deriveNetworkSeedFromSeed(urbitWallet.management.seed, revision);
94};
96/**
97 * @param {Maybe<any>} wallet
98 * @param {string} authMnemonic
99 * @param {object} details
100 * @param {number} revision
101 * @return {Promise<Maybe<string>>}
102 */
103export const deriveNetworkSeedFromMnemonic = async (
104 wallet,
105 authMnemonic,
106 details,
107 revision = 1
108) => {
109 const isOwner = eqAddr(wallet.address, details.owner);
110 const isManagementProxy = eqAddr(wallet.address, details.managementProxy);
112 // the network seed is only derivable from mnemonic if the derived
113 // management seed or owner equals the record we have on chain
114 if (isOwner || isManagementProxy) {
115 return await deriveNetworkSeedFromSeed(authMnemonic, revision);
116 }
118 return Nothing();
119};
121/**
122 * @param {string} seed
123 * @param {number} revision
124 * @return {Promise<Maybe<string>>}
125 */
126const deriveNetworkSeedFromSeed = async (seed, revision) => {
127 return Just(await kg.deriveNetworkSeed(seed, '', revision));
128};
130/**
131 * @return {Promise<Maybe<string>>}
132 */
133export const attemptNetworkSeedDerivation = async ({
134 urbitWallet,
135 wallet,
136 authMnemonic,
137 details,
138 revision,
139}) => {
140 if (Just.hasInstance(urbitWallet)) {
141 return await deriveNetworkSeedFromUrbitWallet(urbitWallet.value, revision);
142 }
144 if (Just.hasInstance(wallet) && Just.hasInstance(authMnemonic)) {
145 return await deriveNetworkSeedFromMnemonic(
146 wallet.value,
147 authMnemonic.value,
148 details,
149 revision
150 );
151 }
153 return Nothing();
154};
156/**
157 *
158 * @param {object} pair
159 * @param {object} details
160 * @return {boolean}
161 */
162export const keysMatchChain = (pair, details) => {
163 const { crypt, auth } = pair;
164 const { encryptionKey, authenticationKey } = details;
166 return (
167 encryptionKey === addHexPrefix(crypt.public) &&
168 authenticationKey === addHexPrefix(auth.public)
169 );
170};
172export const segmentNetworkKey = hex => {
173 if (hex === CURVE_ZERO_ADDR) {
174 return null;
175 }
177 const sl = i => hex.slice(i, i + 4);
178 const rowFrom = i => `${sl(i)}.${sl(i + 4)}.${sl(i + 8)}.${sl(i + 12)}`;
180 return [rowFrom(2), rowFrom(18), rowFrom(34), rowFrom(50)];
181};