├── LICENSE ├── README.md └── mips_rsp.py /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | Cisco IOS MIPS GDB remote serial protocol implementation 3 | =================== 4 | 5 | A hacky implementation of GDB RSP to aid exploit development for MIPS based Cisco routers 6 | 7 | Command reference 8 | ------------- 9 | 10 | ``` 11 | Command reference: 12 | c - continue program execution 13 | stepi - step into 14 | nexti - step over 15 | reg - print registers 16 | setreg - set register value 17 | break - set breakpoint 18 | info break - view breakpoints set 19 | del - delete breakpoint 20 | read - read memory 21 | write - dump memory within specified range 23 | gdb kernel - send "gdb kernel" command to IOS to launch GDB. Does not work on recent IOS versions. 24 | disas [aslr] - disassemble at address. Optional "aslr" parameter to account for code randomization 25 | set_aslr_offset - set aslr offset for code section 26 | ``` 27 | 28 | you can also send any GDB RSP command manually 29 | 30 | Usage example 31 | ------------- 32 | - Launch GDB on the device 33 | 34 | ``` 35 | $ sudo picocom -b 9600 /dev/ttyS0 36 | picocom v2.2 37 | Type [C-a] [C-h] to see available commands 38 | 39 | Terminal ready 40 | 41 | cisco.local>en 42 | Password: 43 | cisco.local#gdb kernel 44 | |||| 45 | 46 | ``` 47 | 48 | - Connect the debugger 49 | 50 | ``` 51 | $ python mips_rsp.py /dev/ttyS0 52 | > command: reg 53 | All registers: 54 | ... 55 | Control registers: 56 | PC: 4008f3e0 SP: 47c354d8 RA: 403a026c 57 | > command: disas 58 | ... 59 | 0x4008f3c4: move $v0, $zero 60 | 0x4008f3c8: lui $t0, 0x45fc 61 | 0x4008f3cc: lw $t0, 0x7ea8($t0) 62 | 0x4008f3d0: nop 63 | 0x4008f3d4: ori $t0, $t0, 0x100 64 | 0x4008f3d8: mtc0 $t0, $t5, 0 65 | 0x4008f3dc: nop 66 | 0x4008f3e0: nop 67 | 0x4008f3e4: j 0x4008f3f0 68 | 0x4008f3e8: addiu $v0, $zero, 1 69 | 0x4008f3ec: move $v0, $zero 70 | 0x4008f3f0: lw $ra, 0x10($sp) 71 | ... 72 | > command: 73 | 74 | ``` 75 | 76 | Dependencies 77 | ------ 78 | 79 | Capstone - www.capstone-engine.org 80 | 81 | Credits 82 | ------ 83 | 84 | Based on https://github.com/nccgroup/IODIDE 85 | 86 | Author 87 | ------ 88 | 89 | Artem Kondratenko https://twitter.com/artkond -------------------------------------------------------------------------------- /mips_rsp.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # Author: 3 | # Artem Kondratenko (@artkond) 4 | 5 | import serial 6 | import time 7 | import logging 8 | from struct import pack, unpack 9 | import sys 10 | import capstone as cs 11 | from termcolor import colored 12 | 13 | logging.basicConfig(level=logging.INFO) 14 | logger = logging.getLogger(__name__) 15 | 16 | tn = None 17 | 18 | reg_map = {1: 'at', 2: 'v0', 3: 'v1', 4:'a0', 19 | 5:'a1', 6: 'a2', 7: 'a3', 8: 't0', 20 | 9: 't1', 10: 't2', 11: 't3', 12: 't4', 21 | 13: 't5', 14: 't6', 15: 't7', 16: 's0', 22 | 17: 's1', 18: 's2', 19: 's3', 20: 's4', 23 | 21: 's5', 22: 's6', 23: 's7', 24: 't8', 24 | 25: 't9', 26: 'k0', 27: 'k1', 28: 25 | 'gp', 29:'sp', 30: 's8', 31:'ra', 37:'pc'} 26 | 27 | reg_map_rev = {} 28 | 29 | breakpoints = {} 30 | breakpoints_count = 0 31 | 32 | aslr_offset = None 33 | 34 | isSerial = True 35 | 36 | for k, v in reg_map.iteritems(): 37 | reg_map_rev[v] = k 38 | 39 | if len(sys.argv) < 2: 40 | print 'Specify serial device as a parameter' 41 | sys.exit(1) 42 | 43 | ser = serial.Serial( 44 | port=sys.argv[1], 45 | timeout=5 46 | ) 47 | 48 | 49 | def hexdump_gen(byte_string, _len=16, base_addr=0, n=0, sep='-'): 50 | FMT = '{} {} |{}|' 51 | not_shown = [' '] 52 | leader = (base_addr + n) % _len 53 | next_n = n + _len - leader 54 | while byte_string[n:]: 55 | col0 = format(n + base_addr - leader, '08x') 56 | col1 = not_shown * leader 57 | col2 = ' ' * leader 58 | leader = 0 59 | for i in bytearray(byte_string[n:next_n]): 60 | col1 += [format(i, '02x')] 61 | col2 += chr(i) if 31 < i < 127 else '.' 62 | trailer = _len - len(col1) 63 | if trailer: 64 | col1 += not_shown * trailer 65 | col2 += ' ' * trailer 66 | col1.insert(_len // 2, sep) 67 | yield FMT.format(col0, ' '.join(col1), col2) 68 | n = next_n 69 | next_n += _len 70 | 71 | 72 | def isValidDword(hexdword): 73 | if len(hexdword) != 8: 74 | return False 75 | try: 76 | hexdword.decode('hex') 77 | except TypeError: 78 | return False 79 | return True 80 | 81 | def checksum(command): 82 | csum = 0 83 | reply = "" 84 | for x in command: 85 | csum = csum + ord(x) 86 | csum = csum % 256 87 | reply = "$" + command + "#%02x" % csum 88 | return reply 89 | 90 | def decodeRLE(data): 91 | i=2 92 | multiplier=0 93 | reply="" 94 | 95 | while i < len(data): 96 | if data[i] == "*": 97 | multiplier = int(data[i+1] + data[i+2],16) 98 | for j in range (0, multiplier): 99 | reply = reply + data[i-1] 100 | i = i + 3 101 | if data[i] == "#": 102 | break 103 | reply = reply + data[i] 104 | i = i + 1 105 | return reply 106 | 107 | def print_help(): 108 | print '''Command reference: 109 | c - continue program execution 110 | stepi - step into 111 | nexti - step over 112 | reg - print registers 113 | setreg - set register value 114 | break - set break point 115 | info break - view breakpoints set 116 | del - delete breakpoint 117 | read - read memory 118 | write - dump memory within specified range 120 | gdb kernel - send "gdb kernel" command to IOS to launch GDB. Does not work on recent IOS versions. 121 | disas [aslr] - disassemble at address. Optional "aslr" parameter to account for code randomization 122 | set_aslr_offset - set aslr offset for code section 123 | 124 | you can also manually send any GDB RSP command 125 | ''' 126 | 127 | def CreateGetMemoryReq(address, len): 128 | address = "m" + address + "," + len 129 | formatted = checksum(address) 130 | formatted = formatted + "\n" 131 | return formatted 132 | 133 | def DisplayRegistersMIPS(regbuffer): 134 | regvals = [''] * 39 135 | buf = regbuffer 136 | for k, dword in enumerate([buf[i:i+8] for i in range(0, len(buf), 8)]): 137 | regvals[k] = dword 138 | return regvals 139 | 140 | def GdbCommand(command): 141 | global isSerial 142 | logger.debug('GdbCommand sending: {}'.format(checksum(command))) 143 | 144 | ser.write('{}'.format(checksum(command))) 145 | if command == 'c': 146 | return '' 147 | out = '' 148 | char ='' 149 | while char != "#": 150 | char = ser.read(1) 151 | out = out + char 152 | ser.read(2) 153 | 154 | logger.debug('Raw output from cisco: {}'.format(out)) 155 | newrle = decodeRLE(out) 156 | decoded = newrle.decode() 157 | while decoded[0] == "|" or decoded[0] == "+" or decoded[0] == "$": 158 | decoded = decoded[1:] 159 | return decoded 160 | 161 | def OnReadReg(): 162 | regs = DisplayRegistersMIPS(GdbCommand('g')) 163 | print 'All registers:' 164 | for k, reg_name in reg_map.iteritems(): 165 | print "{}: {}".format(reg_name, regs[reg_map_rev[reg_name]]) 166 | print 'Control registers:' 167 | print "PC: {} SP: {} RA: {}".format(regs[reg_map_rev['pc']],regs[reg_map_rev['sp']], regs[reg_map_rev['ra']]) 168 | return regs 169 | 170 | def OnWriteReg(command): 171 | lex = command.split(' ') 172 | (_ , reg_name, reg_val) = lex[0:3] 173 | if reg_name not in reg_map_rev: 174 | logger.error('Unknown register specified') 175 | return 176 | if not isValidDword(reg_val): 177 | logger.error('Invalid register value supplied') 178 | return 179 | logger.debug("Setting register {} with value {}".format(reg_name, reg_val)) 180 | regs = DisplayRegistersMIPS(GdbCommand('g')) 181 | regs[reg_map_rev[reg_name]] = reg_val.lower() 182 | buf = ''.join(regs) 183 | logger.debug("Writing register buffer: {}".format(buf)) 184 | res = GdbCommand('G{}'.format(buf)) 185 | if 'OK' in res: 186 | return True 187 | else: 188 | return None 189 | 190 | def OnReadMem(addr, length): 191 | if not isValidDword(addr): 192 | logger.error('Invalid address supplied') 193 | return None 194 | if length > 199: 195 | logger.error('Maximum length of 199 exceeded') 196 | return None 197 | res = GdbCommand('m{},{}'.format(addr.lower(),hex(length)[2:])) 198 | if res.startswith('E0'): 199 | return None 200 | else: 201 | return res 202 | 203 | def OnWriteMem(addr, data): 204 | res = GdbCommand('M{},{}:{}'.format(addr.lower(), len(data)/2, data)) 205 | if 'OK' in res: 206 | return True 207 | else: 208 | return None 209 | 210 | def hex2int(s): 211 | return unpack(">I", s.decode('hex'))[0] 212 | 213 | def int2hex(num): 214 | return pack(">I", num & 0xffffffff).encode('hex') 215 | 216 | def OnBreak(command): 217 | global breakpoints 218 | global breakpoints_count 219 | lex = command.split(' ') 220 | 221 | (_ ,addr) = lex[0:2] 222 | if not isValidDword(addr): 223 | logger.error('Invalid address supplied') 224 | return 225 | if len(lex) == 3: 226 | if lex[2] == 'aslr' and aslr_offset != None: 227 | addr = int2hex(hex2int(addr) + aslr_offset) 228 | addr = addr.lower().rstrip() 229 | if addr in breakpoints: 230 | logger.info('breakpoint already set') 231 | return 232 | opcode_to_save = OnReadMem(addr, 4) 233 | if opcode_to_save is None: 234 | logger.error('Can\'t set breakpoint at {}. Read error'.format(addr)) 235 | return 236 | res = OnWriteMem(addr, '0000000d') 237 | if res: 238 | breakpoints_count += 1 239 | breakpoints[addr] = (breakpoints_count, opcode_to_save) 240 | logger.info('Breakpoint set at {}'.format(addr)) 241 | else: 242 | logger.error('Can\'t set breakpoint at {}. Error writing'.format(addr)) 243 | 244 | def OnDelBreak(command): 245 | global breakpoints 246 | global breakpoints_count 247 | (_, b_num) = command.rstrip().split(' ') 248 | logger.debug('OnDelBreak') 249 | item_to_delete = None 250 | for k, v in breakpoints.iteritems(): 251 | try: 252 | if v[0] == int(b_num): 253 | res = OnWriteMem(k, v[1]) 254 | if res: 255 | item_to_delete = k 256 | break 257 | else: 258 | logger.error('Error deleting breakpoint {} at {}'.format(b_num, k)) 259 | return 260 | except ValueError: 261 | logger.error('Invalid breakpoint num supplied') 262 | return 263 | if item_to_delete is not None: 264 | del breakpoints[k] 265 | logger.info('Deleted breakpoint {}'.format(b_num)) 266 | 267 | def OnSearchMem(addr, pattern): 268 | cur_addr = addr.lower() 269 | buf = '' 270 | i = 0 271 | while True: 272 | i += 1 273 | mem = GdbCommand('m{},00c7'.format(cur_addr)) 274 | buf += mem 275 | if i %1000 == 0: 276 | print cur_addr 277 | print hexdump(mem.decode('hex')) 278 | if pattern in buf[-100:-1]: 279 | print 'FOUND at {}'.format(cur_addr) 280 | return 281 | cur_addr = pack(">I", unpack(">I",cur_addr.decode('hex'))[0] + 0xc7).encode('hex') 282 | 283 | def OnListBreak(): 284 | global breakpoints 285 | global breakpoints_count 286 | for k, v in breakpoints.iteritems(): 287 | print '{}: {}'.format(v[0], k) 288 | 289 | def OnStepInto(): 290 | ser.write("$s#73\r\n") 291 | ser.read(5) 292 | OnReadReg() 293 | OnDisas('disas') 294 | 295 | def OnNext(): 296 | regs = OnReadReg() 297 | pc = unpack('>I', regs[reg_map_rev['pc']].decode('hex'))[0] 298 | pc_after_branch = pc + 8 299 | pc_in_hex = pack('>I', pc_after_branch).encode('hex') 300 | OnBreak('break {}'.format(pc_in_hex)) 301 | GdbCommand('c') 302 | OnReadReg() 303 | OnDelBreak('del {}'.format(breakpoints[pc_in_hex][0])) 304 | 305 | def OnDumpMemory(start, stop): 306 | buf = '' 307 | print start, stop 308 | if not isValidDword(start) or not isValidDword(stop): 309 | logger.error('Invalid memory range specified') 310 | return 311 | cur_addr = start 312 | while unpack(">I",cur_addr.decode('hex'))[0] < unpack(">I", stop.decode('hex'))[0]: 313 | res = GdbCommand('m{},00c7'.format(cur_addr)) 314 | logger.info('Dumping at {} len {}'.format(cur_addr, len(res))) 315 | cur_addr = pack(">I", unpack(">I",cur_addr.decode('hex'))[0] + 0xc7).encode('hex') 316 | buf += res 317 | return buf 318 | 319 | def OnSetAslrOffset(): 320 | global aslr_offset 321 | (_, offset) = command.rstrip().split(' ') 322 | aslr_offset = hex2int(offset) 323 | logger.info('ASLR offset set to: 0x{}'.format(offset)) 324 | 325 | def OnDisas(command): 326 | lex = command.rstrip().split(' ') 327 | 328 | regs = DisplayRegistersMIPS(GdbCommand('g')) 329 | pc = hex2int(regs[reg_map_rev['pc']]) 330 | 331 | for lexem in lex[1:]: 332 | if lexem != 'aslr': 333 | if not isValidDword(lexem): 334 | logger.error('Invalid address supplied') 335 | return 336 | pc = hex2int(lexem) 337 | 338 | logger.debug('OnDisas PC = {}'.format(pc)) 339 | buf = OnReadMem(int2hex(pc - 20 * 4), 40 * 4) 340 | md = cs.Cs(cs.CS_ARCH_MIPS, cs.CS_MODE_MIPS32 | cs.CS_MODE_BIG_ENDIAN) 341 | 342 | if len(lex) > 1: 343 | if lex[1] == 'aslr' and aslr_offset != None: 344 | pc -= aslr_offset 345 | 346 | for i in md.disasm(buf.decode('hex'), pc - 20 * 4): 347 | color = 'green' if i.address == pc else 'blue' 348 | print("0x%x:\t%s\t%s" %(i.address, colored(i.mnemonic, color), colored(i.op_str, color))) 349 | 350 | 351 | while True: 352 | try: 353 | command = raw_input('> command: ').rstrip() 354 | if command == 'exit': 355 | sys.exit(0) 356 | elif command == 'help': 357 | print_help() 358 | elif command == 'c': 359 | GdbCommand('c') 360 | elif command == 'stepi': 361 | OnStepInto() 362 | elif command == 'nexti': 363 | OnNext() 364 | elif command == 'reg': 365 | OnReadReg() 366 | elif command.startswith('setreg'): 367 | OnWriteReg(command) 368 | elif command.startswith('break'): 369 | OnBreak(command) 370 | elif command.startswith('del'): 371 | OnDelBreak(command) 372 | elif command.startswith('info b'): 373 | OnListBreak() 374 | elif command.startswith('read'): 375 | _, start, length = command.split(' ') 376 | buf = OnReadMem(start, int(length)) 377 | for line in hexdump_gen(buf.decode('hex'), base_addr=hex2int(start), sep=' '): 378 | print line 379 | elif command.startswith('write'): 380 | _, dest, value = command.split(' ') 381 | value.decode('hex') 382 | OnWriteMem(dest, value) 383 | elif command.startswith('search'): 384 | _, addr, pattern = command.split(' ') 385 | OnSearchMem(addr, pattern) 386 | elif command.startswith('gdb kernel'): 387 | ser.write('{}\n'.format('gdb kernel')) 388 | elif command.startswith('dump'): 389 | _, start, stop = command.split(' ') 390 | buf = OnDumpMemory(start.lower(), stop.lower()) 391 | if buf is None: 392 | continue 393 | else: 394 | with open('dump_file','wb') as f: 395 | f.write(buf) 396 | logger.info('Wrote memory dump to "dump_file"') 397 | elif command.startswith('set_aslr_offset'): 398 | OnSetAslrOffset() 399 | elif command.startswith('disas'): 400 | OnDisas(command) 401 | else: 402 | 403 | ans = raw_input('Command not recognized.\nDo you want to send raw command: {} ? [yes]'.format(checksum(command.rstrip()))) 404 | if ans == '' or ans == 'yes': 405 | reply = GdbCommand(command.rstrip()) 406 | print 'Cisco response:', reply.rstrip() 407 | except (KeyboardInterrupt, serial.serialutil.SerialException, ValueError, TypeError) as e: 408 | print '\n{}'.format(e) 409 | print 'Type "exit" to end debugging session' --------------------------------------------------------------------------------