Release 2024.12.06
[yt-dlp.git] / test / test_youtube_signature.py
blob2a99436a6d7ab7dd3dd21ad99f09c7746692b321
1 #!/usr/bin/env python3
3 # Allow direct execution
4 import os
5 import sys
6 import unittest
8 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
11 import contextlib
12 import re
13 import string
14 import urllib.request
16 from test.helper import FakeYDL, is_download_test
17 from yt_dlp.extractor import YoutubeIE
18 from yt_dlp.jsinterp import JSInterpreter
20 _SIG_TESTS = [
22 'https://s.ytimg.com/yts/jsbin/html5player-vflHOr_nV.js',
23 86,
24 '>=<;:/.-[+*)(\'&%$#"!ZYX0VUTSRQPONMLKJIHGFEDCBA\\yxwvutsrqponmlkjihgfedcba987654321',
27 'https://s.ytimg.com/yts/jsbin/html5player-vfldJ8xgI.js',
28 85,
29 '3456789a0cdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS[UVWXYZ!"#$%&\'()*+,-./:;<=>?@',
32 'https://s.ytimg.com/yts/jsbin/html5player-vfle-mVwz.js',
33 90,
34 ']\\[@?>=<;:/.-,+*)(\'&%$#"hZYXWVUTSRQPONMLKJIHGFEDCBAzyxwvutsrqponmlkjiagfedcb39876',
37 'https://s.ytimg.com/yts/jsbin/html5player-en_US-vfl0Cbn9e.js',
38 84,
39 'O1I3456789abcde0ghijklmnopqrstuvwxyzABCDEFGHfJKLMN2PQRSTUVW@YZ!"#$%&\'()*+,-./:;<=',
42 'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflXGBaUN.js',
43 '2ACFC7A61CA478CD21425E5A57EBD73DDC78E22A.2094302436B2D377D14A3BBA23022D023B8BC25AA',
44 'A52CB8B320D22032ABB3A41D773D2B6342034902.A22E87CDD37DBE75A5E52412DC874AC16A7CFCA2',
47 'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflBb0OQx.js',
48 84,
49 '123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQ0STUVWXYZ!"#$%&\'()*+,@./:;<=>',
52 'https://s.ytimg.com/yts/jsbin/html5player-en_US-vfl9FYC6l.js',
53 83,
54 '123456789abcdefghijklmnopqr0tuvwxyzABCDETGHIJKLMNOPQRS>UVWXYZ!"#$%&\'()*+,-./:;<=F',
57 'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflCGk6yw/html5player.js',
58 '4646B5181C6C3020DF1D9C7FCFEA.AD80ABF70C39BD369CCCAE780AFBB98FA6B6CB42766249D9488C288',
59 '82C8849D94266724DC6B6AF89BBFA087EACCD963.B93C07FBA084ACAEFCF7C9D1FD0203C6C1815B6B',
62 'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflKjOTVq/html5player.js',
63 '312AA52209E3623129A412D56A40F11CB0AF14AE.3EE09501CB14E3BCDC3B2AE808BF3F1D14E7FBF12',
64 '112AA5220913623229A412D56A40F11CB0AF14AE.3EE0950FCB14EEBCDC3B2AE808BF331D14E7FBF3',
67 'https://www.youtube.com/s/player/6ed0d907/player_ias.vflset/en_US/base.js',
68 '2aq0aqSyOoJXtK73m-uME_jv7-pT15gOFC02RFkGMqWpzEICs69VdbwQ0LDp1v7j8xx92efCJlYFYb1sUkkBSPOlPmXgIARw8JQ0qOAOAA',
69 'AOq0QJ8wRAIgXmPlOPSBkkUs1bYFYlJCfe29xx8j7v1pDL2QwbdV96sCIEzpWqMGkFR20CFOg51Tp-7vj_EMu-m37KtXJoOySqa0',
72 'https://www.youtube.com/s/player/3bb1f723/player_ias.vflset/en_US/base.js',
73 '2aq0aqSyOoJXtK73m-uME_jv7-pT15gOFC02RFkGMqWpzEICs69VdbwQ0LDp1v7j8xx92efCJlYFYb1sUkkBSPOlPmXgIARw8JQ0qOAOAA',
74 'MyOSJXtKI3m-uME_jv7-pT12gOFC02RFkGoqWpzE0Cs69VdbwQ0LDp1v7j8xx92efCJlYFYb1sUkkBSPOlPmXgIARw8JQ0qOAOAA',
78 _NSIG_TESTS = [
80 'https://www.youtube.com/s/player/7862ca1f/player_ias.vflset/en_US/base.js',
81 'X_LCxVDjAavgE5t', 'yxJ1dM6iz5ogUg',
84 'https://www.youtube.com/s/player/9216d1f7/player_ias.vflset/en_US/base.js',
85 'SLp9F5bwjAdhE9F-', 'gWnb9IK2DJ8Q1w',
88 'https://www.youtube.com/s/player/f8cb7a3b/player_ias.vflset/en_US/base.js',
89 'oBo2h5euWy6osrUt', 'ivXHpm7qJjJN',
92 'https://www.youtube.com/s/player/2dfe380c/player_ias.vflset/en_US/base.js',
93 'oBo2h5euWy6osrUt', '3DIBbn3qdQ',
96 'https://www.youtube.com/s/player/f1ca6900/player_ias.vflset/en_US/base.js',
97 'cu3wyu6LQn2hse', 'jvxetvmlI9AN9Q',
100 'https://www.youtube.com/s/player/8040e515/player_ias.vflset/en_US/base.js',
101 'wvOFaY-yjgDuIEg5', 'HkfBFDHmgw4rsw',
104 'https://www.youtube.com/s/player/e06dea74/player_ias.vflset/en_US/base.js',
105 'AiuodmaDDYw8d3y4bf', 'ankd8eza2T6Qmw',
108 'https://www.youtube.com/s/player/5dd88d1d/player-plasma-ias-phone-en_US.vflset/base.js',
109 'kSxKFLeqzv_ZyHSAt', 'n8gS8oRlHOxPFA',
112 'https://www.youtube.com/s/player/324f67b9/player_ias.vflset/en_US/base.js',
113 'xdftNy7dh9QGnhW', '22qLGxrmX8F1rA',
116 'https://www.youtube.com/s/player/4c3f79c5/player_ias.vflset/en_US/base.js',
117 'TDCstCG66tEAO5pR9o', 'dbxNtZ14c-yWyw',
120 'https://www.youtube.com/s/player/c81bbb4a/player_ias.vflset/en_US/base.js',
121 'gre3EcLurNY2vqp94', 'Z9DfGxWP115WTg',
124 'https://www.youtube.com/s/player/1f7d5369/player_ias.vflset/en_US/base.js',
125 'batNX7sYqIJdkJ', 'IhOkL_zxbkOZBw',
128 'https://www.youtube.com/s/player/009f1d77/player_ias.vflset/en_US/base.js',
129 '5dwFHw8aFWQUQtffRq', 'audescmLUzI3jw',
132 'https://www.youtube.com/s/player/dc0c6770/player_ias.vflset/en_US/base.js',
133 '5EHDMgYLV6HPGk_Mu-kk', 'n9lUJLHbxUI0GQ',
136 'https://www.youtube.com/s/player/113ca41c/player_ias.vflset/en_US/base.js',
137 'cgYl-tlYkhjT7A', 'hI7BBr2zUgcmMg',
140 'https://www.youtube.com/s/player/c57c113c/player_ias.vflset/en_US/base.js',
141 'M92UUMHa8PdvPd3wyM', '3hPqLJsiNZx7yA',
144 'https://www.youtube.com/s/player/5a3b6271/player_ias.vflset/en_US/base.js',
145 'B2j7f_UPT4rfje85Lu_e', 'm5DmNymaGQ5RdQ',
148 'https://www.youtube.com/s/player/7a062b77/player_ias.vflset/en_US/base.js',
149 'NRcE3y3mVtm_cV-W', 'VbsCYUATvqlt5w',
152 'https://www.youtube.com/s/player/dac945fd/player_ias.vflset/en_US/base.js',
153 'o8BkRxXhuYsBCWi6RplPdP', '3Lx32v_hmzTm6A',
156 'https://www.youtube.com/s/player/6f20102c/player_ias.vflset/en_US/base.js',
157 'lE8DhoDmKqnmJJ', 'pJTTX6XyJP2BYw',
160 'https://www.youtube.com/s/player/cfa9e7cb/player_ias.vflset/en_US/base.js',
161 'aCi3iElgd2kq0bxVbQ', 'QX1y8jGb2IbZ0w',
164 'https://www.youtube.com/s/player/8c7583ff/player_ias.vflset/en_US/base.js',
165 '1wWCVpRR96eAmMI87L', 'KSkWAVv1ZQxC3A',
168 'https://www.youtube.com/s/player/b7910ca8/player_ias.vflset/en_US/base.js',
169 '_hXMCwMt9qE310D', 'LoZMgkkofRMCZQ',
172 'https://www.youtube.com/s/player/590f65a6/player_ias.vflset/en_US/base.js',
173 '1tm7-g_A9zsI8_Lay_', 'xI4Vem4Put_rOg',
176 'https://www.youtube.com/s/player/b22ef6e7/player_ias.vflset/en_US/base.js',
177 'b6HcntHGkvBLk_FRf', 'kNPW6A7FyP2l8A',
180 'https://www.youtube.com/s/player/3400486c/player_ias.vflset/en_US/base.js',
181 'lL46g3XifCKUZn1Xfw', 'z767lhet6V2Skl',
184 'https://www.youtube.com/s/player/20dfca59/player_ias.vflset/en_US/base.js',
185 '-fLCxedkAk4LUTK2', 'O8kfRq1y1eyHGw',
188 'https://www.youtube.com/s/player/b12cc44b/player_ias.vflset/en_US/base.js',
189 'keLa5R2U00sR9SQK', 'N1OGyujjEwMnLw',
192 'https://www.youtube.com/s/player/3bb1f723/player_ias.vflset/en_US/base.js',
193 'gK15nzVyaXE9RsMP3z', 'ZFFWFLPWx9DEgQ',
198 @is_download_test
199 class TestPlayerInfo(unittest.TestCase):
200 def test_youtube_extract_player_info(self):
201 PLAYER_URLS = (
202 ('https://www.youtube.com/s/player/4c3f79c5/player_ias.vflset/en_US/base.js', '4c3f79c5'),
203 ('https://www.youtube.com/s/player/64dddad9/player_ias.vflset/en_US/base.js', '64dddad9'),
204 ('https://www.youtube.com/s/player/64dddad9/player_ias.vflset/fr_FR/base.js', '64dddad9'),
205 ('https://www.youtube.com/s/player/64dddad9/player-plasma-ias-phone-en_US.vflset/base.js', '64dddad9'),
206 ('https://www.youtube.com/s/player/64dddad9/player-plasma-ias-phone-de_DE.vflset/base.js', '64dddad9'),
207 ('https://www.youtube.com/s/player/64dddad9/player-plasma-ias-tablet-en_US.vflset/base.js', '64dddad9'),
208 # obsolete
209 ('https://www.youtube.com/yts/jsbin/player_ias-vfle4-e03/en_US/base.js', 'vfle4-e03'),
210 ('https://www.youtube.com/yts/jsbin/player_ias-vfl49f_g4/en_US/base.js', 'vfl49f_g4'),
211 ('https://www.youtube.com/yts/jsbin/player_ias-vflCPQUIL/en_US/base.js', 'vflCPQUIL'),
212 ('https://www.youtube.com/yts/jsbin/player-vflzQZbt7/en_US/base.js', 'vflzQZbt7'),
213 ('https://www.youtube.com/yts/jsbin/player-en_US-vflaxXRn1/base.js', 'vflaxXRn1'),
214 ('https://s.ytimg.com/yts/jsbin/html5player-en_US-vflXGBaUN.js', 'vflXGBaUN'),
215 ('https://s.ytimg.com/yts/jsbin/html5player-en_US-vflKjOTVq/html5player.js', 'vflKjOTVq'),
217 for player_url, expected_player_id in PLAYER_URLS:
218 player_id = YoutubeIE._extract_player_info(player_url)
219 self.assertEqual(player_id, expected_player_id)
222 @is_download_test
223 class TestSignature(unittest.TestCase):
224 def setUp(self):
225 TEST_DIR = os.path.dirname(os.path.abspath(__file__))
226 self.TESTDATA_DIR = os.path.join(TEST_DIR, 'testdata/sigs')
227 if not os.path.exists(self.TESTDATA_DIR):
228 os.mkdir(self.TESTDATA_DIR)
230 def tearDown(self):
231 with contextlib.suppress(OSError):
232 for f in os.listdir(self.TESTDATA_DIR):
233 os.remove(f)
236 def t_factory(name, sig_func, url_pattern):
237 def make_tfunc(url, sig_input, expected_sig):
238 m = url_pattern.match(url)
239 assert m, f'{url!r} should follow URL format'
240 test_id = m.group('id')
242 def test_func(self):
243 basename = f'player-{name}-{test_id}.js'
244 fn = os.path.join(self.TESTDATA_DIR, basename)
246 if not os.path.exists(fn):
247 urllib.request.urlretrieve(url, fn)
248 with open(fn, encoding='utf-8') as testf:
249 jscode = testf.read()
250 self.assertEqual(sig_func(jscode, sig_input), expected_sig)
252 test_func.__name__ = f'test_{name}_js_{test_id}'
253 setattr(TestSignature, test_func.__name__, test_func)
254 return make_tfunc
257 def signature(jscode, sig_input):
258 func = YoutubeIE(FakeYDL())._parse_sig_js(jscode)
259 src_sig = (
260 str(string.printable[:sig_input])
261 if isinstance(sig_input, int) else sig_input)
262 return func(src_sig)
265 def n_sig(jscode, sig_input):
266 ie = YoutubeIE(FakeYDL())
267 funcname = ie._extract_n_function_name(jscode)
268 jsi = JSInterpreter(jscode)
269 func = jsi.extract_function_from_code(*ie._fixup_n_function_code(*jsi.extract_function_code(funcname)))
270 return func([sig_input])
273 make_sig_test = t_factory(
274 'signature', signature, re.compile(r'.*(?:-|/player/)(?P<id>[a-zA-Z0-9_-]+)(?:/.+\.js|(?:/watch_as3|/html5player)?\.[a-z]+)$'))
275 for test_spec in _SIG_TESTS:
276 make_sig_test(*test_spec)
278 make_nsig_test = t_factory(
279 'nsig', n_sig, re.compile(r'.+/player/(?P<id>[a-zA-Z0-9_-]+)/.+.js$'))
280 for test_spec in _NSIG_TESTS:
281 make_nsig_test(*test_spec)
284 if __name__ == '__main__':
285 unittest.main()