MSRPRelay

= MSRP  software suite =

[[Image(http://msrprelay.org/chrome/site/files/MSRP-Relay-Scenarios.png, align=right)]] 

== Description ==

A series of related instant messages between two or more parties can be viewed as part of a "message session", that is, a conversational exchange of messages with a definite beginning and end. This is in contrast to individual messages each sent independently. Messaging schemes that track only individual messages can be described as "page-mode" messaging, whereas messaging that is part of a "session" with a definite start and end is called "session-mode" messaging.

Page-mode messaging is enabled in SIP via the SIP MESSAGE method, as defined in [http://tools.ietf.org/html/rfc3428 RFC 3428]. Session-mode messaging has a number of benefits over page-mode messaging, however, such as explicit rendezvous, tighter integration with other media-types, direct client-to-client operation, and brokered privacy and security.

Message Session Relay Protocol (MSRP) is a protocol for transmitting a series of related instant messages in the context of a session. Message sessions are treated like any other media stream when set up via a rendezvous or session creation protocol such as the Session Initiation Protocol (SIP). MSRP Sessions are defined in [http://tools.ietf.org/html/rfc4975 RFC 4975].

This project implements in Python programming language:

 * MSRP client library, it can be used to create clients from instant messaging and file transfer based on [http://tools.ietf.org/html/rfc4975 RFC 4975] and [http://tools.ietf.org/html/rfc4976 RFC 4976]

 * MSRP relay, a stand alone server. Its main role is to help NAT traversal of instant messaging and file transfer sessions between SIP end-points located behind NAT. This extension is defined in [http://tools.ietf.org/html/rfc4976 RFC 4976].

 * MSRP chat server, a stand alone server, which allows multi-party IM/File transfer sessions using SIP protocol [http://tools.ietf.org/html/draft-ietf-simple-chat-03 draft-ietf-simple-chat-03]

== Security ==

The software have the following security features:

  * TLS encryption and digital certificates using GnuTLS library

  * Digest or basic HTTP authentication with support for multiple realms

  * Database passwords can be stored in an encrypted format

== Documentation ==

 * [wiki:MSRPRelayScenarios MSRP Relay scenarios] - This document describes several use case scenarios of how MSRP relay functionality may be deployed in the field

 * [wiki:MSRPRelayDesign MSRP Relay design] - The internal logic of the MSRPRelay is described as a series of message flow diagrams

 * [wiki:InstallationGuide MSRP Relay Installation guide] - How to install the software

== Download ==

The software can be downloaded as a tar archive from: [http://download.ag-projects.com/MSRPRelay/ http://download.ag-projects.com/MSRPRelay/]

For people running Debian testing or unstable there is an official public repository provided by AG Projects. 

Add the following lines to /etc/apt/sources.list:

{{{

# AG Projects software

deb	http://ag-projects.com/debian unstable main

deb-src http://ag-projects.com/debian unstable main

}}}

Update the list of available software:

{{{

apt-get update

}}}

To install the MSRP client:

{{{

apt-get install python-msrplib

}}}

To install the MSRP relay:

{{{

apt-get install msrprelay

}}}

=== Version control ===

The source code is managed using darcs version control tool. The darcs repository can be fetched with:

{{{

darcs get http://devel.ag-projects.com/repositories/python-msrplib

}}}

To obtain the incremental changes after the initial get, go to the openxcap directory and run:

{{{

cd python-msrplib

darcs pull -a

}}}

== MSRP clients ==

No server is relevant without clients supporting their features. Below is a list with MSRP clients. Not all implement the relay extension yet: 

    * [http://pypjua.org/ SIP SIMPLE client] (IM and file transfer with MSRP relay support)

    * [http://www.mercuro.net/ Mercuro] (MSRP IM and File transfer but no relay support)

    * http://www.xs4all.nl/~mfnboer/twinkle/index.html (on the roadmap)

    * [http://mac.softpedia.com/get/Development/Libraries/LibMSRP.shtml LibMSRP] 

At SIPIT 23-rd held in October 2008 at Lannion, France were five MSRP client implementations.

== Live testbed ==

We provide a live SIP testbed with MSRP relay enabled. You may use the SIP accounts registered at [http://sip2sip.info http://sip2sip.info] for reserving MSRP sessions in an operational MSRP relay. 

{{{

_msrps._tcp.sip2sip.info. 3600	IN	SRV	0 0 2855 node10.dns-hosting.info.

_msrps._tcp.sip2sip.info. 3600	IN	SRV	0 0 2855 node03.dns-hosting.info.

node10.dns-hosting.info. 900	IN	A	81.23.228.139

node03.dns-hosting.info. 900	IN	A	81.23.228.146

}}}

[[Image(http://nlnet.nl/image/logo.gif, align=right, nolink)]]

== Credits ==

 * Funding for MSRP relay and chat server provided by [http://www.nlnet.nl NLNet foundation]

 * Credits: Adrian Georgescu, Ruud Klaver, Denis Bilenko, Dan Pascu and the IETF community for advise and support

== Support == 

The project is supported via this wiki collaboration system by [http://ag-projects.com AG Projects]. To open  ticket please Register first. The ticketing support system is available only for registered users. The support is provided on a best-effort basis.

For commercial support see  [http://ag-projects.com Multimedia Service Platform]