In this attackathon, your task will be to write a program that performs a channel jamming attack against a test lightning network. Your goal is to completely jam a routing node for an hour.
Your program should:
- Accept the public key of the node being attacked as a parameter.
- Write an attack against the hybrid approach to jamming mitigations which is deployed on the network.
- Open any channels required to perform the attack, and close them when the attack has competed.
The final deliverable for the attackathon is a run script that downloads, installs and runs your attack in a kubernetes cluster.
We're aiming to jam a routing node, which we define as:
The target node is unable to facillitate forwading of HTLCs on behalf
of of nodes in the network.
Conventionally, this is achieved when:
All of the target node's local(/outbound) HTLC slots are occupied.
OR
All of the target node's local(/outbound) liquidity is occupied.
However, given that we are operating within the context of a specific mitigation, we need to consider the possibility that the attack may try to use the mitigation itself to disrupt quality of service.
In general, our reputation and resource bucketing mitigation may be abused by an attacker to jam a channel if:
All of its general bucket's local(/outbound) liquidity OR slots are occupied.
AND
Peers looking to use the channel have low reputation.
When the attacker manages to successfully sabotage the reputation and fill up general slots, the channel is effectively jammed because peers looking to use the channel do not have access to the projected slots that are reserved for high reputation peers. This may be abused in various ways, and we encourage you to explore them!
The attack you develop will be tested against a warnet running a network of LND nodes that have the jamming attack mitigation implemented* (via an external tool called circuitbreaker).
To assist with local development, we've provided a test network that can be used to run your attacks against. Prerequisites to set up this network are:
- Python3
- Docker
- Kubernetes (see docker desktop or minikube instructions)
- Just
- jq
Clone the attackathon repo and cd into it:
git clone https://github.com/carlaKC/attackathon
cd attackathon
The following scripts can be run from the attackathon
directory to
manage your network:
- Warnet server: ./scripts/start_warnet.sh
sets up the warnet server, which is responsible for orchestration of
the network.
- You'll only need to do this once, but leave it running!
- When you're done with it, bring it down with ./scripts/stop_warnet.sh
- Start network: ./scripts/start_network.sh ln_10
brings up your lightning network, opens channels, simulates
random payments in the network and mines blocks every 5 minutes.
- If you want to kill your test network and start fresh, you can use ./scripts/stop_network.sh ln_10
- You need to wait for this script to complete before you can start your attacking pod!
Wait for your network to fully come up, then you can start your pod of attacking nodes:
- Start attacking pods: ./scripts/start_attacker.sh ln_10
brings up three lightning nodes that you will use for your attack,
a bitcoin node and an empty
flagship
container to run your attack from.- You can use ./scripts/stop_attacker.sh to tear this down if you'd like to start over at any point.
Once you have brought your cluster up, you'll be able to execute your
program from inside of the cluster's flagship
pod:
kubectl exec -it flagship -n warnet-armada -- bash
- Update
run.sh
to:- Install your program.
- Run your program using the credentials provided inline.
endorsement
fields (golang client
is available here).
The following utilities are available for your convenience:
source ./lncli.sh
provides aliases for your LND nodes (lncli0
,lncli1
,lncli2
)./fund.sh
funds each of your LND nodes../connect_nodes.sh
connects the attacking nodes to the network so that they can sync gossip.bitcoin-cli
provides access to the bitcoin node that all three LND nodes are connected to.
Some relevant characteristics of the network:
- The reputation system has been primed with historical forwarding data, so nodes in the network have already had a chance to build up reputation before the attack begins.
- Each node in the network:
- Allows 483 HTLCs in flight per channel.
- Allows 45% of its channel's capacity in flight.
- Allocates 50% of these resources to "general" traffic, and 50% to protected traffic.
- The graph was obtained by reducing the mainnet graph using a random walk around our target node, and real-world routing policies are used.
- When you run the attack, the non-malicious nodes in the network will be executing randomly generated payments to mimic an active network.
Some APIS to note:
- AddHoldInvoice creates an invoice that can be manually settled or canceled
- Endorsement signals can be set on the SendToRoute or SendPayment APIs.
* Note that endorsement signaling and reputation tracking are fully deployed on the test network, but unconditional fees are not. You should assume that they will be 1% of your success-case fees, and we will account for them during attack analysis.
Attacks will be assessed using the following measures:
- Did the attack achieve a jamming attack as described above?
- What was the total cost of the attack, considering:
- On-chain fees: for channel opens and closes, sending funds between nodes on-chain will node be included for simplicity's sake.
- Off-chain fees: the sum of fees paid for successful off-chain payments plus 1% of the success-case fees for all payments that are sent to represent unconditional fees.
- Opportunity cost of capital: for each channel that is opened, 5% p.a. charged on the total capital deployed in the channels, assuming 10 minute blocks.
- When compared to the operation of the network without a jamming attack, how many honest htlcs were dropped as a result of the attack?
A work-in-progress analysis script requires your network name to run. You may optionally provide the end timestamp (unix nano) of your attack to get a more precise comparison period (the present time will otherwise be used as the time of attack).
It can be run from within the attackathon repo:
python3 analysis/analyse_attack.py ln_10 [endtime_ns]
We're trying to break channel jamming mitigations, not our setup itself so please be a good sport and let us know if there's anything buggy! Real attackers won't be able to take advantage of our test setup, so neither should we.
Participants do not need to read the following section, it contains instructions on how to setup a warnet network to run the attackathon on.
Setup Instructions
To get started clone the attackathon repo and cd into it:
git clone https://github.com/carlaKC/attackathon
cd attackathon
You will need to provide:
- A
json
file with the same format as LND'sdescribegraph
output which describes the graph that you'd like to simulate. - The duration of time, expressed in seconds, that you'd like the setup script to generate fake historical forwards for all the nodes in the network for.
- Manually add the alias of the node that you're attacking to
attackathon/data/{network name}/target.txt
once this script has run.
The setup script provided will generate all required files and docker
images for you:
./setup/create_network.sh {path to json file} {duration in seconds}
Note that you must run this from your directory containing warnet
,
simln
and circuitbreaker
because it moves between directories to
achieve various tasks! The name that you give the json
file is
considered to be your network_name
.
Once the script has completed, check in any files that it generated and provide your students with the following:
- The
network_name
for your attackathon. - The attackathon repo (/branch) with all files checked in.
The script currently hardcodes the docker hub account for images to
carlakirkcohen
and tries to push to it, so you'll need to search and
replace if you want to test the full flow.
A utility script is provided to add an attacking node to an existing
graph. It will copy the source_network
's graph file, inserting an
attacking node that has the following channels:
- One direct channel with the target node (supplied in
target_pk
) - Direct channels with the
N
largest nodes in the network that are not connected to the target node (whereN = node count / 10
).
python3 attackathon/setup/add_attacking_node.py {source_network} {target_pk} {dest_network}
This script can be used with create_network
to generate an image that
has reputation history for the attacking node.
You can also run a script to generate projected payment data for a given network. This may take a while, as it runs the simulator 10 times to aggregate expected values over multiple runs (it is not perfectly deterministic). This data is not currently checked into the repo to save space.
./attackathon/setup/get_projections.sh <network name>