reformat, fix typos and urls, etc

svn:r22010
This commit is contained in:
Roger Dingledine 2010-03-18 04:52:53 +00:00
parent e94eac1d5d
commit 178d06b8d3
6 changed files with 70 additions and 58 deletions

31
AUTHORS
View File

@ -1,28 +1,27 @@
This file lists the authors for Orbot, This file lists the authors for Orbot, a free software project to provide
a free software project to provide anonymity on the Internet on Android smartphones. anonymity on the Internet on Android smartphones.
For more information about Orbot, see http://openideals.com/guardian For more information about Orbot, see http://guardianproject.info/
If you got this file as a part of a larger bundle, If you got this file as a part of a larger bundle, there are probably
there are probably other authors that you should be aware of. other authors that you should be aware of.
Main Authors: Main Authors:
------------- -------------
Nathan Freitas <nathan@freitas.net> developed the primary Nathan Freitas <nathan@freitas.net> developed the primary Android
Android application and managed the porting of Tor to Android. application and managed the porting of Tor to Android.
Jake Appelbaum <jake@appelbaum.net > regular gave Nathan a Jake Appelbaum <jacob@appelbaum.net> regular gave Nathan a swift kick
swift kick in the rear to get this done. He has also provided in the rear to get this done. He has also provided extensive guidance
extensive guidance and review. Most recently he has been and review. Most recently he has been promoted to Chief Application
promoted to Chief Application Resource Editor. Resource Editor.
Contributors: Contributors:
------------- -------------
Nick Mathewson <nickm@freehaven.net> wrote some of the patch Nick Mathewson <nickm@freehaven.net> wrote some of the patch code to
code to support the compiling of Tor and Libevent on Android, support the compiling of Tor and Libevent on Android, and generally
and generally provided guidance in the entire effort. provided guidance in the entire effort.
Adam Langley <> made the original valiant effort to port Adam Langley <> made the original valiant effort to port Tor to Android.
Tor to Android.

12
BUILD
View File

@ -7,8 +7,8 @@ Please install the following prerequisites (instructions for each follows):
droid-wrapper: http://github.com/tmurakam/droid-wrapper droid-wrapper: http://github.com/tmurakam/droid-wrapper
libevent source (1.4.12-stable from svn) libevent source (1.4.12-stable from svn)
Tor source (most recent git master branch) Tor source (most recent git master branch)
Privoxy source (http://sourceforge.net/projects/ijbswa/) Privoxy source (http://sourceforge.net/projects/ijbswa/)
Install and prepare the Android OS SDK ( http://source.android.com/download ) Install and prepare the Android OS SDK ( http://source.android.com/download )
on Debian Lenny: on Debian Lenny:
@ -59,10 +59,10 @@ Fetch and build Privoxy:
autoheader autoheader
autoconf autoconf
#need to disable setpgrp check in configure #need to disable setpgrp check in configure
export ac_cv_func_setpgrp_void=yes export ac_cv_func_setpgrp_void=yes
CC=droid-gcc LD=droid-ld CPPFLAGS="-I/home/foo/mydroid/external/zlib"./configure --host=arm-none-linux-gnueabi CC=droid-gcc LD=droid-ld CPPFLAGS="-I/home/foo/mydroid/external/zlib"./configure --host=arm-none-linux-gnueabi
#don't mind the "unrecognized option '-pthread'" error message that you'll see when you run make #don't mind the "unrecognized option '-pthread'" error message that you'll see when you run make
make make
Fetch and build libevent: Fetch and build libevent:
@ -104,7 +104,8 @@ We need to build our Java SOCKS library:
ant jar ant jar
cp bin/jar/asocks.jar ../Orbot/libs cp bin/jar/asocks.jar ../Orbot/libs
We need to get the TorControl library for Java (https://svn.torproject.org/svn/torctl/trunk/doc/howto.txt): We need to get the TorControl library for Java:
(see also https://svn.torproject.org/svn/torctl/trunk/doc/howto.txt)
git clone git://git.torproject.org/git/jtorctl git clone git://git.torproject.org/git/jtorctl
cd jtorctl cd jtorctl
@ -154,3 +155,4 @@ You can also GPG sign the apk and generate an .asc:
Now you should have a fully signed and production ready alpha release of Orbot! Now you should have a fully signed and production ready alpha release of Orbot!
Give bin/Orbot-signed-alpha.apk an install and send us bug reports! Give bin/Orbot-signed-alpha.apk an install and send us bug reports!

View File

@ -5,7 +5,8 @@
- Added relay support for static/publicly accessible IP devices - Added relay support for static/publicly accessible IP devices
0.0.3a - 2010-02-07 0.0.3a - 2010-02-07
- Integrated iptables support for transparent proxying of outbound port 80 and DNS - Integrated iptables support for transparent proxying of outbound port
80 and DNS
- Privoxy is now used as HTTP Proxy server (cross-compiled to ARM) - Privoxy is now used as HTTP Proxy server (cross-compiled to ARM)
- New UI layout and graphics - New UI layout and graphics
- Android settings screen for generated torrc file - Android settings screen for generated torrc file
@ -18,7 +19,8 @@
- Added Help page - Added Help page
0.0.2 - 2009-11-27 0.0.2 - 2009-11-27
- Major improvement to the user interface including relative layout for different screens - Major improvement to the user interface including relative layout for
different screens
- New graphics resources - New graphics resources
- Implemented Tor Control Port using official Java library - Implemented Tor Control Port using official Java library
- Added 'clear' button to the log screen - Added 'clear' button to the log screen
@ -27,5 +29,6 @@
0.0.1-alpha - 2009-10-21 0.0.1-alpha - 2009-10-21
- First code release - First code release
- Major Features: Tor binary application is fully operational, UI: Start/Stop Tor, View Message Log, View Settings (torrc) - Major Features: Tor binary application is fully operational, UI:
Start/Stop Tor, View Message Log, View Settings (torrc)

35
INSTALL
View File

@ -1,21 +1,25 @@
Orbot: Android Onion Routing Robot Orbot: Android Onion Routing Robot
*********************************************** ***********************************************
This is a freely licensed open-source application developed for the Android is a freely licensed open-source application developed for the
Android platform, that acts as a front-end to the Tor binary application. Android platform. It acts as a front-end to the Tor binary application,
Orbot also provides an HTTP Proxy for connecting web browsers and other and also provides an HTTP Proxy for connecting web browsers and other
HTTP client applications into the Tor SOCKS interface. HTTP client applications into the Tor SOCKS interface.
*** PreReqs *** *** PreReqs ***
You need the Android Developer SDK to compile and build the APK file: http://developer.android.com/ You need the Android Developer SDK to compile and build the APK file:
The project files including in this distribution are meant to be used with Eclipse: http://eclipse.org/ http://developer.android.com/
The project files including in this distribution are meant to be used
with Eclipse: http://eclipse.org/
*** How to use *** *** How to use ***
Currently, Orbot will work with any application that supports using an HTTP or SOCKS Proxy. Currently, Orbot will work with any application that supports using
Once you start Tor using Orbot, you can then point your application to HTTP port 8118 or SOCKS port 9050 an HTTP or SOCKS Proxy. Once you start Tor using Orbot, you can then
on localhost IP 127.0.0.1. point your application to HTTP port 8118 or SOCKS port 9050 on localhost
IP 127.0.0.1.
You can also set the Android system-wide HTTP proxy using the Mobile Network APN: You can also set the Android system-wide HTTP proxy using the Mobile
Network APN:
Settings->Mobile networks->Access Point Names->(select your Carrier APN): Settings->Mobile networks->Access Point Names->(select your Carrier APN):
Proxy: 127.0.0.1 Proxy: 127.0.0.1
@ -23,12 +27,13 @@ Port:8118
** A Few Notes ** ** A Few Notes **
To ensure you are connected to the Tor network, you should browse to https://check.torproject.org To ensure you are connected to the Tor network, you should browse to
https://check.torproject.org/
The first time you activate Orbot, it may take a while to connect to Tor. Check the message log to
ensure you are "100% Bootstrapped".
The first time you activate Orbot, it may take a while to connect to
Tor. Check the message log to ensure you are "100% Bootstrapped".
*********************************************** ***********************************************
/* Copyright (c) 2009, Nathan Freitas, The Guardian Project - http://openideals.com/guardian */ /* Copyright (c) 2009-2010, Nathan Freitas, The Guardian Project
* http://guardianproject.info/ */

25
LICENSE
View File

@ -1,12 +1,14 @@
This file contains the license for Orbot, a free software project to provide anonymity on the Internet from a Google Android smartphone. This file contains the license for Orbot, a free software project to
provide anonymity on the Internet from a Google Android smartphone.
It also lists the licenses for other components used by Orbot. It also lists the licenses for other components used by Orbot.
For more information about Orbot, see http://openideals.com/guardian For more information about Orbot, see http://guardianproject.info/
If you got this file as a part of a larger bundle, there may be other license terms that you should be aware of. If you got this file as a part of a larger bundle, there may be other
license terms that you should be aware of.
=============================================================================== ===============================================================================
Orbot is distributed under this license (aka The Tor License) Orbot is distributed under this license (aka the 3-clause BSD license)
Copyright (c) 2009, Nathan Freitas, The Guardian Project Copyright (c) 2009, Nathan Freitas, The Guardian Project
@ -39,11 +41,14 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
***** *****
Orbot contains a binary distribution of the JSocks library: http://code.google.com/p/jsocks-mirror/ Orbot contains a binary distribution of the JSocks library:
which is licensed under the GNU Lesser General Public License: http://www.gnu.org/licenses/lgpl.html http://code.google.com/p/jsocks-mirror/
which is licensed under the GNU Lesser General Public License:
http://www.gnu.org/licenses/lgpl.html
***** *****
Orbot contains the source code for HttpProxy developed and freely licensed by: Julian Robichaux -- http://www.nsftools.com Orbot contains the source code for HttpProxy developed and freely licensed
by: Julian Robichaux -- http://www.nsftools.com
****** ******
Orbot contains a binary distribution of Tor: Orbot contains a binary distribution of Tor:
@ -95,7 +100,7 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=============================================================================== ===============================================================================
:src/common/strlcat.c and src/common/strlcpy.c by Todd C. Miller are licensed src/common/strlcat.c and src/common/strlcpy.c by Todd C. Miller are licensed
under the following license: under the following license:
* Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com> * Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
@ -136,7 +141,3 @@ http://ip-to-country.webhosting.info."
See the src/config/geoip file in particular. See the src/config/geoip file in particular.
=============================================================================== ===============================================================================

16
README
View File

@ -1,25 +1,27 @@
Orbot: Android Onion Routing Robot Orbot: Android Onion Routing Robot
*********************************************** ***********************************************
This is a freely licensed open-source application developed for the Orbot is a freely licensed open-source application developed for the
Android platform, that acts as a front-end to the Tor binary application. Android platform. It acts as a front-end to the Tor binary application,
Orbot also provides an HTTP Proxy for connecting web browsers and other and also provides an HTTP Proxy for connecting web browsers and other
HTTP client applications into the Tor SOCKS interface. HTTP client applications into the Tor SOCKS interface.
*********************************************** ***********************************************
Orbot is a component of the Guardian Project, an effort to develop Orbot is a component of the Guardian Project, an effort to develop
a secure, anonymous smartphone for use by human rights activists, journalists a secure, anonymous smartphone for use by human rights activists, journalists
and others around the world. Learn more: http://openideals.com/guardian and others around the world. Learn more: http://guardianproject.info/
*********************************************** ***********************************************
Tor protects your privacy on the internet by hiding the connection Tor protects your privacy on the internet by hiding the connection
between your Internet address and the services you use. We believe Tor between your Internet address and the services you use. We believe Tor
is reasonably secure, but please ensure you read the instructions and is reasonably secure, but please ensure you read the instructions and
configure it properly. Learn more at http://torproject.org configure it properly. Learn more at https://torproject.org/
Tor Frequently Asked Questions: Tor Frequently Asked Questions:
https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ
https://www.torproject.org/faq.html.en
*********************************************** ***********************************************
/* Copyright (c) 2009, Nathan Freitas, The Guardian Project - http://guardianproject.info */ /* Copyright (c) 2009-2010, Nathan Freitas, The Guardian Project
* http://guardianproject.info/ */