Стратегии переноса сайта от использования строки агента пользователя к новым клиентским подсказкам User-Agent.
Дата публикации: 19 мая 2021 г.
Строка User-Agent – это важный элемент пассивного цифрового отпечатка в браузерах, который сложно обрабатывать. Однако существует множество веских причин для сбора и обработки данных агента пользователя, поэтому необходимо найти лучшее решение. Клиентские подсказки User-Agent позволяют явно заявить о необходимости данных агента пользователя и предоставляют методы для возврата данных в удобном формате.
В этой статье мы расскажем, как проверить доступ к данным агента пользователя и перейти на клиентские подсказки User-Agent.
Проверьте сбор и использование данных агента пользователя
Как и в случае с любой формой сбора данных, вы всегда должны понимать, зачем вы их собираете. Первый шаг, независимо от того, будете ли вы предпринимать какие-либо действия, – понять, где и почему вы используете данные агента пользователя.
Если вы не знаете, используются ли данные агента пользователя и где именно, поищите navigator.userAgent в коде интерфейса и HTTP-заголовок User-Agent в коде серверной части. Также проверьте, не используются ли в коде интерфейса функции, поддержка которых уже прекращена, например navigator.platform и navigator.appVersion.
С функциональной точки зрения подумайте о том, где в вашем коде вы записываете или обрабатываете:
- Название или версия браузера
- Название или версия операционной системы.
- Марка или модель устройства
- тип, архитектура или разрядность ЦП (например, 64-разрядный);
Также вероятно, что вы используете стороннюю библиотеку или сервис для обработки агента пользователя. В этом случае проверьте, обновляются ли они для поддержки клиентских подсказок User-Agent.
Вы используете только базовые данные агента пользователя?
В набор клиентских подсказок User-Agent по умолчанию входят:
Sec-CH-UA– название браузера и основная версия.Sec-CH-UA-Mobile– логическое значение, указывающее на мобильное устройство.Sec-CH-UA-Platform– название операционной системы;
В предлагаемой сокращенной версии строки агента пользователя эта базовая информация также будет сохранена с обеспечением обратной совместимости. Например, вместо Chrome/90.0.4430.85 в строке будет указано Chrome/90.0.0.0.
Если вы проверяете строку агента пользователя только на наличие названия браузера, основной версии или операционной системы, то ваш код продолжит работать, хотя вы, скорее всего, будете видеть предупреждения о прекращении поддержки.
Хотя вы можете и должны перейти на клиентские подсказки User-Agent, у вас может быть устаревший код или ограничения ресурсов, которые мешают этому. Сокращение информации в строке агента пользователя с сохранением обратной совместимости гарантирует, что существующий код будет получать менее подробную информацию, но сохранит базовую функциональность.
Стратегии
Существует несколько стратегий перехода от использования строк агента пользователя к клиентским подсказкам User-Agent.
Клиентский JavaScript API по запросу
Если вы используете navigator.userAgent, то вам следует перейти на navigator.userAgentData, а если это невозможно, то на синтаксический анализ строки агента пользователя.
if (navigator.userAgentData) {
// use new hints
} else {
// fall back to user-agent string parsing
}
Если вы проверяете, используется ли мобильное устройство или компьютер, используйте логическое значение mobile:
const isMobile = navigator.userAgentData.mobile;
userAgentData.brands – массив объектов со свойствами brand и version, в котором браузер может указать свою совместимость с этими брендами. Вы можете получить доступ к нему напрямую как к массиву или использовать вызов some(), чтобы проверить, есть ли в нем определенная запись:
function isCompatible(item) {
// In real life you most likely have more complex rules here
return ['Chromium', 'Google Chrome', 'NewBrowser'].includes(item.brand);
}
if (navigator.userAgentData.brands.some(isCompatible)) {
// browser reports as compatible
}
Если вам нужно одно из более подробных значений агента пользователя с высокой энтропией, укажите его и проверьте результат в возвращенном Promise:
navigator.userAgentData.getHighEntropyValues(['model'])
.then(ua => {
// requested hints available as attributes
const model = ua.model
});
Этот вариант также подходит, если вы хотите перейти от серверной обработки к клиентской обработке. JavaScript API не требует доступа к заголовкам HTTP-запросов, поэтому значения агента пользователя можно запрашивать в любой момент.
Статический заголовок на стороне сервера
Если вы используете заголовок запроса User-Agent на сервере и ваши потребности в этих данных относительно одинаковы на всем сайте, вы можете указать подсказки клиента в качестве статического набора в своих ответах. Это относительно простой подход, поскольку обычно вам нужно настроить его только в одном месте. Например, если вы уже добавляете заголовки в конфигурацию веб-сервера, то можете добавить их и в конфигурацию хостинга или конфигурацию верхнего уровня фреймворка или платформы, которую вы используете для своего сайта.
Этот вариант подходит, если вы преобразуете или настраиваете ответы на основе данных агента пользователя.
Браузеры и другие клиенты могут предоставлять разные подсказки по умолчанию, поэтому рекомендуется указывать все, что вам нужно, даже если обычно это предоставляется по умолчанию.
Например, текущие настройки по умолчанию для Chrome будут представлены следующим образом:
⬇️ Заголовки ответов
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Platform, Sec-CH-UA
Если вы также хотите получать в ответах модель устройства, отправьте следующий запрос:
⬇️ Заголовки ответов
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA
При обработке на стороне сервера сначала проверьте, был ли отправлен нужный заголовок Sec-CH-UA, а затем, если он недоступен, выполните синтаксический анализ заголовка User-Agent.
Делегирование подсказок междоменным запросам
Если вы запрашиваете перекрестные или межсайтовые вспомогательные ресурсы, для которых в запросах требуются клиентские подсказки User-Agent, вам нужно будет явно указать нужные подсказки с помощью Permissions Policy.
Например, предположим, что https://blog.site размещает ресурсы на https://cdn.site, который может возвращать ресурсы, оптимизированные для определенного устройства.
https://blog.site может запросить подсказку Sec-CH-UA-Model, но должен явно делегировать ее https://cdn.site с помощью заголовка Permissions-Policy. Список подсказок, управляемых правилами, доступен в черновике спецификации инфраструктуры клиентских подсказок.
⬇️ Ответ от blog.site, делегирующего подсказку
Accept-CH: Sec-CH-UA-Model
Permissions-Policy: ch-ua-model=(self "https://cdn.site")
⬆️ Запросы к подресурсам на сайте cdn.site включают делегированную подсказку
Sec-CH-UA-Model: "Pixel 5"
Вы можете указать несколько подсказок для нескольких источников, а не только из диапазона ch-ua:
⬇️ Ответ от blog.site, делегирующий несколько подсказок нескольким источникам
Accept-CH: Sec-CH-UA-Model, DPR
Permissions-Policy: ch-ua-model=(self "https://cdn.site"),
ch-dpr=(self "https://cdn.site" "https://img.site")
Как делегировать подсказки окнам iframe
Перекрестные фреймы iframe работают так же, как и перекрестные ресурсы, но вы указываете подсказки, которые хотите делегировать, в атрибуте allow.
⬇️ Ответ от blog.site
Accept-CH: Sec-CH-UA-Model
↪️ HTML для blog.site
<iframe src="https://widget.site" allow="ch-ua-model"></iframe>
⬆️ Запрос пользователю widget.site
Sec-CH-UA-Model: "Pixel 5"
Атрибут allow в iframe переопределит любой заголовок Accept-CH, который может отправить widget.site, поэтому убедитесь, что вы указали все, что потребуется сайту, встроенному в iframe.
Динамические подсказки на стороне сервера
Если на определенных этапах пути пользователя вам требуется больше подсказок, чем на остальном сайте, вы можете запрашивать их по требованию, а не статически по всему сайту. Управлять этим сложнее, но если вы уже задали разные заголовки для каждого маршрута, то это может быть целесообразно.
Важно помнить, что каждый экземпляр заголовка Accept-CH перезаписывает существующий набор. Поэтому если вы динамически настраиваете заголовок, то каждая страница должна запрашивать полный набор необходимых подсказок.
Например, в одном из разделов сайта вы хотите показывать значки и элементы управления, соответствующие операционной системе пользователя. Для этого вам может потребоваться дополнительно использовать Sec-CH-UA-Platform-Version, чтобы показывать подходящие дочерние ресурсы.
⬇️ Заголовки ответов для /blog
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Platform, Sec-CH-UA
⬇️ Заголовки ответов для /app
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA
Как устранить проблему "При первом запросе требуются подсказки на стороне сервера"
В некоторых случаях вам может потребоваться больше подсказок, чем по умолчанию, но это бывает редко, поэтому убедитесь, что вы изучили причины.
Первый запрос – это самый первый запрос верхнего уровня для источника, отправленный в рамках сеанса просмотра. Набор подсказок по умолчанию включает название браузера с номером основной версии, платформу и индикатор мобильного устройства. Поэтому здесь нужно задать вопрос: требуются ли вам расширенные данные при первоначальной загрузке страницы?
Чтобы получить дополнительные подсказки по первому запросу, есть два варианта. Во-первых, вы можете использовать заголовок Critical-CH. Этот заголовок имеет тот же формат, что и Accept-CH, но сообщает браузеру, что он должен немедленно повторить запрос, если первый был отправлен без критической подсказки.
⬆️ Первоначальный запрос
[With default headers]
⬇️ Заголовки ответов
Accept-CH: Sec-CH-UA-Model
Critical-CH: Sec-CH-UA-Model
🔃 Браузер повторяет исходный запрос с дополнительным заголовком.
[With default headers + …]
Sec-CH-UA-Model: Pixel 5
Это приводит к дополнительным затратам на повторную попытку при самом первом запросе, но стоимость реализации относительно низкая. Отправьте дополнительный заголовок, а браузер сделает все остальное.
Если вам действительно нужны дополнительные подсказки при первой загрузке страницы, ознакомьтесь с предложением по надежности подсказок клиента. В нем описано, как указывать подсказки в настройках на уровне подключения. Для этого используется расширение Application-Layer Protocol Settings (ALPS) для TLS 1.3, которое позволяет передавать подсказки на раннем этапе в подключениях HTTP/2 и HTTP/3. Это пока только начало, но если вы активно управляете собственными настройками TLS и подключения, то сейчас самое время внести свой вклад.
Поддержка устаревших версий
На вашем сайте может быть устаревший или сторонний код, который зависит от navigator.userAgent, включая части строки агента пользователя, которые будут сокращены. Рекомендуем перейти на эквивалентные вызовы navigator.userAgentData, но есть и временное решение.
UA-CH retrofill – это небольшая библиотека, которая позволяет перезаписать navigator.userAgent новой строкой, созданной на основе запрошенных значений navigator.userAgentData.
Например, этот код генерирует строку агента пользователя, которая дополнительно включает подсказку "model":
import { overrideUserAgentUsingClientHints } from './uach-retrofill.js';
overrideUserAgentUsingClientHints(['model'])
.then(() => { console.log(navigator.userAgent); });
В результате будет показана модель Pixel 5, но по-прежнему будет отображаться сокращенная версия 92.0.0.0, поскольку подсказка uaFullVersion не была запрошена:
Mozilla/5.0 (Linux; Android 10.0; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.0.0 Mobile Safari/537.36
Дополнительная поддержка
Если эти стратегии не подходят для вашего случая, начните обсуждение в репозитории privacy-sandbox-dev-support, и мы вместе рассмотрим вашу проблему.