sjs/rack-attack
1
0
Fork 0
mirror of https://github.com/samsonjs/rack-attack.git synced 2026-04-27 15:07:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update repo references after move to rack org

Browse source
This commit is contained in:
Gonzalo 2020-12-25 23:51:59 -03:00
parent cbae022df1
commit 26476670f4
No known key found for this signature in database
GPG key ID: 319EB6E3DB0D60FA
5 changed files with 62 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

92
CHANGELOG.md
View file

@ -96,9 +96,9 @@ All notable changes to this project will be documented in this file.
### Added ### Added
- Support "plain" `Redis` as a cache store backend ([#280](https://github.com/kickstarter/rack-attack/pull/280)). Thanks @bfad and @ryandv. - Support "plain" `Redis` as a cache store backend ([#280](https://github.com/rack/rack-attack/pull/280)). Thanks @bfad and @ryandv.
- When overwriting `Rack::Attack.throttled_response` you can now access the exact epoch integer that was used for caching - When overwriting `Rack::Attack.throttled_response` you can now access the exact epoch integer that was used for caching
so your custom code is less prone to race conditions ([#282](https://github.com/kickstarter/rack-attack/pull/282)). Thanks @doliveirakn. so your custom code is less prone to race conditions ([#282](https://github.com/rack/rack-attack/pull/282)). Thanks @doliveirakn.
### Dependency changes ### Dependency changes
@ -120,43 +120,43 @@ so your custom code is less prone to race conditions ([#282](https://github.com/
### Added ### Added
- Add support for [`ActiveSupport::Cache::RedisCacheStore`](http://api.rubyonrails.org/classes/ActiveSupport/Cache/RedisCacheStore.html) as a store backend ([#340](https://github.com/kickstarter/rack-attack/pull/340) and [#350](https://github.com/kickstarter/rack-attack/pull/350)) - Add support for [`ActiveSupport::Cache::RedisCacheStore`](http://api.rubyonrails.org/classes/ActiveSupport/Cache/RedisCacheStore.html) as a store backend ([#340](https://github.com/rack/rack-attack/pull/340) and [#350](https://github.com/rack/rack-attack/pull/350))
## [5.2.0] - 2018-03-29 ## [5.2.0] - 2018-03-29
### Added ### Added
- Shorthand for blocking an IP address `Rack::Attack.blocklist_ip("1.2.3.4")` ([#320](https://github.com/kickstarter/rack-attack/pull/320)) - Shorthand for blocking an IP address `Rack::Attack.blocklist_ip("1.2.3.4")` ([#320](https://github.com/rack/rack-attack/pull/320))
- Shorthand for blocking an IP subnet `Rack::Attack.blocklist_ip("1.2.0.0/16")` ([#320](https://github.com/kickstarter/rack-attack/pull/320)) - Shorthand for blocking an IP subnet `Rack::Attack.blocklist_ip("1.2.0.0/16")` ([#320](https://github.com/rack/rack-attack/pull/320))
- Shorthand for safelisting an IP address `Rack::Attack.safelist_ip("5.6.7.8")` ([#320](https://github.com/kickstarter/rack-attack/pull/320)) - Shorthand for safelisting an IP address `Rack::Attack.safelist_ip("5.6.7.8")` ([#320](https://github.com/rack/rack-attack/pull/320))
- Shorthand for safelisting an IP subnet `Rack::Attack.safelist_ip("5.6.0.0/16")` ([#320](https://github.com/kickstarter/rack-attack/pull/320)) - Shorthand for safelisting an IP subnet `Rack::Attack.safelist_ip("5.6.0.0/16")` ([#320](https://github.com/rack/rack-attack/pull/320))
- Throw helpful error message when using `allow2ban` but cache store is misconfigured ([#315](https://github.com/kickstarter/rack-attack/issues/315)) - Throw helpful error message when using `allow2ban` but cache store is misconfigured ([#315](https://github.com/rack/rack-attack/issues/315))
- Throw helpful error message when using `fail2ban` but cache store is misconfigured ([#315](https://github.com/kickstarter/rack-attack/issues/315)) - Throw helpful error message when using `fail2ban` but cache store is misconfigured ([#315](https://github.com/rack/rack-attack/issues/315))
## [5.1.0] - 2018-03-10 ## [5.1.0] - 2018-03-10
- Fixes edge case bug when using ruby 2.5.0 and redis [#253](https://github.com/kickstarter/rack-attack/issues/253) ([#271](https://github.com/kickstarter/rack-attack/issues/271)) - Fixes edge case bug when using ruby 2.5.0 and redis [#253](https://github.com/rack/rack-attack/issues/253) ([#271](https://github.com/rack/rack-attack/issues/271))
- Throws errors with better semantics when missing or misconfigured store caches to aid in developers debugging their configs ([#274](https://github.com/kickstarter/rack-attack/issues/274)) - Throws errors with better semantics when missing or misconfigured store caches to aid in developers debugging their configs ([#274](https://github.com/rack/rack-attack/issues/274))
- Removed legacy code that was originally intended for Rails 3 apps ([#264](https://github.com/kickstarter/rack-attack/issues/264)) - Removed legacy code that was originally intended for Rails 3 apps ([#264](https://github.com/rack/rack-attack/issues/264))
## [5.0.1] - 2016-08-11 ## [5.0.1] - 2016-08-11
- Fixes arguments passed to deprecated internal methods. ([#198](https://github.com/kickstarter/rack-attack/issues/198)) - Fixes arguments passed to deprecated internal methods. ([#198](https://github.com/rack/rack-attack/issues/198))
## [5.0.0] - 2016-08-09 ## [5.0.0] - 2016-08-09
- Deprecate `whitelist`/`blacklist` in favor of `safelist`/`blocklist`. ([#181](https://github.com/kickstarter/rack-attack/issues/181), - Deprecate `whitelist`/`blacklist` in favor of `safelist`/`blocklist`. ([#181](https://github.com/rack/rack-attack/issues/181),
thanks @renee-travisci). To upgrade and fix deprecations, find and replace instances of `whitelist` and `blacklist` with `safelist` and `blocklist`. If you reference `rack.attack.match_type`, note that it will have values like `:safelist`/`:blocklist`. thanks @renee-travisci). To upgrade and fix deprecations, find and replace instances of `whitelist` and `blacklist` with `safelist` and `blocklist`. If you reference `rack.attack.match_type`, note that it will have values like `:safelist`/`:blocklist`.
- Remove test coverage for unsupported ruby dependencies: ruby 2.0, activesupport 3.2/4.0, and dalli 1. - Remove test coverage for unsupported ruby dependencies: ruby 2.0, activesupport 3.2/4.0, and dalli 1.
## [4.4.1] - 2016-02-17 ## [4.4.1] - 2016-02-17
- Fix a bug affecting apps using Redis::Store and ActiveSupport that could generate an error - Fix a bug affecting apps using Redis::Store and ActiveSupport that could generate an error
saying dalli was a required dependency. I learned all about ActiveSupport autoloading. ([#165](https://github.com/kickstarter/rack-attack/issues/165)) saying dalli was a required dependency. I learned all about ActiveSupport autoloading. ([#165](https://github.com/rack/rack-attack/issues/165))
## [4.4.0] - 2016-02-10 ## [4.4.0] - 2016-02-10
- New: support for MemCacheStore ([#153](https://github.com/kickstarter/rack-attack/issues/153)). Thanks @elhu. - New: support for MemCacheStore ([#153](https://github.com/rack/rack-attack/issues/153)). Thanks @elhu.
- Some documentation and test harness improvements. - Some documentation and test harness improvements.
## [4.3.1] - 2015-12-18 ## [4.3.1] - 2015-12-18
@ -222,36 +222,36 @@ so your custom code is less prone to race conditions ([#282](https://github.com/
- Remove unused variable - Remove unused variable
- Extract mandatory options to constants - Extract mandatory options to constants
[6.3.1]: https://github.com/kickstarter/rack-attack/compare/v6.3.0...v6.3.1/ [6.3.1]: https://github.com/rack/rack-attack/compare/v6.3.0...v6.3.1/
[6.3.0]: https://github.com/kickstarter/rack-attack/compare/v6.2.2...v6.3.0/ [6.3.0]: https://github.com/rack/rack-attack/compare/v6.2.2...v6.3.0/
[6.2.2]: https://github.com/kickstarter/rack-attack/compare/v6.2.1...v6.2.2/ [6.2.2]: https://github.com/rack/rack-attack/compare/v6.2.1...v6.2.2/
[6.2.1]: https://github.com/kickstarter/rack-attack/compare/v6.2.0...v6.2.1/ [6.2.1]: https://github.com/rack/rack-attack/compare/v6.2.0...v6.2.1/
[6.2.0]: https://github.com/kickstarter/rack-attack/compare/v6.1.0...v6.2.0/ [6.2.0]: https://github.com/rack/rack-attack/compare/v6.1.0...v6.2.0/
[6.1.0]: https://github.com/kickstarter/rack-attack/compare/v6.0.0...v6.1.0/ [6.1.0]: https://github.com/rack/rack-attack/compare/v6.0.0...v6.1.0/
[6.0.0]: https://github.com/kickstarter/rack-attack/compare/v5.4.2...v6.0.0/ [6.0.0]: https://github.com/rack/rack-attack/compare/v5.4.2...v6.0.0/
[5.4.2]: https://github.com/kickstarter/rack-attack/compare/v5.4.1...v5.4.2/ [5.4.2]: https://github.com/rack/rack-attack/compare/v5.4.1...v5.4.2/
[5.4.1]: https://github.com/kickstarter/rack-attack/compare/v5.4.0...v5.4.1/ [5.4.1]: https://github.com/rack/rack-attack/compare/v5.4.0...v5.4.1/
[5.4.0]: https://github.com/kickstarter/rack-attack/compare/v5.3.2...v5.4.0/ [5.4.0]: https://github.com/rack/rack-attack/compare/v5.3.2...v5.4.0/
[5.3.2]: https://github.com/kickstarter/rack-attack/compare/v5.3.1...v5.3.2/ [5.3.2]: https://github.com/rack/rack-attack/compare/v5.3.1...v5.3.2/
[5.3.1]: https://github.com/kickstarter/rack-attack/compare/v5.3.0...v5.3.1/ [5.3.1]: https://github.com/rack/rack-attack/compare/v5.3.0...v5.3.1/
[5.3.0]: https://github.com/kickstarter/rack-attack/compare/v5.2.0...v5.3.0/ [5.3.0]: https://github.com/rack/rack-attack/compare/v5.2.0...v5.3.0/
[5.2.0]: https://github.com/kickstarter/rack-attack/compare/v5.1.0...v5.2.0/ [5.2.0]: https://github.com/rack/rack-attack/compare/v5.1.0...v5.2.0/
[5.1.0]: https://github.com/kickstarter/rack-attack/compare/v5.0.1...v5.1.0/ [5.1.0]: https://github.com/rack/rack-attack/compare/v5.0.1...v5.1.0/
[5.0.1]: https://github.com/kickstarter/rack-attack/compare/v5.0.0...v5.0.1/ [5.0.1]: https://github.com/rack/rack-attack/compare/v5.0.0...v5.0.1/
[5.0.0]: https://github.com/kickstarter/rack-attack/compare/v4.4.1...v5.0.0/ [5.0.0]: https://github.com/rack/rack-attack/compare/v4.4.1...v5.0.0/
[4.4.1]: https://github.com/kickstarter/rack-attack/compare/v4.4.0...v4.4.1/ [4.4.1]: https://github.com/rack/rack-attack/compare/v4.4.0...v4.4.1/
[4.4.0]: https://github.com/kickstarter/rack-attack/compare/v4.3.1...v4.4.0/ [4.4.0]: https://github.com/rack/rack-attack/compare/v4.3.1...v4.4.0/
[4.3.1]: https://github.com/kickstarter/rack-attack/compare/v4.3.0...v4.3.1/ [4.3.1]: https://github.com/rack/rack-attack/compare/v4.3.0...v4.3.1/
[4.3.0]: https://github.com/kickstarter/rack-attack/compare/v4.2.0...v4.3.0/ [4.3.0]: https://github.com/rack/rack-attack/compare/v4.2.0...v4.3.0/
[4.2.0]: https://github.com/kickstarter/rack-attack/compare/v4.1.1...v4.2.0/ [4.2.0]: https://github.com/rack/rack-attack/compare/v4.1.1...v4.2.0/
[4.1.1]: https://github.com/kickstarter/rack-attack/compare/v4.1.0...v4.1.1/ [4.1.1]: https://github.com/rack/rack-attack/compare/v4.1.0...v4.1.1/
[4.1.0]: https://github.com/kickstarter/rack-attack/compare/v4.0.1...v4.1.0/ [4.1.0]: https://github.com/rack/rack-attack/compare/v4.0.1...v4.1.0/
[4.0.1]: https://github.com/kickstarter/rack-attack/compare/v4.0.0...v4.0.1/ [4.0.1]: https://github.com/rack/rack-attack/compare/v4.0.0...v4.0.1/
[4.0.0]: https://github.com/kickstarter/rack-attack/compare/v3.0.0...v4.0.0/ [4.0.0]: https://github.com/rack/rack-attack/compare/v3.0.0...v4.0.0/
[3.0.0]: https://github.com/kickstarter/rack-attack/compare/v2.3.0...v3.0.0/ [3.0.0]: https://github.com/rack/rack-attack/compare/v2.3.0...v3.0.0/
[2.3.0]: https://github.com/kickstarter/rack-attack/compare/v2.2.1...v2.3.0/ [2.3.0]: https://github.com/rack/rack-attack/compare/v2.2.1...v2.3.0/
[2.2.1]: https://github.com/kickstarter/rack-attack/compare/v2.2.0...v2.2.1/ [2.2.1]: https://github.com/rack/rack-attack/compare/v2.2.0...v2.2.1/
[2.2.0]: https://github.com/kickstarter/rack-attack/compare/v2.1.1...v2.2.0/ [2.2.0]: https://github.com/rack/rack-attack/compare/v2.1.1...v2.2.0/
[@fatkodima]: https://github.com/fatkodima [@fatkodima]: https://github.com/fatkodima
[@rofreg]: https://github.com/rofreg [@rofreg]: https://github.com/rofreg

8
CONTRIBUTING.md
View file

@ -8,12 +8,12 @@ This project is intended to be a safe, welcoming space for collaboration, and co
Any of the following is greatly appreciated: Any of the following is greatly appreciated:
* Helping users by answering to their [questions](https://github.com/kickstarter/rack-attack/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+question%22) * Helping users by answering to their [questions](https://github.com/rack/rack-attack/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+question%22)
* Helping users troubleshoot their [error reports](https://github.com/kickstarter/rack-attack/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+error+report%22) to figure out if the error is caused by an actual bug or some misconfiguration * Helping users troubleshoot their [error reports](https://github.com/rack/rack-attack/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+error+report%22) to figure out if the error is caused by an actual bug or some misconfiguration
* Giving feedback by commenting in other users [feature requests](https://github.com/kickstarter/rack-attack/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+feature+request%22) * Giving feedback by commenting in other users [feature requests](https://github.com/rack/rack-attack/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+feature+request%22)
* Reporting an error you are experiencing * Reporting an error you are experiencing
* Suggesting a new feature you think it would be useful for many users * Suggesting a new feature you think it would be useful for many users
* If you want to work on fixing an actual issue and you don't know where to start, those labeled [good first issue](https://github.com/kickstarter/rack-attack/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) may be a good choice * If you want to work on fixing an actual issue and you don't know where to start, those labeled [good first issue](https://github.com/rack/rack-attack/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) may be a good choice
## Style Guide ## Style Guide

4
README.md
View file

@ -1,5 +1,5 @@
__Note__: You are viewing the development version README. __Note__: You are viewing the development version README.
For the README consistent with the latest released version see https://github.com/kickstarter/rack-attack/blob/6-stable/README.md. For the README consistent with the latest released version see https://github.com/rack/rack-attack/blob/6-stable/README.md.
# Rack::Attack # Rack::Attack
@ -10,7 +10,7 @@ Protect your Rails and Rack apps from bad clients. Rack::Attack lets you easily
See the [Backing & Hacking blog post](https://www.kickstarter.com/backing-and-hacking/rack-attack-protection-from-abusive-clients) introducing Rack::Attack. See the [Backing & Hacking blog post](https://www.kickstarter.com/backing-and-hacking/rack-attack-protection-from-abusive-clients) introducing Rack::Attack.
[![Gem Version](https://badge.fury.io/rb/rack-attack.svg)](https://badge.fury.io/rb/rack-attack) [![Gem Version](https://badge.fury.io/rb/rack-attack.svg)](https://badge.fury.io/rb/rack-attack)
[![Build Status](https://travis-ci.org/kickstarter/rack-attack.svg?branch=master)](https://travis-ci.org/kickstarter/rack-attack) [![Build Status](https://travis-ci.org/rack/rack-attack.svg?branch=master)](https://travis-ci.org/rack/rack-attack)
[![Code Climate](https://codeclimate.com/github/kickstarter/rack-attack.svg)](https://codeclimate.com/github/kickstarter/rack-attack) [![Code Climate](https://codeclimate.com/github/kickstarter/rack-attack.svg)](https://codeclimate.com/github/kickstarter/rack-attack)
[![Join the chat at https://gitter.im/rack-attack/rack-attack](https://badges.gitter.im/rack-attack/rack-attack.svg)](https://gitter.im/rack-attack/rack-attack) [![Join the chat at https://gitter.im/rack-attack/rack-attack](https://badges.gitter.im/rack-attack/rack-attack.svg)](https://gitter.im/rack-attack/rack-attack)

12
docs/advanced_configuration.md
View file

@ -6,7 +6,7 @@ If you're feeling ambitious or you have a very particular use-case for Rack::Att
### Exponential Backoff ### Exponential Backoff
By layering throttles with linearly increasing limits and exponentially increasing periods, you can mimic an exponential backoff throttle. See [#106](https://github.com/kickstarter/rack-attack/issues/106) for more discussion. By layering throttles with linearly increasing limits and exponentially increasing periods, you can mimic an exponential backoff throttle. See [#106](https://github.com/rack/rack-attack/issues/106) for more discussion.
```ruby ```ruby
# Allows 20 requests in 8 seconds # Allows 20 requests in 8 seconds
@ -24,7 +24,7 @@ end
### Rack::Attack::Request Helpers ### Rack::Attack::Request Helpers
You can define helpers on requests like `localhost?` or `subdomain` by monkey-patching `Rack::Attack::Request`. See [#73](https://github.com/kickstarter/rack-attack/issues/73) for more discussion. You can define helpers on requests like `localhost?` or `subdomain` by monkey-patching `Rack::Attack::Request`. See [#73](https://github.com/rack/rack-attack/issues/73) for more discussion.
```ruby ```ruby
class Rack::Attack::Request < ::Rack::Request class Rack::Attack::Request < ::Rack::Request
@ -38,7 +38,7 @@ Rack::Attack.safelist("localhost") { |req| req.localhost? }
### Blocklisting From ENV Variables ### Blocklisting From ENV Variables
You can have `Rack::Attack` configure its blocklists from ENV variables to simplify maintenance. See [#110](https://github.com/kickstarter/rack-attack/issues/110) for more discussion. You can have `Rack::Attack` configure its blocklists from ENV variables to simplify maintenance. See [#110](https://github.com/rack/rack-attack/issues/110) for more discussion.
```ruby ```ruby
class Rack::Attack class Rack::Attack
@ -57,7 +57,7 @@ end
### Reset Specific Throttles ### Reset Specific Throttles
By doing a bunch of monkey-patching, you can add a helper for resetting specific throttles. The implementation is kind of long, so see [#113](https://github.com/kickstarter/rack-attack/issues/113) for more discussion. By doing a bunch of monkey-patching, you can add a helper for resetting specific throttles. The implementation is kind of long, so see [#113](https://github.com/rack/rack-attack/issues/113) for more discussion.
```ruby ```ruby
Rack::Attack.reset_throttle "logins/email", "user@example.com" Rack::Attack.reset_throttle "logins/email", "user@example.com"
@ -65,7 +65,7 @@ Rack::Attack.reset_throttle "logins/email", "user@example.com"
### Blocklisting From Rails.cache ### Blocklisting From Rails.cache
You can configure blocklists to check values stored in `Rails.cache` to allow setting blocklists from inside your application. See [#111](https://github.com/kickstarter/rack-attack/issues/111) for more discussion. You can configure blocklists to check values stored in `Rails.cache` to allow setting blocklists from inside your application. See [#111](https://github.com/rack/rack-attack/issues/111) for more discussion.
```ruby ```ruby
# Block attacks from IPs in cache # Block attacks from IPs in cache
@ -78,7 +78,7 @@ end
### Throttle Basic Auth Crackers ### Throttle Basic Auth Crackers
An example implementation for blocking hackers who spam basic auth attempts. See [#47](https://github.com/kickstarter/rack-attack/issues/47) for more discussion. An example implementation for blocking hackers who spam basic auth attempts. See [#47](https://github.com/rack/rack-attack/issues/47) for more discussion.
```ruby ```ruby
# After 5 requests with incorrect auth in 1 minute, # After 5 requests with incorrect auth in 1 minute,

8
rack-attack.gemspec
View file

@ -15,16 +15,16 @@ Gem::Specification.new do |s|
s.email = "aaron@ktheory.com" s.email = "aaron@ktheory.com"
s.files = Dir.glob("{bin,lib}/**/*") + %w(Rakefile README.md) s.files = Dir.glob("{bin,lib}/**/*") + %w(Rakefile README.md)
s.homepage = 'https://github.com/kickstarter/rack-attack' s.homepage = 'https://github.com/rack/rack-attack'
s.rdoc_options = ["--charset=UTF-8"] s.rdoc_options = ["--charset=UTF-8"]
s.require_paths = ["lib"] s.require_paths = ["lib"]
s.summary = 'Block & throttle abusive requests' s.summary = 'Block & throttle abusive requests'
s.test_files = Dir.glob("spec/**/*") s.test_files = Dir.glob("spec/**/*")
s.metadata = { s.metadata = {
"bug_tracker_uri" => "https://github.com/kickstarter/rack-attack/issues", "bug_tracker_uri" => "https://github.com/rack/rack-attack/issues",
"changelog_uri" => "https://github.com/kickstarter/rack-attack/blob/master/CHANGELOG.md", "changelog_uri" => "https://github.com/rack/rack-attack/blob/master/CHANGELOG.md",
"source_code_uri" => "https://github.com/kickstarter/rack-attack" "source_code_uri" => "https://github.com/rack/rack-attack"
} }
s.required_ruby_version = '>= 2.4' s.required_ruby_version = '>= 2.4'