├── LICENSE.md ├── README.md ├── example ├── main.go └── test.http ├── go.mod ├── go.sum ├── rpc ├── contract.go ├── errors.go ├── logger.go ├── middleware.go ├── middleware │ ├── logger.go │ └── validation.go ├── options.go ├── server.go └── wrapper.go └── transport ├── http.go ├── tcp.go ├── transport.go └── unix.go /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 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 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | 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 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because 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 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 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 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | 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 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 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 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | 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 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # JSON-RPC 2.0 3 | 4 | ❗️ Main repo: [https://gitrepo.ru/neonxp/jsonrpc2](https://gitrepo.ru/neonxp/jsonrpc2). Github is only mirror. 5 | 6 | Golang implementation of JSON-RPC 2.0 server with generics. 7 | 8 | Go 1.18+ required 9 | 10 | ## Features: 11 | 12 | - [x] HTTP/HTTPS transport 13 | - [x] TCP transport 14 | - [ ] WebSocket transport 15 | 16 | ## Usage (http transport) 17 | 18 | 1. Create JSON-RPC server with options: 19 | ```go 20 | import "go.neonxp.dev/jsonrpc2/rpc" 21 | ... 22 | s := rpc.New( 23 | rpc.WithTransport(&transport.HTTP{ 24 | Bind: ":8000", // Port to bind 25 | CORSOrigin: "*", // CORS origin 26 | TLS: &tls.Config{}, // Optional TLS config (default nil) 27 | Parallel: true, // Allow parallel run batch methods (default false) 28 | }), 29 | //Other options like transports/middlewares... 30 | ) 31 | ``` 32 | 33 | 2. Add required transport(s): 34 | ```go 35 | import "go.neonxp.dev/jsonrpc2/transport" 36 | ... 37 | s.Use( 38 | rpc.WithTransport(&transport.TCP{Bind: ":3000"}), 39 | //... 40 | ) 41 | ``` 42 | 43 | 3. Write handlers: 44 | ```go 45 | 46 | // This handler supports request parameters 47 | func Multiply(ctx context.Context, args *Args) (int, error) { 48 | return args.A * args.B, nil 49 | } 50 | 51 | // This handler has no request parameters 52 | func Hello(ctx context.Context) (string, error) { 53 | return "World", nil 54 | } 55 | ``` 56 | 57 | A handler must have a context as first parameter and may have a second parameter, representing request paramters (input of any json serializable type). A handler always returns exactly two values (output of any json serializable type and error). 58 | 59 | 4. Wrap the handler using one of the two functions `rpc.H` (supporting req params) or `rpc.HS` (no params) and register it with the server: 60 | 61 | ```go 62 | // handler has params 63 | s.Register("multiply", rpc.H(Multiply)) 64 | 65 | // handler has no params 66 | s.Register("hello", rpc.HS(Hello)) 67 | ``` 68 | 69 | 5. Run RPC server: 70 | ```go 71 | s.Run(ctx) 72 | ``` 73 | 74 | ## Custom transport 75 | 76 | Any transport must implement simple interface `transport.Transport`: 77 | 78 | ```go 79 | type Transport interface { 80 | Run(ctx context.Context, resolver Resolver) error 81 | } 82 | ``` 83 | 84 | ## Complete example 85 | 86 | [Full code](/example) 87 | 88 | ```go 89 | package main 90 | 91 | import ( 92 | "context" 93 | 94 | "go.neonxp.dev/jsonrpc2/rpc" 95 | "go.neonxp.dev/jsonrpc2/rpc/middleware" 96 | "go.neonxp.dev/jsonrpc2/transport" 97 | ) 98 | 99 | func main() { 100 | s := rpc.New( 101 | rpc.WithLogger(rpc.StdLogger), // Optional logger 102 | rpc.WithTransport(&transport.HTTP{Bind: ":8000"}), // HTTP transport 103 | ) 104 | 105 | // Set options after constructor 106 | s.Use( 107 | rpc.WithTransport(&transport.TCP{Bind: ":3000"}), // TCP transport 108 | rpc.WithMiddleware(middleware.Logger(rpc.StdLogger)), // Logger middleware 109 | ) 110 | 111 | s.Register("multiply", rpc.H(Multiply)) 112 | s.Register("divide", rpc.H(Divide)) 113 | s.Register("hello", rpc.HS(Hello)) 114 | 115 | s.Run(context.Background()) 116 | } 117 | 118 | func Multiply(ctx context.Context, args *Args) (int, error) { 119 | //... 120 | } 121 | 122 | func Divide(ctx context.Context, args *Args) (*Quotient, error) { 123 | //... 124 | } 125 | 126 | func Hello(ctx context.Context) (string, error) { 127 | // ... 128 | } 129 | 130 | type Args struct { 131 | A int `json:"a"` 132 | B int `json:"b"` 133 | } 134 | 135 | type Quotient struct { 136 | Quo int `json:"quo"` 137 | Rem int `json:"rem"` 138 | } 139 | 140 | ``` 141 | 142 | ## Author 143 | 144 | Alexander Kiryukhin 145 | 146 | ## License 147 | 148 | ![GPL v3](https://www.gnu.org/graphics/gplv3-with-text-136x68.png) 149 | 150 | 151 | -------------------------------------------------------------------------------- /example/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "context" 5 | "errors" 6 | "log" 7 | "os" 8 | "os/signal" 9 | 10 | "go.neonxp.dev/jsonrpc2/rpc" 11 | "go.neonxp.dev/jsonrpc2/rpc/middleware" 12 | "go.neonxp.dev/jsonrpc2/transport" 13 | ) 14 | 15 | func main() { 16 | s := rpc.New( 17 | rpc.WithLogger(rpc.StdLogger), 18 | rpc.WithTransport(&transport.HTTP{Bind: ":8000", CORSOrigin: "*"}), 19 | ) 20 | 21 | // Set options after constructor 22 | serviceSchema := ` 23 | { 24 | "divide": { 25 | "request": { 26 | "type": "object", 27 | "properties": { 28 | "a": { 29 | "type": "integer" 30 | }, 31 | "b": { 32 | "type": "integer", 33 | "not":{"const":0} 34 | } 35 | }, 36 | "required": ["a", "b"] 37 | }, 38 | "response": { 39 | "type": "object", 40 | "properties": { 41 | "quo": { 42 | "type": "integer" 43 | }, 44 | "rem": { 45 | "type": "integer" 46 | } 47 | }, 48 | "required": ["quo", "rem"] 49 | } 50 | }, 51 | "multiply": { 52 | "request": { 53 | "type": "object", 54 | "properties": { 55 | "a": { 56 | "type": "integer" 57 | }, 58 | "b": { 59 | "type": "integer" 60 | } 61 | }, 62 | "required": ["a", "b"] 63 | }, 64 | "response": { 65 | "type": "integer" 66 | } 67 | } 68 | }` 69 | 70 | validation, err := middleware.Validation(middleware.MustSchema(serviceSchema)) 71 | if err != nil { 72 | log.Fatal(err) 73 | } 74 | s.Use( 75 | rpc.WithTransport(&transport.TCP{Bind: ":3000"}), 76 | rpc.WithMiddleware(middleware.Logger(rpc.StdLogger)), 77 | rpc.WithMiddleware(validation), 78 | ) 79 | 80 | s.Register("multiply", rpc.H(Multiply)) 81 | s.Register("divide", rpc.H(Divide)) 82 | s.Register("hello", rpc.HS(Hello)) 83 | 84 | ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, os.Kill) 85 | defer cancel() 86 | 87 | if err := s.Run(ctx); err != nil { 88 | log.Fatal(err) 89 | } 90 | } 91 | 92 | func Multiply(ctx context.Context, args *Args) (int, error) { 93 | return args.A * args.B, nil 94 | } 95 | 96 | func Divide(ctx context.Context, args *Args) (*Quotient, error) { 97 | if args.B == 0 { 98 | return nil, errors.New("divide by zero") 99 | } 100 | quo := new(Quotient) 101 | quo.Quo = args.A / args.B 102 | quo.Rem = args.A % args.B 103 | return quo, nil 104 | } 105 | 106 | func Hello(ctx context.Context) (string, error) { 107 | return "world", nil 108 | } 109 | 110 | type Args struct { 111 | A int `json:"a"` 112 | B int `json:"b"` 113 | } 114 | 115 | type Quotient struct { 116 | Quo int `json:"quo"` 117 | Rem int `json:"rem"` 118 | } 119 | -------------------------------------------------------------------------------- /example/test.http: -------------------------------------------------------------------------------- 1 | POST http://localhost:8000/ 2 | Content-Type: application/json 3 | { 4 | "jsonrpc": "2.0", 5 | "method": "multiply", 6 | "params": { 7 | "a": 2, 8 | "b": 3 9 | }, 10 | "id": 1 11 | } 12 | 13 | 14 | ### 15 | POST http://localhost:8000/ 16 | Content-Type: application/json 17 | { 18 | "jsonrpc": "2.0", 19 | "method": "divide", 20 | "params": { 21 | "a": 10, 22 | "b": 10 23 | }, 24 | "id": 2 25 | } 26 | 27 | 28 | ### Batch request 29 | POST http://localhost:8000/ 30 | Content-Type: application/json 31 | { "jsonrpc": "2.0", "method": "multiply", "params": { "a": 2, "b": 3 }, "id": 10 } 32 | {"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"} 33 | {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]} 34 | {"jsonrpc": "2.0", "method": "subtract", "params": [42,23], "id": "2"} 35 | { 36 | "jsonrpc": "2.0", 37 | "method": "divide", 38 | "params": { 39 | "a": 10, 40 | "b": 3 41 | }, 42 | "id": "divide" 43 | } 44 | {"foo": "boo"} 45 | {"jsonrpc": "2.0", "method": "foo.get", "params": {"name": "myself"}, "id": "5"} 46 | {"jsonrpc": "2.0", "method": "get_data", "id": "9"} 47 | { 48 | "jsonrpc": "2.0", 49 | "method": "divide", 50 | "params": { 51 | "a": 10, 52 | "b": 0 53 | }, 54 | "id": "divide" 55 | } 56 | { 57 | "jsonrpc": "2.0", 58 | "method": "divide", 59 | "params": {}, 60 | "id": "divide" 61 | } 62 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module go.neonxp.dev/jsonrpc2 2 | 3 | go 1.18 4 | 5 | require ( 6 | github.com/qri-io/jsonschema v0.2.1 7 | golang.org/x/sync v0.0.0-20220513210516-0976fa681c29 8 | ) 9 | 10 | require github.com/qri-io/jsonpointer v0.1.1 // indirect 11 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 2 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 3 | github.com/qri-io/jsonpointer v0.1.1 h1:prVZBZLL6TW5vsSB9fFHFAMBLI4b0ri5vribQlTJiBA= 4 | github.com/qri-io/jsonpointer v0.1.1/go.mod h1:DnJPaYgiKu56EuDp8TU5wFLdZIcAnb/uH9v37ZaMV64= 5 | github.com/qri-io/jsonschema v0.2.1 h1:NNFoKms+kut6ABPf6xiKNM5214jzxAhDBrPHCJ97Wg0= 6 | github.com/qri-io/jsonschema v0.2.1/go.mod h1:g7DPkiOsK1xv6T/Ao5scXRkd+yTFygcANPBaaqW+VrI= 7 | github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ= 8 | github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= 9 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 10 | github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= 11 | golang.org/x/sync v0.0.0-20220513210516-0976fa681c29 h1:w8s32wxx3sY+OjLlv9qltkLU5yvJzxjjgiHWLjdIcw4= 12 | golang.org/x/sync v0.0.0-20220513210516-0976fa681c29/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 13 | -------------------------------------------------------------------------------- /rpc/contract.go: -------------------------------------------------------------------------------- 1 | //Package rpc provides abstract rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package rpc 21 | 22 | import ( 23 | "context" 24 | "encoding/json" 25 | ) 26 | 27 | type RpcHandler func(ctx context.Context, req *RpcRequest) *RpcResponse 28 | 29 | type RpcRequest struct { 30 | Jsonrpc string `json:"jsonrpc"` 31 | Method string `json:"method"` 32 | Params json.RawMessage `json:"params"` 33 | Id any `json:"id"` 34 | } 35 | 36 | type RpcResponse struct { 37 | Jsonrpc string `json:"jsonrpc"` 38 | Result json.RawMessage `json:"result,omitempty"` 39 | Error error `json:"error,omitempty"` 40 | Id any `json:"id,omitempty"` 41 | } 42 | 43 | type Flusher interface { 44 | // Flush sends any buffered data to the client. 45 | Flush() 46 | } 47 | -------------------------------------------------------------------------------- /rpc/errors.go: -------------------------------------------------------------------------------- 1 | //Package rpc provides abstract rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package rpc 21 | 22 | import "fmt" 23 | 24 | const ( 25 | ErrCodeParseError = -32700 26 | ErrCodeInvalidRequest = -32600 27 | ErrCodeMethodNotFound = -32601 28 | ErrCodeInvalidParams = -32602 29 | ErrCodeInternalError = -32603 30 | ErrUser = -32000 31 | ) 32 | 33 | var errorMap = map[int]string{ 34 | ErrCodeParseError: "Parse error", // Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. 35 | ErrCodeInvalidRequest: "Invalid Request", // The JSON sent is not a valid Request object. 36 | ErrCodeMethodNotFound: "Method not found", // The method does not exist / is not available. 37 | ErrCodeInvalidParams: "Invalid params", // Invalid method parameter(s). 38 | ErrCodeInternalError: "Internal error", // Internal JSON-RPC error. 39 | ErrUser: "Other error", 40 | } 41 | 42 | //-32000 to -32099 RpcServer error Reserved for implementation-defined server-errors. 43 | 44 | type Error struct { 45 | Code int `json:"code"` 46 | Message string `json:"message"` 47 | } 48 | 49 | func (e Error) Error() string { 50 | return fmt.Sprintf("jsonrpc2 error: code: %d message: %s", e.Code, e.Message) 51 | } 52 | 53 | func ErrorFromCode(code int) Error { 54 | if _, ok := errorMap[code]; ok { 55 | return Error{ 56 | Code: code, 57 | Message: errorMap[code], 58 | } 59 | } 60 | return Error{Code: code} 61 | } 62 | 63 | func NewError(message string, code int) Error { 64 | if code == 0 { 65 | code = ErrUser 66 | } 67 | return Error{ 68 | Code: code, 69 | Message: message, 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /rpc/logger.go: -------------------------------------------------------------------------------- 1 | //Package rpc provides abstract rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package rpc 21 | 22 | import "log" 23 | 24 | type Logger interface { 25 | Logf(format string, args ...interface{}) 26 | } 27 | 28 | type nopLogger struct{} 29 | 30 | func (n nopLogger) Logf(_ string, _ ...interface{}) { 31 | } 32 | 33 | type stdLogger struct{} 34 | 35 | func (n stdLogger) Logf(format string, args ...interface{}) { 36 | log.Printf(format, args...) 37 | } 38 | 39 | var StdLogger = stdLogger{} 40 | -------------------------------------------------------------------------------- /rpc/middleware.go: -------------------------------------------------------------------------------- 1 | //Package rpc provides abstract rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package rpc 21 | 22 | type Middleware func(handler RpcHandler) RpcHandler 23 | -------------------------------------------------------------------------------- /rpc/middleware/logger.go: -------------------------------------------------------------------------------- 1 | //Package middleware provides middlewares for rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package middleware 21 | 22 | import ( 23 | "context" 24 | "encoding/json" 25 | "fmt" 26 | "time" 27 | 28 | "go.neonxp.dev/jsonrpc2/rpc" 29 | ) 30 | 31 | func Logger(logger rpc.Logger) rpc.Middleware { 32 | return func(handler rpc.RpcHandler) rpc.RpcHandler { 33 | return func(ctx context.Context, req *rpc.RpcRequest) *rpc.RpcResponse { 34 | t1 := time.Now().UnixMicro() 35 | resp := handler(ctx, req) 36 | t2 := time.Now().UnixMicro() 37 | var params any 38 | if err := json.Unmarshal(req.Params, ¶ms); err != nil { 39 | params = fmt.Sprintf("", err.Error()) 40 | } 41 | logger.Logf("rpc call=%s, args=%+v, take=%dμs", req.Method, params, (t2 - t1)) 42 | return resp 43 | } 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /rpc/middleware/validation.go: -------------------------------------------------------------------------------- 1 | //Package middleware provides middlewares for rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package middleware 21 | 22 | import ( 23 | "context" 24 | "encoding/json" 25 | "fmt" 26 | "strings" 27 | 28 | "github.com/qri-io/jsonschema" 29 | 30 | "go.neonxp.dev/jsonrpc2/rpc" 31 | ) 32 | 33 | type ServiceSchema map[string]MethodSchema 34 | 35 | func MustSchema(schema string) ServiceSchema { 36 | ss := new(ServiceSchema) 37 | if err := json.Unmarshal([]byte(schema), ss); err != nil { 38 | panic(err) 39 | } 40 | return *ss 41 | } 42 | 43 | type MethodSchema struct { 44 | Request *jsonschema.Schema `json:"request"` 45 | Response *jsonschema.Schema `json:"response"` 46 | } 47 | 48 | func Validation(serviceSchema ServiceSchema) (rpc.Middleware, error) { 49 | return func(handler rpc.RpcHandler) rpc.RpcHandler { 50 | return func(ctx context.Context, req *rpc.RpcRequest) *rpc.RpcResponse { 51 | rs, hasSchema := serviceSchema[strings.ToLower(req.Method)] 52 | if hasSchema && rs.Request != nil { 53 | if errResp := formatError(ctx, req.Id, *rs.Request, req.Params); errResp != nil { 54 | return errResp 55 | } 56 | } 57 | resp := handler(ctx, req) 58 | if hasSchema && rs.Response != nil { 59 | if errResp := formatError(ctx, req.Id, *rs.Response, resp.Result); errResp != nil { 60 | return errResp 61 | } 62 | } 63 | return resp 64 | } 65 | }, nil 66 | } 67 | 68 | func formatError(ctx context.Context, requestId any, schema jsonschema.Schema, data json.RawMessage) *rpc.RpcResponse { 69 | errs, err := schema.ValidateBytes(ctx, data) 70 | if err != nil { 71 | return rpc.ErrorResponse(requestId, err) 72 | } 73 | if errs != nil && len(errs) > 0 { 74 | messages := []string{} 75 | for _, msg := range errs { 76 | messages = append(messages, fmt.Sprintf("%s: %s", msg.PropertyPath, msg.Message)) 77 | } 78 | return rpc.ErrorResponse(requestId, rpc.Error{ 79 | Code: rpc.ErrCodeInvalidParams, 80 | Message: strings.Join(messages, "\n"), 81 | }) 82 | } 83 | return nil 84 | } 85 | -------------------------------------------------------------------------------- /rpc/options.go: -------------------------------------------------------------------------------- 1 | //Package rpc provides abstract rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package rpc 21 | 22 | import ( 23 | "go.neonxp.dev/jsonrpc2/transport" 24 | ) 25 | 26 | type Option func(s *RpcServer) 27 | 28 | func WithTransport(transport transport.Transport) Option { 29 | return func(s *RpcServer) { 30 | s.transports = append(s.transports, transport) 31 | } 32 | } 33 | 34 | func WithMiddleware(mw Middleware) Option { 35 | return func(s *RpcServer) { 36 | s.middlewares = append(s.middlewares, mw) 37 | } 38 | } 39 | 40 | func WithLogger(l Logger) Option { 41 | return func(s *RpcServer) { 42 | s.logger = l 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /rpc/server.go: -------------------------------------------------------------------------------- 1 | //Package rpc provides abstract rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package rpc 21 | 22 | import ( 23 | "context" 24 | "encoding/json" 25 | "io" 26 | "strings" 27 | "sync" 28 | 29 | "golang.org/x/sync/errgroup" 30 | 31 | "go.neonxp.dev/jsonrpc2/transport" 32 | ) 33 | 34 | const version = "2.0" 35 | 36 | type RpcServer struct { 37 | logger Logger 38 | handlers map[string]HandlerFunc 39 | middlewares []Middleware 40 | transports []transport.Transport 41 | mu sync.RWMutex 42 | } 43 | 44 | func New(opts ...Option) *RpcServer { 45 | s := &RpcServer{ 46 | logger: nopLogger{}, 47 | handlers: map[string]HandlerFunc{}, 48 | transports: []transport.Transport{}, 49 | mu: sync.RWMutex{}, 50 | } 51 | for _, opt := range opts { 52 | opt(s) 53 | } 54 | return s 55 | } 56 | 57 | func (r *RpcServer) Use(opts ...Option) { 58 | for _, opt := range opts { 59 | opt(r) 60 | } 61 | } 62 | 63 | func (r *RpcServer) Register(method string, handler HandlerFunc) { 64 | r.mu.Lock() 65 | defer r.mu.Unlock() 66 | r.logger.Logf("Register method %s", method) 67 | r.handlers[strings.ToLower(method)] = handler 68 | } 69 | 70 | func (r *RpcServer) Run(ctx context.Context) error { 71 | eg, ctx := errgroup.WithContext(ctx) 72 | for _, t := range r.transports { 73 | eg.Go(func(t transport.Transport) func() error { 74 | return func() error { return t.Run(ctx, r) } 75 | }(t)) 76 | } 77 | return eg.Wait() 78 | } 79 | 80 | func (r *RpcServer) Resolve(ctx context.Context, rd io.Reader, w io.Writer, parallel bool) { 81 | dec := json.NewDecoder(rd) 82 | enc := json.NewEncoder(w) 83 | mu := sync.Mutex{} 84 | wg := sync.WaitGroup{} 85 | for { 86 | req := new(RpcRequest) 87 | if err := dec.Decode(req); err != nil { 88 | break 89 | } 90 | exec := func() { 91 | h := r.callMethod 92 | for _, m := range r.middlewares { 93 | h = m(h) 94 | } 95 | resp := h(ctx, req) 96 | if req.Id == nil { 97 | // notification request 98 | return 99 | } 100 | mu.Lock() 101 | defer mu.Unlock() 102 | if err := enc.Encode(resp); err != nil { 103 | r.logger.Logf("Can't write response: %v", err) 104 | enc.Encode(ErrorResponse(req.Id, ErrorFromCode(ErrCodeInternalError))) 105 | } 106 | if w, canFlush := w.(Flusher); canFlush { 107 | w.Flush() 108 | } 109 | } 110 | if parallel { 111 | wg.Add(1) 112 | go func(req *RpcRequest) { 113 | defer wg.Done() 114 | exec() 115 | }(req) 116 | } else { 117 | exec() 118 | } 119 | } 120 | if parallel { 121 | wg.Wait() 122 | } 123 | } 124 | 125 | func (r *RpcServer) callMethod(ctx context.Context, req *RpcRequest) *RpcResponse { 126 | r.mu.RLock() 127 | h, ok := r.handlers[strings.ToLower(req.Method)] 128 | r.mu.RUnlock() 129 | if !ok { 130 | return ErrorResponse(req.Id, ErrorFromCode(ErrCodeMethodNotFound)) 131 | } 132 | resp, err := h(ctx, req.Params) 133 | if err != nil { 134 | r.logger.Logf("User error %v", err) 135 | return ErrorResponse(req.Id, err) 136 | } 137 | 138 | return ResultResponse(req.Id, resp) 139 | } 140 | 141 | func ResultResponse(id any, resp json.RawMessage) *RpcResponse { 142 | return &RpcResponse{ 143 | Jsonrpc: version, 144 | Result: resp, 145 | Id: id, 146 | } 147 | } 148 | 149 | func ErrorResponse(id any, err error) *RpcResponse { 150 | return &RpcResponse{ 151 | Jsonrpc: version, 152 | Error: err, 153 | Id: id, 154 | } 155 | } 156 | -------------------------------------------------------------------------------- /rpc/wrapper.go: -------------------------------------------------------------------------------- 1 | //Package rpc provides abstract rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package rpc 21 | 22 | import ( 23 | "context" 24 | "encoding/json" 25 | ) 26 | 27 | func H[RQ any, RS any](handler func(context.Context, *RQ) (RS, error)) HandlerFunc { 28 | return func(ctx context.Context, in json.RawMessage) (json.RawMessage, error) { 29 | req := new(RQ) 30 | if err := json.Unmarshal(in, req); err != nil { 31 | return nil, ErrorFromCode(ErrCodeParseError) 32 | } 33 | resp, err := handler(ctx, req) 34 | if err != nil { 35 | return nil, Error{ 36 | Code: ErrUser, 37 | Message: err.Error(), 38 | } 39 | } 40 | return json.Marshal(resp) 41 | } 42 | } 43 | 44 | // HS is a simple generic wrapper for rpc handlers without any request params. 45 | func HS[RS any](handler func(context.Context) (RS, error)) HandlerFunc { 46 | return func(ctx context.Context, in json.RawMessage) (json.RawMessage, error) { 47 | resp, err := handler(ctx) 48 | if err != nil { 49 | return nil, Error{ 50 | Code: ErrUser, 51 | Message: err.Error(), 52 | } 53 | } 54 | return json.Marshal(resp) 55 | } 56 | } 57 | 58 | type HandlerFunc func(context.Context, json.RawMessage) (json.RawMessage, error) 59 | -------------------------------------------------------------------------------- /transport/http.go: -------------------------------------------------------------------------------- 1 | //Package transport provides transports for rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package transport 21 | 22 | import ( 23 | "context" 24 | "crypto/tls" 25 | "net" 26 | "net/http" 27 | ) 28 | 29 | type HTTP struct { 30 | Bind string 31 | TLS *tls.Config 32 | CORSOrigin string 33 | Parallel bool 34 | } 35 | 36 | func (h *HTTP) Run(ctx context.Context, resolver Resolver) error { 37 | srv := http.Server{ 38 | Addr: h.Bind, 39 | Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { 40 | if r.Method == http.MethodOptions && h.CORSOrigin != "" { 41 | w.Header().Set("Access-Control-Allow-Origin", h.CORSOrigin) 42 | w.Header().Set("Access-Control-Allow-Headers", "Content-Type") 43 | w.WriteHeader(http.StatusOK) 44 | return 45 | } 46 | if r.Method != http.MethodPost { 47 | w.WriteHeader(http.StatusMethodNotAllowed) 48 | return 49 | } 50 | if h.CORSOrigin != "" { 51 | w.Header().Set("Access-Control-Allow-Origin", h.CORSOrigin) 52 | w.Header().Set("Access-Control-Allow-Headers", "Content-Type") 53 | } 54 | w.Header().Add("Content-Type", "application/json") 55 | w.WriteHeader(http.StatusOK) 56 | resolver.Resolve(ctx, r.Body, w, h.Parallel) 57 | }), 58 | BaseContext: func(l net.Listener) context.Context { 59 | return ctx 60 | }, 61 | TLSConfig: h.TLS, 62 | } 63 | go func() { 64 | <-ctx.Done() 65 | srv.Close() 66 | }() 67 | if err := srv.ListenAndServe(); err != http.ErrServerClosed { 68 | return err 69 | } 70 | return nil 71 | } 72 | -------------------------------------------------------------------------------- /transport/tcp.go: -------------------------------------------------------------------------------- 1 | //Package transport provides transports for rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package transport 21 | 22 | import ( 23 | "context" 24 | "net" 25 | ) 26 | 27 | type TCP struct { 28 | Bind string 29 | Parallel bool 30 | } 31 | 32 | func (t *TCP) Run(ctx context.Context, resolver Resolver) error { 33 | ln, err := net.Listen("tcp", t.Bind) 34 | if err != nil { 35 | return err 36 | } 37 | 38 | go func() { 39 | <-ctx.Done() 40 | ln.Close() 41 | }() 42 | for { 43 | conn, err := ln.Accept() 44 | if err != nil { 45 | return err 46 | } 47 | go resolver.Resolve(ctx, conn, conn, t.Parallel) 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /transport/transport.go: -------------------------------------------------------------------------------- 1 | //Package transport provides transports for rpc server 2 | // 3 | //Copyright (C) 2022 Alexander Kiryukhin 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | 20 | package transport 21 | 22 | import ( 23 | "context" 24 | "io" 25 | ) 26 | 27 | type Transport interface { 28 | Run(ctx context.Context, resolver Resolver) error 29 | } 30 | 31 | type Resolver interface { 32 | Resolve(ctx context.Context, reader io.Reader, writer io.Writer, isParallel bool) 33 | } 34 | -------------------------------------------------------------------------------- /transport/unix.go: -------------------------------------------------------------------------------- 1 | //Package transport provides transports for rpc server 2 | // 3 | //Copyright (C) 2022 Max Nikitenko 4 | // 5 | //This file is part of go.neonxp.dev/jsonrpc2 project. 6 | // 7 | //This program is free software: you can redistribute it and/or modify 8 | //it under the terms of the GNU General Public License as published by 9 | //the Free Software Foundation, either version 3 of the License, or 10 | //(at your option) any later version. 11 | // 12 | //This program is distributed in the hope that it will be useful, 13 | //but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | //GNU General Public License for more details. 16 | // 17 | //You should have received a copy of the GNU General Public License 18 | //along with this program. If not, see . 19 | package transport 20 | 21 | import ( 22 | "context" 23 | "net" 24 | ) 25 | 26 | type UnixSocket struct { 27 | Path string 28 | Parallel bool 29 | } 30 | 31 | func (t *UnixSocket) Run(ctx context.Context, resolver Resolver) error { 32 | tcpAddr, err := net.ResolveUnixAddr("unix", t.Path) 33 | if err != nil { 34 | return err 35 | } 36 | ln, err := net.ListenUnix("unix", tcpAddr) 37 | if err != nil { 38 | return err 39 | } 40 | 41 | go func() { 42 | <-ctx.Done() 43 | _ = ln.Close() 44 | }() 45 | for { 46 | conn, err := ln.Accept() 47 | if err != nil { 48 | return err 49 | } 50 | go resolver.Resolve(ctx, conn, conn, t.Parallel) 51 | } 52 | } 53 | --------------------------------------------------------------------------------