MSRPRelay

= MSRP Relay =

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

This project implements an MSRP relay, which is an extension to the MSRP protocol. Its main role is to help NAT traversal of IM and file transfer media sessions between SIP User Agents located behind NAT.

== Background ==

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 an MSRP relay ,which is an extension to the MSRP protocol. Its main role is to help NAT traversal of media sessions between endpoints located behind NAT. This extension is defined in [http://tools.ietf.org/html/rfc4976 RFC 4976].

== 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 Installation guide] - How to install the software

== Download ==

The software can be downloaded from:

[http://download.ag-projects.com/MSRPRelay/ http://download.ag-projects.com/MSRPRelay/]

== Credits ==

 * Funding: [http://www.nlnet.nl NLNet foundation]

 * Project management: Adrian Georgescu

 * Author: Ruud Klaver

 * Contributors: Dan Pascu's [http://cheeseshop.python.org/pypi/python-gnutls python-gnutls]

 * Many thanks to the IETF community for advise and support