https://github.com/redis-developer/basic-redis-rate-limiting-demo-csharp-dot-net
Basic redis rate limiting demo written in C# .net
https://github.com/redis-developer/basic-redis-rate-limiting-demo-csharp-dot-net
Last synced: 6 months ago
JSON representation
Basic redis rate limiting demo written in C# .net
- Host: GitHub
- URL: https://github.com/redis-developer/basic-redis-rate-limiting-demo-csharp-dot-net
- Owner: redis-developer
- License: mit
- Created: 2021-02-27T04:21:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T07:43:41.000Z (over 2 years ago)
- Last Synced: 2025-04-12T03:53:09.561Z (11 months ago)
- Language: C#
- Size: 2.36 MB
- Stars: 6
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rate Limiting app in .NET using Redis
This demo shows how how to use Redis in .NET 5 to implement IP Rate limiting to prevent excessive calls to your app from a single client.
## Technical Stack
- Frontend: ASP.NET Core MVC
- Backend: ASP.NET Core MVC / Redis
## How it works?
### 1. How the data is stored:
- New responses are added key-ip: `SETNX your_ip:PING limit_amount`
- E.g `SETNX 127.0.0.1:PING 10`
more information
- Set a timeout on key: `EXPIRE your_ip:PING timeout`
- E.g `EXPIRE 127.0.0.1:PING 1000`
more information
### 2. How the data is accessed:
- Next responses are get bucket: `GET your_ip:PING`
- E.g `GET 127.0.0.1:PING`
more information
- Next responses are changed bucket: `DECRBY your_ip:PING amount`
- E.g `DECRBY 127.0.0.1:PING 1`
more information
#### Code used for configuring rate limiting
When configuring constructing our app's middleware in Startup.cs, we initialize the cache client and inject it into our services. We then pull from the configuration the `IpRateLimit` section, and use that as the configuration for `IpRateLimitOptions`
```C#
using AspNetCoreRateLimit;
// ...
services.AddStackExchangeRedisCache(options =>
{
options.ConfigurationOptions = ConfigurationOptions.Parse(redisConnectionUrl);
});
services.Configure(Configuration.GetSection("IpRateLimit"));
services.AddSingleton();
services.AddSingleton();
services.AddSingleton();
//...
app.UseIpRateLimiting();
```
The `IpRateLimit` section is from the `appsettings.json` file:
```json
"IpRateLimit": {
"EnableEndpointRateLimiting": true,
"StackBlockedRequests": false,
"RealIPHeader": "X-Real-IP",
"ClientIdHeader": "X-ClientId",
"HttpStatusCode": 429,
"GeneralRules": [
{
"Endpoint": "*:/api/*",
"Period": "10s",
"Limit": 10
}
]
}
```
This section dictates the period the path which limitations will be applied to, `Endpoint`, the period over which restrictions are considered, `Period`, and the Limit for the number of requests permitted in that period `Limit`
---
## How to run it locally?
```
git clone https://github.com/redis-developer/basic-redis-rate-limiting-demo-csharp-dot-net.git
```
#### Write in environment variable or Dockerfile actual connection to Redis:
```
REDIS_ENDPOINT_URL = "Redis server URI:PORT"
REDIS_PASSWORD = "Password to the server"
```
#### Run backend
```sh
dotnet run
```
Static content runs automatically with the backend part.
## Try it out
#### Deploy to Heroku
#### Deploy to Google Cloud
