Adding custom properties | laravel-suspicious-login | Spatie       

 SPATIE  

laravel-suspicious-login
========================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-suspicious-login](https://spatie.be/docs/laravel-suspicious-login/v1)  Basic-usage  Adding custom properties

 Version   v1      

 Other versions for crawler [v1](https://spatie.be/docs/laravel-suspicious-login/v1) 

  Adding custom properties    
- [ Introduction ](https://spatie.be/docs/laravel-suspicious-login/v1/introduction)
- [ Support us ](https://spatie.be/docs/laravel-suspicious-login/v1/support-us)
- [ Requirements ](https://spatie.be/docs/laravel-suspicious-login/v1/requirements)
- [ Installation &amp; setup ](https://spatie.be/docs/laravel-suspicious-login/v1/installation-setup)
- [ Questions and issues ](https://spatie.be/docs/laravel-suspicious-login/v1/questions-issues)
- [ Changelog ](https://spatie.be/docs/laravel-suspicious-login/v1/changelog)
- [ About us ](https://spatie.be/docs/laravel-suspicious-login/v1/about-us)

Basic usage
-----------

- [ Getting started ](https://spatie.be/docs/laravel-suspicious-login/v1/basic-usage/getting-started)
- [ How a login is scored ](https://spatie.be/docs/laravel-suspicious-login/v1/basic-usage/how-a-login-is-scored)
- [ Choosing a preset ](https://spatie.be/docs/laravel-suspicious-login/v1/basic-usage/choosing-a-preset)
- [ Customizing presets ](https://spatie.be/docs/laravel-suspicious-login/v1/basic-usage/customizing-presets)
- [ Working with login attempts ](https://spatie.be/docs/laravel-suspicious-login/v1/basic-usage/working-with-login-attempts)
- [ Adding custom properties ](https://spatie.be/docs/laravel-suspicious-login/v1/basic-usage/adding-custom-properties)
- [ Recording logins manually ](https://spatie.be/docs/laravel-suspicious-login/v1/basic-usage/recording-logins-manually)

Available checks
----------------

- [ Overview ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/overview)
- [ New device ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/new-device)
- [ New IP address ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/new-ip)
- [ New country ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/new-country)
- [ Impossible travel ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/impossible-travel)
- [ Allowed and blocked countries ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/country)
- [ Failed attempts ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/failed-attempts)
- [ Credential stuffing ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/credential-stuffing)
- [ Unusual time ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/unusual-time)
- [ Suspicious user agent ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/suspicious-user-agent)
- [ IP reputation ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/ip-reputation)
- [ Multiple countries ](https://spatie.be/docs/laravel-suspicious-login/v1/available-checks/multiple-countries)

Responding to suspicious logins
-------------------------------

- [ Notifying users ](https://spatie.be/docs/laravel-suspicious-login/v1/responding-to-suspicious-logins/notifying-users)
- [ Blocking logins ](https://spatie.be/docs/laravel-suspicious-login/v1/responding-to-suspicious-logins/blocking-logins)
- [ Writing your own actions ](https://spatie.be/docs/laravel-suspicious-login/v1/responding-to-suspicious-logins/writing-your-own-actions)
- [ Using events ](https://spatie.be/docs/laravel-suspicious-login/v1/responding-to-suspicious-logins/using-events)

Advanced usage
--------------

- [ Creating custom checks ](https://spatie.be/docs/laravel-suspicious-login/v1/advanced-usage/creating-custom-checks)
- [ Geolocation drivers ](https://spatie.be/docs/laravel-suspicious-login/v1/advanced-usage/geolocation-drivers)
- [ IP reputation drivers ](https://spatie.be/docs/laravel-suspicious-login/v1/advanced-usage/ip-reputation-drivers)
- [ Device fingerprints ](https://spatie.be/docs/laravel-suspicious-login/v1/advanced-usage/device-fingerprints)
- [ Using your own model ](https://spatie.be/docs/laravel-suspicious-login/v1/advanced-usage/using-your-own-model)

 Adding custom properties
========================

###  On this page 

1. [ Using properties in a check ](#content-using-properties-in-a-check)
2. [ Passing properties when recording manually ](#content-passing-properties-when-recording-manually)
3. [ Keep personal data out ](#content-keep-personal-data-out)

Your app probably knows things about a login that the package doesn't: which tenant the user logged in to, which version of your mobile app they used, or whether the request came through your API. You can store those with every login attempt as custom properties.

Register a callback in the `boot` method of a service provider. It receives the request and the user, and returns the properties as an array:

```
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Http\Request;
use Spatie\SuspiciousLogin\Facades\SuspiciousLogin;

SuspiciousLogin::addPropertiesUsing(fn (Request $request, ?Authenticatable $user) => [
    'tenant_id' => $request->route('tenant'),
    'app_version' => $request->header('X-App-Version'),
]);
```

The callback runs for every login attempt, successful or failed. For a failed login on an account that doesn't exist, `$user` is `null`.

Properties are stored as JSON in the `properties` column of the login attempt. Read them with `getProperty`, which also understands dot notation for nested values:

```
$attempt->getProperty('tenant_id'); // 5
$attempt->getProperty('device.model'); // 'iPhone'
$attempt->getProperty('missing', 'default'); // 'default'

$attempt->properties; // all properties as an array, or null when there are none
```

Because they're plain JSON, you can query them too:

```
LoginAttempt::query()->where('properties->tenant_id', 5)->get();
```

Using properties in a check
-----------------------------------------------------------------------------------------------------------------------------------------

The callback runs while the login attempt is being built, before any check runs. That means a [custom check](/docs/laravel-suspicious-login/v1/advanced-usage/creating-custom-checks) can use your properties. Here's one that flags a login to a tenant the user doesn't belong to:

```
namespace App\SuspiciousLogin\Checks;

use Spatie\SuspiciousLogin\Checks\Check;
use Spatie\SuspiciousLogin\Checks\CheckResult;
use Spatie\SuspiciousLogin\Models\LoginAttempt;

class ForeignTenantCheck extends Check
{
    protected int $score = 50;

    public function evaluate(LoginAttempt $attempt): CheckResult
    {
        $tenantId = $attempt->getProperty('tenant_id');

        if (! $tenantId) {
            return $this->pass();
        }

        if ($attempt->authenticatable?->tenants()->whereKey($tenantId)->exists()) {
            return $this->pass();
        }

        return $this->flag('Login to a tenant the user does not belong to');
    }
}
```

Passing properties when recording manually
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

When you [record logins yourself](/docs/laravel-suspicious-login/v1/basic-usage/recording-logins-manually), pass properties for that one login with the `properties:` argument:

```
SuspiciousLogin::recordSuccessfulLogin($user, guard: 'api', properties: ['token_name' => $token->name]);
```

These are merged with the properties of your callback. When both set the same key, the value you pass wins.

Keep personal data out
--------------------------------------------------------------------------------------------------------------------------

Properties end up in your database for as long as you keep login attempts. Only store what you need to detect suspicious logins or to investigate one later, and never store passwords, tokens or other secrets.

 A good
match?
-------------

### What we do best

- All things Laravel
- Custom frontend components
- Building APIs
- AI-powered features
- Simplifying things
- Clean solutions
- Integrating services

### Not our cup of tea

- WordPress themes
- Cutting corners
- Free mockups to win a job
- "Just execute the briefing"

 In short: we'd like to be a **substantial part** of your project.

 [ Get in touch via email ](mailto:info@spatie.be?subject=A%20good%20match%21&body=Tell%20us%20as%20much%20as%20you%20can%20about%0A-%20your%20online%20project%0A-%20your%20planning%0A-%20your%20budget%0A-%20%E2%80%A6%0A%0AAnything%20that%20helps%20us%20to%20start%20straightforward%21)
