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.

Sign up for GitHub

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

Jump to bottom

Release v1.7.0 #266

Merged
merged 9 commits into from
Oct 12, 2019
Merged

Release v1.7.0 #266

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8b3e9f9
chore: bump version to 1.7.0
Jack-Works Oct 10, 2019
bf2dbe2
fix: webpackEnv is not defined
Jack-Works Oct 10, 2019
c74636b
revert: "chore(deps): bump gun from 0.2019.422 to 0.2019.930"
Jack-Works Oct 10, 2019
e4ee7c6
fix: debug mode does not work
Jack-Works Oct 11, 2019
3ad9e4e
fix: debug mode hash wrong for version -39 or lower
Jack-Works Oct 11, 2019
4592e0e
fix: background service not loaded
Jack-Works Oct 11, 2019
b8ad080
fix: using wrong version of hashCryptoKey
Jack-Works Oct 11, 2019
4c9ecff
chore: better message for post hash dialog
Jack-Works Oct 11, 2019
e38cefd
revert: "fix: asmCrypto is not defined"
Jack-Works Oct 11, 2019
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: 1 addition & 1 deletion config-overrides/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<script src="/polyfill/browser-polyfill.min.js"></script>
<script src="/polyfill/asmcrypto.js"></script>
<script src="/firefoxFix.js"></script>
<script src="/js/env.js"></script>
<script src="/env.js"></script>
</head>
<body></body>
</html>
21 changes: 5 additions & 16 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "maskbook",
"license": "AGPL-3.0-or-later",
"version": "1.6.0",
"version": "1.7.0",
"private": true,
"engines": {
"node": ">=12.0.0"
Expand Down Expand Up @@ -58,7 +58,7 @@
"elliptic": "^6.4.1",
"eslint-plugin-import": "^2.18.2",
"eslint-plugin-react-hooks": "^2.0.1",
"gun": "0.2019.930",
"gun": "0.2019.422",
"husky": "^3.0.5",
"idb": "^4.0.3",
"json-stable-stringify": "^1.0.1",
Expand Down Expand Up @@ -112,16 +112,8 @@
"yargs": "^14.0.0"
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
"production": [">0.2%", "not dead", "not op_mini all"],
"development": ["last 1 chrome version", "last 1 firefox version", "last 1 safari version"]
},
"husky": {
"hooks": {
Expand All @@ -130,9 +122,6 @@
}
},
"lint-staged": {
"*.{ts,tsx,js,jsx}": [
"node scripts/lint.js",
"git add"
]
"*.{ts,tsx,js,jsx}": ["node scripts/lint.js", "git add"]
}
}
2 changes: 1 addition & 1 deletion src/components/DebugModeUI/PostHashDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export function DebugModeUI_PostHashDialog(props: { post: string; network: strin
useAsync(() => {
if (!payload) return Promise.resolve([] as typeof hashMap)
const ivID = new PostIVIdentifier(props.network, payload.iv)
return Services.Crypto.debugShowAllPossibleHashForPost(ivID)
return Services.Crypto.debugShowAllPossibleHashForPost(ivID, payload.version)
}, [props.post]).then(setHashMap)
return (
<>
Expand Down
8 changes: 5 additions & 3 deletions src/extension/background-script/CryptoServices/debugShowAllPossibleHashForPost.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { PostIVIdentifier } from '../../../database/type'
import { queryPeopleDB } from '../../../database/people'
import { hashPostSalt, hashCryptoKey } from '../../../network/gun/version.2/hash'
import { hashPostSalt, hashCryptoKey, hashCryptoKeyUnstable } from '../../../network/gun/version.2/hash'

export async function debugShowAllPossibleHashForPost(post: PostIVIdentifier) {
export async function debugShowAllPossibleHashForPost(post: PostIVIdentifier, payloadVersion: -38 | -39 | -40) {
const friends = await queryPeopleDB(x => x.network === post.network)
return Promise.all(
friends
Expand All @@ -11,7 +11,9 @@ export async function debugShowAllPossibleHashForPost(post: PostIVIdentifier) {
async x =>
[
x.identifier.toText(),
(await hashPostSalt(post.postIV)) + '-' + (await hashCryptoKey(x.publicKey!, true)),
(await hashPostSalt(post.postIV)) +
'-' +
(await (payloadVersion >= -38 ? hashCryptoKey : hashCryptoKeyUnstable)(x.publicKey!)),
] as [string, string],
),
)
Expand Down
2 changes: 1 addition & 1 deletion src/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json.schemastore.org/chrome-manifest",
"name": "Maskbook",
"version": "1.6.0",
"version": "1.7.0",
"manifest_version": 2,
"web_accessible_resources": ["*.css", "*.js", "*.jpg", "*.png"],
"permissions": ["storage", "downloads", "webNavigation", "activeTab"],
Expand Down
36 changes: 20 additions & 16 deletions src/network/gun/version.2/hash.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,30 @@ export const hashPostSalt = memoizePromise(async function(postSalt: string) {

const hash = (await Gun.SEA.work(postSalt, hashPair))!
return hash.substring(0, N)
})
}, undefined)

/**
* @param key - The key need to be hashed
* @param stableHash - Set this to true if you're writing new code.
* Unstable hash may cause problem but we cannot just switch to stable hash
* because it may breaks current data.
* @deprecated
*/
export const hashCryptoKey = memoizePromise(async function(key: CryptoKey, stableHash: boolean) {
export const hashCryptoKeyUnstable = memoizePromise(async function(key: CryptoKey) {
const hashPair = `10198a2f-205f-45a6-9987-3488c80113d0`
const N = 2

if (stableHash === true) {
const jwk = await CryptoKeyToJsonWebKey(key)
if (!jwk.x || !jwk.y) throw new Error('Invalid key')
const hash = (await Gun.SEA.work(jwk.x! + jwk.y!, hashPair))!
return hash.substring(0, N)
} else {
const jwk = JSON.stringify(await CryptoKeyToJsonWebKey(key))
const hash = (await Gun.SEA.work(jwk, hashPair))!
return hash.substring(0, N)
}
})
const jwk = JSON.stringify(await CryptoKeyToJsonWebKey(key))
Jack-Works marked this conversation as resolved.
Show resolved Hide resolved
const hash = (await Gun.SEA.work(jwk, hashPair))!
return hash.substring(0, N)
}, undefined)

/**
* @param key - The key need to be hashed
*/
export const hashCryptoKey = memoizePromise(async function(key: CryptoKey) {
const hashPair = `10198a2f-205f-45a6-9987-3488c80113d0`
const N = 2

const jwk = await CryptoKeyToJsonWebKey(key)
if (!jwk.x || !jwk.y) throw new Error('Invalid key')
const hash = (await Gun.SEA.work(jwk.x! + jwk.y!, hashPair))!
Copy link
Contributor

@Artoria2e5 Artoria2e5 Oct 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for being laaaaaate to the new payload party, but we really can just get away with only hashing x as long as we are on EC. Let's fix that before -38 gets released and formalized. And may I ask what's exactly in the hashPair? Is somehow derived from the name K256? If not, we should fix that with something like jwk.kty + jwk.alg as salt.

PS: I don't see the point of doing a PBKDF2 on a public key when all we need is a fingerprint. Gun.SEA.work can use SHA-256.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hashPair is a random UUID. You can think it is some type of salt but shared to generate a stable output between clients.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jwk.x or jwk.x + jwk.y is not important, we just need a hash, does the current way looks good to you?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, because by only hashing the points we are throwing away algorithmic information previously provided by hashing the entire thing. This breaks the #191 mandate of being able to stably process a multitude of curves.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can see we cut the N chars of the hash. return hash.substring(0, N).

This is not a full hash, it's more like a "partition"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Hashing the entire thing" does not mean taking the full hash. It means that we used to hash the entire JWK object, which contained information about the algorithm in jwk.kty + jwk.alg. We are not including it anymore, which is a short-sighted view especially given that the current salt has no use.

You are trying to go through this quick by dismissing everything without reading them through.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The design here is from the https://github.com/DimensionDev/Maskbook/wiki/Data-structure-on-Gun-version-2 . Maskbook is only using the a part of "feature" of the key, it should be stable, but it's content is not important

return hash.substring(0, N)
}, undefined)
8 changes: 4 additions & 4 deletions src/network/gun/version.2/post.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { OnlyRunInContext } from '@holoflows/kit/es'
import { gun2, SharedAESKeyGun2 } from '.'
import { hashPostSalt, hashCryptoKey } from './hash'
import { hashPostSalt, hashCryptoKey, hashCryptoKeyUnstable } from './hash'
import { PublishedAESKeyRecordV39OrV38 } from '../../../crypto/crypto-alpha-38'

OnlyRunInContext('background', 'gun')
Expand All @@ -18,7 +18,7 @@ export async function queryPostKeysOnGun2(
): Promise<{ keys: SharedAESKeyGun2[]; postHash: string; keyHash: string }> {
const postHash = await hashPostSalt(postSalt)
// In version > -39, we will use stable hash to prevent unstable result for key hashing
const keyHash = await hashCryptoKey(partitionByCryptoKey, version > -39)
const keyHash = await (version > -39 ? hashCryptoKeyUnstable : hashCryptoKey)(partitionByCryptoKey)

// ? here we get the internal node names of gun2[postHash][keyHash]
// ? where gun2[postHash][keyHash] is a list
Expand Down Expand Up @@ -52,7 +52,7 @@ export function subscribePostKeysOnGun2(
) {
hashPostSalt(postSalt).then(postHash => {
// In version > -39, we will use stable hash to prevent unstable result for key hashing
hashCryptoKey(partitionByCryptoKey, version > -39).then(keyHash => {
;(version > -39 ? hashCryptoKeyUnstable : hashCryptoKey)(partitionByCryptoKey).then(keyHash => {
gun2.get(postHash)
// @ts-ignore
.get(keyHash)
Expand Down Expand Up @@ -81,7 +81,7 @@ export async function publishPostAESKeyOnGun2(
const postHash = await hashPostSalt(postSalt)
// Store AES key to gun
receiversKeys.forEach(async ({ aesKey, receiverKey }) => {
const keyHash = await hashCryptoKey(receiverKey, version > -39)
const keyHash = await (version > -39 ? hashCryptoKeyUnstable : hashCryptoKey)(receiverKey)
console.log(`gun[${postHash}][${keyHash}].push(`, aesKey, `)`)
gun2.get(postHash)
// @ts-ignore
Expand Down
12 changes: 10 additions & 2 deletions src/utils/memoize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
import { memoize } from 'lodash-es'
/**
* The promise version of lodash-es/memoize
* @param f An async function
* @param resolver If the function has 1 param, it can be undefined
* as `x => x`. If it has more than 1 param, you must specify a function
* to map the param the memoize key.
*/
export function memoizePromise<T extends (...args: Args) => PromiseLike<any>, Args extends any[]>(
f: T,
resolver: (...args: Args) => any = ((a: any) => a) as any,
resolver: Args[1] extends undefined ? undefined | ((...args: Args) => unknown) : (...args: Args) => unknown,
) {
if (resolver === undefined) resolver = ((x: any) => x) as any
const memorizedFunction = memoize(
(async function(...args: Args) {
try {
// ? DO NOT remove "await" here
return await f(...args)
} catch (e) {
memorizedFunction.cache.delete(resolver(...args))
memorizedFunction.cache.delete(resolver!(...args))
throw e
}
} as any) as T,
Expand Down
15 changes: 7 additions & 8 deletions src/utils/type-transform/Payload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import { geti18nString } from '../i18n'
import { SocialNetworkWorkerAndUI } from '../../social-network/shared'
import { defaults, isNil } from 'lodash-es'
import { definedSocialNetworkWorkers } from '../../social-network/worker'
import { getActivatedUI } from '../../social-network/ui'
import { GetContext } from '@holoflows/kit/es'

export type Payload = PayloadAlpha40_Or_Alpha39 | PayloadAlpha38

Expand Down Expand Up @@ -96,22 +98,19 @@ export function deconstructPayload(

const decoders = (() => {
if (isNil(decoder)) {
const sto = []
for (const v of definedSocialNetworkWorkers) {
sto.push(v.payloadDecoder)
}
return sto
if (GetContext() === 'content') return [getActivatedUI().payloadDecoder]
return Array.from(definedSocialNetworkWorkers).map(x => x.payloadDecoder)
}
return [decoder]
})()

if (decoders.length === 0) decoders.push(x => x)

for (const versionDecoder of versions) {
for (const networkDecoder of decoders) {
if (isNil(networkDecoder(str))) continue
const result = versionDecoder(networkDecoder(str)!, false)
if (!isNil(result)) {
return result
}
if (!isNil(result)) return result
}
}
if (str.includes('🎼') && str.includes(':||'))
Expand Down
Loading