Siri Proxy is a proxy server for Apple's Siri "assistant." The idea is to allow for the creation of custom handlers for different actions. This can allow developers to easily add functionality to Siri.
The main example I provide is a plugin to control my thermostat with Siri. It responds to commands such as, "What's the status of the thermostat?", or "Set the thermostat to 68 degrees", or even "What's the inside temperature?"
We recently changed the way plugins work very significantly. That being the case, your old plugins won't work.
New plugins should be independent Gems. Take a look at the included example plugin for some inspiration. We will try to keep that file up to date with the latest features.
Please remember that this project is super-pre-alpha right now. If you're not a developer with a good bit of experience with networks, you're probably not even going to get the proxy running. But if you do (we are willing to help to an extent, check the IRC chat and my Twitter feed @plamoni), then test out building a plugin. It's very easy to do and takes almost no time at all for most experienced developers. Check the demo videos and other plugins below for inspiration!
We now have an IRC channel. Check out the #SiriProxy channel on irc.freenode.net.
See the system in action here: http://www.youtube.com/watch?v=AN6wy0keQqo
For a list of current plugins and some more demo videos, check the Plugins page on the wiki.
Video of a complete installation on Ubuntu 11.10
http://www.youtube.com/watch?v=GQXyJR6mOk0
This is a video of a complete start-to-finish installation on a fresh install of Ubuntu 11.10.
The commands used in the video can be found at https://gist.github.com/1428474.
Set up DNS
Before you can use SiriProxy, you must set up a DNS server on your network to forward requests for guzzoni.apple.com to the computer running the proxy (make sure that computer is not using your DNS server!). I recommend dnsmasq for this purpose. It's easy to get running and can easily handle this sort of behavior. (http://www.youtube.com/watch?v=a9gO4L0U59s)
Set up RVM and Ruby 1.9.3
If you don't already have Ruby 1.9.3 installed through RVM, please do so in order to make sure you can follow the steps later. Experts can ignore this. If you're unsure, follow these directions carefully:
- Download and install RVM (if you don't have it already):
- Download/install RVM:
bash < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer) - Activate RVM:
[[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm" - (optional, but useful) Add RVM to your .bash_profile:
echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm" # Load RVM function' >> ~/.bash_profile
- Download/install RVM:
- Install Ruby 1.9.3 (if you don't have it already):
rvm install 1.9.3 - Set RVM to use/default to 1.9.3:
rvm use 1.9.3 --default
Set up SiriProxy
Clone this repo locally, then navigate into the SiriProxy directory (the root of the repo). Then follow these instructions carefully. Note that nothing needs to be (or should be) done as root until you launch the server:
- Install Rake and Bundler:
rvmsudo gem install rake bundler - Install SiriProxy gem (do this from your SiriProxy directory):
rake install - Make .siriproxy directory:
mkdir ~/.siriproxy - Move default config file to .siriproxy (if you need to make configuration changes, do that now by editing the config.yml):
cp ./config.example.yml ~/.siriproxy/config.yml - Generate certificates:
siriproxy gencerts - Install
~/.siriproxy/ca.pemon your phone. This can easily be done by emailing the file to yourself and clicking on it in the iPhone email app. Follow the prompts. - Bundle SiriProxy (this should be done every time you change the config.yml):
siriproxy bundle - Start SiriProxy (must start as root because it uses a port < 1024):
rvmsudo siriproxy server - Test that the server is running by saying "Test Siri Proxy" to your phone.
Note: on some machines, rvmsudo changes "~" to "/root/". This means that you may need to symlink your ".siriproxy" directory to "/root/" in order to get the application to work:
sudo ln -s ~/.siriproxy /root/.siriproxy
Updating SiriProxy
Once you're up and running, if you modify the code, or you want to grab the latest code from GitHub, you can do that easily using the "siriproxy update" command. Here's a couple of examples:
siriproxy update
Installs the latest code from the [master] branch on GitHub.
siriproxy update /path/to/SiriProxy
Installs the code from /path/to/SiriProxy
siriproxy update -b gemify
Installs the latest code from the [gemify] branch on GitHub
Will this let me run Siri on my iPhone 4, iPod Touch, iPhone 3G, Microwave, etc?
No. Please stop asking.
What is your opinion on h1siri, public SiriProxy servers, and other Siri "ports"?
Glad you asked! Watch this: http://youtu.be/Y_Q6PfxBSbA
How do I generate the certificate?
Certificates can now be easily generated using siriproxy gencerts once you install the SiriProxy gem. See the instructions above.
How do I set up a DNS server to forward Guzzoni.apple.com traffic to my computer?
Check out my video on this:
http://www.youtube.com/watch?v=a9gO4L0U59s
Will this work outside my home network?
No, it won't. But, as suggested by STBullard on YouTube, you COULD VPN into your home network from outside your house in order to make this work. That would not require a jailbreak. Of course, it also means ALL your traffic gets funneled through your home network. The nice thing about adding an entry to your /etc/hosts file (on a jailbroken phone) is that it funnels only Siri traffic through your home network, and not all your traffic.
Can you provide me with an iPhone 4S UDID?
No. Don't even ask.
I'm getting a bunch of "[Info - Guzzoni] Object: SessionValidationFailed" messages. What's wrong?!
You're probably not using an iPhone 4S. You need to be using an iPhone 4S (or have a UDID you can sub in) in order to make use of SiriProxy. Sorry, this is not designed to be a way around that limitation. (Thanks to @brownie545 for providing information on what happens when you use a non-iPhone 4S)
How do I remove the certificate from my iPhone when I'm done?
Just go into your phone's Settings app, then go to "General->Profiles." Your CA will probably be the only thing listed under "Configuration Profiles." It will be listed as "SiriProxyCA" Just click it and click "Remove" and it will be removed. (Thanks to @tidegu for asking!)
Does this require a jailbreak?
No. The only action you need to take on the phone is to install the root CA's public key.
Using Siri causes a whole bunch of the following messages, followed by SiriProxy crashing!
Create server for iPhone connection
start conn #<SiriProxy::Connection::Iphone:0x966a400 @signature=880, @processed_headers=false, @output_buffer="", @input_buffer="", @unzipped_input="", @unzipped_output="", @unzip_stream=#<Zlib::Inflate:0x9669640>, @zip_stream=#<Zlib::Deflate:0x96695dc>, @consumed_ace=false, @name="iPhone", @ssled=false>
[Info - Plugin Manager] Plugins laoded: [#<SiriProxy::Plugin::Example:0x968a818 @manager=#<SiriProxy::PluginManager:0x9685750 @plugins=[...]>>]
This is actually really common (but can be tricky to fix). The problem is that your SiriProxy server is using your tainted DNS server. So what happens is this:
- Your iPhone connects to your server, thinking it's
guzzoni.apple.com - Your server connects to itself, thinking that it's
guzzoni.apple.com - Your server thinks another iPhone has connected, and repeats step 2.
This goes on forever, or at least a second or two before the server up and dies. The trick is that you need to make sure your server isn't connecting to itself when it requests a connection to guzzoni.apple.com. This is actually the default behavior, but many people accidentally mess things up by either (1) setting up their server to use itself as a DNS server (while using dnsmasq to taint the entry for guzzoni.apple.com), or (2) putting their server on a network where the DNS server issued by DHCP is tainted to point to the wrong guzzoni.apple.com.
So the fix for this varies based on your setup, but one possible fix for scenario 1 (above) on many *NIX machines is to edit /etc/resolve.conf and change the nameserver entry to 8.8.8.8 (one of Google's public DNS servers). Do this and then restart networking (or just restart the computer) and things should start working.
Your network setup may be different. This is THE most complex part of setting up SiriProxy (getting DNS set up correctly). So once you have this working, you are probably home free. Keep with it, good luck, and have fun!
Given that SiriProxy is a bit of a hack and very unstable, it's probably a good idea to not run it as root. This is especially true if you're allowing access to your server from outside your network. Doing this isn't actually that hard, as SiriProxy doesn't need access to anything privileged.
The only trick is that Siri expects the server to be running on port 443, and only privileged users can open ports below 1024 on *NIX operating systems. So I work around this by running SiriProxy on port 2000 and redirecting traffic to that port using iptables.
Step 1: Set up an account
I just set up an account called "siriproxy". I made sure it wasn't a "sudoer" (on my computer, that means keep it out of the "sudo" group). I also think it's a good idea to refrain from giving it login privileges. But do as I say on that one, not as I do.
Step 2: Set up iptables/ufw
I run UFW on my machine, which is pretty much a wrapper on iptables. I tossed in the following at the top of my /etc/ufw/before.rules:
*nat
:PREROUTING ACCEPT [0:0]
-A PREROUTING --dst 10.0.0.3 -p tcp --dport 443 -j REDIRECT --to-port 2000
COMMIT
The IP referenced (10.0.0.3) is the IP of the computer running SiriProxy. Since this computer is being used as a wireless AP, it's important to only redirect traffic targeted directly at the server, otherwise all traffic to 443/tcp on my wifi network would be incorrectly redirected.
I also made sure to open up 2000/tcp to allow traffic:
sudo ufw allow 2000/tcp