API Sequence Mitigation Demo
Sequence mitigation is a great tool to enforce the order of APIs and can be used as an extra layer to protect you API endpoints/Application.
API Sequence Mitigation Demo
Sequence mitigation is a great tool to enforce the order of APIs and can be used as an extra layer to protect you API endpoints/Application.
Key considerations/limitations:
CommentSession identifier required - If the application/API endpoints aren't protected and don't carry a unique identifer, alternative to that would be the cookie based sequence mitigation introduced by BoTM.
- Session identifier required - If the application/API endpoints aren't protected and don't carry a unique identifer, alternative to that would be the cookie based sequence mitigation introduced by BoTM.
- Only stores the last 10 requested endpoints by each API user (Session identifier used to track this)
- Only supports 2 endpoints in a policy i.e. start API endpoint and a Final API endpoint
- Can only lookback up to 10 minutes
Implementation of the demo:

in this case banking application where "normal" users wouldn't jump straight to transfer before performing pre-requisites actions (mapping to API calls (1) and (2)).
We will use Workers to host the backend and front-end of the application:

Endpoints setup on API shield:
Setup the 3 endpoints manually in Endpoint Management

Setup the session identifiers in API shield:

Setup the sequence mitigations: Due to the limitation of max 2 endpoint/APIs per rule, we are setting up 2 rules as per below

Rule 1:
Rule 2:
Demo
https://apisequences.mythingy.io/
Workers setup:
workers.js
import indexHtml from './index.html';
export default {
async fetch(request) {
const url = new URL(request.url);
if (url.pathname === '/') {
return new Response(indexHtml, {
headers: { 'content-type': 'text/html' },
});
} else if (url.pathname === '/users/jamal/accounts') {
return new Response(JSON.stringify({
name: "Jamal",
address: "1234 Elm Street",
bankName: "Demo Bank",
accountNumber: "5678-1234-5678"
}), { headers: { 'content-type': 'application/json' } });
} else if (url.pathname === '/accounts/2048/balance') {
return new Response(JSON.stringify({
name: "Jamal",
address: "1234 Elm Street",
bankName: "Demo Bank",
accountNumber: "5678-1234-5678",
balance: "$10,000.00"
}), { headers: { 'content-type': 'application/json' } });
} else if (url.pathname === '/transfer' && request.method === 'POST') {
const from = url.searchParams.get('from');
const to = url.searchParams.get('to');
return new Response(JSON.stringify({
sourceAccount: from,
destinationAccount: to,
amount: "$5,000.00"
}), { headers: { 'content-type': 'application/json' } });
} else {
return new Response(JSON.stringify({ error: 'Not Found' }), { status: 404, headers: { 'content-type': 'application/json' } });
}
}
}
index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Bank Interface</title>
<style>
body {
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
background-color: #f0f4f8;
color: #333;
margin: 0;
padding: 0;
display: flex;
justify-content: center;
align-items: center;
height: 100vh;
}
.container {
background-color: #ffffff;
border-radius: 10px;
box-shadow: 0 10px 20px rgba(0, 0, 0, 0.1);
width: 400px;
padding: 30px;
text-align: center;
}
.header {
margin-bottom: 20px;
}
.header img {
height: 50px;
}
.header h1 {
font-size: 24px;
color: #2c3e50;
margin-top: 10px;
}
.auth-input {
margin-bottom: 20px;
text-align: left;
}
.auth-input label {
display: block;
font-weight: bold;
margin-bottom: 5px;
color: #2c3e50;
}
.auth-input input {
width: 100%;
padding: 10px;
border: 1px solid #ccc;
border-radius: 5px;
margin-bottom: 10px;
}
.auth-input button {
background-color: #3498db;
color: white;
padding: 10px 20px;
border: none;
border-radius: 5px;
cursor: pointer;
width: 100%;
font-size: 16px;
}
.auth-input button:hover {
background-color: #2980b9;
}
ul {
list-style-type: none;
padding: 0;
margin: 20px 0;
}
li a {
text-decoration: none;
color: #3498db;
font-size: 18px;
display: block;
padding: 10px 0;
border-bottom: 1px solid #e0e0e0;
}
li a:hover {
color: #2980b9;
}
#error-message {
margin-top: 20px;
color: #e74c3c;
font-weight: bold;
}
#content {
margin-top: 20px;
text-align: left;
}
</style>
</head>
<body>
<div class="container">
<div class="header">
<img src="https://www.commbank.com.au/content/dam/caas/newsroom/images/logo_evolution_newsroom_1.png" alt="Bank Logo">
<h1>Welcome to Jamal's Demo Bank</h1>
</div>
<div class="auth-input">
<label for="auth-token">Authorization Token:</label>
<input type="text" id="auth-token" placeholder="Enter your token">
<button id="save-auth">Save Token</button>
</div>
<ul>
<li><a href="#" id="account-link">GET /users/jamal/accounts</a></li>
<li><a href="#" id="balance-link">GET /accounts/2048/balance</a></li>
<li><a href="#" id="transfer-link">POST /transfer?from=1515&to=2048</a></li>
</ul>
<div id="content"></div>
<div id="error-message"></div>
</div>
<script>
let authToken = localStorage.getItem('authToken') || '';
document.getElementById('save-auth').addEventListener('click', () => {
authToken = document.getElementById('auth-token').value;
localStorage.setItem('authToken', authToken);
alert('Authorization token saved!');
});
async function handleApiCall(url, options = {}) {
try {
const response = await fetch(url, {
...options,
headers: { 'Authorization': `Bearer ${authToken}`, ...options.headers }
});
if (response.status === 403) {
throw new Error('403 Forbidden: You do not have permission to access this resource.');
} else if (!response.ok) {
throw new Error(`Error: ${response.status} ${response.statusText}`);
}
const data = await response.json();
document.getElementById('error-message').textContent = ''; // Clear any previous error
return data;
} catch (error) {
document.getElementById('error-message').textContent = error.message;
}
}
document.getElementById('account-link').addEventListener('click', async () => {
const data = await handleApiCall('/users/jamal/accounts');
if (data) {
document.getElementById('content').innerHTML = `
<p>Name: ${data.name}</p>
<p>Address: ${data.address}</p>
<p>Bank Name: ${data.bankName}</p>
<p>Account Number: ${data.accountNumber}</p>
`;
}
});
document.getElementById('balance-link').addEventListener('click', async () => {
const data = await handleApiCall('/accounts/2048/balance');
if (data) {
document.getElementById('content').innerHTML = `
<p>Name: ${data.name}</p>
<p>Address: ${data.address}</p>
<p>Bank Name: ${data.bankName}</p>
<p>Account Number: ${data.accountNumber}</p>
<p>Balance: ${data.balance}</p>
`;
}
});
document.getElementById('transfer-link').addEventListener('click', async () => {
const data = await handleApiCall('/transfer?from=1515&to=2048', { method: 'POST' });
if (data) {
document.getElementById('content').innerHTML = `
<p>Source Account: ${data.sourceAccount}</p>
<p>Destination Account: ${data.destinationAccount}</p>
<p>Amount: ${data.amount}</p>
`;
}
});
</script>
</body>
</html>
附件
- 📎 https-files.gitbook.com-v0-b-gitbook-x-prod.appspot.com-o-spaces-2FER0NL5kECmloTHBH7PHC-2Fuploads-2F.bin (92 KB)
- 📎 https-files.gitbook.com-v0-b-gitbook-x-prod.appspot.com-o-spaces-2FER0NL5kECmloTHBH7PHC-2Fuploads-2F.bin (89 KB)
- 📎 https-files.gitbook.com-v0-b-gitbook-x-prod.appspot.com-o-spaces-2FER0NL5kECmloTHBH7PHC-2Fuploads-2F.bin (40 KB)