This is the client-side code for Android.
The idea behind this project is not new, and originates from DeskSMS and GTalkSMS. The former is paid yearly and has no option for custom commands whatsoever, only SMS forwarding, and the latter requires you to connect and maintain a constant connection to an XMPP server, which means always-on Wi-Fi with constant traffic and full wakelock, which is the best combination if your goal is to drain your battery as fast as possible. It also seems to go nuts when the network connectivity changes.
This application aims to be as customizable (soon) as GTalkSMS, but use Google's Cloud Messaging solution to push messages from/to the device, thus eliminating connection and battery drain issues.
The project is in its infancy, only supporting a handful of commands and an UI that consists of only two
TextViews. However, all the implemented commands work as intended.
The impact of the app on your battery is next to nothing, because your phone will be able to go to deep sleep, and this app will only be invoked when needed, and even then, it will only run for an average of 25 milliseconds until the
Intent is processed and the HTTP request is sent to AppEngine asynchronously, if needed.
With the phone and the XMPP client being in Europe, and the AppEngine servers being in the US, the commands have an average total latency of 0.35 seconds between them being issued in your XMPP client and the response being received in the same XMPP client.
However, if your phone is in deep sleep, it may take up to 2 minutes to answer a push request. This delay doesn't apply to stuff that the phone forwards towards your XMPP client, because your phone will exit deep sleep when receiving an SMS, for example, and after that the app will maintain a partial wakelock until the
Intent is processed and the HTTP request finishes.
Ping requests while the phone is in deep sleep:
[16:20] RoliSoft: /ping [16:20] firstname.lastname@example.org: Pushing ping notification to your device... [16:21] email@example.com: Pingback received from device after 69.899 seconds. [16:24] RoliSoft: /ping [16:24] firstname.lastname@example.org: Pushing ping notification to your device... [16:24] email@example.com: Pingback received from device after 6.427 seconds. [16:46] RoliSoft: /ping [16:46] firstname.lastname@example.org: Pushing ping notification to your device... [16:46] email@example.com: Pingback received from device after 19.068 seconds. [17:09] RoliSoft: /ping [17:09] firstname.lastname@example.org: Pushing ping notification to your device... [17:10] email@example.com: Pingback received from device after 93.239 seconds.
Ping requests while the phone is under partial wakelock or screen is on:
[16:16] RoliSoft: /ping [16:16] firstname.lastname@example.org: Pushing ping notification to your device... [16:16] email@example.com: Pingback received from device after 0.268 seconds. [16:25] RoliSoft: /ping [16:25] firstname.lastname@example.org: Pushing ping notification to your device... [16:25] email@example.com: Pingback received from device after 0.325 seconds. [17:01] RoliSoft: /ping [17:01] firstname.lastname@example.org: Pushing ping notification to your device... [17:01] email@example.com: Pingback received from device after 0.287 seconds. [17:59] RoliSoft: /ping [17:59] firstname.lastname@example.org: Pushing ping notification to your device... [17:59] email@example.com: Pingback received from device after 0.441 seconds.
This section contains a list of supported commands.
These commands are handled by the AppEngine application before they may result in a GCM push to the device. A list of these commands is also available in the server-side application's repository as well, this is only kept as reference. For the latest list and behaviour of the commands, please refer to that repository.
The server or device replies with the list of commands it supports including some minimal explanation of what they do. The device reply may take up to 2 minutes to complete if your device is in deep sleep. The default parameter is the server's response.
Pushes a ping notification through GCM to the device and when the device receives it, it invokes the
PingbackHandler on the AppEngine, returning the original timestamp.
Sends a text message to name. The name parameter can be of any length and contain any characters, except
:, which is the name/text separator. Spaces around the separator will be trimmed. The message can contain further
: characters without any issues.
To find out how the name parameter works, refer to
Opens a new chat window dedicated to name. Anything sent to that window will be forwarded as an SMS, with the exception of commands. (Anything that starts with
The way this works, is that instead of talking to
rstxtfwd.appspot.com the application will clean the name parameter and send you a message from
The name can be a phone number or either full or partial name. The action will be carried out on the first match. If a contact has multiple phone numbers, you can append
/N to the name where
N is the index of the phone number as seen in your address book, starting from 1. If you do not append an index, but have a number marked as default, then that will be used. If not, the first mobile number will be used.
To make sure your first match is the actual number you're looking for, you can play around with
Every command that is not handled on the server side is pushed through GCM to the device. The client currently supports these commands:
Rejects the incoming phone call.
Lists the contacts that match the name or phone number fully or partially. Accepts
The purpose of this command is to make sure you're addressing the right contact when you're sending a message.
This command only works in the dedicated chat window. Its purpose is to return the full name and phone number of the receiving end of the forwarded messages.
Returns some miscellaneous device information, such as IMEI, cell towers, etc. When
cpu is specified, returns the current clock speed and the min/max for the selected CPU governor.
Runs a command on the device and returns its content. This command was initially
/cmd, however the implementation changed to use libsuperuser.
[06:17] RoliSoft: /sh cat /proc/cpuinfo [06:17] rstxtfwd .com: Pushing command cmd to device... [06:17] rstxtfwd .com: Processor: ARMv7 Processor rev 2 (v7l) [...]
To run a command under root, you had to use
su -c with the old
/cmd command, however a new command has been introduced under
/sh su -c is now deprecated as it was bad practice and a nasty hack when it was introduced.
Runs a command on the device as root and returns its content. You will have to allow superuser rights on the device the first time you try to use
su within the app.
[19:31] RoliSoft: /sh whoami [19:31] firstname.lastname@example.org: Pushing command sh to device... [19:31] email@example.com: u0_a157 [19:31] RoliSoft: /su whoami [19:31] firstname.lastname@example.org: Pushing command su to device... [19:31] email@example.com: root
You should be careful when running commands as root. I am not responsible if you erase your bootloader by running
dd if=/dev/zero of=/dev/block/mmcblk0p5 completely out of curiousity.
This command allows you to list running and installed apps, and start them.
ps. This is essentially
/cmd ps, but that command was not yet implemented at that point.
The device will reply with the last known network and GPS locations. These locations may not be accurate at all, because if the device was turned off and moved, then it will return the old location. In these situations look for
/track for solutions.
This command allows you to track your phone's location.
LocationListener. Returns whether it's running, what provider is in use, and when was the last location update.
exploit argument will try using root to turn on GPS as a fallback method. See
TODO in the source.
You have to add at least one address from your AppEngine's address to your friends list, otherwise the server won't receive your full JID when you go online, and messages may not be delivered properly, depending on the server and client configurations. Google Talk, for example, will bounce all messages that are not sent to a specific login location.
MainActivityand replace the
AppIDconstant to point to your own server.
You will have a hard time if you'll try to use the app in the Android emulator, since it needs Google Play Services which in turn needs a Google account which is signed in and connected to Google Cloud Messaging. However, it is possible, by creating a new emulator by using "Google APIs" as the platform and then going through the process of setting up an Android with Google.
The server currently filters out GMail and Simonics Google Voice Gateway presences.
Check out the server-side Python code that was designed to run on an AppEngine instance. After successfully setting that server up and compiling this client-side code, push the
apk onto your device and install it.
Upon opening the software, it will register for GCM, so you'll need internet access. However, you may re-register at any time by clicking the "Register GCM" menu option, should any problems arise. After the registration was successful, you don't have to do anything else. Close the app and everything will be forwarded bidirectionally. You may suspend the bidirectional forwarding globally by going back into the app and selecting "Suspend" from the menu.
The app will automatically suspend itself when there is no internet connection, so don't worry about the app constantly trying to contact your server then timing out if you receive a message.
Upon pairing the device with the server, the device generates a 1024-bit RSA key and sends the public key to the server. A user-associated counter is also set to zero on the server side.
When sending a message, the device will sign the request with its private key and increase the counter. The server checks the signature with the public key and that the counter is higher than in the previous request. This eliminates impersonations and replay attacks.
Encryption is not currently implemented due to the fact that all the connections are SSL-encrypted between the device and server. However, if you roll your own server without SSL, or don't trust SSL, you can quickly implement an encryption that encrypts the sensitive form variables using the RSA key. (However, it is generally not a good idea to encrypt directly with the RSA key. You should instead generate a random 256-bit key for AES and use that for encryption, then communicate this key to the device by encrypting it with the public RSA key. This is also how SSL works.)
AppEngine server ->
Google's XMPP server ->
your provider's XMPP server ->
your client route and vice versa is not encrypted, and there might be nothing you can do about it. But then again, you shouldn't be sharing sensitive information through SMS to begin with...
Both the server-side and client-side applications are licensed under AGPLv3. Consult the
LICENSE file for more information.
tl;dr: The Affero GPL v3:
If you'd like to use the code without attribution and under a different license that isn't reciprocal and doesn't address the application service provider loophole, contact me via email for further information.