Protocols/OSCAR/SNAC/OSERVICE MIGRATE GROUPS

OSCAR Protocol

Introduction • Terms • Clients

Basic

Datatypes • FLAP • SNAC • TLV

UUIDs • Errors • Tool IDs

Host Interaction

Rate Limits • Migration • Messages

Other Services

ADMIN • ADVERT • ALERT

BART • BOS • BUCP • CHAT

CHAT_NAV

Tutorials

Sign On • BART • Rendezvous

ICBM • Locate • Buddies

Foodgroups

OSERVICE (0x0001)

LOCATE (0x0002)

BUDDY (0x0003)

ICBM (0x0004)

ADVERT (0x0005)

INVITE (0x0006)

ADMIN (0x0007)

POPUP (0x0008)

PD (0x0009)

USER_LOOKUP (0x000A)

STATS (0x000B)

TRANSLATE (0x000C)

CHAT_NAV (0x000D)

CHAT (0x000E)

ODIR (0x000F)

BART (0x0010)

FEEDBAG (0x0013)

ICQ (0x0015)

BUCP (0x0017)

ALERT (0x0018)

PLUGIN (0x0022)

UNNAMED_FG_24 (0x0024)

MDIR (0x0025)

ARS (0x044A)

ID	Origin	Name	Foodgroup	Service	Status	Version
0x0001, 0x0012	Host	OSERVICE__MIGRATE_GROUPS	Unspecified	All	Active	4.0

This SNAC commands the client to reconnect to the server specified by the included OSERVICE__TLV_TAGS_RECONNECT_HERE TLV.

See more information about client migration.

SNAC Header

Foodgroup	uint16 (word)	00 01
Subgroup	uint16 (word)	00 12
Flags	uint16 (word)	00 00
Request ID	uint32 (dword)	00 00 00 00

SNAC Data

The client needs to present the OSERVICE__TLV_TAGS_LOGIN_COOKIE to sign in so that it can reacquire the services which were previously OSERVICE__PAUSE_REQ'd by the server and OSERVICE__PAUSE_ACK'd by the client.

All groups currently provided on the existing connection are migrated to the new location. The client should drop the existing connection since services will no longer be available from it.

Name	Type	Notes
allGroups	uint16 (word)	Will be zero
tlvAuthData	Rest of SNAC array of TLV	[Class: OSERVICE__MIGRATE_TAGS] Information about where to reconnect

TLV Class: OSERVICE__MIGRATE_TAGS

These are the codes used in OSERVICE__MIGRATE_GROUPS to describe where the client should reconnect.

Name	Tag	Type	Notes
OSERVICE__TLV_TAGS_RECONNECT_HERE	0x05	string	IP address followed by optional colon and port, 10.0.0.1:5190
OSERVICE__TLV_TAGS_LOGIN_COOKIE	0x06	string	Binary opaque data
OSERVICE__TLV_TAGS_SSL_CERTNAME	0x8D	string	Certificate name to use for SSL validation
OSERVICE__TLV_TAGS_SSL_STATE	0x8E	uint8 (byte)	[Class:OSERVICE__SERVICE_RESPONSE_SSL_STATE] SSL state

From Aleksandr Shutko: SNAC(01,12) server migration notice

SNAC(01,12)  OSERVICE__MIGRATE_GROUPS

This is the last SNAC in client migration sequence. See also known families list. Client should open new connection to specified server and use this connection for specified families. If there is no family list (empty) or it contain all connection families - client should close current connection and use new one. Migration sequence used to redirect client to new BOS server during current BOS shutdown.  00 01   word   SNAC family  00 12   word   SNAC subtype  00 00   word   SNAC flags  xx xx xx xx   dword   SNAC request-id  xx xx   word   Number of families in migration list  xx xx   word   Family to migrate #1  ....   ....   ....  xx xx   word   Family to migrate #n  00 05   word   TLV.Type(0x05) - server address  xx xx   word   TLV.Length  xx ..   string   Server address and (optional) port  00 06   word   TLV.Type(0x06) - authorization cookie  xx xx   word   TLV.Length  xx ..   string   Authorization cookie  May contain other tlv from the following list

Example SNAC dump with flap header:

2A 02 E5 66 00 3A 00 01 00 12 00 00 8E CC C4 E0 *..f.:.......... 00 04 00 01 00 02 00 03 00 15 00 05 00 0F 31 30 ..............10 2E 31 30 2E 31 30 2E 38 3A 35 31 39 30 00 06 00 .10.10.8:5190... 0F 31 32 33 34 35 36 37 38 39 41 42 43 44 45 46 .123456789ABCDEF

OSERVICE SNACs

SNAC List

Subgroup Origin Name 0x0001 Any OSERVICE__ERR This is the error SNAC for the OSERVICE foodgroup. 0x0002 Client OSERVICE__CLIENT_ONLINE This message is sent by the client once it has initialized the host state (set preferences, Buddy Lists, locate information, capabilities) and is ready to be announced as being online by the host. 0x0003 Host OSERVICE__HOST_ONLINE This is the very first SNAC sent from the host to the client after the FLAP signon frames are sent. It contains an array of all of the foodgroups the service supports. 0x0004 Client OSERVICE__SERVICE_REQUEST This SNAC requests that the specified service (foodgroup) be provided to it in a way further specified by qualifying parameters. 0x0005 Host OSERVICE__SERVICE_RESPONSE This SNAC contains information about connecting to the new server. It is the response from the server to a service request. 0x0006 Client OSERVICE__RATE_PARAMS_QUERY This SNAC is sent by the client to query for the current rate limit parameters. 0x0007 Host OSERVICE__RATE_PARAMS_REPLY Contains response to the OSERVICE__RATE_PARAMS_QUERY. 0x0008 Client OSERVICE__RATE_PARAMS_SUB_ADD Subscribe to any rate parameter changes among the specified class IDs. If there was no prior subscription for a given class ID, an immediate notification will be queued. 0x0009 Client OSERVICE__RATE_DEL_PARAM_SUB Cancels any rate parameter subscriptions for the specified class IDs. 0x000A Host OSERVICE__RATE_PARAM_CHANGE This contains an array of class rate parameters that have changed since last query or notification. 0x000B Host OSERVICE__PAUSE_REQ This is sent by the server when it needs to migrate the client. 0x000C Client OSERVICE__PAUSE_ACK This is sent by the client to acknowledge the receipt and processing of a OSERVICE__PAUSE_REQ SNAC request. 0x000D Host OSERVICE__RESUME In certain situations the server may abort a migration after having told the client to PAUSE. 0x000E Client OSERVICE__USER_INFO_QUERY This is a query to find out one's current info. The server will send a OSERVICE__USER_INFO_UPDATE. 0x000F Host OSERVICE__USER_INFO_UPDATE This SNAC is sent by the server whenever significant parts of a user's info change. 0x0010 Host OSERVICE__EVIL_NOTIFICATION This is a notice that the user's evil level has changed. 0x0011 Client OSERVICE__IDLE_NOTIFICATION This SNAC is sent by the client to inform the server of the user's idle state. 0x0012 Host OSERVICE__MIGRATE_GROUPS This SNAC commands the client to reconnect to the server specified by the included OSERVICE__TLV_TAGS_RECONNECT_HERE TLV. 0x0013 Host OSERVICE__MOTD Message of the day (MOTD). Often contains upgrade information for clients as well as notices about clients. 0x0014 Client OSERVICE__SET_PRIVACY_FLAGS Set privacy flags. 0x0015 Host OSERVICE__WELL_KNOWN_URLS Service related URLs for the client to use or provide to the user. 0x0016 Client OSERVICE__NOOP Legacy SNAC keepalive, replaced in large part with FLAP level keepalive. 0x0017 Client OSERVICE__CLIENT_VERSIONS Sent after OSERVICE__HOST_ONLINE, it contains the client's foodgroup version list so the host knows what functionality the client is capable of. 0x0018 Host OSERVICE__HOST_VERSIONS The host responds to OSERVICE__CLIENT_VERSIONS with its foodgroup version list so that the client knows what this host provides and its capabilities. 0x0019 NCD OSERVICE__MAX_CONFIG_QUERY This is not currently documented. Want to contribute? 0x001A NCD OSERVICE__MAX_CONFIG_REPLY This is not currently documented. Want to contribute? 0x001B NCD OSERVICE__STORE_CONFIG This is not currently documented. Want to contribute? 0x001C NCD OSERVICE__CONFIG_QUERY This is not currently documented. Want to contribute? 0x001D NCD OSERVICE__CONFIG_REPLY This is not currently documented. Want to contribute? 0x001E Client OSERVICE__SET_USERINFO_FIELDS This allows the client to set some of the fields in user info that are sent to every client. 0x001F Host OSERVICE__PROBE_REQ Client verification request. 0x0020 Client OSERVICE__PROBE_ACK Client verification reply. 0x0021 Host OSERVICE__BART_REPLY This reply is used to tell the client that a BART item needs to be uploaded or changed. 0x0022 Client OSERVICE__BART_QUERY2 This query sees if the BART IDs are available; OSERVICE__BART_REPLY2 is sent as a response. 0x0023 Host OSERVICE__BART_REPLY2 This SNAC is sent on initial login about items in the personality section of the Feedbag. It is also used in response to a OSERVICE__BART_QUERY2.