├── CMakeLists.txt ├── Kconfig ├── LICENSE ├── README.md ├── component.mk ├── include ├── websocket.h └── websocket_server.h ├── websocket.c └── websocket_server.c /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | set(COMPONENT_SRCS "websocket.c" "websocket_server.c") 2 | set(COMPONENT_ADD_INCLUDEDIRS "./include") 3 | set(COMPONENT_REQUIRES lwip mbedtls) 4 | register_component() -------------------------------------------------------------------------------- /Kconfig: -------------------------------------------------------------------------------- 1 | 2 | menu "WebSocket Server" 3 | 4 | config WEBSOCKET_SERVER_MAX_CLIENTS 5 | int "Max clients" 6 | range 1 1000 7 | default 20 8 | help 9 | Maximum number of clients that the WebSocket 10 | server can handle at a time. 11 | 12 | config WEBSOCKET_SERVER_QUEUE_SIZE 13 | int "Queue read size" 14 | range 1 100 15 | default 10 16 | help 17 | Size of the queue to deal with incoming 18 | WebSocket messages. The queue holds the 19 | connection, not the actual message. 20 | 21 | config WEBSOCKET_SERVER_QUEUE_TIMEOUT 22 | int "Queue timeout" 23 | range 0 10000 24 | default 30 25 | help 26 | Timeout for adding new connections to the 27 | read queue. 28 | 29 | config WEBSOCKET_SERVER_TASK_STACK_DEPTH 30 | int "Stack depth" 31 | range 3000 20000 32 | default 6000 33 | help 34 | Stack depth for the WebSocket server. The task 35 | handles reads. 36 | 37 | config WEBSOCKET_SERVER_TASK_PRIORITY 38 | int "Priority" 39 | range 1 20 40 | default 5 41 | help 42 | Priority for the WebSocket server. The task 43 | handles reads. 44 | 45 | config WEBSOCKET_SERVER_PINNED 46 | bool "Server pinned to core" 47 | default false 48 | help 49 | Pin the WebSocket server task to a specific core. 50 | The task handles reads. 51 | 52 | config WEBSOCKET_SERVER_PINNED_CORE 53 | int "Pinned core" 54 | depends on WEBSOCKET_SERVER_PINNED 55 | range 0 1 56 | default 0 57 | help 58 | Core that the WebSocket server is pinned to. 59 | The task handles reads. 60 | 61 | endmenu 62 | -------------------------------------------------------------------------------- /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 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | By Blake Felt - blake.w.felt@gmail.com 3 | 4 | ESP32 WebSocket 5 | ================== 6 | 7 | A component for WebSockets on ESP-IDF using lwip netconn. 8 | For an example, see https://github.com/Molorius/ESP32-Examples. 9 | 10 | To add to a project, type: 11 | `git submodule add https://github.com/Molorius/esp32-websocket.git components/websocket` 12 | into the base directory of your project. 13 | 14 | Some configuration options for the Server can be found in menuconfig in: 15 | Component config ---> WebSocket Server 16 | 17 | This presently only has the WebSocket server code working, but client code will be added in the future (the groundwork is there). 18 | 19 | The code only allows one WebSocket server at a time, but this merely handles all incoming reads. New connections are added externally, so this can be used to hold various WebSocket connections. 20 | 21 | While this can theoretically handle very large messages, hardware constraints (RAM) limits the size of messages. I highly recommend not using more than 5000 bytes per message, but no constraint is in place for this. 22 | 23 | Any suggestions or fixes are gladly appreciated. 24 | 25 | Table of Contents 26 | ================= 27 | * [Enumerations](#enumerations) 28 | * [WEBSOCKET_TYPE_t](#enum-websocket_type_t) 29 | * [Functions](#functions) 30 | * [ws_server_start](#int-ws_server_start) 31 | * [ws_server_stop](#int-ws_server_stop) 32 | * [ws_server_add_client](#int-ws_server_add_clientstruct-netconn-connchar-msguint16_t-lenchar-urlvoid-callback) 33 | * [ws_server_add_client_protocol](#int-ws_server_add_client_protocolstruct-netconn-connchar-msguint16_t-lenchar-urlchar-protocolvoid-callback) 34 | * [ws_server_len_url](#int-ws_server_len_urlchar-url) 35 | * [ws_server_len_all](#int-ws_server_len_all) 36 | * [ws_server_remove_client](#int-ws_server_remove_clientint-num) 37 | * [ws_server_remove_clients](#int-ws_server_remove_clientschar-url) 38 | * [ws_server_remove_all](#int-ws_server_remove_all) 39 | * [ws_server_send_text_client](#int-ws_server_send_text_clientint-numchar-msguint64_t-len) 40 | * [ws_server_send_text_clients](#int-ws_server_send_text_clientschar-urlchar-msguint64_t-len) 41 | * [ws_server_send_text_all](#int-ws_server_send_text_allchar-msguint64_t-len) 42 | * [ws_server_send_text_client_from_callback](#int-ws_server_send_text_client_from_callbackint-numchar-msguint64_t-len) 43 | * [ws_server_send_text_clients_from_callback](#int-ws_server_send_text_clients_from_callbackchar-urlchar-msguint64_t-len) 44 | * [ws_server_send_text_all_from_callback](#int-ws_server_send_text_all_from_callbackchar-msguint64_t-len) 45 | * [ws_server_send_bin_client_from_callback](#int-ws_server_send_bin_client_from_callbackint-numchar-msguint64_t-len) 46 | * [ws_server_send_bin_clients_from_callback](#int-ws_server_send_bin_clients_from_callbackchar-urlchar-msguint64_t-len) 47 | * [ws_server_send_bin_all_from_callback](#int-ws_server_send_bin_all_from_callbackchar-msguint64_t-len) 48 | 49 | Enumerations 50 | ============ 51 | 52 | enum WEBSOCKET_TYPE_t 53 | --------------------- 54 | 55 | The different types of WebSocket events. 56 | 57 | *Values* 58 | * `WEBSOCKET_CONNECT`: A new client has successfully connected. 59 | * `WEBSOCKET_DISCONNECT_EXTERNAL`: The other side sent a disconnect message. 60 | * `WEBSOCKET_DISCONNECT_INTERNAL`: The esp32 server sent a disconnect message. 61 | * `WEBSOCKET_DISCONNECT_ERROR`: Disconnect due to a connection error. 62 | * `WEBSOCKET_TEXT`: Incoming text. 63 | * `WEBSOCKET_BIN`: Incoming binary. 64 | * `WEBSOCKET_PING`: The other side sent a ping message. 65 | * `WEBSOCKET_PONG`: The other side successfully replied to our ping. 66 | 67 | Functions 68 | ========= 69 | 70 | int ws_server_start() 71 | --------------------- 72 | 73 | Starts the WebSocket Server. Use this function before attempting any 74 | sort of transmission or adding a client. 75 | 76 | *Returns* 77 | * 1: successful start 78 | * 0: server already running 79 | 80 | int ws_server_stop() 81 | -------------------- 82 | 83 | Stops the WebSocket Server. New clients can still be added and 84 | messages can be sent, but new messages will not be received. 85 | 86 | *Returns* 87 | * 1: successful stop 88 | * 0: server was not running before 89 | 90 | int ws_server_add_client(struct netconn* conn,char* msg,uint16_t len,char* url,void *callback) 91 | ---------------------------------------------------------------------------------------------- 92 | 93 | Adds a client to the WebSocket Server handler and performs the necessary handshake. 94 | 95 | *Parameters* 96 | * `conn`: the lwip netconn connection. 97 | * `msg`: the entire incoming request message to join the server. Necessary for the handshake. 98 | * `len`: the length of `msg`. 99 | * `url`: the NULL-terminated url. Used to keep track of clients, not required. 100 | * `callback`: the callback that is used to run WebSocket events. This must be with parameters(uint8_t num,WEBSOCKET_TYPE_t type,char* msg,uint64_t len) where "num" is the client number, "type" is the event type, "msg" is the incoming message, and "len" is the message length. The callback itself is optional. 101 | 102 | *Returns* 103 | * -2: not enough information in `msg` to perform handshake. 104 | * -1: server full, or connection issue. 105 | * 0 or greater: connection number 106 | 107 | int ws_server_add_client_protocol(struct netconn* conn,char* msg,uint16_t len,char* url,char* protocol,void *callback) 108 | ---------------------------------------------------------------------------------------------------------------------- 109 | 110 | Adds a client to the WebSocket Server handler and performs the necessary handshake. Will also send 111 | the specified protocol. 112 | 113 | *Parameters* 114 | * `conn`: the lwip netconn connection. 115 | * `msg`: the entire incoming request message to join the server. Necessary for the handshake. 116 | * `len`: the length of `msg`. 117 | * `url`: the NULL-terminated url. Used to keep track of clients, not required. 118 | * `protocol`: the NULL-terminated protocol. This will be sent to the client in the header. 119 | * `callback`: the callback that is used to run WebSocket events. This must be with parameters(uint8_t num,WEBSOCKET_TYPE_t type,char* msg,uint64_t len) where "num" is the client number, "type" is the event type, "msg" is the incoming message, and "len" is the message length. The callback itself is optional. 120 | 121 | *Returns* 122 | * -2: not enough information in `msg` to perform handshake. 123 | * -1: server full, or connection issue. 124 | * 0 or greater: connection number 125 | 126 | int ws_server_len_url(char* url) 127 | -------------------------------- 128 | 129 | Returns the number of clients connected to the specified URL. 130 | 131 | *Parameters* 132 | * `url`: the NULL-terminated string of the desired URL. 133 | 134 | *Returns* 135 | * The number of clients connected to the specified URL. 136 | 137 | int ws_server_len_all() 138 | ----------------------- 139 | 140 | *Returns* 141 | * The number of connected clients. 142 | 143 | int ws_server_remove_client(int num) 144 | ------------------------------------ 145 | 146 | Removes the desired client. 147 | 148 | *Parameters* 149 | * `num`: the client number 150 | 151 | *Returns* 152 | * 0: not a valid client number 153 | * 1: client disconnected 154 | 155 | int ws_server_remove_clients(char* url) 156 | --------------------------------------- 157 | 158 | Removes all clients connect to the desired URL. 159 | 160 | *Parameters* 161 | * `url`: the NULL-terminated URL. 162 | 163 | *Returns* 164 | * The number of clients that were disconnected. 165 | 166 | int ws_server_remove_all() 167 | -------------------------- 168 | 169 | Removes all clients from server. 170 | 171 | *Returns* 172 | * The number of clients that were disconnected. 173 | 174 | int ws_server_send_text_client(int num,char* msg,uint64_t len) 175 | -------------------------------------------------------------- 176 | 177 | Sends the desired message to the client. 178 | 179 | *Parameters* 180 | * `num`: the client's number. 181 | * `msg`: the desired message. 182 | * `len`: the length of the message. 183 | 184 | *Returns* 185 | * 0: message not sent properly 186 | * 1: message sent 187 | 188 | int ws_server_send_text_clients(char* url,char* msg,uint64_t len) 189 | ----------------------------------------------------------------- 190 | 191 | Sends the message to clients connected to the desired URL. 192 | 193 | *Parameters* 194 | * `url`: the NULL-terminated URL. 195 | * `msg`: the desired message. 196 | * `len`: the length of the message. 197 | 198 | *Returns* 199 | * The number of clients that the message was sent to. 200 | 201 | int ws_server_send_text_all(char* msg,uint64_t len) 202 | --------------------------------------------------- 203 | 204 | Sends the message to all connected clients. 205 | 206 | *Parameters* 207 | * `msg`: the desired message 208 | * `len`: the length of the message 209 | 210 | *Returns* 211 | * The number of clients that the message was sent to. 212 | 213 | int ws_server_send_text_client_from_callback(int num,char* msg,uint64_t len) 214 | ---------------------------------------------------------------------------- 215 | 216 | Sends the desired message to the client. Only use this inside the callback function. 217 | 218 | *Parameters* 219 | * `num`: the client's number. 220 | * `msg`: the desired message. 221 | * `len`: the length of the message. 222 | 223 | *Returns* 224 | * 0: message not sent properly 225 | * 1: message sent 226 | 227 | int ws_server_send_text_clients_from_callback(char* url,char* msg,uint64_t len) 228 | ------------------------------------------------------------------------------- 229 | 230 | Sends the message to clients connected to the desired URL. Only use this inside the callback function. 231 | 232 | *Parameters* 233 | * `url`: the NULL-terminated URL. 234 | * `msg`: the desired message. 235 | * `len`: the length of the message. 236 | 237 | *Returns* 238 | * The number of clients that the message was sent to. 239 | 240 | int ws_server_send_text_all_from_callback(char* msg,uint64_t len) 241 | ----------------------------------------------------------------- 242 | 243 | Sends the message to all connected clients. Only use this inside the callback function. 244 | 245 | *Parameters* 246 | * `msg`: the desired message 247 | * `len`: the length of the message 248 | 249 | *Returns* 250 | * The number of clients that the message was sent to. 251 | 252 | int ws_server_send_bin_client_from_callback(int num,char* msg,uint64_t len) 253 | ---------------------------------------------------------------------------- 254 | 255 | Sends the desired binary message to the client. Only use this inside the callback function. 256 | 257 | *Parameters* 258 | * `num`: the client's number. 259 | * `msg`: the desired message. 260 | * `len`: the length of the message. 261 | 262 | *Returns* 263 | * 0: message not sent properly 264 | * 1: message sent 265 | 266 | int ws_server_send_bin_clients_from_callback(char* url,char* msg,uint64_t len) 267 | ------------------------------------------------------------------------------- 268 | 269 | Sends the binary message to clients connected to the desired URL. Only use this inside the callback function. 270 | 271 | *Parameters* 272 | * `url`: the NULL-terminated URL. 273 | * `msg`: the desired message. 274 | * `len`: the length of the message. 275 | 276 | *Returns* 277 | * The number of clients that the message was sent to. 278 | 279 | int ws_server_send_bin_all_from_callback(char* msg,uint64_t len) 280 | ----------------------------------------------------------------- 281 | 282 | Sends a binary message to all connected clients. Only use this inside the callback function. 283 | 284 | *Parameters* 285 | * `msg`: the desired message 286 | * `len`: the length of the message 287 | 288 | *Returns* 289 | * The number of clients that the message was sent to. 290 | -------------------------------------------------------------------------------- /component.mk: -------------------------------------------------------------------------------- 1 | # websocket component makefile 2 | # all files are in default positions -------------------------------------------------------------------------------- /include/websocket.h: -------------------------------------------------------------------------------- 1 | 2 | /* 3 | esp32-websocket - a websocket component on esp-idf 4 | Copyright (C) 2019 Blake Felt - blake.w.felt@gmail.com 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program. If not, see . 18 | */ 19 | 20 | #ifdef __cplusplus 21 | extern "C" { 22 | #endif 23 | 24 | #ifndef WEBSOCKET_H 25 | #define WEBSOCKET_H 26 | 27 | #include "lwip/api.h" 28 | 29 | // the different codes for the callbacks 30 | typedef enum { 31 | WEBSOCKET_CONNECT, 32 | WEBSOCKET_DISCONNECT_EXTERNAL, // the other side disconnected 33 | WEBSOCKET_DISCONNECT_INTERNAL, // the esp32 disconnected 34 | WEBSOCKET_DISCONNECT_ERROR, // disconnect due to error 35 | WEBSOCKET_TEXT, 36 | WEBSOCKET_BIN, 37 | WEBSOCKET_PING, 38 | WEBSOCKET_PONG 39 | } WEBSOCKET_TYPE_t; 40 | 41 | // websocket operation codes 42 | typedef enum { 43 | WEBSOCKET_OPCODE_CONT = 0x0, 44 | WEBSOCKET_OPCODE_TEXT = 0x1, 45 | WEBSOCKET_OPCODE_BIN = 0x2, 46 | WEBSOCKET_OPCODE_CLOSE = 0x8, 47 | WEBSOCKET_OPCODE_PING = 0x9, 48 | WEBSOCKET_OPCODE_PONG = 0xA 49 | } WEBSOCKET_OPCODES_t; 50 | 51 | // the header, useful for creating and quickly passing to functions 52 | typedef struct { 53 | union { 54 | struct { 55 | uint16_t LEN:7; // bits 0.. 6 56 | uint16_t MASK:1; // bit 7 57 | uint16_t OPCODE:4; // bits 8.. 11 58 | uint16_t :3; // bits 12.. 14 reserved 59 | uint16_t FIN:1; // bit 15 60 | } bit; 61 | struct { 62 | uint16_t ONE:8; // bits 0.. 7 63 | uint16_t ZERO:8; // bits 8.. 15 64 | } pos; 65 | } param; // the initial parameters of the header 66 | uint64_t length; // actual message length 67 | union { 68 | char part[4]; // the mask, array 69 | uint32_t full; // the mask, all 32 bits 70 | } key; // masking key 71 | bool received; // was a message successfully received? 72 | } ws_header_t; 73 | 74 | // a client, with space for a server callback or a client callback (depending on use) 75 | typedef struct { 76 | struct netconn* conn; // the connection 77 | char* url; // the associated url, null terminated 78 | char* protocol; // the associated protocol, null terminated 79 | bool ping; // did we send a ping? 80 | WEBSOCKET_OPCODES_t last_opcode; // the previous opcode 81 | char* contin; // any continuation piece 82 | bool contin_text; // is the continue a binary or text? 83 | uint64_t len; // length of continuation 84 | uint32_t unfinished; // sometimes netconn doesn't read a full frame, treated similarly to a continuation frame 85 | void (*ccallback)(WEBSOCKET_TYPE_t type,char* msg,uint64_t len); // client callback 86 | void (*scallback)(uint8_t num,WEBSOCKET_TYPE_t type,char* msg,uint64_t len); // server callback 87 | } ws_client_t; 88 | 89 | // returns the populated client struct 90 | // does not send any header, assumes the proper handshake has already occurred 91 | // ccallback = callback for client (userspace) 92 | // scallback = callback for server (userspace) 93 | ws_client_t ws_connect_client(struct netconn* conn, 94 | char* url, 95 | void (*ccallback)(WEBSOCKET_TYPE_t type,char* msg,uint64_t len), 96 | void (*scallback)(uint8_t num,WEBSOCKET_TYPE_t type,char* msg,uint64_t len) 97 | ); 98 | void ws_disconnect_client(ws_client_t* client,bool mask); 99 | bool ws_is_connected(ws_client_t client); // returns 1 if connected, status updates after send/read/connect/disconnect 100 | int ws_send(ws_client_t* client,WEBSOCKET_OPCODES_t opcode,char* msg,uint64_t len,bool mask); // sends message. this function performs the masking 101 | char* ws_read(ws_client_t* client,ws_header_t* header); // unmasks and returns message. populates header. 102 | char* ws_hash_handshake(char* key,uint8_t len); // returns string of output 103 | 104 | #endif // ifndef WEBSOCKET_H 105 | 106 | #ifdef __cplusplus 107 | } 108 | #endif 109 | -------------------------------------------------------------------------------- /include/websocket_server.h: -------------------------------------------------------------------------------- 1 | 2 | /* 3 | esp32-websocket - a websocket component on esp-idf 4 | Copyright (C) 2019 Blake Felt - blake.w.felt@gmail.com 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program. If not, see . 18 | */ 19 | 20 | #ifdef __cplusplus 21 | extern "C" { 22 | #endif 23 | 24 | #ifndef WEBSOCKET_SERVER_H 25 | #define WEBSOCKET_SERVER_H 26 | 27 | #include "websocket.h" 28 | 29 | #define WEBSOCKET_SERVER_MAX_CLIENTS CONFIG_WEBSOCKET_SERVER_MAX_CLIENTS 30 | #define WEBSOCKET_SERVER_QUEUE_SIZE CONFIG_WEBSOCKET_SERVER_QUEUE_SIZE 31 | #define WEBSOCKET_SERVER_QUEUE_TIMEOUT CONFIG_WEBSOCKET_SERVER_QUEUE_TIMEOUT 32 | #define WEBSOCKET_SERVER_TASK_STACK_DEPTH CONFIG_WEBSOCKET_SERVER_TASK_STACK_DEPTH 33 | #define WEBSOCKET_SERVER_TASK_PRIORITY CONFIG_WEBSOCKET_SERVER_TASK_PRIORITY 34 | #define WEBSOCKET_SERVER_PINNED CONFIG_WEBSOCKET_SERVER_PINNED 35 | #if WEBSOCKET_SERVER_PINNED 36 | #define WEBSOCKET_SERVER_PINNED_CORE CONFIG_WEBSOCKET_SERVER_PINNED_CORE 37 | #endif 38 | 39 | // starts the server 40 | int ws_server_start(); 41 | 42 | // ends the server 43 | int ws_server_stop(); 44 | 45 | // adds a client, returns the client's number in the server 46 | int ws_server_add_client(struct netconn* conn, 47 | char* msg, 48 | uint16_t len, 49 | char* url, 50 | void (*callback)(uint8_t num, 51 | WEBSOCKET_TYPE_t type, 52 | char* msg, 53 | uint64_t len)); 54 | 55 | int ws_server_add_client_protocol(struct netconn* conn, 56 | char* msg, 57 | uint16_t len, 58 | char* url, 59 | char* protocol, 60 | void (*callback)(uint8_t num, 61 | WEBSOCKET_TYPE_t type, 62 | char* msg, 63 | uint64_t len)); 64 | 65 | int ws_server_len_url(char* url); // returns the number of connected clients to url 66 | int ws_server_len_all(); // returns the total number of connected clients 67 | 68 | int ws_server_remove_client(int num); // removes the client with the set number 69 | int ws_server_remove_clients(char* url); // removes all clients connected to the specified url 70 | int ws_server_remove_all(); // removes all clients from the server 71 | 72 | int ws_server_send_text_client(int num,char* msg,uint64_t len); // send text to client with the set number 73 | int ws_server_send_text_clients(char* url,char* msg,uint64_t len); // sends text to all clients with the set number 74 | int ws_server_send_text_all(char* msg,uint64_t len); // sends text to all clients 75 | 76 | int ws_server_send_bin_client(int num,char* msg,uint64_t len); 77 | int ws_server_send_bin_clients(char* url,char* msg,uint64_t len); 78 | int ws_server_send_bin_all(char* msg,uint64_t len); 79 | 80 | // these versions can be sent from the callback ONLY 81 | 82 | int ws_server_send_text_client_from_callback(int num,char* msg,uint64_t len); // send text to client with the set number 83 | int ws_server_send_text_clients_from_callback(char* url,char* msg,uint64_t len); // sends text to all clients with the set number 84 | int ws_server_send_text_all_from_callback(char* msg,uint64_t len); // sends text to all clients 85 | 86 | int ws_server_send_bin_client_from_callback(int num,char* msg,uint64_t len); //sends binary to client with the set number 87 | int ws_server_send_bin_clients_from_callback(char* url,char* msg,uint64_t len); // sends binary to all clients with the set number 88 | int ws_server_send_bin_all_from_callback(char* msg,uint64_t len); // sends binary to all clients 89 | 90 | int ws_server_ping(); // sends a ping to all connected clients 91 | 92 | #endif 93 | 94 | #ifdef __cplusplus 95 | } 96 | #endif 97 | -------------------------------------------------------------------------------- /websocket.c: -------------------------------------------------------------------------------- 1 | 2 | /* 3 | esp32-websocket - a websocket component on esp-idf 4 | Copyright (C) 2019 Blake Felt - blake.w.felt@gmail.com 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program. If not, see . 18 | */ 19 | 20 | #include "websocket.h" 21 | #include "lwip/tcp.h" // for the netconn structure 22 | #include "esp_system.h" // for esp_random 23 | #include "mbedtls/base64.h" 24 | #include "mbedtls/sha1.h" 25 | #include 26 | 27 | ws_client_t ws_connect_client(struct netconn* conn, 28 | char* url, 29 | void (*ccallback)(WEBSOCKET_TYPE_t type,char* msg,uint64_t len), 30 | void (*scallback)(uint8_t num,WEBSOCKET_TYPE_t type,char* msg,uint64_t len) 31 | ) { 32 | ws_client_t client; 33 | client.conn = conn; 34 | client.url = url; 35 | client.ping = 0; 36 | client.last_opcode = 0; 37 | client.contin = NULL; 38 | client.len = 0; 39 | client.unfinished = 0; 40 | client.ccallback = ccallback; 41 | client.scallback = scallback; 42 | return client; 43 | } 44 | 45 | void ws_disconnect_client(ws_client_t* client,bool mask) { 46 | ws_send(client,WEBSOCKET_OPCODE_CLOSE,NULL,0,mask); // tell the client to close 47 | if(client->conn) { 48 | client->conn->callback = NULL; // shut off the callback 49 | netconn_close(client->conn); 50 | netconn_delete(client->conn); 51 | client->conn = NULL; 52 | } 53 | client->url = NULL; 54 | client->last_opcode = 0; 55 | if(client->len) { 56 | if(client->contin) 57 | free(client->contin); 58 | client->len = 0; 59 | } 60 | client->ccallback = NULL; 61 | client->scallback = NULL; 62 | } 63 | 64 | bool ws_is_connected(ws_client_t client) { 65 | if(client.conn) 66 | return 1; 67 | return 0; 68 | } 69 | 70 | static void ws_generate_mask(ws_header_t* header) { 71 | header->param.bit.MASK = 1; 72 | header->key.full = esp_random(); // generate a random 32 bit number 73 | } 74 | 75 | static void ws_encrypt_decrypt(char* msg,ws_header_t header) { 76 | if(header.param.bit.MASK) { 77 | for(uint64_t i=0; i> 8) & 0xFF; 129 | out[3] = (len ) & 0xFF; 130 | pos = 4; 131 | } 132 | if(header.param.bit.LEN == 127) { 133 | //memcpy(&out[2],&len,8); 134 | out[2] = (len >> 56) & 0xFF; 135 | out[3] = (len >> 48) & 0xFF; 136 | out[4] = (len >> 40) & 0xFF; 137 | out[5] = (len >> 32) & 0xFF; 138 | out[6] = (len >> 24) & 0xFF; 139 | out[7] = (len >> 16) & 0xFF; 140 | out[8] = (len >> 8) & 0xFF; 141 | out[9] = (len) & 0xFF; 142 | pos = 10; 143 | } 144 | 145 | if(mask) { 146 | out[pos] = header.key.part[0]; pos++; 147 | out[pos] = header.key.part[1]; pos++; 148 | out[pos] = header.key.part[2]; pos++; 149 | out[pos] = header.key.part[3]; pos++; 150 | memcpy(&out[pos],encrypt,len); // put in the encrypted message 151 | free(encrypt); 152 | } 153 | else { 154 | memcpy(&out[pos],msg,len); 155 | } 156 | 157 | ret = netconn_write(client->conn,out,true_len,NETCONN_COPY); // finally! send it. 158 | free(out); // free the entire message 159 | return ret; 160 | } 161 | 162 | char* ws_read(ws_client_t* client,ws_header_t* header) { 163 | char* ret; 164 | char* append; 165 | err_t err; 166 | struct netbuf* inbuf; 167 | struct netbuf* inbuf2; 168 | char* buf; 169 | char* buf2; 170 | uint16_t len; 171 | uint16_t len2; 172 | uint64_t pos; 173 | uint64_t cont_len; 174 | uint64_t cont_pos; 175 | 176 | // if we read from this previously (not cont frames), stop reading 177 | if(client->unfinished) { 178 | client->unfinished--; 179 | return NULL; 180 | } 181 | 182 | err = netconn_recv(client->conn,&inbuf); 183 | if(err != ERR_OK) return NULL; 184 | netbuf_data(inbuf,(void**)&buf, &len); 185 | if(!buf) return NULL; 186 | 187 | // get the header 188 | header->param.pos.ZERO = buf[0]; 189 | header->param.pos.ONE = buf[1]; 190 | 191 | // get the message length 192 | pos = 2; 193 | if(header->param.bit.LEN <= 125) { 194 | header->length = header->param.bit.LEN; 195 | } 196 | else if(header->param.bit.LEN == 126) { 197 | header->length = buf[2] << 8 | buf[3]; 198 | pos = 4; 199 | } 200 | else { // LEN = 127 201 | header->length = (uint64_t)buf[2] << 56 | (uint64_t)buf[3] << 48 202 | | (uint64_t)buf[4] << 40 | (uint64_t)buf[5] << 32 203 | | (uint64_t)buf[6] << 24 | (uint64_t)buf[7] << 16 204 | | (uint64_t)buf[8] << 8 | (uint64_t)buf[9]; 205 | pos = 10; 206 | } 207 | 208 | if(header->param.bit.MASK) { 209 | memcpy(&(header->key.full),&buf[pos],4); // extract the key 210 | pos += 4; 211 | } 212 | 213 | ret = malloc(header->length+1); // allocate memory, plus a byte 214 | if(!ret) { 215 | netbuf_delete(inbuf); 216 | header->received = 0; 217 | return NULL; 218 | } 219 | 220 | cont_len = len-pos; // get the actual length 221 | memcpy(ret,&buf[pos],header->length); // allocate the total memory 222 | cont_pos = cont_len; // get the initial position 223 | // netconn gives messages in pieces, so we need to get those (different than OPCODE_CONT) 224 | while(cont_len < header->length) { // while the actual length is less than the header stated 225 | err = netconn_recv(client->conn,&inbuf2); 226 | if(err != ERR_OK) { 227 | netbuf_delete(inbuf2); 228 | free(ret); 229 | client->unfinished = 0; 230 | header->received = 0; 231 | return NULL; 232 | } 233 | netbuf_data(inbuf2,(void**)&buf2, &len2); 234 | // Prevent catastrophic failure due to memory leakage 235 | if(cont_len + len2 > header->length) { 236 | netbuf_delete(inbuf2); 237 | free(ret); 238 | client->unfinished = 0; 239 | header->received = 0; 240 | return NULL; 241 | } 242 | memcpy(&ret[cont_pos],buf2,len2); 243 | cont_pos += len2; 244 | if(!buf2) { 245 | client->unfinished = 0; 246 | header->received = 0; 247 | } 248 | netbuf_delete(inbuf2); 249 | client->unfinished++; 250 | cont_len += len2; 251 | } 252 | 253 | ret[header->length] = '\0'; // end string 254 | ws_encrypt_decrypt(ret,*header); // unencrypt, if necessary 255 | 256 | if(header->param.bit.FIN == 0) { // if the message isn't done 257 | if((header->param.bit.OPCODE == WEBSOCKET_OPCODE_CONT) && 258 | ((client->last_opcode==WEBSOCKET_OPCODE_BIN) || (client->last_opcode==WEBSOCKET_OPCODE_TEXT))) { 259 | cont_len = header->length + client->len; 260 | append = malloc(cont_len); 261 | memcpy(append,client->contin,client->len); 262 | memcpy(&append[client->len],ret,header->length); 263 | free(client->contin); 264 | client->contin = malloc(cont_len); 265 | client->len = cont_len; 266 | 267 | free(append); 268 | free(ret); 269 | netbuf_delete(inbuf); 270 | //free(buf); 271 | return NULL; 272 | } 273 | else if((header->param.bit.OPCODE==WEBSOCKET_OPCODE_BIN) || (header->param.bit.OPCODE==WEBSOCKET_OPCODE_TEXT)) { 274 | if(client->len) { 275 | free(client->contin); 276 | } 277 | client->contin = malloc(header->length); 278 | memcpy(client->contin,ret,header->length); 279 | client->len = header->length; 280 | client->last_opcode = header->param.bit.OPCODE; 281 | 282 | free(ret); 283 | netbuf_delete(inbuf); 284 | //free(buf); 285 | return NULL; 286 | } 287 | else { // there shouldn't be another FIN code.... 288 | free(ret); 289 | netbuf_delete(inbuf); 290 | //free(buf); 291 | return NULL; 292 | } 293 | } 294 | client->last_opcode = header->param.bit.OPCODE; 295 | if(inbuf) netbuf_delete(inbuf); 296 | header->received = 1; 297 | return ret; 298 | } 299 | 300 | char* ws_hash_handshake(char* handshake,uint8_t len) { 301 | const char hash[] = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; 302 | const uint8_t hash_len = sizeof(hash); 303 | char* ret; 304 | char key[64]; 305 | unsigned char sha1sum[20]; 306 | unsigned int ret_len; 307 | 308 | if(!len) return NULL; 309 | ret = malloc(32); 310 | 311 | memcpy(key,handshake,len); 312 | strlcpy(&key[len],hash,sizeof(key)); 313 | mbedtls_sha1((unsigned char*)key,len+hash_len-1,sha1sum); 314 | mbedtls_base64_encode(NULL, 0, &ret_len, sha1sum, 20); 315 | if(!mbedtls_base64_encode((unsigned char*)ret,32,&ret_len,sha1sum,20)) { 316 | ret[ret_len] = '\0'; 317 | return ret; 318 | } 319 | free(ret); 320 | return NULL; 321 | } 322 | -------------------------------------------------------------------------------- /websocket_server.c: -------------------------------------------------------------------------------- 1 | 2 | /* 3 | esp32-websocket - a websocket component on esp-idf 4 | Copyright (C) 2019 Blake Felt - blake.w.felt@gmail.com 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program. If not, see . 18 | */ 19 | 20 | #include "websocket_server.h" 21 | #include "freertos/FreeRTOS.h" 22 | #include "freertos/semphr.h" 23 | #include "freertos/task.h" 24 | #include "freertos/queue.h" 25 | #include 26 | 27 | static SemaphoreHandle_t xwebsocket_mutex; // to lock the client array 28 | static QueueHandle_t xwebsocket_queue; // to hold the clients that send messages 29 | static ws_client_t clients[WEBSOCKET_SERVER_MAX_CLIENTS]; // holds list of clients 30 | static TaskHandle_t xtask; // the task itself 31 | 32 | static void background_callback(struct netconn* conn, enum netconn_evt evt,u16_t len) { 33 | switch(evt) { 34 | case NETCONN_EVT_RCVPLUS: 35 | xQueueSendToBack(xwebsocket_queue,&conn,WEBSOCKET_SERVER_QUEUE_TIMEOUT); 36 | break; 37 | default: 38 | break; 39 | } 40 | } 41 | 42 | static void handle_read(uint8_t num) { 43 | ws_header_t header; 44 | char* msg; 45 | 46 | header.received = 0; 47 | msg = ws_read(&clients[num],&header); 48 | 49 | if(!header.received) { 50 | if(msg) free(msg); 51 | return; 52 | } 53 | 54 | switch(clients[num].last_opcode) { 55 | case WEBSOCKET_OPCODE_CONT: 56 | break; 57 | case WEBSOCKET_OPCODE_BIN: 58 | clients[num].scallback(num,WEBSOCKET_BIN,msg,header.length); 59 | break; 60 | case WEBSOCKET_OPCODE_TEXT: 61 | clients[num].scallback(num,WEBSOCKET_TEXT,msg,header.length); 62 | break; 63 | case WEBSOCKET_OPCODE_PING: 64 | ws_send(&clients[num],WEBSOCKET_OPCODE_PONG,msg,header.length,0); 65 | clients[num].scallback(num,WEBSOCKET_PING,msg,header.length); 66 | break; 67 | case WEBSOCKET_OPCODE_PONG: 68 | if(clients[num].ping) { 69 | clients[num].scallback(num,WEBSOCKET_PONG,NULL,0); 70 | clients[num].ping = 0; 71 | } 72 | break; 73 | case WEBSOCKET_OPCODE_CLOSE: 74 | clients[num].scallback(num,WEBSOCKET_DISCONNECT_EXTERNAL,NULL,0); 75 | ws_disconnect_client(&clients[num], 0); 76 | break; 77 | default: 78 | break; 79 | } 80 | if(msg) free(msg); 81 | } 82 | 83 | static void ws_server_task(void* pvParameters) { 84 | struct netconn* conn; 85 | 86 | xwebsocket_mutex = xSemaphoreCreateMutex(); 87 | xwebsocket_queue = xQueueCreate(WEBSOCKET_SERVER_QUEUE_SIZE, sizeof(struct netconn*)); 88 | 89 | // initialize all clients 90 | for(int i=0;icallback = background_callback; 201 | netconn_write(conn,handshake,strlen(handshake),NETCONN_COPY); 202 | 203 | for(int i=0;i