OSTN cookbook

From Guardian Project Wiki

Jump to: navigation, search

The Open Secure Telephony Network is a standard that defines how to configure a VoIP softswitch with the capability to have secure two-way VoIP conversations if both parties are using the same server. The system requires both backend and frontend components, which makes OSTN is a little different than some of the other Guardian apps.

Ready? Here's the 12 step program:

The core server system is what provides user registration and media proxying. The reference application I used is called Freeswitch g. It has a plethora of configuration options, so I chose to use a configuration management system called Chef to get everything set correctly.

  1. Bootstrap a Debian server. Right now the only supported platform for an automated installation is Debian 6 "Squeeze". The adventerous may try to run the cookbook on another platform and do some bug fixing
  2. Install sudo, curl and git if you don't already have them. apt-get install sudo curl git-core
  3. Get a static IP address. This is crucial! Your users will need a place to register from anywhere in the world
  4. Get a domain name. This is also crucial! Your users will prefer to register to a name rather than an IP address
  5. Configure a local hostname. This is a dependency for the cookbook to properly configure Freeswitch to serve your custom domain. Unfortunately, this process varies based on OS and has bizarre conventions that make no sense. Just follow the instructions. Remember to reboot after changing the hostname
  6. Install Chef from the opscode full stack.
  7. Download the freeswitch cookbook and execute it with chef-solo
  8. Walk away and have some coffee, tea or beer, depending on where the sun is relative to you
  9. When the Chef run is finished, Freeswitch will be up and running. Check with netstat -lntp you should see freeswitch listening on TCP port 5061
  10. Create users by running /opt/chef/embedded/bin/ruby /usr/local/freeswitch/scripts/gen_users. Without arguments, it will print the required parameters. Run it with an offset of 1000 and as many users as you like. Copy the XML files output by the script to /usr/local/freeswitch/conf/directory/default/ The script will also output a file with plaintext passwords so you can provision user handsets. Put this file somewhere safe and encrypted
  11. Reload the XML into Freeswitch's memory. /usr/local/freeswitch/bin/fs_cli -x "reloadxml"
  12. Install CSipSimple nightly or CSipSimple official and configure it to connect to your domain name with the username/password pair. OSTN also works on every available operating system via these supported platforms https://guardianproject.info/wiki/OSTN#Client_Software

If you make it through these steps, congratulations! You are now a Freeswitch operator. If you're curious what is behind all of this and why it works, you should read about SIP, ZRTP and SDP. It's also worth noting that the Chef cookbook configures the server to act as an SSL Certificate Authority. This is used for Secure SIP. The current landscape of using commercially signed certificates in Freeswitch is far more complicated than any HTTPS web server you may have worked with.

If you'd like to get help from me or another Guardian Project hacker, you can create issues in our tracker or message SteeleNivenson on Freenode or OFTC in our IRC channel #guardianproject. Oh yeah, and there's Twitter @leeazzarello @guardianproject

Personal tools
Namespaces
Variants
Actions
Navigation
Projects
Toolbox