\Bitrix\Security\Mfa\Otp — методы и описание класса

__construct()

activate() Активирует OTP пользователя.

canSkipMandatory() Проверяет, может ли текущий пользователь пропустить обязательное использование OTP.

canSkipMandatoryByRights() Проверяет, что текущий пользователь не включён в обязательные права

deactivate() Отключает OTP пользователя на необходимое количество дней или навсегда

defer() Откладывает обязательное использование OTP пользователем на необходимое количество дней или навсегда

delete() Удаляет запись OTP из БД

getAlgorithm() Возвращает экземпляр используемого OtpAlgorithm

getAppSecret() Возвращает secret мобильного приложения, используемый для ручной инициализации устройства

getAttempts() Возвращает количество попыток проверки

static getAvailableTypes() Возвращает доступные типы OtpAlgorithm

static getByType() Возвращает новый экземпляр с требуемым типом OtpAlgorithm

static getByUser() Возвращает новый экземпляр для пользователя, заданного по user ID

getContext() Возвращает контекст текущего запроса.

getDeactivateUntil()

static getDefaultType() Возвращает тип OtpAlgorithm по умолчанию

static getDeferredParams() Возвращает отложенные параметры (см. verifyUser)

getHexSecret() Возвращает secret в шестнадцатеричном представлении

getInitialDate() Возвращает дату инициализации OTP

getInitParams() Возвращает параметры инициализации для алгоритмов.

getIssuer() Возвращает issuer.

getLabel() Возвращает метку для issuer (если задана). Если пользовательская метка недоступна — генерирует значение по умолчанию (см. generateLabel)

static getMandatoryRights() Возвращает права пользователей, которые обязаны использовать OTP

getParams() Возвращает параметры пользователя (например, counter для HotpAlgorithm)

getProvisioningUri() Возвращает Provision URI в соответствии с KeyUriFormat

getSecret() Возвращает бинарный secret

static getSkipMandatoryDays() Возвращает окно инициализации (в днях) для проверки обязательного использования

getSyncParameters() Возвращает синхронизированные параметры пользователя для переданных входных данных

getType() Возвращает используемый тип OtpAlgorithm

static getTypesDescription() Возвращает описание доступных типов OtpAlgorithm

getUserId() Возвращает используемый User ID

getUserLogin() Возвращает логин пользователя. Если пользовательский логин недоступен, он будет получен из БД

isActivated() Возвращает, активирован ли OTP

isAttemptsReached() Проверяет, достигнуто ли количество попыток проверки согласно групповой политике безопасности. Может использоваться для показа Captcha или чего угодно

static isCaptchaRequired() Возвращает, должен ли пользователь ввести код captcha перед проверкой пароля OTP

isInitialized()

isMandatorySkipped() Возвращает true, если пользователь может пропустить обязательное использование

static isMandatoryUsing() Возвращает, активировано ли обязательное использование OTP

static isOtpEnabled() Возвращает, включён ли OTP

static isOtpRequired() Возвращает true, если пользователь должен ввести пароль с устройства

static isOtpRequiredByMandatory() Возвращает true, если пользователь не использует OTP, но он обязателен и льготный период заканчивается

static isRecoveryCodesEnabled() Возвращает, включены ли «Коды восстановления»

isUserActive()

regenerate() Повторно инициализирует OTP (генерирует новый secret, устанавливает алгоритм по умолчанию и т.д.), должен вызываться перед подключением нового устройства

save() Сохраняет все данные OTP в БД

setActive() Устанавливает новое состояние активации

setAppSecret() Устанавливает новый secret мобильного приложения

setContext() Устанавливает контекст текущего запроса.

static setDefaultType() Устанавливает тип OtpAlgorithm по умолчанию

static setDeferredParams() Устанавливает или удаляет отложенные параметры (см. verifyUser)

setHexSecret() Устанавливает новый secret в шестнадцатеричном представлении

setInitParams() Устанавливает параметры инициализации для алгоритмов.

setIssuer() Устанавливает пользовательский issuer

setLabel() Устанавливает пользовательскую метку

static setMandatoryRights() Устанавливает права пользователей, которые обязаны использовать OTP

static setMandatoryUsing() Включает или отключает обязательное использование OTP

setSecret() Устанавливает новый secret

static setSkipMandatoryDays() Устанавливает окно инициализации (в днях) для проверки обязательного использования

setType() Устанавливает новый тип OtpAlgorithm

setUserActive()

setUserInfo() Устанавливает новую информацию о пользователе. В основном используется для инициализации из БД. Сейчас поддерживается: - ACTIVE: bool, состояние…

setUserLogin() Устанавливает пользовательский логин

syncParameters() Синхронизирует параметры пользователя для переданных входных данных. Должен вызываться после регенерации и перед сохранением! Если что-то пошло не…

verify() Проверяет переданный ввод

static verifyUser() Самый сложный метод, может проверить всё :-) ToDo: описать после рефакторинга

Otp

Константы

Методы (65)