Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A high performance PageKite implementation in C

This branch is 184 commits behind pagekite:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
libev
net.pagekite.lib
AGPLv3.txt
Android.mk
Application.mk
COPYING.md
LICENSE-2.0.txt
Makefile
README.md
TODO.md
common.h
httpkite.c
pagekite-jni.c
pagekite.c
pagekite_net.h
pd_sha1.c
pd_sha1.h
pkblocker.c
pkblocker.h
pkconn.c
pkconn.h
pkerror.c
pkerror.h
pklogging.c
pklogging.h
pkmanager.c
pkmanager.h
pkmanager_test.c
pkproto.c
pkproto.h
pkproto_test.c
pkstate.c
pkstate.h
sha1_test.c
tests.c
utils.c
utils.h
utils_test.c
version.h
version.h.in

README.md

libpagekite

This will eventually be a tight, fast implementation of the PageKite protocol in C, suitable for high-performance or embedded applications.

This code is a work in progress.

What is PageKite?

PageKite is a protocol for dynamic, tunneled reverse proxying of arbitrary TCP byte streams. It is particularly well suited for making a HTTP server on a device without a public IP address visible to the wider Internet, but can also be used for a variety of other things, including SSH access.

For more information about PageKite, see http://pagekite.org/

What is in the box?

Things that work:

httpkite.c      Sample implementation of a very basic HTTP server
pagekite.c      Basic standalone pagekite back-end connector.

Works in progress:

pagekite-jni.c  JNI wrapper for use in Android development

Everything else is either support code or documentation.

Getting started

Playing with httpkite.c is probably the easiest way to get started hacking. You can build it like so:

$ make httpkite

Running the program will give some hints on how to use it. It does not do anything useful on its own, the idea is to provide a basic implementation which can extended and build upon.

A more complete implementation of a PageKite proxy is in pagekite.c.

This project has a Wiki page: https://pagekite.net/wiki/Floss/LibPageKite/

Getting started on Android

This source tree can be included in an Android project using the NDK. It has been tested and verified to work with revision 8 of the NDK, targetting Android 2.2 (Froyo, API level 8).

If PageKite is the only native package you are using, the quickest way to get it to build as part of your project is by adding the following symbolic links to your project tree:

cd /path/to/YourApp/
ln -s /path/to/libpagekite/ jni
mkdir -p src/net/pagekite
ln -s /path/to/libpagekite/net.pagekite.lib src/net/pagekite/lib

You will also need to grab a copy of OpenSSL for Android, we recommend the version maintained by the Guardian Project:

cd /path/to/libpagekite/
git clone https://github.com/guardianproject/openssl-android.git

(Although not recommended, SSL support can be skipped by commenting out the relevant lines in the Android.mk file and removing #define HAVE_OPENSSL from common.h.)

Finally, the JNI interface can then be built using the commands:

cd /path/to/YourApp/
export NDK_PROJECT_PATH=/path/to/android-ndk
make -f jni/Makefile android

Expect this to take a while, as building OpenSSL for multiple architectures is a pretty big task. Once everything has been compiled, you should be able to import net.pagekite.lib and use the methods of the PageKiteAPI class in your app - but please read our licensing terms carefully if your app is not Open Source.

If you are using multiple native packages, you may need to structure your code differently and massage the Android.mk files a bit.

License and Copyright

libpagekite is Copyright 2011, 2012, The Beanstalks Project ehf.

This code is released under the Apache License 2.0, but may also be used according to the terms of the GNU Affero General Public License. Please see the file COPYING.md for details on which license applies to you.

Commercial support for this code, as well as managed front-end relay service, are available from https://pagekite.net/.

Development of this code was partially sponsored by SURFnet and the Icelandic Technology Development fund.

Something went wrong with that request. Please try again.