BGP anomalies
BetaTo access Cloudflare Radar BGP Anomaly Detection results, you will first need to create an API token that includes a User:User Details permission. All the following examples should work with a free-tier Cloudflare account.
In the following example, we will query the BGP hijack events API for the most recent BGP origin hijacks originated by or affecting AS64512 (example ASN).
curl "https://api.cloudflare.com/client/v4/radar/bgp/hijacks/events?invlovedAsn=64512&format=json&per_page=10" \--header "Authorization: Bearer <API_TOKEN>"The result shows the most recent 10 BGP hijack events that affects AS64512.
{ "success": true, "errors": [], "result": { "asn_info": [ { "asn": 64512, "org_name": "XXXXX", "country_code": "XX" }, ... ], "events": [ { "duration": 0, "event_type": 0, "hijack_msgs_count": 1, "hijacker_asn": 64512, "id": 1234, "is_stale": false, "max_hijack_ts": "2023-04-27T14:01:55.952", "max_msg_ts": "2023-04-27T14:01:55.952", "min_hijack_ts": "2023-04-27T14:01:55.952", "on_going_count": 1, "peer_asns": [ 8455 ], "peer_ip_count": 1, "prefixes": [ "192.0.2.0/24" ], "tags": [ { "name": "irr_new_origin_invalid", "score": 4 }, { "name": "irr_old_origin_valid", "score": 0 }, ... ], "victim_asns": [ 64513 ], "confidence_score": 4 }, ], "total_monitors": 163 }, ...}In the response we can learn about the following information about each event:
hijack_msg_count: the number of potential BGP hijack messages observed from all peers.peer_asns: the AS numbers of the route collector peers who observed the hijack messages.prefixes: the affected prefixes.hijacker_asnandvictim_asns: the potential hijacker ASN and victim ASNs.confidence_score: a quantitative score describing how confident the system is for this event being a hijack:- 1-3: low confidence.
- 4-7: medium confidence.
- 8-above: high confidence.
tags: the evidence collected for the events. Eachtagis also associated with a score that affects the overall confidence score:- a positive score indicates that the event is more likely to be a hijack.
- a negative score indicates that the event is less likely to be a hijack.
Users can further filter out low-confidence events by attaching a minConfidence=8 parameter, which will return only events with a confidence_score of 8 or higher.
curl "https://api.cloudflare.com/client/v4/radar/bgp/hijacks/events?invlovedAsn=64512&format=json&per_page=10&minConfidence=8" \--header "Authorization: Bearer <API_TOKEN>"BGP route leak is another type of BGP anomalies that Cloudflare Radar detects. Currently, we focus on detecting specifically
the provider-customer-provider type of route leak. You can learn more about our design and methodology in our blog post ↗.
In the following example, we will query the BGP route leak events API for the most recent BGP route leak events affecting AS64512.
curl "https://api.cloudflare.com/client/v4/radar/bgp/leaks/events?invlovedAsn=64512&format=json&per_page=10" \--header "Authorization: Bearer <API_TOKEN>"The result shows the most recent 10 BGP route leak events that affects AS64512.
{ "success": true, "errors": [], "result": { "asn_info": [ { "asn": 64512, "org_name": "XXXXXXX", "country_code": "XX" }, ... ], "events": [ { "detected_ts": "2023-04-21T23:10:06", "finished": false, "id": 1234, "leak_asn": 64512, "leak_count": 14, "leak_seg": [ 64514, 64512, 64513 ], "leak_type": 1, "max_ts": "2023-04-21T23:10:56", "min_ts": "2023-04-21T23:09:46", "origin_count": 1, "peer_count": 13, "prefix_count": 1 }, ... ] }, ...}In the response we can learn about the following information about each event:
leak_asn: the AS who potentially caused the leak.leak_seg: the AS path segment observed and believed to be a leak.min_tsandmax_ts: the earliest and latest timestamps of the leak announcements.leak_count: the total number of BGP route leak announcements observed.peer_count: the number of route collector peers observed the leak.prefix_countandorigin_count: the number of prefixes and origin ASes affected by the leak.
In this example, we will show you how you can build a Cloudflare Workers app that sends out alerts for BGP hijacks relevant to a given ASN using webhooks (works for Google Hangouts, Discord, Telegram, etc) or email.
We will use Cloudflare Workers as the platform and use its Cron Triggers to periodically check for new alerts.
For the app, we would like it to do the following things:
- Fetch from Cloudflare API with a given API token.
- Check against Cloudflare KV to know what events are new.
- Construct messages for new hijacks and send out alerts via webhook triggers.
We will start with setting up a Cloudflare Worker app.
First, create a new Workers app in a local directory:
npm create cloudflare@latest -- hijack-alertsyarn create cloudflare@latest hijack-alertspnpm create cloudflare@latest hijack-alertsFor setup, select the following options:
- For What would you like to start with?, choose
Hello World example. - For Which template would you like to use?, choose
Hello World Worker. - For Which language do you want to use?, choose
JavaScript. - For Do you want to use git for version control?, choose
Yes. - For Do you want to deploy your application?, choose
No(we will be making some changes before deploying).
To start developing your Worker, cd into your new project directory:
cd hijack-alertsIn your wrangler.toml file, change the default checking frequency (once per hour) to what you like. Here is an example
of configuring the workers to run the script five minutes.
name = "hijack-alerts"main = "src/index.js"compatibility_date = "2023-04-27"
[triggers]crons = [ "*/5 * * * *" ]In this example, we will also need to use Cloudflare KV to save the latest checked event IDs which allows us to know what events are new. Once you have created a KV, you can head back to the wranglers.toml file and add the following sections:
[[kv_namespaces]]binding = "HIJACKS_KV"id = "KV_ID_FOR_PRODUCTION"preview_id = "TEMPORARY_KV_FOR_DEV_ENVIRONMENT"Start with the API fetching function.
The following apiFetch(env, paramsStr) handles taking in a request parameters string, construct proper headers and
fetch from the Cloudflare API BGP hijacks endpoint.
async function apiFetch(env, paramsStr) { const config = { headers: { Authorization: `Bearer ${env.CF_API_TOKEN}`, }, }; const res = await fetch( `https://api.cloudflare.com/client/v4/radar/bgp/hijacks/events?${paramsStr}`, config, );
if (!res.ok) { console.log(JSON.stringify(res)); return null; } return await res.json();}The env parameter is passed in from the caller, and we do not need to worry about construct it. The paramsStr is a
string variable that holds the query parameters in a query URL.
Now in our main cron trigger function, we will need to construct the query parameters and call the API fetch function. The default cron trigger worker script is defined as the follows:
export default { async scheduled(controller, env, ctx) { ... }}In our example, we use the env variables to get the runtime variables like the TOKEN and ASN of interest, and Cloudflare
KV bindings. We do not use the controller and ctx variables in this example.
First, we will need to learn about what are the new events. We define new events as the events the app has not yet processed.
We use the Cloudflare KV bucket previously created and defined (HIJACKS_KV) to save and retrieve the most recent
processed event ID.
let kv_latest_id = parseInt(await env.HIJACKS_KV.get("latest_id"));const first_batch = isNaN(kv_latest_id);The main loop that checks for the most recent events looks like this (some of the validation code is skipped):
let new_events = [];let page = 1;while (true) { // query for events const query_params = `per_page=10&page=${page}&involvedAsn=${env.TARGET_ASN}&sortBy=ID&sortOrder=DESC`; const data = await apiFetch(env, query_params);
// first batch, save KV value only if (first_batch) { await env.HIJACKS_KV.put("latest_id", events[0].id.toString()); return; }
// some validation skipped // ...
let reached_last = false; for (const event of data.result.events) { if (event.id <= kv_latest_id) { // reached the latest events reached_last = true; break; } new_events.push(event); } if (reached_last) { break; } page += 1;}Now that we have all the newly detected events saved in new_events variable, we can then send out alerts:
// sort events by increasing ID ordernew_events.sort((a, b) => a.id - b.id);const kv_latest_id = new_events[new_events.length - 1].id;// push new eventsfor (const event of new_events) { await send_alert(env, event);}// update latest_id KV valueawait env.HIJACKS_KV.put("latest_id", kv_latest_id.toString());The function send_alert handles constructing alert message and sending out alerts using webhook. Here we demonstrate
an example plain-text message template using Google Hangouts webhook. Users can customize the message and the use of webhook based on their
platform of choice and needs.
async function send_hangout_alert(env, event) { const webhook_url = `${env.WEBHOOK_URL}&threadKey=bgp-hijacks-event-${event.id}`;
const data = JSON.stringify({ text: `Detected BGP hijack event (${event.id}):Detected time: *${event.min_hijack_ts} UTC*Detected ASN: *${event.hijacker_asn}*Expected ASN(s): *${event.victim_asns.join(" ")}*Prefixes: *${event.prefixes.join(" ")}*Tags: *${event.tags.map((tag) => tag.name).join(" ")}*Peer Count: *${event.peer_ip_count}*`, }); await fetch(webhook_url, { method: "POST", headers: { "Content-Type": "application/json; charset=UTF-8", }, body: data, });}Note that the webhook is considered secret and should be set to the environment via wrangler secret put WEBHOOK_URL command.
The last step is to deploy the application with command npx wrangler deploy and the app should be up and running on your Cloudflare account, and will be triggered to execute every five minutes.
If you have Email Routing enabled for your domain, you can also send email alerts directly from Workers. Refer to Send emails from Workers to learn more.
For this alert to work, you will need to configure the proper email bindings in the wrangler.toml file.
send_email = [ {type = "send_email", name = "SEND_EMAIL_BINDING", destination_address = "<YOUR_EMAIL>@example.com"},]Then, you can create an email-sending function to send alert emails to your configured destination address:
async function send_email_alert(hijacker, prefixes, victims) { const msg = createMimeMessage(); msg.setSender({ name: "BGP Hijack Alerter", addr: "<YOUR_APP>@<YOUR_APP_DOMAIN>", }); msg.setRecipient("<YOUR_EMAIL>@example.com"); msg.setSubject("BGP hijack alert"); msg.addMessage({ contentType: "text/plain", data: `BGP hijack detected: Detected origin: ${hijacker} Expected origins: ${victims.join(" ")} Prefixes: ${prefixes.join(" ")} `, });
var message = new EmailMessage( "<YOUR_APP>@<YOUR_APP_DOMAIN>", "<YOUR_EMAIL>@example.com", msg.asRaw(), ); try { await env.SEND_EMAIL_BINDING.send(message); } catch (e) { return new Response(e.message); }}Refer to our API documentation for BGP route leaks and BGP hijacks for more information on these topics.