├── LICENSE ├── README.md ├── beacon-simulator.py ├── python-scripts ├── tcp-client.py ├── tcp-server.py ├── udp-client.py └── udp-server.py ├── shell-scripts ├── beacon-simulator.sh └── simple-beacon.sh └── simple-listener.sh /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

threat-tools

2 | 3 | This repository contains several scripts that will allow you to mimic a compromised system calling home to a command and control (C2) server. None of the tools exfiltrate any data and are designed to test your environment's ability to detect a wide range of C2 channels. 4 | 5 | ## Table of Contents 6 | [Overview](#overview)
7 | [Example Setup](#example-setup)
8 | [`simple-listener.sh`](#simple-listenersh)
9 | [`beacon-simulator.py`](#beacon-simulatorpy)
10 | [`beacon-simulator.sh`](#beacon-simulatorsh)
11 | [`simple-beacon.sh`](#simple-beaconsh)
12 | [Python Script Pairs](#python-script-pairs)
13 | [Running Tools in the Background with `screen`](#running-tools-in-the-background-with-screen) 14 | 15 | Some names were changed from previous versions in order to be more intuitive. Navigate to the following section to reference name changes if you do not see your script in the Table of Contents:
16 | 17 | [Script Name Changes](#script-name-changes) 18 | 19 | 20 | ## Overview 21 | In order to run these scripts, you will need two systems: one to act as the compromised client sending the beacon, and one to act as the C2 server. The client will need to run one of the beacon simulator scripts, and the server will need to run one of the scripts to set up a listener. With exception to the scripts within `python-scripts`, all beacon simulators are meant to be used in tandem with `simple-listener.sh` running on the server. 22 | 23 | The only exception to this is if the client is running `simple-beacon.sh`, which can simulate beacon traffic by repeatedly sending web requests to any public web server. 24 | 25 | For the majority of users, `beacon-simulator.py` and `simple-listener.sh` will be sufficient to simulate a C2 channel. Alternative beacon simulators are available in the `shell-scripts` and `python-scripts` directories. 26 | 27 |
28 |
29 | 30 | ## Example Setup 31 | This guide will walk you through setting up a C2 channel with `simple-listener.sh` running on the device acting as the server and `beacon-simulator.py` running on the device acting as the compromised client system. 32 | 33 | ### Setting up the Server 34 | 1. Clone this repository onto the server. 35 | 1. Install `ncat` if it is not already installed. (While `simple-listener.sh` can run with `netcat` and `nc`, it may have issues with UDP timeouts.) 36 | 1. Navigate into the `threat-tools` directory. 37 | 1. Run the following command to set up port 9000 to listen for TCP connections: 38 | ``` 39 | ./simple-listener.sh 9000 40 | ``` 41 | If successful, the console will print `Starting listener on TCP port 9000`. 42 | 43 | ### Setting up the Client 44 | 1. Clone this repository onto the client. 45 | 1. Install `python3` if it is not already installed. Most systems have it. 46 | 1. Navigate into the `threat-tools` directory. 47 | 1. Run the following command, replacing `` with the server's IP address, to establish a TCP beacon with a 30-second interval with 5 seconds of jitter and a maximum payload of 1024 bytes. 48 | ``` 49 | python3 ./beacon-simulator.py -ip -p 9000 -i 30 -j 5 -m 1024 50 | ``` 51 | If successful, the console will start printing a message specifying the amount of jitter, the data sent (a random string of `a`'s), and the total number of beacons sent. 52 | 53 | To close the beacon, use "Ctrl + C" in each terminal to stop the scripts. 54 | 55 | ### Next Steps 56 | To view more detailed information about each script used in this example and how to customize them, you can read their sections of the README: 57 | - [`simple-listener.sh`](#simple-listenersh) 58 | - [`beacon-simulator.py`](#beacon-simulatorpy) 59 | 60 | The README also contains detailed information for all other scripts included in this repository. 61 | 62 |

Back to Top

63 | 64 |
65 |
66 | 67 | ## `simple-listener.sh` 68 | `simple-listener.sh` should run on the machine simulating the C2 server. It will set up a listening port for either TCP or UDP connections. 69 | 70 | It should be used in conjunction with `beacon-simulator.py`, `beacon-simulator.sh`, or `simple-beacon.sh` running on the machine simulating the compromised client. 71 | 72 | ### Dependencies: 73 | Ensure you have the network utility `ncat` installed on the system running the script. 74 | 75 | **NOTE:** While the script can work with `netcat` and `nc`, both have shown issues with handling UDP timeouts. We highly encourage you to install `ncat`. 76 | 77 | ### Command Syntax: 78 | ``` 79 | ./simple-listener.sh 80 | ``` 81 | `port`: The port number you want to set up as the listener. Must be root user to listen on ports <= 1024.
82 | `protocol` (optional): The protocol to listen for. Accepts either `udp` or `tcp`. Defaults to `tcp`. 83 | 84 | ### Example Commands: 85 | ``` 86 | ./simple-listener.sh 9000 udp 87 | ``` 88 | Sets up port 9000 to listen for UDP connections. 89 | 90 | ``` 91 | ./simple-listener.sh 3333 92 | ``` 93 | Sets up port 3333 to listen for TCP connections. 94 | 95 |

Back to Top

96 | 97 |
98 |
99 | 100 | ## `beacon-simulator.py` 101 | `beacon-simulator.py` should run on the machine simulating the compromised client. It will allow you to send a jittered beacon with a payload of random size to the targeted IP. The IP should point to the machine acting as the C2 server running `./simple-listener.sh`. 102 | 103 | ### Dependencies 104 | You will need to use the `python3` interpreter to run the script. Most OS's come with this already installed. You will need to install it if the system running the script does not have it. 105 | 106 | ### Command Syntax 107 | ``` 108 | python3 ./beacon-simulator.py 109 | ``` 110 | `ip`: The IP address of the server.
111 | `port`: The server port listening for the connection.
112 | `interval`: The amount of time in seconds between beacons.
113 | `jitter`: The amount of jitter in seconds.
114 | `max payload`: The beacon's maximum payload size in bytes. The payload is a random string of a's ranging from 0 to the maximum payload size.
115 | `protocol` (optional): The protocol of the beacon. Accepts either `--tcp` or `--udp`. The TCP protocol is used by default.
116 | 117 | ### Example Commands 118 | ``` 119 | python3 ./beacon-simulator.py -ip 192.168.56.104 -p 9000 -i 30 -j 5 -m 1024 120 | ``` 121 | Sends a random payload of up to 1024 bytes to port 9000 on the device at IP 192.168.56.104 every 25-35 seconds using the TCP protocol. 122 | ``` 123 | python3 ./beacon-simulator.py -ip 192.168.56.101 --port 3333 --interval 300 --jitter 8 --max_payload 256 --udp 124 | ``` 125 | Sends a random payload of up to 256 bytes to port 3333 on the device at IP 192.168.56.101 every 292-308 seconds using the UDP protocol. 126 | 127 |

Back to Top

128 | 129 |
130 |
131 | 132 | ## `beacon-simulator.sh` 133 | `beacon-simulator.sh` should run on the machine simulating the compromised client. It will allow you to send a jittered beacon with a payload of random size to the targeted IP. The IP should point to the machine acting as the C2 server running `./simple-listener.sh`. 134 | 135 | ### Dependencies 136 | 137 | Please ensure you have the following tools installed on the system running the script: 138 | 139 | - `ncat`: To make TCP or UDP connections. 140 | - `hping3`: To send ICMP packets. 141 | 142 | **NOTE:** While the script can work with `netcat` and `nc`, both have shown issues with handling UDP timeouts. We highly encourage you to install `ncat`. 143 | 144 | ### Command Syntax 145 | ``` 146 | ./beacon-simulator.sh 147 | ``` 148 | `ip`: The IP address of the server.
149 | `port`: The server port listening for the connection. (Or the ICMP type: 8 = `ping`, 13 = `timestampreq`, 17 = `addrmaskreq`)
150 | `interval`: The amount of time in seconds between beacons.
151 | `jitter`: The amount of jitter in seconds.
152 | `protocol` (optional): The protocol of the beacon. Accepts `tcp`, `udp`, or `icmp`. Defaults to `tcp`.
153 | `max payload` (optional): The beacon's maximum payload size in bytes. The payload is a random string of a's ranging from 0 to the maximum payload size. Defaults to `1424`.
154 | 155 | ### Example Commands 156 | ``` 157 | ./beacon-simulator.sh 192.168.56.104 9000 30 5 158 | ``` 159 | Sends a random payload of up to 1424 bytes to port 9000 on the device at IP 192.168.56.104 every 25-35 seconds using the TCP protocol. 160 | 161 | ``` 162 | ./beacon-simulator.sh 192.168.56.101 3333 300 8 udp 256 163 | ``` 164 | Sends a random payload of up to 256 bytes to port 3333 on the device at IP 192.168.56.101 every 292-308 seconds using the UDP protocol. 165 | 166 | ``` 167 | ./beacon-simulator.sh 192.168.56.102 8 10 2 icmp 168 | ``` 169 | Pings the server at 192.168.56.102 every 8-12 seconds. 170 | 171 |

Back to Top

172 | 173 |
174 |
175 | 176 | ## `simple-beacon.sh` 177 | `simple-beacon.sh` should run on the machine simulating the compromised client. It sends a very simple HTTP request with a custom user-agent string (`Modzilla/0.0001(Atari7800)`) to a specified IP address or FQDN every 200-350 seconds. This script can be used on its own without any additional scripts such as `simple-listener.sh`. 178 | 179 | ### Dependencies 180 | This script uses common utilities commonly pre-installed on Unix-like systems. You should not need to install them. For your reference, the required utilities are: 181 | 182 | - `curl` 183 | - `shuf` 184 | - `sleep` 185 | 186 | #### Command Syntax 187 | ``` 188 | ./simple-beacon.sh 189 | ``` 190 | `IP or FQDN`: The IP address or FQDN of the server. 191 | 192 | #### Example Commands 193 | ``` 194 | ./simple-beacon.sh activecountermeasures.com 195 | ``` 196 | Simulates a jittered beacon by sending HTTP requests to activecountermeasures.com 197 | 198 |

Back to Top

199 | 200 |
201 |
202 | 203 | ## Python Script Pairs 204 | The scripts within the `python-scripts` directory work in pairs. `tcp-client.py` works with `tcp-server.py`, and `udp-client.py` works with `udp-server.py`. Unlike the other threat tools, these scripts can send a beacon to more than one server. Both client scripts will require editing the code so the IP addresses match your server IP(s). You can also edit the code to configure the server port for the C2 channel, the payload size, and the beaconing interval if you disagree with the defaults. 205 | 206 | Default Server Port: 9000
207 | Default Payload Size: 0 - 1200 bytes
208 | Default Beaconing Interval: 30 - 60 seconds 209 | 210 | ### Dependencies 211 | These scripts require the following tools to be installed on both systems. 212 | 213 | - `python3`: Interpreter to run the script. Most systems have this pre-installed. 214 | - `pycryptodome`: Python cryptographic library. 215 | - `pip3`: Needed to install `pycryptodome` if it is not already installed. 216 | 217 | #### Installing `pycryptodome` 218 | If your system does not have `pycryptodome` installed, follow these instructions: 219 | 220 | 1. Install the Python package manager, `pip3`. 221 | 1. Run the following command: 222 | ``` 223 | pip3 install pycryptodome 224 | ``` 225 | 226 | ### Configurations 227 | 228 | #### Configuring the Client Files 229 | 1. On the client device, open `tcp-client.py` or `udp-client.py` in a text editor such as nano. 230 | 1. Navigate to the line starting with `server =` followed by a list of IP addresses and replace them with the IP Address(es) of your server(s). 231 | 1. (optional) Change the server port at the line with `SERVER_PORT = 9000`. (If you change the port number, you *must* edit the corresponding `-server.py` file to match.) 232 | 1. (optional) Change the payload size range at the line with `m = randint(0, 1200)`. 233 | 1. (optional) Change the beaconing interval at the line with `rsleep = random.randint(30, 60)`. 234 | 1. Save the changes and exit. 235 | 236 | #### Configuring Server Files (optional) 237 | NOTE: This is only necessary if you changed the server port number in a `-client.py` script. For example, if you changed the server port in `tcp-client.py`, you *must* edit `tcp-server.py` script to match. 238 | 1. On the server device, open the corresponding `-server.py` file in a text editor such as nano. 239 | 1. Change the server port number at the line with `SERVER_PORT = 9000` to match the number you chose in the corresponding `-client.py` file. 240 | 1. Save the changes and exit. 241 | 242 | ### Running the Script Pairs 243 | 244 | #### TCP Beacon Pair 245 | On the server machine, navigate into the `python-scripts` directory and run: 246 | 247 | ``` 248 | python3 ./tcp-server.py 249 | ``` 250 | 251 | On the client machine, navigate into the `python-scripts` directory and run: 252 | 253 | ``` 254 | python3 ./tcp-client.py 255 | ``` 256 | 257 | #### UDP Beacon Pair 258 | On the server machine, navigate into the `python-scripts` directory and run: 259 | 260 | ``` 261 | python3 ./udp-server.py 262 | ``` 263 | 264 | On the client machine, navigate into the `python-scripts` directory and run: 265 | 266 | ``` 267 | python3 ./udp-client.py 268 | ``` 269 | 270 |

Back to Top

271 | 272 |
273 |
274 | 275 | ## Running Tools in the Background with `screen` 276 | You can use the `screen` utility to run these scripts in a separate session in the background and access it later. To do so, simply add `screen -S -d -m` at the beginning of the command, replacing `` with a name for the session. 277 | 278 | ### Dependencies 279 | You may need to install `screen` if it is not already installed on your system. 280 | 281 | ### Start Session in the Background 282 | ``` 283 | screen -S my-session -d -m ./simple-beacon.sh 192.168.56.104 284 | ``` 285 | This will run `simple-beacon.sh` in the background. 286 | 287 | If you wish to access the session later and turn it off, you can do so by using `screen -r ` to re-attach the session to the terminal window then pressing "Ctrl + C". 288 | 289 | ### Re-attaching the Session 290 | ``` 291 | screen -r my-session 292 | ``` 293 | This will re-attach `my-session` to the terminal window. You can then stop `simple-beacon.sh` by pressing "Ctrl + C". 294 | 295 |

Back to Top

296 | 297 |
298 |
299 | 300 | ## File Name Changes 301 | File names have changed from previous versions in order to be more intuitive and consistent. Returning users can reference the table below to confirm name changes. 302 | 303 | | Old Name | New Name | 304 | | ------------------- | ------------------- | 305 | | beacon_simulator.py | beacon-simulator.py | 306 | | beacon-test | simple-beacon.sh | 307 | | tcp_client.py | tcp-client.py | 308 | | tcp_server.py | tcp-server.py | 309 | | udp_client.py | udp-client.py | 310 | | udp_server.py | udp-server.py | 311 | 312 |

Back to Top

-------------------------------------------------------------------------------- /beacon-simulator.py: -------------------------------------------------------------------------------- 1 | # Based off of beacon-simulator.sh written by Bill Stearns bill@activecountermeasures.com 2 | # Written by Mason Bryan mason.bryan@omegaatc.com 3 | # Released under GPL 3.0 License 4 | # Version 1 5 | 6 | # The payload is a random number of 'a' 's (between 0 and max_payload_size a's). 7 | # Note: the payload _is never sent_ if using TCP and the remote port is closed. 8 | 9 | import socket, time, random, argparse 10 | 11 | parser = argparse.ArgumentParser(description="Example command: 'python3 .\\beacon-simulator.py -ip 192.168.0.5 -p 2000 -i 10 -j 3 -m 1024' or 'python3 .\\beacon-simulator.py -ip 192.168.0.5 -p 2000 --interval 120 --jitter 12 --max_payload 1024 --tcp'") 12 | parser.add_argument("-ip", dest="ip", type=str, help="Use -ip in order to set your target IP address.", required=True) 13 | parser.add_argument("-p", "--port", type=int, dest="port", help="Use -p to specifiy a port for use.", required=True) 14 | parser.add_argument("-i", "--interval", type=int, dest="interval", help="Use -i to specify an interval for the beacon in seconds.", required=True) 15 | parser.add_argument("-j", "--jitter", type=int, dest="jitter", help="Use -j to specify the amount of jitter to be used in seconds.", required=True) 16 | parser.add_argument("--tcp", dest="tcp", action="store_true", help="Use -t to select the tcp protocol. This is optional and TCP is default.", required=False) 17 | parser.add_argument("--udp", dest="udp", action="store_true", help="Use -u to select the udp protocol. This is optional and TCP is default.", required=False) 18 | parser.add_argument("-m", "--max_payload", type=int, dest="max_payload", help="Use -m to set a maximum payload size.", required=True) 19 | args = parser.parse_args() 20 | 21 | server_ip = args.ip 22 | server_port = args.port 23 | max_size = args.max_payload 24 | data = "a" 25 | interval = args.interval 26 | variance = args.jitter 27 | jitter = random.randint(interval - variance, interval + variance) 28 | 29 | def tcp_beacon(): 30 | count = 0 31 | while True: 32 | message_size = random.randint(0,max_size) 33 | message = "".join([data]*message_size) 34 | message = bytes(message, 'utf-8') 35 | jitter = random.randint(interval - variance, interval + variance) 36 | print("amount of jitter: ",jitter) 37 | print("data sent: ",message) 38 | client_tcp = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 39 | client_tcp.connect((server_ip, server_port)) 40 | client_tcp.sendall(message) 41 | client_tcp.close() 42 | count = count +1 43 | print("Number of beacons sent: ",count) 44 | time.sleep(jitter) 45 | 46 | def udp_beacon(): 47 | count = 0 48 | while True: 49 | message_size = random.randint(0,max_size) 50 | message = "".join([data]*message_size) 51 | message = bytes(message, 'utf-8') 52 | jitter = random.randint(interval - variance, interval + variance) 53 | print("Amount of jitter: ",jitter) 54 | print("Data sent: ",message) 55 | client_udp = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) 56 | client_udp.sendto(message, (server_ip, server_port)) 57 | client_udp.close() 58 | count = count +1 59 | print("Number of beacons sent: ",count) 60 | time.sleep(jitter) 61 | 62 | if args.tcp: 63 | tcp_beacon() 64 | elif args.udp: 65 | udp_beacon() 66 | else: 67 | tcp_beacon() -------------------------------------------------------------------------------- /python-scripts/tcp-client.py: -------------------------------------------------------------------------------- 1 | # Framework for this script can be found here https://github.com/awilk54/Cyber550-Assignment-2 2 | # Written by Mason Bryan mason.bryan@omegaatc.com 3 | # Released under GPL 3.0 License 4 | 5 | import socket 6 | import time 7 | import random 8 | import string 9 | 10 | try: 11 | try: 12 | from Cryptodome.Cipher import AES # Windows 13 | except: 14 | from Crypto.Cipher import AES # Linux 15 | except: 16 | print('Missing pycryptodome module. Please run `pip3 install pycryptodome`') 17 | 18 | SERVER_PORT = 9000 # Server Port 19 | CIPHER_KEY = b'bQeThWmZq4t7w!z%C*F-JaNdRfUjXn2r' # Shared encryption/decryption key 20 | NONCE = b'dRgUkXp2s5v8y/B?E(G+KbPeShVmYq3t' # Shared NONCE key for validity 21 | socket.setdefaulttimeout(3) 22 | count = 0 23 | 24 | while True: 25 | server = ['192.168.1.111', '192.168.1.113', '192.168.1.115'] # Enter a single server IP address or multiple server IPs to bounce between 26 | print(random.choice(server)) 27 | SERVER_IP = random.choice(server) 28 | client = socket.socket(socket.AF_INET, socket.SOCK_STREAM) # TCP socket creation 29 | 30 | try: 31 | client.connect((SERVER_IP, SERVER_PORT)) # TCP connection 32 | m = random.randint(0, 1200) # Sets a random size for the payload to be sent back to the server 33 | Message = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(m)) # Creates the string to be sent back to the server 34 | p = random.randint(0, 6) # Generates the number to decide what is going to be sent back to the server from a "command" from the server 35 | # print('number: ', p) # Debug: Prints out the number 36 | # print('message size: ',m) # Debug: Prints out how long the message should be 37 | if p > 4: 38 | Message = Message 39 | else: 40 | Message = 'a' 41 | 42 | while True: 43 | Message = bytes(Message, 'utf-8') # Converts payload to utf-8 for transmission 44 | print('Message sent: ', Message) # Prints the message to be sent 45 | CIPHER = AES.new(CIPHER_KEY, AES.MODE_EAX, NONCE) # AES encryption using EAX mode with predefined cipher key and NONCE key for validation 46 | ciphertext, tag = CIPHER.encrypt_and_digest(Message) # Encrypts the payload 47 | 48 | try: 49 | client.sendall(ciphertext) # Send ciphertext of raw message 50 | try: 51 | data = client.recv(1024) # Client sending cipher message 52 | ciphertext = data 53 | cipher = AES.new(CIPHER_KEY, AES.MODE_EAX, NONCE) # AES encryption using EAX mode -Encrypt/authenticate/translate 54 | plaintext = cipher.decrypt(ciphertext) # Decryption of cipher message passed from client 55 | print('Message recieved: ', plaintext) # Prints message received from server 56 | break 57 | except: 58 | break 59 | except: 60 | break 61 | 62 | client.close() # Closes connection in preparation for next loop iteration 63 | 64 | except: 65 | break 66 | 67 | rsleep = random.randint(30, 60) # Generates the amount of random jitter between 30 and 60 seconds 68 | # print('Sleep time in seconds: 'rsleep) # Debug: Prints how long the sleep will be 69 | count = count + 1 70 | print('Number of beacons sent: ', count) 71 | print() 72 | 73 | time.sleep(rsleep) 74 | -------------------------------------------------------------------------------- /python-scripts/tcp-server.py: -------------------------------------------------------------------------------- 1 | # Framework for this script can be found here https://github.com/awilk54/Cyber550-Assignment-2 2 | # Written by Mason Bryan mason.bryan@omegaatc.com 3 | # Released under GPL 3.0 License 4 | 5 | import socket 6 | import random 7 | import string 8 | 9 | try: 10 | try: 11 | from Cryptodome.Cipher import AES #windows 12 | except: 13 | from Crypto.Cipher import AES #linux 14 | except: 15 | print('Missing pycryptodome module. Please run `pip3 install pycryptodome`') 16 | 17 | TCP_SERVER_IP = '' # Sets IP as the device current IP address 18 | TCP_BUFFER = 1024 # Buffer for receiving data 19 | SERVER_PORT = 9000 # Server Port 20 | CIPHER_KEY = b'bQeThWmZq4t7w!z%C*F-JaNdRfUjXn2r' # Shared Key 32 bytes for 256-bit encryption 21 | NONCE = b'dRgUkXp2s5v8y/B?E(G+KbPeShVmYq3t' # Shared NONCE key for validation. 22 | 23 | while True: 24 | TCPserver = socket.socket(socket.AF_INET, socket.SOCK_STREAM) # Initialize TCP stream 25 | TCPserver.bind((TCP_SERVER_IP, SERVER_PORT)) # Bind TCP Stream connection 26 | TCPserver.listen(1) # Listen for two TCP connections 27 | 28 | while True: 29 | conn, addr = TCPserver.accept() # Connection 1 which is client 30 | m = random.randint(5, 20) # Creates simulated command length 31 | message = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(m)) # Creates simulated command 32 | r1 = random.randint(30, 50) # Sets one side of the buffer length 33 | r2 = random.randint(70, 90) # Sets the other side of the buffer length 34 | message = ')(' + message + ')(' # Creates a way to easily pull out the simulated command 35 | message = message.rjust(r1, 'A') # Applies one side of padding buffer 36 | message = message.ljust(r2, 'B') # Applies one side of padding buffer 37 | message = bytes(message, 'utf-8') # Converts simulated command to utf-8 38 | data = conn.recv(TCP_BUFFER) # Client sending cipher message to server 39 | ciphertext = data 40 | cipher = AES.new(CIPHER_KEY, AES.MODE_EAX, NONCE) # AES encryption using EAX mode -Encrypt/authenticate/translate 41 | plaintext = cipher.decrypt(ciphertext) # Decryption of cipher message passed from client 42 | print('Message from client: ', plaintext) # Prints recieved output from client 43 | print('Message to client: ', message) # Prints message to be sent back to client 44 | CIPHER = AES.new(CIPHER_KEY, AES.MODE_EAX, NONCE) # AES encryption using EAX mode with predefined cipher key and NONCE key for validation 45 | ciphertext, tag = CIPHER.encrypt_and_digest(message) # Encrypting message to send to client 46 | conn.sendall(ciphertext) # Send ciphertext of raw message 47 | print() 48 | -------------------------------------------------------------------------------- /python-scripts/udp-client.py: -------------------------------------------------------------------------------- 1 | # Framework for this script can be found here https://github.com/awilk54/Cyber550-Assignment-2 2 | # Written by Mason Bryan mason.bryan@omegaatc.com 3 | # Released under GPL 3.0 License 4 | 5 | import socket 6 | import random 7 | import time 8 | import string 9 | 10 | try: 11 | try: 12 | from Cryptodome.Cipher import AES # Windows 13 | except: 14 | from Crypto.Cipher import AES # Linux 15 | except: 16 | print('Missing pycryptodome module. Please run `pip3 install pycryptodome`') 17 | 18 | SERVER_PORT = 9000 19 | UDP_BUFFER = 2048 20 | CIPHER_KEY = b'dRgUkXp2s5v8y/B?E(G+KbPeShVmYq3t' # Shared encryption/decryption key 21 | socket.setdefaulttimeout(3) 22 | count = 0 23 | 24 | while True: 25 | server = ['192.168.1.112', '192.168.1.114', '192.168.1.116'] # Enter a single server IP address or multipe server IPs to bounce between 26 | print(random.choice(server)) 27 | UDP_SERVER_IP = random.choice(server) 28 | ClientSocket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) #Create UDP Socket 29 | m = random.randint(0,1200) # Sets a random size for the payload to be sent back to the server 30 | Message = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(m)) # Creates the string to be sent back to the server 31 | p = random.randint(0,6) # Generates the number to decide what is going to be sent back to the server from a "command" from the server 32 | # print('number: ', p) # Debug: prints out the number 33 | # print('message size: ',m) # Debug: prints out how long the message should be 34 | if p > 4: 35 | Message = Message 36 | else: 37 | Message = 'a' 38 | while True: 39 | print('Message sent to server: ', Message) # Prints the message to be sent 40 | Secret_Message = bytes(Message, 'utf-8') # Converts payload to utf-8 for transmission 41 | CIPHER = AES.new(CIPHER_KEY, AES.MODE_EAX) # AES encryption using EAX mode with predefined cipher key for validation 42 | nonce = CIPHER.nonce 43 | ciphertext, tag = CIPHER.encrypt_and_digest(Secret_Message) # Encrypts the payload 44 | ClientSocket.sendto(ciphertext,(UDP_SERVER_IP,SERVER_PORT)) # Send ciphertext 45 | ClientSocket.sendto(nonce,(UDP_SERVER_IP,SERVER_PORT)) # send NONCE 46 | try: 47 | data,addr = ClientSocket.recvfrom(UDP_BUFFER) # Recieving message from server 48 | ciphertext = data 49 | data,addr = ClientSocket.recvfrom(UDP_BUFFER) # Recieving message from server 50 | nonce = data 51 | cipher = AES.new(CIPHER_KEY, AES.MODE_EAX, nonce = nonce) # AES encryption using EAX mode with predefined cipher key and NONCE key for validation 52 | plaintext = cipher.decrypt(ciphertext) # Decryption of cipher message passed from server 53 | payload_data = plaintext.decode('utf-8') # Decode payload data to string 54 | payload_data2 = payload_data.split(',') # Split payload by comma 55 | TEXT = payload_data2[0] 56 | print('Server sent the following message:', TEXT) 57 | break 58 | except: 59 | break 60 | ClientSocket.close() # Closes connection in preparation for next loop iteration 61 | rsleep = random.randint(30,60) # Generates the amount of random jitter between 30 and 60 seconds 62 | # print('Sleep time in seconds: 'rsleep) # Debug: View how long the sleep will be 63 | count = count + 1 64 | print('Number of beacons sent: ', count) 65 | print() 66 | time.sleep(rsleep) 67 | -------------------------------------------------------------------------------- /python-scripts/udp-server.py: -------------------------------------------------------------------------------- 1 | # Framework for this script can be found here https://github.com/awilk54/Cyber550-Assignment-2 2 | # Written by Mason Bryan mason.bryan@omegaatc.com 3 | # Released under GPL 3.0 License 4 | 5 | import socket 6 | import re 7 | 8 | try: 9 | try: 10 | from Cryptodome.Cipher import AES # Windows 11 | except: 12 | from Crypto.Cipher import AES # Linux 13 | except: 14 | print('Missing pycryptodome module. Please run `pip3 install pycryptodome`') 15 | import random 16 | import string 17 | 18 | UDP_SERVER_IP = '' # Sets IP as the device current IP address 19 | UDP_BUFFER = 2048 # Buffer for receiving data 20 | SERVER_PORT = 9000 # Server Port 21 | CIPHER_KEY = b'dRgUkXp2s5v8y/B?E(G+KbPeShVmYq3t' # Shared Key 32 bytes for 256-bit encryption 22 | UDPSocket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) # Create UDP Socket 23 | UDPSocket.bind((UDP_SERVER_IP, SERVER_PORT)) # Bind the socket to IP/Port 24 | 25 | while True: 26 | m = random.randint(5, 20) # Creates simulated command length 27 | message = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(m)) # Creates simulated command 28 | r1 = random.randint(30, 50) # Sets one side of the buffer length 29 | r2 = random.randint(70, 90) # Sets one side of the buffer length 30 | message = ')(' + message + ')(' # Creates a way to easily pull out the simulated command 31 | message = message.rjust(r1, 'A') # Applies one side of padding buffer 32 | message = message.ljust(r2, 'B') # Applies one side of padding buffer 33 | message = bytes(message, 'utf-8') # Converts simulated command to utf-8 34 | data, addr = UDPSocket.recvfrom(UDP_BUFFER) # Recieving message from client 35 | ciphertext = data 36 | data, addr = UDPSocket.recvfrom(UDP_BUFFER) # Recieving nonce from client 37 | nonce = data 38 | cipher = AES.new(CIPHER_KEY, AES.MODE_EAX, nonce = nonce) # AES encryption using EAX mode -Encrypt/authenticate/translate 39 | plaintext = cipher.decrypt(ciphertext) # Decryption of cipher message passed from client 40 | CIPHER = AES.new(CIPHER_KEY, AES.MODE_EAX) # AES encryption using EAX mode -Encrypt/authenticate/translate 41 | nonce = CIPHER.nonce 42 | ciphertext, tag = CIPHER.encrypt_and_digest(message) # Encrypting message to send to client 43 | UDPSocket.sendto(ciphertext,addr) # Send ciphertext 44 | UDPSocket.sendto(nonce,addr) # Send NONCE 45 | try: 46 | plaintext = plaintext.decode('utf-8') 47 | plaintext = plaintext.split(',') # Split payload by comma 48 | plaintext = plaintext[0] 49 | plaintext = re.sub('[^A-Za-z0-9]+', '', plaintext) 50 | print() 51 | print('Message from client: ', plaintext) 52 | print('Message to client: ', message) 53 | except: 54 | continue -------------------------------------------------------------------------------- /shell-scripts/beacon-simulator.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Copyright 2021 Active Countermeasures 4 | # Written by Bill Stearns bill@activecountermeasures.com 5 | # Based on ideas from Chris Brenton 6 | # Released under GPL 3.0 License 7 | # v0.8.0 8 | 9 | # The payload is a random number of 'a' 's (between 0 and max_payload_size a's). 10 | # Note: the payload _is never sent_ if using TCP and the remote port is closed. 11 | 12 | Usage () { 13 | echo 'Parameters:' >&2 14 | echo ' 1: target ip' >&2 15 | echo ' 2: port (or icmp type: 8=ping, 13=timestampreq, 17=addrmaskreq)' >&2 16 | echo ' 3: interval' >&2 17 | echo ' 4: jitter (max deviation from interval)' >&2 18 | echo ' 5: optional protocol (default is tcp ; put udp or icmp here if you want those)' >&2 19 | echo ' (you must specify tcp or udp if you want to force max_payload_size)' >&2 20 | echo ' 6: max_payload_size (a payload with a random number of characters between 0 bytes and this value will be sent)' >&2 21 | echo '' >&2 22 | echo 'Examples:' >&2 23 | echo "$0 192.168.0.1 9999 150 12" >&2 24 | echo "$0 192.168.0.7 514 200 10 udp" >&2 25 | echo "$0 192.168.0.7 9999 150 12 tcp 1000" >&2 26 | exit 1 27 | } 28 | 29 | if which ncat >/dev/null ; then 30 | netcat_bin=`which ncat` 31 | elif which nc >/dev/null ; then 32 | netcat_bin=`which nc` 33 | elif which netcat >/dev/null ; then 34 | netcat_bin=`which netcat` 35 | elif [ -n "$BASH_VERSION" ]; then 36 | netcat_bin='' #We'll use bash's built-in ability to make TCP connections 37 | else 38 | echo 'Unable to locate netcat and not running under bash, exiting.' >&2 39 | exit 1 40 | fi 41 | 42 | 43 | if [ "z$1" = "z--help" -o "z$1" = "z-h" ]; then 44 | Usage 45 | elif [ -z "$4" -o -n "$7" ]; then 46 | echo "Incorrect number of parameters, exiting." 47 | Usage 48 | fi 49 | 50 | if [ "$3" -lt "$4" ]; then 51 | echo 'Jitter cannot be greater than the interval, exiting.' >&2 52 | exit 1 53 | fi 54 | 55 | if [ "$5" = "udp" -o "$5" = "UDP" ]; then 56 | proto_flag=' -u ' 57 | proto_acronym='udp' 58 | elif [ "$5" = "icmp" -o "$5" = "ICMP" ]; then 59 | if ! which hping3 >/dev/null ; then 60 | echo "ICMP requested but hping3 is not installed. Please run 'sudo yum -y install hping3', 'sudo apt -y install hping3', or 'sudo port install hping3'." 61 | exit 1 62 | fi 63 | proto_acronym='icmp' 64 | if [ "$2" = "8" -o "$2" = "ping" -o "$2" = "echo" ]; then 65 | icmp_type="8" 66 | elif [ "$2" = "13" -o "$2" = "17" ]; then 67 | icmp_type="$2" 68 | else 69 | icmp_type="8" #Fall back on ping 70 | fi 71 | else 72 | proto_flag=' ' 73 | proto_acronym='tcp' 74 | fi 75 | 76 | if [ -n "$6" ]; then 77 | if [[ $6 =~ ^0+$ ]]; then 78 | max_payload_size="none" 79 | #random_divisor="1" #Won't be used 80 | elif [[ $6 =~ ^[[:digit:]]+$ ]]; then 81 | max_payload_size="$6" 82 | #random_divisor=$((32767 / $max_payload_size)) 83 | else 84 | echo "max_payload_size field contains non-digits: $6 . Exiting." >&2 85 | exit 1 86 | fi 87 | else 88 | max_payload_size="1424" 89 | #random_divisor="23" 90 | fi 91 | 92 | echo "Will connect to host $1, $proto_acronym port $2 every $3 +/-(${4}) seconds, max payload of $max_payload_size bytes." >&2 93 | while : ; do 94 | if [ "$max_payload_size" = "none" ]; then 95 | random_payload='' 96 | else 97 | #Note - we stopped using $RANDOM as it's limited to 0-32767, so can never generate payloads larger than 32767 bytes: 98 | #random_payload=`dd if=/dev/zero bs=1 count=$[ $RANDOM / $random_divisor ] 2>/dev/null | tr '\0' 'a'` #Creates between 0 and max_payload_size letter a's as a payload 99 | #Instead we pul bytes from /dev/urandom to generate payloads from 0 to max_payload_size bytes, inclusive.: 100 | random_payload="$(dd if=/dev/zero bs=1 count=$(( $(od -A n -t d -N 3 /dev/urandom) % ($max_payload_size + 1) )) 2>/dev/null | tr '\0' 'a')" #Creates between 0 and max_payload_size (inclusive) letter a's as a payload 101 | fi 102 | 103 | if [ "$proto_acronym" = "icmp" ]; then 104 | sudo hping3 --icmp --icmptype "$2" -c 1 -n -q -e "$random_payload" "$1" >/dev/null 2>&1 105 | elif [ -n "$netcat_bin" ]; then 106 | if [ "$proto_acronym" = "udp" ]; then 107 | echo -n "$random_payload" | "$netcat_bin" $proto_flag "$1" "$2" >/dev/null 2>/dev/null 108 | else 109 | echo -n "$random_payload" | "$netcat_bin" $proto_flag -w 10 "$1" "$2" >/dev/null 2>/dev/null 110 | fi 111 | else 112 | if [ "$proto_acronym" = "udp" ]; then 113 | #For some reason the packet is never sent if stdout is redirected to /dev/null 114 | echo -n "$random_payload" >"/dev/$proto_acronym/$1/$2" 115 | else 116 | echo -n "$random_payload" >"/dev/$proto_acronym/$1/$2" 2>/dev/null 117 | fi 118 | fi 119 | 120 | echo -n '.' 121 | naptime=$[ (($RANDOM * $4 * 2) / 32767) - ($4) + $3 ] #"random value between 0 and 1 * 2x jitter", minus 1x jitter plus interval 122 | #echo "Sleeping for $naptime" 123 | sleep "$naptime" 124 | done 125 | -------------------------------------------------------------------------------- /shell-scripts/simple-beacon.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Copyright 2023, Chris Brenton 4 | # Released under GPL 3.0 License 5 | 6 | # Command syntax: 7 | # /path/to/simple-beacon.sh 8 | 9 | while : 10 | do 11 | curl -A 'Modzilla/0.0001 (Atari 7800)' $1 >/dev/null 2>&1 12 | sleep $(shuf -i200-350 -n1) 13 | done -------------------------------------------------------------------------------- /simple-listener.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Copyright 2022, Active Countermeasures 4 | # Written by Bill Stearns bill@activecountermeasures.com 5 | # Released under GPL 3.0 License 6 | # Version 0.1 7 | 8 | # Sets up a simple listening TCP or UDP port suitable for accepting a connections from beacon-simulator.sh 9 | 10 | 11 | Usage() { 12 | echo 'Parameters:' >&2 13 | echo ' Port number to listen on (on all platforms except windows you must be root to listen on ports <=1024)' >&2 14 | echo ' Protocol (UDP or TCP, default is TCP)' >&2 15 | exit 1 16 | } 17 | 18 | 19 | if which ncat >/dev/null ; then 20 | netcat_bin=`which ncat` 21 | elif which nc >/dev/null ; then 22 | if [ "$2" = "udp" -o "$2" = "UDP" ]; then 23 | echo "The 'nc' form of netcat may not correctly handle udp timeouts correctly. Please install 'ncat'" >&2 24 | fi 25 | netcat_bin=`which nc` 26 | elif which netcat >/dev/null ; then 27 | if [ "$2" = "udp" -o "$2" = "UDP" ]; then 28 | echo "The 'netcat' form of netcat may not correctly handle udp timeouts correctly. Please install 'ncat'" >&2 29 | fi 30 | netcat_bin=`which netcat` 31 | else 32 | echo 'Unable to locate netcat, exiting.' >&2 33 | exit 1 34 | fi 35 | 36 | 37 | if [ -z "$1" -o -n "$3" ]; then 38 | Usage 39 | fi 40 | 41 | listen_port="$1" 42 | if [ "$2" = "udp" -o "$2" = "UDP" ]; then 43 | listen_proto='UDP' 44 | listen_param=' -u -i 3 ' 45 | elif [ "$2" = "tcp" -o "$2" = "TCP" -o "$2" = '' ]; then 46 | listen_proto='TCP' 47 | listen_param=' -k ' 48 | else 49 | Usage 50 | fi 51 | 52 | 53 | while : ; do 54 | echo "Starting listener on $listen_proto port $listen_port" >&2 55 | $netcat_bin -l $listen_param $listen_port /dev/null 2>&1 56 | done 57 | 58 | 59 | 60 | --------------------------------------------------------------------------------