├── CONTRIBUTING.md ├── LICENSE └── README.md /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | ## Code Style 4 | 5 | * Prefer memory-safe code and languages (Swift, Rust) 6 | * [Apple Secure Coding Guide](https://developer.apple.com/library/mac/documentation/Security/Conceptual/SecureCodingGuide/Introduction.html) 7 | * [Swift Style Guide](https://github.com/github/swift-style-guide) 8 | * [Objective-C Style Guide](https://github.com/github/objective-c-style-guide) 9 | * [Rust Style Guide](http://aturon.github.io/README.html) 10 | 11 | ## Releases 12 | 13 | * All releases will be versioned according to [semver](http://semver.org) 14 | * All release tags must be [signed](https://git-scm.com/book/tr/v2/Git-Tools-Signing-Your-Work) 15 | * Signing each commit may be overkill 16 | 17 | ## Code Review 18 | 19 | * Every feature/bugfix/etc should be done in a feature branch. 20 | * To merge into master, submit a PR on GitHub to allow for code review. 21 | * Ideally before merging, it should be reviewed by at least 1 other person. 22 | 23 | ## Tests 24 | 25 | * All code should be written in a way that [facilitates testing](http://programmers.stackexchange.com/questions/153410/what-are-the-design-principles-that-promote-testable-code-designing-testable-c) 26 | * New code should be accompanied by unit tests and integration tests 27 | * TDD (test driven development) is very helpful for quick iteration 28 | 29 | ## Dependencies 30 | 31 | * 3rd party dependencies should be minimized if possible 32 | * Prefer Cocoapods or Carthage over submodules 33 | 34 | ## License 35 | 36 | * By contributing you affirm you have the rights to all the code you provide 37 | * All code should be permissively licensed 38 | * We should use the [Tor LICENSE](https://gitweb.torproject.org/tor.git/plain/LICENSE) 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | 118 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # iCepa-Docs 2 | Documentation scratchpad for iOS Tor VPN implementation. Below are the different components that we'll probably need. 3 | 4 | ## Style Guide 5 | 6 | * Check out [CONTRIBUTING.md](https://github.com/iCepa/iCepa-Docs/blob/master/CONTRIBUTING.md) 7 | * Signing git commits 8 | * Pull request code review process 9 | * Test coverage 10 | * LICENSE (permissive / same as [Tor](https://gitweb.torproject.org/tor.git/plain/LICENSE)) 11 | * Writing memory-safe code 12 | 13 | ## Tor.framework 14 | 15 | * Wrap Tor binary 16 | * Wrap control port 17 | * Standalone iOS 8 framework 18 | * Separate repo 19 | * [Tor Control Port](https://gitweb.torproject.org/torspec.git/tree/control-spec.txt) 20 | * [Tor Manual](https://www.torproject.org/docs/tor-manual.html.en) 21 | 22 | ## TorPacketTunnelProvider 23 | 24 | * Separate repo 25 | * Integrates Tor.framework 26 | * NEPacketTunnelProvider 27 | * Integrates tun2socks 28 | * Prevent information leaks via domain/IP whitelist 29 | 30 | ## tun2socks 31 | 32 | * Separate repo 33 | * Convert [Conrad's Notes](https://docs.google.com/document/d/1ob96eK-qjrxzIdNEmglClaH3kI-O5CfT9tp1xnXwksc/edit?usp=sharing) to README.md 34 | * [tun2socks-iOS](https://github.com/shadowsocks/tun2socks-iOS) - Currently Empty 35 | * [tun2socks-iOS](https://github.com/linusyang/tun2socks-iOS) - [@linusyang](https://github.com/linusyang) branch 36 | * [tun2socks](https://github.com/ambrop72/badvpn/tree/master/tun2socks) - Upstream tun2socks repo 37 | * [lwIP](http://savannah.nongnu.org/projects/lwip/) - Lightweight TCP/IP stack written in C 38 | * [tun2socks - Swift wrapper](https://github.com/zhuhaow/tun2socks) 39 | 40 | #### tun2socks-rust 41 | 42 | * Rewrite this as resuable Rust crate for memory safety and portability? 43 | * Write Obj-C or Swift wrapper for exported Rust C API 44 | 45 | ## Tor for iOS App UI 46 | 47 | * Get designer(s) 48 | * Keep It Simple 49 | * Prevent users from accidentally leaking information 50 | * Get feedback from designers on how to implement on-demand whitelist 51 | * Sketch out some storyboards (use iOS Storyboards?) 52 | * OS X support (???) 53 | 54 | # Helpful Links 55 | 56 | ## NETunnelProviderManager 57 | 58 | * [Class reference](https://developer.apple.com/library/prerelease/ios/documentation/NetworkExtension/Reference/NETunnelProviderManagerClassRef/index.html#//apple_ref/doc/uid/TP40016295) 59 | * [WWDC Session about Network Extensions](https://developer.apple.com/videos/wwdc/2015/?id=717) 60 | * [Sample code](https://developer.apple.com/library/prerelease/ios/samplecode/SimpleTunnel/Introduction/Intro.html) 61 | * [ShadowVPN-iOS](https://github.com/clowwindy/ShadowVPN-iOS) - Includes Swift PacketTunnelProvider Example 62 | * [shadowsocks-iOS](https://github.com/shadowsocks/shadowsocks-iOS/issues/124) - Issue 124: "Adopting iOS 9 network extension points" discussion thread 63 | * [NEKit](https://github.com/zhuhaow/NEKit) - A toolkit for NetworkExtension Framework 64 | 65 | ## Secure Coding 66 | 67 | * [Apple Secure Coding Guide](https://developer.apple.com/library/mac/documentation/Security/Conceptual/SecureCodingGuide/Introduction.html) 68 | * [Swift Style Guide](https://github.com/github/swift-style-guide) 69 | * [Objective-C Style Guide](https://github.com/github/objective-c-style-guide) 70 | * [Rust Style Guide](http://aturon.github.io/README.html) 71 | 72 | ## Tor 73 | 74 | * [Tor Control Port](https://gitweb.torproject.org/torspec.git/tree/control-spec.txt) 75 | * [Tor Manual](https://www.torproject.org/docs/tor-manual.html.en) 76 | 77 | ## Rust 78 | 79 | #### Learning Rust 80 | 81 | * [Rust in Detail: Writing Scalable Chat Service from Scratch](https://nbaksalyar.github.io/2015/07/10/writing-chat-in-rust.html) 82 | * [Rust Once, Run Everywhere](http://blog.rust-lang.org/2015/04/24/Rust-Once-Run-Everywhere.html) (Rust/C FFI) 83 | * [Rust Style Guide](http://aturon.github.io/README.html) 84 | 85 | #### Rust IDE 86 | 87 | * [Atom](https://atom.io) and [Sublime](https://www.sublimetext.com) both have Rust language plugins 88 | * [racer](https://github.com/phildawes/racer) - Rust autocomplete 89 | --------------------------------------------------------------------------------