README

Установка

Для ведения журнала аутентификации GSManager требуется GSManager v1 или выше и PHP 8.4+.

Вы можете использовать Composer для установки GSManager Authentication Log в свой проект GSManager:

composer require gsmanager-cloud/authentication-log

Конфигурация

После установки журнала проверки подлинности GSManager опубликуйте его конфигурацию, выполните перенос и просмотр, используя vendor:publish Artisan команду:

php gsm vendor:publish --provider="GSManager\AuthenticationLog\AuthenticationLogServiceProvider"

Затем вам нужно перенести вашу базу данных. При переносе журнала проверки подлинности GSManager будет создана таблица, необходимая вашему приложению для хранения журналов проверки подлинности:

php gsm migrate

Наконец, добавьте AuthenticationLogable и Notifiable характеристики вашей аутентифицируемой модели (по умолчанию, App\User модель). Эти функции предоставляют различные методы, позволяющие вам получать общие данные журнала аутентификации, такие как время последнего входа в систему, IP-адрес последнего входа в систему, а также настраивать каналы для уведомления пользователя при входе с нового устройства:

use GSManager\Notifications\Notifiable;
use GSManager\AuthenticationLog\AuthenticationLogable;
use GSManager\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use Notifiable, AuthenticationLogable;
}

Basic Usage

Получить все журналы аутентификации пользователя:

User::find(1)->authentications;

Получите последнюю регистрационную информацию пользователя:

User::find(1)->lastLoginAt();

User::find(1)->lastLoginIp();

Получить предыдущее время входа пользователя в систему и ip-адрес (игнорируя текущий логин):

auth()->user()->previousLoginAt();

auth()->user()->previousLoginIp();

Уведомлять о входе в систему с нового устройства

Уведомления могут быть отправлены на mail, nexmo, и slack каналы. По умолчанию вы отправляете уведомление по электронной почте.

Вы можете определить notifyAuthenticationLogVia метод определения того, по каким каналам должно быть доставлено уведомление:

/**
 * The Authentication Log notifications delivery channels.
 *
 * @return array
 */
public function notifyAuthenticationLogVia()
{
    return ['nexmo', 'mail', 'slack'];
}

Конечно, вы можете отключить уведомление, установив notify вариант в вашем config/authentication-log.php конфигурационный файл для false:

'notify' => env('AUTHENTICATION_LOG_NOTIFY', false),

Очистите старые журналы

Вы можете очистить старые записи журнала проверки подлинности, используя authentication-log:clear Artisan команда:

php gsm authentication-log:clear

Записи, которые старше количества дней, указанного в older вариант в вашем config/authentication-log.php будут удалены:

'older' => 365,

Способствующий

Благодарим вас за то, что вы решили внести свой вклад в журнал аутентификации GSManager.

Лицензия

Журнал аутентификации GSManager - это программное обеспечение с открытым исходным кодом, лицензируемое в соответствии с MIT license.

gsmanager-cloud / authentication-log

Maintainers

Details