├── .gitattributes ├── .gitignore ├── LICENSE ├── README.md ├── binlog ├── __init__.py ├── binlog.py ├── binlog_event.py ├── binlog_key_value.py ├── events │ ├── __init__.py │ └── aes_ctr_encryption.py ├── exceptions.py ├── handler.py ├── models │ ├── __init__.py │ └── auth_key.py └── tl_parser.py ├── main.py └── pyproject.toml /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | .idea/ 161 | 162 | # Mac 163 | .DS_Store -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # td.binlog-reader 2 | Any [TDLib](https://github.com/tdlib/td) application stores its cache data inside the **td.binlog** file. All data is stored as a **dictionary**, with keys and values. It contains: datacenters' info, auth keys, locales etc. This utility will help you to decode **td.binlog** file and use its map. 3 | 4 | ## Setup 5 | 6 | Install the tgcrypto cryptographic library to use aes256 encryption function 7 | ``` 8 | $ pip install tgcrypto 9 | ``` 10 | 11 | ## Usage 12 | 13 | 1. Run main.py file using python to test a script. 14 | 2. Modify program logic the way it fits your needs (extracting values of different keys, parsing them, etc.). 15 | -------------------------------------------------------------------------------- /binlog/__init__.py: -------------------------------------------------------------------------------- 1 | import os 2 | from typing import BinaryIO, Optional 3 | 4 | from binlog.binlog import Binlog 5 | 6 | 7 | def read(tdbinlog_file: str | os.PathLike | BinaryIO, password: Optional[str] = None) -> Binlog: 8 | if isinstance(tdbinlog_file, (str, os.PathLike)): 9 | with open(tdbinlog_file, 'rb') as file: 10 | buffer = file.read() 11 | else: 12 | buffer = tdbinlog_file.read() 13 | 14 | binlog = Binlog(buffer, password) 15 | while True: 16 | try: 17 | event = binlog.read_next_event() 18 | except BufferError: # occurs when no more bytes left to read 19 | break 20 | event.validate() 21 | 22 | binlog.process_event(event) 23 | 24 | return binlog 25 | -------------------------------------------------------------------------------- /binlog/binlog.py: -------------------------------------------------------------------------------- 1 | from typing import Optional 2 | 3 | from tgcrypto import ctr256_encrypt 4 | 5 | from binlog.binlog_event import BinlogEvent 6 | from binlog.binlog_key_value import BinlogKeyValue 7 | from binlog.events import AesCtrEncryptionEvent 8 | from binlog.exceptions import InvalidPassword, BinlogEventSizeInvalid 9 | from binlog.handler import HandlerType 10 | from binlog.tl_parser import TlParser 11 | 12 | # https://github.com/tdlib/td/blob/97ded01095246a3a693bc85bef4bca5d1af177dd/td/telegram/Td.cpp#L2770 13 | DEFAULT_DB_KEY = "cucumber" 14 | 15 | 16 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/Binlog.cpp#L95 17 | class Binlog: 18 | def __init__(self, buffer: bytes | bytearray, password: Optional[str] = None) -> None: 19 | self._parser = TlParser(buffer) 20 | self._password = password or DEFAULT_DB_KEY 21 | self.map = BinlogKeyValue() 22 | 23 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/Binlog.cpp#L112 24 | def read_next_event(self) -> BinlogEvent: 25 | size = self._parser.read_int() 26 | self._parser.seek(-4) # go back 27 | 28 | if size > BinlogEvent.MAX_SIZE: 29 | raise BinlogEventSizeInvalid(f'Event is too big: {size}') 30 | elif size < BinlogEvent.MIN_SIZE: 31 | raise BinlogEventSizeInvalid(f'Event is too small: {size}') 32 | elif size % 4 != 0: 33 | raise BinlogEventSizeInvalid(f'Event size is not expected: {size}') 34 | 35 | return BinlogEvent.parse(TlParser(self._parser.read(size))) 36 | 37 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/Binlog.cpp#L326 38 | def process_event(self, event: BinlogEvent) -> None: 39 | if event.type == BinlogEvent.ServiceTypes.AesCtrEncryption.value: 40 | aes_encryption_event = AesCtrEncryptionEvent.parse(TlParser(event.event_data)) 41 | secret_key = aes_encryption_event.generate_key(self._password) 42 | 43 | if aes_encryption_event.generate_hash(secret_key) != aes_encryption_event.key_hash: 44 | raise InvalidPassword(f"Password is invalid. " 45 | f"Generated hash={aes_encryption_event.generate_hash(secret_key)}, " 46 | f"real hash={aes_encryption_event.key_hash}") 47 | 48 | data = self._parser.read() 49 | # https://github.com/tdlib/td/blob/81dc2e242b6c3ea358dba6b5a750727c378dc098/tddb/td/db/binlog/Binlog.cpp#L472 50 | decrypted_buffer = ctr256_encrypt(data, secret_key, aes_encryption_event.iv, bytes(1)) 51 | 52 | # https://github.com/tdlib/td/blob/81dc2e242b6c3ea358dba6b5a750727c378dc098/tddb/td/db/binlog/Binlog.cpp#L478 53 | self._parser = TlParser(decrypted_buffer) 54 | 55 | # we only process these events 56 | # https://github.com/tdlib/td/blob/81dc2e242b6c3ea358dba6b5a750727c378dc098/td/telegram/TdDb.cpp#L161 57 | # https://github.com/tdlib/td/blob/81dc2e242b6c3ea358dba6b5a750727c378dc098/td/telegram/TdDb.cpp#L164 58 | # also see binlog dump script: 59 | # https://github.com/tdlib/td/blob/81dc2e242b6c3ea358dba6b5a750727c378dc098/tddb/td/db/binlog/binlog_dump.cpp#L127 60 | elif event.type in [HandlerType.ConfigPmcMagic.value, HandlerType.BinlogPmcMagic.value]: 61 | storage_event = BinlogKeyValue.StorageEvent.parse(TlParser(event.event_data)) 62 | 63 | self.map[storage_event.key] = storage_event.value 64 | -------------------------------------------------------------------------------- /binlog/binlog_event.py: -------------------------------------------------------------------------------- 1 | import zlib 2 | from enum import IntEnum 3 | from typing import Self 4 | 5 | from binlog.exceptions import BinlogEventSizeInvalid, BinlogEventCrc32HashInvalid 6 | from binlog.tl_parser import TlParser 7 | 8 | 9 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/BinlogEvent.h#L50 10 | class BinlogEvent: 11 | MAX_SIZE = 1 << 24 12 | HEADER_SIZE = 4 + 8 + 4 + 4 + 8 13 | TAIL_SIZE = 4 14 | MIN_SIZE = HEADER_SIZE + TAIL_SIZE 15 | 16 | class ServiceTypes(IntEnum): 17 | Header = -1 18 | Empty = -2 19 | AesCtrEncryption = -3 20 | NoEncryption = -4 # is not used at all 21 | 22 | def __init__(self, raw_event: bytes, 23 | event_data: bytes, 24 | size: int, id_: int, type_: int, flags: int, extra: int, crc32: int) -> None: 25 | self.raw_event = raw_event 26 | self.event_data = event_data 27 | self.size = size 28 | self.id = id_ 29 | self.type = type_ 30 | self.flags = flags 31 | self.extra = extra 32 | self.crc32 = crc32 33 | 34 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/BinlogEvent.cpp#L17 35 | @classmethod 36 | def parse(cls, parser: TlParser) -> Self: 37 | size = parser.read_int(False) # cast into uint32: 4 bytes 38 | id_ = parser.read_long(False) # cast into uint64: 8 bytes 39 | type_ = parser.read_int(True) # no cast: 4 bytes 40 | flags = parser.read_int(True) # no cast: 4 bytes 41 | extra = parser.read_long(False) # cast into uint64: 8 bytes 42 | 43 | # in original code it says "skip data". this was implemented, so inside method `get_data` 44 | # this content aka event_data would be read and returned. but we do it already in place 45 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/BinlogEvent.cpp#L26 46 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/BinlogEvent.cpp#L33 47 | # HEADER_SIZE = sum bytes of: size + id_ + type_ + flags + extra 48 | event_data = parser.read(size - cls.MIN_SIZE) 49 | 50 | crc32 = parser.read_int(False) # cast into uint32: 4 bytes 51 | 52 | return cls(parser.get_value(), event_data, size, id_, type_, flags, extra, crc32) 53 | 54 | def validate(self) -> None: 55 | if len(self.raw_event) < self.MIN_SIZE: 56 | raise BinlogEventSizeInvalid(f'Event is too small: {len(self.raw_event)}') 57 | 58 | expected_binlog_event = BinlogEvent.parse(TlParser(self.raw_event)) 59 | if self.size != expected_binlog_event.size or self.size != len(self.raw_event): 60 | raise BinlogEventSizeInvalid(f'Size of event changed: was={self.size}, now={expected_binlog_event.size}, ' 61 | f'real_size={len(self.raw_event)}') 62 | 63 | data = self.raw_event[:-self.TAIL_SIZE] 64 | calculated_crc = zlib.crc32(data) 65 | stored_crc = expected_binlog_event.crc32 66 | 67 | if calculated_crc != self.crc32 or calculated_crc != stored_crc: 68 | raise BinlogEventCrc32HashInvalid(f'CRC32 hash mismatch: actual={calculated_crc}, expected={self.crc32}') 69 | -------------------------------------------------------------------------------- /binlog/binlog_key_value.py: -------------------------------------------------------------------------------- 1 | from typing import Self 2 | 3 | from binlog.tl_parser import TlParser 4 | 5 | 6 | # https://github.com/tdlib/td/blob/97ded01095246a3a693bc85bef4bca5d1af177dd/tddb/td/db/BinlogKeyValue.h#L37 7 | class BinlogKeyValue(dict): 8 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/BinlogKeyValue.h#L41 9 | class StorageEvent: 10 | def __init__(self, key: str, value: bytes) -> None: 11 | self.key = key 12 | self.value = value 13 | 14 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/BinlogKeyValue.h#L54 15 | @classmethod 16 | def parse(cls, parser: TlParser) -> Self: 17 | key = parser.read_string() 18 | value = parser.read_bytes() # read_bytes() instead of read_string() 19 | return cls(key, value) 20 | -------------------------------------------------------------------------------- /binlog/events/__init__.py: -------------------------------------------------------------------------------- 1 | from binlog.events.aes_ctr_encryption import AesCtrEncryptionEvent 2 | -------------------------------------------------------------------------------- /binlog/events/aes_ctr_encryption.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import hmac 3 | from hashlib import pbkdf2_hmac 4 | from typing import Self 5 | 6 | from binlog.tl_parser import TlParser 7 | 8 | 9 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/Binlog.cpp#L31 10 | class AesCtrEncryptionEvent: 11 | MIN_SALT_SIZE = 16 # it isn't used 12 | DEFAULT_SALT_SIZE = 32 # it isn't used 13 | KEY_SIZE = 32 14 | IV_SIZE = 16 # it isn't used 15 | HASH_SIZE = 32 # it isn't used 16 | KDF_ITERATION_COUNT = 60002 # it isn't used 17 | KDF_FAST_ITERATION_COUNT = 2 18 | 19 | def __init__(self, key_salt: bytes, iv: bytes, key_hash: bytes) -> None: 20 | self.key_salt = key_salt 21 | self.iv = iv 22 | self.key_hash = key_hash 23 | 24 | def generate_key(self, db_key: str) -> bytes: 25 | # we use KDF_FAST_ITERATION_COUNT, because we will only use raw_key 26 | # see: https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/Binlog.cpp#L62 27 | return pbkdf2_hmac( 28 | 'sha256', db_key.encode(), self.key_salt, self.KDF_FAST_ITERATION_COUNT, 29 | dklen=self.KEY_SIZE 30 | ) 31 | 32 | @staticmethod 33 | def generate_hash(key) -> bytes: 34 | return hmac.new(key, b'cucumbers everywhere', hashlib.sha256).digest() 35 | 36 | @classmethod 37 | def parse(cls, parser: TlParser) -> Self: 38 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/tddb/td/db/binlog/Binlog.cpp#L87 39 | parser.seek(4) # BEGIN_PARSE_FLAGS function consumes 4 bytes, because of read_int() 40 | 41 | key_salt = parser.read_bytes() # KEY_SIZE = 32 42 | iv = parser.read_bytes() # IV_SIZE = 16 43 | key_hash = parser.read_bytes() # HASH_SIZE = 16 44 | 45 | return cls(key_salt, iv, key_hash) 46 | -------------------------------------------------------------------------------- /binlog/exceptions.py: -------------------------------------------------------------------------------- 1 | class BinlogException(Exception): 2 | def __init__(self, message: str) -> None: 3 | self.message = message 4 | 5 | 6 | class InvalidPassword(BinlogException): 7 | """Invalid password when trying to encrypt (kinda decrypt) binlog""" 8 | 9 | 10 | class BinlogEventInvalid(BinlogException): 11 | """Binlog event is invalid""" 12 | 13 | 14 | class BinlogEventSizeInvalid(BinlogEventInvalid): 15 | """Binlog event size invalid""" 16 | 17 | 18 | class BinlogEventCrc32HashInvalid(BinlogEventInvalid): 19 | """Binlog crc32 hash invalid""" 20 | -------------------------------------------------------------------------------- /binlog/handler.py: -------------------------------------------------------------------------------- 1 | from enum import IntEnum 2 | 3 | 4 | # https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/td/telegram/logevent/LogEvent.h#L64 5 | class HandlerType(IntEnum): 6 | SecretChats = 1, # 1, it isn't used 7 | Users = 2, # 2, it isn't used 8 | Chats = 3, # 3, it isn't used 9 | Channels = 4, # 4, it isn't used 10 | SecretChatInfos = 5, # 5, it isn't used 11 | WebPages = 0x10, # 16, it isn't used 12 | SetPollAnswer = 0x20, # 32, it isn't used 13 | StopPoll = 0x21, # 33, it isn't used 14 | SendMessage = 0x100, # 256, it isn't used 15 | DeleteMessage = 0x101, # 257, it isn't used 16 | DeleteMessagesOnServer = 0x102, # 258, it isn't used 17 | ReadHistoryOnServer = 0x103, # 259, it isn't used 18 | ForwardMessages = 0x104, # 260, it isn't used 19 | ReadMessageContentsOnServer = 0x105, # 261, it isn't used 20 | SendBotStartMessage = 0x106, # 262, it isn't used 21 | SendScreenshotTakenNotificationMessage = 0x107, # 263, it isn't used 22 | SendInlineQueryResultMessage = 0x108, # 264, it isn't used 23 | DeleteDialogHistoryOnServer = 0x109, # 265, it isn't used 24 | ReadAllDialogMentionsOnServer = 0x10a, # 266, it isn't used 25 | DeleteAllChannelMessagesFromSenderOnServer = 0x10b, # 267, it isn't used 26 | ToggleDialogIsPinnedOnServer = 0x10c, # 268, it isn't used 27 | ReorderPinnedDialogsOnServer = 0x10d, # 269, it isn't used 28 | SaveDialogDraftMessageOnServer = 0x10e, # 270, it isn't used 29 | UpdateDialogNotificationSettingsOnServer = 0x10f, # 271, it isn't used 30 | UpdateScopeNotificationSettingsOnServer = 0x110, # 272, it isn't used 31 | ResetAllNotificationSettingsOnServer = 0x111, # 273, it isn't used 32 | ToggleDialogReportSpamStateOnServer = 0x112, # 274, it isn't used 33 | RegetDialog = 0x113, # 275, it isn't used 34 | ReadHistoryInSecretChat = 0x114, # 276, it isn't used 35 | ToggleDialogIsMarkedAsUnreadOnServer = 0x115, # 277, it isn't used 36 | SetDialogFolderIdOnServer = 0x116, # 278, it isn't used 37 | DeleteScheduledMessagesOnServer = 0x117, # 279, it isn't used 38 | ToggleDialogIsBlockedOnServer = 0x118, # 280, it isn't used 39 | ReadMessageThreadHistoryOnServer = 0x119, # 281, it isn't used 40 | BlockMessageSenderFromRepliesOnServer = 0x120, # 288, it isn't used 41 | UnpinAllDialogMessagesOnServer = 0x121, # 289, it isn't used 42 | DeleteAllCallMessagesOnServer = 0x122, # 290, it isn't used 43 | DeleteDialogMessagesByDateOnServer = 0x123, # 291, it isn't used 44 | ReadAllDialogReactionsOnServer = 0x124, # 292, it isn't used 45 | DeleteTopicHistoryOnServer = 0x125, # 293, it isn't used 46 | ToggleDialogIsTranslatableOnServer = 0x126, # 294, it isn't used 47 | ToggleDialogViewAsMessagesOnServer = 0x127, # 295, it isn't used 48 | SendQuickReplyShortcutMessages = 0x128, # 296, it isn't used 49 | UpdateReactionNotificationSettingsOnServer = 0x129, # 297, it isn't used 50 | GetChannelDifference = 0x140, # 320, it isn't used 51 | AddMessagePushNotification = 0x200, # 512, it isn't used 52 | EditMessagePushNotification = 0x201, # 513, it isn't used 53 | SaveAppLog = 0x300, # 768, it isn't used 54 | DeleteStoryOnServer = 0x400, # 1024, it isn't used 55 | ReadStoriesOnServer = 0x401, # 1025, it isn't used 56 | LoadDialogExpiringStories = 0x402, # 1026, it isn't used 57 | SendStory = 0x403, # 1027, it isn't used 58 | EditStory = 0x404, # 1028, it isn't used 59 | ChangeAuthorizationSettingsOnServer = 0x500, # 1280, it isn't used 60 | ResetAuthorizationOnServer = 0x501, # 1281, it isn't used 61 | ResetAuthorizationsOnServer = 0x502, # 1282, it isn't used 62 | SetDefaultHistoryTtlOnServer = 0x503, # 1283, it isn't used 63 | SetAccountTtlOnServer = 0x504, # 1284, it isn't used 64 | SetAuthorizationTtlOnServer = 0x505, # 1285, it isn't used 65 | ResetWebAuthorizationOnServer = 0x506, # 1286, it isn't used 66 | ResetWebAuthorizationsOnServer = 0x507, # 1287, it isn't used 67 | InvalidateSignInCodesOnServer = 0x508, # 1288, it isn't used 68 | ConfigPmcMagic = 0x1f18, # 7960 69 | BinlogPmcMagic = 0x4327 # 17191 70 | -------------------------------------------------------------------------------- /binlog/models/__init__.py: -------------------------------------------------------------------------------- 1 | from binlog.models.auth_key import AuthKey 2 | -------------------------------------------------------------------------------- /binlog/models/auth_key.py: -------------------------------------------------------------------------------- 1 | import time 2 | from typing import Self 3 | 4 | from binlog.tl_parser import TlParser 5 | 6 | 7 | # https://github.com/tdlib/td/blob/d7203eb719304866a7eb7033ef03d421459335b8/td/mtproto/AuthKey.h#L126 8 | class AuthKey: 9 | AUTH_FLAG = 1 10 | HAS_CREATED_AT = 4 11 | HAS_EXPIRES_AT = 8 12 | 13 | def __init__(self, auth_key: bytes, 14 | auth_key_id: int = 0, 15 | auth_flag: bool = False, have_header: bool = True, header_expires_at: int = 0, 16 | expires_at: int = 0, created_at: int = 0) -> None: 17 | self.auth_key = auth_key 18 | 19 | self.auth_key_id = auth_key_id 20 | self.auth_flag = auth_flag 21 | self.have_header = have_header 22 | self.header_expires_at = header_expires_at 23 | 24 | self.expires_at = expires_at 25 | self.created_at = created_at 26 | 27 | # https://github.com/tdlib/td/blob/d7203eb719304866a7eb7033ef03d421459335b8/td/mtproto/AuthKey.h#L104 28 | @classmethod 29 | def parse(cls, parser: TlParser) -> Self: 30 | auth_key_id = parser.read_long(signed=False) 31 | flags = parser.read_int() 32 | auth_flag = bool(flags & cls.AUTH_FLAG) 33 | auth_key = parser.read_bytes() 34 | 35 | created_at = 0 36 | if flags & cls.HAS_CREATED_AT: 37 | created_at = int(parser.read_double()) 38 | 39 | expires_at = 0 40 | if flags & cls.HAS_EXPIRES_AT: 41 | time_left = parser.read_double() 42 | old_server_time = parser.read_double() 43 | passed_server_time = max(time.time() - old_server_time, 0.0) 44 | time_left = max(time_left - passed_server_time, 0.0) 45 | expires_at = int(time.time() + time_left) 46 | 47 | return cls( 48 | auth_key, auth_key_id, auth_flag, True, expires_at=expires_at, created_at=created_at 49 | ) 50 | -------------------------------------------------------------------------------- /binlog/tl_parser.py: -------------------------------------------------------------------------------- 1 | import os 2 | from io import BytesIO 3 | from struct import unpack 4 | 5 | 6 | # https://github.com/tdlib/td/blob/master/tdutils/td/utils/tl_parsers.h#L24 7 | class TlParser: 8 | def __init__(self, buffer: bytes | bytearray) -> None: 9 | self.stream = BytesIO(buffer) 10 | 11 | # region custom Reading 12 | def read_byte(self) -> int: 13 | """Reads a single byte value.""" 14 | return self.read(1)[0] 15 | 16 | def read_int(self, signed=True) -> int: 17 | """Reads an integer (4 bytes) value.""" 18 | return int.from_bytes(self.read(4), byteorder='little', signed=signed) 19 | 20 | def read_long(self, signed=True) -> int: 21 | """Reads a long integer (8 bytes) value.""" 22 | return int.from_bytes(self.read(8), byteorder='little', signed=signed) 23 | 24 | def read_double(self) -> float: 25 | """Reads a real floating point (8 bytes) value.""" 26 | return unpack(' bytes: 29 | """Read the given number of bytes, or -1 to read all remaining.""" 30 | result = self.stream.read(length) 31 | if (length >= 0) and (len(result) != length): 32 | raise BufferError( 33 | 'No more data left to read (need {}, got {}: {});' 34 | .format(length, len(result), repr(result)) 35 | ) 36 | 37 | return result 38 | 39 | def read_bytes(self) -> bytes: 40 | first_byte = self.read_byte() 41 | if first_byte == 254: 42 | length = self.read_byte() | (self.read_byte() << 8) | ( 43 | self.read_byte() << 16) 44 | padding = length % 4 45 | else: 46 | length = first_byte 47 | padding = (length + 1) % 4 48 | 49 | data = self.read(length) 50 | if padding > 0: 51 | padding = 4 - padding 52 | self.read(padding) 53 | 54 | return data 55 | 56 | def read_string(self) -> str: 57 | return str(self.read_bytes(), encoding='utf-8', errors='replace') 58 | 59 | # endregion 60 | 61 | # region BytesIO related 62 | 63 | def get_value(self) -> bytes: 64 | return self.stream.getvalue() 65 | 66 | def seek(self, offset: int) -> None: 67 | self.stream.seek(offset, os.SEEK_CUR) 68 | 69 | # endregion 70 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | from binlog import read 4 | from binlog.exceptions import InvalidPassword, BinlogEventInvalid 5 | from binlog.models import AuthKey 6 | from binlog.tl_parser import TlParser 7 | 8 | tdbinlog_file_path = input('Enter the path to the td.binlog file: ') 9 | 10 | 11 | def to_int(data: bytes) -> int: 12 | if data.startswith(b'I'): 13 | data = data[1:] 14 | return int(data.decode()) 15 | 16 | 17 | def to_str(data: bytes) -> str: 18 | if data.startswith(b'S'): 19 | data = data[1:] 20 | return data.decode() 21 | 22 | 23 | def to_bool(data: bytes) -> bool: 24 | if data.startswith(b'B'): 25 | data = data[1:] 26 | return data == b'true' 27 | 28 | 29 | try: 30 | binlog = read(tdbinlog_file_path) 31 | except InvalidPassword: 32 | print('invalid password') 33 | except BinlogEventInvalid: 34 | print('invalid binlog') 35 | else: 36 | map_ = binlog.map 37 | 38 | if map_.get('auth') == b'ok': 39 | try: 40 | dc_id = to_int(map_['main_dc_id']) 41 | except KeyError: 42 | try: 43 | dc_id = to_int(map_['webfile_dc_id']) 44 | except KeyError: 45 | print('failed to locate dc_id') 46 | sys.exit() 47 | 48 | print(f'{dc_id=}') 49 | 50 | user_id = to_int(map_['my_id']) 51 | print(f'{user_id=}') 52 | 53 | raw_auth_key: bytes = map_[f'auth{dc_id}'] 54 | auth_key = AuthKey.parse(TlParser(raw_auth_key)) 55 | print(f'{auth_key.auth_key=}') 56 | 57 | # phone_number = to_str(map_['my_phone_number']) 58 | # print(f'{phone_number=}') 59 | # 60 | # was_online_remote = to_int(map_['my_was_online_remote']) 61 | # print(f'{was_online_remote=}') 62 | # 63 | # was_online_local = to_int(map_['my_was_online_local']) 64 | # print(f'{was_online_local=}') 65 | # 66 | # authorization_date = to_int(map_['authorization_date']) 67 | # print(f'{authorization_date=}') 68 | # 69 | # test_mode = to_bool(map_['test_mode']) 70 | # print(f'{test_mode=}') 71 | # 72 | # language_pack = to_str(map_['language_pack_id']) 73 | # print(f'{language_pack=}') 74 | else: 75 | print('user is not authorized') 76 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "tdbinlog-reader" 3 | version = "0.1.0" 4 | description = "" 5 | authors = ["lplpqq <69588388+lplpqq@users.noreply.github.com>"] 6 | readme = "README.md" 7 | 8 | [tool.poetry.dependencies] 9 | python = "^3.11" 10 | tgcrypto = "^1.2.5" 11 | 12 | 13 | [build-system] 14 | requires = ["poetry-core"] 15 | build-backend = "poetry.core.masonry.api" 16 | --------------------------------------------------------------------------------