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.

Sign up for GitHub

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

Update RateLimiter.cfc, fix for CONTENTBOX-1512 #608

Merged
merged 3 commits into from
Jun 26, 2024
Merged

Update RateLimiter.cfc, fix for CONTENTBOX-1512 #608

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34df992
Update RateLimiter.cfc, fix for CONTENTBOX-1512
GunnarLieb Jun 25, 2024
6fd7639
Merge branch 'Ortus-Solutions:development' into patch-1
GunnarLieb Jun 26, 2024
447398c
Update RateLimiter.cfc
GunnarLieb Jun 26, 2024
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
113 changes: 42 additions & 71 deletions modules/contentbox/models/security/RateLimiter.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,7 @@ component extends="coldbox.system.Interceptor" {
// DI
property name="settingService" inject="id:settingService@contentbox";
property name="securityService" inject="id:securityService@contentbox";

/**
* Configure
*/
function configure(){
// the limiter data
variables.limitData = {};
}
property name = "cachebox" inject = "Cachebox";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the cfformater please, so it uses the formatting rules.


/**
* Limiter
Expand All @@ -42,99 +35,77 @@ component extends="coldbox.system.Interceptor" {
}
}

/**
* Written by Charlie Arehart, [email protected], in 2009, updated 2012, modified by Luis Majano 2016
* - Throttles requests made more than "count" times within "duration" seconds from single IP.
* - Duck typed for performance
*
* @count The throttle counter
* @duration The time in seconds to limit
* @event The request context object
* @settings The settings structure
*/
private function limiter( count, duration, event, settings ){
/**
* Written by Charlie Arehart, [email protected], in 2009, updated 2012, modified by Luis Majano 2016
* - Throttles requests made more than "count" times within "duration" seconds from single IP.
* - Duck typed for performance
* @count The throttle counter
* @duration The time in seconds to limit
* @event The request context object
* @settings The settings structure
*/
private function limiter( count, duration, event, settings ) {
// Get real IP address of requester
var realIP = variables.securityService.getRealIP();
var realIP = variables.securityService.getRealIP();
var cache = cachebox.getDefaultCache();
var cacheKey = 'limiter'&realIP;

// If first time visit, create record.
if ( !structKeyExists( variables.limitData, realIP ) ) {
lock name="cb-ratelimiter-#hash( realIP )#" type="exclusive" throwontimeout="true" timeout="5" {
if ( !structKeyExists( variables.limitData, realIP ) ) {
variables.limitData[ realIP ] = { attempts : 1, lastAttempt : now() };
return this;
}
}
}

lock name="cb-ratelimiter-#hash( realIP )#" type="readonly" throwontimeout="true" timeout="5" {
var targetData = variables.limitData[ realIP ];
var targetData = cache.get( cacheKey );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

best to use the getOrSet() for these type of situations.https://s3.amazonaws.com/apidocs.ortussolutions.com/cachebox/7.4.0/cachebox/system/cache/AbstractCacheBoxProvider.html#getOrSet()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like this? But how to handle, if cache key doesn't exist return default value (no further execution!

		var targetData = cache.getOrSet( cacheKey, function(){
				return { attempts = 0, lastAttempt = now() }
		} );

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What this does is pretty much what you did manually. If the cacheKey exists, it returns the value of the cache. If it doesn't, it will seed it with the return value of the supplier function.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, got it, but in case value is created I don't want to execute further code. Original code did this:
if( isNull( targetData ) ){ cache.set( cacheKey, { attempts = 1, lastAttempt = now() }); return this; }

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh ok. Well, you would say

if( targetData.attempts == 1 ){
  return this;

The usage of getOrSet() is preferred as it does internal locking

Copy link
Contributor Author

@GunnarLieb GunnarLieb Jun 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get the locking mechanism, to make it working I have to write something like this.
`var targetData = cache.getOrSet( cacheKey, function(){
return { attempts = 0, lastAttempt = now() }
} );

	// on first visit no further processing
	if( targetData.attempts == 0 ){
		targetData.attempts++;
		cache.set( cacheKey, targetData );
		return this;
	}`

if( isNull( targetData ) ){
cache.set( cacheKey, { attempts = 1, lastAttempt = now() });
return this;
}

log.debug( "Limit data", targetData );
// log.info( "DateDiff " & dateDiff( "s", targetData.lastAttempt, Now() ) );
// log.info( "Within Duration " & dateDiff( "s", targetData.lastAttempt, Now() ) LT arguments.duration );

//log.info( "DateDiff " & dateDiff( "s", targetData.lastAttempt, Now() ) );
//log.info( "Within Duration " & dateDiff( "s", targetData.lastAttempt, Now() ) LT arguments.duration );
// Are we executing another request withing our duration in seconds? Ex: Has X seconds passed before last attempt
if ( dateDiff( "s", targetData.lastAttempt, now() ) LT arguments.duration ) {
if( dateDiff( "s", targetData.lastAttempt, Now() ) LT arguments.duration ){
// Limit by count?
if ( targetData.attempts GT arguments.count ) {
if ( settings.cb_security_rate_limiter_logging && log.canInfo() ) {
if( targetData.attempts GT arguments.count ){

if( settings.cb_security_rate_limiter_logging && log.canInfo() ){
// Log it to app logs
log.info(
"'limiter invoked for:','#realIP#',#targetData.attempts#,#cgi.request_method#,'#cgi.SCRIPT_NAME#', '#cgi.QUERY_STRING#','#cgi.http_user_agent#','#targetData.lastAttempt#',#listLen( cgi.http_cookie, ";" )#"
);
log.info( "'limiter invoked for:','#realIP#',#targetData.attempts#,#cgi.request_method#,'#cgi.SCRIPT_NAME#', '#cgi.QUERY_STRING#','#cgi.http_user_agent#','#targetData.lastAttempt#',#listlen(cgi.http_cookie,";" )#" );
}

// Log attempt
lock name="cb-ratelimiter-#hash( realIP )#" type="exclusive" throwontimeout="true" timeout="5" {
targetData.attempts++;
targetData.lastAttempt = now();
}
targetData.attempts++;
targetData.lastAttempt = now();
cache.set( cacheKey, targetData );

// Do we have a redirect URL setup?
if ( len( settings.cb_security_rate_limiter_redirectURL ) ) {
location(
settings.cb_security_rate_limiter_redirectURL,
"false",
"301"
);
if( len( settings.cb_security_rate_limiter_redirectURL ) ){
location( settings.cb_security_rate_limiter_redirectURL, "false", "301" );
return;
}

// Output Message
writeOutput(
replaceNoCase(
settings[ "cb_security_rate_limiter_message" ],
"{duration}",
arguments.duration,
"all"
)
writeOutput(
replaceNoCase( settings[ "cb_security_rate_limiter_message" ], "{duration}", arguments.duration, "all" )
);
arguments.event
.setHTTPHeader( statusCode = "503", statusText = "Service Unavailable" )
.setHTTPHeader( name = "Retry-After", value = arguments.duration );
arguments.event.setHTTPHeader( statusCode="503", statusText="Service Unavailable" )
.setHTTPHeader( name="Retry-After", value=arguments.duration );

// No execution anymore.
event.noExecution();

// Hard abort;
abort;
abort;
} else {
// Log attempt
lock name="cb-ratelimiter-#hash( realIP )#" type="exclusive" throwontimeout="true" timeout="5" {
targetData.attempts++;
targetData.lastAttempt = now();
}
targetData.attempts++;
targetData.lastAttempt = now();
}
} else {
// Reset attempts counter, since we are in the safe zone, just log the last attempt timestamp
lock name="cb-ratelimiter-#hash( realIP )#" type="exclusive" throwontimeout="true" timeout="5" {
targetData.attempts = 0;
targetData.lastAttempt = now();
}
targetData.attempts = 0;
targetData.lastAttempt = now();
}

cache.set( cacheKey, targetData );
return this;
}

}
Loading