Working with login attempts | 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  Working with login attempts

 Version   v1      

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

  Working with login attempts    
- [ 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)

 Working with login attempts
===========================

###  On this page 

1. [ What is stored ](#content-what-is-stored)
2. [ Showing users their recent logins ](#content-showing-users-their-recent-logins)
3. [ Useful methods and scopes ](#content-useful-methods-and-scopes)

Every login and failed login is stored as a `Spatie\SuspiciousLogin\Models\LoginAttempt`. You can use these records to show users their recent activity, to build an admin overview, or to see how your preset scores real logins.

What is stored
--------------------------------------------------------------------------------------------------

AttributeContains`authenticatable`The user, as a polymorphic relation. `null` for a failed login on an account that doesn't exist.`guard`The auth guard used for the login.`identifier`For failed logins: the email address or username that was tried. Passwords are never stored.`successful`Whether authentication succeeded, even if a preset action then blocked the login. Use `trusted()` for successful logins that were not blocked.`blocked`Whether the login was [blocked](/docs/laravel-suspicious-login/v1/responding-to-suspicious-logins/blocking-logins).`ip_address`, `user_agent`Taken from the request.`device_fingerprint`A hash that identifies the device. See [device fingerprints](/docs/laravel-suspicious-login/v1/advanced-usage/device-fingerprints).`country_code`, `city`, `latitude`, `longitude`The location, when a [geolocation driver](/docs/laravel-suspicious-login/v1/advanced-usage/geolocation-drivers) found one.`risk_score`, `risk_level`The score from 0 to 100 and the `RiskLevel` enum. `null` for failed logins.`reasons`An array with the check, score and human readable reason for every check that flagged the login.`properties`Your [custom properties](/docs/laravel-suspicious-login/v1/basic-usage/adding-custom-properties), or `null` when there are none.Showing users their recent logins
-----------------------------------------------------------------------------------------------------------------------------------------------------------

```
use Spatie\SuspiciousLogin\Models\LoginAttempt;

$recentLogins = LoginAttempt::query()
    ->whereMorphedTo('authenticatable', $request->user())
    ->where('successful', true)
    ->latest()
    ->limit(10)
    ->get();
```

```
@foreach($recentLogins as $login)

        {{ $login->created_at->diffForHumans() }} from {{ $login->city ?? $login->country_code ?? $login->ip_address }}

        @if($login->isSuspicious())
            Suspicious: {{ collect($login->reasons)->pluck('reason')->implode(', ') }}
        @endif

@endforeach
```

Useful methods and scopes
-----------------------------------------------------------------------------------------------------------------------------------

```
$attempt->isSuspicious(); // true for medium and high risk logins
$attempt->location(); // a Location object, or null
$attempt->getProperty('tenant_id'); // a custom property, or null

$attempt->history(); // a query for the other attempts of the same user, up to this one

LoginAttempt::query()->trusted(); // successful logins that weren't blocked
LoginAttempt::query()->failed(); // failed logins
LoginAttempt::query()->since(now()->subDay());
```

The scopes combine with `history()`, which is what the checks themselves use:

```
$failedAttemptsToday = $attempt->history()->failed()->since(now()->startOfDay())->count();
```

History is scoped to the user, not the guard. Logins to different guards share history when they use the same user model and ID.

When you [use your own model](/docs/laravel-suspicious-login/v1/advanced-usage/using-your-own-model), import that model in your application queries instead of the package model.

 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)
