├── .github └── FUNDING.yml ├── .gitignore ├── LICENSE ├── Makefile ├── README.asciidoc ├── client.mk ├── config ├── accessrules ├── sys.config └── xabber_ws.config ├── erlang.mk ├── relx.config ├── src ├── client_handler.erl ├── redirect_handler.erl ├── ws_handler.erl ├── xabber_ws_app.erl └── xabber_ws_sup.erl └── xabber_ws.init.example /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: xabber 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .erlang.mk 2 | _rel 3 | deps 4 | ebin 5 | *.d 6 | priv/client 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PROJECT = xabber_ws 2 | PROJECT_DESCRIPTION = Xabber Websocket server 3 | PROJECT_VERSION = 0.3.4 4 | 5 | DEPS = cowlib cowboy p1_utils fast_xml lager 6 | dep_cowlib_commit = 2.7.0 7 | dep_cowboy_commit = 2.6.1 8 | dep_p1_utils = git https://github.com/processone/p1_utils.git 9 | dep_fast_xml = git https://github.com/processone/fast_xml.git 10 | dep_lager = git https://github.com/erlang-lager/lager.git 11 | 12 | ERLC_OPTS += +'{parse_transform, lager_transform}' 13 | 14 | include client.mk 15 | include erlang.mk 16 | -------------------------------------------------------------------------------- /README.asciidoc: -------------------------------------------------------------------------------- 1 | = Xabber WebSocket server 2 | 3 | Xabber WebSocket is a WebSocket XMPP client interface. It is a standalone WebSocket connection manager 4 | that enables a web application like https://github.com/redsolution/xabber-web[Xabber for Web] to communicate 5 | with multiple different XMPP servers 6 | 7 | === Build and run 8 | You need GNU `make` and `git` in your PATH. 9 | 10 | To build and run the app, use the following command: 11 | 12 | [source,bash] 13 | $ git clone https://github.com/redsolution/xabber-websocket.git 14 | $ cd xabber-websocket 15 | $ make run 16 | 17 | Then point your xmpp client to `ws://yourserver:8080/websocket` 18 | or you can use the embedded Xabber Web client on `http://yourserver:8080/client` 19 | 20 | === Install and run 21 | If `make` is successful, archive `xabber_ws-NN.tar.gz` with an application will be created 22 | in the `_rel/xabber_ws/` directory 23 | 24 | Copy the archive to your server and use the following command: 25 | 26 | [source,bash] 27 | $ mkdir xabber_ws 28 | $ tar -xvf xabber_ws-NN.tar.gz -C xabber_ws 29 | $ cd xabber_ws/bin 30 | $ ./xabber_ws start 31 | 32 | Then point your xmpp client to `ws://yourserver:8080/websocket` 33 | or you can use the embedded Xabber Web client on `http://yourserver:8080/client` 34 | 35 | === Online documentation 36 | 37 | https://github.com/redsolution/xabber-websocket/wiki[Wiki] -------------------------------------------------------------------------------- /client.mk: -------------------------------------------------------------------------------- 1 | all:: client 2 | rel:: client 3 | DEPS_DIR ?= $(CURDIR)/deps 4 | C_VERSION ?= develop 5 | 6 | client: 7 | @echo -n "Getting Xabber Web client ..." 8 | @if [ ! -d "$(DEPS_DIR)/xabber_web/.git" ]; then \ 9 | mkdir -p $(DEPS_DIR)/xabber_web ;\ 10 | cd $(DEPS_DIR)/xabber_web ;\ 11 | git init -q ;\ 12 | git remote add origin https://github.com/redsolution/xabber-web.git ;\ 13 | fi 14 | @cd $(DEPS_DIR)/xabber_web && git pull -q origin $(C_VERSION) && git checkout $(C_VERSION) 15 | @echo ". done." 16 | @echo -n "Copying Xabber Web files to 'priv' directory ." 17 | @mkdir -p priv/client 18 | @cp -r $(DEPS_DIR)/xabber_web/dist priv/client/ && echo -n "." 19 | @cp -r $(DEPS_DIR)/xabber_web/assets priv/client/ && echo -n "." 20 | @cp -r $(DEPS_DIR)/xabber_web/manifest.json priv/client/ && echo -n "." 21 | @cp -r $(DEPS_DIR)/xabber_web/background-images.xml priv/client/ && echo -n "." 22 | @cp -r $(DEPS_DIR)/xabber_web/background-patterns.xml priv/client/ && echo -n "." 23 | @sed "s/CONNECTION_URL: ''/CONNECTION_URL: (location.protocol == 'https:' ? 'wss:' : 'ws:')+'\/\/'+location.host+'\/websocket'/g" $(DEPS_DIR)/xabber_web/example_index.html > priv/client/index.html 24 | @echo ". done." 25 | -------------------------------------------------------------------------------- /config/accessrules: -------------------------------------------------------------------------------- 1 | ## Access rules 2 | ## Default action is set in xabber_ws.config. Set 'allow_all' parameter to true or false (restart required). 3 | ## New rules take effect without restarting server. 4 | ## Rule examples: 5 | ## rule server(xmpp domain) 6 | ## ----------------------------- 7 | ## allow myserver.com 8 | ## deny alienserver.com 9 | -------------------------------------------------------------------------------- /config/sys.config: -------------------------------------------------------------------------------- 1 | ["config/xabber_ws.config"]. -------------------------------------------------------------------------------- /config/xabber_ws.config: -------------------------------------------------------------------------------- 1 | [ 2 | {xabber_ws, 3 | [ 4 | {ws_path, "/websocket"}, 5 | {client_path, "/client"}, 6 | {port, 8080}, 7 | {ws_timeout, 60000}, 8 | {dns_timeout, 3000}, 9 | {dns_retries, 3}, 10 | {ssl, false}, 11 | {ssl_port, 8443}, 12 | {ssl_cacertfile, ""}, 13 | {ssl_certfile, ""}, 14 | {ssl_keyfile, ""}, 15 | {allow_all, true} 16 | ] 17 | }, 18 | {lager, [ 19 | {handlers, [ 20 | {lager_file_backend, [ 21 | {file, "xabber_ws.log"}, 22 | {level, info}, 23 | {size, 5242880}, 24 | {date, "$D0"}, 25 | {count, 5}]} 26 | ]} 27 | ]} 28 | ]. 29 | -------------------------------------------------------------------------------- /relx.config: -------------------------------------------------------------------------------- 1 | {release, {xabber_ws, "0.3.4"}, [xabber_ws]}. 2 | {extended_start_script, true}. 3 | {sys_config, "config/sys.config"}. 4 | {overlay, 5 | [ 6 | {copy, "config/xabber_ws.config", "config/xabber_ws.config"}, 7 | {copy, "config/accessrules", "config/accessrules"}, 8 | {copy, "xabber_ws.init.example", "bin/xabber_ws.init.example"} 9 | ]}. 10 | -------------------------------------------------------------------------------- /src/client_handler.erl: -------------------------------------------------------------------------------- 1 | %% All this is done to add the trailing slash 2 | 3 | -module(client_handler). 4 | -export([init/2]). 5 | 6 | init(Req0, Opts) -> 7 | Path = cowboy_req:path(Req0), 8 | case binary:last(Path) of 9 | 47 -> 10 | Index_file = filename:join([code:priv_dir(xabber_ws), "client", "index.html"]), 11 | Body = case file:read_file(Index_file) of 12 | {ok, Binary} -> 13 | Binary; 14 | {error, Reason} -> 15 | Reason_binary = atom_to_binary(Reason, utf8), 16 | <<"error: ", Reason_binary/binary,"">> 17 | end, 18 | Reply = cowboy_req:reply(200,#{ 19 | <<"content-type">> => <<"text/html; charset=utf-8">> 20 | }, Body, Req0), 21 | {ok, Reply, Opts}; 22 | _ -> 23 | Req1 = cowboy_req:set_resp_header(<<"Location">>, <>, Req0), 24 | Reply = cowboy_req:reply(301, Req1), 25 | {ok, Reply, Opts} 26 | end. 27 | -------------------------------------------------------------------------------- /src/redirect_handler.erl: -------------------------------------------------------------------------------- 1 | -module(redirect_handler). 2 | 3 | 4 | %% API 5 | -export([init/2]). 6 | 7 | init(Req0, RedirectPort) -> 8 | URI = cowboy_req:uri(Req0, #{scheme => "https", port => RedirectPort}), 9 | Req = cowboy_req:reply(301, #{<<"location">> => URI}, Req0), 10 | {ok, Req, RedirectPort}. 11 | -------------------------------------------------------------------------------- /src/ws_handler.erl: -------------------------------------------------------------------------------- 1 | -module(ws_handler). 2 | -include_lib("kernel/include/inet.hrl"). 3 | 4 | -record(xmlel, 5 | { 6 | name = <<"">> :: binary(), 7 | attrs = [] :: [attr()], 8 | children = [] :: [xmlel() | cdata()] 9 | }). 10 | 11 | -record(session, 12 | { 13 | src_ip, 14 | src_port, 15 | dst_ip, 16 | dst_port, 17 | connstep = 0, 18 | xmppserver, 19 | tcpsocket, 20 | xmlstream 21 | }). 22 | 23 | -type host_port() :: {inet:hostname(), inet:port_number()}. 24 | -type ip_port() :: {inet:ip_address(), inet:port_number()}. 25 | -type network_error() :: {error, inet:posix() | inet_res:res_error()}. 26 | -type(cdata() :: {xmlcdata, CData::binary()}). 27 | -type(attr() :: {Name::binary(), Value::binary()}). 28 | -type(xmlel() :: #xmlel{}). 29 | 30 | -export([init/2]). 31 | -export([terminate/3]). 32 | -export([websocket_init/1]). 33 | -export([websocket_handle/2]). 34 | -export([websocket_info/2]). 35 | 36 | 37 | -define(NS_STREAM, <<"http://etherx.jabber.org/streams">>). 38 | -define(WS_CLOSE, <<"">>). 39 | -define(STREAM_START(Server), <<"">>). 41 | -define(STREAM_CLOSE, <<"">>). 42 | -define(WS_TIMEOUT, 60000). 43 | -define(WEBSOCKET_PING, 15000). 44 | -define(NS_WS_PROXY, <<"urn:xabber:ws:proxy">>). 45 | 46 | init(Req, State) -> 47 | IsXMPPClient = case cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req) of 48 | undefined -> 49 | undefined; 50 | SubProtocols -> 51 | lists:member(<<"xmpp">>, SubProtocols) 52 | end, 53 | case IsXMPPClient of 54 | true -> 55 | Req2 = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, <<"xmpp">>, Req), 56 | {IP, Port} = cowboy_req:peer(Req), 57 | NewState = #session{src_ip = IP, src_port = Port}, 58 | {cowboy_websocket, Req2, NewState, 59 | #{idle_timeout => application:get_env(xabber_ws, ws_timeout, ?WS_TIMEOUT)}}; 60 | _ -> 61 | Req2 = cowboy_req:reply(400, #{<<"content-type">> => <<"text/plain">>}, 62 | <<"unsupported WebSocket protocol">>, Req), 63 | {ok, Req2, State} 64 | end. 65 | 66 | 67 | terminate(Arg0, Arg1, State) when is_record(State, session)-> 68 | lager:debug("Websocket terminated: ~p ~p ~p",[Arg0, Arg1, State]), 69 | case State#session.tcpsocket of 70 | undefined -> undefined; 71 | _ -> 72 | tcp_send(?STREAM_CLOSE, State#session.tcpsocket), 73 | tcp_close(State#session.tcpsocket) 74 | end, 75 | case State#session.xmlstream of 76 | undefined -> undefined; 77 | _ -> 78 | fxml_stream:close(State#session.xmlstream) 79 | end, 80 | ok; 81 | terminate(Arg0, Arg1, State) -> 82 | lager:debug("Websocket terminated: ~p ~p ~p",[Arg0, Arg1, State]), 83 | ok. 84 | 85 | 86 | websocket_init(State) -> 87 | {ok, State}. 88 | 89 | websocket_handle({text, Frame}, State) -> 90 | X1=fxml_stream:parse_element(Frame), 91 | #xmlel{name = Name, attrs = Attrs} = X1, 92 | case Name of 93 | <<"open">> -> 94 | erlang:start_timer(?WEBSOCKET_PING, self(), <<>>), 95 | {_,Server} = fxml:get_attr(<<"to">>, Attrs), 96 | if 97 | State#session.connstep == 0 -> 98 | case check_server(Server) of 99 | <<"allow">> -> 100 | case init_session_to_xmpp_server(Server) of 101 | {ok,connected, {Socket, IP, Port}} -> 102 | tcp_send(?STREAM_START(Server), Socket), 103 | NewStream = fxml_stream:new(self()), 104 | NewState = State#session{dst_ip = IP, dst_port = Port, 105 | connstep = 1, xmppserver = Server, tcpsocket = Socket, 106 | xmlstream = NewStream}, 107 | {ok,NewState,hibernate}; 108 | {err, Source, Why} -> 109 | forward_connection_error_to_ws(Source, Why), 110 | {ok,State,hibernate}; 111 | _ -> 112 | {stop, State} 113 | end; 114 | _ -> 115 | lager:warning("accessrules: Not allowed domain: ~p", [Server]), 116 | forward_connection_error_to_ws(accessrules, 'not-allowed-domain'), 117 | {ok,State,hibernate} 118 | end; 119 | true -> 120 | fxml_stream:close(State#session.xmlstream), 121 | NewStream = fxml_stream:new(self()), 122 | Server = State#session.xmppserver, 123 | tcp_send(?STREAM_START(Server),State#session.tcpsocket), 124 | NewState = State#session{ xmlstream = NewStream}, 125 | {ok, NewState, hibernate} 126 | end; 127 | <<"close">> -> 128 | tcp_send(?STREAM_CLOSE, State#session.tcpsocket), 129 | tcp_close(State#session.tcpsocket), 130 | {stop,State}; 131 | _ -> 132 | tcp_send(Frame, State#session.tcpsocket), 133 | {ok,State,hibernate} 134 | end; 135 | websocket_handle(pong, State) -> 136 | {ok, State, hibernate}; 137 | websocket_handle({ping, Payload}, State) -> 138 | {reply, {pong, Payload}, State, hibernate}; 139 | websocket_handle(_Frame, State) -> 140 | {ok, State, hibernate}. 141 | 142 | websocket_info({timeout, _Ref, _Msg}, State) -> 143 | erlang:start_timer(?WEBSOCKET_PING, self(), <<>>), 144 | {reply, {ping, <<>>}, State}; 145 | websocket_info({reply, fromxmppsrv, Packet}, State) -> 146 | {reply, {text, Packet}, State,hibernate}; 147 | websocket_info({tcp, Socket, Packet}, State) -> 148 | inet:setopts(Socket, [{active, once}]), 149 | Stream = fxml_stream:parse(State#session.xmlstream, Packet), 150 | NewState = State#session{xmlstream = Stream}, 151 | {ok, NewState, hibernate}; 152 | websocket_info({ssl, Socket, Packet}, State) -> 153 | ssl:setopts(Socket, [{active, once}]), 154 | Stream = fxml_stream:parse(State#session.xmlstream, Packet), 155 | NewState = State#session{xmlstream = Stream}, 156 | {ok, NewState, hibernate}; 157 | websocket_info({tcp_closed, Socket}, State) -> 158 | lager:info("tcp_socket: ~p connection closed",[Socket]), 159 | {stop, State}; 160 | websocket_info({ssl_closed, Socket}, State) -> 161 | lager:info("ssl_socket: ~p connection closed",[Socket]), 162 | {stop, State}; 163 | websocket_info({start_tls}, State) -> 164 | case tcp_upgrade_to_tls(State#session.tcpsocket) of 165 | {ok, SSLSocket}-> 166 | fxml_stream:close(State#session.xmlstream), 167 | NewStream = fxml_stream:new(self()), 168 | Server = State#session.xmppserver, 169 | tcp_send(?STREAM_START(Server),SSLSocket), 170 | NewState = State#session{connstep = 2, tcpsocket = SSLSocket, xmlstream = NewStream}, 171 | {ok, NewState, hibernate}; 172 | {err, _Why} -> 173 | inet:close(State#session.tcpsocket), 174 | {stop, State} 175 | end; 176 | websocket_info({ws,stop, Why}, State) -> 177 | lager:debug("web_socket closed: ~p",[Why]), 178 | {stop, State}; 179 | websocket_info({'$gen_event', XMLStreamEl}, State) -> 180 | XMLStreamEl2 = case XMLStreamEl of 181 | {xmlstreamstart, _, Attrs} -> 182 | if 183 | State#session.connstep < 2 -> 184 | Attrs2 = [{<<"xmlns">>, <<"urn:ietf:params:xml:ns:xmpp-framing">>} | 185 | lists:keydelete(<<"xmlns">>, 1, lists:keydelete(<<"xmlns:stream">>, 1, Attrs))], 186 | {xmlstreamelement, #xmlel{name = <<"open">>, attrs = Attrs2}}; 187 | true -> 188 | {xmlstreamelement , skip} 189 | end; 190 | {xmlstreamelement, #xmlel{name=Name} = XMLel} -> 191 | XMLel2 = case Name of 192 | <<"stream:features">> -> 193 | case fxml:get_subtag(XMLel, <<"proxy">>) of 194 | #xmlel{attrs = [{<<"xmlns">>, ?NS_WS_PROXY}]} -> 195 | send_proxy_iq(State); 196 | _ -> 197 | ok 198 | end, 199 | case fxml:get_subtag(XMLel, <<"starttls">>) of 200 | #xmlel{name = <<"starttls">>} -> 201 | tcp_send(<<"">>, 202 | State#session.tcpsocket), 203 | skip; 204 | _ -> 205 | fxml:replace_tag_attr(<<"xmlns:stream">>, ?NS_STREAM, XMLel) 206 | end; 207 | <<"stream:", _/binary>> -> 208 | fxml:replace_tag_attr(<<"xmlns:stream">>, ?NS_STREAM, XMLel); 209 | <<"proceed">> -> 210 | self() ! {start_tls}, 211 | skip; 212 | _ -> 213 | case fxml:get_tag_attr_s(<<"xmlns">>, XMLel) of 214 | <<"">> -> 215 | fxml:replace_tag_attr(<<"xmlns">>, <<"jabber:client">>, XMLel); 216 | _ -> 217 | XMLel 218 | end 219 | end, 220 | {xmlstreamelement , XMLel2}; 221 | {xmlstreamend, _} -> 222 | {xmlstreamelement, #xmlel{name = <<"close">>, 223 | attrs = [{<<"xmlns">>, <<"urn:ietf:params:xml:ns:xmpp-framing">>}]}}; 224 | _ -> 225 | XMLStreamEl 226 | end, 227 | case XMLStreamEl2 of 228 | {xmlstreamelement , skip} -> 229 | skip; 230 | {xmlstreamelement, El} -> 231 | self() ! {reply, fromxmppsrv, fxml:element_to_binary(El)}; 232 | {_, Bin} -> 233 | self() ! {reply, fromxmppsrv, Bin} 234 | end, 235 | {ok, State, hibernate}; 236 | websocket_info(Info, State) -> 237 | lager:debug("web_socket closed ~p", [Info]), 238 | {stop, State}. 239 | 240 | 241 | init_session_to_xmpp_server(Server) -> 242 | case dns_resolve(binary_to_list(Server)) of 243 | {ok, AddrPortList} -> 244 | case tcp_connect(AddrPortList, []) of 245 | {ok, Address, Port, Socket} -> 246 | lager:info("tcp_socket:~p Connected to ~s (~s:~p)", 247 | [Socket, Server, inet_parse:ntoa(Address), Port]), 248 | {ok,connected, {Socket, Address, Port}}; 249 | {error, Why} -> 250 | lager:error("ERROR: Can not connect to ~s~p: ~p ",[Server, 251 | [inet_parse:ntoa(A)++":"++integer_to_list(P) || {A,P} <- AddrPortList],Why]), 252 | {err,tcp_connect, Why} 253 | end; 254 | {error, Why} -> 255 | lager:error("ERROR: Can not resolve domain name ~p : ~p",[Server,Why]), 256 | {err, dns, 'dns-error'} 257 | end. 258 | 259 | tcp_connect([], Err) -> 260 | {error, Err}; 261 | tcp_connect([{Address, Port} | AddrPortList ], _Err) -> 262 | SocketOpts = [binary, {active, once}, {reuseaddr, true}, {nodelay, true}, {keepalive, true}], 263 | case gen_tcp:connect(Address, Port, SocketOpts) of 264 | {ok, Socket} -> 265 | {ok, Address, Port, Socket}; 266 | {error, Why} -> 267 | tcp_connect(AddrPortList, Why) 268 | end. 269 | 270 | tcp_upgrade_to_tls(Socket) -> 271 | case ssl:connect(Socket, []) of 272 | {ok, SSLSocket} -> 273 | lager:info("tcp_socket ~p upgrade to TLS ~p~n", [Socket,SSLSocket]), 274 | {ok, SSLSocket}; 275 | {error, Why} -> 276 | lager:error("ERROR TCP socket not upgrade to TLS ~p~n",[Why]), 277 | {err, Why} 278 | end. 279 | 280 | tcp_send(Packet, Socket) -> 281 | case Socket of 282 | {sslsocket,_,_} -> 283 | catch ssl:send(Socket,Packet); 284 | _ -> 285 | catch gen_tcp:send(Socket,Packet) 286 | end. 287 | 288 | 289 | tcp_close(Socket) -> 290 | case Socket of 291 | {sslsocket,_,_} -> 292 | catch ssl:close(Socket); 293 | _ -> 294 | catch inet:close(Socket) 295 | end. 296 | 297 | 298 | forward_connection_error_to_ws(_Source, Why) -> 299 | WhyBin= erlang:atom_to_binary(Why, utf8), 300 | self() ! {reply, fromxmppsrv, <<"<", 301 | WhyBin/binary," xmlns='urn:ietf:params:xml:ns:xmpp-streams'/>", 302 | "">>}, 303 | self() ! {reply, fromxmppsrv, ?WS_CLOSE}, 304 | self() ! {ws, stop, Why}. 305 | 306 | 307 | send_proxy_iq(#session{connstep = 1, src_ip = SrcIP, src_port = SrcPort, 308 | dst_ip = DstIP, dst_port = DstPort, tcpsocket = Socket}) -> 309 | IQ = iolist_to_binary(io_lib:format( 310 | " 311 | 312 | ", 313 | [?NS_WS_PROXY, inet:ntoa(SrcIP), SrcPort, inet:ntoa(DstIP), DstPort])), 314 | tcp_send(IQ, Socket); 315 | send_proxy_iq(_) -> ok. 316 | 317 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 318 | %%% Access rules %% 319 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 320 | 321 | check_server(Server) -> 322 | %% domain names consisting only of numbers and dots are not allowed 323 | try binary_to_integer(binary:replace(Server,<<$.>>,<<>>)) of 324 | _ -> 325 | <<"deny">> 326 | catch _:_ -> 327 | check_access(Server) 328 | end. 329 | 330 | check_access(Server) -> 331 | Def_rule = case application:get_env(xabber_ws, allow_all, true) of 332 | true -> <<"allow">>; 333 | _ -> <<"deny">> 334 | end, 335 | ACL_file_path = filename:join([code:root_dir(), "config", "accessrules"]), 336 | case file:read_file(ACL_file_path) of 337 | {ok,<<>>} -> Def_rule; 338 | {ok, Binary} -> 339 | {ok, MP} = re:compile("[#|%].*\n"), 340 | Binary2 = re:replace(Binary,MP,"\n",[{return,binary},global]), 341 | ACL = lists:filtermap( 342 | fun(X) -> case string:lexemes(string:lowercase(X)," ") of 343 | [] -> false; 344 | [W1, W2] -> 345 | {true, {W1, W2}}; 346 | _ -> 347 | lager:error("accessrules: Wrong record in accessrules: ~s",[X]), 348 | false 349 | end 350 | end, 351 | binary:split(Binary2,<<"\n">>,[global])), 352 | case lists:keyfind(Server, 2, ACL) of 353 | {Rule, _ } -> Rule; 354 | _ -> Def_rule 355 | end; 356 | {error, Reason} -> 357 | lager:error("accessrules: File read error: ~p",[Reason]), 358 | Def_rule 359 | end. 360 | 361 | 362 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 363 | %%% DNS lookup. %% 364 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 365 | 366 | 367 | -spec dns_resolve(string()) -> {ok, [ip_port()]} | network_error(). 368 | dns_resolve(Host) -> 369 | Timeout = application:get_env(xabber_ws, dns_timeout, 3000), 370 | Retries = application:get_env(xabber_ws, dns_retries, 3), 371 | case srv_record_resolve(Host, Timeout, Retries) of 372 | {error, _Reason} -> 373 | a_lookup([{Host, 5222}], [], {error, nxdomain}); 374 | {ok, HostPortList} -> 375 | a_lookup(HostPortList, [], {error, nxdomain}) 376 | end. 377 | 378 | 379 | -spec srv_record_resolve(string(), timeout(), integer()) -> 380 | {ok, [host_port()]} | network_error(). 381 | srv_record_resolve(_Host, _Timeout, Retries) when Retries < 1 -> 382 | {error, timeout}; 383 | srv_record_resolve(Host, Timeout, Retries) -> 384 | case inet_res:getbyname("_xmpp-client._tcp." ++ Host, srv, Timeout) of 385 | {ok, HostsList} -> 386 | to_host_port_list(HostsList); 387 | {error, timeout} -> 388 | srv_record_resolve(Host, Timeout, Retries - 1); 389 | {error, _} = Err -> 390 | Err 391 | end. 392 | 393 | -spec a_lookup([{inet:hostname(), inet:port_number()}], 394 | [ip_port()], network_error()) -> {ok, [ip_port()]} | network_error(). 395 | a_lookup([{Host, Port}| HostPortList], Acc, Err) -> 396 | Timeout = application:get_env(xabber_ws, dns_timeout, 3000), 397 | Retries = application:get_env(xabber_ws, dns_retries, 3), 398 | case a_lookup(Host, Port, Timeout, Retries) of 399 | {error, Reason} -> 400 | a_lookup(HostPortList, Acc, {error, Reason}); 401 | {ok, AddrPorts} -> 402 | a_lookup(HostPortList, Acc ++ AddrPorts, Err) 403 | end; 404 | a_lookup([], [], Err) -> 405 | Err; 406 | a_lookup([], Acc, _) -> 407 | {ok, Acc}. 408 | 409 | -spec a_lookup(inet:hostname(), inet:port_number(), 410 | timeout(), integer()) -> {ok, [ip_port()]} | network_error(). 411 | a_lookup(_Host, _Port, _Timeout, Retries) when Retries < 1 -> 412 | {error, timeout}; 413 | a_lookup(Host, Port, Timeout, Retries) -> 414 | Start = erlang:monotonic_time(milli_seconds), 415 | case inet:gethostbyname(Host, inet, Timeout) of 416 | {error, nxdomain} = Err -> 417 | End = erlang:monotonic_time(milli_seconds), 418 | if (End - Start) >= Timeout -> 419 | a_lookup(Host, Port, Timeout, Retries - 1); 420 | true -> 421 | Err 422 | end; 423 | {error, _} = Err -> 424 | Err; 425 | {ok, HostsList} -> 426 | to_addr_port_list(HostsList, Port) 427 | end. 428 | 429 | -spec to_host_port_list(inet:hostent()) -> {ok, [host_port()]} | {error, nxdomain}. 430 | to_host_port_list(#hostent{h_addr_list = AddrList}) -> 431 | AddrList2 = lists:flatmap( 432 | fun({Priority, Weight, Port, Host}) -> 433 | [{Priority + 65536 - Weight + rand:uniform(), Host, Port}]; 434 | (_) -> 435 | [] 436 | end, AddrList), 437 | HostPortList = [{Host, Port} 438 | || {_, Host, Port} <- lists:usort(AddrList2)], 439 | case HostPortList of 440 | [] -> {error, nxdomain}; 441 | _ -> {ok, HostPortList} 442 | end. 443 | 444 | -spec to_addr_port_list(inet:hostent(), inet:port_number()) -> 445 | {ok, [ip_port()]} | {error, nxdomain}. 446 | to_addr_port_list(#hostent{h_addr_list = AddrList}, Port) -> 447 | AddrPortList = lists:map(fun(Addr) -> {Addr, Port} end, AddrList), 448 | case AddrPortList of 449 | [] -> {error, nxdomain}; 450 | _ -> {ok, AddrPortList} 451 | end. 452 | 453 | -------------------------------------------------------------------------------- /src/xabber_ws_app.erl: -------------------------------------------------------------------------------- 1 | -module(xabber_ws_app). 2 | -behaviour(application). 3 | 4 | %% API. 5 | -export([start/2]). 6 | -export([stop/1]). 7 | 8 | %% Defaults 9 | -define(PORT, 8080). 10 | -define(WS_PATH, "/websocket"). 11 | -define(CLIENT_PATH, "/client"). 12 | -define(SSL, false). 13 | -define(SSL_PORT, 8443). 14 | 15 | 16 | %% API. 17 | start(_Type, _Args) -> 18 | case load_config() of 19 | start -> 20 | xabber_ws_sup:start_link(); 21 | stop -> 22 | init:stop(), 23 | {error, bad_config} 24 | end. 25 | 26 | load_config() -> 27 | Port = application:get_env(xabber_ws, port, ?PORT), 28 | WS_path = application:get_env(xabber_ws, ws_path, ?WS_PATH), 29 | Client_path = application:get_env(xabber_ws, client_path, ?CLIENT_PATH), 30 | Dispatch = cowboy_router:compile([ 31 | {'_', [ 32 | {WS_path, ws_handler, []}, 33 | {Client_path, client_handler, []}, 34 | {Client_path ++ "/[...]", cowboy_static, {priv_dir, xabber_ws, "client/"}} 35 | ]} 36 | ]), 37 | Opts = #{env => #{dispatch => Dispatch}}, 38 | case application:get_env(xabber_ws, ssl, ?SSL) of 39 | true -> 40 | case check_ssl_params([ssl_cacertfile, ssl_certfile, ssl_keyfile]) of 41 | [] -> 42 | stop; 43 | [CAFile, CertFile, KeyFile] -> 44 | SSL_port = application:get_env(xabber_ws, ssl_port, ?SSL_PORT), 45 | {ok, _} = cowboy:start_tls(https, [ 46 | {port, SSL_port}, 47 | {cacertfile, CAFile}, 48 | {certfile, CertFile}, 49 | {keyfile, KeyFile} 50 | ], Opts), 51 | Dispatch_redirect =cowboy_router:compile([{'_', [{'_', redirect_handler, SSL_port}]}]), 52 | {ok, _} = cowboy:start_clear(http, [{port, Port}], #{env => #{dispatch => Dispatch_redirect}}), 53 | start 54 | end; 55 | _ -> 56 | {ok, _} = cowboy:start_clear(http, [{port, Port}], Opts), 57 | start 58 | end. 59 | 60 | stop(_State) -> 61 | ok. 62 | 63 | check_ssl_params(Params) -> 64 | try 65 | get_ssl_params_value(Params, []) 66 | catch 67 | throw:{undefined, Param} -> 68 | lager:error("SSL config error: ~p is undefined",[Param]), []; 69 | throw:{unavailable, File} -> 70 | lager:error("SSL config error: ~p is unavailable",[File]), [] 71 | end. 72 | 73 | 74 | get_ssl_params_value([H|T], Values) -> 75 | case application:get_env(xabber_ws, H) of 76 | undefined -> 77 | throw({undefined, H}); 78 | {ok,[]} -> 79 | throw({undefined, H}); 80 | {ok,Val} -> 81 | case filelib:is_regular(Val) of 82 | true -> 83 | get_ssl_params_value(T, [Val|Values]); 84 | _ -> 85 | throw({unavailable, Val}) 86 | end 87 | end; 88 | get_ssl_params_value([], Values) -> 89 | lists:reverse(Values). 90 | -------------------------------------------------------------------------------- /src/xabber_ws_sup.erl: -------------------------------------------------------------------------------- 1 | -module(xabber_ws_sup). 2 | -behaviour(supervisor). 3 | 4 | %% API. 5 | -export([start_link/0]). 6 | 7 | %% supervisor. 8 | -export([init/1]). 9 | 10 | %% API. 11 | 12 | -spec start_link() -> {ok, pid()}. 13 | start_link() -> 14 | supervisor:start_link({local, ?MODULE}, ?MODULE, []). 15 | 16 | %% supervisor. 17 | 18 | init([]) -> 19 | Procs = [], 20 | {ok, {{one_for_one, 10, 10}, Procs}}. 21 | -------------------------------------------------------------------------------- /xabber_ws.init.example: -------------------------------------------------------------------------------- 1 | #! /bin/bash 2 | 3 | ### BEGIN INIT INFO 4 | # Provides: xabber_ws 5 | # Required-Start: $remote_fs $network $named $time 6 | # Required-Stop: $remote_fs $network $named $time 7 | # Default-Start: 2 3 4 5 8 | # Default-Stop: 0 1 6 9 | # Short-Description: Starts Xabber WebSocket Server 10 | # Description: Starts Xabber WebSocket Server 11 | ### END INIT INFO 12 | 13 | 14 | set -o errexit 15 | 16 | DIR=/opt/xabber_websocket_dir 17 | DAEMON="$DIR"/bin/xabber_ws 18 | USER=xabber_websoket_user 19 | 20 | test -x "$DAEMON" || { 21 | echo "ERROR: xabber_ws not found: $DIR" 22 | exit 1 23 | } 24 | getent passwd "$USER" >/dev/null || { 25 | echo "ERROR: System user not found: $USER" 26 | exit 2 27 | } 28 | 29 | export PATH="${PATH:+$PATH:}/usr/sbin:/sbin" 30 | 31 | case "$1" in 32 | start) 33 | test -x "$DAEMON" || exit 0 34 | printf "%-50s" "Starting Xabber WebSocket Server..." 35 | su - $USER -c "$DAEMON start > /dev/null 2>&1"; 36 | 37 | # wait for pid 38 | for (( i=0; i<10; ++i )); do 39 | OUT="$DAEMON pid"; 40 | if [ $? == 0 ]; then PID=$OUT; break; fi 41 | sleep 1; 42 | done 43 | 44 | if [ -z "$PID" ]; then 45 | printf "%s\n" "Fail" 46 | else 47 | printf "%s\n" "Ok" 48 | fi 49 | ;; 50 | stop) 51 | test -x "$DAEMON" || exit 0 52 | printf "%-50s" "Stopping Xabber WebSocket Server..." 53 | su - $USER -c "$DAEMON stop > /dev/null 2>&1"; 54 | if [ $? != 0 ]; then 55 | printf "%s\n" "Node is not running!" 56 | else 57 | printf "%s\n" "Ok" 58 | fi 59 | ;; 60 | status) 61 | test -x "$DAEMON" || exit 0 62 | printf "%-50s" "Checking Xabber WebSocket Server..." 63 | su - $USER -c "$DAEMON pid > /dev/null 2>&1"; 64 | if [ $? != 0 ]; then 65 | printf "%s\n" "Node is not running!" 66 | else 67 | printf "%s\n" "Ok" 68 | fi 69 | ;; 70 | reload) 71 | "$0" stop 72 | "$0" start 73 | ;; 74 | *) 75 | echo "Usage: $0 {start|stop|reload|status}" 76 | exit 1 77 | esac 78 | 79 | exit 0 --------------------------------------------------------------------------------