Compare commits

...

9 Commits

Author SHA1 Message Date
fiatjaf
454366f6a2 allow signing events with a custom signing function on pool.publish() 2022-01-12 22:32:45 -03:00
fiatjaf
3d6f9a41e0 prevent blocking waiting times on publish (unless "wait" is set in the pool policy). 2022-01-12 17:39:24 -03:00
fiatjaf
e3631ba806 fix and update nip06. 2022-01-06 21:46:34 -03:00
fiatjaf
89f11e214d fix filter matching for tags. 2022-01-02 19:46:19 -03:00
fiatjaf
bb09e25512 fix tag in matchFilter for kinds and ids. 2022-01-01 21:18:37 -03:00
fiatjaf
1b5c314436 nip-01 update: everything as arrays on filters. 2022-01-01 20:49:05 -03:00
fiatjaf
2230f32d11 use randomBytes from @noble/hashes. 2022-01-01 14:59:12 -03:00
fiatjaf
b271d6c06b fix .kind filter validator. 2022-01-01 10:26:55 -03:00
fiatjaf
76624a0f23 validateEvent() function. 2022-01-01 10:04:36 -03:00
8 changed files with 97 additions and 45 deletions

View File

@@ -18,7 +18,7 @@ export function serializeEvent(evt) {
evt.pubkey, evt.pubkey,
evt.created_at, evt.created_at,
evt.kind, evt.kind,
evt.tags || [], evt.tags,
evt.content evt.content
]) ])
} }
@@ -30,8 +30,24 @@ export function getEventHash(event) {
return Buffer.from(eventHash).toString('hex') return Buffer.from(eventHash).toString('hex')
} }
export function verifySignature(event) { export function validateEvent(event) {
if (event.id !== getEventHash(event)) return false if (event.id !== getEventHash(event)) return false
if (typeof event.content !== 'string') return false
if (typeof event.created_at !== 'number') return false
if (!Array.isArray(event.tags)) return false
for (let i = 0; i < event.tags.length; i++) {
let tag = event.tags[i]
if (!Array.isArray(tag)) return false
for (let j = 0; j < tag.length; j++) {
if (typeof tag[j] === 'object') return false
}
}
return true
}
export function verifySignature(event) {
return secp256k1.schnorr.verify(event.sig, event.id, event.pubkey) return secp256k1.schnorr.verify(event.sig, event.id, event.pubkey)
} }

View File

@@ -1,20 +1,23 @@
export function matchFilter(filter, event) { export function matchFilter(filter, event) {
if (filter.id && event.id !== filter.id) return false if (filter.ids && filter.ids.indexOf(event.id) === -1) return false
if (filter.kind && event.kind !== filter.kind) return false if (filter.kinds && filter.kinds.indexOf(event.kind) === -1) return false
if (filter.author && event.pubkey !== filter.author) return false
if (filter.authors && filter.authors.indexOf(event.pubkey) === -1) if (filter.authors && filter.authors.indexOf(event.pubkey) === -1)
return false return false
if (
filter['#e'] && for (let f in filter) {
!event.tags.find(([t, v]) => t === 'e' && v === filter['#e']) if (f[0] === '#') {
) if (
return false filter[f] &&
if ( !event.tags.find(
filter['#p'] && ([t, v]) => t === f.slice(1) && filter[f].indexOf(v) !== -1
!event.tags.find(([t, v]) => t === 'p' && v === filter['#p']) )
) )
return false return false
if (filter.since && event.created_at <= filter.since) return false }
}
if (filter.since && event.created_at < filter.since) return false
if (filter.until && event.created_at >= filter.until) return false
return true return true
} }

View File

@@ -4,6 +4,7 @@ import {relayPool} from './pool'
import { import {
getBlankEvent, getBlankEvent,
signEvent, signEvent,
validateEvent,
verifySignature, verifySignature,
serializeEvent, serializeEvent,
getEventHash getEventHash
@@ -15,6 +16,7 @@ export {
relayConnect, relayConnect,
relayPool, relayPool,
signEvent, signEvent,
validateEvent,
verifySignature, verifySignature,
serializeEvent, serializeEvent,
getEventHash, getEventHash,

View File

@@ -1,6 +1,6 @@
import aes from 'browserify-cipher' import aes from 'browserify-cipher'
import {Buffer} from 'buffer' import {Buffer} from 'buffer'
import randomBytes from 'randombytes' import {randomBytes} from '@noble/hashes/utils'
import * as secp256k1 from '@noble/secp256k1' import * as secp256k1 from '@noble/secp256k1'
export function encrypt(privkey, pubkey, text) { export function encrypt(privkey, pubkey, text) {

View File

@@ -8,13 +8,13 @@ import {HDKey} from 'micro-bip32'
export function privateKeyFromSeed(seed) { export function privateKeyFromSeed(seed) {
let root = HDKey.fromMasterSeed(Buffer.from(seed, 'hex')) let root = HDKey.fromMasterSeed(Buffer.from(seed, 'hex'))
return Buffer.from(root.derive(`m/44'/1237'/0'/0'`).privateKey).toString( return Buffer.from(root.derive(`m/44'/1237'/0'/0/0`).privateKey).toString(
'hex' 'hex'
) )
} }
export function seedFromWords(mnemonic) { export function seedFromWords(mnemonic) {
return Buffer.from(mnemonicToSeedSync(mnemonic, wordlist)).toString('hex') return Buffer.from(mnemonicToSeedSync(mnemonic)).toString('hex')
} }
export function generateSeedWords() { export function generateSeedWords() {

View File

@@ -1,12 +1,13 @@
{ {
"name": "nostr-tools", "name": "nostr-tools",
"version": "0.14.3", "version": "0.19.0",
"description": "Tools for making a Nostr client.", "description": "Tools for making a Nostr client.",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/fiatjaf/nostr-tools.git" "url": "https://github.com/fiatjaf/nostr-tools.git"
}, },
"dependencies": { "dependencies": {
"@noble/hashes": "^0.5.7",
"@noble/secp256k1": "^1.3.0", "@noble/secp256k1": "^1.3.0",
"browserify-cipher": ">=1", "browserify-cipher": ">=1",
"buffer": ">=5", "buffer": ">=5",
@@ -14,7 +15,6 @@
"dns-packet": "^5.2.4", "dns-packet": "^5.2.4",
"micro-bip32": "^0.1.0", "micro-bip32": "^0.1.0",
"micro-bip39": "^0.1.3", "micro-bip39": "^0.1.3",
"randombytes": ">=2",
"websocket-polyfill": "^0.0.3" "websocket-polyfill": "^0.0.3"
}, },
"keywords": [ "keywords": [

74
pool.js
View File

@@ -1,12 +1,18 @@
import {getEventHash, signEvent} from './event' import {getEventHash, verifySignature, signEvent} from './event'
import {relayConnect, normalizeRelayURL} from './relay' import {relayConnect, normalizeRelayURL} from './relay'
export function relayPool() { export function relayPool() {
var globalPrivateKey var globalPrivateKey
var globalSigningFunction
const poolPolicy = { const poolPolicy = {
// setting this to a number will cause events to be published to a random // setting this to a number will cause events to be published to a random
// set of relays only, instead of publishing to all relays all the time // set of relays only, instead of publishing to all relays all the time
randomChoice: null randomChoice: null,
// setting this to true will cause .publish() calls to wait until the event has
// been published -- or at least attempted to be published -- to all relays
wait: false
} }
const relays = {} const relays = {}
const noticeCallbacks = [] const noticeCallbacks = []
@@ -72,6 +78,9 @@ export function relayPool() {
setPrivateKey(privateKey) { setPrivateKey(privateKey) {
globalPrivateKey = privateKey globalPrivateKey = privateKey
}, },
registerSigningFunction(fn) {
globalSigningFunction = fn
},
setPolicy(key, value) { setPolicy(key, value) {
poolPolicy[key] = value poolPolicy[key] = value
}, },
@@ -111,7 +120,7 @@ export function relayPool() {
let index = noticeCallbacks.indexOf(cb) let index = noticeCallbacks.indexOf(cb)
if (index !== -1) noticeCallbacks.splice(index, 1) if (index !== -1) noticeCallbacks.splice(index, 1)
}, },
async publish(event, statusCallback = (status, relayURL) => {}) { async publish(event, statusCallback) {
event.id = getEventHash(event) event.id = getEventHash(event)
if (!event.sig) { if (!event.sig) {
@@ -119,9 +128,21 @@ export function relayPool() {
if (globalPrivateKey) { if (globalPrivateKey) {
event.sig = await signEvent(event, globalPrivateKey) event.sig = await signEvent(event, globalPrivateKey)
} else if (globalSigningFunction) {
event.sig = await globalSigningFunction(event)
if (!event.sig) {
// abort here
return
} else {
// check
if (!(await verifySignature(event)))
throw new Error(
'signature provided by custom signing function is invalid.'
)
}
} else { } else {
throw new Error( throw new Error(
"can't publish unsigned event. either sign this event beforehand or pass a private key while initializing this relay pool so it can be signed automatically." "can't publish unsigned event. either sign this event beforehand, provide a signing function or pass a private key while initializing this relay pool so it can be signed automatically."
) )
} }
} }
@@ -136,28 +157,37 @@ export function relayPool() {
let successes = 0 let successes = 0
for (let i = 0; i < writeable.length; i++) { if (poolPolicy.wait) {
let {relay} = writeable[i] for (let i = 0; i < writeable.length; i++) {
let {relay} = writeable[i]
try { try {
await new Promise(async (resolve, reject) => { await new Promise(async (resolve, reject) => {
try { try {
await relay.publish(event, status => { await relay.publish(event, status => {
statusCallback(status, relay.url) if (statusCallback) statusCallback(status, relay.url)
resolve() resolve()
}) })
} catch (err) { } catch (err) {
statusCallback(-1, relay.url) if (statusCallback) statusCallback(-1, relay.url)
}
})
successes++
if (successes >= maxTargets) {
break
} }
}) } catch (err) {
/***/
successes++
if (successes >= maxTargets) {
break
} }
} catch (err) {
/***/
} }
} else {
writeable.forEach(async ({relay}) => {
let callback = statusCallback
? status => statusCallback(status, relay.url)
: null
relay.publish(event, callback)
})
} }
return event return event

View File

@@ -2,7 +2,7 @@
import 'websocket-polyfill' import 'websocket-polyfill'
import {verifySignature} from './event' import {verifySignature, validateEvent} from './event'
import {matchFilters} from './filter' import {matchFilters} from './filter'
export function normalizeRelayURL(url) { export function normalizeRelayURL(url) {
@@ -93,7 +93,8 @@ export function relayConnect(url, onNotice = () => {}, onError = () => {}) {
let event = data[2] let event = data[2]
if ( if (
(await verifySignature(event)) && validateEvent(event) &&
verifySignature(event) &&
channels[channel] && channels[channel] &&
matchFilters(openSubs[channel], event) matchFilters(openSubs[channel], event)
) { ) {