├── .github └── workflows │ ├── build.yml │ └── scans.yml ├── LICENSE ├── README.md ├── configuration └── config.go ├── deploy ├── Vagrantfile └── ansible │ ├── playbook.yml │ └── roles │ └── falconieri │ ├── defaults │ └── main.yml │ ├── files │ └── falconieri.service │ ├── tasks │ └── main.yml │ └── templates │ └── conf.json.tpl ├── go.mod ├── go.sum ├── main.go ├── methods ├── healthcheck.go └── providerDispatch.go ├── middleware └── middleware.go ├── models ├── mac.go ├── providerError.go └── url.go ├── providers ├── fanvil.go ├── gigaset.go ├── snom.go └── yealink.go └── utils └── utils.go /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build and release Falconieri 2 | 3 | on: 4 | push: 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v3 11 | - name: Setup Go 12 | uses: actions/setup-go@v3 13 | - name: Install dependencies 14 | run: go get 15 | - name: Build Falconieri 16 | run: go build 17 | - name: Upload Falconieri binary 18 | uses: actions/upload-artifact@v4.4.0 19 | with: 20 | name: falconieri 21 | path: ./falconieri 22 | release: 23 | runs-on: ubuntu-latest 24 | if: startsWith(github.ref, 'refs/tags/') 25 | needs: build 26 | steps: 27 | - uses: actions/checkout@v3 28 | - uses: actions/download-artifact@v4.1.8 29 | id: download 30 | with: 31 | name: 'falconieri' 32 | - name: Release Falconieri 33 | uses: softprops/action-gh-release@v1 34 | with: 35 | files: ${{steps.download.outputs.download-path}}/falconieri 36 | -------------------------------------------------------------------------------- /.github/workflows/scans.yml: -------------------------------------------------------------------------------- 1 | name: SBOM scans 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | release: 8 | types: 9 | - published 10 | 11 | permissions: 12 | actions: read 13 | contents: write 14 | security-events: write 15 | packages: write 16 | 17 | jobs: 18 | sbom: 19 | name: SBOM 20 | runs-on: ubuntu-22.04 21 | steps: 22 | - uses: actions/checkout@v4 23 | - name: Generate 24 | uses: aquasecurity/trivy-action@0.28.0 25 | with: 26 | scan-type: 'fs' 27 | scan-ref: '.' 28 | format: 'github' 29 | output: 'dependency-results.sbom.json' 30 | github-pat: ${{ secrets.GITHUB_TOKEN }} 31 | - name: Scan 32 | uses: aquasecurity/trivy-action@0.28.0 33 | with: 34 | scan-type: 'fs' 35 | scan-ref: '.' 36 | format: 'sarif' 37 | output: 'trivy-results.sarif' 38 | github-pat: ${{ secrets.GITHUB_TOKEN }} 39 | - name: Upload 40 | uses: github/codeql-action/upload-sarif@v3 41 | with: 42 | sarif_file: 'trivy-results.sarif' 43 | - name: Generate SBOM 44 | if: startsWith(github.ref, 'refs/tags/') 45 | uses: aquasecurity/trivy-action@0.30.0 46 | with: 47 | scan-type: 'fs' 48 | scan-ref: '.' 49 | format: cyclonedx 50 | output: sbom.cdx.json 51 | - name: Attach SBOM 52 | if: startsWith(github.ref, 'refs/tags/') 53 | env: 54 | GH_TOKEN: ${{ github.token }} 55 | run: | 56 | gh release upload ${{ github.ref_name }} sbom.cdx.json 57 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Falconieri 2 | 3 | Modern IP phones can contact a redirect service provider at boot time 4 | and discover their PBX address with it. 5 | 6 | The Falconieri project is a RPS (Redirect and Provisioning Service) gateway 7 | that helps to store the phone provisioning URL in the phone vendor redirect service. 8 | 9 | Supported providers: 10 | 11 | * [Snom](https://service.snom.com/display/wiki/XML-RPC+API) 12 | * [Gigaset](https://teamwork.gigaset.com/gigawiki/display/GPPPO/Gigaset+Redirect+server) 13 | * Fanvil (a link to its public documentation was not found) 14 | * [Yealink](http://support.yealink.com/documentFront/forwardToDocumentDetailPage?documentId=257) 15 | 16 | ## APIs 17 | 18 | ### PUT /providers/:provider/:mac 19 | --- 20 | 21 | Register device on remote provisioning service, if the device is already configured, 22 | the new configuration override the old. 23 | 24 | ##### Request 25 | 26 | ###### Headers 27 | * `Content-Type: application/json` 28 | 29 | ###### Path variables 30 | * `provider`: Name of the remote provider. 31 | * `mac`: Mac address of the device, represented in the EUI-48 IEEE RA hexadecimal 32 | format with the octets separated by hyphens. E.g. `AC-DE-48-23-45-67`. 33 | 34 | ###### Query parameters 35 | * `crc` mac address's CRC code, only valid with Gigaset provider. 36 | 37 | ###### Body 38 | A JSON object with the `url` field: 39 | * `url` URL of configuration server, must be formatted as URI standard https://tools.ietf.org/html/rfc3986. 40 | 41 | Example: 42 | ```json 43 | {"url":"https://example.com/"} 44 | ``` 45 | #### Response 46 | The API return a HTTP status code `200` with an empty body in case of success 47 | or a json object in case of error. 48 | Json object field: 49 | * `error`: specific error code. 50 | * `message`: additional informations (optional). 51 | ##### 200 52 | The device was configured successfully 53 | 54 | ##### 400 55 | Errors codes: 56 | * `missing_mac_address`: the mac address of the device is missing. 57 | * `malformed_mac_address`: the mac address of the device is malformed. 58 | * `missing_url`: the url to associate to device is missing. 59 | * `unable_to_parse_url`: the url is not correctly formatted. 60 | * `unsupported_url_scheme`: the scheme of the url is not supported (valid schemes: `ftp`, `tftp`, `http`, `https`) 61 | * `missing_mac-id_crc`: the crc code of the provided mac address is missing, 62 | error returned only in case of Gigaset provider. 63 | * `invalid_mac-id_crc_format`: the crc code provided is in invalid format, 64 | error returned only in case of Gigaset provider. 65 | 66 | ##### 404 67 | Errors codes: 68 | * `provider_not_supported`: the selected providers is not supported or disabled. 69 | 70 | ##### 500 71 | Errors codes: 72 | * `connection_to_remote_provider_failed`: the connection to remote provider failed, the addition field 73 | `message` is provided. 74 | * `provider_remote_call_failed`: the remote provider responded with a HTTP status code that is not `200`. 75 | * `read_remote_response_failed`: error on read remote response. 76 | * `unknown_response_from_provider`: unknown response from remote provider. 77 | * `malformed_url`: the provided url was not accepted by the remote provider. 78 | * `not_valid_mac_address`: the provided mac address was not accepted by the remote provider. 79 | * `device_owned_by_other_user`: the provided mac address was already configured by another provider user. 80 | * `unknown_provider_error`: the error returned by provider is unknown, the addition field 81 | `message` is provided. 82 | 83 | ## Usage 84 | 85 | ``` 86 | Usage of ./falconieri: 87 | -c string 88 | Path to configuration file (default "/opt/falconieri/conf.json") 89 | ``` 90 | 91 | ## Configuration 92 | Falconieri can configured via json file or environment variables, if present **the values in the environment variable take the precedence** over the ones declared in files. 93 | 94 | ### JSON 95 | 96 | #### Providers configuration 97 | The `provider` section define the remote providers configuration, common configurations fields to each provider: 98 | 99 | * `user` Username for access to provider 100 | * `password` Password for access to provider 101 | * `rpc_url` The URL for XML-RPC requests 102 | * `disable` Enable/Disable the provider, default `false` 103 | 104 | Gigaset specific: 105 | 106 | * `disable_crc` If set to `true` Falconieri don't send the mac address's CRC code, default `false` 107 | 108 | 109 | Example: 110 | 111 | ```json 112 | { 113 | "providers": { 114 | "snom": { 115 | "user":"user", 116 | "password": "password", 117 | "rpc_url": "https://secure-provisioning.snom.com:8083/xmlrpc/", 118 | "disable": false 119 | } 120 | } 121 | ``` 122 | 123 | ### Environment Variables 124 | 125 | * `SNOM_USER` Username for access to Snom provider 126 | * `SNOM_PASSWORD` Password for access to Snom provider 127 | * `SNOM_RPC_URL` The URL for XML-RPC requests of Snom provider 128 | * `SNOM_DISABLE` Enable/Disable the provider, default `false` 129 | 130 | * `GIGASET_USER` Username for access to Gigaset provider 131 | * `GIGASET_PASSWORD` Password for access to Gigaset provider 132 | * `GIGASET_RPC_URL` The URL for XML-RPC requests of Gigaset provider 133 | * `GIGASET_DISABLE_CRC` If set to `true` Falconieri don't send the mac address's CRC code, default `false` 134 | * `GIGASET_DISABLE` Enable/Disable the provider, default `false` 135 | 136 | * `FANVIL_USER` Username for access to Fanvil provider 137 | * `FANVIL_PASSWORD` Password for access to Fanvil provider 138 | * `FANVIL_RPC_URL` The URL for XML-RPC requests of Fanvil provider 139 | * `FANVIL_DISABLE` Enable/Disable the provider, default `false` 140 | 141 | * `YEALINK_USER` Username for access to Yealink provider 142 | * `YEALINK_PASSWORD` Password for access to Yealink provider 143 | * `YEALINK_RPC_URL` The URL for XML-RPC requests of Yealink provider 144 | * `YEALINK_DISABLE` Enable/Disable the provider, default `false` 145 | 146 | ## Other projects 147 | 148 | [Tancredi](https://nethesis.github.io/tancredi/) is a phone provisioning engine ideal for internet deployments. 149 | -------------------------------------------------------------------------------- /configuration/config.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package configuration 24 | 25 | import ( 26 | "encoding/json" 27 | "fmt" 28 | "os" 29 | "strconv" 30 | ) 31 | 32 | type ProviderConf struct { 33 | Password string `json:"password"` 34 | User string `json:"user"` 35 | RpcUrl string `json:"rpc_url"` 36 | Disable bool `json:"disable"` 37 | } 38 | 39 | type GigasetConf struct { 40 | ProviderConf 41 | DisableCrc bool `json:"disable_crc"` 42 | } 43 | 44 | type Configuration struct { 45 | Providers struct { 46 | Snom ProviderConf `json:"snom"` 47 | Gigaset GigasetConf `json:"gigaset"` 48 | Fanvil ProviderConf `json:"fanvil"` 49 | Yealink ProviderConf `json:"yealink"` 50 | } `json: "providers"` 51 | } 52 | 53 | var Config = Configuration{} 54 | 55 | func Init(ConfigFilePtr *string) { 56 | 57 | // read configuration 58 | if _, err := os.Stat(*ConfigFilePtr); err == nil { 59 | file, _ := os.Open(*ConfigFilePtr) 60 | decoder := json.NewDecoder(file) 61 | // check errors or parse JSON 62 | err := decoder.Decode(&Config) 63 | if err != nil { 64 | fmt.Println("Configuration parsing error:", err) 65 | } 66 | } 67 | 68 | if os.Getenv("SNOM_USER") != "" { 69 | Config.Providers.Snom.User = os.Getenv("SNOM_USER") 70 | } 71 | 72 | if os.Getenv("SNOM_PASSWORD") != "" { 73 | Config.Providers.Snom.Password = os.Getenv("SNOM_PASSWORD") 74 | } 75 | 76 | if os.Getenv("SNOM_RPC_URL") != "" { 77 | Config.Providers.Snom.RpcUrl = os.Getenv("SNOM_RPC_URL") 78 | } 79 | 80 | if os.Getenv("SNOM_DISABLE") != "" { 81 | 82 | disable, err := strconv.ParseBool(os.Getenv("SNOM_DISABLE")) 83 | if err == nil { 84 | Config.Providers.Snom.Disable = disable 85 | } 86 | } 87 | 88 | if !Config.Providers.Snom.Disable && 89 | (Config.Providers.Snom.User == "" && 90 | Config.Providers.Snom.Password == "" && 91 | Config.Providers.Snom.RpcUrl == "") { 92 | 93 | Config.Providers.Snom.Disable = true 94 | } 95 | 96 | if os.Getenv("GIGASET_USER") != "" { 97 | Config.Providers.Gigaset.User = os.Getenv("GIGASET_USER") 98 | } 99 | 100 | if os.Getenv("GIGASET_PASSWORD") != "" { 101 | Config.Providers.Gigaset.Password = os.Getenv("GIGASET_PASSWORD") 102 | } 103 | 104 | if os.Getenv("GIGASET_RPC_URL") != "" { 105 | Config.Providers.Gigaset.RpcUrl = os.Getenv("GIGASET_RPC_URL") 106 | } 107 | 108 | if os.Getenv("GIGASET_DISABLE_CRC") != "" { 109 | 110 | disableCrc, err := strconv.ParseBool(os.Getenv("GIGASET_DISABLE_CRC")) 111 | if err == nil { 112 | Config.Providers.Gigaset.DisableCrc = disableCrc 113 | } 114 | } 115 | 116 | if os.Getenv("GIGASET_DISABLE") != "" { 117 | 118 | disable, err := strconv.ParseBool(os.Getenv("GIGASET_DISABLE")) 119 | if err == nil { 120 | Config.Providers.Gigaset.Disable = disable 121 | } 122 | } 123 | 124 | if !Config.Providers.Gigaset.Disable && 125 | (Config.Providers.Gigaset.User == "" && 126 | Config.Providers.Gigaset.Password == "" && 127 | Config.Providers.Gigaset.RpcUrl == "") { 128 | 129 | Config.Providers.Gigaset.Disable = true 130 | } 131 | 132 | if os.Getenv("FANVIL_USER") != "" { 133 | Config.Providers.Fanvil.User = os.Getenv("FANVIL_USER") 134 | } 135 | 136 | if os.Getenv("FANVIL_PASSWORD") != "" { 137 | Config.Providers.Fanvil.Password = os.Getenv("FANVIL_PASSWORD") 138 | } 139 | 140 | if os.Getenv("FANVIL_RPC_URL") != "" { 141 | Config.Providers.Fanvil.RpcUrl = os.Getenv("FANVIL_RPC_URL") 142 | } 143 | 144 | if os.Getenv("FANVIL_DISABLE") != "" { 145 | 146 | disable, err := strconv.ParseBool(os.Getenv("FANVIL_DISABLE")) 147 | if err == nil { 148 | Config.Providers.Fanvil.Disable = disable 149 | } 150 | } 151 | 152 | if !Config.Providers.Fanvil.Disable && 153 | (Config.Providers.Fanvil.User == "" && 154 | Config.Providers.Fanvil.Password == "" && 155 | Config.Providers.Fanvil.RpcUrl == "") { 156 | 157 | Config.Providers.Fanvil.Disable = true 158 | } 159 | 160 | if os.Getenv("YEALINK_USER") != "" { 161 | Config.Providers.Yealink.User = os.Getenv("YEALINK_USER") 162 | } 163 | 164 | if os.Getenv("YEALINK_PASSWORD") != "" { 165 | Config.Providers.Yealink.Password = os.Getenv("YEALINK_PASSWORD") 166 | } 167 | 168 | if os.Getenv("YEALINK_RPC_URL") != "" { 169 | Config.Providers.Yealink.RpcUrl = os.Getenv("YEALINK_RPC_URL") 170 | } 171 | 172 | if os.Getenv("YEALINK_DISABLE") != "" { 173 | 174 | disable, err := strconv.ParseBool(os.Getenv("YEALINK_DISABLE")) 175 | if err == nil { 176 | Config.Providers.Yealink.Disable = disable 177 | } 178 | } 179 | 180 | if !Config.Providers.Yealink.Disable && 181 | (Config.Providers.Yealink.User == "" && 182 | Config.Providers.Yealink.Password == "" && 183 | Config.Providers.Yealink.RpcUrl == "") { 184 | 185 | Config.Providers.Yealink.Disable = true 186 | } 187 | } 188 | -------------------------------------------------------------------------------- /deploy/Vagrantfile: -------------------------------------------------------------------------------- 1 | Vagrant.configure("2") do |config| 2 | config.vm.box = "centos/7" 3 | 4 | config.vm.network "forwarded_port", guest: 8080, host: 8080 5 | 6 | config.vm.provision "ansible" do |ansible| 7 | ansible.playbook = "ansible/playbook.yml" 8 | ansible.become = true 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /deploy/ansible/playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | become: true 4 | roles: 5 | - role: falconieri -------------------------------------------------------------------------------- /deploy/ansible/roles/falconieri/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | falconieri_url: https://github.com/nethesis/falconieri 3 | falconieri_version: v1.0.11 4 | 5 | snom_user: user 6 | snom_password: password 7 | snom_rpc_url: https://secure-provisioning.snom.com:8083/xmlrpc/ 8 | snom_disable: "false" 9 | 10 | yealink_user: user 11 | yealink_password: password 12 | yealink_rpc_url: https://api-dm.yealink.com:8443/xmlrpc 13 | yealink_disable: "false" 14 | 15 | gigaset_user: user 16 | gigaset_password: password 17 | gigaset_rpc_url: https://prov.gigaset.net/apxml/rpc.do 18 | gigaset_disable: "false" 19 | gigaset_disable_crc: "false" 20 | 21 | fanvil_user: user 22 | fanvil_password: password 23 | fanvil_rpc_url: http://fdps.fanvil.com/xmlrpc.php 24 | fanvil_disable: "false" 25 | -------------------------------------------------------------------------------- /deploy/ansible/roles/falconieri/files/falconieri.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Falconieri Remote Provisioning Gateway 3 | After=network.target cloud-init.service 4 | 5 | [Service] 6 | Type=simple 7 | User=root 8 | WorkingDirectory=/opt/falconieri 9 | EnvironmentFile=-/opt/falconieri/conf.env 10 | Environment=GIN_MODE=release 11 | ExecStart=/opt/falconieri/falconieri 12 | Restart=on-failure 13 | RestartSec=5 14 | 15 | [Install] 16 | WantedBy=multi-user.target -------------------------------------------------------------------------------- /deploy/ansible/roles/falconieri/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create falconieri destination directory 3 | file: 4 | path: /opt/falconieri 5 | state: directory 6 | recurse: yes 7 | 8 | - name: Download and install falconieri executable 9 | get_url: 10 | url: "{{ falconieri_url }}/releases/download/{{ falconieri_version }}/falconieri" 11 | force: true 12 | dest: /opt/falconieri/falconieri 13 | mode: 0755 14 | 15 | - name: Copy falconieri configuration 16 | template: 17 | dest: /opt/falconieri/conf.json 18 | src: conf.json.tpl 19 | 20 | - name: Copy systemd unit file 21 | copy: 22 | dest: /usr/lib/systemd/system/ 23 | src: falconieri.service 24 | 25 | - name: Systemd configuration 26 | systemd: 27 | name: falconieri 28 | daemon_reload: true 29 | enabled: true 30 | state: started -------------------------------------------------------------------------------- /deploy/ansible/roles/falconieri/templates/conf.json.tpl: -------------------------------------------------------------------------------- 1 | { 2 | "providers": { 3 | "snom": { 4 | "user":"{{ snom_user }}", 5 | "password": "{{ snom_password }}", 6 | "rpc_url": "{{ snom_rpc_url }}", 7 | "disable": {{ snom_disable }} 8 | }, 9 | "yealink": { 10 | "user":"{{ yealink_user }}", 11 | "password": "{{ yealink_password }}", 12 | "rpc_url": "{{ yealink_rpc_url }}", 13 | "disable": {{ yealink_disable }} 14 | }, 15 | "giagaset": { 16 | "user":"{{ gigaset_user }}", 17 | "password": "{{ gigaset_password }}", 18 | "rpc_url": "{{ gigaset_rpc_url }}", 19 | "disable": {{ gigaset_disable }}, 20 | "disable_crc": {{ gigaset_disable_crc }} 21 | }, 22 | "fanvil": { 23 | "user":"{{ fanvil_user }}", 24 | "password": "{{ fanvil_password }}", 25 | "rpc_url": "{{ fanvil_rpc_url }}", 26 | "disable": {{ fanvil_disable }} 27 | } 28 | } 29 | } -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/nethesis/falconieri 2 | 3 | go 1.13 4 | 5 | require ( 6 | github.com/divan/gorilla-xmlrpc v0.0.0-20190926132722-f0686da74fda 7 | github.com/gin-gonic/gin v1.9.1 8 | github.com/gorilla/rpc v1.2.0 // indirect 9 | github.com/rogpeppe/go-charset v0.0.0-20190617161244-0dc95cdf6f31 // indirect 10 | ) 11 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1O2AihPM= 2 | github.com/bytedance/sonic v1.9.1 h1:6iJ6NqdoxCDr6mbY8h18oSO+cShGSMRGCEo7F2h0x8s= 3 | github.com/bytedance/sonic v1.9.1/go.mod h1:i736AoUSYt75HyZLoJW9ERYxcy6eaN6h4BZXU064P/U= 4 | github.com/chenzhuoyu/base64x v0.0.0-20211019084208-fb5309c8db06/go.mod h1:DH46F32mSOjUmXrMHnKwZdA8wcEefY7UVqBKYGjpdQY= 5 | github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 h1:qSGYFH7+jGhDF8vLC+iwCD4WpbV1EBDSzWkJODFLams= 6 | github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311/go.mod h1:b583jCggY9gE99b6G5LEC39OIiVsWj+R97kbl5odCEk= 7 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 8 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 9 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 10 | github.com/divan/gorilla-xmlrpc v0.0.0-20190926132722-f0686da74fda h1:q6BJCx6rxRJv/sLreclgzu4dK4dPF8x48afqcXtRtLQ= 11 | github.com/divan/gorilla-xmlrpc v0.0.0-20190926132722-f0686da74fda/go.mod h1:3Cp6mWQcmK3erqkPrriKEkSpok0LO1uB2M5GxGzifhc= 12 | github.com/gabriel-vasile/mimetype v1.4.2 h1:w5qFW6JKBz9Y393Y4q372O9A7cUSequkh1Q7OhCmWKU= 13 | github.com/gabriel-vasile/mimetype v1.4.2/go.mod h1:zApsH/mKG4w07erKIaJPFiX0Tsq9BFQgN3qGY5GnNgA= 14 | github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= 15 | github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= 16 | github.com/gin-gonic/gin v1.9.1 h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqJ+Jmg= 17 | github.com/gin-gonic/gin v1.9.1/go.mod h1:hPrL7YrpYKXt5YId3A/Tnip5kqbEAP+KLuI3SUcPTeU= 18 | github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= 19 | github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= 20 | github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= 21 | github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= 22 | github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= 23 | github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= 24 | github.com/go-playground/validator/v10 v10.14.0 h1:vgvQWe3XCz3gIeFDm/HnTIbj6UGmg/+t63MyGU2n5js= 25 | github.com/go-playground/validator/v10 v10.14.0/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU= 26 | github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU= 27 | github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= 28 | github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= 29 | github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= 30 | github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= 31 | github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= 32 | github.com/gorilla/rpc v1.2.0 h1:WvvdC2lNeT1SP32zrIce5l0ECBfbAlmrmSBsuc57wfk= 33 | github.com/gorilla/rpc v1.2.0/go.mod h1:V4h9r+4sF5HnzqbwIez0fKSpANP0zlYd3qR7p36jkTQ= 34 | github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= 35 | github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= 36 | github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= 37 | github.com/klauspost/cpuid/v2 v2.2.4 h1:acbojRNwl3o09bUq+yDCtZFc1aiwaAAxtcn8YkZXnvk= 38 | github.com/klauspost/cpuid/v2 v2.2.4/go.mod h1:RVVoqg1df56z8g3pUjL/3lE5UfnlrJX8tyFgg4nqhuY= 39 | github.com/leodido/go-urn v1.2.4 h1:XlAE/cm/ms7TE/VMVoduSpNBoyc2dOxHs5MZSwAN63Q= 40 | github.com/leodido/go-urn v1.2.4/go.mod h1:7ZrI8mTSeBSHl/UaRyKQW1qZeMgak41ANeCNaVckg+4= 41 | github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= 42 | github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= 43 | github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= 44 | github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= 45 | github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= 46 | github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= 47 | github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= 48 | github.com/pelletier/go-toml/v2 v2.0.8 h1:0ctb6s9mE31h0/lhu+J6OPmVeDxJn+kYnJc2jZR9tGQ= 49 | github.com/pelletier/go-toml/v2 v2.0.8/go.mod h1:vuYfssBdrU2XDZ9bYydBu6t+6a6PYNcZljzZR9VXg+4= 50 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 51 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 52 | github.com/rogpeppe/go-charset v0.0.0-20190617161244-0dc95cdf6f31 h1:DE4LcMKyqAVa6a0CGmVxANbnVb7stzMmPkQiieyNmfQ= 53 | github.com/rogpeppe/go-charset v0.0.0-20190617161244-0dc95cdf6f31/go.mod h1:qgYeAmZ5ZIpBWTGllZSQnw97Dj+woV0toclVaRGI8pc= 54 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 55 | github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= 56 | github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= 57 | github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= 58 | github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 59 | github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 60 | github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= 61 | github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= 62 | github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= 63 | github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY= 64 | github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= 65 | github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= 66 | github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= 67 | github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4dU= 68 | github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg= 69 | github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= 70 | golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= 71 | golang.org/x/arch v0.3.0 h1:02VY4/ZcO/gBOH6PUaoiptASxtXU10jazRCP865E97k= 72 | golang.org/x/arch v0.3.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= 73 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 74 | golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= 75 | golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU= 76 | golang.org/x/crypto v0.9.0 h1:LF6fAI+IutBocDJ2OT0Q1g8plpYljMZ4+lty+dsqw3g= 77 | golang.org/x/crypto v0.9.0/go.mod h1:yrmDGqONDYtNj3tH8X9dzUun2m2lzPa9ngI6/RUPGR0= 78 | golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= 79 | golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= 80 | golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= 81 | golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= 82 | golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= 83 | golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= 84 | golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= 85 | golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M= 86 | golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= 87 | golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 88 | golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 89 | golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 90 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 91 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 92 | golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 93 | golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 94 | golang.org/x/sys v0.0.0-20220704084225-05e143d24a9e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 95 | golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 96 | golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 97 | golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 98 | golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU= 99 | golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 100 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 101 | golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= 102 | golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= 103 | golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= 104 | golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= 105 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 106 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 107 | golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= 108 | golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= 109 | golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= 110 | golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= 111 | golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= 112 | golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= 113 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 114 | golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= 115 | golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= 116 | golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= 117 | golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 118 | golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= 119 | golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 120 | google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= 121 | google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng= 122 | google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= 123 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 124 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 125 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 126 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 127 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 128 | rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= 129 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package main 24 | 25 | import ( 26 | "flag" 27 | "net/http" 28 | 29 | "github.com/gin-gonic/gin" 30 | 31 | "github.com/nethesis/falconieri/configuration" 32 | "github.com/nethesis/falconieri/methods" 33 | "github.com/nethesis/falconieri/middleware" 34 | ) 35 | 36 | func DefineAPI(router *gin.Engine) { 37 | 38 | router.GET("/health/check", methods.HealthCheck) 39 | 40 | providers := router.Group("/providers") 41 | 42 | providers.Use(middleware.FalconieriAuth) 43 | { 44 | providers.PUT("/:provider/:mac", methods.ProviderDispatch) 45 | } 46 | 47 | // handle missing endpoint 48 | router.NoRoute(func(c *gin.Context) { 49 | c.Status(http.StatusNotFound) 50 | }) 51 | 52 | } 53 | 54 | func main() { 55 | 56 | // read and init configuration 57 | ConfigFilePtr := flag.String("c", "/opt/falconieri/conf.json", "Path to configuration file") 58 | flag.Parse() 59 | configuration.Init(ConfigFilePtr) 60 | // init routers 61 | router := gin.Default() 62 | 63 | DefineAPI(router) 64 | 65 | router.Run() 66 | } 67 | -------------------------------------------------------------------------------- /methods/healthcheck.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package methods 24 | 25 | import ( 26 | "net/http" 27 | 28 | "github.com/gin-gonic/gin" 29 | ) 30 | 31 | func HealthCheck(c *gin.Context) { 32 | c.Status(http.StatusOK) 33 | } 34 | -------------------------------------------------------------------------------- /methods/providerDispatch.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package methods 24 | 25 | import ( 26 | "errors" 27 | "net/http" 28 | net_url "net/url" 29 | "regexp" 30 | 31 | "github.com/gin-gonic/gin" 32 | 33 | "github.com/nethesis/falconieri/configuration" 34 | "github.com/nethesis/falconieri/models" 35 | "github.com/nethesis/falconieri/providers" 36 | "github.com/nethesis/falconieri/utils" 37 | ) 38 | 39 | func ProviderDispatch(c *gin.Context) { 40 | 41 | var device interface { 42 | Register() error 43 | } 44 | 45 | switch provider := c.Param("provider"); { 46 | 47 | case (provider == "snom") && !configuration.Config.Providers.Snom.Disable: 48 | mac, url, err := parseParams(c) 49 | if err != nil { 50 | c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) 51 | return 52 | } 53 | 54 | redirectUrl, _ := net_url.QueryUnescape(url) 55 | 56 | device = providers.SnomDevice{ 57 | Mac: mac.A0 + mac.A1 + mac.A2 + mac.A3 + mac.A4 + mac.A5, 58 | Url: redirectUrl, 59 | } 60 | 61 | case (provider == "gigaset") && !configuration.Config.Providers.Gigaset.Disable: 62 | mac, url, err := parseParams(c) 63 | if err != nil { 64 | c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) 65 | return 66 | } 67 | 68 | redirectUrl, _ := net_url.QueryUnescape(url) 69 | 70 | var mac_address string 71 | 72 | if configuration.Config.Providers.Gigaset.DisableCrc { 73 | 74 | mac_address = mac.A0 + mac.A1 + mac.A2 + mac.A3 + mac.A4 + mac.A5 75 | 76 | } else { 77 | 78 | if regexp.MustCompile(`^[A-Z0-9]{4}$`).MatchString(c.Query("crc")) { 79 | 80 | mac_address = mac.A0 + mac.A1 + mac.A2 + mac.A3 + mac.A4 + mac.A5 + "-" + c.Query("crc") 81 | 82 | } else if c.Query("crc") == "" { 83 | 84 | c.JSON(http.StatusBadRequest, gin.H{"error": "missing_mac-id_crc"}) 85 | return 86 | 87 | } else { 88 | 89 | c.JSON(http.StatusBadRequest, gin.H{"error": "invalid_mac-id_crc_format"}) 90 | return 91 | } 92 | 93 | } 94 | 95 | device = providers.GigasetDevice{ 96 | Mac: mac_address, 97 | Url: redirectUrl, 98 | Provider: "Falconieri", 99 | } 100 | 101 | case (provider == "fanvil") && !configuration.Config.Providers.Fanvil.Disable: 102 | mac, url, err := parseParams(c) 103 | if err != nil { 104 | c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) 105 | return 106 | } 107 | 108 | device = providers.FanvilDevice{ 109 | Mac: mac.A0 + mac.A1 + mac.A2 + mac.A3 + mac.A4 + mac.A5, 110 | Url: url, 111 | } 112 | 113 | case (provider == "yealink") && !configuration.Config.Providers.Yealink.Disable: 114 | mac, url, err := parseParams(c) 115 | if err != nil { 116 | c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) 117 | return 118 | } 119 | 120 | redirectUrl, _ := net_url.QueryUnescape(url) 121 | 122 | device = providers.YealinkDevice{ 123 | Mac: mac.A0 + "-" + mac.A1 + "-" + mac.A2 + "-" + mac.A3 + "-" + mac.A4 + "-" + mac.A5, 124 | Url: redirectUrl, 125 | ServerName: "Falconieri", 126 | Override: "1", 127 | } 128 | 129 | default: 130 | c.JSON(http.StatusNotFound, gin.H{"error": "provider_not_supported"}) 131 | return 132 | } 133 | 134 | err := device.Register() 135 | if err != nil { 136 | if errors.Unwrap(err) != nil { 137 | c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error(), 138 | "message": errors.Unwrap(err).Error()}) 139 | } else { 140 | c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) 141 | } 142 | return 143 | } 144 | 145 | c.Status(http.StatusOK) 146 | } 147 | 148 | func parseParams(c *gin.Context) (models.MacAddress, string, error) { 149 | 150 | var url models.Url 151 | 152 | mac, err := utils.GetMacAddress(c.Param("mac")) 153 | if err != nil { 154 | return mac, "", errors.New("missing_mac_address") 155 | } 156 | 157 | if err := c.BindJSON(&url); err != nil { 158 | return mac, "", errors.New("missing_url") 159 | } 160 | 161 | var pUrl *net_url.URL 162 | pUrl, err = net_url.Parse(url.Url) 163 | if err != nil { 164 | return mac, "", errors.New("unable_to_parse_url") 165 | } 166 | 167 | if pUrl.Scheme != "ftp" && 168 | pUrl.Scheme != "tftp" && 169 | pUrl.Scheme != "http" && 170 | pUrl.Scheme != "https" { 171 | return mac, pUrl.String(), errors.New("unsupported_url_scheme") 172 | } 173 | 174 | return mac, pUrl.String(), nil 175 | } 176 | -------------------------------------------------------------------------------- /middleware/middleware.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package middleware 24 | 25 | import ( 26 | "github.com/gin-gonic/gin" 27 | ) 28 | 29 | func FalconieriAuth(c *gin.Context) { 30 | 31 | c.Next() 32 | } 33 | -------------------------------------------------------------------------------- /models/mac.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package models 24 | 25 | type MacAddress struct { 26 | A0 string 27 | A1 string 28 | A2 string 29 | A3 string 30 | A4 string 31 | A5 string 32 | } 33 | -------------------------------------------------------------------------------- /models/providerError.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package models 24 | 25 | type ProviderError struct { 26 | Message string 27 | WrappedError error 28 | } 29 | 30 | func (e ProviderError) Error() string { 31 | return e.Message 32 | } 33 | 34 | func (e ProviderError) Unwrap() error { 35 | return e.WrappedError 36 | } 37 | -------------------------------------------------------------------------------- /models/url.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package models 24 | 25 | type Url struct { 26 | Url string `json:"url"` 27 | } 28 | -------------------------------------------------------------------------------- /providers/fanvil.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package providers 24 | 25 | import ( 26 | "bytes" 27 | "crypto/md5" 28 | "errors" 29 | "fmt" 30 | "io" 31 | "io/ioutil" 32 | "net/http" 33 | "net/url" 34 | "regexp" 35 | "strconv" 36 | "strings" 37 | 38 | "github.com/divan/gorilla-xmlrpc/xml" 39 | 40 | "github.com/nethesis/falconieri/configuration" 41 | "github.com/nethesis/falconieri/models" 42 | "github.com/nethesis/falconieri/utils" 43 | ) 44 | 45 | type FanvilDevice struct { 46 | Mac string 47 | Url string 48 | } 49 | 50 | var fanvilPassword string 51 | 52 | func (d FanvilDevice) Register() error { 53 | 54 | password := fanvilGetPassword() 55 | 56 | //Delete old server 57 | buf, _ := xml.EncodeClientRequest("redirect.deleteServer", 58 | &struct { 59 | GroupName string 60 | }{GroupName: d.Mac}) 61 | 62 | req, _ := http.NewRequest("POST", configuration.Config.Providers.Fanvil.RpcUrl, 63 | bytes.NewReader(buf)) 64 | 65 | req.SetBasicAuth(configuration.Config.Providers.Fanvil.User, password) 66 | 67 | req.Header.Set("Content-Type", "text/xml") 68 | req.Header.Set("User-Agent", " Falconieri/1") 69 | 70 | resp, err := http.DefaultClient.Do(req) 71 | 72 | if err != nil { 73 | return models.ProviderError{ 74 | Message: "connection_to_remote_provider_failed", 75 | WrappedError: err, 76 | } 77 | 78 | } 79 | 80 | defer resp.Body.Close() 81 | 82 | if resp.StatusCode != http.StatusOK { 83 | return errors.New("provider_remote_call_failed") 84 | } 85 | 86 | err = fanvilParseResponse(resp.Body) 87 | 88 | if (err != nil) && (errors.Unwrap(err).Error() != "Error:server_not_exist") { 89 | return err 90 | } 91 | 92 | //Create Server 93 | var Url *url.URL 94 | var UrlScheme string 95 | 96 | Url, err = url.Parse(d.Url) 97 | 98 | switch Url.Scheme { 99 | case "ftp": 100 | UrlScheme = "1" 101 | case "tftp": 102 | UrlScheme = "2" 103 | case "http": 104 | UrlScheme = "4" 105 | case "https": 106 | UrlScheme = "5" 107 | } 108 | 109 | /* Server/Group configuration: 110 | * - Disable DHCP provision: cfgDhcpOpt=false 111 | * - Disable PnP provision: cfgPnpEnable=false 112 | * - Apply the configuration after the reboot: cfgPfMode=1 113 | */ 114 | 115 | buf, _ = xml.EncodeClientRequest("redirect.addMaterialServer", 116 | &struct { 117 | ServerConfigs []string 118 | }{ServerConfigs: []string{"cfgName=" + d.Mac, "cfgPfMode=1", 119 | "cfgDhcpOpt=false", "cfgPnpEnable=false", 120 | "cfgPfSrv=" + Url.Host, "cfgPfName=" + strings.TrimPrefix(Url.Path, "/"), 121 | "cfgPfProt=" + UrlScheme}}) 122 | 123 | req, _ = http.NewRequest("POST", configuration.Config.Providers.Fanvil.RpcUrl, 124 | bytes.NewReader(buf)) 125 | 126 | req.SetBasicAuth(configuration.Config.Providers.Fanvil.User, password) 127 | 128 | req.Header.Set("Content-Type", "text/xml") 129 | req.Header.Set("User-Agent", " Falconieri/1") 130 | 131 | resp, err = http.DefaultClient.Do(req) 132 | 133 | if err != nil { 134 | return models.ProviderError{ 135 | Message: "connection_to_remote_provider_failed", 136 | WrappedError: err, 137 | } 138 | 139 | } 140 | 141 | defer resp.Body.Close() 142 | 143 | if resp.StatusCode != http.StatusOK { 144 | return errors.New("provider_remote_call_failed") 145 | } 146 | 147 | err = fanvilParseResponse(resp.Body) 148 | 149 | if err != nil { 150 | return err 151 | } 152 | 153 | //Deregister the device 154 | buf, _ = xml.EncodeClientRequest("redirect.deRegisterDevice", 155 | &struct { 156 | Mac string 157 | }{Mac: d.Mac}) 158 | 159 | req, _ = http.NewRequest("POST", configuration.Config.Providers.Fanvil.RpcUrl, 160 | bytes.NewReader(buf)) 161 | 162 | req.SetBasicAuth(configuration.Config.Providers.Fanvil.User, password) 163 | 164 | req.Header.Set("Content-Type", "text/xml") 165 | req.Header.Set("User-Agent", " Falconieri/1") 166 | 167 | resp, err = http.DefaultClient.Do(req) 168 | 169 | if err != nil { 170 | return models.ProviderError{ 171 | Message: "connection_to_remote_provider_failed", 172 | WrappedError: err, 173 | } 174 | 175 | } 176 | 177 | defer resp.Body.Close() 178 | 179 | if resp.StatusCode != http.StatusOK { 180 | return errors.New("provider_remote_call_failed") 181 | } 182 | 183 | //Register the device 184 | buf, _ = xml.EncodeClientRequest("redirect.registerDevice", 185 | &struct { 186 | Mac string 187 | ServerName string 188 | }{Mac: d.Mac, ServerName: d.Mac}) 189 | 190 | req, _ = http.NewRequest("POST", configuration.Config.Providers.Fanvil.RpcUrl, 191 | bytes.NewReader(buf)) 192 | 193 | req.SetBasicAuth(configuration.Config.Providers.Fanvil.User, password) 194 | 195 | req.Header.Set("Content-Type", "text/xml") 196 | req.Header.Set("User-Agent", " Falconieri/1") 197 | 198 | resp, err = http.DefaultClient.Do(req) 199 | 200 | if err != nil { 201 | return models.ProviderError{ 202 | Message: "connection_to_remote_provider_failed", 203 | WrappedError: err, 204 | } 205 | 206 | } 207 | 208 | defer resp.Body.Close() 209 | 210 | if resp.StatusCode != http.StatusOK { 211 | return errors.New("provider_remote_call_failed") 212 | } 213 | 214 | err = fanvilParseResponse(resp.Body) 215 | 216 | return err 217 | } 218 | 219 | func fanvilGetPassword() string { 220 | 221 | if fanvilPassword == "" { 222 | 223 | h := md5.New() 224 | io.WriteString(h, configuration.Config.Providers.Fanvil.Password) 225 | d1 := fmt.Sprintf("%x", h.Sum(nil)) 226 | 227 | h2 := md5.New() 228 | io.WriteString(h2, d1) 229 | fanvilPassword = fmt.Sprintf("%x", h2.Sum(nil)) 230 | 231 | return fanvilPassword 232 | 233 | } else { 234 | return fanvilPassword 235 | } 236 | } 237 | 238 | func fanvilParseResponse(body io.ReadCloser) error { 239 | 240 | var response_regexp = `(?s).*(.*).*(.*).*` 241 | 242 | respBytes, err := ioutil.ReadAll(body) 243 | 244 | if err != nil { 245 | return errors.New("read_remote_response_failed") 246 | } 247 | 248 | re := regexp.MustCompile(response_regexp) 249 | 250 | if re.MatchString(string(respBytes)) { 251 | 252 | response := re.FindStringSubmatch(string(respBytes)) 253 | 254 | var success bool 255 | 256 | success, _ = strconv.ParseBool(response[1]) 257 | message := response[2] 258 | 259 | if !success { 260 | return utils.ParseProviderError(message) 261 | } 262 | 263 | } else { 264 | return errors.New("unknown_response_from_provider") 265 | } 266 | 267 | return nil 268 | } 269 | -------------------------------------------------------------------------------- /providers/gigaset.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package providers 24 | 25 | import ( 26 | "bytes" 27 | "errors" 28 | "io/ioutil" 29 | "net/http" 30 | "regexp" 31 | "strconv" 32 | 33 | "github.com/divan/gorilla-xmlrpc/xml" 34 | 35 | "github.com/nethesis/falconieri/configuration" 36 | "github.com/nethesis/falconieri/models" 37 | "github.com/nethesis/falconieri/utils" 38 | ) 39 | 40 | type GigasetDevice struct { 41 | Mac string 42 | Url string 43 | Provider string 44 | } 45 | 46 | func (d GigasetDevice) Register() error { 47 | 48 | var response_regexp = `(.*)(.*)` 49 | 50 | //Deregister the device, dont care if the device already exists or not 51 | buf, _ := xml.EncodeClientRequest("autoprov.deregisterDevice", &struct{ Mac string }{Mac: d.Mac}) 52 | 53 | req, _ := http.NewRequest("POST", configuration.Config.Providers.Gigaset.RpcUrl, 54 | bytes.NewReader(buf)) 55 | 56 | req.SetBasicAuth(configuration.Config.Providers.Gigaset.User, 57 | configuration.Config.Providers.Gigaset.Password) 58 | 59 | req.Header.Set("Content-Type", "text/xml") 60 | req.Header.Set("User-Agent", " Falconieri/1") 61 | 62 | resp, err := http.DefaultClient.Do(req) 63 | 64 | if err != nil { 65 | return models.ProviderError{ 66 | Message: "connection_to_remote_provider_failed", 67 | WrappedError: err, 68 | } 69 | } 70 | 71 | defer resp.Body.Close() 72 | 73 | if resp.StatusCode != http.StatusOK { 74 | return errors.New("provider_remote_call_failed") 75 | } 76 | 77 | //Register the device 78 | buf, _ = xml.EncodeClientRequest("autoprov.registerDevice", &d) 79 | 80 | req, _ = http.NewRequest("POST", configuration.Config.Providers.Gigaset.RpcUrl, 81 | bytes.NewReader(buf)) 82 | 83 | req.SetBasicAuth(configuration.Config.Providers.Gigaset.User, 84 | configuration.Config.Providers.Gigaset.Password) 85 | 86 | req.Header.Set("Content-Type", "text/xml") 87 | req.Header.Set("User-Agent", " Falconieri/1") 88 | 89 | resp, err = http.DefaultClient.Do(req) 90 | 91 | if err != nil { 92 | return models.ProviderError{ 93 | Message: "connection_to_remote_provider_failed", 94 | WrappedError: err, 95 | } 96 | 97 | } 98 | 99 | defer resp.Body.Close() 100 | 101 | if resp.StatusCode != http.StatusOK { 102 | return errors.New("provider_remote_call_failed") 103 | } 104 | 105 | respBytes, err := ioutil.ReadAll(resp.Body) 106 | 107 | if err != nil { 108 | return errors.New("read_remote_response_failed") 109 | } 110 | 111 | re := regexp.MustCompile(response_regexp) 112 | 113 | if re.MatchString(string(respBytes)) { 114 | 115 | response := re.FindStringSubmatch(string(respBytes)) 116 | 117 | var success bool 118 | 119 | success, _ = strconv.ParseBool(response[1]) 120 | message := response[2] 121 | 122 | if !success { 123 | return utils.ParseProviderError(message) 124 | } 125 | 126 | } else { 127 | return errors.New("unknow_response_from_provider") 128 | } 129 | 130 | return nil 131 | } 132 | -------------------------------------------------------------------------------- /providers/snom.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package providers 24 | 25 | import ( 26 | "bytes" 27 | "errors" 28 | "io/ioutil" 29 | "net/http" 30 | "regexp" 31 | "strconv" 32 | 33 | "github.com/divan/gorilla-xmlrpc/xml" 34 | 35 | "github.com/nethesis/falconieri/configuration" 36 | "github.com/nethesis/falconieri/models" 37 | "github.com/nethesis/falconieri/utils" 38 | ) 39 | 40 | type SnomDevice struct { 41 | Mac string 42 | Url string 43 | } 44 | 45 | func (s SnomDevice) Register() error { 46 | 47 | var response_regexp = `(.*)(.*)` 48 | 49 | buf, _ := xml.EncodeClientRequest("redirect.registerPhone", &s) 50 | 51 | req, _ := http.NewRequest("POST", configuration.Config.Providers.Snom.RpcUrl, 52 | bytes.NewReader(buf)) 53 | 54 | req.SetBasicAuth(configuration.Config.Providers.Snom.User, 55 | configuration.Config.Providers.Snom.Password) 56 | 57 | req.Header.Set("Content-Type", "text/xml") 58 | req.Header.Set("User-Agent", " Falconieri/1") 59 | 60 | resp, err := http.DefaultClient.Do(req) 61 | 62 | if err != nil { 63 | return models.ProviderError{ 64 | Message: "connection_to_remote_provider_failed", 65 | WrappedError: err, 66 | } 67 | 68 | } 69 | 70 | defer resp.Body.Close() 71 | 72 | if resp.StatusCode != http.StatusOK { 73 | return errors.New("provider_remote_call_failed") 74 | } 75 | 76 | respBytes, err := ioutil.ReadAll(resp.Body) 77 | 78 | if err != nil { 79 | return errors.New("read_remote_response_failed") 80 | } 81 | 82 | re := regexp.MustCompile(response_regexp) 83 | 84 | if re.MatchString(string(respBytes)) { 85 | 86 | response := re.FindStringSubmatch(string(respBytes)) 87 | 88 | var success bool 89 | 90 | success, _ = strconv.ParseBool(response[1]) 91 | message := response[2] 92 | 93 | if !success { 94 | return utils.ParseProviderError(message) 95 | } 96 | 97 | } else { 98 | return errors.New("unknown_response_from_provider") 99 | } 100 | 101 | return nil 102 | } 103 | -------------------------------------------------------------------------------- /providers/yealink.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package providers 24 | 25 | import ( 26 | "bytes" 27 | "errors" 28 | "io/ioutil" 29 | "net/http" 30 | "regexp" 31 | "strconv" 32 | 33 | "github.com/divan/gorilla-xmlrpc/xml" 34 | 35 | "github.com/nethesis/falconieri/configuration" 36 | "github.com/nethesis/falconieri/models" 37 | "github.com/nethesis/falconieri/utils" 38 | ) 39 | 40 | type YealinkDevice struct { 41 | Mac string 42 | ServerName string 43 | Url string 44 | Override string 45 | } 46 | 47 | func (s YealinkDevice) Register() error { 48 | 49 | var response_regexp = `(?s)(.*)(.*)` 50 | 51 | buf, _ := xml.EncodeClientRequest("redirect.registerDeviceWithUniqueUrl", &s) 52 | 53 | req, _ := http.NewRequest("POST", configuration.Config.Providers.Yealink.RpcUrl, 54 | bytes.NewReader(buf)) 55 | 56 | req.SetBasicAuth(configuration.Config.Providers.Yealink.User, 57 | configuration.Config.Providers.Yealink.Password) 58 | 59 | req.Header.Set("Content-Type", "text/xml") 60 | req.Header.Set("User-Agent", " Falconieri/1") 61 | 62 | resp, err := http.DefaultClient.Do(req) 63 | 64 | if err != nil { 65 | return models.ProviderError{ 66 | Message: "connection_to_remote_provider_failed", 67 | WrappedError: err, 68 | } 69 | 70 | } 71 | 72 | defer resp.Body.Close() 73 | 74 | if resp.StatusCode != http.StatusOK { 75 | return errors.New("provider_remote_call_failed") 76 | } 77 | 78 | respBytes, err := ioutil.ReadAll(resp.Body) 79 | 80 | if err != nil { 81 | return errors.New("read_remote_response_failed") 82 | } 83 | 84 | re := regexp.MustCompile(response_regexp) 85 | if re.MatchString(string(respBytes)) { 86 | 87 | response := re.FindStringSubmatch(string(respBytes)) 88 | 89 | var success bool 90 | 91 | success, _ = strconv.ParseBool(response[1]) 92 | message := response[2] 93 | 94 | if !success { 95 | return utils.ParseProviderError(message) 96 | } 97 | 98 | } else { 99 | return errors.New("unknown_response_from_provider") 100 | } 101 | 102 | return nil 103 | 104 | } 105 | -------------------------------------------------------------------------------- /utils/utils.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2019 Nethesis S.r.l. 3 | * http://www.nethesis.it - info@nethesis.it 4 | * 5 | * This file is part of Falconieri project. 6 | * 7 | * Falconieri is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Affero General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, 10 | * or any later version. 11 | * 12 | * Falconieri 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 Affero General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Affero General Public License 18 | * along with Falconieri. If not, see LICENSE. 19 | * 20 | * author: Matteo Valentini 21 | */ 22 | 23 | package utils 24 | 25 | import ( 26 | "errors" 27 | "regexp" 28 | "strings" 29 | 30 | "github.com/nethesis/falconieri/models" 31 | ) 32 | 33 | func GetMacAddress(mac string) (models.MacAddress, error) { 34 | 35 | var macRegexp = regexp.MustCompile(`^([A-Z0-9]{2})-([A-Z0-9]{2})-([A-Z0-9]{2})-([A-Z0-9]{2})-([A-Z0-9]{2})-([A-Z0-9]{2})$`) 36 | 37 | var macAddress models.MacAddress 38 | 39 | if macRegexp.MatchString(mac) { 40 | 41 | macAddr := macRegexp.FindStringSubmatch(mac) 42 | 43 | macAddress.A0 = macAddr[1] 44 | macAddress.A1 = macAddr[2] 45 | macAddress.A2 = macAddr[3] 46 | macAddress.A3 = macAddr[4] 47 | macAddress.A4 = macAddr[5] 48 | macAddress.A5 = macAddr[6] 49 | 50 | return macAddress, nil 51 | 52 | } else { 53 | return macAddress, errors.New("malformed_mac_address") 54 | } 55 | } 56 | 57 | func ParseProviderError(message string) error { 58 | 59 | switch { 60 | case message == "Error:malformed_url", //snom 61 | message == "Error: url_format_error", //fanvil 62 | strings.HasPrefix(message, "url_invalid:"), //gigaset 63 | message == "Error:The url can only begin with 'http://' or 'https://' or 'ftp://' or 'tftp://'": //yealink 64 | 65 | return errors.New("malformed_url") 66 | 67 | case message == "Error:malformed_mac", //snom 68 | message == "Error: mac_format_error", //fanvil 69 | strings.HasPrefix(message, "mac_not_exist:"): //gigaset 70 | 71 | return errors.New("not_valid_mac_address") 72 | 73 | case message == "Error:owned_by_other_user", //snom 74 | message == "Error: device_had_existed", //fanvil 75 | strings.HasPrefix(message, "mac_already_in_use:"), //gigaset 76 | regexp.MustCompile(`^Error:[a-z0-9]{10}`).MatchString(message): //yealink 77 | 78 | return errors.New("device_owned_by_other_user") 79 | 80 | default: 81 | return models.ProviderError{ 82 | Message: "unknown_provider_error: " + message, 83 | WrappedError: errors.New(message), 84 | } 85 | } 86 | } 87 | --------------------------------------------------------------------------------