├── LICENSE.md ├── README.md ├── modbus.py ├── plcscan.py └── s7.py /LICENSE.md: -------------------------------------------------------------------------------- 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | Tool for scan PLC devices over s7comm or modbus protocols. 2 | 3 | This project is forked from code from Dmitry Efanov (Positive Research) originally posted to Google Code. 4 | 5 | ## Usage examples: 6 | ``` 7 | plcscan.py 192.168.0.1 8 | plcscan.py --timeout 2 192.168.0.1:102 10.0.0.0/24 9 | plcscan.py --hosts-list hosts.txt' 10 | ``` 11 | where file hosts.txt looks like: 12 | ``` 13 | 192.168.1.15 14 | 192.168.1.107:102 15 | example.host:502' 16 | ``` 17 | ## Output examples: 18 | ### Siemens PLC 19 | ``` 20 | 127.0.0.1:102 S7comm (src_tsap=0x100, dst_tsap=0x102) 21 | Module : 6ES7 151-8AB01-0AB0 v.0.2 (36455337203135312d38414230312d304142302000c000020001) 22 | Basic Hardware : 6ES7 151-8AB01-0AB0 v.0.2 (36455337203135312d38414230312d304142302000c000020001) 23 | Basic Firmware : v.3.2.6 (202020202020202020202020202020202020202000c056030206) 24 | Unknown (129) : Boot Loader A (426f6f74204c6f61646572202020202020202020000041200909) 25 | Name of the PLC : SIMATIC 300(xxxxxxxxx) (53494d4154494320333030280000000000000000002900000000000000000000) 26 | Name of the module : IM151-8 PN/DP CPU (494d3135312d3820504e2f445020435055000000000000000000000000000000) 27 | Plant identification : (0000000000000000000000000000000000000000000000000000000000000000) 28 | Copyright : Original Siemens Equipment (4f726967696e616c205369656d656e732045717569706d656e74000000000000) 29 | Serial number of module : S C-BOUVxxxxxxxx (5320432d424f5556xxxxxxxxxx00000000000000000000000000000000000000) 30 | Module type name : IM151-8 PN/DP CPU (494d3135312d3820504e2f445020435055000000000000000000000000000000) 31 | ``` 32 | ### Modbus device 33 | ``` 34 | 127.0.0.1:502 Modbus/TCP 35 | Unit ID: 0 36 | Response error: ILLEGAL FUNCTION 37 | Device info error: ILLEGAL FUNCTION 38 | Unit ID: 255 39 | Response error: GATEWAY TARGET DEVICE FAILED TO RESPOND 40 | Device: Lantronix I WiPo V3.2.25` 41 | ``` 42 | -------------------------------------------------------------------------------- /modbus.py: -------------------------------------------------------------------------------- 1 | """ 2 | File: modbus.py 3 | Desc: partial implementation of modbus protocol 4 | Version: 0.1 5 | 6 | Copyright (c) 2012 Dmitry Efanov (Positive Research) 7 | """ 8 | 9 | __author__ = 'defanov' 10 | 11 | from struct import pack,unpack 12 | import socket 13 | 14 | from optparse import OptionGroup 15 | 16 | import string 17 | 18 | __FILTER = "".join([' '] + [' ' if chr(x) not in string.printable or chr(x) in string.whitespace else chr(x) for x in range(1,256)]) 19 | def StripUnprintable(msg): 20 | return msg.translate(__FILTER) 21 | 22 | class ModbusProtocolError(Exception): 23 | def __init__(self, message, packet=''): 24 | self.message = message 25 | self.packet = packet 26 | def __str__(self): 27 | return "[Error][ModbusProtocol] %s" % self.message 28 | 29 | class ModbusError(Exception): 30 | _errors = { 31 | 0: 'No reply', 32 | # Modbus errors 33 | 1: 'ILLEGAL FUNCTION', 34 | 2: 'ILLEGAL DATA ADDRESS', 35 | 3: 'ILLEGAL DATA VALUE', 36 | 4: 'SLAVE DEVICE FAILURE', 37 | 5: 'ACKNOWLEDGE', 38 | 6: 'SLAVE DEVICE BUSY', 39 | 8: 'MEMORY PARITY ERROR', 40 | 0x0A: 'GATEWAY PATH UNAVAILABLE', 41 | 0x0B: 'GATEWAY TARGET DEVICE FAILED TO RESPOND' 42 | } 43 | def __init__(self, code): 44 | self.code = code 45 | self.message = ModbusError._errors[code] if ModbusError._errors.has_key(code) else 'Unknown Error' 46 | def __str__(self): 47 | return "[Error][Modbus][%d] %s" % (self.code, self.message) 48 | 49 | 50 | class ModbusPacket: 51 | def __init__(self, transactionId=0, unitId=0, functionId=0, data=''): 52 | self.transactionId = transactionId 53 | self.unitId = unitId 54 | self.functionId = functionId 55 | self.data = data 56 | 57 | def pack(self): 58 | return pack('!HHHBB', 59 | self.transactionId, # transaction id 60 | 0, # protocol identifier (reserved 0) 61 | len(self.data)+2, # remaining length 62 | self.unitId, # unit id 63 | self.functionId # function id 64 | ) + self.data # data 65 | 66 | def unpack(self,packet): 67 | if len(packet)<8: 68 | raise ModbusProtocolError('Response too short', packet) 69 | 70 | self.transactionId, self.protocolId, length, self.unitId, self.functionId = unpack('!HHHBB',packet[:8]) 71 | if len(packet) < 6+length: 72 | raise ModbusProtocolError('Response too short', packet) 73 | 74 | self.data = packet[8:] 75 | 76 | return self 77 | 78 | class Modbus: 79 | def __init__(self, ip, port=502, uid=0, timeout=8): 80 | self.ip = ip 81 | self.port = port 82 | self.uid = uid 83 | self.timeout = timeout 84 | 85 | def Request(self, functionId, data=''): 86 | sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 87 | sock.settimeout(self.timeout) 88 | 89 | sock.connect((self.ip,self.port)) 90 | 91 | sock.send(ModbusPacket(0, self.uid, functionId, data).pack()) 92 | 93 | reply = sock.recv(1024) 94 | 95 | if not reply: 96 | raise ModbusError(0) 97 | 98 | response = ModbusPacket().unpack(reply) 99 | 100 | if response.unitId != self.uid: 101 | raise ModbusProtocolError('Unexpected unit ID or incorrect packet', reply) 102 | 103 | if response.functionId != functionId: 104 | raise ModbusError(ord(response.data[0])) 105 | 106 | return response.data 107 | 108 | def DeviceInfo(self): 109 | res = self.Request(0x2b, '\x0e\x01\00') 110 | 111 | if res and len(res)>5: 112 | objectsCount = ord(res[5]) 113 | data = res[6:] 114 | info = '' 115 | for i in range(0, objectsCount): 116 | info += data[2:2+ord(data[1])] 117 | info += ' ' 118 | data = data[2+ord(data[1]):] 119 | return info 120 | else: 121 | raise ModbusProtocolError('Packet format (reply for device info) wrong', res) 122 | 123 | def ScanUnit(ip, port, uid, timeout, function=None, data=''): 124 | con = Modbus(ip, port, uid, timeout) 125 | 126 | unitInfo = [] 127 | if function: 128 | try: 129 | response = con.Request(function, data) 130 | unitInfo.append("Response: %s\t(%s)" % (StripUnprintable(response), response.encode('hex'))) 131 | except ModbusError as e: 132 | if e.code: 133 | unitInfo.append("Response error: %s" % e.message) 134 | else: 135 | return unitInfo 136 | 137 | try: 138 | deviceInfo = con.DeviceInfo() 139 | unitInfo.append("Device: %s" % deviceInfo) 140 | except ModbusError as e: 141 | if e.code: 142 | unitInfo.append("Device info error: %s" % e.message) 143 | else: 144 | return unitInfo 145 | 146 | return unitInfo 147 | 148 | def Scan(ip, port, options): 149 | res = False 150 | try: 151 | data = options.modbus_data.decode('string-escape') if options.modbus_data else '' 152 | 153 | if options.brute_uid: 154 | uids = [0,255] + range(1,255) 155 | elif options.modbus_uid: 156 | uids = [int(uid.strip()) for uid in options.modbus_uid.split(',')] 157 | else: 158 | uids = [0,255] 159 | 160 | for uid in uids: 161 | unitInfo = ScanUnit(ip, port, uid, options.modbus_timeout, options.modbus_function, data) 162 | 163 | if unitInfo: 164 | if not res: 165 | print "%s:%d Modbus/TCP" % (ip, port) 166 | res = True 167 | print " Unit ID: %d" % uid 168 | for line in unitInfo: 169 | print " %s" % line 170 | 171 | return res 172 | 173 | except ModbusProtocolError as e: 174 | print "%s:%d Modbus protocol error: %s (packet: %s)" % (ip, port, e.message, e.packet.encode('hex')) 175 | return res 176 | except socket.error as e: 177 | print "%s:%d %s" % (ip, port, e) 178 | return res 179 | 180 | def AddOptions(parser): 181 | group = OptionGroup(parser, "Modbus scanner") 182 | group.add_option("--brute-uid", action="store_true", help="Brute units ID", default=False) 183 | group.add_option("--modbus-uid", help="Use uids from list", type="string", metavar="UID") 184 | group.add_option("--modbus-function", help="Use modbus function NOM for discover units", type="int", metavar="NOM") 185 | group.add_option("--modbus-data", help="Use data for for modbus function", default="", metavar="DATA") 186 | group.add_option("--modbus-timeout", help="Timeout for modbus protocol (seconds)", default=8, type="float", metavar="TIMEOUT") 187 | parser.add_option_group(group) 188 | -------------------------------------------------------------------------------- /plcscan.py: -------------------------------------------------------------------------------- 1 | """ 2 | File: plcscan.py 3 | Desc: PLC scanner 4 | Version: 0.1 5 | 6 | Copyright (c) 2012 Dmitry Efanov (Positive Research) 7 | """ 8 | 9 | __author__ = 'defanov' 10 | import modbus 11 | import s7 12 | 13 | import sys 14 | from optparse import OptionParser 15 | import socket 16 | import struct 17 | 18 | def status(msg): 19 | sys.stderr.write(msg[:-1][:39].ljust(39,' ')+msg[-1:]) 20 | 21 | def get_ip_list(mask): 22 | try: 23 | net_addr,mask = mask.split('/') 24 | mask = int(mask) 25 | start, = struct.unpack('!L', socket.inet_aton(net_addr)) 26 | start &= 0xFFFFFFFF << (32-mask) 27 | end = start | ( 0xFFFFFFFF >> mask ) 28 | return [socket.inet_ntoa(struct.pack('!L', addr)) for addr in range(start+1, end)] 29 | except (struct.error,socket.error): 30 | return [] 31 | 32 | def scan(argv): 33 | parser = OptionParser( 34 | usage = "usage: %prog [options] [ip range]...", 35 | description = """Scan IP range for PLC devices. Support MODBUS and S7COMM protocols 36 | """ 37 | ) 38 | parser.add_option("--hosts-list", dest="hosts_file", help="Scan hosts from FILE", metavar="FILE") 39 | parser.add_option("--ports", dest="ports", help="Scan ports from PORTS", metavar="PORTS", default="102,502") 40 | parser.add_option("--timeout", dest="connect_timeout", help="Connection timeout (seconds)", metavar="TIMEOUT", type="float", default=1) 41 | 42 | modbus.AddOptions(parser) 43 | s7.AddOptions(parser) 44 | 45 | (options, args) = parser.parse_args(argv) 46 | 47 | scan_hosts = [] 48 | if options.hosts_file: 49 | try: 50 | scan_hosts = [file.strip() for file in open(options.hosts_file, 'r')] 51 | except IOError: 52 | print "Can't open file %s" % options.hosts_file 53 | 54 | for ip in args: 55 | scan_hosts.extend(get_ip_list(ip) if '/' in ip else 56 | [ip]) 57 | 58 | scan_ports = [int(port) for port in options.ports.split(',')] 59 | 60 | if not scan_hosts: 61 | print "No targets to scan\n\n" 62 | parser.print_help() 63 | exit() 64 | 65 | status("Scan start...\n") 66 | for host in scan_hosts: 67 | splitted = host.split(':') 68 | host = splitted[0] 69 | if len(splitted)==2: 70 | ports = [int(splitted[1])] 71 | else: 72 | ports = scan_ports 73 | for port in ports: 74 | status("%s:%d...\r" % (host, port)) 75 | try: 76 | sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 77 | sock.settimeout(options.connect_timeout) 78 | sock.connect((host,port)) 79 | sock.close() 80 | except socket.error: 81 | continue 82 | 83 | if port == 102: 84 | res = s7.Scan(host, port, options) 85 | elif port == 502: 86 | res = modbus.Scan(host, port, options) 87 | else: 88 | res = modbus.Scan(host, port, options) or s7.Scan(host, port, options) 89 | 90 | if not res: 91 | print "%s:%d unknown protocol" % (host, port) 92 | 93 | 94 | status("Scan complete\n") 95 | 96 | if __name__=="__main__": 97 | try: 98 | scan(sys.argv[1:]) 99 | except KeyboardInterrupt: 100 | status("Scan terminated\n") 101 | 102 | -------------------------------------------------------------------------------- /s7.py: -------------------------------------------------------------------------------- 1 | """ 2 | File: s7.py 3 | Desc: Partial implementation of s7comm protocol 4 | Version: 0.1 5 | 6 | Copyright (c) 2012 Dmitry Efanov (Positive Research) 7 | """ 8 | 9 | __author__ = 'defanov' 10 | 11 | from struct import * 12 | from random import randint 13 | from optparse import OptionGroup 14 | 15 | import struct 16 | import socket 17 | import string 18 | 19 | __FILTER = "".join([' '] + [' ' if chr(x) not in string.printable or chr(x) in string.whitespace else chr(x) for x in range(1,256)]) 20 | def StripUnprintable(msg): 21 | return msg.translate(__FILTER) 22 | 23 | class TPKTPacket: 24 | """ TPKT packet. RFC 1006 25 | """ 26 | def __init__(self, data=''): 27 | self.data = str(data) 28 | def pack(self): 29 | return pack('!BBH', 30 | 3, # version 31 | 0, # reserved 32 | len(self.data)+4 # packet size 33 | ) + str(self.data) 34 | def unpack(self,packet): 35 | try: 36 | header = unpack('!BBH', packet[:4]) 37 | except struct.error as e: 38 | raise S7ProtocolError("Unknown TPKT format") 39 | 40 | self.data = packet[4:4+header[2]] 41 | return self 42 | 43 | class COTPConnectionPacket: 44 | """ COTP Connection Request or Connection Confirm packet (ISO on TCP). RFC 1006 45 | """ 46 | def __init__(self, dst_ref=0, src_ref=0, dst_tsap=0, src_tsap=0, tpdu_size=0): 47 | self.dst_ref = dst_ref 48 | self.src_ref = src_ref 49 | self.dst_tsap = dst_tsap 50 | self.src_tsap = src_tsap 51 | self.tpdu_size = tpdu_size 52 | 53 | def pack(self): 54 | """ make Connection Request Packet 55 | """ 56 | return pack('!BBHHBBBHBBHBBB', 57 | 17, # size 58 | 0xe0, # pdu type: CR 59 | self.dst_ref, 60 | self.src_ref, 61 | 0, # flag 62 | 0xc1, 2, self.src_tsap, 63 | 0xc2, 2, self.dst_tsap, 64 | 0xc0, 1, self.tpdu_size ) 65 | def __str__(self): 66 | return self.pack() 67 | 68 | def unpack(self, packet): 69 | """ parse Connection Confirm Packet (header only) 70 | """ 71 | try: 72 | size, pdu_type, self.dst_ref, self.src_ref, flags = unpack('!BBHHB', packet[:7]) 73 | except struct.error as e: 74 | raise S7ProtocolError("Wrong CC packet format") 75 | if len(packet) != size + 1: 76 | raise S7ProtocolError("Wrong CC packet size") 77 | if pdu_type != 0xd0: 78 | raise S7ProtocolError("Not a CC packet") 79 | 80 | return self 81 | 82 | class COTPDataPacket: 83 | """ COTP Data packet (ISO on TCP). RFC 1006 84 | """ 85 | def __init__(self, data=''): 86 | self.data = data 87 | def pack(self): 88 | return pack('!BBB', 89 | 2, # header len 90 | 0xf0, # data packet 91 | 0x80) + str(self.data) 92 | def unpack(self, packet): 93 | self.data = packet[ord(packet[0])+1:] 94 | return self 95 | def __str__(self): 96 | return self.pack() 97 | 98 | class S7Packet: 99 | """ S7 packet 100 | """ 101 | def __init__(self, type=1, req_id=0, parameters='', data=''): 102 | self.type = type 103 | self.req_id = req_id 104 | self.parameters = parameters 105 | self.data = data 106 | self.error = 0 107 | 108 | def pack(self): 109 | if self.type not in [1,7]: 110 | raise S7ProtocolError("Unknown pdu type") 111 | return ( pack('!BBHHHH', 112 | 0x32, # protocol s7 magic 113 | self.type, # pdu-type 114 | 0, # reserved 115 | self.req_id, # request id 116 | len(self.parameters), # parameters length 117 | len(self.data)) + # data length 118 | self.parameters + 119 | self.data ) 120 | 121 | def unpack(self, packet): 122 | try: 123 | if ord(packet[1]) in [3,2]: # pdu-type = response 124 | header_size = 12 125 | magic0x32, self.type, reserved, self.req_id, parameters_length, data_length, self.error = unpack('!BBHHHHH', packet[:header_size]) 126 | if self.error: 127 | raise S7Error(self.error) 128 | elif ord(packet[1]) in [1,7]: 129 | header_size = 10 130 | magic0x32, self.type, reserved, self.req_id, parameters_length, data_length = unpack('!BBHHHH', packet[:header_size]) 131 | else: 132 | raise S7ProtocolError("Unknown pdu type (%d)" % ord(packet[1])) 133 | except struct.error as e: 134 | raise S7ProtocolError("Wrong S7 packet format") 135 | 136 | self.parameters = packet[header_size:header_size+parameters_length] 137 | self.data = packet[header_size+parameters_length:header_size+parameters_length+data_length] 138 | return self 139 | 140 | def __str__(self): 141 | return self.pack() 142 | 143 | 144 | class S7ProtocolError(Exception): 145 | def __init__(self, message, packet=''): 146 | self.message = message 147 | self.packet = packet 148 | def __str__(self): 149 | return "[ERROR][S7Protocol] %s" % self.message 150 | 151 | class S7Error( Exception ): 152 | _errors = { 153 | # s7 data errors 154 | 0x05: 'Address Error', 155 | 0x0a: 'Item not available', 156 | # s7 header errors 157 | 0x8104: 'Context not supported', 158 | 0x8500: 'Wrong PDU size' 159 | } 160 | def __init__(self, code): 161 | self.code = code 162 | def __str__(self): 163 | if S7Error._errors.has_key(self.code): 164 | message = S7Error._errors[self.code] 165 | else: 166 | message = 'Unknown error' 167 | return "[ERROR][S7][0x%x] %s" % (self.code, message) 168 | 169 | 170 | def Split(ar,size): 171 | """ split sequence into blocks of given size 172 | """ 173 | return [ar[i:i+size] for i in range(0, len(ar), size)] 174 | 175 | class s7: 176 | def __init__(self, ip, port, src_tsap=0x200, dst_tsap=0x201, timeout=8): 177 | self.ip = ip 178 | self.port = port 179 | self.req_id = 0 180 | self.s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 181 | 182 | self.dst_ref = 0 183 | self.src_ref = 0x04 184 | self.dst_tsap = dst_tsap 185 | self.src_tsap = src_tsap 186 | self.timeout = timeout 187 | 188 | def Connect(self): 189 | """ Establish ISO on TCP connection and negotiate PDU 190 | """ 191 | #sleep(1) 192 | self.src_ref = randint(1, 20) 193 | self.s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 194 | self.s.settimeout(self.timeout) 195 | self.s.connect((self.ip, self.port)) 196 | self.s.send(TPKTPacket(COTPConnectionPacket(self.dst_ref, self.src_ref, self.dst_tsap, self.src_tsap, 0x0a)).pack()) 197 | reply = self.s.recv(1024) 198 | response = COTPConnectionPacket().unpack(TPKTPacket().unpack(reply).data) 199 | 200 | self.NegotiatePDU() 201 | 202 | def Request(self, type, parameters='', data=''): 203 | """ Send s7 request and receive response 204 | """ 205 | packet = TPKTPacket(COTPDataPacket(S7Packet(type, self.req_id, parameters, data))).pack() 206 | self.s.send(packet) 207 | reply = self.s.recv(1024) 208 | response = S7Packet().unpack(COTPDataPacket().unpack(TPKTPacket().unpack(reply).data).data) 209 | if self.req_id != response.req_id: 210 | raise S7ProtocolError('Sequence ID not correct') 211 | return response 212 | 213 | 214 | def NegotiatePDU(self, pdu=480): 215 | """ Send negotiate pdu request and receive response. Reply no matter 216 | """ 217 | response = self.Request(0x01, pack('!BBHHH', 218 | 0xf0, # function NegotiatePDU 219 | 0x00, # unknown 220 | 0x01, # max number of parallel jobs 221 | 0x01, # max number of parallel jobs 222 | pdu)) # pdu length 223 | 224 | func, unknown, pj1, pj2, pdu = unpack('!BBHHH', response.parameters) 225 | return pdu 226 | 227 | def Function(self, type, group, function, data=''): 228 | parameters = pack('!LBBBB', 229 | 0x00011200 + # parameter head (magic) 230 | 0x04, # parameter length 231 | 0x11, # unknown 232 | type*0x10+group, # type, function group 233 | function, # function 234 | 0x00 ) # sequence 235 | 236 | data = pack('!BBH', 0xFF, 0x09, len(data)) + data 237 | response = self.Request(0x07, parameters, data) 238 | 239 | code, transport_size, data_len = unpack('!BBH', response.data[:4]) 240 | if code != 0xFF: 241 | raise S7Error(code) 242 | return response.data[4:] 243 | 244 | def ReadSZL(self, szl_id): 245 | szl_data = self.Function( 246 | 0x04, # request 247 | 0x04, # szl-functions 248 | 0x01, # read szl 249 | pack('!HH', 250 | szl_id, # szl id 251 | 1)) # szl index 252 | 253 | szl_id, szl_index, element_size, element_count = unpack('!HHHH', szl_data[:8]) 254 | 255 | return Split(szl_data[8:], element_size) 256 | 257 | def BruteTsap(ip, port, src_tsaps=(0x100, 0x200), dst_tsaps=(0x102, 0x200, 0x201) ): 258 | for src_tsap in src_tsaps: 259 | for dst_tsap in dst_tsaps: 260 | try: 261 | con = s7(ip, port) 262 | con.src_tsap = src_tsap 263 | con.dst_tsap = dst_tsap 264 | con.Connect() 265 | return src_tsap, dst_tsap 266 | 267 | except S7ProtocolError as e: 268 | pass 269 | 270 | return None 271 | 272 | def GetIdentity(ip, port, src_tsap, dst_tsap): 273 | res = [] 274 | 275 | szl_dict = { 276 | 0x11: 277 | { 'title': 'Module Identification', 278 | 'indexes': { 279 | 1:'Module', 280 | 6:'Basic Hardware', 281 | 7:'Basic Firmware' 282 | }, 283 | 'packer': { 284 | (1, 6): lambda(packet): "{0:s} v.{2:d}.{3:d}".format(*unpack('!20sHBBH', packet)), 285 | (7,): lambda(packet): "{0:s} v.{3:d}.{4:d}.{5:d}".format(*unpack('!20sHBBBB', packet)) 286 | } 287 | }, 288 | 0x1c: 289 | { 'title': 'Component Identification', 290 | 'indexes': { 291 | 1: 'Name of the PLC', 292 | 2: 'Name of the module', 293 | 3: 'Plant identification', 294 | 4: 'Copyright', 295 | 5: 'Serial number of module', 296 | 6: 'Reserved for operating system', 297 | 7: 'Module type name', 298 | 8: 'Serial number of memory card', 299 | 9: 'Manufacturer and profile of a CPU module', 300 | 10:'OEM ID of a module', 301 | 11:'Location designation of a module' 302 | }, 303 | 'packer': { 304 | (1, 2, 5): lambda(packet): "%s" % packet[:24], 305 | (3, 7, 8): lambda(packet): "%s" % packet[:32], 306 | (4,): lambda(packet): "%s" % packet[:26] 307 | } 308 | } 309 | } 310 | 311 | con = s7(ip, port, src_tsap, dst_tsap) 312 | con.Connect() 313 | 314 | for szl_id in szl_dict.keys(): 315 | try: 316 | entities = con.ReadSZL(szl_id) 317 | except S7Error: 318 | continue 319 | 320 | indexes = szl_dict[szl_id]['indexes'] 321 | packers = szl_dict[szl_id]['packer'] 322 | for item in entities: 323 | if len(item)>2: 324 | n, = unpack('!H', item[:2]) 325 | item = item[2:] 326 | title = indexes[n] if indexes.has_key(n) else "Unknown (%d)" % n 327 | 328 | try: 329 | packers_keys = [ i for i in packers.keys() if n in i ] 330 | formated_item = packers[packers_keys[0]](item).strip('\x00') 331 | except (struct.error, IndexError) : 332 | formated_item = StripUnprintable(item).strip('\x00') 333 | 334 | res.append("%s: %s\t(%s)" % (title.ljust(25), formated_item.ljust(30), item.encode('hex'))) 335 | 336 | return res 337 | 338 | def Scan(ip, port, options): 339 | src_tsaps = [ int(n.strip(), 0) for n in options.src_tsap.split(',') ] if options.src_tsap else [0x100, 0x200] 340 | dst_tsaps = [ int(n.strip(), 0) for n in options.dst_tsap.split(',') ] if options.dst_tsap else [0x102, 0x200, 0x201] 341 | 342 | res = () 343 | try: 344 | res = BruteTsap(ip, port, src_tsaps, dst_tsaps) 345 | except socket.error as e: 346 | print "%s:%d %s" % (ip, port, e) 347 | 348 | if not res: 349 | return False 350 | 351 | print "%s:%d S7comm (src_tsap=0x%x, dst_tsap=0x%x)" % (ip, port, res[0], res[1]) 352 | 353 | # sometimes unexpected exceptions occures, so try to get identity several time 354 | identities = [] 355 | for attempt in [0, 1]: 356 | try: 357 | identities = GetIdentity(ip, port, res[0], res[1]) 358 | break 359 | except (S7ProtocolError, socket.error) as e: 360 | print " %s" % e 361 | 362 | for line in identities: 363 | print " %s" % line 364 | 365 | return True 366 | 367 | def AddOptions(parser): 368 | group = OptionGroup(parser, "S7 scanner options") 369 | group.add_option("--src-tsap", help="Try this src-tsap (list) (default: 0x100,0x200)", type="string", metavar="LIST") 370 | group.add_option("--dst-tsap", help="Try this dst-tsap (list) (default: 0x102,0x200,0x201)", type="string", metavar="LIST") 371 | parser.add_option_group(group) --------------------------------------------------------------------------------