OSCAR protocol explained

OSCAR (Open System for CommunicAtion in Realtime) is AOL's proprietary instant messaging and presence information protocol. It was used by AOL's AIM instant messaging system and ICQ.

Despite its name, the specifications for the protocol remain proprietary. AOL has gone to great lengths to keep competitors (namely Microsoft, XMPP, and Cerulean Studios) from implementing compatible clients for their proprietary messaging systems.[1] [2] In 2002, AOL signed a contract with Apple, Inc., allowing them to use OSCAR (as well as AOL's own code libraries) in their iChat application. This allowed iChat users to interact with ICQ and AIM users directly. The deal also permitted users of Apple's .Mac service to log in to the AIM network using their .Mac email addresses. (This has carried over to Apple's MobileMe service.)

, large parts of the protocol had been reverse-engineered and implemented by a number of third-party clients.

The OSCAR protocol can be used separately from AOL's network. In fact, AOL expands on the general concept of OSCAR, adding systems for service-side buddy lists and icons, as well as features for file transfers using Bonjour.

On March 6, 2006, AOL released the AIM SDK and launched a developer website, allowing developers to build plugins for AIM Triton, and build their own custom clients, which connect over the OSCAR protocol. They had not, at that point, however, released any information about the protocol itself.

On March 5, 2008, AOL released portions of the OSCAR protocol documentation. Google also provided the ability to sign in to AIM network via the Google Talk client built into Gmail.

Packet structure

All packets sent over OSCAR are encapsulated in the same manner. All 16-bit integers sent over the network are unsigned, and big endian (see Endianness.) This is the same for 32-bit integers, and 8-bit integers (or bytes.)

FLAP header

A special Frame Layer Protocol (FLAP[3]) container encloses every packet. It carries information about packet size, channel, and its number in sequence.

Offset (hex)FieldType/Size (in bytes)Remarks
00FLAP IDbyte/1Always equal to 2A. It marks the start of the packet.
01Channelbyte/11 = login, 2 = SNAC layer, 3 = error, 4 = disconnect
02Number in sequenceint16/2Incremented by 1 each time a packet is sent. Wraps to 0 after FFFF.
04Data sizeint16/2Size does not include FLAP header

SNAC data

Within almost every packet sent over channel 2, packets contain a SNAC (Simple Network Atomic Communication). There is always either one or zero of these contained in a packet, and therefore they do not contain (nor do they need to) a length.

Offset (hex)FieldType/Size (in bytes)Remarks
00Foodgroupint16/2The general type of the packet
02Typeint16/2The specific type of the packet
04Flagsint16/2
06Request IDint32/4A request ID, this can be random but clients cannot send this with the Highest Order Bit set.

Implementations

Programming
language
Implementations
Clibpurple
GnomeICU
C#NOscar
C++QOscar (Qt)
C# 2.0OscarLib
Goretro-aim-server
aim-oscar-server
Javajoscar
Instant Messenger Lib
daim
Objective-CLibOrange
OCamlmlOscar
PythonTwistedWords
PerlNet::OSCAR
PHPWebIcqPro

See also

External links

Notes and References

  1. Web site: AOL blocks Trillian IM access • The Register. The Register.
  2. Web site: AOL vs. Trillian continues | News | Geek.com . 2018-02-05 . 2016-09-18 . https://web.archive.org/web/20160918001136/http://www.geek.com/news/aol-vs-trillian-continues-548381/ . dead .
  3. Web site: FLAP - Frame Layer Protocol . 2008-03-05 . AOL Developer Network . AOL . 2009-11-01 . dead . https://web.archive.org/web/20080308233204/http://dev.aol.com/aim/oscar/#FLAP . 2008-03-08.