mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-03-31 06:41:08 +00:00
199395de4d
Converts this module to typescript.
- Ecosystem modules renamed from (e.g.) `libp2p-tcp` to `@libp2p/tcp`
- Ecosystem module now have named exports
- Configuration has been updated, now pass instances of modules instead of classes:
- Some configuration keys have been renamed to make them more descriptive. `transport` -> `transports`, `connEncryption` -> `connectionEncryption`. In general where we pass multiple things, the key is now plural, e.g. `streamMuxer` -> `streamMuxers`, `contentRouting` -> `contentRouters`, etc. Where we are configuring a singleton the config key is singular, e.g. `connProtector` -> `connectionProtector` etc.
- Properties of the `modules` config key have been moved to the root
- Properties of the `config` config key have been moved to the root
```js
// before
import Libp2p from 'libp2p'
import TCP from 'libp2p-tcp'
await Libp2p.create({
modules: {
transport: [
TCP
],
}
config: {
transport: {
[TCP.tag]: {
foo: 'bar'
}
},
relay: {
enabled: true,
hop: {
enabled: true,
active: true
}
}
}
})
```
```js
// after
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
await createLibp2p({
transports: [
new TCP({ foo: 'bar' })
],
relay: {
enabled: true,
hop: {
enabled: true,
active: true
}
}
})
```
- Use of `enabled` flag has been reduced - previously you could pass a module but disable it with config. Now if you don't want a feature, just don't pass an implementation. Eg:
```js
// before
await Libp2p.create({
modules: {
transport: [
TCP
],
pubsub: Gossipsub
},
config: {
pubsub: {
enabled: false
}
}
})
```
```js
// after
await createLibp2p({
transports: [
new TCP()
]
})
```
- `.multiaddrs` renamed to `.getMultiaddrs()` because it's not a property accessor, work is done by that method to calculate announce addresses, observed addresses, etc
- `/p2p/${peerId}` is now appended to all addresses returned by `.getMultiaddrs()` so they can be used opaquely (every consumer has to append the peer ID to the address to actually use it otherwise). If you need low-level unadulterated addresses, call methods on the address manager.
BREAKING CHANGE: types are no longer hand crafted, this module is now ESM only
116 lines
3.4 KiB
TypeScript
116 lines
3.4 KiB
TypeScript
/* eslint-env mocha */
|
|
import { expect } from 'aegir/utils/chai.js'
|
|
import { pipe } from 'it-pipe'
|
|
import all from 'it-all'
|
|
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
import { PreSharedKeyConnectionProtector } from '../../src/pnet/index.js'
|
|
import { generate } from '../../src/pnet/key-generator.js'
|
|
import { INVALID_PSK } from '../../src/pnet/errors.js'
|
|
import { mockMultiaddrConnPair } from '@libp2p/interface-compliance-tests/mocks'
|
|
import { Multiaddr } from '@multiformats/multiaddr'
|
|
import { createEd25519PeerId } from '@libp2p/peer-id-factory'
|
|
|
|
const swarmKeyBuffer = new Uint8Array(95)
|
|
const wrongSwarmKeyBuffer = new Uint8Array(95)
|
|
|
|
// Write new psk files to the buffers
|
|
generate(swarmKeyBuffer)
|
|
generate(wrongSwarmKeyBuffer)
|
|
|
|
describe('private network', () => {
|
|
it('should accept a valid psk buffer', () => {
|
|
const protector = new PreSharedKeyConnectionProtector({
|
|
psk: swarmKeyBuffer
|
|
})
|
|
|
|
expect(protector.tag).to.equal('/key/swarm/psk/1.0.0/')
|
|
})
|
|
|
|
it('should protect a simple connection', async () => {
|
|
const { inbound, outbound } = mockMultiaddrConnPair({
|
|
addrs: [
|
|
new Multiaddr('/ip4/127.0.0.1/tcp/1234'),
|
|
new Multiaddr('/ip4/127.0.0.1/tcp/1235')
|
|
],
|
|
remotePeer: await createEd25519PeerId()
|
|
})
|
|
const protector = new PreSharedKeyConnectionProtector({
|
|
psk: swarmKeyBuffer
|
|
})
|
|
|
|
const [aToB, bToA] = await Promise.all([
|
|
protector.protect(inbound),
|
|
protector.protect(outbound)
|
|
])
|
|
|
|
void pipe(
|
|
[uint8ArrayFromString('hello world'), uint8ArrayFromString('doo dah')],
|
|
aToB
|
|
)
|
|
|
|
const output = await pipe(
|
|
bToA,
|
|
async function * (source) {
|
|
for await (const chunk of source) {
|
|
yield chunk.slice()
|
|
}
|
|
},
|
|
async (source) => await all(source)
|
|
)
|
|
|
|
expect(output).to.eql([uint8ArrayFromString('hello world'), uint8ArrayFromString('doo dah')])
|
|
})
|
|
|
|
it('should not be able to share correct data with different keys', async () => {
|
|
const { inbound, outbound } = mockMultiaddrConnPair({
|
|
addrs: [
|
|
new Multiaddr('/ip4/127.0.0.1/tcp/1234'),
|
|
new Multiaddr('/ip4/127.0.0.1/tcp/1235')
|
|
],
|
|
remotePeer: await createEd25519PeerId()
|
|
})
|
|
const protector = new PreSharedKeyConnectionProtector({
|
|
psk: swarmKeyBuffer
|
|
})
|
|
const protectorB = new PreSharedKeyConnectionProtector({
|
|
enabled: true,
|
|
psk: wrongSwarmKeyBuffer
|
|
})
|
|
|
|
const [aToB, bToA] = await Promise.all([
|
|
protector.protect(inbound),
|
|
protectorB.protect(outbound)
|
|
])
|
|
|
|
void pipe(
|
|
[uint8ArrayFromString('hello world'), uint8ArrayFromString('doo dah')],
|
|
aToB
|
|
)
|
|
|
|
const output = await pipe(
|
|
bToA,
|
|
async (source) => await all(source)
|
|
)
|
|
|
|
expect(output).to.not.eql([uint8ArrayFromString('hello world'), uint8ArrayFromString('doo dah')])
|
|
})
|
|
|
|
describe('invalid psks', () => {
|
|
it('should not accept a bad psk', () => {
|
|
expect(() => {
|
|
return new PreSharedKeyConnectionProtector({
|
|
psk: uint8ArrayFromString('not-a-key')
|
|
})
|
|
}).to.throw(INVALID_PSK)
|
|
})
|
|
|
|
it('should not accept a psk of incorrect length', () => {
|
|
expect(() => {
|
|
return new PreSharedKeyConnectionProtector({
|
|
psk: uint8ArrayFromString('/key/swarm/psk/1.0.0/\n/base16/\ndffb7e')
|
|
})
|
|
}).to.throw(INVALID_PSK)
|
|
})
|
|
})
|
|
})
|