├── LICENSE.txt ├── README.md ├── bin ├── cmd_mockle_create.js └── cmd_mockle_spoof.js ├── example ├── example.mock └── mock.js ├── index.js ├── logging.js ├── mock.js ├── package.json └── profiler.js /LICENSE.txt: -------------------------------------------------------------------------------- 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 | Mockle Library 2 | ============== 3 | 4 | Mockle is a node.js library that provides an easy way to spoof existing Bluetooth LE devices. 5 | 6 | It relies on *Bleno.js* library (https://github.com/sandeepmistry/bleno). 7 | 8 | How to install 9 | -------------- 10 | 11 | Follow [*Bleno.js* install steps](https://github.com/sandeepmistry/bleno/blob/master/README.md). 12 | 13 | ``` 14 | $ git clone https://github.com/DigitalSecurity/mockle.git 15 | $ cd mockle 16 | $ sudo npm install -g 17 | ``` 18 | 19 | You're ready to go ! 20 | 21 | How to use Mockle 22 | ----------------- 23 | 24 | Mockle provides two CLI tools: 25 | 26 | * mockle-create: use this command-line tool to create a profile (.mock file) from an existing and available Bluetooth LE device 27 | * mockle-spoof: use this command-line tool to basically spoof an existing device from a profile file 28 | 29 | As an example, we have included an example spoofing an existing device. 30 | 31 | 32 | -------------------------------------------------------------------------------- /bin/cmd_mockle_create.js: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env node 2 | 3 | /** 4 | * mockle-create 5 | * 6 | * This command-line tool may be used to create profile files (.mock) of 7 | * devices in order to clone them. 8 | **/ 9 | 10 | var argparse = require('argparse'); 11 | var jsonfile = require('jsonfile'); 12 | var BleProfiler = require('../profiler'); 13 | 14 | /** 15 | * Command-line tool 16 | **/ 17 | var parser = new argparse.ArgumentParser({ 18 | version: '0.1', 19 | addHelp: true, 20 | description: 'Mockle device duplicator tool.' 21 | }); 22 | parser.addArgument(['-o', '--output'], { 23 | help: 'Mock settings output file', 24 | }) 25 | parser.addArgument(['-t', '--target'], { 26 | help: 'Mac address of the device to duplicate', 27 | required: true, 28 | }) 29 | args = parser.parseArgs(); 30 | if (args.target != null) { 31 | /* Check that args.target matches a BT MAC */ 32 | if (args.target.match(/([0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2})/i)) { 33 | console.log(('Profiling target ' + args.target + '...').bold); 34 | var prof = new BleProfiler(args.target); 35 | prof.getConfig(function(error, config){ 36 | if (error == undefined) { 37 | if (args.output != null) 38 | configFilename = args.output; 39 | else  { 40 | configFilename = args.target 41 | .toLowerCase().split(':').join('') + '.mock'; 42 | } 43 | jsonfile.writeFileSync(configFilename, config); 44 | console.log(('[i] Device information extracted to '+configFilename).green); 45 | process.exit(0); 46 | } 47 | }); 48 | } else { 49 | console.log('[!] Target address is not a valid MAC address !'.red); 50 | process.exit(-1); 51 | } 52 | } else { 53 | parser.printUsage(); 54 | process.exit(0); 55 | } 56 | -------------------------------------------------------------------------------- /bin/cmd_mockle_spoof.js: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env node 2 | 3 | /** 4 | * mockle-spoof 5 | * 6 | * This command-line tool is a very basic BLE device cloner that relies on a 7 | * mock file to clone an existing device. Only services, characteristics and 8 | * descriptors are cloned, it's up to you to implement the logic inside your 9 | * clone to mimic the original device. 10 | **/ 11 | 12 | var argparse = require('argparse'); 13 | var util = require('util'); 14 | var colors = require('colors'); 15 | 16 | 17 | /** 18 | * Command-line tool 19 | **/ 20 | var parser = new argparse.ArgumentParser({ 21 | version: '0.1', 22 | addHelp: true, 23 | description: 'Mockle device duplicator tool.' 24 | }); 25 | parser.addArgument(['-d', '--device-id'], { 26 | help: 'Device id (hci0 -> 0)', 27 | }); 28 | parser.addArgument(['-m', '--mock-file'], { 29 | help: 'Mock file (created by mockle-create)', 30 | required: true, 31 | }); 32 | args = parser.parseArgs(); 33 | if (args.mock_file != null) { 34 | /* Select device if provided. */ 35 | if (args.device_id != null) { 36 | process.env['BLENO_HCI_DEVICE_ID'] = args.device_id; 37 | console.log(util.format('[setup] using device #%d', args.device_id).green); 38 | } 39 | 40 | /* Create our mock. */ 41 | var BleMock = require('../mock'); 42 | var mock = new BleMock(args.mock_file, args.proxy); 43 | mock.start(); 44 | } else { 45 | parser.printUsage(); 46 | process.exit(0); 47 | } 48 | -------------------------------------------------------------------------------- /example/example.mock: -------------------------------------------------------------------------------- 1 | {"ad_records":"020106110745fa56c1fb1bc02896a867180128174f","scan_data":"09ffabbab75ff60f10f5","services":[{"uuid":"1802","characteristics":[{"uuid":"2a06","properties":["writeWithoutResponse"],"descriptors":[]}]},{"uuid":"1803","characteristics":[{"uuid":"2a06","properties":["read","write"],"descriptors":[]}]},{"uuid":"180f","characteristics":[{"uuid":"2a19","properties":["read","notify"],"descriptors":["2902"]}]},{"uuid":"4f1728011867a89628c01bfbc156fa45","characteristics":[{"uuid":"4f1724911867a89628c01bfbc156fa45","properties":["read","notify"],"descriptors":["2902"]}]},{"uuid":"b0ad152399b27e1dfc0d6d399e1edf02","characteristics":[{"uuid":"b0ad152499b27e1dfc0d6d399e1edf02","properties":["read","notify"],"descriptors":["2902"]},{"uuid":"b0ad152599b27e1dfc0d6d399e1edf02","properties":["read","write"],"descriptors":[]},{"uuid":"b0ad152699b27e1dfc0d6d399e1edf02","properties":["read","write"],"descriptors":[]}]},{"uuid":"899433002d54b8cb3af2212144c5ca13","characteristics":[{"uuid":"899433012d54b8cb3af2212144c5ca13","properties":["read","write"],"descriptors":[]},{"uuid":"899433022d54b8cb3af2212144c5ca13","properties":["read","notify"],"descriptors":["2902"]},{"uuid":"899433042d54b8cb3af2212144c5ca13","properties":["read","write"],"descriptors":[]},{"uuid":"899433032d54b8cb3af2212144c5ca13","properties":["read","notify"],"descriptors":["2902"]},{"uuid":"899433052d54b8cb3af2212144c5ca13","properties":["read","write"],"descriptors":[]},{"uuid":"899433062d54b8cb3af2212144c5ca13","properties":["read","write"],"descriptors":[]}]},{"uuid":"7b12256866777f8cf8e9af0eedb36e3a","characteristics":[{"uuid":"7b12199066777f8cf8e9af0eedb36e3a","properties":["write"],"descriptors":[]},{"uuid":"7b12199166777f8cf8e9af0eedb36e3a","properties":["read"],"descriptors":[]},{"uuid":"7b12199266777f8cf8e9af0eedb36e3a","properties":["read"],"descriptors":[]},{"uuid":"7b12199366777f8cf8e9af0eedb36e3a","properties":["read","write"],"descriptors":[]},{"uuid":"7b12199466777f8cf8e9af0eedb36e3a","properties":["read"],"descriptors":[]},{"uuid":"7b12199566777f8cf8e9af0eedb36e3a","properties":["read"],"descriptors":[]},{"uuid":"7b12199666777f8cf8e9af0eedb36e3a","properties":["read"],"descriptors":[]},{"uuid":"7b12199766777f8cf8e9af0eedb36e3a","properties":["write"],"descriptors":[]},{"uuid":"7b12199866777f8cf8e9af0eedb36e3a","properties":["read"],"descriptors":[]}]}],"address":"f5:10:0f:f6:5f:b7"} 2 | -------------------------------------------------------------------------------- /example/mock.js: -------------------------------------------------------------------------------- 1 | /* 2 | * This example is a quick demo of how to emulate a device (read-only) with Mockle. 3 | * 4 | * More info will be available soon after the NDH2016 conference ;) 5 | * 6 | */ 7 | 8 | const mockle = require('mockle').BleMock(); 9 | 10 | var mock = new mockle('./example.mock'); 11 | 12 | /* Handles read operation on some services. */ 13 | mock.on('read', function(service, characteristic, offset, callback) { 14 | switch(service) { 15 | /* Battery service. */ 16 | case '180f': 17 | switch(characteristic) { 18 | case '2a19': 19 | callback(mock.RESULT_SUCCESS, new Buffer([0x64])); 20 | break; 21 | } 22 | break; 23 | 24 | /* Link Loss. */ 25 | case '1803': 26 | if (characteristic == '2a06') { 27 | callback(mock.RESULT_SUCCESS, new Buffer([0x00, 0x00])); 28 | break; 29 | } else { 30 | callback(mock.RESULT_UNLIKELY_ERROR); 31 | } 32 | break; 33 | 34 | case '4f1728011867a89628c01bfbc156fa45': 35 | callback(mock.RESULT_SUCCESS, new Buffer([0x00, 0x00])); 36 | break; 37 | 38 | case 'b0ad152499b27e1dfc0d6d399e1edf02': 39 | callback(mock.RESULT_SUCCESS, new Buffer([0x00, 0x00])); 40 | break; 41 | 42 | case '7b12256866777f8cf8e9af0eedb36e3a': 43 | switch(characteristic) { 44 | case '7b12199166777f8cf8e9af0eedb36e3a': 45 | callback(mock.RESULT_SUCCESS, new Buffer([0x01, 0x03])); 46 | break; 47 | 48 | case '7b12199266777f8cf8e9af0eedb36e3a': 49 | callback(mock.RESULT_SUCCESS, new Buffer( [0x4e, 0x6f,0x76,0x20,0x20,0x33,0x20,0x32,0x30,0x31,0x34,0x00])); 50 | break; 51 | } 52 | break; 53 | 54 | } 55 | }.bind(this)); 56 | 57 | mock.start(); 58 | 59 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | function BleMock() { 2 | var blemock = require('./mock'); 3 | return blemock; 4 | } 5 | 6 | function BleProfiler() { 7 | var bleprofiler = require('./profiler'); 8 | return bleprofiler; 9 | } 10 | 11 | module.exports = { 12 | BleMock: BleMock, 13 | BleProfiler: BleProfiler, 14 | }; 15 | -------------------------------------------------------------------------------- /logging.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Logging module. 3 | **/ 4 | 5 | var winston = require('winston'); 6 | 7 | function mockleFormatter(options) { 8 | if (options.level == 'info') 9 | return options.timestamp() + ' '+(undefined !== options.message?options.message:''); 10 | else 11 | return options.timestamp() + ' ['+options.level.toUpperCase() + '] '+(undefined !== options.message?options.message:''); 12 | } 13 | 14 | var getLogger = function(logfile) { 15 | winston.add(winston.transports.File, { 16 | filename: logfile, 17 | json: false, 18 | formatter: mockleFormatter, 19 | timestamp: function() { 20 | return Date.now(); 21 | }, 22 | }); 23 | return winston; 24 | } 25 | 26 | module.exports = getLogger; 27 | -------------------------------------------------------------------------------- /mock.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Mockle BLE mocking class 3 | * 4 | * The BleMock class takes a device profile in input and create a pure NodeJS 5 | * clone uppon which high-level behaviors may be implemented. 6 | **/ 7 | 8 | var async = require('async'); 9 | var events = require('events'); 10 | var bleno = require('bleno'); 11 | var util = require('util'); 12 | var jsonfile = require('jsonfile'); 13 | var colors = require('colors'); 14 | var io = require('socket.io-client'); 15 | var logging = require('./logging'); 16 | 17 | var args = process.argv.slice(2); 18 | var deviceMac = args[0]; 19 | 20 | /** 21 | * Mockle device emulator 22 | **/ 23 | 24 | var BleMock = function(configFile) { 25 | events.EventEmitter.call(this); 26 | 27 | /* Logger */ 28 | this.logger = logging('test.log'); 29 | 30 | /* Update callbacks. */ 31 | this.subsCallbacks = {}; 32 | 33 | /* Propagate bleno constants. */ 34 | this.RESULT_SUCCESS = bleno.Characteristic.RESULT_SUCCESS; 35 | this.RESULT_INVALID_OFFSET = bleno.Characteristic.RESULT_INVALID_OFFSET; 36 | this.RESULT_INVALID_ATTRIBUTE_LENGTH = bleno.Characteristic.RESULT_INVALID_ATTRIBUTE_LENGTH; 37 | this.RESULT_UNLIKELY_ERROR = bleno.Characteristic.RESULT_UNLIKELY_ERROR; 38 | 39 | /* Read config file (json) */ 40 | this.config = jsonfile.readFileSync(configFile); 41 | if (this.config['name'] != null) { 42 | console.log(('[setup] creating mock for device ' + this.config['name'] + ' (' + this.config['address'] + ')').bold); 43 | } else { 44 | console.log(('[setup] creating mock for device ' + this.config['address']).bold); 45 | } 46 | 47 | /* Change environment variable to force device name. */ 48 | process.env['BLENO_DEVICE_NAME'] = this.config.name; 49 | }; 50 | 51 | util.inherits(BleMock, events.EventEmitter); 52 | 53 | /** 54 | * start() 55 | * 56 | * Starts the mock: 57 | * - load config file 58 | * - create the mock 59 | * - advertise the exact same data as the original 60 | * - handles connections 61 | **/ 62 | 63 | BleMock.prototype.start = function() { 64 | 65 | /* Set services as described in config file. */ 66 | this.services = []; 67 | for (var service in this.config['services']) { 68 | /* Get service information. */ 69 | var _service = this.config['services'][service]; 70 | 71 | /* Create the service structure. */ 72 | var service_details = { 73 | uuid: _service['uuid'], 74 | characteristics: [], 75 | }; 76 | 77 | /* Add characteristics. */ 78 | for (var charac in _service['characteristics']) { 79 | var service_char_item = {}; 80 | service_char_item['uuid'] = _service['characteristics'][charac]['uuid']; 81 | service_char_item['properties'] = _service['characteristics'][charac]['properties']; 82 | service_char_item['descriptors'] = []; 83 | for (var desc in _service['characteristics'][charac]['descriptors']) { 84 | service_char_item['descriptors'].push( 85 | new bleno.Descriptor({ 86 | uuid: _service['characteristics'][charac]['descriptors'][desc], 87 | value: 'notifs' 88 | }) 89 | ); 90 | } 91 | 92 | /* Install characteristic read callback if required. */ 93 | if (service_char_item['properties'].indexOf('read') > -1) { 94 | service_char_item['onReadRequest'] = (function(_this, service, characteristic){ 95 | return function(offset, callback) { 96 | _this.onRead(service, characteristic, offset, callback); 97 | } 98 | })(this, _service['uuid'], _service['characteristics'][charac]['uuid']); 99 | } 100 | 101 | /* Install characteristic write callback if required. */ 102 | if ((service_char_item['properties'].indexOf('write') > -1) || (service_char_item['properties'].indexOf('writeWithoutResponse') > -1)) { 103 | service_char_item['onWriteRequest'] = (function(_this, service, characteristic){ 104 | return function(data, offset, withoutResponse, callback){ 105 | _this.onWrite(service, characteristic, data, offset, withoutResponse, callback); 106 | } 107 | })(this, _service['uuid'], _service['characteristics'][charac]['uuid']); 108 | } 109 | 110 | /* Install characteristic notify callback if required. */ 111 | if (service_char_item['properties'].indexOf('notify') > -1) { 112 | service_char_item['onSubscribe'] = (function(_this, service, characteristic){ 113 | return function(maxValueSize, updateValueCallback){ 114 | _this.onSubscribe(service, characteristic, maxValueSize, updateValueCallback); 115 | } 116 | })(this, _service['uuid'], _service['characteristics'][charac]['uuid']); 117 | service_char_item['onNotify'] = (function(_this, service, characteristic){ 118 | return function(maxValueSize, updateValueCallback){ 119 | _this.onNotify(service, characteristic); 120 | } 121 | })(this, _service['characteristics'][charac]['uuid']); 122 | } 123 | 124 | /* Register the service in bleno. */ 125 | service_details['characteristics'].push( 126 | new bleno.Characteristic(service_char_item) 127 | ); 128 | } 129 | 130 | this.services.push(new bleno.PrimaryService(service_details)); 131 | } 132 | 133 | /* Advertise our mocked device. */ 134 | var scan_data = new Buffer(this.config['scan_data'], 'hex'); 135 | 136 | bleno.on('advertisingStart', (function(_this){ 137 | return function(error){ 138 | if (!error) { 139 | console.log('[setup] services registered'.yellow); 140 | bleno.setServices(_this.services); 141 | } else { 142 | console.log('[setup] error while registering services !'.red); 143 | } 144 | }; 145 | })(this)); 146 | 147 | /* Notify the console that we've accepted a connection. */ 148 | bleno.on('accept', function(clientAddress) { 149 | console.log(("[ mock] accepted connection from address: " + clientAddress).green); 150 | }); 151 | 152 | /* Notify the console that we have disconnected from a client. */ 153 | bleno.on('disconnect', function(clientAddress) { 154 | console.log(("[ mock] disconnected from address: " + clientAddress).red); 155 | }); 156 | 157 | 158 | bleno.on('stateChange', (function(_this, adv_data, scan_data){ 159 | return function(state){ 160 | if (state === 'poweredOn') { 161 | bleno.startAdvertisingWithEIRData(adv_data, scan_data); 162 | } else { 163 | bleno.stopAdvertising(); 164 | } 165 | }; 166 | })(this, new Buffer(this.config['ad_records'], 'hex'), scan_data)); 167 | 168 | }; 169 | 170 | /** 171 | * BleMock default handlers. 172 | **/ 173 | 174 | BleMock.prototype.onRead = function(service, characteristic, offset, callback) { 175 | /* Emit a read event (global). */ 176 | this.emit('read', service, characteristic, offset, callback); 177 | 178 | /* Emit a service-specific event. */ 179 | this.emit(service, 'read', characteristic, offset, callback); 180 | }; 181 | 182 | /** 183 | * onWrite() 184 | * 185 | * Called when a connected device asks for a write operation. 186 | **/ 187 | 188 | BleMock.prototype.onWrite = function(service, characteristic, data, offset, withoutResponse, callback) { 189 | /* Emit a write event (global). */ 190 | this.emit('write', service, characteristic, data, offset, withoutResponse, callback); 191 | 192 | /* Emit a service-specific event. */ 193 | this.emit(service, 'write', characteristic, data, offset, withoutResponse, callback); 194 | }; 195 | 196 | /** 197 | * onSubscribe() 198 | * 199 | * Called when a connected device subscribes for notification to a specific 200 | * characteristic 201 | */ 202 | 203 | BleMock.prototype.onSubscribe = function(service, characteristic, maxValueSize, updateValueCallback) { 204 | /* Emit a subscribe event (global). */ 205 | this.emit('subscribe', service, characteristic, maxValueSize, updateValueCallback); 206 | 207 | /* Emit a service-specific event. */ 208 | this.emit(service, 'subscribe', characteristic, maxValueSize, updateValueCallback); 209 | }; 210 | 211 | /** 212 | * onUnsubscribe() 213 | * 214 | * Called when a connected device unsubscribes for notification. 215 | **/ 216 | 217 | BleMock.prototype.onUnsubscribe = function(service, characteristi) { 218 | /* Emit a subscribe event (global). */ 219 | this.emit('unsubscribe', service, characteristic); 220 | 221 | /* Emit a service-specific event. */ 222 | this.emit(service, 'unsubscribe', characteristic); 223 | }; 224 | 225 | /** 226 | * onNotify() 227 | * 228 | * Called when the device provides a notification to the connected device. 229 | **/ 230 | 231 | BleMock.prototype.onNotify = function(service, characteristic) { 232 | /* Emit a notify event (global). */ 233 | this.emit('notify', service, characteristic); 234 | 235 | /* Emit a service-specific event. */ 236 | this.emit(service, 'notify', characteristic); 237 | }; 238 | 239 | 240 | /** 241 | * registerNotifyCallback() 242 | * 243 | * Registers a notification callback for a given service and characteristic. 244 | **/ 245 | 246 | BleMock.prototype.registerNotifyCallback = function(service, characteristic, callback) { 247 | if (!(service in this.subsCallbacks)) { 248 | this.subsCallbacks[service] = {}; 249 | } 250 | this.subsCallbacks[service][characteristic] = callback; 251 | } 252 | 253 | /** 254 | * getCallback() 255 | * 256 | * Retrieve the registered notification callback for a given service 257 | * and characteristic. 258 | **/ 259 | 260 | BleMock.prototype.getCallback = function(service, characteristic) { 261 | if (service in this.subsCallbacks) { 262 | if (characteristic in this.subsCallbacks[service]) { 263 | /* Callback exists, return. */ 264 | return this.subsCallbacks[service][characteristic]; 265 | } 266 | } 267 | 268 | /* No callback found. */ 269 | return null; 270 | } 271 | 272 | /** 273 | * unregisterNotifyCallback() 274 | * 275 | * Unregister a previously registered notification callback. 276 | **/ 277 | 278 | BleMock.prototype.unregisterNotifyCallback = function(service, characteristic, callback) { 279 | if (service in this.subsCallbacks) { 280 | if (characteristic in this.subsCallbacks[service]) { 281 | this.subsCallbacks[service][characteristic] = null; 282 | } 283 | } 284 | } 285 | 286 | module.exports = BleMock; 287 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "mockle", 3 | "version": "0.1.0", 4 | "description": "Bluetooth Low-Energy spoofing framework", 5 | "main": "index.js", 6 | "bin": { 7 | "mockle-create": "bin/cmd_mockle_create.js", 8 | "mockle-spoof": "bin/cmd_mockle_spoof.js" 9 | }, 10 | "dependencies": { 11 | "argparse": "^1.0.7", 12 | "async": "^1.5.2", 13 | "bleno": "0.4.0", 14 | "colors": "^1.1.2", 15 | "jsonfile": "^2.2.3", 16 | "noble": "^1.3.0", 17 | "socket.io": "^1.4.5", 18 | "socket.io-client": "^1.4.5", 19 | "winston": "^2.2.0" 20 | }, 21 | "devDependencies": {}, 22 | "scripts": { 23 | "test": "echo 'no test command'; exit 1;" 24 | }, 25 | "keywords": [ 26 | "bluetooth", 27 | "le", 28 | "spoofing", 29 | "mitm" 30 | ], 31 | "author": "Damien Cauquil ", 32 | "license": "MIT" 33 | } 34 | -------------------------------------------------------------------------------- /profiler.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Mockle profiler 3 | * 4 | * The BleProfiler class allows BTLE device profiling, i.e. gathering all the 5 | * required information to basically clone a device. 6 | * 7 | * Combined with the BleMock class, it makes it easy to create clones that 8 | * implement a high-level logic and state machines. 9 | * 10 | * This class may be used in projects or directly by using the `mockle-create` 11 | * tool provided in this package. 12 | **/ 13 | 14 | var async = require('async'); 15 | var events = require('events'); 16 | var noble = require('noble'); 17 | var util = require('util'); 18 | var colors = require('colors'); 19 | 20 | /** 21 | * Mockle BleProfiler 22 | **/ 23 | 24 | var BleProfiler = function(target){ 25 | /* Device array. */ 26 | this.target = target.toLowerCase(); 27 | this.devices = {}; 28 | this.currentDevice = null; 29 | this.configCallback = null; 30 | }; 31 | 32 | util.inherits(BleProfiler, events.EventEmitter); 33 | 34 | /** 35 | * Get a profile from a device. 36 | **/ 37 | 38 | BleProfiler.prototype.getConfig = function(callback){ 39 | this.configCallback = callback; 40 | 41 | /* Start scanning when ble device is ready. */ 42 | noble.on('stateChange', function(state) { 43 | if (state === 'poweredOn') { 44 | noble.startScanning(); 45 | } else { 46 | noble.stopScanning(); 47 | } 48 | }); 49 | 50 | /* Track BLE advertisement reports. */ 51 | noble._bindings._gap._hci.on( 52 | 'leAdvertisingReport', 53 | function(status, type, address, addressType, report, rssi){ 54 | this.discoverDeviceAdv(address, report, rssi); 55 | }.bind(this)); 56 | 57 | /* Track BLE advertisement reports. */ 58 | noble.on('discover', function(peripheral){ 59 | this.discoverDevice(peripheral); 60 | }.bind(this)); 61 | }; 62 | 63 | BleProfiler.prototype.discoverDeviceAdv = function(bdaddr, report, rssi)  { 64 | if (!(bdaddr in this.devices) && bdaddr != null) { 65 | this.devices[bdaddr] = { 66 | services: {}, 67 | adv_records: report, 68 | scan_response: null, 69 | connected: false, 70 | }; 71 | } else if (bdaddr in this.devices) { 72 | /* Store scan response if any. */ 73 | if (Buffer.compare(this.devices[bdaddr].adv_records, report) && (this.devices[bdaddr].scan_response == null)) { 74 | this.devices[bdaddr].scan_response = report; 75 | } 76 | } 77 | }; 78 | 79 | /** 80 | * Device discovery. 81 | **/ 82 | 83 | BleProfiler.prototype.discoverDevice = function(peripheral) { 84 | if (peripheral.address.toLowerCase() === this.target.toLowerCase()) { 85 | /* Stop scanning. */ 86 | noble.stopScanning(); 87 | 88 | /* Try to connect to our device, and explore services. */ 89 | this.currentDevice = peripheral; 90 | this.services = 0; 91 | this.characteristics = 0; 92 | 93 | peripheral.connect(function(error) { 94 | if (error == undefined) { 95 | if (!this.devices[this.currentDevice.address].connected) { 96 | console.log('Target detected in range, starting profiling ...'.bold); 97 | this.devices[this.currentDevice.address].connected = true; 98 | this.devices[this.currentDevice.address].name = peripheral.advertisement.localName; 99 | this.onDeviceConnected(this.currentDevice); 100 | } 101 | } else { 102 | this.onDiscoverFailed(); 103 | } 104 | }.bind(this)); 105 | 106 | } 107 | }; 108 | 109 | /** 110 | * onDeviceConnected() 111 | * 112 | * Services discovery. 113 | */ 114 | 115 | BleProfiler.prototype.onDeviceConnected = function(peripheral) { 116 | /* Discover services. */ 117 | console.log('Starting services and characteristics discovery ...'.bold); 118 | peripheral.discoverServices(null, (function(_this, peripheral){ 119 | return function(error, services) { 120 | _this.services = services.length; 121 | if (error == undefined) { 122 | for (var service in services) { 123 | /* Exclude service uuid(1800) and uuid(1801), 124 | * because Bleno already provides them. */ 125 | if ((services[service].uuid != '1801') && (services[service].uuid != '1800')) { 126 | console.log((' * discovered service ' + services[service].uuid).yellow); 127 | var device = _this.devices[_this.currentDevice.address]; 128 | device.services[services[service].uuid] = {}; 129 | _this.onDiscoverService(peripheral, services[service], (function(t, service){ 130 | return function(){ 131 | t.onServiceDiscovered(service); 132 | }; 133 | })(_this, services[service].uuid)); 134 | } else { 135 | _this.onServiceDiscovered(service); 136 | } 137 | } 138 | } else { 139 | _this.onDiscoverFailed(); 140 | } 141 | }; 142 | })(this, peripheral)); 143 | }; 144 | 145 | /** 146 | * onDiscoverService() 147 | * 148 | * Characteristics discovery. 149 | **/ 150 | 151 | BleProfiler.prototype.onDiscoverService = function(peripheral, service, callback) { 152 | /* Discover characteristics. */ 153 | service.discoverCharacteristics(null, (function(_this, peripheral, service, callback){ 154 | return function(error, characs) { 155 | if (error == undefined) { 156 | for (var charac in characs) { 157 | _this.characteristics += 1; 158 | var device = _this.devices[_this.currentDevice.address]; 159 | var _service = device.services[service]; 160 | _service[characs[charac].uuid] = { 161 | uuid: characs[charac].uuid, 162 | properties: characs[charac].properties, 163 | descriptors: [], 164 | }; 165 | console.log((' * discovered characteristic '+ service + '::' + characs[charac].uuid + ' ('+characs[charac].properties + ')').blue); 166 | _this.onDiscoverCharacteristic(peripheral, service, characs[charac], (function(t){ 167 | return function(){ 168 | t.onCharacteristicDiscovered(null); 169 | }; 170 | })(_this)); 171 | } 172 | } else { 173 | _this.onDiscoverFailed(); 174 | } 175 | callback(); 176 | }; 177 | })(this, peripheral, service.uuid, callback)); 178 | }; 179 | 180 | /** 181 | * onServiceDiscovered() 182 | * 183 | * Track discovered services. 184 | */ 185 | 186 | BleProfiler.prototype.onServiceDiscovered = function(service) { 187 | this.services = this.services - 1; 188 | }; 189 | 190 | 191 | /** 192 | * onCharacteristicDiscovered() 193 | * 194 | * Track discovered characteristics. 195 | **/ 196 | 197 | BleProfiler.prototype.onCharacteristicDiscovered = function(characteristic) { 198 | this.characteristics = this.characteristics - 1; 199 | if ((this.services == 0) && (this.characteristics == 0)) { 200 | console.log((' >> Target ' + this.currentDevice.address + ' successfully profiled.').bold) 201 | this.onDiscoverDone(); 202 | } 203 | } 204 | 205 | /** 206 | * onDiscoverCharacteristic() 207 | * 208 | * Descriptors discovery. 209 | **/ 210 | 211 | BleProfiler.prototype.onDiscoverCharacteristic = function(peripheral, service, charac, callback) { 212 | charac.discoverDescriptors((function(_this, peripheral, service, charac, callback){ 213 | return function(error, descriptors) { 214 | _this.descriptors += descriptors.length; 215 | var device = _this.devices[_this.currentDevice.address]; 216 | var _charac = device.services[service][charac.uuid]; 217 | for (var desc in descriptors) { 218 | _charac.descriptors.push(descriptors[desc].uuid); 219 | } 220 | callback(); 221 | } 222 | })(this, peripheral, service, charac, callback)); 223 | }; 224 | 225 | /** 226 | * onDiscoverFailed() 227 | * 228 | * Handle failed. 229 | **/ 230 | 231 | BleProfiler.prototype.onDiscoverFailed = function() { 232 | /* Start scanning. */ 233 | this.currentDevice = null; 234 | this.configCallback('discovery failed', null); 235 | }; 236 | 237 | /** 238 | * onDiscoverDone() 239 | * 240 | * Discovery done, save config. 241 | **/ 242 | 243 | BleProfiler.prototype.onDiscoverDone = function(){ 244 | //console.log(this.devices[this.currentDevice.address]); 245 | this.currentDevice = null; 246 | this.config = this.createMockConfig(); 247 | this.configCallback(null, this.config); 248 | } 249 | 250 | BleProfiler.prototype.createMockConfig = function() { 251 | 252 | 253 | /* Create our serialized data. */ 254 | var device_info = {}; 255 | 256 | device_info['ad_records'] = this.devices[this.target].adv_records.toString('hex'); 257 | device_info['scan_data'] = this.devices[this.target].scan_response.toString('hex'); 258 | device_info['name'] = this.devices[this.target].name; 259 | device_info['services'] = []; 260 | device_info['address'] = this.target; 261 | for (var _service in this.devices[this.target].services) { 262 | var _chars = this.devices[this.target].services[_service]; 263 | 264 | var service = {}; 265 | service['uuid'] = _service; 266 | service['characteristics'] = []; 267 | for (var device_char in _chars) { 268 | var char = {}; 269 | char['uuid'] = _chars[device_char]['uuid']; 270 | char['properties'] = _chars[device_char]['properties']; 271 | char['descriptors'] = _chars[device_char]['descriptors']; 272 | service['characteristics'].push(char); 273 | } 274 | device_info['services'].push(service); 275 | } 276 | return device_info; 277 | } 278 | 279 | module.exports = BleProfiler; 280 | --------------------------------------------------------------------------------