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.

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

Block connections with blacklisted multiaddrs #373

Merged
merged 4 commits into from
May 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"packages": [
"packages/*"
],
"version": "0.2.40",
"version": "0.2.41",
"npmClient": "yarn",
"useWorkspaces": true,
"command": {
Expand Down
2 changes: 1 addition & 1 deletion packages/cache/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/cache",
"version": "0.2.40",
"version": "0.2.41",
"description": "Generic object cache",
"main": "dist/index.js",
"scripts": {
Expand Down
6 changes: 3 additions & 3 deletions packages/cli/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/cli",
"version": "0.2.40",
"version": "0.2.41",
"main": "dist/index.js",
"license": "AGPL-3.0",
"scripts": {
Expand All @@ -11,8 +11,8 @@
"chat": "DEBUG='vulcanize:*, laconic:*' node dist/chat.js"
},
"dependencies": {
"@cerc-io/peer": "^0.2.40",
"@cerc-io/util": "^0.2.40",
"@cerc-io/peer": "^0.2.41",
"@cerc-io/util": "^0.2.41",
"@ethersproject/providers": "^5.4.4",
"@graphql-tools/utils": "^9.1.1",
"@ipld/dag-cbor": "^8.0.0",
Expand Down
22 changes: 22 additions & 0 deletions packages/cli/src/peer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import { hideBin } from 'yargs/helpers';
import yargs from 'yargs';
import debug from 'debug';
import fs from 'fs';
import path from 'path';

import {
PeerInitConfig,
Expand All @@ -19,6 +21,7 @@ const log = debug('vulcanize:peer');

interface Arguments {
relayMultiaddr: string;
denyMultiaddrs?: string;
maxConnections: number;
dialTimeout: number;
maxRelayConnections: number;
Expand All @@ -38,7 +41,22 @@ export class PeerCmd {
peerIdObj = readPeerId(argv.peerIdFile);
}

let denyMultiaddrsList: string[] = [];
if (argv.denyMultiaddrs) {
const denyMultiaddrsFilePath = path.resolve(argv.denyMultiaddrs);

if (!fs.existsSync(denyMultiaddrsFilePath)) {
console.log(`File at given path ${denyMultiaddrsFilePath} not found, exiting`);
process.exit();
}

console.log(`Reading blacklisted multiaddr(s) from file ${denyMultiaddrsFilePath}`);
const denyMultiaddrsListObj = fs.readFileSync(denyMultiaddrsFilePath, 'utf-8');
denyMultiaddrsList = JSON.parse(denyMultiaddrsListObj);
}

const peerNodeInit: PeerInitConfig = {
denyMultiaddrs: denyMultiaddrsList,
maxConnections: argv.maxConnections,
dialTimeout: argv.dialTimeout,
maxRelayConnections: argv.maxRelayConnections,
Expand Down Expand Up @@ -73,6 +91,10 @@ function _getArgv (): any {
describe: 'Multiaddr of the primary relay node for this peer',
demandOption: true
},
denyMultiaddrs: {
type: 'string',
describe: 'Blacklisted multiaddr(s) list file path (json)'
},
maxConnections: {
type: 'number',
describe: 'Max number of connections for a peer'
Expand Down
2 changes: 2 additions & 0 deletions packages/cli/src/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ export class ServerCmd {
port: relayConfig.port ?? RELAY_DEFAULT_PORT,
announceDomain: relayConfig.announce,
relayPeers: relayConfig.relayPeers ?? [],
denyMultiaddrs: relayConfig.denyMultiaddrs ?? [],
dialTimeout: relayConfig.dialTimeout ?? DIAL_TIMEOUT,
pingInterval: relayConfig.pingInterval ?? DEFAULT_PING_INTERVAL,
redialInterval: relayConfig.redialInterval ?? RELAY_REDIAL_INTERVAL,
Expand All @@ -198,6 +199,7 @@ export class ServerCmd {
const peerNodeInit: PeerInitConfig = {
pingInterval: peerConfig.pingInterval,
pingTimeout: peerConfig.pingTimeout,
denyMultiaddrs: peerConfig.denyMultiaddrs,
maxRelayConnections: peerConfig.maxRelayConnections,
relayRedialInterval: peerConfig.relayRedialInterval,
maxConnections: peerConfig.maxConnections,
Expand Down
4 changes: 2 additions & 2 deletions packages/codegen/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/codegen",
"version": "0.2.40",
"version": "0.2.41",
"description": "Code generator",
"private": true,
"main": "index.js",
Expand All @@ -20,7 +20,7 @@
},
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@cerc-io/util": "^0.2.40",
"@cerc-io/util": "^0.2.41",
"@graphql-tools/load-files": "^6.5.2",
"@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",
"@solidity-parser/parser": "^0.13.2",
Expand Down
10 changes: 5 additions & 5 deletions packages/codegen/src/templates/package-template.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@
"dependencies": {
"@apollo/client": "^3.3.19",
"@ethersproject/providers": "^5.4.4",
"@cerc-io/cli": "^0.2.40",
"@cerc-io/ipld-eth-client": "^0.2.40",
"@cerc-io/solidity-mapper": "^0.2.40",
"@cerc-io/util": "^0.2.40",
"@cerc-io/cli": "^0.2.41",
"@cerc-io/ipld-eth-client": "^0.2.41",
"@cerc-io/solidity-mapper": "^0.2.41",
"@cerc-io/util": "^0.2.41",
{{#if (subgraphPath)}}
"@cerc-io/graph-node": "^0.2.40",
"@cerc-io/graph-node": "^0.2.41",
{{/if}}
"apollo-type-bigint": "^0.1.3",
"debug": "^4.3.1",
Expand Down
10 changes: 5 additions & 5 deletions packages/graph-node/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@cerc-io/graph-node",
"version": "0.2.40",
"version": "0.2.41",
"main": "dist/index.js",
"license": "AGPL-3.0",
"devDependencies": {
"@cerc-io/solidity-mapper": "^0.2.40",
"@cerc-io/solidity-mapper": "^0.2.41",
"@ethersproject/providers": "^5.4.4",
"@graphprotocol/graph-ts": "^0.22.0",
"@nomiclabs/hardhat-ethers": "^2.0.2",
Expand Down Expand Up @@ -51,9 +51,9 @@
"dependencies": {
"@apollo/client": "^3.3.19",
"@cerc-io/assemblyscript": "0.19.10-watcher-ts-0.1.2",
"@cerc-io/cache": "^0.2.40",
"@cerc-io/ipld-eth-client": "^0.2.40",
"@cerc-io/util": "^0.2.40",
"@cerc-io/cache": "^0.2.41",
"@cerc-io/ipld-eth-client": "^0.2.41",
"@cerc-io/util": "^0.2.41",
"@types/json-diff": "^0.5.2",
"@types/yargs": "^17.0.0",
"bn.js": "^4.11.9",
Expand Down
4 changes: 2 additions & 2 deletions packages/ipld-eth-client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/ipld-eth-client",
"version": "0.2.40",
"version": "0.2.41",
"description": "IPLD ETH Client",
"main": "dist/index.js",
"scripts": {
Expand All @@ -20,7 +20,7 @@
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@apollo/client": "^3.7.1",
"@cerc-io/cache": "^0.2.40",
"@cerc-io/cache": "^0.2.41",
"cross-fetch": "^3.1.4",
"debug": "^4.3.1",
"ethers": "^5.4.4",
Expand Down
2 changes: 1 addition & 1 deletion packages/peer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/peer",
"version": "0.2.40",
"version": "0.2.41",
"description": "libp2p module",
"main": "dist/index.js",
"exports": "./dist/index.js",
Expand Down
20 changes: 20 additions & 0 deletions packages/peer/src/cli/relay.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ interface Arguments {
announce?: string;
peerIdFile?: string;
relayPeers?: string;
denyMultiaddrs?: string;
dialTimeout: number;
pingInterval: number;
redialInterval: number;
Expand All @@ -31,6 +32,7 @@ async function main (): Promise<void> {
const argv: Arguments = _getArgv();
let peerIdObj: PeerIdObj | undefined;
let relayPeersList: string[] = [];
let denyMultiaddrsList: string[] = [];

if (argv.peerIdFile) {
const peerIdFilePath = path.resolve(argv.peerIdFile);
Expand All @@ -55,12 +57,26 @@ async function main (): Promise<void> {
relayPeersList = JSON.parse(relayPeersListObj);
}

if (argv.denyMultiaddrs) {
const denyMultiaddrsFilePath = path.resolve(argv.denyMultiaddrs);

if (!fs.existsSync(denyMultiaddrsFilePath)) {
console.log(`File at given path ${denyMultiaddrsFilePath} not found, exiting`);
process.exit();
}

console.log(`Reading blacklisted multiaddr(s) from file ${denyMultiaddrsFilePath}`);
const denyMultiaddrsListObj = fs.readFileSync(denyMultiaddrsFilePath, 'utf-8');
denyMultiaddrsList = JSON.parse(denyMultiaddrsListObj);
}

const relayNodeInit: RelayNodeInitConfig = {
host: argv.host,
port: argv.port,
peerIdObj,
announceDomain: argv.announce,
relayPeers: relayPeersList,
denyMultiaddrs: denyMultiaddrsList,
dialTimeout: argv.dialTimeout,
pingInterval: argv.pingInterval,
redialInterval: argv.redialInterval,
Expand Down Expand Up @@ -101,6 +117,10 @@ function _getArgv (): Arguments {
alias: 'r',
describe: 'Relay peer multiaddr(s) list file path (json)'
},
denyMultiaddrs: {
type: 'string',
describe: 'Blacklisted multiaddr(s) list file path (json)'
},
pingInterval: {
type: 'number',
describe: 'Interval to check relay peer connections using ping (ms)',
Expand Down
11 changes: 10 additions & 1 deletion packages/peer/src/peer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import {
P2P_WEBRTC_STAR_ID
} from './constants.js';
import { PeerHearbeatChecker } from './peer-heartbeat-checker.js';
import { debugInfoRequestHandler, dialWithRetry, getConnectionsInfo, getPseudonymForPeerId, getSelfInfo, wsPeerFilter } from './utils/index.js';
import { debugInfoRequestHandler, dialWithRetry, getConnectionsInfo, getPseudonymForPeerId, getSelfInfo, isMultiaddrBlacklisted, wsPeerFilter } from './utils/index.js';
import { ConnectionType, DebugPeerInfo, DebugRequest, PeerConnectionInfo, PeerSelfInfo } from './types/debug-info.js';

const log = debug('laconic:peer');
Expand All @@ -62,6 +62,7 @@ export interface PeerInitConfig {
pingTimeout?: number;
maxRelayConnections?: number;
relayRedialInterval?: number;
denyMultiaddrs?: string[];
maxConnections?: number;
minConnections?: number;
dialTimeout?: number;
Expand All @@ -78,6 +79,7 @@ export class Peer {

_relayRedialInterval?: number;
_maxRelayConnections?: number;
_denyMultiaddrs?: string[];

_debugInfoEnabled?: boolean;

Expand Down Expand Up @@ -114,6 +116,7 @@ export class Peer {

async init (initOptions: PeerInitConfig, peerIdObj?: PeerIdObj): Promise<void> {
this._relayRedialInterval = initOptions.relayRedialInterval;
this._denyMultiaddrs = initOptions.denyMultiaddrs;
this._maxRelayConnections = initOptions.maxRelayConnections;
this._debugInfoEnabled = initOptions.enableDebugInfo;
const pingTimeout = initOptions.pingTimeout ?? DEFAULT_PING_TIMEOUT;
Expand Down Expand Up @@ -164,6 +167,7 @@ export class Peer {
connectionManager: {
maxDialsPerPeer: MAX_CONCURRENT_DIALS_PER_PEER,
autoDial: false,
deny: initOptions.denyMultiaddrs,
maxConnections: initOptions.maxConnections ?? MAX_CONNECTIONS,
minConnections: initOptions.minConnections ?? MIN_CONNECTIONS,
dialTimeout: initOptions.dialTimeout ?? DIAL_TIMEOUT,
Expand Down Expand Up @@ -467,6 +471,11 @@ export class Peer {

let isRelayPeer = false;
for (const multiaddr of peer.multiaddrs) {
if (isMultiaddrBlacklisted(this._denyMultiaddrs ?? [], multiaddr)) {
log(`Ignoring blacklisted node with multiaddr ${multiaddr.toString()}`);
return;
}

if (this.isRelayPeerMultiaddr(multiaddr.toString())) {
isRelayPeer = true;
break;
Expand Down
15 changes: 11 additions & 4 deletions packages/peer/src/relay.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import {
DEBUG_INFO_TOPIC
} from './constants.js';
import { PeerHearbeatChecker } from './peer-heartbeat-checker.js';
import { debugInfoRequestHandler, dialWithRetry, getConnectionsInfo, getPseudonymForPeerId, getSelfInfo } from './utils/index.js';
import { debugInfoRequestHandler, dialWithRetry, getConnectionsInfo, getPseudonymForPeerId, getSelfInfo, isMultiaddrBlacklisted } from './utils/index.js';
import { PeerIdObj } from './peer.js';
import { SelfInfo, ConnectionInfo } from './types/debug-info.js';

Expand All @@ -40,6 +40,7 @@ export interface RelayNodeInitConfig {
peerIdObj?: PeerIdObj;
announceDomain?: string;
relayPeers: string[];
denyMultiaddrs: string[];
dialTimeout: number;
pingInterval: number;
pingTimeout?: number;
Expand Down Expand Up @@ -94,7 +95,8 @@ export async function createRelayNode (init: RelayNodeInitConfig): Promise<Libp2
connectionManager: {
maxDialsPerPeer: MAX_CONCURRENT_DIALS_PER_PEER,
autoDial: false,
dialTimeout: init.dialTimeout
dialTimeout: init.dialTimeout,
deny: init.denyMultiaddrs
},
ping: {
timeout: pingTimeout
Expand Down Expand Up @@ -157,7 +159,7 @@ export async function createRelayNode (init: RelayNodeInitConfig): Promise<Libp2

if (init.relayPeers.length) {
log('Dialling relay peers');
await _dialRelayPeers(node, init.relayPeers, init.maxDialRetry, init.redialInterval);
await _dialRelayPeers(node, init.relayPeers, init.denyMultiaddrs, init.maxDialRetry, init.redialInterval);
}

if (init.enableDebugInfo) {
Expand All @@ -168,9 +170,14 @@ export async function createRelayNode (init: RelayNodeInitConfig): Promise<Libp2
return node;
}

async function _dialRelayPeers (node: Libp2p, relayPeersList: string[], maxDialRetry: number, redialInterval: number): Promise<void> {
async function _dialRelayPeers (node: Libp2p, relayPeersList: string[], denyMultiaddrs: string[], maxDialRetry: number, redialInterval: number): Promise<void> {
relayPeersList.forEach(async (relayPeer) => {
const relayMultiaddr = multiaddr(relayPeer);
if (isMultiaddrBlacklisted(denyMultiaddrs, relayMultiaddr)) {
log(`Ignoring blacklisted node with multiaddr ${relayMultiaddr.toString()}`);
return;
}

await dialWithRetry(
node,
relayMultiaddr,
Expand Down
11 changes: 11 additions & 0 deletions packages/peer/src/utils/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,17 @@ export const getPseudonymForPeerId = (peerId: string): string => {
});
};

/**
* Method to check if the given multiaddr is part of a blacklist
* @param blacklist
* @param multiaddr
*/
export const isMultiaddrBlacklisted = (blacklist: string[], multiaddr: Multiaddr): boolean => {
return blacklist.some(maString => {
return multiaddr.toString().startsWith(maString);
});
};

/**
* Handler for pubsub debug info request
* @param peerId
Expand Down
4 changes: 2 additions & 2 deletions packages/solidity-mapper/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@cerc-io/solidity-mapper",
"version": "0.2.40",
"version": "0.2.41",
"main": "dist/index.js",
"license": "AGPL-3.0",
"devDependencies": {
"@cerc-io/ipld-eth-client": "^0.2.40",
"@cerc-io/ipld-eth-client": "^0.2.41",
"@ethersproject/abi": "^5.3.0",
"@nomiclabs/hardhat-ethers": "^2.0.2",
"@nomiclabs/hardhat-waffle": "^2.0.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/test/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/test",
"version": "0.2.40",
"version": "0.2.41",
"main": "dist/index.js",
"license": "AGPL-3.0",
"private": true,
Expand Down
2 changes: 1 addition & 1 deletion packages/tracing-client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/tracing-client",
"version": "0.2.40",
"version": "0.2.41",
"description": "ETH VM tracing client",
"main": "dist/index.js",
"scripts": {
Expand Down
Loading