├── .github └── workflows │ └── docs.yml ├── .gitignore ├── LICENSE ├── README.md ├── docs ├── .gitignore ├── CNAME ├── Gemfile ├── Gemfile.lock ├── _config.yml ├── _sass │ └── kb1rd.scss ├── assets │ └── css │ │ └── style.scss └── build.sh ├── package.json ├── sample.config.yaml ├── src ├── ajv.ts ├── bridge.ts ├── call.ts ├── config.ts ├── database.ts ├── error.ts ├── httpserver.ts ├── index.ts ├── log.ts ├── modules │ ├── index.ts │ ├── module.ts │ ├── twilio │ │ ├── index.ts │ │ └── signalling.ts │ └── vonage.ts ├── phonenumber.ts ├── signalling_events.ts └── util.ts ├── tsconfig.json ├── tslint.json └── yarn.lock /.github/workflows/docs.yml: -------------------------------------------------------------------------------- 1 | name: Build docs 2 | 3 | on: 4 | release: 5 | types: 6 | - created 7 | workflow_dispatch: 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v2 14 | 15 | - run: cd docs; bundle install; bash build.sh; cd .. 16 | 17 | - uses: JamesIves/github-pages-deploy-action@releases/v3 18 | with: 19 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 20 | BRANCH: gh-pages 21 | FOLDER: docs/_site/ 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | config.yaml 2 | *registration.yaml 3 | node_modules 4 | build 5 | *.db 6 | yarn-error.log 7 | -------------------------------------------------------------------------------- /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 | # matrix-pstn-bridge 2 | A Matrix Puppet bridge for the public telephone network that supports a number 3 | of VoIP providers (Twillo, Vonage, etc.) 4 | 5 | It's not ready for production use yet, there are still a few things left to iron 6 | out. 7 | 8 | [Matrix Room](https://matrix.to/#/#matrix-pstn-bridge:kb1rd.net?via=kb1rd.net) 9 | 10 | ## Features 11 | * Connect to [Twilio](https://www.twilio.com/) & get current account balance 12 | * Multi-provider module system enables easy use of other providers than 13 | Twilio (none yet implemented) and seamless switching between them. 14 | * Send SMS texts to phone numbers and receive texts back 15 | * Send and receive voice calls 16 | * Intelligent dialing looks up phone numbers based on the one you're using 17 | * Give SMS users "pet names" 18 | * Allow multiple users to puppet a bridge & allow the bridging of bots 19 | * This bridge has a unique way of puppetting. Rather than being controlled by 20 | a single user, numbers are controlled in a single "control room." This allows 21 | multiple users to transparently puppet the same number. This is ideal for 22 | situations like in a small business where multiple people may want to talk or 23 | review conversation history. 24 | 25 | ## Planned Features 26 | * [ ] Displaying bridge info in Element settings 27 | * [ ] Dialer widget 28 | * [ ] Sending MMS (pictures, video, voice, etc.) 29 | * [ ] Getting extended information about users. Services like Twilio offer carrier 30 | lookups and that sort of thing. Could be useful to help weed out spam. 31 | * [x] Phone calls -- This is very hard 32 | * [ ] Answering machine 33 | * [ ] Faxing. Why not, I guess? 34 | * [ ] Pay-as-you-go managed phone number service 35 | * Start a chat with the bridge bot and buy a phone number via Matrix 36 | * Payment security is an issue here ;) 37 | * [ ] Puppetting WhatsApp business or Facebook Messenger. Companies like Twilio 38 | offer connections to proprietary messengers like these. 39 | 40 | ## Current Issues 41 | * Only supports a SQLite DB 42 | * Undefined behavior when invalid numbers are sent from the provider (ex, 43 | Twilio) to the bridge 44 | * Need a way to alert users of texts in rooms that they've left 45 | * Membership syncing between control room and bridge rooms 46 | 47 | ## Setup 48 | 49 | It's assumed that you have a Matrix server that supports Application Services, 50 | which is currently only Synapse, installed and working. You also need a 51 | publicly accessible IP address or domain name, ideally with a reverse proxy 52 | such as NGINX with SSL support to ensure secure text delivery. 53 | 54 | You'll also need an account with whichever provider you want to use. 55 | 56 | If you need any help with this, please ask in the Matrix room. I'll try to 57 | make this process easier where people get stuck. 58 | 59 | First, the bridge code needs to be built. The following commands can be used: 60 | 61 | ```sh 62 | $ yarn # Installs packages 63 | 64 | $ yarn build # Builds the bridge 65 | ``` 66 | 67 | Now, edit the sample config to your liking. Once edited, you need to generate a 68 | registration file: 69 | 70 | ```sh 71 | $ node build/index.js -r # Run the bridge with the `-r` option, which generates a reg file 72 | ``` 73 | 74 | Now, put this file in your homeserver's config directory and edit the HS config 75 | to add this registration. In the case of Synapse, this means adding the file to 76 | the `app_service_config_files` variable in the config. 77 | 78 | Finally, you can run the bridge with `node build/index.js`. 79 | 80 | Once the bridge is up and running, you can start a chat with 81 | `@_pstn_:myserver.org`, which will create a control room with a new puppet. 82 | **Make sure E2EE is disabled when you make the room!** 83 | 84 | Type `help` in this chat to see a list of available commands. 85 | 86 | Type `link ` to link the bridge. You'll receive instructions. 87 | 88 | Once linked, you can use `dial ` to start a DM. You cannot invite the 89 | phone number directly to a room, so please use the `dial` command. 90 | 91 | You can rename phone numbers with the `name` command and check you account 92 | balance with the `status` command. 93 | -------------------------------------------------------------------------------- /docs/.gitignore: -------------------------------------------------------------------------------- 1 | _site 2 | index.md 3 | -------------------------------------------------------------------------------- /docs/CNAME: -------------------------------------------------------------------------------- 1 | pstnbridge.kb1rd.net 2 | -------------------------------------------------------------------------------- /docs/Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | gem 'github-pages', group: :jekyll_plugins 3 | -------------------------------------------------------------------------------- /docs/Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | activesupport (5.2.4.3) 5 | concurrent-ruby (~> 1.0, >= 1.0.2) 6 | i18n (>= 0.7, < 2) 7 | minitest (~> 5.1) 8 | tzinfo (~> 1.1) 9 | addressable (2.7.0) 10 | public_suffix (>= 2.0.2, < 5.0) 11 | coffee-script (2.4.1) 12 | coffee-script-source 13 | execjs 14 | coffee-script-source (1.11.1) 15 | colorator (1.1.0) 16 | commonmarker (0.17.13) 17 | ruby-enum (~> 0.5) 18 | concurrent-ruby (1.1.7) 19 | dnsruby (1.61.4) 20 | simpleidn (~> 0.1) 21 | em-websocket (0.5.1) 22 | eventmachine (>= 0.12.9) 23 | http_parser.rb (~> 0.6.0) 24 | ethon (0.12.0) 25 | ffi (>= 1.3.0) 26 | eventmachine (1.2.7) 27 | execjs (2.7.0) 28 | faraday (1.0.1) 29 | multipart-post (>= 1.2, < 3) 30 | ffi (1.13.1) 31 | forwardable-extended (2.6.0) 32 | gemoji (3.0.1) 33 | github-pages (207) 34 | github-pages-health-check (= 1.16.1) 35 | jekyll (= 3.9.0) 36 | jekyll-avatar (= 0.7.0) 37 | jekyll-coffeescript (= 1.1.1) 38 | jekyll-commonmark-ghpages (= 0.1.6) 39 | jekyll-default-layout (= 0.1.4) 40 | jekyll-feed (= 0.13.0) 41 | jekyll-gist (= 1.5.0) 42 | jekyll-github-metadata (= 2.13.0) 43 | jekyll-mentions (= 1.5.1) 44 | jekyll-optional-front-matter (= 0.3.2) 45 | jekyll-paginate (= 1.1.0) 46 | jekyll-readme-index (= 0.3.0) 47 | jekyll-redirect-from (= 0.15.0) 48 | jekyll-relative-links (= 0.6.1) 49 | jekyll-remote-theme (= 0.4.1) 50 | jekyll-sass-converter (= 1.5.2) 51 | jekyll-seo-tag (= 2.6.1) 52 | jekyll-sitemap (= 1.4.0) 53 | jekyll-swiss (= 1.0.0) 54 | jekyll-theme-architect (= 0.1.1) 55 | jekyll-theme-cayman (= 0.1.1) 56 | jekyll-theme-dinky (= 0.1.1) 57 | jekyll-theme-hacker (= 0.1.1) 58 | jekyll-theme-leap-day (= 0.1.1) 59 | jekyll-theme-merlot (= 0.1.1) 60 | jekyll-theme-midnight (= 0.1.1) 61 | jekyll-theme-minimal (= 0.1.1) 62 | jekyll-theme-modernist (= 0.1.1) 63 | jekyll-theme-primer (= 0.5.4) 64 | jekyll-theme-slate (= 0.1.1) 65 | jekyll-theme-tactile (= 0.1.1) 66 | jekyll-theme-time-machine (= 0.1.1) 67 | jekyll-titles-from-headings (= 0.5.3) 68 | jemoji (= 0.11.1) 69 | kramdown (= 2.3.0) 70 | kramdown-parser-gfm (= 1.1.0) 71 | liquid (= 4.0.3) 72 | mercenary (~> 0.3) 73 | minima (= 2.5.1) 74 | nokogiri (>= 1.10.4, < 2.0) 75 | rouge (= 3.19.0) 76 | terminal-table (~> 1.4) 77 | github-pages-health-check (1.16.1) 78 | addressable (~> 2.3) 79 | dnsruby (~> 1.60) 80 | octokit (~> 4.0) 81 | public_suffix (~> 3.0) 82 | typhoeus (~> 1.3) 83 | html-pipeline (2.14.0) 84 | activesupport (>= 2) 85 | nokogiri (>= 1.4) 86 | http_parser.rb (0.6.0) 87 | i18n (0.9.5) 88 | concurrent-ruby (~> 1.0) 89 | jekyll (3.9.0) 90 | addressable (~> 2.4) 91 | colorator (~> 1.0) 92 | em-websocket (~> 0.5) 93 | i18n (~> 0.7) 94 | jekyll-sass-converter (~> 1.0) 95 | jekyll-watch (~> 2.0) 96 | kramdown (>= 1.17, < 3) 97 | liquid (~> 4.0) 98 | mercenary (~> 0.3.3) 99 | pathutil (~> 0.9) 100 | rouge (>= 1.7, < 4) 101 | safe_yaml (~> 1.0) 102 | jekyll-avatar (0.7.0) 103 | jekyll (>= 3.0, < 5.0) 104 | jekyll-coffeescript (1.1.1) 105 | coffee-script (~> 2.2) 106 | coffee-script-source (~> 1.11.1) 107 | jekyll-commonmark (1.3.1) 108 | commonmarker (~> 0.14) 109 | jekyll (>= 3.7, < 5.0) 110 | jekyll-commonmark-ghpages (0.1.6) 111 | commonmarker (~> 0.17.6) 112 | jekyll-commonmark (~> 1.2) 113 | rouge (>= 2.0, < 4.0) 114 | jekyll-default-layout (0.1.4) 115 | jekyll (~> 3.0) 116 | jekyll-feed (0.13.0) 117 | jekyll (>= 3.7, < 5.0) 118 | jekyll-gist (1.5.0) 119 | octokit (~> 4.2) 120 | jekyll-github-metadata (2.13.0) 121 | jekyll (>= 3.4, < 5.0) 122 | octokit (~> 4.0, != 4.4.0) 123 | jekyll-mentions (1.5.1) 124 | html-pipeline (~> 2.3) 125 | jekyll (>= 3.7, < 5.0) 126 | jekyll-optional-front-matter (0.3.2) 127 | jekyll (>= 3.0, < 5.0) 128 | jekyll-paginate (1.1.0) 129 | jekyll-readme-index (0.3.0) 130 | jekyll (>= 3.0, < 5.0) 131 | jekyll-redirect-from (0.15.0) 132 | jekyll (>= 3.3, < 5.0) 133 | jekyll-relative-links (0.6.1) 134 | jekyll (>= 3.3, < 5.0) 135 | jekyll-remote-theme (0.4.1) 136 | addressable (~> 2.0) 137 | jekyll (>= 3.5, < 5.0) 138 | rubyzip (>= 1.3.0) 139 | jekyll-sass-converter (1.5.2) 140 | sass (~> 3.4) 141 | jekyll-seo-tag (2.6.1) 142 | jekyll (>= 3.3, < 5.0) 143 | jekyll-sitemap (1.4.0) 144 | jekyll (>= 3.7, < 5.0) 145 | jekyll-swiss (1.0.0) 146 | jekyll-theme-architect (0.1.1) 147 | jekyll (~> 3.5) 148 | jekyll-seo-tag (~> 2.0) 149 | jekyll-theme-cayman (0.1.1) 150 | jekyll (~> 3.5) 151 | jekyll-seo-tag (~> 2.0) 152 | jekyll-theme-dinky (0.1.1) 153 | jekyll (~> 3.5) 154 | jekyll-seo-tag (~> 2.0) 155 | jekyll-theme-hacker (0.1.1) 156 | jekyll (~> 3.5) 157 | jekyll-seo-tag (~> 2.0) 158 | jekyll-theme-leap-day (0.1.1) 159 | jekyll (~> 3.5) 160 | jekyll-seo-tag (~> 2.0) 161 | jekyll-theme-merlot (0.1.1) 162 | jekyll (~> 3.5) 163 | jekyll-seo-tag (~> 2.0) 164 | jekyll-theme-midnight (0.1.1) 165 | jekyll (~> 3.5) 166 | jekyll-seo-tag (~> 2.0) 167 | jekyll-theme-minimal (0.1.1) 168 | jekyll (~> 3.5) 169 | jekyll-seo-tag (~> 2.0) 170 | jekyll-theme-modernist (0.1.1) 171 | jekyll (~> 3.5) 172 | jekyll-seo-tag (~> 2.0) 173 | jekyll-theme-primer (0.5.4) 174 | jekyll (> 3.5, < 5.0) 175 | jekyll-github-metadata (~> 2.9) 176 | jekyll-seo-tag (~> 2.0) 177 | jekyll-theme-slate (0.1.1) 178 | jekyll (~> 3.5) 179 | jekyll-seo-tag (~> 2.0) 180 | jekyll-theme-tactile (0.1.1) 181 | jekyll (~> 3.5) 182 | jekyll-seo-tag (~> 2.0) 183 | jekyll-theme-time-machine (0.1.1) 184 | jekyll (~> 3.5) 185 | jekyll-seo-tag (~> 2.0) 186 | jekyll-titles-from-headings (0.5.3) 187 | jekyll (>= 3.3, < 5.0) 188 | jekyll-watch (2.2.1) 189 | listen (~> 3.0) 190 | jemoji (0.11.1) 191 | gemoji (~> 3.0) 192 | html-pipeline (~> 2.2) 193 | jekyll (>= 3.0, < 5.0) 194 | kramdown (2.3.0) 195 | rexml 196 | kramdown-parser-gfm (1.1.0) 197 | kramdown (~> 2.0) 198 | liquid (4.0.3) 199 | listen (3.2.1) 200 | rb-fsevent (~> 0.10, >= 0.10.3) 201 | rb-inotify (~> 0.9, >= 0.9.10) 202 | mercenary (0.3.6) 203 | mini_portile2 (2.4.0) 204 | minima (2.5.1) 205 | jekyll (>= 3.5, < 5.0) 206 | jekyll-feed (~> 0.9) 207 | jekyll-seo-tag (~> 2.1) 208 | minitest (5.14.1) 209 | multipart-post (2.1.1) 210 | nokogiri (1.10.10) 211 | mini_portile2 (~> 2.4.0) 212 | octokit (4.18.0) 213 | faraday (>= 0.9) 214 | sawyer (~> 0.8.0, >= 0.5.3) 215 | pathutil (0.16.2) 216 | forwardable-extended (~> 2.6) 217 | public_suffix (3.1.1) 218 | rb-fsevent (0.10.4) 219 | rb-inotify (0.10.1) 220 | ffi (~> 1.0) 221 | rexml (3.2.4) 222 | rouge (3.19.0) 223 | ruby-enum (0.8.0) 224 | i18n 225 | rubyzip (1.3.0) 226 | safe_yaml (1.0.5) 227 | sass (3.7.4) 228 | sass-listen (~> 4.0.0) 229 | sass-listen (4.0.0) 230 | rb-fsevent (~> 0.9, >= 0.9.4) 231 | rb-inotify (~> 0.9, >= 0.9.7) 232 | sawyer (0.8.2) 233 | addressable (>= 2.3.5) 234 | faraday (> 0.8, < 2.0) 235 | simpleidn (0.1.1) 236 | unf (~> 0.1.4) 237 | terminal-table (1.8.0) 238 | unicode-display_width (~> 1.1, >= 1.1.1) 239 | thread_safe (0.3.6) 240 | typhoeus (1.4.0) 241 | ethon (>= 0.9.0) 242 | tzinfo (1.2.7) 243 | thread_safe (~> 0.1) 244 | unf (0.1.4) 245 | unf_ext 246 | unf_ext (0.0.7.7) 247 | unicode-display_width (1.7.0) 248 | 249 | PLATFORMS 250 | ruby 251 | 252 | DEPENDENCIES 253 | github-pages 254 | 255 | BUNDLED WITH 256 | 2.1.4 257 | -------------------------------------------------------------------------------- /docs/_config.yml: -------------------------------------------------------------------------------- 1 | title: Matrix PSTN Bridge 2 | description: ☎️ A Matrix Puppet bridge for the public telephone network that supports a number of VoIP providers (Twillo, Vonage, etc.). Sends and receives voice and SMS. 3 | remote_theme: pmarsceill/just-the-docs 4 | 5 | aux_links: 6 | "On GitHub": 7 | - "https://github.com/kb1rd/matrix-pstn-bridge/" 8 | 9 | aux_links_new_tab: true 10 | 11 | -------------------------------------------------------------------------------- /docs/_sass/kb1rd.scss: -------------------------------------------------------------------------------- 1 | #sidebar-md { 2 | font-size: 18px; 3 | } 4 | -------------------------------------------------------------------------------- /docs/assets/css/style.scss: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | 4 | @import 'kb1rd'; 5 | -------------------------------------------------------------------------------- /docs/build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | cp ../README.md index.md 4 | bundle exec jekyll build 5 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "matrix-pstn-bridge", 3 | "version": "0.1.0A", 4 | "description": "A Matrix Puppet bridge for the public telephone network that supports a number of VoIP providers (Twillo, Vonage, etc.)", 5 | "main": "index.js", 6 | "scripts": { 7 | "build": "tsc", 8 | "lint": "tslint --project ./tsconfig.json -t stylish", 9 | "start": "node ./build/index.js", 10 | "test": "echo \"Error: no test specified\" && exit 1" 11 | }, 12 | "license": "GPL-3.0", 13 | "author": "KB1RD [@kb1rd:kb1rd.net]", 14 | "dependencies": { 15 | "@supercharge/strings": "^1.18.0", 16 | "@vonage/server-sdk": "^2.10.7", 17 | "ajv": "^8.0.5", 18 | "better-sqlite3": "^7.1.4", 19 | "chalk": "^4.1.1", 20 | "command-line-args": "^5.1.1", 21 | "command-line-usage": "^5.0.5", 22 | "concat-stream": "^2.0.0", 23 | "express": "^4.17.1", 24 | "google-libphonenumber": "^3.2.18", 25 | "hash.js": "^1.1.7", 26 | "loglevel": "^1.7.1", 27 | "loglevel-plugin-prefix": "^0.8.4", 28 | "matrix-bot-sdk": "^0.5.17", 29 | "tslint": "^5.17.0", 30 | "twilio": "^3.60.0", 31 | "twilio-client": "^1.14.0", 32 | "typescript": "^4.2.4", 33 | "ws": "^7.4.4", 34 | "yaml": "^1.10.2" 35 | }, 36 | "devDependencies": { 37 | "@types/better-sqlite3": "^5.4.1", 38 | "@types/google-libphonenumber": "^7.4.20", 39 | "@types/node": "^12.0.8", 40 | "@types/ws": "^7.4.1" 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /sample.config.yaml: -------------------------------------------------------------------------------- 1 | bridge: 2 | # Port to host the bridge on 3 | # Used for communication between the homeserver and the bridge 4 | # Keep behind a firewall 5 | port: 8437 6 | # The host connections to the bridge's webserver are allowed from 7 | bindAddress: 0.0.0.0 8 | # Public domain of the homeserver 9 | homeserverName: localhost:8081 10 | # Reachable URL of the Matrix homeserver 11 | homeserverUrl: http://localhost:8081 12 | 13 | # PUBLICLY ACCESSIBLE HTTP server for webhooks and stuff 14 | # In production, you want HTTPS behind a reverse proxy. 15 | httpserver: 16 | # Port used for the HTTP server 17 | port: 8438 18 | # Bind address for the HTTP server 19 | bindAddress: 0.0.0.0 20 | # PUBLICLY ACCESSIBLE URL to the server's root 21 | publicBaseURL: https://example.com/my_pstn_bridge/ 22 | 23 | permissions: 24 | # Modules to allow. Defaults to all. 25 | modules: 26 | - "twilio" 27 | # Regex of Matrix IDs allowed to create control rooms 28 | # `action` can be `DENY`, `USE` (can only use the bridge), `FULL` (also 29 | # can create new bridges) 30 | # Default end rule is to give everyone full access 31 | # YOU SHOULD EDIT THIS FOR PRODUCTION! 32 | # and please be very careful with your regexes 33 | user_rules: 34 | - regex: '^@kb1rd:localhost:8081$' 35 | action: 'FULL' 36 | - regex: '.*' 37 | action: 'DENY' 38 | 39 | database: 40 | # Use SQLite3 as a database backend 41 | # The name of the database file 42 | filename: database.db 43 | 44 | logging: 45 | # Log level for Matrix Bot SDK's logger (which this bridge uses) 46 | # TRACE, DEBUG, INFO, WARN, ERROR 47 | # Defaults to INFO 48 | level: INFO 49 | -------------------------------------------------------------------------------- /src/ajv.ts: -------------------------------------------------------------------------------- 1 | import Ajv from 'ajv'; 2 | 3 | export default new Ajv(); 4 | -------------------------------------------------------------------------------- /src/bridge.ts: -------------------------------------------------------------------------------- 1 | import { 2 | Appservice, 3 | IAppserviceOptions, 4 | MessageEvent, 5 | Intent, 6 | RoomEvent, 7 | MessageEventContent, 8 | } from 'matrix-bot-sdk'; 9 | import * as Str from '@supercharge/strings'; 10 | 11 | import * as phone from './phonenumber'; 12 | import { getModule, listModules, IModule } from './modules'; 13 | import { ICompleteConfig, getUserAction } from './config'; 14 | import { IBridgeDatabase, IBridgedRoomConfigWithControl } from './database'; 15 | import { BridgeHTTPServer } from './httpserver'; 16 | import { PhoneCall } from './modules/module'; 17 | import { CallState } from './call'; 18 | import * as voip_ev from './signalling_events'; 19 | import { getLogger } from './log' 20 | import { TupleLookup } from './util'; 21 | import { UserFriendlyError } from './error'; 22 | 23 | export interface IUserInfo { 24 | displayname: string 25 | }; 26 | 27 | export interface IBridgeOptions extends IAppserviceOptions { 28 | prefix: string; 29 | storage: IBridgeDatabase; 30 | httpserver: BridgeHTTPServer; 31 | config: ICompleteConfig; 32 | }; 33 | 34 | const log = getLogger('bridge'); 35 | 36 | export class Bridge extends Appservice { 37 | // TODO: Make config option. 38 | protected readonly bot_name = 'PSTN Bridge Bot'; 39 | 40 | // Room name, call ID <-> call 41 | protected readonly active_calls = new TupleLookup< 42 | [string, string], 43 | PhoneCall 44 | >(); 45 | 46 | constructor(protected readonly opts: IBridgeOptions) { 47 | // `options` is private in `Appservice`. We define it *again* as protected, 48 | // but called `opts`. 49 | super(opts); 50 | 51 | // Respond to user directory queries 52 | this.on('query.user', async (mxid, resp) => { 53 | if (this.botUserId === mxid) { 54 | // Set the bot's display name 55 | resp({ display_name: this.bot_name }); 56 | return; 57 | } 58 | 59 | const suffix = this.getSuffixForUserId(mxid); 60 | if (!suffix) { 61 | return; 62 | } 63 | 64 | // Respond with a global number as the username 65 | await resp({ display_name: this.getSuffixDisplayName(suffix) }); 66 | }); 67 | 68 | // Respond to invites 69 | this.on('room.invite', async (room, { sender, state_key }) => { 70 | log.info(`Got invite for ${state_key} to ${room}`); 71 | 72 | // Ignore invites for anything but the bot 73 | if ( 74 | sender && 75 | state_key === this.botUserId && 76 | getUserAction(this.opts.config, sender) === 'FULL' 77 | ) { 78 | log.info(`Accepting invite to ${room}`); 79 | try { 80 | await this.botIntent.joinRoom(room); 81 | } catch (e) { 82 | log.error(`Failed to accept invite to ${room}: ${e}`); 83 | } 84 | return; 85 | } 86 | 87 | log.info(`Rejecting invite to ${room}`); 88 | try { 89 | await this.getIntentForUserId(state_key).leaveRoom(room); 90 | } catch (e) { 91 | log.error(`Failed to reject invite to ${room}: ${e}`); 92 | } 93 | }); 94 | 95 | const self = this; 96 | this.addPreprocessor({ 97 | getSupportedEventTypes(): string[] { 98 | return [ 99 | 'm.room.message', 100 | 'm.call.answer', 101 | 'm.call.invite', 102 | 'm.call.candidates', 103 | 'm.call.hangup', 104 | 'm.call.reject', 105 | ]; 106 | }, 107 | async processEvent(e_raw: any): Promise { 108 | const roomId = e_raw?.room_id; 109 | if (typeof roomId !== 'string') { 110 | return; 111 | } 112 | 113 | const event = new RoomEvent(e_raw); 114 | if ( 115 | !event.sender || 116 | !event.type || 117 | self.isNamespacedUser(event.sender) 118 | ) { 119 | log.debug(`Dropping local echo from ${event.sender}`); 120 | return; 121 | } 122 | log.debug(`Got event of type '${event.type}' in room ${roomId}`); 123 | 124 | if (getUserAction(self.opts.config, event.sender) === 'DENY') { 125 | log.info(`Denied message sending in ${roomId}`); 126 | self.botClient.sendNotice(roomId, 'Access denied'); 127 | return; 128 | } 129 | 130 | const config = await self.db.getBridgedRoomConfig(roomId); 131 | 132 | // So not a bridged room 133 | if (!config) { 134 | let msg: MessageEvent 135 | if ( 136 | event.type === 'm.room.message' && 137 | (msg = new MessageEvent(e_raw)).messageType === 'm.text' 138 | ) { 139 | log.debug(`Processing event as control message`); 140 | await self.processControlMessage(msg.textBody, roomId, msg.sender); 141 | } 142 | return; 143 | } 144 | 145 | log.debug(`Processing event as bridged message`); 146 | await self.processBridgedEvent(event, roomId, config); 147 | }, 148 | }); 149 | } 150 | 151 | /** 152 | * Lists modules that are enabled in the config. 153 | */ 154 | listModules(): string[] { 155 | if (this.opts.config.permissions.modules.length) { 156 | return listModules() 157 | .filter((m) => this.opts.config.permissions.modules.includes(m)); 158 | } 159 | return listModules(); 160 | } 161 | /** 162 | * Gets a module. Returns `null` if it doesn't exist or is disabled in config. 163 | */ 164 | getModule(n: string): IModule | null { 165 | const mods = this.opts.config.permissions.modules; 166 | if (mods.length && !mods.includes(n)) { 167 | return null; 168 | } 169 | return getModule(n); 170 | } 171 | 172 | protected get db(): IBridgeDatabase { 173 | return this.opts.storage; 174 | } 175 | 176 | /** 177 | * Gets the suffix for a telephone number. 178 | */ 179 | getTelSuffix(number: string): string { 180 | return `tel-${number.slice(1)}`; 181 | } 182 | 183 | async begin(): Promise { 184 | const self = this; 185 | const handlers = { 186 | async getConfig(control: string): Promise { 187 | return (await self.db.getControlRoomConfig(control))?.moddata || null; 188 | }, 189 | async createCall( 190 | control: string, 191 | from: string, 192 | ): Promise { 193 | try { 194 | const [info, cfg] = await Promise.all([ 195 | self.getPhoneNumRoom(control, from), 196 | self.db.getControlRoomConfig(control), 197 | ]); 198 | if (!info || !cfg) { 199 | throw new Error('No registered number in room'); 200 | } 201 | 202 | const call = new PhoneCall(cfg.number, from, false, Str.random(64)); 203 | if (info.notE164) { 204 | await self.botIntent.sendText( 205 | control, 206 | `Got phone call from invalid number '${from}', cannot process`, 207 | ); 208 | return null; 209 | } else { 210 | self.addNewCall(info.room, call); 211 | } 212 | return call; 213 | } catch (e) { 214 | log.info( 215 | `Failed to create phone call from ${from} to user under control room ${control}.` 216 | ); 217 | return null; 218 | } 219 | }, 220 | async sendText( 221 | control: string, 222 | from: string, 223 | body: string, 224 | ): Promise { 225 | try { 226 | const info = await self.getPhoneNumRoom(control, from); 227 | if (info.notE164) { 228 | self.botIntent.sendText( 229 | control, 230 | `Got text from invalid number '${from}': ${body}`, 231 | ); 232 | } else { 233 | info.intent.sendText(info.room, body); 234 | } 235 | } catch (e) { 236 | log.info( 237 | `Failed to send text from ${from} to user under control room ${control}: ${e}` 238 | ); 239 | } 240 | }, 241 | }; 242 | 243 | const modules = this.listModules(); 244 | for (const modname of modules) { 245 | const mod = this.getModule(modname); 246 | (mod as IModule).registerWebhooks( 247 | this.opts.httpserver.getModuleApp(modname), 248 | handlers, 249 | ); 250 | } 251 | 252 | await super.begin(); 253 | await this.botIntent.ensureRegistered(); 254 | await this.botClient.setDisplayName(this.bot_name); 255 | } 256 | 257 | /** 258 | * Returns a display name for a particular suffix, or `null` if none defined. 259 | * @param suffix - Suffix to name 260 | * @param ctrl - Used for per-room names. This is the ID of the control room 261 | * controlling that particular bridge room. 262 | * @returns A name or `null`. 263 | */ 264 | async getSuffixDisplayName(suffix: string, ctrl?: string): Promise { 265 | const cfg = (typeof ctrl === 'string' && await this.db.getControlRoomConfig(ctrl)) || null; 266 | if (suffix.startsWith('tel-')) { 267 | const num = phone.getPhoneNumberFromE164('+' + suffix.slice(4)); 268 | return num && num.formatForRegion( 269 | cfg?.number && 270 | phone.getPhoneNumberFromE164(cfg.number)?._region 271 | ); 272 | } 273 | return null; 274 | } 275 | 276 | addNewCall( 277 | room: string, 278 | call: PhoneCall, 279 | intent = this.getIntentForSuffix(this.getTelSuffix(call.remote)) 280 | ): boolean { 281 | // TODO glare 282 | this.active_calls.set([room, call.matrix_id], call); 283 | const call_log = getLogger(`bridge/call/${room}/${call.matrix_id}`); 284 | call.on('ended', () => { 285 | if (this.active_calls.get([room, call.matrix_id]) === call) { 286 | call_log.info('Call was hung up or failed. Call will be deleted.'); 287 | this.active_calls.delete([room, call.matrix_id]); 288 | } 289 | }); 290 | 291 | const sendEvent = async (type: string, event: object): Promise => { 292 | intent.underlyingClient.sendEvent(room, type, event); 293 | } 294 | call.on('send_invite', async (sdp: string) => { 295 | try { 296 | await sendEvent('m.call.invite', { 297 | call_id: call.matrix_id, 298 | // TODO: What should this be? 299 | lifetime: 60000, 300 | offer: { sdp, type: 'offer' }, 301 | version: call.matrix_call_version, 302 | // I can get away with the party ID being the same since there's only 303 | // one remote "device" 304 | party_id: call.matrix_call_version === 1 ? '' : undefined, 305 | }); 306 | } catch (e) { 307 | call_log.error(`Error sending invite: ${e}`); 308 | } 309 | }); 310 | call.on('send_candidates', async (candidates_sdp: string[]) => { 311 | try { 312 | await sendEvent('m.call.candidates', { 313 | call_id: call.matrix_id, 314 | candidates: candidates_sdp.map((candidate) => ({ 315 | candidate, 316 | // TODO: Verify this stuff 317 | sdpMLineIndex: 0, 318 | sdpMid: 'audio', 319 | })), 320 | version: call.matrix_call_version, 321 | party_id: call.matrix_call_version === 1 ? '' : undefined, 322 | }); 323 | } catch (e) { 324 | call_log.error(`Error sending candidates: ${e}`); 325 | } 326 | }); 327 | call.on('send_accept', async (sdp: string) => { 328 | try { 329 | await sendEvent('m.call.answer', { 330 | call_id: call.matrix_id, 331 | // TODO: What should this be? 332 | lifetime: 60000, 333 | answer: { sdp, type: 'answer' }, 334 | version: call.matrix_call_version, 335 | party_id: call.matrix_call_version === 1 ? '' : undefined, 336 | }); 337 | } catch (e) { 338 | call_log.error(`Error sending answer: ${e}`); 339 | } 340 | }); 341 | call.on('send_hangup', async () => { 342 | try { 343 | await sendEvent('m.call.hangup', { 344 | call_id: call.matrix_id, 345 | version: call.matrix_call_version, 346 | party_id: call.matrix_call_version === 1 ? '' : undefined, 347 | }); 348 | } catch (e) { 349 | call_log.error(`Error sending hangup: ${e}`); 350 | } 351 | }); 352 | return true; 353 | } 354 | 355 | /** 356 | * Array of command handler functions. 357 | */ 358 | protected readonly commands = { 359 | async help( 360 | this: Bridge, 361 | { replies }: { room: string, sender: string, replies: string[] }, 362 | ): Promise { 363 | replies.push(`Available commands:`); 364 | replies.push(`help - Print this message`); 365 | replies.push(`status - Print bridge status`); 366 | replies.push(`link [args...] - Link to a phone number using `); 367 | replies.push(`unlink - Remove the phone number link`); 368 | replies.push(`dial - Start chatting with a phone number`); 369 | replies.push(`name [name...] - Set or clear a name for a number. The number can't have spaces.`); 370 | replies.push(`\nAvailable modules: ${this.listModules().join(', ')}`); 371 | }, 372 | async status( 373 | this: Bridge, 374 | { room, replies }: { room: string, sender: string, replies: string[] }, 375 | ): Promise { 376 | const config = await this.db.getControlRoomConfig(room); 377 | if (config) { 378 | const mod = this.getModule(config.module); 379 | if (!mod) { 380 | replies.push(`Linked to ${config.number} via a module that has been removed. You should re-link this bridge.`); 381 | } else { 382 | let stat = `${mod.friendly_name} failed to update status. Is the bridge still authenticated properly?`; 383 | try { 384 | stat = await mod.getStatusMsg(config.moddata); 385 | } catch (e) { 386 | log.warn(`Failed to update status on ${room} for ${config.module}`); 387 | } 388 | replies.push(`Linked to ${config.number} via ${mod.friendly_name}. ${stat}`); 389 | } 390 | } else { 391 | replies.push(`Bridge not configured. Type 'link' to get started.`); 392 | } 393 | }, 394 | 395 | async link( 396 | this: Bridge, 397 | { room, replies }: { room: string, sender: string, replies: string[] }, 398 | modname?: string, 399 | ...modargs: string[] 400 | ): Promise { 401 | const mod = modname && this.getModule(modname); 402 | if (!mod) { 403 | replies.push('Usage: link [module args...]'); 404 | replies.push('Try invoking a module to see its usage.'); 405 | replies.push(`Valid modules are: ${this.listModules().join(', ')}`); 406 | return; 407 | } 408 | 409 | const opts = { 410 | webhook: await this.opts.httpserver.createWebhook( 411 | modname as string, 412 | room, 413 | ), 414 | }; 415 | 416 | try { 417 | const [number, moddata] = await mod.tryLink(opts, ...modargs); 418 | this.db.setControlRoomConfig( 419 | room, 420 | { module: modname as string, number, moddata } 421 | ); 422 | log.debug(`Linked ${room} to ${number} via ${modname}`); 423 | } catch (e) { 424 | if (e instanceof UserFriendlyError) { 425 | log.warn(`Failed to link module ${modname}: ${e}`); 426 | replies.push(`Failed to link to ${modname}: ${e.message}`); 427 | } else { 428 | log.error(`Failed to link module ${modname}: ${e}`); 429 | replies.push(`Unknown error linking to ${modname}`); 430 | } 431 | return; 432 | } 433 | 434 | replies.push(`Linked to module ${modname}.`); 435 | }, 436 | async unlink( 437 | this: Bridge, 438 | { room, replies }: { room: string, sender: string, replies: string[] }, 439 | ): Promise { 440 | const config = await this.db.getControlRoomConfig(room); 441 | if (config) { 442 | const mod = this.getModule(config.module); 443 | if (!mod) { 444 | replies.push(`Linked to ${config.number} via a module that has been removed. Unable to clean up registration. Unlinking anyway...`); 445 | } else { 446 | try { 447 | await mod.unlink(config.moddata, config.number); 448 | } catch (e) { 449 | log.error( 450 | `Failed to perform unlink cleanup with module ${config.module}: ${e}` 451 | ); 452 | if (e instanceof UserFriendlyError) { 453 | replies.push(`Failed to clean up registration: ${e.message}.`); 454 | } else { 455 | replies.push(`Unknown error cleaning up registration.`); 456 | } 457 | } 458 | } 459 | } else { 460 | replies.push(`Bridge already unlinked`); 461 | return; 462 | } 463 | this.db.setControlRoomConfig(room, null); 464 | this.db.deleteWebhookToken(room); 465 | replies.push(`Account unlinked`); 466 | log.debug(`Unlinked ${room}`); 467 | }, 468 | 469 | async dial( 470 | this: Bridge, 471 | { room, sender, replies }: { room: string, sender: string, replies: string[] }, 472 | ...numa: string[] 473 | ): Promise { 474 | const config = await this.db.getControlRoomConfig(room); 475 | const num = phone.parsePhoneNumber(numa.join(' '), config?.number); 476 | if (!num) { 477 | replies.push(`Unrecognized phone number ${numa.join(' ')}`); 478 | return; 479 | } 480 | 481 | const info = await this.getPhoneNumRoom(room, num.E164, sender); 482 | if (info.notE164) { 483 | log.error('E164 number is not valid E164. This should not happen.'); 484 | return; 485 | } 486 | if (!info.changed) { 487 | replies.push(`Bridge already open under ${info.room}.`); 488 | } 489 | }, 490 | 491 | async name( 492 | this: Bridge, 493 | { room, replies }: { room: string, sender: string, replies: string[] }, 494 | nums?: string, 495 | ...namea: string[] 496 | ): Promise { 497 | if (!nums) { 498 | replies.push(`Usage: name [name...]`); 499 | return; 500 | } 501 | 502 | const config = await this.db.getControlRoomConfig(room); 503 | const num = phone.parsePhoneNumber(nums, config?.number); 504 | if (!num) { 505 | replies.push(`Unrecognized phone number ${nums}`); 506 | return; 507 | } 508 | 509 | const name = namea.join(' ').trim(); 510 | 511 | const pn_room = await this.db.getBridgedRoomForNumber(room, num.E164); 512 | if (!pn_room) { 513 | replies.push('Room does not exist. Try dialing this number first'); 514 | return; 515 | } 516 | 517 | this.setPhoneNumRoomDisplayName( 518 | room, 519 | pn_room, 520 | this.getTelSuffix(num.E164), 521 | name, 522 | ); 523 | log.debug(`Updating name in ${room} for ${num}`); 524 | }, 525 | }; 526 | async processControlMessage(text: string, room: string, sender: string): Promise { 527 | let replies: string[] = []; 528 | const args = text.trim().split(' ').map((a) => a.trim()).filter((a) => a); 529 | 530 | log.debug(`Got command ${args[0]} in ${room}`); 531 | 532 | let func = this.commands[args[0]]; 533 | if (!func) { 534 | replies.push(`Unrecognized command: ${args[0]}`); 535 | func = this.commands.help; 536 | } 537 | try { 538 | await func.call(this, { room, sender, replies }, ...args.slice(1)); 539 | } catch (e) { 540 | replies.push(`Internal error processing command`); 541 | log.error(`Got error when processing ${args[0]} in ${room}: ${e}`); 542 | } 543 | 544 | if (replies.length) { 545 | this.botClient.sendNotice(room, replies.join('\n')); 546 | } 547 | } 548 | 549 | async processBridgedEvent( 550 | event: RoomEvent, 551 | room: string, 552 | { remote_number, control_config}: IBridgedRoomConfigWithControl 553 | ): Promise { 554 | const intent = this.getIntentForSuffix(this.getTelSuffix(remote_number)); 555 | if (!(await intent.getJoinedRooms()).includes(room)) { 556 | this.db.setBridgedRoomConfig(room, null); 557 | return; 558 | } 559 | 560 | if (!control_config) { 561 | log.debug(`Got bridge message in unlinked room ${room}.`); 562 | intent.sendText( 563 | room, 564 | 'This bridge is not linked. Please use the link command in the bridge control room', 565 | 'm.notice' 566 | ); 567 | return; 568 | } 569 | 570 | const mod = this.getModule(control_config.module); 571 | if (!mod) { 572 | log.debug(`Got bridge message in room ${room} with unregistered module ${control_config.module}`); 573 | intent.sendText( 574 | room, 575 | `The '${control_config.module}' module was removed since this bridge was linked. Cannot send`, 576 | 'm.notice' 577 | ); 578 | return; 579 | } 580 | 581 | try { 582 | if (event.type === 'm.room.message') { 583 | const msg = new MessageEvent(event.raw); 584 | switch (msg.messageType) { 585 | case 'm.text': 586 | log.debug(`Sending message to ${remote_number} from ${room}`); 587 | await mod.sendMessage( 588 | control_config.moddata, 589 | control_config.number, 590 | remote_number, 591 | msg.textBody, 592 | ); 593 | break; 594 | } 595 | } else if (event.type === 'm.call.invite') { 596 | log.debug(`Creating call to ${remote_number} in ${room}`); 597 | const content = event.content as unknown; 598 | if (!voip_ev.IVoipInvite.validate(content)) { 599 | log.warn(`Failed to process call invite in ${room}: Invalid event`); 600 | return; 601 | } 602 | 603 | if (content.version !== 0 && content.version !== 1) { 604 | log.warn(`VoIP invite in ${room} has unsupported version ${content.version}`); 605 | return; 606 | } 607 | 608 | if (new Date().getTime() > event.timestamp + content.lifetime) { 609 | log.info(`Invite in ${room} past expiration`); 610 | return; 611 | } 612 | 613 | if (this.active_calls.has([room, content.call_id])) { 614 | log.warn(`Failed to process call invite in ${room}: Call already active with same ID`); 615 | return; 616 | } 617 | 618 | const call = new PhoneCall( 619 | control_config.number, 620 | remote_number, 621 | true, 622 | content.call_id 623 | ); 624 | call.matrix_call_version = content.version; 625 | call.state = CallState.INVITED; 626 | this.addNewCall(room, call); 627 | await mod.sendCallInvite( 628 | control_config.moddata, 629 | call, 630 | content.offer.sdp, 631 | ); 632 | } else if (event.type === 'm.call.candidates') { 633 | const content = event.content as unknown; 634 | if (!voip_ev.IVoipCandidates.validate(content)) { 635 | log.warn(`Failed to process call candidates in ${room}: Invalid event`); 636 | return; 637 | } 638 | 639 | if (content.version !== 0 && content.version !== 1) { 640 | log.warn(`Candidates event in ${room} has unsupported version ${content.version}`); 641 | return; 642 | } 643 | const call = this.active_calls.get([room, content.call_id]); 644 | if (!call) { 645 | log.warn(`Failed to process call candidates in ${room} for call ${content.call_id}: Not tracking this call. Was the bridge restarted with active calls?`); 646 | return; 647 | } 648 | if (!call.can_send_candidates) { 649 | log.warn(`Failed to process call candidates in ${room} for all ${content.call_id}: Call not in state where candidates can be sent`); 650 | return; 651 | } 652 | 653 | await mod.sendCallCandidates( 654 | control_config.moddata, 655 | call, 656 | content.candidates.map(({ candidate }) => candidate), 657 | ); 658 | } else if (event.type === 'm.call.answer') { 659 | const content = event.content as unknown; 660 | if (!voip_ev.IVoipAnswer.validate(content)) { 661 | log.warn(`Failed to process call answer in ${room}: Invalid event`); 662 | return; 663 | } 664 | 665 | if (content.version !== 0 && content.version !== 1) { 666 | log.warn(`Answer in ${room} has unsupported version ${content.version}`); 667 | return; 668 | } 669 | const call = this.active_calls.get([room, content.call_id]); 670 | if (!call) { 671 | log.warn(`Failed to process call answer in ${room} for call ${content.call_id}: Not tracking this call. Was the bridge restarted with active calls?`); 672 | return; 673 | } 674 | if (!call.can_answer) { 675 | log.warn(`Failed to process call answer in ${room} for all ${content.call_id}: Call not in state where answer can be sent`); 676 | return; 677 | } 678 | 679 | call.state = CallState.ACCEPTED; 680 | await mod.sendCallAccept( 681 | control_config.moddata, 682 | call, 683 | content.answer.sdp, 684 | ); 685 | } else if (event.type === 'm.call.hangup') { 686 | const content = event.content as unknown; 687 | if (!voip_ev.IVoipHangup.validate(content)) { 688 | log.warn(`Failed to process call answer in ${room}: Invalid event`); 689 | return; 690 | } 691 | 692 | if (content.version !== 0 && content.version !== 1) { 693 | log.warn(`Hangup in ${room} has unsupported version ${content.version}`); 694 | return; 695 | } 696 | const call = this.active_calls.get([room, content.call_id]); 697 | if (!call) { 698 | log.warn(`Failed to process call hangup in ${room} for call ${content.call_id}: Not tracking this call. Was the bridge restarted with active calls?`); 699 | return; 700 | } 701 | 702 | // TODO: Is it even necessary to have a function in the module? Since 703 | // changing the state fires an event, which the module can listen for 704 | call.state = CallState.HUNGUP; 705 | await mod.sendCallHangup(control_config.moddata, call); 706 | } else if (event.type === 'm.call.reject') { 707 | const content = event.content as unknown; 708 | if (!voip_ev.IVoipHangup.validate(content)) { 709 | log.warn(`Failed to process call reject in ${room}: Invalid event`); 710 | return; 711 | } 712 | 713 | if (content.version !== 0 && content.version !== 1) { 714 | log.warn(`Reject in ${room} has unsupported version ${content.version}`); 715 | return; 716 | } 717 | const call = this.active_calls.get([room, content.call_id]); 718 | if (!call) { 719 | log.warn(`Failed to process call reject in ${room} for call ${content.call_id}: Not tracking this call. Was the bridge restarted with active calls?`); 720 | return; 721 | } 722 | if (!call.can_reject) { 723 | log.warn(`Failed to process call reject in ${room} for all ${content.call_id}: Call not in state where reject can be sent`); 724 | return; 725 | } 726 | 727 | call.state = CallState.HUNGUP; 728 | await mod.sendCallHangup(control_config.moddata, call); 729 | } else { 730 | log.debug(`Couldn't process event to ${remote_number} from ${room}. Unknown type ${event.type}`); 731 | } 732 | } catch(e) { 733 | log.error(`Failed to send event of type ${event.type} to ${remote_number} from ${room}: ${e}`); 734 | if (e instanceof UserFriendlyError) { 735 | intent.sendText( 736 | room, 737 | `Failed to forward event: ${e.message}`, 738 | 'm.notice' 739 | ); 740 | } else { 741 | intent.sendText( 742 | room, 743 | `Unknown error forwarding event`, 744 | 'm.notice' 745 | ); 746 | } 747 | } 748 | } 749 | 750 | /** 751 | * Updates the `m.room.member` event in a bridged room to contain localized 752 | * display information. Is idempotent. This function trusts that the correct 753 | * values for the control room, bridged room, and user suffix are provided. 754 | * @param control - Control room for the bridged room 755 | * @param room - The bridged room 756 | * @param suffix - The suffix of the bridged user in `room` 757 | * @param dname - The desired name. If `undefined` or `null`, it is assumed 758 | * that the default name should be used unless the user has already specified 759 | * a pet name via the `name` command. If it is `''`, it is assumed that the 760 | * user wants to reset the name to the default. If it's a string, then the 761 | * name is set to exactly that string. 762 | * @returns A promise that resolves when complete. 763 | */ 764 | async setPhoneNumRoomDisplayName( 765 | control: string, 766 | room: string, 767 | suffix: string, 768 | dname?: string | null, 769 | ): Promise { 770 | const intent = this.getIntentForSuffix(suffix); 771 | const client = intent.underlyingClient; 772 | 773 | const [cstate, name] = await Promise.all([ 774 | client.getRoomStateEvent( 775 | room, 776 | 'm.room.member', 777 | this.getUserIdForSuffix(suffix) 778 | ), 779 | dname ? Promise.resolve(dname) : this.getSuffixDisplayName(suffix, control), 780 | ]); 781 | 782 | if ( 783 | typeof dname != 'string' && 784 | cstate && 785 | cstate['net.kb1rd.bridge.userdef_display'] 786 | ) { 787 | return; 788 | } 789 | if (!name) { 790 | return; 791 | } 792 | 793 | if (cstate?.membership === 'join' && cstate?.displayname !== name) { 794 | log.debug(`Updating display name in room ${room} for ${suffix}.`); 795 | await client.sendStateEvent( 796 | room, 797 | 'm.room.member', 798 | this.getUserIdForSuffix(suffix), 799 | Object.assign( 800 | {}, 801 | cstate, 802 | { 803 | displayname: name, 804 | 'net.kb1rd.bridge.userdef_display': Boolean(dname), 805 | }, 806 | ), 807 | ); 808 | } 809 | } 810 | 811 | /** 812 | * Gets or creates a room to talk to a particular phone number, possibly 813 | * inviting users. 814 | * @param control - The control room ID 815 | * @param e164 - The E164 number for the remote number 816 | * @param user - An optional user to ensure is in the room 817 | * @returns An object: 818 | * `{ room: string, changed: boolean, notE164: false, intent: Intent }` 819 | * `room` contains the ID of the new/old room, `changed` is set to true if 820 | * some change to server state has been made (create or invite), and `intent` 821 | * is the bot SDK's intent for the phone number. 822 | * OR `{ notE164: true }` 823 | * `notE164` will be true if the input number 824 | */ 825 | async getPhoneNumRoom( 826 | control: string, 827 | e164: string, 828 | user?: string, 829 | ): Promise<{ room: string, changed: boolean, notE164: false, intent: Intent } | { notE164: true }> { 830 | if (!phone.getPhoneNumberFromE164(e164)) { 831 | return { notE164: true }; 832 | } 833 | 834 | const suffix = this.getTelSuffix(e164); 835 | const intent = this.getIntentForSuffix(suffix); 836 | const client = intent.underlyingClient; 837 | 838 | // Username is managed on a per-room basis. Setting it gobally overwrites 839 | // the custom, per-room values 840 | // await intent.ensureRegistered(); 841 | // const generic_name = await this.getSuffixDisplayName(suffix); 842 | // generic_name && await client.setDisplayName(generic_name); 843 | 844 | let room = await this.db.getBridgedRoomForNumber(control, e164); 845 | 846 | const reconcileRoomState = async () => { 847 | this.setPhoneNumRoomDisplayName(control, room as string, suffix); 848 | }; 849 | 850 | if (typeof room === 'string' && (await intent.getJoinedRooms()).includes(room)) { 851 | await reconcileRoomState(); 852 | if (user && !(await client.getJoinedRoomMembers(room)).includes(user)) { 853 | log.debug(`Invited user ${user} to ${room}.`); 854 | await intent.underlyingClient.inviteUser(user, room); 855 | return { room, changed: true, notE164: false, intent }; 856 | } 857 | log.debug(`Room ${room} already exists. Taking no action.`); 858 | return { room, changed: false, notE164: false, intent }; 859 | } 860 | 861 | // TODO: Sync membership 862 | const membership = (await this.botClient.getRoomMembers(control, undefined, ['join'])) 863 | .map(({ membershipFor }) => membershipFor) 864 | .filter((m) => typeof this.getSuffixForUserId(m) !== 'string'); 865 | 866 | await intent.ensureRegistered(); 867 | log.debug(`Creating new room for ${control} to bridge to ${e164}.`); 868 | room = await client.createRoom({ 869 | preset: 'private_chat', 870 | visibility: 'private', 871 | invite: membership, 872 | is_direct: true, 873 | }); 874 | 875 | await this.db.setBridgedRoomConfig( 876 | room, 877 | { control_room: control, remote_number: e164 } 878 | ); 879 | 880 | await reconcileRoomState(); 881 | return { room, changed: true, notE164: false, intent }; 882 | } 883 | } 884 | -------------------------------------------------------------------------------- /src/call.ts: -------------------------------------------------------------------------------- 1 | import * as Str from '@supercharge/strings'; 2 | import { TypedEventEmitter } from './util'; 3 | 4 | export enum CallState { 5 | CREATED = 0, INVITED = 1, ACCEPTED = 2, FAILED = 3, HUNGUP = 4, 6 | } 7 | 8 | type PhoneCallEvents = { 9 | send_invite(sdp: string): void; 10 | send_candidates(candidates_sdp: string[]): void; 11 | send_accept(sdp: string): void; 12 | send_hangup(); 13 | statechange(new_state: CallState, old_state: CallState); 14 | ended(); 15 | } 16 | 17 | export type PhoneCallEventArgs = { 18 | [key in keyof PhoneCallEvents]: Parameters; 19 | }; 20 | 21 | export class PhoneCall extends TypedEventEmitter { 22 | matrix_call_version = 0; 23 | private _state = CallState.CREATED; 24 | constructor( 25 | public readonly local: string, 26 | public readonly remote: string, 27 | public readonly from_matrix: boolean, 28 | public readonly matrix_id = Str.random(64) 29 | ) { 30 | super(); 31 | this.on('send_invite', () => { 32 | this.state = CallState.INVITED; 33 | }); 34 | this.on('send_accept', () => { 35 | this.state = CallState.ACCEPTED; 36 | }); 37 | this.on('send_hangup', () => { 38 | this.state = CallState.HUNGUP; 39 | }); 40 | this.on('statechange', (state: CallState) => { 41 | if (state === CallState.HUNGUP || state === CallState.FAILED) { 42 | this.emit('ended'); 43 | } 44 | }); 45 | } 46 | get state() { 47 | return this._state; 48 | } 49 | set state(state: CallState) { 50 | // Don't go backwards. 51 | if (this.state > state || this.state === CallState.HUNGUP) { 52 | return; 53 | } 54 | const oldstate = this._state; 55 | this._state = state; 56 | this.emit('statechange', state, oldstate); 57 | } 58 | get can_invite(): boolean { 59 | return this.state === CallState.CREATED; 60 | } 61 | get can_answer(): boolean { 62 | return this.state === CallState.INVITED; 63 | } 64 | get can_send_candidates(): boolean { 65 | return this.state >= CallState.INVITED && this.state < CallState.FAILED; 66 | } 67 | get can_reject(): boolean { 68 | // > This rejects the call on all devices, but if the calling device sees 69 | // an accept, it disregards the reject event and carries on.` 70 | return this.state < CallState.ACCEPTED; 71 | } 72 | // No point in asking if the call can be hung up; The answer is yes 73 | } 74 | -------------------------------------------------------------------------------- /src/config.ts: -------------------------------------------------------------------------------- 1 | import * as YAML from 'yaml'; 2 | import * as fs from 'fs'; 3 | import { JSONSchemaType } from 'ajv'; 4 | import * as Str from '@supercharge/strings'; 5 | import { IAppserviceRegistration } from 'matrix-bot-sdk'; 6 | 7 | import ajv from './ajv'; 8 | 9 | type Complete = T extends undefined ? never : T extends Object ? Required<{ 10 | [P in keyof T]?: Complete; 11 | }> : NonNullable; 12 | 13 | export type IRegexRuleAction = 'DENY' | 'USE' | 'FULL'; 14 | export type IRegexRules = { regex: string; action: IRegexRuleAction }[]; 15 | export namespace IRegexRules { 16 | export const JSON: JSONSchemaType = { 17 | $id: 'src/config.ts/IRegexRules', 18 | type: 'array', 19 | items: { 20 | type: 'object', 21 | properties: { 22 | regex: { type: 'string' }, 23 | action: { type: 'string', enum: ['DENY', 'USE', 'FULL'] }, 24 | }, 25 | required: ['regex', 'action'], 26 | }, 27 | }; 28 | ajv.addSchema(JSON); 29 | }; 30 | 31 | export interface IConfigData { 32 | bridge: { 33 | port: number, 34 | bindAddress: string, 35 | homeserverName: string, 36 | homeserverUrl: string, 37 | }; 38 | httpserver: { 39 | port: number; 40 | bindAddress: string; 41 | publicBaseURL: string; 42 | }; 43 | permissions?: { 44 | modules?: string[], 45 | user_rules?: IRegexRules, 46 | }; 47 | database: /*{ connString: string } |*/ { filename: string }; 48 | logging?: { level?: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' }; 49 | }; 50 | export type ICompleteConfig = Complete; 51 | export namespace IConfigData { 52 | export const JSON: JSONSchemaType = { 53 | $id: 'src/config.ts/IConfigData', 54 | type: 'object', 55 | properties: { 56 | bridge: { 57 | type: 'object', 58 | properties: { 59 | port: { type: 'number' }, 60 | bindAddress: { type: 'string' }, 61 | homeserverName: { type: 'string' }, 62 | homeserverUrl: { type: 'string' }, 63 | }, 64 | required: ['port', 'bindAddress', 'homeserverName', 'homeserverUrl'], 65 | }, 66 | httpserver: { 67 | type: 'object', 68 | properties: { 69 | port: { type: 'number' }, 70 | bindAddress: { type: 'string' }, 71 | publicBaseURL: { type: 'string' }, 72 | }, 73 | required: ['port', 'bindAddress', 'publicBaseURL'], 74 | }, 75 | permissions: { 76 | type: 'object', 77 | properties: { 78 | modules: { type: 'array', items: { type: 'string' }, nullable: true }, 79 | user_rules: { $ref: 'IRegexRules' }, 80 | }, 81 | required: [], 82 | nullable: true, 83 | }, 84 | database: { 85 | type: 'object', 86 | properties: { 87 | filename: { type: 'string' }, 88 | }, 89 | required: ['filename'], 90 | }, 91 | logging: { 92 | type: 'object', 93 | properties: { 94 | level: { 95 | type: 'string', 96 | enum: ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR'], 97 | nullable: true, 98 | }, 99 | }, 100 | required: [], 101 | nullable: true, 102 | }, 103 | }, 104 | required: ['bridge', 'database'], 105 | }; 106 | ajv.addSchema(JSON); 107 | export const validate = ajv.compile(JSON); 108 | }; 109 | 110 | export function loadConfig(path: string): ICompleteConfig { 111 | const config = YAML.parse(fs.readFileSync(path, 'utf8')); 112 | 113 | if (!ajv.validate('src/config.ts/IConfigData', config)) { 114 | throw ajv.errors && ajv.errors[0]; 115 | } 116 | 117 | const pburl = config.httpserver.publicBaseURL; 118 | if (!pburl.startsWith('http://') && !pburl.startsWith('https://')) { 119 | throw new TypeError('Public base URL for the HTTP server must be HTTP or HTTPS'); 120 | } 121 | if (!pburl.endsWith('/')) { 122 | config.httpserver.publicBaseURL += '/'; 123 | } 124 | 125 | config.permissions = Object.assign( 126 | { modules: [], user_rules: [] }, 127 | config.permissions || {} 128 | ); 129 | config.logging = config.logging || {}; 130 | config.logging.level = config.logging.level || 'INFO'; 131 | 132 | return config as ICompleteConfig; 133 | } 134 | 135 | export function getUserAction(config: ICompleteConfig, mxid: string): IRegexRuleAction { 136 | for (const { regex, action } of config.permissions.user_rules) { 137 | if (mxid.match(regex)) { 138 | return action; 139 | } 140 | } 141 | return 'FULL'; 142 | } 143 | 144 | export interface IRegOpts { 145 | id: string; 146 | url: string; 147 | prefix: string; 148 | }; 149 | 150 | export function createRegistration(opts: IRegOpts): IAppserviceRegistration { 151 | const regex_safe_prefix = opts.prefix.replace('.', '\\.'); 152 | return { 153 | id: opts.id, 154 | url: opts.url, 155 | as_token: Str.random(64), 156 | hs_token: Str.random(64), 157 | sender_localpart: opts.prefix, 158 | namespaces: { 159 | users: [{ exclusive: true, regex: '@' + regex_safe_prefix + '.*' }], 160 | aliases: [], 161 | rooms: [], 162 | }, 163 | protocols: [], 164 | rate_limited: false, 165 | }; 166 | } 167 | 168 | export interface IRegTokens { 169 | as_token: string; 170 | hs_token: string; 171 | } 172 | 173 | export function loadRegTokens(path: string): IRegTokens { 174 | const config = YAML.parse(fs.readFileSync(path, 'utf8')); 175 | if ( 176 | typeof config !== 'object' || 177 | typeof config.as_token !== 'string' || 178 | typeof config.hs_token !== 'string' 179 | ) { 180 | throw new TypeError('Invalid registration file'); 181 | } 182 | return config as IRegTokens; 183 | } 184 | 185 | -------------------------------------------------------------------------------- /src/database.ts: -------------------------------------------------------------------------------- 1 | import { IStorageProvider, IAppserviceStorageProvider, IFilterInfo } from 'matrix-bot-sdk'; 2 | import * as SqliteDB from 'better-sqlite3'; 3 | import * as sha512 from 'hash.js/lib/hash/sha/512'; 4 | import * as Str from '@supercharge/strings'; 5 | 6 | export interface IControlConfig { 7 | number: string; 8 | module: string; 9 | moddata: object; 10 | }; 11 | 12 | export interface IBridgedRoomConfig { 13 | remote_number: string; 14 | control_room: string; 15 | }; 16 | export interface IBridgedRoomConfigWithControl extends IBridgedRoomConfig { 17 | control_config: IControlConfig | null; 18 | }; 19 | 20 | export interface IBridgeDatabase extends IStorageProvider, IAppserviceStorageProvider { 21 | /** 22 | * Gets the config data for a control room. 23 | */ 24 | getControlRoomConfig(room: string): Promise; 25 | /** 26 | * Sets the config data for a control room. 27 | */ 28 | setControlRoomConfig(room: string, config: IControlConfig | null): Promise; 29 | // getControlRoomForNumber(number: string): Promise<[string, IControlConfig] | null>; 30 | 31 | /** 32 | * Gets the config data for a bridged room. 33 | */ 34 | getBridgedRoomConfig(room: string): Promise; 35 | /** 36 | * Sets the config data for a bridged room. 37 | */ 38 | setBridgedRoomConfig(room: string, config: IBridgedRoomConfig | null): Promise; 39 | /** 40 | * Gets the bridge room that corresponds to a number for a particular control 41 | * room ID. 42 | */ 43 | getBridgedRoomForNumber(control: string, number: string): Promise; 44 | 45 | /** 46 | * Creates a random webhook token for a control room. Will overwrite any 47 | * existing tokens for that control room if present. 48 | */ 49 | createWebhookToken(control: string): Promise; 50 | /** 51 | * Gets the control room corresponding to a webhook token, or `null`. 52 | */ 53 | getControlRoomFromWebhookToken(token: string): Promise; 54 | /** 55 | * Invalidates a webhook token. 56 | */ 57 | deleteWebhookToken(control: string): Promise; 58 | } 59 | 60 | export class SqliteBridgeDatabase implements IBridgeDatabase { 61 | protected db: SqliteDB.Database; 62 | 63 | protected txns = new Set(); 64 | 65 | protected stmt_getctrlconfig: SqliteDB.Statement<{ room: string }>; 66 | protected stmt_insctrlconfig: SqliteDB.Statement; 67 | protected stmt_delctrlconfig: SqliteDB.Statement<{ room: string }>; 68 | 69 | protected stmt_getbrroom: SqliteDB.Statement<{ room: string }>; 70 | protected stmt_insbrroom: SqliteDB.Statement; 71 | protected stmt_delbrroom: SqliteDB.Statement<{ room: string }>; 72 | protected stmt_getbrroom_num: SqliteDB.Statement<{ control: string, number: string }>; 73 | 74 | protected stmt_inswht: SqliteDB.Statement<{ control: string, hook: string }>; 75 | protected stmt_getwht: SqliteDB.Statement<{ hook: string }>; 76 | protected stmt_delwht: SqliteDB.Statement<{ control: string }>; 77 | 78 | protected kvstore_get: (k: string) => string | null 79 | protected kvstore_set: (k: string, v: string | null) => void 80 | 81 | constructor({ file }: { file: string }) { 82 | this.db = new SqliteDB(file); 83 | this.db.exec(` 84 | CREATE TABLE IF NOT EXISTS control_rooms ( 85 | id TEXT PRIMARY KEY NOT NULL, 86 | number TEXT NOT NULL, 87 | module TEXT NOT NULL, 88 | moddata TEXT NOT NULL, 89 | UNIQUE (id) 90 | ); 91 | 92 | CREATE TABLE IF NOT EXISTS bridged_rooms ( 93 | id TEXT PRIMARY KEY NOT NULL, 94 | control_room TEXT NOT NULL, 95 | remote_number TEXT NOT NULL, 96 | UNIQUE (id), 97 | UNIQUE (control_room, remote_number) 98 | ); 99 | 100 | CREATE TABLE IF NOT EXISTS webhooks ( 101 | control TEXT PRIMARY KEY NOT NULL, 102 | hook TEXT NOT NULL, 103 | UNIQUE (control), 104 | UNIQUE (hook) 105 | ); 106 | 107 | CREATE TABLE IF NOT EXISTS kvstore ( 108 | key TEXT PRIMARY KEY NOT NULL, 109 | value TEXT NOT NULL, 110 | UNIQUE (key) 111 | ); 112 | `); 113 | 114 | this.stmt_getctrlconfig = this.db.prepare('SELECT number, module, moddata FROM control_rooms WHERE id = $room'); 115 | this.stmt_insctrlconfig = this.db.prepare('INSERT INTO control_rooms VALUES ($room, $number, $module, $moddata)'); 116 | this.stmt_delctrlconfig = this.db.prepare('DELETE FROM control_rooms WHERE id = $room'); 117 | this.setControlRoomConfig = this.db.transaction(async (room: string, config: IControlConfig | null): Promise => { 118 | this.stmt_delctrlconfig.run({ room }); 119 | if (config) { 120 | this.stmt_insctrlconfig.run( 121 | Object.assign( 122 | config, 123 | { room, moddata: config && JSON.stringify(config.moddata) }, 124 | ), 125 | ); 126 | } 127 | }); 128 | 129 | this.stmt_getbrroom = this.db.prepare('SELECT remote_number, control_room FROM bridged_rooms WHERE id = $room'); 130 | this.getBridgedRoomConfig = this.db.transaction(async (room: string): Promise => { 131 | const cfg: IBridgedRoomConfigWithControl | null = this.stmt_getbrroom.get({ room }); 132 | if (cfg) { 133 | cfg.control_config = await this.getControlRoomConfig(cfg.control_room); 134 | } 135 | return cfg; 136 | }); 137 | this.stmt_insbrroom = this.db.prepare('INSERT INTO bridged_rooms VALUES ($room, $control_room, $remote_number)'); 138 | this.stmt_delbrroom = this.db.prepare('DELETE FROM bridged_rooms WHERE id = $room'); 139 | this.setBridgedRoomConfig = this.db.transaction(async (room: string, config: IBridgedRoomConfig | null): Promise => { 140 | this.stmt_delbrroom.run({ room }); 141 | if (config) { 142 | this.stmt_insbrroom.run(Object.assign(config, { room })); 143 | } 144 | }); 145 | this.stmt_getbrroom_num = this.db.prepare('SELECT id FROM bridged_rooms WHERE control_room = $control AND remote_number = $number'); 146 | 147 | this.stmt_inswht = this.db.prepare('INSERT INTO webhooks VALUES ($control, $hook)'); 148 | this.stmt_getwht = this.db.prepare('SELECT control FROM webhooks WHERE hook = $hook'); 149 | this.stmt_delwht = this.db.prepare('DELETE FROM webhooks WHERE control = $control'); 150 | this.createWebhookToken = this.db.transaction(async (control: string): Promise => { 151 | await this.deleteWebhookToken(control); 152 | const hook = Str.random(128); 153 | this.stmt_inswht.run({ control, hook }); 154 | return hook; 155 | }); 156 | 157 | const stmt_kvget = this.db.prepare('SELECT value FROM kvstore WHERE key = ?'); 158 | const stmt_kvins = this.db.prepare('INSERT INTO kvstore VALUES (?, ?)'); 159 | const stmt_kvdel = this.db.prepare('DELETE FROM kvstore WHERE key = ?'); 160 | this.kvstore_get = (k: string): string | null => stmt_kvget.get(k)?.value || null; 161 | this.kvstore_set = this.db.transaction((k: string, v: string | null): void => { 162 | stmt_kvdel.run(k); 163 | if (v) { 164 | stmt_kvins.run(k, v); 165 | } 166 | }); 167 | } 168 | 169 | async getControlRoomConfig(room: string): Promise { 170 | const config = this.stmt_getctrlconfig.get({ room }) || null; 171 | if (config) { 172 | config.moddata = JSON.parse(config.moddata as string); 173 | } 174 | return config; 175 | } 176 | // Set in constructor. It's a bit weird, I know 177 | setControlRoomConfig: (room: string, config: IControlConfig | null) => Promise; 178 | 179 | getBridgedRoomConfig: (room: string) => Promise; 180 | setBridgedRoomConfig: (room: string, config: IBridgedRoomConfig | null) => Promise; 181 | async getBridgedRoomForNumber(control: string, number: string): Promise { 182 | return this.stmt_getbrroom_num.get({ control, number })?.id || null; 183 | } 184 | 185 | createWebhookToken: (control: string) => Promise; 186 | async getControlRoomFromWebhookToken(hook: string): Promise { 187 | return this.stmt_getwht.get({ hook })?.control; 188 | } 189 | async deleteWebhookToken(control: string): Promise { 190 | this.stmt_delwht.run({ control }); 191 | } 192 | 193 | setSyncToken(token: string | null): void { 194 | this.kvstore_set('syncToken', token); 195 | } 196 | getSyncToken(): string | null { 197 | return this.kvstore_get('syncToken'); 198 | } 199 | 200 | setFilter(filter: IFilterInfo): void { 201 | this.kvstore_set('filter', JSON.stringify(filter)); 202 | } 203 | getFilter(): IFilterInfo { 204 | const json = this.kvstore_get('filter'); 205 | return ((json && JSON.parse(json)) || null) as IFilterInfo; 206 | } 207 | 208 | addRegisteredUser(userId: string) { 209 | const key = sha512().update(userId).digest('hex'); 210 | this.kvstore_set(`appserviceUsers.${key}.registered`, 'true'); 211 | } 212 | isUserRegistered(userId: string): boolean { 213 | const key = sha512().update(userId).digest('hex'); 214 | return this.kvstore_get(`appserviceUsers.${key}.registered`) === 'true'; 215 | } 216 | 217 | isTransactionCompleted(id: string): boolean { 218 | return this.txns.has(id); 219 | } 220 | setTransactionCompleted(id: string) { 221 | this.txns.add(id); 222 | } 223 | 224 | readValue(key: string): string | null { 225 | return this.kvstore_get(`user_${key}`); 226 | } 227 | storeValue(key: string, value: string): void { 228 | this.kvstore_set(`user_${key}`, value) 229 | } 230 | } 231 | 232 | -------------------------------------------------------------------------------- /src/error.ts: -------------------------------------------------------------------------------- 1 | export class UserFriendlyError extends Error { 2 | constructor(desc: string) { 3 | super(desc); 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /src/httpserver.ts: -------------------------------------------------------------------------------- 1 | import * as express from 'express'; 2 | 3 | import { IConfigData } from './config'; 4 | import { IBridgeDatabase } from './database'; 5 | 6 | /** 7 | * https://stackoverflow.com/a/55718334 8 | * Oh god this is so hacky. 9 | */ 10 | declare module 'express-serve-static-core' { 11 | interface Request { 12 | control_room?: string; 13 | } 14 | } 15 | 16 | /** 17 | * A HTTP server used by the bridge for public access, such as for webhooks. 18 | */ 19 | export class BridgeHTTPServer { 20 | protected readonly httpserver = express(); 21 | constructor( 22 | protected readonly config: IConfigData, 23 | protected readonly db: IBridgeDatabase 24 | ) { 25 | this.httpserver.param('token', async (req, res, next, token) => { 26 | const room = await db.getControlRoomFromWebhookToken(token); 27 | 28 | if (!room) { 29 | res.sendStatus(403); 30 | return; 31 | } 32 | 33 | req.control_room = room; 34 | next(); 35 | }); 36 | 37 | this.httpserver.listen( 38 | config.httpserver.port, 39 | config.httpserver.bindAddress 40 | ); 41 | } 42 | 43 | getModuleApp(module: string): express.Application { 44 | const app = express(); 45 | this.httpserver.use(`/webhook/${encodeURIComponent(module)}/:token`, app); 46 | return app; 47 | } 48 | 49 | /** 50 | * Returns the full URL of a webhook from its token. 51 | */ 52 | getWebhookUrl(module: string, token: string): string { 53 | return `${this.config.httpserver.publicBaseURL}webhook/${encodeURIComponent(module)}/${encodeURIComponent(token)}`; 54 | } 55 | 56 | /** 57 | * Creates a new webhook for a particular control room (replacing the old one 58 | * if one exists) and returns the URL. 59 | */ 60 | async createWebhook(module: string, room: string): Promise { 61 | return this.getWebhookUrl(module, await this.db.createWebhookToken(room)); 62 | } 63 | }; 64 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import * as commandLineArgs from 'command-line-args'; 2 | import * as commandLineUsage from 'command-line-usage'; 3 | 4 | import * as fs from 'fs'; 5 | import * as YAML from 'yaml'; 6 | import { SimpleRetryJoinStrategy, LogService, LogLevel } from 'matrix-bot-sdk'; 7 | 8 | import { loadConfig, createRegistration, loadRegTokens } from './config'; 9 | import { Bridge } from './bridge'; 10 | import { SqliteBridgeDatabase } from './database'; 11 | import { BridgeHTTPServer } from './httpserver'; 12 | import { log } from './log'; 13 | 14 | const commandOptions = [ 15 | { name: 'register', alias: 'r', type: Boolean }, 16 | { name: 'registration-file', alias: 'f', type: String }, 17 | { name: 'config', alias: 'c', type: String }, 18 | { name: 'help', alias: 'h', type: Boolean }, 19 | ]; 20 | const options = Object.assign({ 21 | register: false, 22 | 'registration-file': 'registration.yaml', 23 | config: 'config.yaml', 24 | help: false, 25 | }, commandLineArgs(commandOptions)); 26 | 27 | // if we asked for help, just display the help and exit 28 | if (options.help) { 29 | // tslint:disable-next-line:no-console 30 | console.log(commandLineUsage([ 31 | { 32 | header: "Matrix PSTN Bridge", 33 | content: "A Matrix Puppet bridge for the public telephone network that supports a number of VoIP providers (Twillo, Vonage, etc.)", 34 | }, 35 | { 36 | header: "Options", 37 | optionList: commandOptions, 38 | }, 39 | ])); 40 | process.exit(0); 41 | } 42 | 43 | const config = loadConfig(options.config); 44 | const prefix = '_pstn_'; 45 | 46 | // The logging level is already validated by Ajv 47 | LogService.setLevel(LogLevel[config.logging.level]); 48 | log.setLevel(config.logging.level); 49 | Object 50 | .values(log.getLoggers()) 51 | .forEach((l) => l.setLevel(config.logging.level)); 52 | 53 | const registration = createRegistration({ 54 | prefix, 55 | id: "pstn-puppet", 56 | url: `http://${config.bridge.bindAddress}:${config.bridge.port}`, 57 | }); 58 | 59 | if (options.register) { 60 | try { 61 | fs.writeFileSync( 62 | options['registration-file'], 63 | YAML.stringify(registration) 64 | ); 65 | } catch (err) { 66 | // tslint:disable-next-line:no-console 67 | console.log("Couldn't generate registration file:", err); 68 | process.exit(1); 69 | } 70 | process.exit(0); 71 | } 72 | 73 | Object.assign(registration, loadRegTokens(options['registration-file'])); 74 | 75 | const storage = new SqliteBridgeDatabase({ file: config.database.filename }); 76 | 77 | const httpserver = new BridgeHTTPServer(config, storage); 78 | 79 | const bridge = new Bridge({ 80 | ...config.bridge, 81 | registration, 82 | joinStrategy: new SimpleRetryJoinStrategy(), 83 | prefix, 84 | storage, 85 | httpserver, 86 | config, 87 | }); 88 | 89 | bridge.begin(); 90 | 91 | -------------------------------------------------------------------------------- /src/log.ts: -------------------------------------------------------------------------------- 1 | import * as log from 'loglevel'; 2 | import * as chalk from 'chalk'; 3 | import * as prefix from 'loglevel-plugin-prefix'; 4 | 5 | import { LogService } from 'matrix-bot-sdk'; 6 | 7 | const colors = { 8 | TRACE: chalk.magenta, 9 | DEBUG: chalk.cyan, 10 | INFO: chalk.blue, 11 | WARN: chalk.yellow, 12 | ERROR: chalk.red, 13 | } 14 | prefix.reg(log) 15 | function setupLoggerPrefix(logger: log.Logger): void { 16 | prefix.apply(logger, { 17 | format(level, name, timestamp) { 18 | return `${chalk.gray(`[${timestamp}]`)} ${colors[level.toUpperCase()](level)} ${chalk.green(`${name}:`)}`; 19 | } 20 | }); 21 | } 22 | setupLoggerPrefix(log); 23 | 24 | export { log }; 25 | 26 | const setup_loggers = new WeakSet(); 27 | export function getLogger(name: string): log.Logger { 28 | const lg = log.getLogger(name); 29 | if (!setup_loggers.has(lg)) { 30 | setupLoggerPrefix(lg); 31 | } 32 | return lg; 33 | } 34 | 35 | LogService.setLogger({ 36 | info(module: string, ...args: any[]) { 37 | getLogger(`matrix-bot-sdk/${module}`).info(...args); 38 | }, 39 | warn(module: string, ...args: any[]) { 40 | getLogger(`matrix-bot-sdk/${module}`).warn(...args); 41 | }, 42 | error(module: string, ...args: any[]) { 43 | getLogger(`matrix-bot-sdk/${module}`).error(...args); 44 | }, 45 | debug(module: string, ...args: any[]) { 46 | getLogger(`matrix-bot-sdk/${module}`).debug(...args); 47 | }, 48 | trace(module: string, ...args: any[]) { 49 | getLogger(`matrix-bot-sdk/${module}`).trace(...args); 50 | }, 51 | }); 52 | -------------------------------------------------------------------------------- /src/modules/index.ts: -------------------------------------------------------------------------------- 1 | const Vonage = require('@vonage/server-sdk'); 2 | 3 | import { IModule, ILinkOpts } from './module'; 4 | 5 | import twilio from './twilio'; 6 | import vonage from './vonage'; // unfinished 7 | 8 | const modules: { [key: string]: IModule } = { twilio }; 9 | 10 | export default modules; 11 | export function getModule(name: string): IModule { 12 | return modules[name]; 13 | } 14 | export function listModules(): string[] { 15 | return Object.keys(modules); 16 | } 17 | 18 | export { IModule, ILinkOpts }; 19 | -------------------------------------------------------------------------------- /src/modules/module.ts: -------------------------------------------------------------------------------- 1 | import * as express from 'express'; 2 | 3 | import { PhoneCall, PhoneCallEventArgs } from '../call'; 4 | 5 | import * as log from '../log'; 6 | 7 | export { PhoneCall, express }; 8 | 9 | export interface ILinkOpts { 10 | webhook: string; 11 | }; 12 | 13 | export interface IWebhookHandlers { 14 | sendText(control: string, from: string, body: string): void; 15 | createCall( 16 | control: string, 17 | from: string, 18 | ): Promise; 19 | getConfig(control: string): Promise; 20 | } 21 | 22 | export function getLogger(name: string) { 23 | return log.getLogger(`module/${name}`); 24 | } 25 | 26 | export interface IModule { 27 | friendly_name: string; 28 | 29 | tryLink(opts: ILinkOpts, ...args: string[]): Promise<[string, any]>; 30 | unlink(data: object, number: string): Promise; 31 | getStatusMsg(data: object): Promise; 32 | 33 | registerWebhooks(app: express.Application, handlers: IWebhookHandlers): void; 34 | 35 | sendMessage( 36 | data: object, 37 | from: string, 38 | to: string, 39 | body: string, 40 | ): Promise; 41 | 42 | sendCallInvite( 43 | data: object, 44 | call: PhoneCall, 45 | ...args: PhoneCallEventArgs['send_invite'] 46 | ): Promise; 47 | sendCallCandidates( 48 | data: object, 49 | call: PhoneCall, 50 | ...args: PhoneCallEventArgs['send_candidates'] 51 | ): Promise; 52 | sendCallAccept( 53 | data: object, 54 | call: PhoneCall, 55 | ...args: PhoneCallEventArgs['send_accept'] 56 | ): Promise; 57 | sendCallHangup( 58 | data: object, 59 | call: PhoneCall, 60 | ...args: PhoneCallEventArgs['send_hangup'] 61 | ): Promise; 62 | }; 63 | -------------------------------------------------------------------------------- /src/modules/twilio/index.ts: -------------------------------------------------------------------------------- 1 | import * as Twilio from 'twilio'; 2 | import * as Str from '@supercharge/strings'; 3 | import * as phone from '../../phonenumber'; 4 | 5 | import { 6 | IModule, 7 | ILinkOpts, 8 | PhoneCall, 9 | express, 10 | IWebhookHandlers, 11 | getLogger, 12 | } from '../module'; 13 | 14 | import { createSignallingStream, TwilioSignallingStream } from './signalling'; 15 | import { CallState } from '../../call'; 16 | import * as concat from 'concat-stream'; 17 | import { UserFriendlyError } from '../../error'; 18 | 19 | interface ITwilioData { 20 | version: 0; 21 | sid: string; 22 | authToken: string; 23 | apikey: { sid: string, secret: string }; 24 | appSid: string; 25 | }; 26 | 27 | interface ICallData { 28 | call: PhoneCall; 29 | sigstr: TwilioSignallingStream; 30 | twilio_id: string | null; 31 | }; 32 | 33 | const calls = new WeakMap(); 34 | const calls_by_id = new Map(); 35 | 36 | const log = getLogger('twilio'); 37 | 38 | async function initCall( 39 | data: ITwilioData, 40 | call: PhoneCall, 41 | invite: boolean, 42 | init_signal: ( 43 | sigstr: TwilioSignallingStream, 44 | id: string, 45 | ) => void | Promise, 46 | ): Promise { 47 | // The ID for this "client" signalling stream 48 | // Can be passed to the Dial Client TwiML directives 49 | const id = Str.random(64); 50 | const sigstr = createSignallingStream(data, id); 51 | await sigstr.begin(); 52 | const cdata = { call, sigstr, twilio_id: null as string | null }; 53 | calls.set(call, cdata); 54 | 55 | call.on('ended', () => { 56 | log.debug('Call ended, sending hangup'); 57 | if (cdata.twilio_id) { 58 | calls_by_id.delete(cdata.twilio_id); 59 | sigstr.send('hangup', { callsid: cdata.twilio_id }); 60 | } 61 | // Just closing the stream will eventually cause the call to hang up 62 | sigstr.close(); 63 | }); 64 | 65 | await init_signal(sigstr, id); 66 | 67 | await new Promise((res, rej) => { 68 | // No call sids are checked here because... 69 | // 1.) There's only one call per channel in this impl 70 | // 2.) There's no way for me to know the call SID before it arrives in an 71 | // answer or hangup. Setting the call SID on the invite does nothing. 72 | if (invite) { 73 | sigstr.on('msg:invite', (msg) => { 74 | log.debug('Got invite message from Twilio'); 75 | if ( 76 | typeof msg !== 'object' || 77 | typeof msg.sdp !== 'string' || 78 | typeof msg.callsid !== 'string' 79 | ) { 80 | call.state = CallState.FAILED; 81 | call.emit('send_hangup'); 82 | rej(new Error('Invalid invite message from Twilio')); 83 | return; 84 | } 85 | cdata.twilio_id = msg.callsid; 86 | calls_by_id.set(msg.callsid, cdata); 87 | call.emit('send_invite', msg.sdp); 88 | res(); 89 | }); 90 | } else { 91 | sigstr.on('msg:answer', (msg) => { 92 | log.debug('Got answer message from Twilio'); 93 | if ( 94 | typeof msg !== 'object' || 95 | typeof msg.sdp !== 'string' || 96 | typeof msg.callsid !== 'string' 97 | ) { 98 | call.state = CallState.FAILED; 99 | call.emit('send_hangup'); 100 | rej(new Error('Invalid answer message from Twilio')); 101 | return; 102 | } 103 | cdata.twilio_id = msg.callsid; 104 | calls_by_id.set(msg.callsid, cdata); 105 | call.emit('send_accept', msg.sdp); 106 | res(); 107 | }); 108 | } 109 | sigstr.on('msg:hangup', () => { 110 | log.debug('Got hangup message from Twilio'); 111 | call.emit('send_hangup'); 112 | res(); 113 | }); 114 | sigstr.on('msg:cancel', () => { 115 | log.debug('Got cancel message from Twilio'); 116 | call.emit('send_hangup'); 117 | res(); 118 | }); 119 | }); 120 | } 121 | 122 | const mod: IModule = { 123 | friendly_name: 'Twilio', 124 | 125 | async tryLink( 126 | { webhook }: ILinkOpts, 127 | sid: string, 128 | authToken: string, 129 | ...numargs: string[] 130 | ): Promise<[string, ITwilioData]> { 131 | const number = (numargs && numargs.length && numargs.join(' ')) || '' 132 | if (!sid || !authToken || number === '') { 133 | throw new UserFriendlyError('Usage: link twilio [sid] [token] [number...]'); 134 | } 135 | 136 | // The whole account token is necessary for voice API grants 137 | // An API key and TwiML app also have to be created, which is then used to 138 | // create a JWT token. So let's see... That's 3 ids and 2 secrets to create 139 | // another single use token. 6 identifiers. What the hell. 140 | if (!sid.startsWith('AC')) { 141 | throw new UserFriendlyError('The SID must be your account SID (starts with AC)'); 142 | } 143 | 144 | const e164 = phone.parsePhoneNumber(number)?.E164; 145 | if (!e164) { 146 | throw new UserFriendlyError(`Invalid phone number ${number}`); 147 | } 148 | 149 | const twilio = Twilio(sid, authToken); 150 | let apikey: { sid: string, secret: string }; 151 | const opts: Record = { 152 | // TODO: Some form of ID here? Limited to 64 chars 153 | friendlyName: 'Matrix PSTN Bridge', 154 | }; 155 | try { 156 | const { sid, secret } = await twilio.newKeys.create(opts); 157 | apikey = { sid, secret }; 158 | } catch(e) { 159 | throw new UserFriendlyError( 160 | 'Failed to create API key. Are the credentials correct?' 161 | ); 162 | } 163 | opts.voiceMethod = 'POST'; 164 | opts.voiceUrl = `${webhook}/call/outgoing`; 165 | let appSid: string; 166 | try { 167 | appSid = (await twilio.applications.create(opts)).sid; 168 | } catch(e) { 169 | throw new UserFriendlyError( 170 | 'Failed to create TwiML app. Are the credentials correct?' 171 | ); 172 | } 173 | 174 | try { 175 | const numbers = await twilio 176 | .incomingPhoneNumbers 177 | .list({ phoneNumber: e164 }); 178 | if (numbers.length !== 1) { 179 | throw new UserFriendlyError(`Failed to find the number (${e164}) in your account.`); 180 | } 181 | numbers[0].smsMethod = 'POST'; 182 | numbers[0].smsUrl = `${webhook}/message`; 183 | numbers[0].voiceMethod = 'POST'; 184 | numbers[0].voiceUrl = `${webhook}/call/incoming`; 185 | await numbers[0].update(numbers[0]); 186 | } catch(e) { 187 | throw new UserFriendlyError( 188 | 'Failed to confirm phone number. Are the credentials correct?' 189 | ); 190 | } 191 | return [e164, { version: 0, sid, authToken, apikey, appSid }]; 192 | }, 193 | unlink(data: ITwilioData, phoneNumber: string): Promise { 194 | const twilio = Twilio(data.sid, data.authToken); 195 | const funcs = [ 196 | async () => { 197 | log.debug('Removing Twilio API key...'); 198 | await twilio.keys(data.apikey.sid).remove(); 199 | }, 200 | async () => { 201 | log.debug('Removing Twilio application...'); 202 | await twilio.applications.get(data.appSid).remove(); 203 | }, 204 | async () => { 205 | log.debug('Removing Twilio number webhooks...'); 206 | const numbers = await twilio.incomingPhoneNumbers.list({ phoneNumber }); 207 | if (numbers.length !== 1) { 208 | log.warn('Failed to remove webhooks from number: No longer exists'); 209 | return; // Assume the user deleted it manually 210 | } 211 | numbers[0].smsMethod = 'POST'; 212 | numbers[0].smsUrl = ``; 213 | numbers[0].voiceMethod = 'POST'; 214 | numbers[0].voiceUrl = ``; 215 | await numbers[0].update(numbers[0]); 216 | }, 217 | ]; 218 | return Promise.all(funcs.map((f) => f())) as unknown as Promise; 219 | }, 220 | 221 | registerWebhooks(app: express.Application, handlers: IWebhookHandlers) { 222 | // This just plain doesn't work. Body stays as `{}`. No comment. 223 | // app.use(bodyparser.urlencoded({ extended: false, type: '*' })); 224 | 225 | // If the wheel is broken, reinvent it 226 | app.use((req, res, next) => { 227 | req.pipe(concat((data) => { 228 | const parts = data.toString().split('&').map((p) => p.split('=')); 229 | req.body = {}; 230 | parts.forEach(([k, v]) => { 231 | v = decodeURIComponent(v.replace(/\+/g, '%20')); 232 | req.body[k] = v; 233 | }); 234 | next(); 235 | })); 236 | }); 237 | 238 | app.post('/message', (req, res) => { 239 | log.debug('Got incoming message request'); 240 | res.sendStatus(204); 241 | 242 | if ( 243 | typeof req.body.From !== 'string' || 244 | typeof req.body.Body !== 'string' 245 | ) { 246 | log.warn('Got corrupt msg request from Twilio. No From or Body.'); 247 | return; 248 | } 249 | handlers.sendText( 250 | // If the token is authenticated, the control room must be a string 251 | req.control_room as string, 252 | req.body.From, 253 | req.body.Body 254 | ); 255 | }); 256 | 257 | app.post('/call/incoming', async (req, res) => { 258 | log.debug('Got incoming call request'); 259 | const fail = () => { 260 | log.debug('Sending text-to-speech error response.'); 261 | res.set('Content-Type', 'text/xml'); 262 | res.send(` 263 | 264 | Error processing call 265 | 266 | `); 267 | res.sendStatus(200); 268 | }; 269 | if ( 270 | typeof req.body.From !== 'string' || 271 | typeof req.body.CallSid !== 'string' 272 | ) { 273 | log.warn('Got corrupt call request from Twilio. No From or CallSid.'); 274 | fail(); 275 | return; 276 | } 277 | 278 | const config = (await handlers.getConfig( 279 | req.control_room as string, 280 | )) as ITwilioData; 281 | if (!config) { 282 | log.error('Got call for room with no config.'); 283 | fail(); 284 | return; 285 | } 286 | 287 | const call = await handlers.createCall( 288 | req.control_room as string, 289 | req.body.From 290 | ); 291 | if (!call) { 292 | // The error is already logged, we just need to exit gracefully 293 | fail(); 294 | return; 295 | } 296 | await initCall(config, call, true, (sigstr, id) => { 297 | log.debug('Responding with client dial TwiML...'); 298 | const timeout = 60; 299 | // Including `` causes it to fail, 300 | // even though Twilio demos include it. 301 | res.set('Content-Type', 'text/xml'); 302 | res.status(200); 303 | res.send(` 304 | 305 | 306 | 307 | ${id} 308 | 309 | 310 | 311 | `); 312 | }); 313 | }); 314 | 315 | app.post('/call/outgoing', async (req, res) => { 316 | log.debug('Got outgoing call request'); 317 | const data = calls_by_id.get(req.body.CallSid); 318 | if (!data) { 319 | res.set('Content-Type', 'text/xml'); 320 | res.status(200); 321 | res.send(` 322 | 323 | Internal error. Failed to find call 324 | 325 | `); 326 | log.error( 327 | 'Failed to find an active call with outgoing call request. This should not happen.' 328 | ); 329 | return; 330 | } 331 | 332 | const timeout = 30; 333 | res.set('Content-Type', 'text/xml'); 334 | res.status(200); 335 | res.send(` 336 | 337 | 338 | ${data.call.remote} 339 | 340 | 341 | `); 342 | }); 343 | }, 344 | 345 | async getStatusMsg(data: ITwilioData): Promise { 346 | const bal = await Twilio(data.sid, data.authToken).balance.fetch(); 347 | return `Account balance ${bal.balance} ${bal.currency}.`; 348 | }, 349 | 350 | async sendMessage( 351 | data: ITwilioData, 352 | from: string, 353 | to: string, 354 | body: string 355 | ): Promise { 356 | const twilio = Twilio(data.sid, data.authToken); 357 | await twilio.messages.create({ body, from, to }); 358 | }, 359 | 360 | async sendCallInvite( 361 | data: ITwilioData, 362 | call: PhoneCall, 363 | sdp: string 364 | ): Promise { 365 | log.debug('Initializing new call'); 366 | await initCall(data, call, false, (sigstr) => { 367 | log.debug('Sending invite to Twilio'); 368 | // The call SID here doesn't seem to be used anywhere again 369 | sigstr.send('invite', { sdp, callsid: '', preflight: false, twilio: {} }); 370 | }); 371 | }, 372 | async sendCallCandidates(): Promise { 373 | // It doesn't look like Twilio uses candidates. 374 | // The connection is fairly simple: Browser client connects to Twilio 375 | // Twilio doesn't send candidates and client candidates are kinda useless 376 | }, 377 | async sendCallAccept( 378 | data: ITwilioData, 379 | call: PhoneCall, 380 | sdp: string, 381 | ): Promise { 382 | const cdata = calls.get(call); 383 | if (!cdata) { 384 | throw new UserFriendlyError('Call signalling not started with Twilio'); 385 | } 386 | if (!cdata.twilio_id) { 387 | throw new UserFriendlyError('No remote ID. This should not happen.'); 388 | } 389 | cdata.sigstr.send('answer', { callsid: cdata.twilio_id as string, sdp }); 390 | }, 391 | async sendCallHangup(): Promise { 392 | // Call hangup handler is set up when the call is created 393 | }, 394 | }; 395 | export default mod; 396 | -------------------------------------------------------------------------------- /src/modules/twilio/signalling.ts: -------------------------------------------------------------------------------- 1 | import * as Twilio from 'twilio'; 2 | import * as WS from 'ws'; 3 | import * as EventEmitter from 'events'; 4 | 5 | import { getLogger } from '../module'; 6 | 7 | const AccessToken = Twilio.jwt.AccessToken; 8 | const VoiceGrant = AccessToken.VoiceGrant; 9 | 10 | export interface IInvitePayload { 11 | callsid: string; 12 | sdp: string; 13 | preflight: boolean; 14 | // https://github.com/twilio/twilio-client.js/blob/d90e723a7bf5ee0651159d0bbc91512ffa079cea/lib/twilio/connection.ts#L616 15 | twilio: object; 16 | } 17 | 18 | export interface ISendMsgFunc { 19 | (type: 'listen', payload: { token: string }): void; 20 | (type: 'register', payload: { media: { audio: true } }): void; 21 | (type: 'invite', payload: IInvitePayload): void; 22 | (type: 'answer', payload: { callsid: string, sdp: string }): void; 23 | (type: 'hangup', payload: { callsid: string }): void; 24 | (type: 'cancel', payload: { callsid: string }): void; 25 | } 26 | 27 | const log = getLogger('twilio/sigstr'); 28 | 29 | export const PSTREAM_VERSION = '1.5'; 30 | /** 31 | * A stream to interact with Twilio's client SDK VoIP signalling. 32 | * This was both reverse-engineered from working Twilio clients and from some 33 | * source code [here](https://github.com/twilio/twilio-client.js/blob/master/lib/twilio/pstream.js). 34 | */ 35 | export class TwilioSignallingStream extends EventEmitter { 36 | protected _ws?: WS 37 | constructor( 38 | protected readonly token: string, 39 | protected readonly url = 'wss://chunderw-vpc-gll.twilio.com/signal', 40 | ) { 41 | super(); 42 | } 43 | 44 | get ws(): WS { 45 | if (!this._ws) { 46 | throw new TypeError('Call begin() before attempting to use signalling stream'); 47 | } 48 | return this._ws as WS; 49 | } 50 | 51 | async begin(): Promise { 52 | this._ws = new WS(this.url); 53 | 54 | const promise = new Promise((r) => (this.ws.onopen = r)); 55 | this._ws.onmessage = this._ws_message.bind(this); 56 | this._ws.onclose = () => log.debug('Stream closed'); 57 | this._ws.onerror = (e) => log.warn('Stream websocket error', e); 58 | 59 | await promise; 60 | this.send('listen', { token: this.token }); 61 | await this.on_message('connected'); 62 | this.send('register', { media: { audio: true } }); 63 | await this.on_message('ready'); 64 | } 65 | close(): void { 66 | if (this._ws) { 67 | this._ws.close(); 68 | } 69 | } 70 | 71 | on_message(type: string): Promise { 72 | return new Promise((r) => this.once(`msg:${type}`, r)); 73 | } 74 | 75 | _ws_message(e): void { 76 | // Keep alive 77 | if (e.data.trim() === '') { 78 | this.ws.send('\n'); 79 | log.debug('Responding to Twilio WS keepalive'); 80 | return; 81 | } 82 | 83 | let d; 84 | try { 85 | d = JSON.parse(e.data); 86 | } catch { 87 | log.warn( 88 | 'Got invalid message from Twilio, unable to parse:', 89 | // The stringify here renders with quotes so the exact text is known 90 | JSON.stringify(e.data), 91 | ); 92 | return; 93 | } 94 | if (typeof d.type !== 'string' || typeof d.payload !== 'object') { 95 | log.warn('Got invalid message from Twilio:', d); 96 | return; 97 | } 98 | log.debug('Got msg:', d); 99 | this.emit(`msg`, d.type, d.payload); 100 | this.emit(`msg:${d.type}`, d.payload); 101 | } 102 | 103 | public readonly send: ISendMsgFunc = ( 104 | type: string, 105 | payload: object, 106 | ): void => { 107 | this.ws.send( 108 | JSON.stringify({ type, version: PSTREAM_VERSION, payload }), 109 | ); 110 | log.debug(`Sent msg '${type}':`, payload); 111 | } 112 | } 113 | 114 | interface ISigStreamCreationData { 115 | /** 116 | * **Account** SID 117 | */ 118 | sid: string; 119 | /** 120 | * Twilio [API key](https://www.twilio.com/docs/iam/keys/api-key) 121 | */ 122 | apikey: { sid: string, secret: string }; 123 | /** 124 | * [TwiML app](https://support.twilio.com/hc/en-us/articles/223180928-How-Do-I-Create-a-TwiML-App-) SID 125 | */ 126 | appSid: string; 127 | }; 128 | 129 | /** 130 | * Creates a JWT for a Twilio cliebt and creates a signalling stream with that 131 | * token. 132 | * @param creationdata - Authentication. See `ISigStreamCreationData` 133 | * @param identity - The client name to use 134 | * @param url - Optional URL for the Twilio websocket 135 | */ 136 | export function createSignallingStream( 137 | { sid, apikey, appSid }: ISigStreamCreationData, 138 | identity: string, 139 | url?: string, 140 | ): TwilioSignallingStream { 141 | const voiceGrant = new VoiceGrant({ 142 | outgoingApplicationSid: appSid, 143 | incomingAllow: true, 144 | }); 145 | 146 | const token = new AccessToken(sid, apikey.sid, apikey.secret, { identity }); 147 | token.addGrant(voiceGrant); 148 | 149 | return new TwilioSignallingStream(token.toJwt(), url); 150 | } 151 | -------------------------------------------------------------------------------- /src/modules/vonage.ts: -------------------------------------------------------------------------------- 1 | const Vonage = require('@vonage/server-sdk'); 2 | import * as phone from '../phonenumber'; 3 | 4 | import { ILinkOpts } from './module'; 5 | 6 | interface IVonageData { 7 | apiKey: string, 8 | apiSecret: string, 9 | }; 10 | 11 | // CURRENTLY UNFINISHED 12 | // I had a vonage number months ago, then I stopped having time to work on this 13 | // so I deleted the number. Aparently, when you do that, you have to give them 14 | // your debit card to get a new one, even if you still have trial credits. 15 | // I was too lazy to do that. 16 | 17 | export default { 18 | friendly_name: 'Vonage', 19 | 20 | async tryLink({ webhook }: ILinkOpts, apiKey, apiSecret, ...numargs): Promise<[string, IVonageData]> { 21 | const number = (numargs && numargs.length && numargs.join(' ')) || ''; 22 | if (!apiKey || !apiSecret || number === '') { 23 | throw new TypeError('Usage: link vonage [apikey] [apisecret] [number...]'); 24 | } 25 | const e164 = phone.parsePhoneNumber(number)?.E164; 26 | if (!e164) { 27 | throw new TypeError(`Invalid phone number ${number}`); 28 | } 29 | const vonage = new Vonage({ apiKey, apiSecret }); 30 | try { 31 | const { numbers } = await new Promise( 32 | (res, rej) => vonage.number.get( 33 | { pattern: e164, search_pattern: 2 }, 34 | (e, d) => e ? rej(e) : res(d), 35 | ) 36 | ); 37 | if (numbers.length !== 1) { 38 | throw new Error(`Failed to find the number (${e164}) in your account.`); 39 | } 40 | } catch(e) { 41 | throw new Error('Failed to confirm phone number. Are the credentials correct?'); 42 | } 43 | return [e164, { apiKey, apiSecret }]; 44 | }, 45 | async getStatusMsg(data: object): Promise { 46 | return `Module not finished.`; 47 | }, 48 | 49 | async sendMessage(data: object, from: string, to: string, body: string): Promise { 50 | console.log(to, body); 51 | }, 52 | }; 53 | 54 | -------------------------------------------------------------------------------- /src/phonenumber.ts: -------------------------------------------------------------------------------- 1 | import * as LPN from 'google-libphonenumber'; 2 | 3 | const phoneUtil = LPN.PhoneNumberUtil.getInstance(); 4 | 5 | /** 6 | * Abstraction away from Google's libphonenumber for simplicity. 7 | * Represents a phone number. Created with `getPhoneNumberFromE164` or 8 | * `parsePhoneNumber`. 9 | */ 10 | export class PhoneNumber { 11 | constructor(protected readonly inum: LPN.PhoneNumber) {} 12 | 13 | formatForRegion(region?: string | null): string { 14 | return phoneUtil.formatInOriginalFormat(this.inum, region || undefined); 15 | } 16 | 17 | get defaultDisplayName(): string { 18 | return phoneUtil.format(this.inum, LPN.PhoneNumberFormat.INTERNATIONAL); 19 | } 20 | get E164(): string { 21 | return phoneUtil.format(this.inum, LPN.PhoneNumberFormat.E164); 22 | } 23 | 24 | get _region(): string | null { 25 | return phoneUtil.getRegionCodeForNumber(this.inum) || null; 26 | } 27 | 28 | toString(): string { 29 | return this.E164; 30 | } 31 | } 32 | 33 | /** 34 | * Gets a `PhoneNumber` class representing the provided `e164` number. This will 35 | * return `null` if the number is not strictly E164. 36 | * @param e164 - The E164 number. 37 | * @returns A `PhoneNumber` or `null` if the text isn't strict E164. 38 | */ 39 | export function getPhoneNumberFromE164(e164: string): PhoneNumber | null { 40 | // So its actually difficult to validate a number in a particular format with 41 | // libphonenumber... This hack checks for errors thrown with an invalid 42 | // number and checks that the e164 formatted number is the same as the input 43 | try { 44 | const num = phoneUtil.parse(e164); 45 | if (e164 !== phoneUtil.format(num, LPN.PhoneNumberFormat.E164)) { 46 | return null; 47 | } 48 | return new PhoneNumber(num); 49 | } catch (e) { 50 | return null; 51 | } 52 | } 53 | 54 | /** 55 | * Parses phone number text and returns a `PhoneNumber` for that text, or `null` 56 | * if it can't be parsed. 57 | * @param text - The text to be parsed. 58 | * @param sender_e164 - Optionally specify the sender's number to allow the 59 | * parser to infer which number the user is talking about based on their region. 60 | * @returns A `PhoneNumber` class or `null` if `text` can't be parsed. 61 | */ 62 | export function parsePhoneNumber(text: string, sender_e164?: string): PhoneNumber | null { 63 | const sender = sender_e164 && getPhoneNumberFromE164(sender_e164); 64 | try { 65 | return new PhoneNumber(phoneUtil.parse(text, (sender && sender._region) || undefined)); 66 | } catch (e) { 67 | return null; 68 | } 69 | } 70 | 71 | -------------------------------------------------------------------------------- /src/signalling_events.ts: -------------------------------------------------------------------------------- 1 | import ajv from './ajv'; 2 | import { JSONSchemaType } from 'ajv'; 3 | 4 | export interface IVoipEvent { 5 | call_id: string; 6 | party_id?: string; 7 | version: number; 8 | } 9 | export namespace IVoipEvent { 10 | export const JSON: JSONSchemaType = { 11 | $id: 'src/signalling_events.ts/IVoipEvent', 12 | type: 'object', 13 | properties: { 14 | call_id: { type: 'string' }, 15 | party_id: { type: 'string', nullable: true }, 16 | version: { type: 'number' }, 17 | }, 18 | required: ['call_id', 'version'], 19 | anyOf: [{ properties: { version: { const: 1 } }, required: ['party_id'] }], 20 | }; 21 | ajv.addSchema(JSON); 22 | }; 23 | 24 | export interface IVoipInvite extends IVoipEvent { 25 | lifetime: number; 26 | offer: { 27 | sdp: string; 28 | type: 'offer'; 29 | }; 30 | } 31 | export namespace IVoipInvite { 32 | export const JSON: JSONSchemaType = { 33 | $id: 'src/signalling_events.ts/IVoipInvite', 34 | type: 'object', 35 | properties: { 36 | call_id: { type: 'string' }, 37 | party_id: { type: 'string', nullable: true }, 38 | version: { type: 'number' }, 39 | lifetime: { type: 'number' }, 40 | offer: { 41 | type: 'object', 42 | properties: { 43 | sdp: { type: 'string' }, 44 | type: { type: 'string', enum: ['offer'] }, 45 | }, 46 | required: ['sdp', 'type'], 47 | }, 48 | }, 49 | required: ['call_id', 'version', 'lifetime', 'offer'], 50 | anyOf: [{ properties: { version: { const: 1 } }, required: ['party_id'] }], 51 | }; 52 | ajv.addSchema(JSON); 53 | export const validate = ajv.compile(JSON); 54 | }; 55 | 56 | export interface IVoipCandidates extends IVoipEvent { 57 | candidates: { 58 | candidate: string; 59 | sdpMLineIndex: number; 60 | sdpMid: string; 61 | }[]; 62 | } 63 | export namespace IVoipCandidates { 64 | export const JSON: JSONSchemaType = { 65 | $id: 'src/signalling_events.ts/IVoipCandidates', 66 | type: 'object', 67 | properties: { 68 | call_id: { type: 'string' }, 69 | party_id: { type: 'string', nullable: true }, 70 | version: { type: 'number' }, 71 | candidates: { 72 | type: 'array', 73 | items: { 74 | type: 'object', 75 | properties: { 76 | candidate: { type: 'string' }, 77 | sdpMLineIndex: { type: 'number' }, 78 | sdpMid: { type: 'string' }, 79 | }, 80 | required: ['candidate', 'sdpMLineIndex', 'sdpMid'], 81 | }, 82 | } 83 | }, 84 | required: ['call_id', 'version', 'candidates'], 85 | anyOf: [{ properties: { version: { const: 1 } }, required: ['party_id'] }], 86 | }; 87 | ajv.addSchema(JSON); 88 | export const validate = ajv.compile(JSON); 89 | }; 90 | 91 | export interface IVoipAnswer extends IVoipEvent { 92 | answer: { 93 | sdp: string; 94 | type: 'answer'; 95 | }; 96 | } 97 | export namespace IVoipAnswer { 98 | export const JSON: JSONSchemaType = { 99 | $id: 'src/signalling_events.ts/IVoipAnswer', 100 | type: 'object', 101 | properties: { 102 | call_id: { type: 'string' }, 103 | party_id: { type: 'string', nullable: true }, 104 | version: { type: 'number' }, 105 | answer: { 106 | type: 'object', 107 | properties: { 108 | sdp: { type: 'string' }, 109 | type: { type: 'string', enum: ['answer'] }, 110 | }, 111 | required: ['sdp', 'type'], 112 | }, 113 | }, 114 | required: ['call_id', 'version', 'answer'], 115 | anyOf: [{ properties: { version: { const: 1 } }, required: ['party_id'] }], 116 | }; 117 | ajv.addSchema(JSON); 118 | export const validate = ajv.compile(JSON); 119 | }; 120 | 121 | export interface IVoipHangup extends IVoipEvent {} 122 | export namespace IVoipHangup { 123 | export const JSON: JSONSchemaType = Object.assign( 124 | {}, 125 | IVoipEvent.JSON, 126 | { $id: 'src/signalling_events.ts/IVoipHangup' }, 127 | ); 128 | ajv.addSchema(JSON); 129 | export const validate = ajv.compile(JSON); 130 | }; 131 | 132 | export interface IVoipReject extends IVoipEvent { 133 | version: 1; 134 | party_id: string; 135 | } 136 | export namespace IVoipReject { 137 | export const JSON: JSONSchemaType = { 138 | $id: 'src/signalling_events.ts/IVoipReject', 139 | type: 'object', 140 | properties: { 141 | call_id: { type: 'string' }, 142 | party_id: { type: 'string' }, 143 | version: { type: 'number', const: 1 }, 144 | }, 145 | required: ['call_id', 'version', 'party_id'], 146 | }; 147 | ajv.addSchema(JSON); 148 | export const validate = ajv.compile(JSON); 149 | }; 150 | -------------------------------------------------------------------------------- /src/util.ts: -------------------------------------------------------------------------------- 1 | import * as EventEmitter from 'events'; 2 | 3 | class TypedEventEmitter extends EventEmitter { 4 | constructor() { 5 | super(); 6 | } 7 | } 8 | 9 | type FuncInterface = Record void>; 10 | 11 | interface TypedListenerFunc { 12 | ( 13 | event: U, listener: T[U] 14 | ): THIS; 15 | } 16 | interface TypedEmitFunc { 17 | ( 18 | event: U, ...args: Parameters 19 | ): boolean; 20 | } 21 | declare interface TypedEventEmitter { 22 | on: TypedListenerFunc; 23 | off: TypedListenerFunc; 24 | addListener: TypedListenerFunc; 25 | once: TypedListenerFunc; 26 | prependListener: TypedListenerFunc; 27 | prependOnceListener: TypedListenerFunc; 28 | removeListener: TypedListenerFunc; 29 | 30 | emit: TypedEmitFunc; 31 | } 32 | 33 | /** 34 | * Like a map, but takes exclusively tuples. I can't find a way to enforce this 35 | * with TS, but you **must** use a fixed length tuple for the `K` type. 36 | */ 37 | export class TupleLookup { 38 | /** 39 | * This is damn impossible to type, so I'm not going to. Enjoy. 40 | */ 41 | protected base_map = new Map(); 42 | get(key: K): V | undefined { 43 | let map: Map = this.base_map; 44 | for (const el of key) { 45 | map = map.get(el) as Map; 46 | if (!map) { 47 | return undefined; 48 | } 49 | } 50 | return map as unknown as V; 51 | } 52 | set(key: K, value: V | undefined): this { 53 | let map = this.base_map; 54 | let tmp: Map; 55 | for (const el of key.slice(0, key.length - 1)) { 56 | tmp = map.get(el) as Map; 57 | if (!tmp) { 58 | tmp = new Map(); 59 | map.set(el, tmp); 60 | } 61 | map = tmp; 62 | } 63 | if (value === undefined) { 64 | map.delete(key[key.length - 1]); 65 | } else { 66 | map.set(key[key.length - 1], value); 67 | } 68 | return this; 69 | } 70 | has(key: K): boolean { 71 | return Boolean(this.get(key)); 72 | } 73 | delete(key: K): this { 74 | this.set(key, undefined); 75 | return this; 76 | } 77 | } 78 | 79 | export { TypedEventEmitter }; 80 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "moduleResolution": "node", 5 | "target": "es2016", 6 | "noImplicitAny": false, 7 | "inlineSourceMap": true, 8 | "outDir": "./build", 9 | "types": ["node"], 10 | "strictNullChecks": true, 11 | "allowSyntheticDefaultImports": true, 12 | "skipLibCheck": true, 13 | }, 14 | "compileOnSave": true, 15 | "include": [ 16 | "src/**/*", 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "tslint:recommended", 3 | "rules": { 4 | "ordered-imports": false, 5 | "no-trailing-whitespace": "error", 6 | "max-classes-per-file": { 7 | "severity": "warning" 8 | }, 9 | "object-literal-sort-keys": "off", 10 | "no-any":{ 11 | "severity": "warning" 12 | }, 13 | "arrow-return-shorthand": true, 14 | "no-magic-numbers": [true, -1, 0, 1, 1000], 15 | "prefer-for-of": true, 16 | "typedef": { 17 | "severity": "warning" 18 | }, 19 | "await-promise": [true], 20 | "curly": true, 21 | "no-empty": false, 22 | "no-invalid-this": true, 23 | "no-string-throw": { 24 | "severity": "warning" 25 | }, 26 | "no-unused-expression": true, 27 | "prefer-const": true, 28 | "object-literal-sort-keys": false, 29 | "indent": [true, "tabs", 1], 30 | "max-file-line-count": { 31 | "severity": "warning", 32 | "options": [500] 33 | }, 34 | "no-duplicate-imports": true, 35 | "array-type": [true, "array"], 36 | "promise-function-async": true, 37 | "no-bitwise": true, 38 | "no-debugger": true, 39 | "no-floating-promises": true, 40 | "prefer-template": [true, "allow-single-concat"] 41 | } 42 | } 43 | --------------------------------------------------------------------------------