Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/silinternational/simplesamlphp-module-silauth

SimpleSAMLphp auth module implementing various security measures before calls to IdP ID Broker backend
https://github.com/silinternational/simplesamlphp-module-silauth

Last synced: about 1 month ago
JSON representation

SimpleSAMLphp auth module implementing various security measures before calls to IdP ID Broker backend

Awesome Lists containing this project

README 

        
# Archived



This repository is no longer maintained. It has been included directly in https://github.com/silinternational/ssp-base.



-- 



# simplesamlphp-module-silauth

SimpleSAMLphp auth module implementing custom business logic



[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/silinternational/simplesamlphp-module-silauth/develop/LICENSE)



## Database Migrations

To create another database migration file, run the following (replacing 

`YourMigrationName` with whatever you want the migration to be named, using 

CamelCase):



    make migration NAME=YourMigrationName



## Rate Limiting

SilAuth will rate limit failed logins by username and by every untrusted IP

address from a login attempt.



### tl;dr ("the short version")

If there have been more than 10 failed logins for a given username (or IP

address) within the past hour, a captcha will be included in the webpage. The

user may or may not have to directly interact with the captcha, though.



If there have been more than 50 failed logins for that username (or IP address)

within the past hour, logins for that username (or IP address) will be blocked

for up to an hour.



### Details

For each login attempt, if it has too many failed logins within the last hour

(aka. recent failed logins) for the given username OR for any single untrusted

IP address associated with the current request, it will do one of the following:



- If there are fewer than `Authenticator::REQUIRE_CAPTCHA_AFTER_NTH_FAILED_LOGIN`

  recent failures: process the request normally.

- If there are at least that many, but fewer than

  `Authenticator::BLOCK_AFTER_NTH_FAILED_LOGIN`: require the user to pass a

  captcha.

- If there are more than that: block that login attempt for `(recent failures

  above the limit)^2` seconds after the most recent failed login, with a

  minimum of 3 (so blocking for 9 seconds).

- Note: the blocking time is capped at an hour, so if no more failures occur,

  then the user will be unblocked in no more than an hour.



See `features/login.feature` for descriptions of how various situations are

handled. That file not only contains human-readable scenarios, but those are

also actual tests that are run to ensure those descriptions are correct.



#### Example 1



- If `BLOCK_AFTER_NTH_FAILED_LOGIN` is 50, and

- if `REQUIRE_CAPTCHA_AFTER_NTH_FAILED_LOGIN` is 10, and

- if there have been 4 failed login attempts for `john_smith`, and

- there have been 10 failed login attempts from `11.22.33.44`, and

- there have been 3 failed login attempts from `192.168.1.2`, and

- someone tries to login as `john_smith` from `192.168.1.2` and their request

  goes through a proxy at `11.22.33.44`, then

- they will have to pass a captcha, but they will not yet be blocked.



#### Example 2



- However, if all of the above is true, but

- there have now been 55 failed login attempts from `11.22.33.44`, then

- any request involving that IP address will be blocked for 25 seconds after

  the most recent of those failed logins.



## Excluding trusted IP addresses from IP address based rate limiting

Since this application enforces rate limits based on the number of recent 

failed login attempts by both username and IP address, and since it looks at 

both the REMOTE_ADDR and the X-Forwarded-For header for IP addresses, you will 

want to list any IP addresses that should NOT be rate limited (such as your 

load balancer) in the TRUSTED_IP_ADDRESSES environment variable (see 

`local.env.dist`).



## Status Check

To check the status of the website, you can access this URL:  

`https://(your domain name)/module.php/silauth/status.php`



## Debugging

To debug the project in your IDE (such as NetBeans), do the following:



1. Edit your `local.env` file, insert your IP address as the value for 

   `XDEBUG_REMOTE_HOST`.

2. Run `make start enabledebug`.

3. Set your IDE to use debugger port 9000 and a Session ID of netbeans-xdebug.

4. Click the "Debug Project" button in your IDE.



### Manual Testing ###

1. Add an entry to your `/etc/hosts` file for `127.0.0.1 silauth.local`

2. Run `make`

3. Go to  in

your browser.



### Debugging



Xdebug can be enabled by doing the following:



1. Define `REMOTE_DEBUG_IP` in `local.env`. This should be the IP address of your development machine, i.e. the one that

   is running your IDE. If you're using Linux as your Docker host, you can use 172.17.0.1 here.

2. Map run-debug.sh into the container you wish to debug. For example:

```yaml

    volumes:

      - ./development/run-debug.sh:/data/run.sh

```

3. Enable debugging in your IDE. See the next section for PhpStorm setup.



## Configuring PhpStorm for remote debugging



In PhpStorm go to: Preferences > PHP > Debug > DBGp Proxy and set the following settings:

- Host: (your IP address or hostname)

- Port: 9000



Set path mappings in: Preferences > PHP > Servers

- Add a server and map the project folder to '/data/vendor/simplesamlphp/simplesamlphp/modules/silauth'

- Map other directories as needed. PhpStorm should prompt when an unrecognized path is encountered.



Then start listening by clicking the "listen" button on the PhpStorm toolbar.