├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── README.rst ├── conftest.py ├── deploy.py ├── loco ├── __init__.py ├── loco.py └── utils.py ├── post ├── setup.cfg ├── setup.py ├── tests ├── __init__.py └── all_test.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *#* 3 | *.DS_STORE 4 | *.log 5 | *Data.fs* 6 | *flymake* 7 | dist/* 8 | *egg* 9 | urllist* 10 | build/ 11 | __pycache__/ 12 | /.Python 13 | /bin/ 14 | /include/ 15 | /lib/ 16 | /pip-selfcheck.json 17 | .tox/ 18 | .cache 19 | .coverage -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | matrix: 3 | include: 4 | - python: 3.5 5 | env: TOX_ENV=py35 6 | - python: 2.7.10 7 | env: TOX_ENV=py27 8 | - python: 3.4 9 | env: TOX_ENV=py34 10 | install: 11 | - pip install tox 12 | script: 13 | - tox -e $TOX_ENV 14 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | 3 | GNU AFFERO GENERAL PUBLIC LICENSE 4 | Version 3, 19 November 2007 5 | 6 | Copyright (C) 2007 Free Software Foundation, Inc. 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | Preamble 11 | 12 | The GNU Affero General Public License is a free, copyleft license for 13 | software and other kinds of works, specifically designed to ensure 14 | cooperation with the community in the case of network server software. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | our General Public Licenses are intended to guarantee your freedom to 19 | share and change all versions of a program--to make sure it remains free 20 | software for all its users. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | Developers that use our General Public Licenses protect your rights 30 | with two steps: (1) assert copyright on the software, and (2) offer 31 | you this License which gives you legal permission to copy, distribute 32 | and/or modify the software. 33 | 34 | A secondary benefit of defending all users' freedom is that 35 | improvements made in alternate versions of the program, if they 36 | receive widespread use, become available for other developers to 37 | incorporate. Many developers of free software are heartened and 38 | encouraged by the resulting cooperation. However, in the case of 39 | software used on network servers, this result may fail to come about. 40 | The GNU General Public License permits making a modified version and 41 | letting the public access it on a server without ever releasing its 42 | source code to the public. 43 | 44 | The GNU Affero General Public License is designed specifically to 45 | ensure that, in such cases, the modified source code becomes available 46 | to the community. It requires the operator of a network server to 47 | provide the source code of the modified version running there to the 48 | users of that server. Therefore, public use of a modified version, on 49 | a publicly accessible server, gives the public access to the source 50 | code of the modified version. 51 | 52 | An older license, called the Affero General Public License and 53 | published by Affero, was designed to accomplish similar goals. This is 54 | a different license, not a version of the Affero GPL, but Affero has 55 | released a new version of the Affero GPL which permits relicensing under 56 | this license. 57 | 58 | The precise terms and conditions for copying, distribution and 59 | modification follow. 60 | 61 | TERMS AND CONDITIONS 62 | 63 | 0. Definitions. 64 | 65 | "This License" refers to version 3 of the GNU Affero General Public License. 66 | 67 | "Copyright" also means copyright-like laws that apply to other kinds of 68 | works, such as semiconductor masks. 69 | 70 | "The Program" refers to any copyrightable work licensed under this 71 | License. Each licensee is addressed as "you". "Licensees" and 72 | "recipients" may be individuals or organizations. 73 | 74 | To "modify" a work means to copy from or adapt all or part of the work 75 | in a fashion requiring copyright permission, other than the making of an 76 | exact copy. The resulting work is called a "modified version" of the 77 | earlier work or a work "based on" the earlier work. 78 | 79 | A "covered work" means either the unmodified Program or a work based 80 | on the Program. 81 | 82 | To "propagate" a work means to do anything with it that, without 83 | permission, would make you directly or secondarily liable for 84 | infringement under applicable copyright law, except executing it on a 85 | computer or modifying a private copy. Propagation includes copying, 86 | distribution (with or without modification), making available to the 87 | public, and in some countries other activities as well. 88 | 89 | To "convey" a work means any kind of propagation that enables other 90 | parties to make or receive copies. Mere interaction with a user through 91 | a computer network, with no transfer of a copy, is not conveying. 92 | 93 | An interactive user interface displays "Appropriate Legal Notices" 94 | to the extent that it includes a convenient and prominently visible 95 | feature that (1) displays an appropriate copyright notice, and (2) 96 | tells the user that there is no warranty for the work (except to the 97 | extent that warranties are provided), that licensees may convey the 98 | work under this License, and how to view a copy of this License. If 99 | the interface presents a list of user commands or options, such as a 100 | menu, a prominent item in the list meets this criterion. 101 | 102 | 1. Source Code. 103 | 104 | The "source code" for a work means the preferred form of the work 105 | for making modifications to it. "Object code" means any non-source 106 | form of a work. 107 | 108 | A "Standard Interface" means an interface that either is an official 109 | standard defined by a recognized standards body, or, in the case of 110 | interfaces specified for a particular programming language, one that 111 | is widely used among developers working in that language. 112 | 113 | The "System Libraries" of an executable work include anything, other 114 | than the work as a whole, that (a) is included in the normal form of 115 | packaging a Major Component, but which is not part of that Major 116 | Component, and (b) serves only to enable use of the work with that 117 | Major Component, or to implement a Standard Interface for which an 118 | implementation is available to the public in source code form. A 119 | "Major Component", in this context, means a major essential component 120 | (kernel, window system, and so on) of the specific operating system 121 | (if any) on which the executable work runs, or a compiler used to 122 | produce the work, or an object code interpreter used to run it. 123 | 124 | The "Corresponding Source" for a work in object code form means all 125 | the source code needed to generate, install, and (for an executable 126 | work) run the object code and to modify the work, including scripts to 127 | control those activities. However, it does not include the work's 128 | System Libraries, or general-purpose tools or generally available free 129 | programs which are used unmodified in performing those activities but 130 | which are not part of the work. For example, Corresponding Source 131 | includes interface definition files associated with source files for 132 | the work, and the source code for shared libraries and dynamically 133 | linked subprograms that the work is specifically designed to require, 134 | such as by intimate data communication or control flow between those 135 | subprograms and other parts of the work. 136 | 137 | The Corresponding Source need not include anything that users 138 | can regenerate automatically from other parts of the Corresponding 139 | Source. 140 | 141 | The Corresponding Source for a work in source code form is that 142 | same work. 143 | 144 | 2. Basic Permissions. 145 | 146 | All rights granted under this License are granted for the term of 147 | copyright on the Program, and are irrevocable provided the stated 148 | conditions are met. This License explicitly affirms your unlimited 149 | permission to run the unmodified Program. The output from running a 150 | covered work is covered by this License only if the output, given its 151 | content, constitutes a covered work. This License acknowledges your 152 | rights of fair use or other equivalent, as provided by copyright law. 153 | 154 | You may make, run and propagate covered works that you do not 155 | convey, without conditions so long as your license otherwise remains 156 | in force. You may convey covered works to others for the sole purpose 157 | of having them make modifications exclusively for you, or provide you 158 | with facilities for running those works, provided that you comply with 159 | the terms of this License in conveying all material for which you do 160 | not control copyright. Those thus making or running the covered works 161 | for you must do so exclusively on your behalf, under your direction 162 | and control, on terms that prohibit them from making any copies of 163 | your copyrighted material outside their relationship with you. 164 | 165 | Conveying under any other circumstances is permitted solely under 166 | the conditions stated below. Sublicensing is not allowed; section 10 167 | makes it unnecessary. 168 | 169 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 170 | 171 | No covered work shall be deemed part of an effective technological 172 | measure under any applicable law fulfilling obligations under article 173 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 174 | similar laws prohibiting or restricting circumvention of such 175 | measures. 176 | 177 | When you convey a covered work, you waive any legal power to forbid 178 | circumvention of technological measures to the extent such circumvention 179 | is effected by exercising rights under this License with respect to 180 | the covered work, and you disclaim any intention to limit operation or 181 | modification of the work as a means of enforcing, against the work's 182 | users, your or third parties' legal rights to forbid circumvention of 183 | technological measures. 184 | 185 | 4. Conveying Verbatim Copies. 186 | 187 | You may convey verbatim copies of the Program's source code as you 188 | receive it, in any medium, provided that you conspicuously and 189 | appropriately publish on each copy an appropriate copyright notice; 190 | keep intact all notices stating that this License and any 191 | non-permissive terms added in accord with section 7 apply to the code; 192 | keep intact all notices of the absence of any warranty; and give all 193 | recipients a copy of this License along with the Program. 194 | 195 | You may charge any price or no price for each copy that you convey, 196 | and you may offer support or warranty protection for a fee. 197 | 198 | 5. Conveying Modified Source Versions. 199 | 200 | You may convey a work based on the Program, or the modifications to 201 | produce it from the Program, in the form of source code under the 202 | terms of section 4, provided that you also meet all of these conditions: 203 | 204 | a) The work must carry prominent notices stating that you modified 205 | it, and giving a relevant date. 206 | 207 | b) The work must carry prominent notices stating that it is 208 | released under this License and any conditions added under section 209 | 7. This requirement modifies the requirement in section 4 to 210 | "keep intact all notices". 211 | 212 | c) You must license the entire work, as a whole, under this 213 | License to anyone who comes into possession of a copy. This 214 | License will therefore apply, along with any applicable section 7 215 | additional terms, to the whole of the work, and all its parts, 216 | regardless of how they are packaged. This License gives no 217 | permission to license the work in any other way, but it does not 218 | invalidate such permission if you have separately received it. 219 | 220 | d) If the work has interactive user interfaces, each must display 221 | Appropriate Legal Notices; however, if the Program has interactive 222 | interfaces that do not display Appropriate Legal Notices, your 223 | work need not make them do so. 224 | 225 | A compilation of a covered work with other separate and independent 226 | works, which are not by their nature extensions of the covered work, 227 | and which are not combined with it such as to form a larger program, 228 | in or on a volume of a storage or distribution medium, is called an 229 | "aggregate" if the compilation and its resulting copyright are not 230 | used to limit the access or legal rights of the compilation's users 231 | beyond what the individual works permit. Inclusion of a covered work 232 | in an aggregate does not cause this License to apply to the other 233 | parts of the aggregate. 234 | 235 | 6. Conveying Non-Source Forms. 236 | 237 | You may convey a covered work in object code form under the terms 238 | of sections 4 and 5, provided that you also convey the 239 | machine-readable Corresponding Source under the terms of this License, 240 | in one of these ways: 241 | 242 | a) Convey the object code in, or embodied in, a physical product 243 | (including a physical distribution medium), accompanied by the 244 | Corresponding Source fixed on a durable physical medium 245 | customarily used for software interchange. 246 | 247 | b) Convey the object code in, or embodied in, a physical product 248 | (including a physical distribution medium), accompanied by a 249 | written offer, valid for at least three years and valid for as 250 | long as you offer spare parts or customer support for that product 251 | model, to give anyone who possesses the object code either (1) a 252 | copy of the Corresponding Source for all the software in the 253 | product that is covered by this License, on a durable physical 254 | medium customarily used for software interchange, for a price no 255 | more than your reasonable cost of physically performing this 256 | conveying of source, or (2) access to copy the 257 | Corresponding Source from a network server at no charge. 258 | 259 | c) Convey individual copies of the object code with a copy of the 260 | written offer to provide the Corresponding Source. This 261 | alternative is allowed only occasionally and noncommercially, and 262 | only if you received the object code with such an offer, in accord 263 | with subsection 6b. 264 | 265 | d) Convey the object code by offering access from a designated 266 | place (gratis or for a charge), and offer equivalent access to the 267 | Corresponding Source in the same way through the same place at no 268 | further charge. You need not require recipients to copy the 269 | Corresponding Source along with the object code. If the place to 270 | copy the object code is a network server, the Corresponding Source 271 | may be on a different server (operated by you or a third party) 272 | that supports equivalent copying facilities, provided you maintain 273 | clear directions next to the object code saying where to find the 274 | Corresponding Source. Regardless of what server hosts the 275 | Corresponding Source, you remain obligated to ensure that it is 276 | available for as long as needed to satisfy these requirements. 277 | 278 | e) Convey the object code using peer-to-peer transmission, provided 279 | you inform other peers where the object code and Corresponding 280 | Source of the work are being offered to the general public at no 281 | charge under subsection 6d. 282 | 283 | A separable portion of the object code, whose source code is excluded 284 | from the Corresponding Source as a System Library, need not be 285 | included in conveying the object code work. 286 | 287 | A "User Product" is either (1) a "consumer product", which means any 288 | tangible personal property which is normally used for personal, family, 289 | or household purposes, or (2) anything designed or sold for incorporation 290 | into a dwelling. In determining whether a product is a consumer product, 291 | doubtful cases shall be resolved in favor of coverage. For a particular 292 | product received by a particular user, "normally used" refers to a 293 | typical or common use of that class of product, regardless of the status 294 | of the particular user or of the way in which the particular user 295 | actually uses, or expects or is expected to use, the product. A product 296 | is a consumer product regardless of whether the product has substantial 297 | commercial, industrial or non-consumer uses, unless such uses represent 298 | the only significant mode of use of the product. 299 | 300 | "Installation Information" for a User Product means any methods, 301 | procedures, authorization keys, or other information required to install 302 | and execute modified versions of a covered work in that User Product from 303 | a modified version of its Corresponding Source. The information must 304 | suffice to ensure that the continued functioning of the modified object 305 | code is in no case prevented or interfered with solely because 306 | modification has been made. 307 | 308 | If you convey an object code work under this section in, or with, or 309 | specifically for use in, a User Product, and the conveying occurs as 310 | part of a transaction in which the right of possession and use of the 311 | User Product is transferred to the recipient in perpetuity or for a 312 | fixed term (regardless of how the transaction is characterized), the 313 | Corresponding Source conveyed under this section must be accompanied 314 | by the Installation Information. But this requirement does not apply 315 | if neither you nor any third party retains the ability to install 316 | modified object code on the User Product (for example, the work has 317 | been installed in ROM). 318 | 319 | The requirement to provide Installation Information does not include a 320 | requirement to continue to provide support service, warranty, or updates 321 | for a work that has been modified or installed by the recipient, or for 322 | the User Product in which it has been modified or installed. Access to a 323 | network may be denied when the modification itself materially and 324 | adversely affects the operation of the network or violates the rules and 325 | protocols for communication across the network. 326 | 327 | Corresponding Source conveyed, and Installation Information provided, 328 | in accord with this section must be in a format that is publicly 329 | documented (and with an implementation available to the public in 330 | source code form), and must require no special password or key for 331 | unpacking, reading or copying. 332 | 333 | 7. Additional Terms. 334 | 335 | "Additional permissions" are terms that supplement the terms of this 336 | License by making exceptions from one or more of its conditions. 337 | Additional permissions that are applicable to the entire Program shall 338 | be treated as though they were included in this License, to the extent 339 | that they are valid under applicable law. If additional permissions 340 | apply only to part of the Program, that part may be used separately 341 | under those permissions, but the entire Program remains governed by 342 | this License without regard to the additional permissions. 343 | 344 | When you convey a copy of a covered work, you may at your option 345 | remove any additional permissions from that copy, or from any part of 346 | it. (Additional permissions may be written to require their own 347 | removal in certain cases when you modify the work.) You may place 348 | additional permissions on material, added by you to a covered work, 349 | for which you have or can give appropriate copyright permission. 350 | 351 | Notwithstanding any other provision of this License, for material you 352 | add to a covered work, you may (if authorized by the copyright holders of 353 | that material) supplement the terms of this License with terms: 354 | 355 | a) Disclaiming warranty or limiting liability differently from the 356 | terms of sections 15 and 16 of this License; or 357 | 358 | b) Requiring preservation of specified reasonable legal notices or 359 | author attributions in that material or in the Appropriate Legal 360 | Notices displayed by works containing it; or 361 | 362 | c) Prohibiting misrepresentation of the origin of that material, or 363 | requiring that modified versions of such material be marked in 364 | reasonable ways as different from the original version; or 365 | 366 | d) Limiting the use for publicity purposes of names of licensors or 367 | authors of the material; or 368 | 369 | e) Declining to grant rights under trademark law for use of some 370 | trade names, trademarks, or service marks; or 371 | 372 | f) Requiring indemnification of licensors and authors of that 373 | material by anyone who conveys the material (or modified versions of 374 | it) with contractual assumptions of liability to the recipient, for 375 | any liability that these contractual assumptions directly impose on 376 | those licensors and authors. 377 | 378 | All other non-permissive additional terms are considered "further 379 | restrictions" within the meaning of section 10. If the Program as you 380 | received it, or any part of it, contains a notice stating that it is 381 | governed by this License along with a term that is a further 382 | restriction, you may remove that term. If a license document contains 383 | a further restriction but permits relicensing or conveying under this 384 | License, you may add to a covered work material governed by the terms 385 | of that license document, provided that the further restriction does 386 | not survive such relicensing or conveying. 387 | 388 | If you add terms to a covered work in accord with this section, you 389 | must place, in the relevant source files, a statement of the 390 | additional terms that apply to those files, or a notice indicating 391 | where to find the applicable terms. 392 | 393 | Additional terms, permissive or non-permissive, may be stated in the 394 | form of a separately written license, or stated as exceptions; 395 | the above requirements apply either way. 396 | 397 | 8. Termination. 398 | 399 | You may not propagate or modify a covered work except as expressly 400 | provided under this License. Any attempt otherwise to propagate or 401 | modify it is void, and will automatically terminate your rights under 402 | this License (including any patent licenses granted under the third 403 | paragraph of section 11). 404 | 405 | However, if you cease all violation of this License, then your 406 | license from a particular copyright holder is reinstated (a) 407 | provisionally, unless and until the copyright holder explicitly and 408 | finally terminates your license, and (b) permanently, if the copyright 409 | holder fails to notify you of the violation by some reasonable means 410 | prior to 60 days after the cessation. 411 | 412 | Moreover, your license from a particular copyright holder is 413 | reinstated permanently if the copyright holder notifies you of the 414 | violation by some reasonable means, this is the first time you have 415 | received notice of violation of this License (for any work) from that 416 | copyright holder, and you cure the violation prior to 30 days after 417 | your receipt of the notice. 418 | 419 | Termination of your rights under this section does not terminate the 420 | licenses of parties who have received copies or rights from you under 421 | this License. If your rights have been terminated and not permanently 422 | reinstated, you do not qualify to receive new licenses for the same 423 | material under section 10. 424 | 425 | 9. Acceptance Not Required for Having Copies. 426 | 427 | You are not required to accept this License in order to receive or 428 | run a copy of the Program. Ancillary propagation of a covered work 429 | occurring solely as a consequence of using peer-to-peer transmission 430 | to receive a copy likewise does not require acceptance. However, 431 | nothing other than this License grants you permission to propagate or 432 | modify any covered work. These actions infringe copyright if you do 433 | not accept this License. Therefore, by modifying or propagating a 434 | covered work, you indicate your acceptance of this License to do so. 435 | 436 | 10. Automatic Licensing of Downstream Recipients. 437 | 438 | Each time you convey a covered work, the recipient automatically 439 | receives a license from the original licensors, to run, modify and 440 | propagate that work, subject to this License. You are not responsible 441 | for enforcing compliance by third parties with this License. 442 | 443 | An "entity transaction" is a transaction transferring control of an 444 | organization, or substantially all assets of one, or subdividing an 445 | organization, or merging organizations. If propagation of a covered 446 | work results from an entity transaction, each party to that 447 | transaction who receives a copy of the work also receives whatever 448 | licenses to the work the party's predecessor in interest had or could 449 | give under the previous paragraph, plus a right to possession of the 450 | Corresponding Source of the work from the predecessor in interest, if 451 | the predecessor has it or can get it with reasonable efforts. 452 | 453 | You may not impose any further restrictions on the exercise of the 454 | rights granted or affirmed under this License. For example, you may 455 | not impose a license fee, royalty, or other charge for exercise of 456 | rights granted under this License, and you may not initiate litigation 457 | (including a cross-claim or counterclaim in a lawsuit) alleging that 458 | any patent claim is infringed by making, using, selling, offering for 459 | sale, or importing the Program or any portion of it. 460 | 461 | 11. Patents. 462 | 463 | A "contributor" is a copyright holder who authorizes use under this 464 | License of the Program or a work on which the Program is based. The 465 | work thus licensed is called the contributor's "contributor version". 466 | 467 | A contributor's "essential patent claims" are all patent claims 468 | owned or controlled by the contributor, whether already acquired or 469 | hereafter acquired, that would be infringed by some manner, permitted 470 | by this License, of making, using, or selling its contributor version, 471 | but do not include claims that would be infringed only as a 472 | consequence of further modification of the contributor version. For 473 | purposes of this definition, "control" includes the right to grant 474 | patent sublicenses in a manner consistent with the requirements of 475 | this License. 476 | 477 | Each contributor grants you a non-exclusive, worldwide, royalty-free 478 | patent license under the contributor's essential patent claims, to 479 | make, use, sell, offer for sale, import and otherwise run, modify and 480 | propagate the contents of its contributor version. 481 | 482 | In the following three paragraphs, a "patent license" is any express 483 | agreement or commitment, however denominated, not to enforce a patent 484 | (such as an express permission to practice a patent or covenant not to 485 | sue for patent infringement). To "grant" such a patent license to a 486 | party means to make such an agreement or commitment not to enforce a 487 | patent against the party. 488 | 489 | If you convey a covered work, knowingly relying on a patent license, 490 | and the Corresponding Source of the work is not available for anyone 491 | to copy, free of charge and under the terms of this License, through a 492 | publicly available network server or other readily accessible means, 493 | then you must either (1) cause the Corresponding Source to be so 494 | available, or (2) arrange to deprive yourself of the benefit of the 495 | patent license for this particular work, or (3) arrange, in a manner 496 | consistent with the requirements of this License, to extend the patent 497 | license to downstream recipients. "Knowingly relying" means you have 498 | actual knowledge that, but for the patent license, your conveying the 499 | covered work in a country, or your recipient's use of the covered work 500 | in a country, would infringe one or more identifiable patents in that 501 | country that you have reason to believe are valid. 502 | 503 | If, pursuant to or in connection with a single transaction or 504 | arrangement, you convey, or propagate by procuring conveyance of, a 505 | covered work, and grant a patent license to some of the parties 506 | receiving the covered work authorizing them to use, propagate, modify 507 | or convey a specific copy of the covered work, then the patent license 508 | you grant is automatically extended to all recipients of the covered 509 | work and works based on it. 510 | 511 | A patent license is "discriminatory" if it does not include within 512 | the scope of its coverage, prohibits the exercise of, or is 513 | conditioned on the non-exercise of one or more of the rights that are 514 | specifically granted under this License. You may not convey a covered 515 | work if you are a party to an arrangement with a third party that is 516 | in the business of distributing software, under which you make payment 517 | to the third party based on the extent of your activity of conveying 518 | the work, and under which the third party grants, to any of the 519 | parties who would receive the covered work from you, a discriminatory 520 | patent license (a) in connection with copies of the covered work 521 | conveyed by you (or copies made from those copies), or (b) primarily 522 | for and in connection with specific products or compilations that 523 | contain the covered work, unless you entered into that arrangement, 524 | or that patent license was granted, prior to 28 March 2007. 525 | 526 | Nothing in this License shall be construed as excluding or limiting 527 | any implied license or other defenses to infringement that may 528 | otherwise be available to you under applicable patent law. 529 | 530 | 12. No Surrender of Others' Freedom. 531 | 532 | If conditions are imposed on you (whether by court order, agreement or 533 | otherwise) that contradict the conditions of this License, they do not 534 | excuse you from the conditions of this License. If you cannot convey a 535 | covered work so as to satisfy simultaneously your obligations under this 536 | License and any other pertinent obligations, then as a consequence you may 537 | not convey it at all. For example, if you agree to terms that obligate you 538 | to collect a royalty for further conveying from those to whom you convey 539 | the Program, the only way you could satisfy both those terms and this 540 | License would be to refrain entirely from conveying the Program. 541 | 542 | 13. Remote Network Interaction; Use with the GNU General Public License. 543 | 544 | Notwithstanding any other provision of this License, if you modify the 545 | Program, your modified version must prominently offer all users 546 | interacting with it remotely through a computer network (if your version 547 | supports such interaction) an opportunity to receive the Corresponding 548 | Source of your version by providing access to the Corresponding Source 549 | from a network server at no charge, through some standard or customary 550 | means of facilitating copying of software. This Corresponding Source 551 | shall include the Corresponding Source for any work covered by version 3 552 | of the GNU General Public License that is incorporated pursuant to the 553 | following paragraph. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the work with which it is combined will remain governed by version 561 | 3 of the GNU General Public License. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU Affero General Public License from time to time. Such new versions 567 | will be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU Affero General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU Affero General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU Affero General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 2015-2016 Zack Scholl 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU Affero General Public License as published 639 | by the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU Affero General Public License for more details. 646 | 647 | You should have received a copy of the GNU Affero General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If your software can interact with users remotely through a computer 653 | network, you should also make sure that it provides a way for users to 654 | get its source. For example, if your program is a web application, its 655 | interface could display a "Source" link that leads users to an archive 656 | of the code. There are many ways you could offer source, and different 657 | solutions will be better for different programs; see section 13 for the 658 | specific requirements. 659 | 660 | You should also get your employer (if you work as a programmer) or school, 661 | if any, to sign a "copyright disclaimer" for the program, if necessary. 662 | For more information on this, and how to apply and follow the GNU AGPL, see 663 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Loco 2 | 3 | [![Build Status](https://travis-ci.org/kootenpv/loco.svg?branch=master)](https://travis-ci.org/kootenpv/loco) 4 | [![PyPI](https://img.shields.io/pypi/v/loco.svg?style=flat-square)](https://pypi.python.org/pypi/loco/) 5 | [![PyPI](https://img.shields.io/pypi/pyversions/loco.svg?style=flat-square)](https://pypi.python.org/pypi/loco/) 6 | 7 | Share localhost through SSH. Making local/remote port forwarding easy and safe. 8 | 9 | ### Story 10 | 11 | `sender` wants to share his web app hosted at port 52222. `receiver` wants to see what the app is all about. 12 | 13 | - `receiver` runs `loco pubkey` to copy their public SSH key to clipboard 14 | - `receiver` sends pubkey to `sender` by chat, mail or pigeon. 15 | - `sender` runs `loco create "RECEIVER_PUBKEY"`. This is [the interesting part](#the-interesting-part)! 16 | - `receiver` runs `loco listen SENDER`, where sender is ssh config such as user@ip 17 | 18 | Receiver can now see what sender is seeing at `localhost:52222` 19 | 20 | When you are behind a (company) firewall/router, then there are 3 possible solutions. 21 | 22 | - You can use a "shared" area (such as a cloud instance). 23 | - You can do remote forwarding instead of local forwarding. Basically, as long as 1 of the 2 parties is not within a firewall, it'll work. 24 | - You can open up port 22 (SSH). 25 | 26 | ### Features 27 | 28 | - **Convenience**. Share whatever is happening on your localhost with someone else 29 | - **Safety**. Nothing beats SSH. The only open port required is 22. Share your HTTP through SSH! 30 | - **Containment**. Specifically creates an SSH user that can ONLY do port forwarding; nothing else. 31 | - **Cross-platform**. Works on OSX and Linux in general. 32 | - **No 3rd party**. Unlike `ngrok`, you won't need to rely on a third party. 33 | 34 | ### Installation 35 | 36 | Works using both Python 2.7+ and Python 3+: 37 | 38 | pip install loco 39 | 40 | ### Functionality 41 | 42 | ```bash 43 | # cast your localhost to someone else 44 | loco cast RECEIVER 45 | 46 | # No need to keep a terminal open 47 | loco listen SENDER --background 48 | 49 | # Kills a `loco listen` in the background 50 | loco kill [optional: PORT, default=52222] 51 | 52 | # Remove all settings for a user (by default loco0). 53 | loco remove_user 54 | 55 | # View how you can be accessed 56 | loco ls # outputs 57 | user="loco0" port=52222 ssh_key=AAAAB3NzaC ..... joCyayMg+d account="pascal@T510" 58 | 59 | # Create specific user+port combination (don't forget to share this info with buddy) 60 | # And don't forget the quotes 61 | loco create "PUBKEY" loco5@someip --port 5000 62 | 63 | # NOTE: default is to serve at same as remote/local, need to give 1 64 | loco listen loco5@someip --remote_port 5000 65 | 66 | # push your content to someone who created a loco user for you 67 | loco cast loco5@someip --local_port 5000 68 | 69 | # --expose exposes `listen` or `cast` to 0.0.0.0 70 | # requires ssh to accept casting, i.e.: 71 | # 'GatewayPorts yes' in '/etc/ssh/sshd_config' 72 | loco cast loco5@someip --expose 73 | ``` 74 | 75 | For issues, such as both parties being within a firewall, you can use a server in between (e.g. some cloud instance). 76 | If just one party is within firewall, then you can use either cast/listen. 77 | 78 | In case of using an inbetween server: 79 | 80 | ```bash 81 | # on server: 82 | loco create "PUBKEY_RECEIVER" 83 | loco create "PUBKEY_SENDER" 84 | # on sender: 85 | loco cast loco0@server 86 | # on receiver 87 | loco listen loco0@server 88 | ``` 89 | 90 | ### The interesting part 91 | 92 | `loco create` creates a restricted user on the senders' machine. This user (by default called `loco0`) can do nothing except for allow port forwarding at a given port (by default `52222`). 93 | The receiver can use `loco listen SENDER_IP` to use SSH for portforwarding (again by default as `loco0`, port `52222`). The good thing is that you can now safely make a HTTP connection without allowing this user to do anything else. 94 | Note that everything can be configured; the used username, the senders' port to be shared, and on which port it will be receivable by the receiver. 95 | 96 | To find out more possibilities, you can use `--help` using the CLI: 97 | 98 | ```bash 99 | pascal@MBP:~ $ loco listen --help 100 | Usage: loco listen [OPTIONS] HOST 101 | 102 | Listen on a remote localhost port and serve it locally. 103 | 104 | Provide host. 105 | 106 | Example: loco listen USER@IP 107 | 108 | Options: 109 | -b, --background 110 | --local_port INTEGER 111 | --remote_port INTEGER 112 | --browse TEXT 113 | --help Show this message and exit. 114 | ``` 115 | 116 | You will have complete control over whether you want to allow sharing a single port with many users, or each user their own port. 117 | 118 | ### loco users are special 119 | 120 | Any username starting with "loco" will be considered a loco user. 121 | Apart from being restricted, the CLI tool also takes extra care for loco users. For example, it will warn you when you would try to remove non loco users. It will throw an exception when you try to delete yourself. 122 | `loco ls` also only lists the `loco` users. 123 | 124 | ### Contributing 125 | 126 | Feel free to make suggestions. 127 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Share localhost through SSH. Also known as local ssh port forward. No strings attached. 2 | -------------------------------------------------------------------------------- /conftest.py: -------------------------------------------------------------------------------- 1 | """ 2 | By defining conftest.py in your root path, you will have pytest recognizing 3 | your application modules without specifying PYTHONPATH. 4 | Source: http://stackoverflow.com/a/34520971/1575066 5 | """ 6 | -------------------------------------------------------------------------------- /deploy.py: -------------------------------------------------------------------------------- 1 | """ File unrelated to the package, except for convenience in deploying """ 2 | import re 3 | import sh 4 | import os 5 | 6 | commit_count = sh.git("rev-list", ["--all"]).count("\n") 7 | 8 | with open("setup.py") as f: 9 | setup = f.read() 10 | 11 | setup = re.sub("MICRO_VERSION = .[0-9]+.", "MICRO_VERSION = '{}'".format(commit_count), setup) 12 | 13 | major = re.search("MAJOR_VERSION = '([0-9]+)'", setup).groups()[0] 14 | minor = re.search("MINOR_VERSION = '([0-9]+)'", setup).groups()[0] 15 | micro = re.search("MICRO_VERSION = '([0-9]+)'", setup).groups()[0] 16 | version = "{}.{}.{}".format(major, minor, micro) 17 | 18 | with open("setup.py", "w") as f: 19 | f.write(setup) 20 | 21 | with open("loco/__init__.py") as f: 22 | init = f.read() 23 | 24 | with open("loco/__init__.py", "w") as f: 25 | f.write(re.sub('__version__ = "[0-9.]+"', '__version__ = "{}"'.format(version), init)) 26 | 27 | py_version = "python3.7" if sh.which("python3.7") is not None else "python" 28 | os.system("rm -rf dist/") 29 | os.system("{} setup.py sdist bdist_wheel".format(py_version)) 30 | os.system("twine upload dist/*") 31 | -------------------------------------------------------------------------------- /loco/__init__.py: -------------------------------------------------------------------------------- 1 | """ You can kind of see this as the scope of `loco` when you 'import loco' 2 | The following functions become available: 3 | loco.__project__ 4 | loco.__version__ 5 | loco.main 6 | loco.print_version 7 | """ 8 | import sys 9 | 10 | __project__ = "loco" 11 | __version__ = "0.1.28" 12 | 13 | 14 | def print_version(): 15 | """ Convenient function for printing the version of the package """ 16 | sv = sys.version_info 17 | py_version = "{}.{}.{}".format(sv.major, sv.minor, sv.micro) 18 | version_parts = __version__.split(".") 19 | s = "{} version: [{}], Python {}".format(__project__, __version__, py_version) 20 | s += "\nMajor version: {} (breaking changes)".format(version_parts[0]) 21 | s += "\nMinor version: {} (extra feature)".format(version_parts[1]) 22 | s += "\nMicro version: {} (commit count)".format(version_parts[2]) 23 | return s 24 | -------------------------------------------------------------------------------- /loco/loco.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import re 3 | import os 4 | import itertools 5 | import webbrowser 6 | import click 7 | 8 | from .utils import write_to_clipboard 9 | from .utils import platform_fn 10 | from .utils import is_on_apple 11 | 12 | 13 | USER = "loco0" 14 | 15 | 16 | @click.group() 17 | def main(): 18 | return "OK" 19 | 20 | 21 | @main.command() 22 | @click.argument("pubfile", default=None, required=False) 23 | @click.option("--cat", default=False, is_flag=True) 24 | def pubkey(pubfile, cat): 25 | """Copies your pubkey to clipboard""" 26 | if pubfile is None: 27 | pubfile = "id_rsa.pub" 28 | 29 | with open(os.path.expanduser("~/.ssh/" + pubfile)) as f: 30 | public_key = f.read().strip() 31 | if not cat: 32 | print("Copied pubkey to clipboard") 33 | write_to_clipboard(public_key) 34 | else: 35 | print(public_key) 36 | 37 | 38 | def get_user_dir(user): 39 | home = "/Users" if is_on_apple() else "/home" 40 | return os.path.join(home, user) 41 | 42 | 43 | def get_random_uid(): 44 | import random 45 | 46 | return random.randint(1000, 3000) 47 | 48 | 49 | def get_restriction_line( 50 | port=52222, 51 | public_key=None, 52 | denied_msg="'Loco account only allows port forwarding.'", 53 | denies="no-X11-forwarding,no-agent-forwarding,no-pty", 54 | ): 55 | if not public_key: 56 | raise ValueError("public_key should be set? or password method (TODO)") 57 | permit_open = 'permitopen="localhost:{0}",permitopen="127.0.0.1:{0}"'.format(port) 58 | restriction = 'command="echo {0}",{1},{2} {3}'.format(denied_msg, denies, permit_open, public_key) 59 | return restriction 60 | 61 | 62 | def read_restrictions(authorized_keys_file): 63 | restrictions = "" 64 | if os.path.isfile(authorized_keys_file): 65 | with open(authorized_keys_file) as f: 66 | restrictions = f.read() 67 | return restrictions 68 | 69 | 70 | def ensure_rbash_osx(): 71 | rbash = '#!/bin/bash\nexec /bin/bash -r "$@"' 72 | rbash_file = "/usr/local/rbash" 73 | if not os.path.isfile(rbash_file): 74 | with open(rbash_file, "w") as f: 75 | f.write(rbash) 76 | os.system("sudo chmod +x {}".format(rbash_file)) 77 | 78 | 79 | def create_user_osx(user=USER): 80 | user_dir = get_user_dir(user) 81 | uid = get_random_uid() 82 | ensure_rbash_osx() 83 | os.system("sudo dscl . -create /groups/loco && sudo dscl . -append /groups/loco gid 622") 84 | cmds = [ 85 | 'sudo dscl . -create /Users/{0} UniqueID "{1}"', 86 | "sudo dscl . -create /Users/{0}", 87 | 'sudo dscl . -create /Users/{0} RealName "Lo Co"', 88 | # eventually remove this one below 89 | "sudo dscl . -create /Users/{0} UserShell /usr/local/rbash", 90 | "sudo dscl . -create /Users/{0} PrimaryGroupID 20", 91 | # home dir does not work yet 92 | "sudo dscl . -create /Users/{0} NFSHomeDirectory /Users/{0}", 93 | ] 94 | cmd = " && ".join(cmds).format(user, uid) 95 | os.system(cmd) 96 | os.system("sudo mkdir {}".format(user_dir)) 97 | return user 98 | 99 | 100 | def create_user_linux(user=USER): 101 | return os.system("sudo useradd -m {}".format(user)) 102 | 103 | 104 | def remove_user_osx(user): 105 | user_dir = get_user_dir(user) 106 | os.system('sudo /usr/bin/dscl . -delete "{0}" && sudo rm -rf {0}'.format(user_dir)) 107 | 108 | 109 | def remove_user_linux(user): 110 | user_dir = get_user_dir(user) 111 | os.system("sudo userdel -r -f {}".format(user)) 112 | os.system("sudo rm -rf {}".format(user_dir)) 113 | 114 | 115 | def create_user(user): 116 | os_dependent_functions = {"Darwin": create_user_osx, "Linux": create_user_linux} 117 | create_user_fn = platform_fn(**os_dependent_functions) 118 | create_user_fn(user) 119 | 120 | 121 | @main.command() 122 | @click.argument("user", default=USER) 123 | def remove_user(user): 124 | """Used to remove a loco user""" 125 | if user in os.path.expanduser("~"): 126 | raise Exception("Cannot delete self") 127 | if not user.startswith("loco"): 128 | inp = input("Are you sure you want to delete user '{}' [y/N]: ".format(user)) 129 | if inp.lower() != "y": 130 | print("Aborting.") 131 | return 132 | os_dependent_functions = {"Darwin": remove_user_osx, "Linux": remove_user_linux} 133 | remove_user_fn = platform_fn(**os_dependent_functions) 134 | donotrun(remove_user_fn, user) 135 | 136 | 137 | def public_port_exists(rline, authorized_keys_file, restrictions, public_key, port): 138 | port = str(port) 139 | new_restrictions = [] 140 | replaced = False 141 | for restriction in restrictions.split("\n"): 142 | if public_key in restriction: 143 | if ":" + port + '"' not in restriction: 144 | new_opens = 'no-pty,permitopen="localhost:{0}",permitopen="127.0.0.1:{0}",' 145 | restriction = restriction.replace("no-pty,", new_opens.format(port)) 146 | replaced = True 147 | else: 148 | print("public_key and port already exists in", authorized_keys_file) 149 | return 150 | new_restrictions.append(restriction) 151 | print("Adding key+port rule to file") 152 | if replaced: 153 | result = "\n".join(new_restrictions) 154 | else: 155 | result = rline 156 | with open(authorized_keys_file, "w") as f: 157 | f.write(result + "\n") 158 | 159 | 160 | @main.command() 161 | @click.argument("public_key") 162 | @click.option("--user", default=USER) 163 | @click.option("--port", default=52222) 164 | def create(public_key, user, port): 165 | """Creates exception at a port for a user for local tunnelling. Creates user if not existing.""" 166 | # has to be done in two, hideous but don't try to be the wise guy 167 | # dirname is not actually dirname, it means path up 168 | user_dir = get_user_dir(user) 169 | if not os.path.isdir(user_dir): 170 | print("Creating user", user) 171 | create_user(user) 172 | ssh_path = os.path.join(user_dir, ".ssh") 173 | # allow for easier editing 174 | try: 175 | os.system("sudo chown -R $USER {}".format(user_dir)) 176 | if not os.path.isdir(ssh_path): 177 | print("Create the .ssh path for user") 178 | os.system("mkdir {}".format(ssh_path)) 179 | rline = get_restriction_line(port, public_key) 180 | authorized_keys_file = os.path.join(ssh_path, "authorized_keys") 181 | restrictions = read_restrictions(authorized_keys_file) 182 | public_port_exists(rline, authorized_keys_file, restrictions, public_key, port) 183 | finally: 184 | # disable editing 185 | os.system("sudo chown -R {0} {1}".format(user, user_dir)) 186 | 187 | 188 | @main.command() 189 | @click.argument("port", default=52222) 190 | def kill(port=52222): 191 | """Kill the local server at a given port""" 192 | cmd = "kill $(ps aux | grep " + str(port) + " | grep -v grep | awk '{print $2}')" 193 | os.system(cmd) 194 | 195 | 196 | @main.command() 197 | @click.argument("host", default=None, required=True) 198 | @click.option("--background", "-b", default=False, is_flag=True) 199 | @click.option("--expose", "-e", default=False, is_flag=True) 200 | @click.option("--local_port", "-l", multiple=True) 201 | @click.option("--remote_port", "-r", multiple=True) 202 | @click.option("--browse", default=False, is_flag=True) 203 | @click.option("--ignore_host", default=False, is_flag=True) 204 | def listen(host, background, expose, local_port, remote_port, browse, ignore_host): 205 | """Listen on a remote localhost port and serve it locally. 206 | 207 | Provide host. 208 | 209 | \bExample: 210 | loco listen USER@IP 211 | """ 212 | listening = True 213 | norm_args = communicate(host, background, expose, local_port, remote_port, listening, browse, ignore_host) 214 | 215 | 216 | @main.command() 217 | @click.argument("host", default=None, required=True) 218 | @click.option("--background", "-b", default=False, is_flag=True) 219 | @click.option("--expose", "-e", default=False, is_flag=True) 220 | @click.option("--local_port", "-l", multiple=True) 221 | @click.option("--remote_port", "-r", multiple=True) 222 | @click.option("--ignore_host", default=False, is_flag=True) 223 | def cast(host, background, expose, local_port, remote_port, ignore_host): 224 | """Cast to a remote localhost port from a local port. 225 | 226 | Provide host. 227 | 228 | \b 229 | Examples: 230 | loco cast USER@IP 231 | """ 232 | communicate( 233 | host, background, expose, local_port, remote_port, listening=False, browse=False, ignore_host=ignore_host 234 | ) 235 | 236 | 237 | def communicate(host, background, expose, local_port, remote_port, listening, browse=False, ignore_host=False): 238 | host = host.split(":")[0] 239 | 240 | interface = "0.0.0.0" if expose else "localhost" 241 | ignore_host = " -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null " if ignore_host else "" 242 | if listening: 243 | action = "LOCALLY available at" 244 | RorL = "-L" 245 | inner_part = " {RorL} {interface}:{local_port}:localhost:{remote_port}" 246 | cmd = "ssh {ignore_host} {host} {bg} -N {inner_part}" 247 | else: 248 | action = "CASTING from" 249 | RorL = "-R" 250 | inner_part = " {RorL} {interface}:{remote_port}:localhost:{local_port}" 251 | cmd = "ssh {ignore_host} {host} {bg} -N {inner_part}" 252 | 253 | background = "-f" if background else "" 254 | inner_kwargs = {"RorL": RorL, "interface": interface} 255 | outer_kwargs = {"ignore_host": ignore_host, "host": host, "bg": background, "inner_part": ""} 256 | 257 | for local_p, remote_p in itertools.zip_longest(local_port, remote_port): 258 | 259 | local_p = local_p if local_p else remote_p 260 | remote_p = remote_p if remote_p else local_p 261 | 262 | local_p = local_p if local_p else 52222 263 | remote_p = remote_p if remote_p else 52222 264 | 265 | inner_kwargs["local_port"] = local_p 266 | inner_kwargs["remote_port"] = remote_p 267 | 268 | msg = "Connecting with {}:{}, {} localhost:{} in_background={}" 269 | connect_str = msg.format(host, remote_p, action, local_p, bool(background)) 270 | print(connect_str) 271 | 272 | if browse: 273 | webbrowser.open("localhost:{}".format(local_p), new=True) 274 | 275 | outer_kwargs["inner_part"] += inner_part.format(**inner_kwargs) 276 | cmd = cmd.format(**outer_kwargs) 277 | os.system(cmd) 278 | return outer_kwargs 279 | 280 | 281 | def list_user(user, user_dir): 282 | auth_keys_file = os.path.join(user_dir, ".ssh/authorized_keys") 283 | with open(auth_keys_file) as f: 284 | for line in f: 285 | line = line.strip() 286 | for port in re.findall(r"127.0.0.1:(\d+)", line): 287 | if "ssh-rsa" not in line: 288 | print(line) 289 | m = "Please post an issue with above line on https://github.com/kootenpv/loco" 290 | raise Exception(m) 291 | key, account = line.split("ssh-rsa")[1].split() 292 | repr_key = key[:10] + " ..... " + key[-10:] 293 | tmpl = 'user="{}" port={} ssh_key={} account="{}"' 294 | print(tmpl.format(user, port, repr_key, account)) 295 | 296 | 297 | @main.command() 298 | def ls(): 299 | """List all allowed connections""" 300 | # e.g. /Users and /home 301 | home_not_user_folder = get_user_dir("") 302 | on_apple = is_on_apple() 303 | if not on_apple: 304 | print("To read loco folder you need root on linux.") 305 | any_connection = False 306 | for user in os.listdir(home_not_user_folder): 307 | if not user.startswith("loco"): 308 | continue 309 | any_connection = True 310 | user_dir = os.path.join(home_not_user_folder, user) 311 | if not on_apple: 312 | try: 313 | os.system("sudo chown -R $USER {}".format(user_dir)) 314 | list_user(user, user_dir) 315 | finally: 316 | os.system("sudo chown -R {0} {1}".format(user, user_dir)) 317 | else: 318 | list_user(user, user_dir) 319 | if not any_connection: 320 | print("No connection rules found.") 321 | 322 | 323 | def get_hash_port(word): 324 | h = str(int(hashlib.sha1(word.encode("utf8")).hexdigest(), 16)) 325 | port = None 326 | for i in range(len(h) - 5): 327 | tmp = int(h[i : i + 5]) 328 | if 3000 < tmp < 65536: 329 | port = tmp 330 | break 331 | return port 332 | -------------------------------------------------------------------------------- /loco/utils.py: -------------------------------------------------------------------------------- 1 | import platform 2 | import subprocess 3 | 4 | 5 | def write_to_clipboard(output): 6 | system = platform.system() 7 | output = output.encode('utf-8') 8 | if system == "Darwin": 9 | cmd = ['pbcopy'] 10 | else: 11 | cmd = ["xclip", "-selection", "clipboard"] 12 | subprocess.Popen(cmd, stdin=subprocess.PIPE).communicate(output) 13 | cmd = ["xclip", "-selection", "primary"] 14 | subprocess.Popen(cmd, stdin=subprocess.PIPE).communicate(output) 15 | 16 | 17 | def platform_fn(**kwargs): 18 | """ Helper function for os dependent implementations """ 19 | operating_system = platform.system() 20 | return kwargs[operating_system] 21 | 22 | 23 | def is_on_apple(): 24 | return platform.system() == "Darwin" 25 | -------------------------------------------------------------------------------- /post: -------------------------------------------------------------------------------- 1 | Traditional 2 | 3 | PC + Firewall (White/Blacklisting) 4 | 5 | Protocols 6 | 7 | - HTTP 8 | - HTTPS 9 | - SSH 10 | 11 | Gain access to computer: 12 | 13 | - ssh access / login 14 | - login on your pc "physically" 15 | - install software under root -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [bdist_rpm] 2 | doc_files = README.rst 3 | 4 | [wheel] 5 | universal = 1 -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import find_packages 2 | from setuptools import setup 3 | 4 | MAJOR_VERSION = '0' 5 | MINOR_VERSION = '1' 6 | MICRO_VERSION = '28' 7 | VERSION = "{}.{}.{}".format(MAJOR_VERSION, MINOR_VERSION, MICRO_VERSION) 8 | 9 | setup(name='loco', 10 | version=VERSION, 11 | description="Share localhost through SSH.", 12 | author='Pascal van Kooten', 13 | url='https://github.com/kootenpv/loco', 14 | author_email='kootenpv@gmail.com', 15 | install_requires=[ 16 | 'click' 17 | ], 18 | entry_points={ 19 | 'console_scripts': ['loco = loco.loco:main'] 20 | }, 21 | classifiers=[ 22 | 'Intended Audience :: Developers', 23 | 'Intended Audience :: Customer Service', 24 | 'Intended Audience :: System Administrators', 25 | 'Operating System :: Microsoft', 26 | 'Operating System :: MacOS :: MacOS X', 27 | 'Operating System :: Unix', 28 | 'Operating System :: POSIX', 29 | 'Programming Language :: Python', 30 | 'Programming Language :: Python :: 2.7', 31 | 'Programming Language :: Python :: 3', 32 | 'Programming Language :: Python :: 3.4', 33 | 'Programming Language :: Python :: 3.5', 34 | 'Topic :: Software Development', 35 | 'Topic :: Software Development :: Libraries', 36 | 'Topic :: Software Development :: Libraries :: Python Modules', 37 | 'Topic :: System :: Software Distribution', 38 | 'Topic :: System :: Systems Administration', 39 | 'Topic :: Utilities' 40 | ], 41 | license='MIT', 42 | packages=find_packages(), 43 | zip_safe=False, 44 | platforms='any') 45 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kootenpv/loco/d02fe1ac3b73a644b39278e78919a20336028da7/tests/__init__.py -------------------------------------------------------------------------------- /tests/all_test.py: -------------------------------------------------------------------------------- 1 | """ Our tests are defined in here """ 2 | from loco.loco import ls 3 | from loco.loco import remove_user 4 | from click.testing import CliRunner 5 | 6 | cli = CliRunner() 7 | 8 | 9 | def test_ls(): 10 | cli.invoke(ls) 11 | 12 | 13 | def test_remove_user(): 14 | cli.invoke(remove_user, ["loco0"]) 15 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py35,py27,py34 3 | 4 | [testenv] 5 | # If you add a new dep here you probably need to add it in setup.py as well 6 | deps = 7 | pytest 8 | tox 9 | changedir = tests 10 | commands = py.test all_test.py 11 | --------------------------------------------------------------------------------