test/test_cookies.py

   1 import datetime as dt
   2 import unittest
   3
   4 from yt_dlp import cookies
   5 from yt_dlp.cookies import (
   6     LenientSimpleCookie,
   7     LinuxChromeCookieDecryptor,
   8     MacChromeCookieDecryptor,
   9     WindowsChromeCookieDecryptor,
  10     _get_linux_desktop_environment,
  11     _LinuxDesktopEnvironment,
  12     parse_safari_cookies,
  13     pbkdf2_sha1,
  14 )
  15
  16
  17 class Logger:
  18     def debug(self, message, *args, **kwargs):
  19         print(f'[verbose] {message}')
  20
  21     def info(self, message, *args, **kwargs):
  22         print(message)
  23
  24     def warning(self, message, *args, **kwargs):
  25         self.error(message)
  26
  27     def error(self, message, *args, **kwargs):
  28         raise Exception(message)
  29
  30
  31 class MonkeyPatch:
  32     def __init__(self, module, temporary_values):
  33         self._module = module
  34         self._temporary_values = temporary_values
  35         self._backup_values = {}
  36
  37     def __enter__(self):
  38         for name, temp_value in self._temporary_values.items():
  39             self._backup_values[name] = getattr(self._module, name)
  40             setattr(self._module, name, temp_value)
  41
  42     def __exit__(self, exc_type, exc_val, exc_tb):
  43         for name, backup_value in self._backup_values.items():
  44             setattr(self._module, name, backup_value)
  45
  46
  47 class TestCookies(unittest.TestCase):
  48     def test_get_desktop_environment(self):
  49         """ based on https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util_unittest.cc """
  50         test_cases = [
  51             ({}, _LinuxDesktopEnvironment.OTHER),
  52             ({'DESKTOP_SESSION': 'my_custom_de'}, _LinuxDesktopEnvironment.OTHER),
  53             ({'XDG_CURRENT_DESKTOP': 'my_custom_de'}, _LinuxDesktopEnvironment.OTHER),
  54
  55             ({'DESKTOP_SESSION': 'gnome'}, _LinuxDesktopEnvironment.GNOME),
  56             ({'DESKTOP_SESSION': 'mate'}, _LinuxDesktopEnvironment.GNOME),
  57             ({'DESKTOP_SESSION': 'kde4'}, _LinuxDesktopEnvironment.KDE4),
  58             ({'DESKTOP_SESSION': 'kde'}, _LinuxDesktopEnvironment.KDE3),
  59             ({'DESKTOP_SESSION': 'xfce'}, _LinuxDesktopEnvironment.XFCE),
  60
  61             ({'GNOME_DESKTOP_SESSION_ID': 1}, _LinuxDesktopEnvironment.GNOME),
  62             ({'KDE_FULL_SESSION': 1}, _LinuxDesktopEnvironment.KDE3),
  63             ({'KDE_FULL_SESSION': 1, 'DESKTOP_SESSION': 'kde4'}, _LinuxDesktopEnvironment.KDE4),
  64
  65             ({'XDG_CURRENT_DESKTOP': 'X-Cinnamon'}, _LinuxDesktopEnvironment.CINNAMON),
  66             ({'XDG_CURRENT_DESKTOP': 'Deepin'}, _LinuxDesktopEnvironment.DEEPIN),
  67             ({'XDG_CURRENT_DESKTOP': 'GNOME'}, _LinuxDesktopEnvironment.GNOME),
  68             ({'XDG_CURRENT_DESKTOP': 'GNOME:GNOME-Classic'}, _LinuxDesktopEnvironment.GNOME),
  69             ({'XDG_CURRENT_DESKTOP': 'GNOME : GNOME-Classic'}, _LinuxDesktopEnvironment.GNOME),
  70             ({'XDG_CURRENT_DESKTOP': 'ubuntu:GNOME'}, _LinuxDesktopEnvironment.GNOME),
  71
  72             ({'XDG_CURRENT_DESKTOP': 'Unity', 'DESKTOP_SESSION': 'gnome-fallback'}, _LinuxDesktopEnvironment.GNOME),
  73             ({'XDG_CURRENT_DESKTOP': 'KDE', 'KDE_SESSION_VERSION': '5'}, _LinuxDesktopEnvironment.KDE5),
  74             ({'XDG_CURRENT_DESKTOP': 'KDE', 'KDE_SESSION_VERSION': '6'}, _LinuxDesktopEnvironment.KDE6),
  75             ({'XDG_CURRENT_DESKTOP': 'KDE'}, _LinuxDesktopEnvironment.KDE4),
  76             ({'XDG_CURRENT_DESKTOP': 'Pantheon'}, _LinuxDesktopEnvironment.PANTHEON),
  77             ({'XDG_CURRENT_DESKTOP': 'UKUI'}, _LinuxDesktopEnvironment.UKUI),
  78             ({'XDG_CURRENT_DESKTOP': 'Unity'}, _LinuxDesktopEnvironment.UNITY),
  79             ({'XDG_CURRENT_DESKTOP': 'Unity:Unity7'}, _LinuxDesktopEnvironment.UNITY),
  80             ({'XDG_CURRENT_DESKTOP': 'Unity:Unity8'}, _LinuxDesktopEnvironment.UNITY),
  81         ]
  82
  83         for env, expected_desktop_environment in test_cases:
  84             self.assertEqual(_get_linux_desktop_environment(env, Logger()), expected_desktop_environment)
  85
  86     def test_chrome_cookie_decryptor_linux_derive_key(self):
  87         key = LinuxChromeCookieDecryptor.derive_key(b'abc')
  88         self.assertEqual(key, b'7\xa1\xec\xd4m\xfcA\xc7\xb19Z\xd0\x19\xdcM\x17')
  89
  90     def test_chrome_cookie_decryptor_mac_derive_key(self):
  91         key = MacChromeCookieDecryptor.derive_key(b'abc')
  92         self.assertEqual(key, b'Y\xe2\xc0\xd0P\xf6\xf4\xe1l\xc1\x8cQ\xcb|\xcdY')
  93
  94     def test_chrome_cookie_decryptor_linux_v10(self):
  95         with MonkeyPatch(cookies, {'_get_linux_keyring_password': lambda *args, **kwargs: b''}):
  96             encrypted_value = b'v10\xccW%\xcd\xe6\xe6\x9fM" \xa7\xb0\xca\xe4\x07\xd6'
  97             value = 'USD'
  98             decryptor = LinuxChromeCookieDecryptor('Chrome', Logger())
  99             self.assertEqual(decryptor.decrypt(encrypted_value), value)
 100
 101     def test_chrome_cookie_decryptor_linux_v11(self):
 102         with MonkeyPatch(cookies, {'_get_linux_keyring_password': lambda *args, **kwargs: b''}):
 103             encrypted_value = b'v11#\x81\x10>`w\x8f)\xc0\xb2\xc1\r\xf4\x1al\xdd\x93\xfd\xf8\xf8N\xf2\xa9\x83\xf1\xe9o\x0elVQd'
 104             value = 'tz=Europe.London'
 105             decryptor = LinuxChromeCookieDecryptor('Chrome', Logger())
 106             self.assertEqual(decryptor.decrypt(encrypted_value), value)
 107
 108     def test_chrome_cookie_decryptor_windows_v10(self):
 109         with MonkeyPatch(cookies, {
 110             '_get_windows_v10_key': lambda *args, **kwargs: b'Y\xef\xad\xad\xeerp\xf0Y\xe6\x9b\x12\xc2<z\x16]\n\xbb\xb8\xcb\xd7\x9bA\xc3\x14e\x99{\xd6\xf4&',
 111         }):
 112             encrypted_value = b'v10T\xb8\xf3\xb8\x01\xa7TtcV\xfc\x88\xb8\xb8\xef\x05\xb5\xfd\x18\xc90\x009\xab\xb1\x893\x85)\x87\xe1\xa9-\xa3\xad='
 113             value = '32101439'
 114             decryptor = WindowsChromeCookieDecryptor('', Logger())
 115             self.assertEqual(decryptor.decrypt(encrypted_value), value)
 116
 117     def test_chrome_cookie_decryptor_mac_v10(self):
 118         with MonkeyPatch(cookies, {'_get_mac_keyring_password': lambda *args, **kwargs: b'6eIDUdtKAacvlHwBVwvg/Q=='}):
 119             encrypted_value = b'v10\xb3\xbe\xad\xa1[\x9fC\xa1\x98\xe0\x9a\x01\xd9\xcf\xbfc'
 120             value = '2021-06-01-22'
 121             decryptor = MacChromeCookieDecryptor('', Logger())
 122             self.assertEqual(decryptor.decrypt(encrypted_value), value)
 123
 124     def test_safari_cookie_parsing(self):
 125         cookies = (
 126             b'cook\x00\x00\x00\x01\x00\x00\x00i\x00\x00\x01\x00\x01\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00Y'
 127             b'\x00\x00\x00\x00\x00\x00\x00 \x00\x00\x00\x00\x00\x00\x008\x00\x00\x00B\x00\x00\x00F\x00\x00\x00H'
 128             b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x03\xa5>\xc3A\x00\x00\x80\xc3\x07:\xc3A'
 129             b'localhost\x00foo\x00/\x00test%20%3Bcookie\x00\x00\x00\x054\x07\x17 \x05\x00\x00\x00Kbplist00\xd1\x01'
 130             b'\x02_\x10\x18NSHTTPCookieAcceptPolicy\x10\x02\x08\x0b&\x00\x00\x00\x00\x00\x00\x01\x01\x00\x00\x00'
 131             b'\x00\x00\x00\x00\x03\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00(')
 132
 133         jar = parse_safari_cookies(cookies)
 134         self.assertEqual(len(jar), 1)
 135         cookie = next(iter(jar))
 136         self.assertEqual(cookie.domain, 'localhost')
 137         self.assertEqual(cookie.port, None)
 138         self.assertEqual(cookie.path, '/')
 139         self.assertEqual(cookie.name, 'foo')
 140         self.assertEqual(cookie.value, 'test%20%3Bcookie')
 141         self.assertFalse(cookie.secure)
 142         expected_expiration = dt.datetime(2021, 6, 18, 21, 39, 19, tzinfo=dt.timezone.utc)
 143         self.assertEqual(cookie.expires, int(expected_expiration.timestamp()))
 144
 145     def test_pbkdf2_sha1(self):
 146         key = pbkdf2_sha1(b'peanuts', b' ' * 16, 1, 16)
 147         self.assertEqual(key, b'g\xe1\x8e\x0fQ\x1c\x9b\xf3\xc9`!\xaa\x90\xd9\xd34')
 148
 149
 150 class TestLenientSimpleCookie(unittest.TestCase):
 151     def _run_tests(self, *cases):
 152         for message, raw_cookie, expected in cases:
 153             cookie = LenientSimpleCookie(raw_cookie)
 154
 155             with self.subTest(message, expected=expected):
 156                 self.assertEqual(cookie.keys(), expected.keys(), message)
 157
 158                 for key, expected_value in expected.items():
 159                     morsel = cookie[key]
 160                     if isinstance(expected_value, tuple):
 161                         expected_value, expected_attributes = expected_value
 162                     else:
 163                         expected_attributes = {}
 164
 165                     attributes = {
 166                         key: value
 167                         for key, value in dict(morsel).items()
 168                         if value != ''
 169                     }
 170                     self.assertEqual(attributes, expected_attributes, message)
 171
 172                     self.assertEqual(morsel.value, expected_value, message)
 173
 174     def test_parsing(self):
 175         self._run_tests(
 176             # Copied from https://github.com/python/cpython/blob/v3.10.7/Lib/test/test_http_cookies.py
 177             (
 178                 'Test basic cookie',
 179                 'chips=ahoy; vienna=finger',
 180                 {'chips': 'ahoy', 'vienna': 'finger'},
 181             ),
 182             (
 183                 'Test quoted cookie',
 184                 'keebler="E=mc2; L=\\"Loves\\"; fudge=\\012;"',
 185                 {'keebler': 'E=mc2; L="Loves"; fudge=\012;'},
 186             ),
 187             (
 188                 "Allow '=' in an unquoted value",
 189                 'keebler=E=mc2',
 190                 {'keebler': 'E=mc2'},
 191             ),
 192             (
 193                 "Allow cookies with ':' in their name",
 194                 'key:term=value:term',
 195                 {'key:term': 'value:term'},
 196             ),
 197             (
 198                 "Allow '[' and ']' in cookie values",
 199                 'a=b; c=[; d=r; f=h',
 200                 {'a': 'b', 'c': '[', 'd': 'r', 'f': 'h'},
 201             ),
 202             (
 203                 'Test basic cookie attributes',
 204                 'Customer="WILE_E_COYOTE"; Version=1; Path=/acme',
 205                 {'Customer': ('WILE_E_COYOTE', {'version': '1', 'path': '/acme'})},
 206             ),
 207             (
 208                 'Test flag only cookie attributes',
 209                 'Customer="WILE_E_COYOTE"; HttpOnly; Secure',
 210                 {'Customer': ('WILE_E_COYOTE', {'httponly': True, 'secure': True})},
 211             ),
 212             (
 213                 'Test flag only attribute with values',
 214                 'eggs=scrambled; httponly=foo; secure=bar; Path=/bacon',
 215                 {'eggs': ('scrambled', {'httponly': 'foo', 'secure': 'bar', 'path': '/bacon'})},
 216             ),
 217             (
 218                 "Test special case for 'expires' attribute, 4 digit year",
 219                 'Customer="W"; expires=Wed, 01 Jan 2010 00:00:00 GMT',
 220                 {'Customer': ('W', {'expires': 'Wed, 01 Jan 2010 00:00:00 GMT'})},
 221             ),
 222             (
 223                 "Test special case for 'expires' attribute, 2 digit year",
 224                 'Customer="W"; expires=Wed, 01 Jan 98 00:00:00 GMT',
 225                 {'Customer': ('W', {'expires': 'Wed, 01 Jan 98 00:00:00 GMT'})},
 226             ),
 227             (
 228                 'Test extra spaces in keys and values',
 229                 'eggs  =  scrambled  ;  secure  ;  path  =  bar   ; foo=foo   ',
 230                 {'eggs': ('scrambled', {'secure': True, 'path': 'bar'}), 'foo': 'foo'},
 231             ),
 232             (
 233                 'Test quoted attributes',
 234                 'Customer="WILE_E_COYOTE"; Version="1"; Path="/acme"',
 235                 {'Customer': ('WILE_E_COYOTE', {'version': '1', 'path': '/acme'})},
 236             ),
 237             # Our own tests that CPython passes
 238             (
 239                 "Allow ';' in quoted value",
 240                 'chips="a;hoy"; vienna=finger',
 241                 {'chips': 'a;hoy', 'vienna': 'finger'},
 242             ),
 243             (
 244                 'Keep only the last set value',
 245                 'a=c; a=b',
 246                 {'a': 'b'},
 247             ),
 248         )
 249
 250     def test_lenient_parsing(self):
 251         self._run_tests(
 252             (
 253                 'Ignore and try to skip invalid cookies',
 254                 'chips={"ahoy;": 1}; vienna="finger;"',
 255                 {'vienna': 'finger;'},
 256             ),
 257             (
 258                 'Ignore cookies without a name',
 259                 'a=b; unnamed; c=d',
 260                 {'a': 'b', 'c': 'd'},
 261             ),
 262             (
 263                 "Ignore '\"' cookie without name",
 264                 'a=b; "; c=d',
 265                 {'a': 'b', 'c': 'd'},
 266             ),
 267             (
 268                 'Skip all space separated values',
 269                 'x a=b c=d x; e=f',
 270                 {'a': 'b', 'c': 'd', 'e': 'f'},
 271             ),
 272             (
 273                 'Skip all space separated values',
 274                 'x a=b; data={"complex": "json", "with": "key=value"}; x c=d x',
 275                 {'a': 'b', 'c': 'd'},
 276             ),
 277             (
 278                 'Expect quote mending',
 279                 'a=b; invalid="; c=d',
 280                 {'a': 'b', 'c': 'd'},
 281             ),
 282             (
 283                 'Reset morsel after invalid to not capture attributes',
 284                 'a=b; invalid; Version=1; c=d',
 285                 {'a': 'b', 'c': 'd'},
 286             ),
 287             (
 288                 'Reset morsel after invalid to not capture attributes',
 289                 'a=b; $invalid; $Version=1; c=d',
 290                 {'a': 'b', 'c': 'd'},
 291             ),
 292             (
 293                 'Continue after non-flag attribute without value',
 294                 'a=b; path; Version=1; c=d',
 295                 {'a': 'b', 'c': 'd'},
 296             ),
 297             (
 298                 'Allow cookie attributes with `$` prefix',
 299                 'Customer="WILE_E_COYOTE"; $Version=1; $Secure; $Path=/acme',
 300                 {'Customer': ('WILE_E_COYOTE', {'version': '1', 'secure': True, 'path': '/acme'})},
 301             ),
 302             (
 303                 'Invalid Morsel keys should not result in an error',
 304                 'Key=Value; [Invalid]=Value; Another=Value',
 305                 {'Key': 'Value', 'Another': 'Value'},
 306             ),
 307         )