Strategies to migrate your site from relying on the user-agent string to the
new User-Agent Client Hints.


![Rowan Merewood](https://web.dev/images/authors/rowan_m.jpg) Rowan Merewood [GitHub](https://github.com/rowan-m) [LinkedIn](https://www.linkedin.com/in/rowanmerewood) [Mastodon](https://mastodon.social/@rowan_m) [Bluesky](https://bsky.app/profile/rowan.fyi) [Homepage](https://rowan.fyi)

<br />


Published: May 19, 2021

<br />

The [User-Agent
string](https://developer.mozilla.org/docs/Web/HTTP/Headers/User-Agent) is
a significant [passive fingerprinting
surface](https://w3c.github.io/fingerprinting-guidance/#passive) in browsers, as
well as being difficult to process. However, there are all kinds of valid
reasons for collecting and processing user-agent data, so what's needed is a
path to a better solution.
[User-Agent Client Hints](https://developer.chrome.com/docs/privacy-security/user-agent-client-hints)
provide both an explicit way to declare your need for user-agent data and
methods to return the data in an easy-to-use format.

Here, we take you through auditing your access to user-agent data and
migrating user-agent string usage to User-Agent Client Hints.


Browser Support

- ![Chrome: 90.](data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='-10 -10 276 276'%3E%3ClinearGradient id='a' x1='145' x2='34' y1='253' y2='61' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='0' stop-color='%231e8e3e'/%3E%3Cstop offset='1' stop-color='%2334a853'/%3E%3C/linearGradient%3E%3ClinearGradient id='b' x1='111' x2='222' y1='254' y2='62' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='0' stop-color='%23fcc934'/%3E%3Cstop offset='1' stop-color='%23fbbc04'/%3E%3C/linearGradient%3E%3ClinearGradient id='c' x1='17' x2='239' y1='80' y2='80' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='0' stop-color='%23d93025'/%3E%3Cstop offset='1' stop-color='%23ea4335'/%3E%3C/linearGradient%3E%3Ccircle cx='128' cy='128' r='64' fill='%23fff'/%3E%3Cpath fill='url(%23a)' d='M96 183a64 64 0 0 1-23-23L17 64a128 128 0 0 0 111 192l55-96a64 64 0 0 1-87 23Z'/%3E%3Cpath fill='url(%23b)' d='M192 128a64 64 0 0 1-9 32l-55 96A128 128 0 0 0 239 64H128a64 64 0 0 1 64 64Z'/%3E%3Ccircle cx='128' cy='128' r='52' fill='%231a73e8'/%3E%3Cpath fill='url(%23c)' d='M96 73a64 64 0 0 1 32-9h111a128 128 0 0 0-222 0l56 96a64 64 0 0 1 23-87Z'/%3E%3C/svg%3E)
- ![Edge: 90.](data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='24' height='24' viewBox='0 0 27600 27600'%3E%3ClinearGradient id='A' gradientUnits='userSpaceOnUse'/%3E%3ClinearGradient id='B' x1='6870' x2='24704' y1='18705' y2='18705' xlink:href='%23A'%3E%3Cstop offset='0' stop-color='%230c59a4'/%3E%3Cstop offset='1' stop-color='%23114a8b'/%3E%3C/linearGradient%3E%3ClinearGradient id='C' x1='16272' x2='5133' y1='10968' y2='23102' xlink:href='%23A'%3E%3Cstop offset='0' stop-color='%231b9de2'/%3E%3Cstop offset='.16' stop-color='%231595df'/%3E%3Cstop offset='.67' stop-color='%230680d7'/%3E%3Cstop offset='1' stop-color='%230078d4'/%3E%3C/linearGradient%3E%3CradialGradient id='D' cx='16720' cy='18747' r='9538' xlink:href='%23A'%3E%3Cstop offset='.72' stop-opacity='0'/%3E%3Cstop offset='.95' stop-opacity='.53'/%3E%3Cstop offset='1'/%3E%3C/radialGradient%3E%3CradialGradient id='E' cx='7130' cy='19866' r='14324' gradientTransform='matrix(.14843 -.98892 .79688 .1196 -8759 25542)' xlink:href='%23A'%3E%3Cstop offset='.76' stop-opacity='0'/%3E%3Cstop offset='.95' stop-opacity='.5'/%3E%3Cstop offset='1'/%3E%3C/radialGradient%3E%3CradialGradient id='F' cx='2523' cy='4680' r='20243' gradientTransform='matrix(-.03715 .99931 -2.12836 -.07913 13579 3530)' xlink:href='%23A'%3E%3Cstop offset='0' stop-color='%2335c1f1'/%3E%3Cstop offset='.11' stop-color='%2334c1ed'/%3E%3Cstop offset='.23' stop-color='%232fc2df'/%3E%3Cstop offset='.31' stop-color='%232bc3d2'/%3E%3Cstop offset='.67' stop-color='%2336c752'/%3E%3C/radialGradient%3E%3CradialGradient id='G' cx='24247' cy='7758' r='9734' gradientTransform='matrix(.28109 .95968 -.78353 .22949 24510 -16292)' xlink:href='%23A'%3E%3Cstop offset='0' stop-color='%2366eb6e'/%3E%3Cstop offset='1' stop-color='%2366eb6e' stop-opacity='0'/%3E%3C/radialGradient%3E%3Cpath id='H' d='M24105 20053a9345 9345 0 01-1053 472 10202 10202 0 01-3590 646c-4732 0-8855-3255-8855-7432 0-1175 680-2193 1643-2729-4280 180-5380 4640-5380 7253 0 7387 6810 8137 8276 8137 791 0 1984-230 2704-456l130-44a12834 12834 0 006660-5282c220-350-168-757-535-565z'/%3E%3Cpath id='I' d='M11571 25141a7913 7913 0 01-2273-2137 8145 8145 0 01-1514-4740 8093 8093 0 013093-6395 8082 8082 0 011373-859c312-148 846-414 1554-404a3236 3236 0 012569 1297 3184 3184 0 01636 1866c0-21 2446-7960-8005-7960-4390 0-8004 4166-8004 7820 0 2319 538 4170 1212 5604a12833 12833 0 007684 6757 12795 12795 0 003908 610c1414 0 2774-233 4045-656a7575 7575 0 01-6278-803z'/%3E%3Cpath id='J' d='M16231 15886c-80 105-330 250-330 566 0 260 170 512 472 723 1438 1003 4149 868 4156 868a5954 5954 0 003027-839 6147 6147 0 001133-850 6180 6180 0 001910-4437c26-2242-796-3732-1133-4392-2120-4141-6694-6525-11668-6525-7011 0-12703 5635-12798 12620 47-3654 3679-6605 7996-6605 350 0 2346 34 4200 1007 1634 858 2490 1894 3086 2921 618 1067 728 2415 728 2952s-271 1333-780 1990z'/%3E%3Cuse fill='url(%23B)' xlink:href='%23H'/%3E%3Cuse fill='url(%23D)' opacity='.35' xlink:href='%23H'/%3E%3Cuse fill='url(%23C)' xlink:href='%23I'/%3E%3Cuse fill='url(%23E)' opacity='.4' xlink:href='%23I'/%3E%3Cuse fill='url(%23F)' xlink:href='%23J'/%3E%3Cuse fill='url(%23G)' xlink:href='%23J'/%3E%3C/svg%3E)
- ![Firefox: not supported.](data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 512 512'%3E%3Cdefs%3E%3CradialGradient id='ff-b' cx='428.5' cy='55.1' r='501' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.1' stop-color='%23ffbd4f'/%3E%3Cstop offset='.2' stop-color='%23ffac31'/%3E%3Cstop offset='.3' stop-color='%23ff9d17'/%3E%3Cstop offset='.3' stop-color='%23ff980e'/%3E%3Cstop offset='.4' stop-color='%23ff563b'/%3E%3Cstop offset='.5' stop-color='%23ff3750'/%3E%3Cstop offset='.7' stop-color='%23f5156c'/%3E%3Cstop offset='.8' stop-color='%23eb0878'/%3E%3Cstop offset='.9' stop-color='%23e50080'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-c' cx='245.4' cy='259.9' r='501' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.3' stop-color='%23960e18'/%3E%3Cstop offset='.3' stop-color='%23b11927' stop-opacity='.7'/%3E%3Cstop offset='.4' stop-color='%23db293d' stop-opacity='.3'/%3E%3Cstop offset='.5' stop-color='%23f5334b' stop-opacity='.1'/%3E%3Cstop offset='.5' stop-color='%23ff3750' stop-opacity='0'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-d' cx='305.8' cy='-58.6' r='363' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.1' stop-color='%23fff44f'/%3E%3Cstop offset='.3' stop-color='%23ffdc3e'/%3E%3Cstop offset='.5' stop-color='%23ff9d12'/%3E%3Cstop offset='.5' stop-color='%23ff980e'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-e' cx='190' cy='390.8' r='238.6' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.3' stop-color='%233a8ee6'/%3E%3Cstop offset='.5' stop-color='%235c79f0'/%3E%3Cstop offset='.7' stop-color='%239059ff'/%3E%3Cstop offset='1' stop-color='%23c139e6'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-f' cx='252.2' cy='201.3' r='126.5' gradientTransform='matrix(1 0 0 1 -48 31)' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.2' stop-color='%239059ff' stop-opacity='0'/%3E%3Cstop offset='.3' stop-color='%238c4ff3' stop-opacity='.1'/%3E%3Cstop offset='.8' stop-color='%237716a8' stop-opacity='.5'/%3E%3Cstop offset='1' stop-color='%236e008b' stop-opacity='.6'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-g' cx='239.1' cy='34.6' r='171.6' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='0' stop-color='%23ffe226'/%3E%3Cstop offset='.1' stop-color='%23ffdb27'/%3E%3Cstop offset='.3' stop-color='%23ffc82a'/%3E%3Cstop offset='.5' stop-color='%23ffa930'/%3E%3Cstop offset='.7' stop-color='%23ff7e37'/%3E%3Cstop offset='.8' stop-color='%23ff7139'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-h' cx='374' cy='-74.3' r='732.2' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.1' stop-color='%23fff44f'/%3E%3Cstop offset='.5' stop-color='%23ff980e'/%3E%3Cstop offset='.6' stop-color='%23ff5634'/%3E%3Cstop offset='.7' stop-color='%23ff3647'/%3E%3Cstop offset='.9' stop-color='%23e31587'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-i' cx='304.6' cy='7.1' r='536.4' gradientTransform='rotate(84 303 4)' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='0' stop-color='%23fff44f'/%3E%3Cstop offset='.1' stop-color='%23ffe847'/%3E%3Cstop offset='.2' stop-color='%23ffc830'/%3E%3Cstop offset='.3' stop-color='%23ff980e'/%3E%3Cstop offset='.4' stop-color='%23ff8b16'/%3E%3Cstop offset='.5' stop-color='%23ff672a'/%3E%3Cstop offset='.6' stop-color='%23ff3647'/%3E%3Cstop offset='.7' stop-color='%23e31587'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-j' cx='235' cy='98.1' r='457.1' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.1' stop-color='%23fff44f'/%3E%3Cstop offset='.5' stop-color='%23ff980e'/%3E%3Cstop offset='.6' stop-color='%23ff5634'/%3E%3Cstop offset='.7' stop-color='%23ff3647'/%3E%3Cstop offset='.9' stop-color='%23e31587'/%3E%3C/radialGradient%3E%3CradialGradient id='ff-k' cx='355.7' cy='124.9' r='500.3' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.1' stop-color='%23fff44f'/%3E%3Cstop offset='.2' stop-color='%23ffe141'/%3E%3Cstop offset='.5' stop-color='%23ffaf1e'/%3E%3Cstop offset='.6' stop-color='%23ff980e'/%3E%3C/radialGradient%3E%3ClinearGradient id='ff-a' x1='446.9' y1='76.8' x2='47.9' y2='461.8' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.1' stop-color='%23fff44f'/%3E%3Cstop offset='.1' stop-color='%23ffe847'/%3E%3Cstop offset='.2' stop-color='%23ffc830'/%3E%3Cstop offset='.4' stop-color='%23ff980e'/%3E%3Cstop offset='.4' stop-color='%23ff8b16'/%3E%3Cstop offset='.5' stop-color='%23ff672a'/%3E%3Cstop offset='.5' stop-color='%23ff3647'/%3E%3Cstop offset='.7' stop-color='%23e31587'/%3E%3C/linearGradient%3E%3ClinearGradient id='ff-l' x1='442.1' y1='74.8' x2='102.6' y2='414.3' gradientUnits='userSpaceOnUse'%3E%3Cstop offset='.2' stop-color='%23fff44f' stop-opacity='.8'/%3E%3Cstop offset='.3' stop-color='%23fff44f' stop-opacity='.6'/%3E%3Cstop offset='.5' stop-color='%23fff44f' stop-opacity='.2'/%3E%3Cstop offset='.6' stop-color='%23fff44f' stop-opacity='0'/%3E%3C/linearGradient%3E%3C/defs%3E%3Cpath d='M479 166c-11-25-32-52-49-60a249 249 0 0 1 25 73c-27-68-73-95-111-155a255 255 0 0 1-8-14 44 44 0 0 1-4-9 1 1 0 0 0 0-1 1 1 0 0 0-1 0c-60 35-81 101-83 134a120 120 0 0 0-66 25 71 71 0 0 0-6-5 111 111 0 0 1-1-58c-25 11-44 29-58 44-9-12-9-52-8-60l-8 4a175 175 0 0 0-24 21 210 210 0 0 0-22 26 203 203 0 0 0-32 73l-1 2-2 15a229 229 0 0 0-4 34v1a240 240 0 0 0 477 40l1-9c5-41 0-84-15-121zM202 355l3 1-3-1zm55-145zm198-31z' fill='url(%23ff-a)'/%3E%3Cpath d='M479 166c-11-25-32-52-49-60 14 26 22 53 25 72v1a207 207 0 0 1-206 279c-113-3-212-87-231-197-3-17 0-26 2-40-2 11-3 14-4 34v1a240 240 0 0 0 477 40l1-9c5-41 0-84-15-121z' fill='url(%23ff-b)'/%3E%3Cpath d='M479 166c-11-25-32-52-49-60 14 26 22 53 25 72v1a207 207 0 0 1-206 279c-113-3-212-87-231-197-3-17 0-26 2-40-2 11-3 14-4 34v1a240 240 0 0 0 477 40l1-9c5-41 0-84-15-121z' fill='url(%23ff-c)'/%3E%3Cpath d='m362 195 1 1a130 130 0 0 0-22-29C266 92 322 5 331 0c-60 35-81 101-83 134l9-1c45 0 84 25 105 62z' fill='url(%23ff-d)'/%3E%3Cpath d='M257 210c-1 6-22 26-29 26-68 0-80 41-80 41 3 35 28 64 57 79l4 2 7 3a107 107 0 0 0 31 6c120 6 143-143 57-186 22-4 45 5 58 14-21-37-60-62-105-62l-9 1a120 120 0 0 0-66 25l17 16c16 16 58 33 58 35z' fill='url(%23ff-e)'/%3E%3Cpath d='M257 210c-1 6-22 26-29 26-68 0-80 41-80 41 3 35 28 64 57 79l4 2 7 3a107 107 0 0 0 31 6c120 6 143-143 57-186 22-4 45 5 58 14-21-37-60-62-105-62l-9 1a120 120 0 0 0-66 25l17 16c16 16 58 33 58 35z' fill='url(%23ff-f)'/%3E%3Cpath d='m171 151 5 3a111 111 0 0 1-1-58c-25 11-44 29-58 44 1 0 36 0 54 11z' fill='url(%23ff-g)'/%3E%3Cpath d='M18 261a242 242 0 0 0 231 197 207 207 0 0 0 206-279c8 56-20 110-64 146-86 71-169 43-186 31l-3-1c-50-24-71-70-67-110-42 0-57-35-57-35s38-28 89-4c46 22 90 4 90 4 0-2-42-19-58-35l-17-16a71 71 0 0 0-6-5l-5-3c-18-11-52-11-54-11-9-12-9-51-8-60l-8 4a175 175 0 0 0-24 21 210 210 0 0 0-22 26 203 203 0 0 0-32 73c0 1-9 38-5 57z' fill='url(%23ff-h)'/%3E%3Cpath d='M341 167a130 130 0 0 1 22 29 46 46 0 0 1 4 3c55 50 26 121 24 126 44-36 72-90 64-146-27-68-73-95-111-155a255 255 0 0 1-8-14 44 44 0 0 1-4-9 1 1 0 0 0 0-1 1 1 0 0 0-1 0c-9 5-65 92 10 167z' fill='url(%23ff-i)'/%3E%3Cpath d='M367 199a46 46 0 0 0-4-3l-1-1c-13-9-36-18-58-15 86 44 63 193-57 187a107 107 0 0 1-31-6 131 131 0 0 1-11-5c17 12 99 39 186-31 2-5 31-76-24-126z' fill='url(%23ff-j)'/%3E%3Cpath d='M148 277s12-41 80-41c7 0 28-20 29-26s-44 18-90-4c-51-24-89 4-89 4s15 35 57 35c-4 40 16 85 67 110l3 1c-29-15-54-44-57-79z' fill='url(%23ff-k)'/%3E%3Cpath d='M479 166c-11-25-32-52-49-60a249 249 0 0 1 25 73c-27-68-73-95-111-155a255 255 0 0 1-8-14 44 44 0 0 1-4-9 1 1 0 0 0 0-1 1 1 0 0 0-1 0c-60 35-81 101-83 134l9-1c45 0 84 25 105 62-13-9-36-18-58-14 86 43 63 192-57 186a107 107 0 0 1-31-6 131 131 0 0 1-11-5l-3-1 3 1c-29-15-54-44-57-79 0 0 12-41 80-41 7 0 28-20 29-26 0-2-42-19-58-35l-17-16a71 71 0 0 0-6-5 111 111 0 0 1-1-58c-25 11-44 29-58 44-9-12-9-52-8-60l-8 4a175 175 0 0 0-24 21 210 210 0 0 0-22 26 203 203 0 0 0-32 73l-1 2-2 15a279 279 0 0 0-4 34v1a240 240 0 0 0 477 40l1-9c5-41 0-84-15-121zm-24 13z' fill='url(%23ff-l)'/%3E%3C/svg%3E)
- ![Safari: not supported.](data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='24' height='24' viewBox='195 190 135 135'%3E%3Cdefs%3E%3ClinearGradient id='s-a' x1='132.6' x2='134.4' y1='111.7' y2='-105.3' xlink:href='%23s-b'%3E%3Cstop offset='0' stop-color='%23d2d2d2' /%3E%3Cstop offset='.5' stop-color='%23f2f2f2' /%3E%3Cstop offset='1' stop-color='%23fff' /%3E%3C/linearGradient%3E%3ClinearGradient id='s-b' gradientUnits='userSpaceOnUse' /%3E%3ClinearGradient id='s-c' x1='65.4' x2='67.4' y1='115.7' y2='17.1' xlink:href='%23s-b'%3E%3Cstop offset='0' stop-color='%23005ad5' /%3E%3Cstop offset='.2' stop-color='%230875f0' /%3E%3Cstop offset='.3' stop-color='%23218cee' /%3E%3Cstop offset='.6' stop-color='%2327a5f3' /%3E%3Cstop offset='.8' stop-color='%2325aaf2' /%3E%3Cstop offset='1' stop-color='%2321aaef' /%3E%3C/linearGradient%3E%3ClinearGradient id='s-d' x1='158.7' x2='176.3' y1='96.7' y2='79.5' xlink:href='%23s-b'%3E%3Cstop offset='0' stop-color='%23c72e24' /%3E%3Cstop offset='1' stop-color='%23fd3b2f' /%3E%3C/linearGradient%3E%3CradialGradient id='s-i' cx='-69.9' cy='69.3' r='54' gradientTransform='matrix(.9 -.01 .04 2.72 -9 -120)' xlink:href='%23s-b'%3E%3Cstop offset='0' stop-color='%2324a5f3' stop-opacity='0' /%3E%3Cstop offset='1' stop-color='%231e8ceb' /%3E%3C/radialGradient%3E%3CradialGradient id='s-j' cx='109.3' cy='13.8' r='93.1' gradientTransform='matrix(-.02 1.1 -1.04 -.02 137 -115)' xlink:href='%23s-b'%3E%3Cstop offset='0' stop-opacity='0' /%3E%3Cstop offset='1' stop-color='%235488d6' stop-opacity='0' /%3E%3Cstop offset='1' stop-color='%235d96eb' /%3E%3C/radialGradient%3E%3C/defs%3E%3Crect width='220' height='220' x='22' y='-107' fill='url(%23s-a)' ry='49' transform='matrix(.57 0 0 .57 187 256)' /%3E%3Cg transform='translate(194 190)'%3E%3Ccircle cx='67.8' cy='67.7' fill='url(%23s-c)' paint-order='stroke fill markers' r='54' /%3E%3Ccircle cx='-69.9' cy='69.3' fill='url(%23s-i)' transform='translate(138 -2)' r='54' /%3E%3C/g%3E%3Cellipse cx='120' cy='14.2' fill='url(%23s-j)' rx='93.1' ry='93.7' transform='matrix(.58 0 0 .58 192 250)' /%3E%3Cg transform='matrix(.58 0 0 .57 197 182)'%3E%3Cpath fill='%23cac7c8' d='M46 192h1l72-48-7-9-66 57Z' /%3E%3Cpath fill='%23fbfffc' d='M46 191v1l66-57-7-9-59 65Z' /%3E%3Cpath fill='url(%23s-d)' d='m119 144-7-9 66-57-59 66Z' /%3E%3Cpath fill='%23fb645c' d='m105 126 7 9 66-57-1-1-72 49Z' /%3E%3C/g%3E%3Cpath stroke='%23fff' stroke-linecap='round' stroke-miterlimit='1' stroke-width='1.3' d='m287 278 3-2m-12-17 8-2m-8-3h4m-4-13 8 2m-8 3h4m-1-13 7 3m-4-11 7 4m-2-11 6 6m0-12 6 7m1-11 4 6m4-10 3 7m5-9 2 7m15-7-1 7m10-5-3 7m11-4-4 7m11-2-5 6m16 7-7 4m10 4-7 3m10 6-8 1m8 16-8-2m5 10-7-3m4 11-7-4m2 11-6-5m0 11-5-6m-2 11-4-7m-4 11-3-8m-6 10-1-8m-16 8 2-8m-10 5 3-7m-11 4 4-7m-11 2 5-6m-8 3 3-3m4 8 2-3m5 8 2-4m6 7 1-4m8 5v-4m8 4v-4m9 3-1-4m9 1-2-4m9 0-2-4m9-2-3-3m8-4-3-2m8-5-4-2m7-6-4-1m5-8h-4m4-8h-4m3-9-4 1m1-9-4 2m-1-9-3 2m-2-9-3 3m-4-8-2 3m-5-8-2 4m-6-6-1 3m-8-5v4m-8-4v4m-9-2 1 3m-9 0 2 3m-9 1 2 3m-9 2 3 3m-8 4 3 2m-8 5 4 2m-7 6 4 1m-4 25 4-1m-2 5 7-3m-6 7 4-2m-2 6 7-4m-13-21h8m41-41v-8m0 99v-8m49-42h-8' transform='translate(-65 8)' /%3E%3C/svg%3E)

[Source](https://developer.mozilla.org/docs/Web/API/Navigator/userAgentData)

<br />

## Audit collection and use of user-agent data

As with any form of data collection, you should always understand **why** you
are collecting it. The first step, regardless of whether or not you will be
taking any action, is to understand where and why you are using user-agent data.

If you don't know if or where user-agent data is being used, consider searching
your frontend code for use of `navigator.userAgent` and your backend code for
use of the `User-Agent` HTTP header. You should also check your frontend code
for use of already deprecated features, such as `navigator.platform` and
`navigator.appVersion`.

From a functional point of view, think about anywhere in your code where you are
recording or processing:

- Browser name or version
- Operating system name or version
- Device make or model
- CPU type, architecture, or bitness (for example, 64-bit)

It's also likely that you may be using a third-party library or service to
process the user-agent. In this case, check to see if they are updating to
support User-Agent Client Hints.

### Are you only using basic user-agent data?

The default set of User-Agent Client Hints includes:

- `Sec-CH-UA`: browser name and major / significant version
- `Sec-CH-UA-Mobile`: boolean value indicating a mobile device
- `Sec-CH-UA-Platform`: operating system name

The reduced version of the user-agent string that is proposed will also retain
this basic information in a backwards-compatible way. For example, instead of
`Chrome/90.0.4430.85` the string would include `Chrome/90.0.0.0`.

If you are only checking the user-agent string for browser name, major version,
or operating system, then your code will continue to work though you are likely
to see deprecation warnings.

While you can and should migrate to User-Agent Client Hints, you may have legacy
code or resource constraints that prevent this. The reduction of information in
the user-agent string in this backwards-compatible way is intended to ensure
that while existing code will receive less detailed information, it should still
retain basic functionality.

## Strategies

There are a number of strategies you can take to migrate user-agent string usage
to User-Agent Client Hints.

### On-demand client-side JavaScript API

If you're using `navigator.userAgent`, you should transition to
preferring `navigator.userAgentData` before falling back to parsing the
user-agent string.

```javascript
if (navigator.userAgentData) {
  // use new hints
} else {
  // fall back to user-agent string parsing
}
```

If you're checking for mobile or desktop, use the boolean `mobile` value:

```javascript
const isMobile = navigator.userAgentData.mobile;
```

`userAgentData.brands` is an array of objects with `brand` and `version`
properties where the browser is able to list its compatibility with those
brands. You can access it directly as an array or you may want to use a
`some()` call to check if a specific entry is present:

```javascript
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
}
```

> [!TIP]
> **Tip:** `userAgentData.brands` contains varying values in a varied order. Avoid relying on something that appears at a certain index.

If you need one of the more detailed, high-entropy user-agent values, you
need to specify it and check for the result in the returned `Promise`:

```javascript
navigator.userAgentData.getHighEntropyValues(['model'])
  .then(ua => {
    // requested hints available as attributes
    const model = ua.model
  });

```

You may also want to use this strategy if you would like to move from
server-side processing to client-side processing. The JavaScript API does not
require access to HTTP request headers, so user-agent values can be requested at
any point.

> [!NOTE]
> **Note:** Try the [User-Agent Client Hints JavaScript API demo](https://user-agent-client-hints.glitch.me/javascript.html).

### Static server-side header

If you are using the `User-Agent` request header on the server and your needs
for that data are relatively consistent across your entire site, then you can
specify client hints as a static set in your responses. This is a
relatively simple approach since you generally only need to configure it in one
location. For example, it may be in your web server configuration if you already
add headers there, your hosting configuration, or top-level configuration of the
framework or platform you use for your site.

Consider this strategy if you are transforming or customizing the responses
served based on the user-agent data.

> [!NOTE]
> **Note:** Consider migrating to the [on-demand client-side JavaScript API](https://web.dev/articles/migrate-to-ua-ch.md.txt#on-demand_client-side_javascript_api) strategy instead of sending additional headers.

Browsers or other clients may choose to supply different default hints, so it's
good practice to specify everything you need, even if it's generally provided by
default.

For example, the current defaults for Chrome would be represented as:

⬇️ Response headers

```text
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Platform, Sec-CH-UA
```

If you also wanted to receive the device model in responses, then you would
send:

⬇️ Response headers

```text
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA
```

> [!TIP]
> **Tip:** Ordering is not important, the example is listed alphabetically.

When processing this on the server-side you should first check if the desired
`Sec-CH-UA` header has been sent and then fallback to the `User-Agent` header
parsing if it is not available.

> [!NOTE]
> **Note:** Try the [User-Agent Client Hints HTTP header demo](https://user-agent-client-hints.glitch.me/).

### Delegate hints to cross-origin requests

If you are requesting cross-origin or cross-site subresources that require
User-Agent Client Hints to be sent on their requests then you will need to
explicitly specify the desired hints using a
[Permissions Policy](https://developer.chrome.com/docs/privacy-security/permissions-policy).

> [!NOTE]
> **Note:** Permissions Policy is the new form of Feature Policy.

For example, let's say that `https://blog.site` hosts resources on
`https://cdn.site` which can return resources optimized for a specific device.
`https://blog.site` can ask for the `Sec-CH-UA-Model` hint, but needs to
explicitly delegate it to `https://cdn.site` using the `Permissions-Policy`
header. The list of policy-controlled hints is available in the [Clients Hints
Infrastructure
draft](https://wicg.github.io/client-hints-infrastructure/#policy-controlled-client-hints-features)

⬇️ Response from `blog.site` delegating the hint

```text
Accept-CH: Sec-CH-UA-Model
Permissions-Policy: ch-ua-model=(self "https://cdn.site")
```

⬆️ Request to subresources on `cdn.site` include the delegated hint

```text
Sec-CH-UA-Model: "Pixel 5"
```

You can specify multiple hints for multiple origins, and not just from the `ch-ua` range:

⬇️ Response from `blog.site` delegating multiple hints to multiple origins

```text
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")
```

> [!TIP]
> **Tip:** You don't need to include each delegated hint in `Accept-CH`, but you do need to include `self` for each hint, even if you're not using it at the top level.

### Delegate hints to iframes

Cross-origin iframes work in a similar way to cross-origin resources, but you
specify the hints you would like to delegate in the `allow` attribute.

⬇️ Response from `blog.site`

```text
Accept-CH: Sec-CH-UA-Model
```

↪️ HTML for `blog.site`

```html
<iframe src="https://widget.site" allow="ch-ua-model"></iframe>
```

⬆️ Request to `widget.site`

```text
Sec-CH-UA-Model: "Pixel 5"
```

The `allow` attribute in the iframe will override any `Accept-CH` header that
`widget.site` may send itself, so make sure you've specified everything the
iframe'd site will need.

### Dynamic server-side hints

If you have specific parts of the user journey where you need a larger selection
of hints than across the rest of the site, you may choose to request those hints
on demand rather than statically across the entire site. This is more complex to
manage, but if you already set different headers on a per route basis it may be
feasible.

The important thing to remember here is that each instance of the `Accept-CH`
header will effectively overwrite the existing set. So, if you are dynamically
setting the header then each page must request the full set of hints required.

For example, you may have one section on your site where you want to provide
icons and controls that match the user's operating system. For this, you may
want to additionally pull in `Sec-CH-UA-Platform-Version` to serve appropriate
subresources.

⬇️ Response headers for `/blog`

```text
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Platform, Sec-CH-UA
```

⬇️ Response headers for `/app`

```text
Accept-CH: Sec-CH-UA-Mobile, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA
```

### Address server-side hints required on first request

There may be cases where you require more than the default set of hints on the
very first request, however this is likely to be rare so make sure you've
reviewed the reasoning.

The first request really means the very first top-level request for that origin
sent in that browsing session. The default set of hints includes the browser
name with major version, the platform, and the mobile indicator. So the question
to ask here is, do you require extended data on the initial page load?

> [!NOTE]
> **Note:** Consider using the [on-demand client-side JavaScript API strategy](https://web.dev/articles/migrate-to-ua-ch.md.txt#on-demand_client-side_javascript_api) to alter content within the page, instead of client-side.

For additional hints on the first request there are two options. First, you can
make use of the `Critical-CH` header. This takes the same format as `Accept-CH`
but tells the browser that it should immediately retry the request if the first
one was sent without the critical hint.

⬆️ Initial request

```text
[With default headers]
```

⬇️ Response headers

```text
Accept-CH: Sec-CH-UA-Model
Critical-CH: Sec-CH-UA-Model
```

🔃 Browser retries initial request with the extra header

```text
[With default headers + ...]
Sec-CH-UA-Model: Pixel 5
```

This incurs the overhead of the retry on the very first request, but the
implementation cost is relatively low. Send the extra header and the browser
will do the rest.

> [!TIP]
> **Tip:** Any `Critical-CH` values must be a subset of the values in `Accept-CH`. `Accept-CH` is all the values you would like for the page, `Critical-CH` is the subset of those values you **must** have to load the page properly.

For situations where you require really do require additional hints on the very
first page load, the [Client Hints Reliability
proposal](https://github.com/WICG/client-hints-infrastructure/blob/main/reliability.md#connection-level-settings)
is laying out a route to specify hints in the connection-level settings. This
makes use of the [Application-Layer Protocol
Settings(ALPS)](https://tools.ietf.org/html/draft-vvv-tls-alps) extension to TLS
1.3 to enable this early passing of hints on HTTP/2 and HTTP/3 connections. This
is still at a very early stage, but if you actively manage your own TLS and
connection settings then this is an ideal time to contribute.

### Legacy support

> [!WARNING]
> **Warning:** We have included the following solution as it completes the scope of migrating away from the User-Agent string. However, we do not recommend or support this solution. Your time is best spent performing the migration.

You may have legacy or third-party code on your site that depends on
`navigator.userAgent`, including portions of the user-agent string that will be
reduced. You should plan to move to the equivalent
`navigator.userAgentData` calls, but there is an interim solution.

[UA-CH retrofill](https://github.com/GoogleChromeLabs/uach-retrofill) is a small
library that lets you overwrite `navigator.userAgent` with a new string
built from the requested `navigator.userAgentData` values.

For example, this code generates a user-agent string that additionally
includes the "model" hint:

```javascript
import { overrideUserAgentUsingClientHints } from './uach-retrofill.js';
overrideUserAgentUsingClientHints(['model'])
  .then(() => { console.log(navigator.userAgent); });
```

The resulting string would show the `Pixel 5` model, but still shows the reduced
`92.0.0.0` as the `uaFullVersion` hint was not requested:

```text
Mozilla/5.0 (Linux; Android 10.0; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.0.0 Mobile Safari/537.36
```

## Further support

If these strategies don't address your use case, start a [Discussion in
privacy-sandbox-dev-support
repo](https://github.com/GoogleChromeLabs/privacy-sandbox-dev-support/discussions)
and we can explore your issue together.