PublicKeyCredentialRequestOptions

Словарь PublicKeyCredentialRequestOptions представляет собой объект, передаваемый в CredentialsContainer.get() в качестве значения параметра publicKey:

Он используется для запроса PublicKeyCredential, предоставленного аутентификатором, который поддерживает API аутентификации веб-приложений.

allowCredentials Необязательно

Массив объектов, используемый для ограничения списка допустимых учётных данных. Пустой массив указывает, что любые учётные данные допустимы.

Каждый объект в массиве будет содержать следующие свойства:

id

ArrayBuffer, TypedArray или DataView, представляющий собой идентификатор открытого ключа для извлечения. Это значение отображается свойством rawId объекта PublicKeyCredential, возвращённого успешным вызовом get().

transports

Массив строк, предоставляющий подсказки о методах, которые клиент может использовать для связи с соответствующим аутентификатором открытого ключа для извлечения. Возможные способы передачи: "ble", "hybrid", "internal", "nfc", и "usb".

Примечание: Это значение отображается возвращаемым значением метода PublicKeyCredential.response.getTransports() объекта PublicKeyCredential, возвращенного вызовом create() для первоначального создания учётных данных. В этот момент приложение должно его сохранить для дальнейшего использования.

type

Строка, определяющая тип открытого ключа для извлечения. В настоящее время это может быть только одно значение "public-key", но в будущем могут быть добавлены другие. Это значение отображается свойством type объекта PublicKeyCredential, возвращённого успешным вызовом get().

По умолчанию это пустой массив.

challenge

ArrayBuffer, TypedArray или DataView, полученный с сервера доверенной стороны и используемый в качестве криптографического запроса. Это значение будет подписано аутентификатором, а подпись будет возвращена как часть AuthenticatorAssertionResponse.signature (доступно в свойстве response объекта PublicKeyCredential, возвращенного успешным вызовом get()).

extensions Необязательно

Объект, содержащий свойства, представляющие входные значения для любых запрошенных расширений. Эти расширения используются для конкретной дополнительной обработки клиентом или аутентификатором во время процесса аутентификации. Примеры включают работу с учётными данными API FIDO устаревшей версии и оценку выходных данных из псевдослучайной функции (PRF), связанной с учётными данными.

Расширения необязательны, и разные браузеры могут распознавать разные расширения. Обработка расширений всегда необязательна для клиента: если браузер не распознаёт данное расширение, он просто его проигнорирует. Сведения об использовании расширений и о поддержке в браузерах см. в расширениях API аутентификации веб-приложений.

hints Необязательно

Массив строк, предоставляющий подсказки о том, какой пользовательский интерфейс аутентификации должен предоставить пользовательский агент для пользователя.

Значения могут быть следующими:

"security-key"

Для аутентификации требуется отдельное физическое устройство для предоставления ключа.

"client-device"

Пользователь проходит аутентификацию, используя собственное устройство, такое как телефон.

"hybrid"

Аутентификация основана на сочетании методов авторизации/аутентификации, потенциально использующих как механизмы пользователя, так и сервера.

rpId Необязательно

Строка, определяющая идентификатор доверенной стороны (например, "login.example.org"). В целях безопасности:

• Вызываемое веб-приложение проверяет, что rpId соответствует происхождению доверенной стороны.
• Аутентификатор проверяет, что rpId соответствует rpId учётных данных, используемых для церемонии аутентификации.

По умолчанию это домен текущего происхождения.

timeout Необязательно

Числовая подсказка в миллисекундах, указывающая время, в течение которого доверенная сторона готова ждать завершения операции извлечения. Этот параметр может быть изменён браузером.

userVerification Необязательно

Строка, определяющая требования доверенной стороны к проверке пользователя в процессе аутентификации. Эта проверка инициируется аутентификатором, который запросит пользователя предоставить доступный фактор (например, PIN или биометрический ввод).

Значение может быть одним из следующих:

"required"

Доверенная сторона требует проверки пользователя, и операция завершится неудачей, если она не произойдёт.

"preferred"

Доверенная сторона предпочитает проверку пользователя, если это возможно, но операция не завершится неудачей, если она не произойдёт.

"discouraged"

Доверенная сторона не хочет проверки пользователя, чтобы сделать взаимодействие с пользователем максимально гладким.

По умолчанию "preferred".