Difference between revisions of "342 Protocol"

From RuneWiki
Jump to navigationJump to search
Line 9: Line 9:
 
====Return Code====
 
====Return Code====
 
The return code is a code used to identify which part of login the session is currently at.
 
The return code is a code used to identify which part of login the session is currently at.
−
=====Return Code Value: 0=====
+
{| border=2
−
Signifies that the session will exchange session keys in order to obtain encryption.
+
! Value
−
<br/>
+
! Response
−
=====Return Code Value: 1=====
+
|-
−
Signifies that the session should re-attempt the login procedure.
+
| -1
−
<br/>
+
| Waits for 2000ms and tries again while counting failures.
−
=====Return Code Value: 2=====
+
|-
−
This is used to signify that the login process has successfully completed.
+
| 0
−
<br/>
+
| Exchanges session keys, player name, password, etc.
−
=====Return Code Value: 3=====
+
|-
−
Client displays message - "Invalid username or password".
+
| 1
−
<br/>
+
| Waits for 2000ms and tries again.
−
Used to let the player know that the account credentials they have entered are invalid.
+
|-
−
<br/>
+
| 2
−
=====Return Code Value: 4=====
+
| Client made a successful login.
−
Client displays message - "Your account has been disabled".
+
|-
−
<br/>
+
| 3
−
Used to tell the player that their account has been banned from the server.
+
| "Invalid username or password."
−
<br/>
+
|-
−
=====Return Code Value: 5=====
+
| 4
−
Client displays message - "Your account is already logged in".
+
| "Your account has been disabled. Please check your message-center for details."
−
<br/>
+
|-
−
Used to let the player know that their account is already logged in.
+
| 5
−
<br/>
+
| "Your account is already logged in. Try again in 60 secs..."
−
=====Return Code Value: 6=====
+
|-
−
Client displays message - "RuneScape has been updated!".
+
| 6
−
<br/>
+
| "RuneScape has been updated! Please reload this page."
−
Used to let the player know that the game has been updated, and they should refresh the page in order to load the new client version.
+
|-
−
<br/>
+
| 7
−
=====Return Code Value: 7=====
+
| "This world is full. Please use a different world."
−
Client displays message - "This world is full".
+
|-
−
<br/>
+
| 8
−
used to let the player know that the world they have selected is full.
+
| "Unable to connect. Login server offline."
−
<br/>
+
|-
−
=====Return Code Value: 8=====
+
| 9
−
Client displays message - "Unable to connect, loginserver offline".
+
| "Login limit exceeded. Too many connections from your address."
−
<br/>
+
|-
−
Used to let the player know that the game server was unable to connect with a loginserver.
+
| 10
−
<br/>
+
| "Unable to connect. Bad session id."
−
=====Return Code Value: 9=====
+
|-
−
Client displays message - "Login limit exceeded".
+
| 11
−
<br/>
+
| "Login server rejected session. Please try again."
−
Used to let the player know that there are too many current connections from their IP address to log in another account.
+
|-
−
<br/>
+
| 12
−
=====Return Code Value: 10=====
+
| "You need a members account to login to this world. Please subscribe, or use a different world."
−
Client displays message - "Unable to connect, bad session ID".
+
|-
−
<br/>
+
| 13
−
Used to let the player know that the session ID the client provided to the server is bad.
+
| "Could not complete login. Please try using a different world."
−
<br/>
+
|-
−
=====Return Code Value: 11=====
+
| 14
−
Client displays message - "Loginserver rejected session".
+
| "The server is being updated. Please wait 1 minute and try again."
−
<br/>
+
|-
−
Used to let the player know that the loginserver that was selected by the game server rejected the session.
+
| 15
−
<br/>
+
| N/A
−
=====Return Code Value: 12=====
+
|-
−
Client displays message - "You need a members account to sign into this world".
+
| 16
−
<br/>
+
| "Login attempts exceeded. Please wait 1 minute and try again."
−
Used to let the player know that the world they have selected is a members-only world, and the account they are using is not a member.
+
|-
−
<br/>
+
| 17
−
=====Return Code Value: 13=====
+
| "You are standing in a members-only area. To play on this world move to a free area first."
−
Client displays message - "Could not complete login".
+
|-
−
<br/>
+
| 20
−
Used to let the player know that the server was unable to complete the login request.
+
| "Invalid loginserver requested. Please try using a different world."
−
<br/>
+
|-
−
=====Return Code Value: 14=====
+
| 21
−
Client displays message - "Server is being updated".
+
| "You have only just left another world. Your profile will be transferred in: (number) seconds."
−
<br/>
+
|-
−
Used to let the player know that the server is currently being updated, and they should wait for the update to complete.
+
| 22
−
<br/>
+
| "Malformed login packet. Please try again."
−
=====Return Code Value: 15=====
+
|-
−
Unknown.
+
| None of the above
−
<br/>
+
| "Unexpected server response. Please try using a different world."
−
=====Return Code Value: 16=====
+
|-
−
Client displays message - "Login attempts exceeded".
+
|}
−
<br/>
+
 
−
Used to let the player know that they have made too many logins with invalid username+password combinations, and they need to wait 5 minutes in order to try again.
 
−
<br/>
 
−
=====Return Code Value: 17=====
 
−
Client displays message - "You are standing in a members only area".
 
−
<br/>
 
−
Used to let the player know that they are attempting to log into a free-world and their character is located in a members-area.
 
−
<br/>
 
−
=====Return Code Value: 20=====
 
−
Client displays message - "Invalid loginserver requested".
 
−
<br/>
 
−
Used to let the player know that the loginserver that was requested by the game server is invalid.
 
−
<br/>
 
−
=====Return Code Value: 21=====
 
−
Client displays message - "You have only just left another world".
 
−
<br/>
 
−
Used to let the player know that they have just left another world, and they must wait to enter another.
 
−
<br/>
 
−
=====Return Code Value: 22=====
 
−
Client displays message - "Malformed login packet".
 
−
<br/>
 
−
Used to let the player know that the login-packet that the client sent to the server was malformed.
 
−
<br/>
 
 
====Server Session Key====
 
====Server Session Key====
 
The server-session-key is one of two ciphers used to encrypt the game protocol, using the ISAAC algorithms.
 
The server-session-key is one of two ciphers used to encrypt the game protocol, using the ISAAC algorithms.

Revision as of 18:09, 15 August 2009

Login Protocol

The Login Protocol for the 342 is very similar in structure to that of the 317 (and other versions). The login is comprised of four stages in which the client and server switch in regards to which one is reading and which one is writing.

Variables:

The login process has a lot of variable data, compiled here is a list of the variables and their different values.

Name Hash

A hash of the player name, thought to be used to select an appropriate login server. This has no use in current private servers.

Return Code

The return code is a code used to identify which part of login the session is currently at.

Value Response
-1 Waits for 2000ms and tries again while counting failures.
0 Exchanges session keys, player name, password, etc.
1 Waits for 2000ms and tries again.
2 Client made a successful login.
3 "Invalid username or password."
4 "Your account has been disabled. Please check your message-center for details."
5 "Your account is already logged in. Try again in 60 secs..."
6 "RuneScape has been updated! Please reload this page."
7 "This world is full. Please use a different world."
8 "Unable to connect. Login server offline."
9 "Login limit exceeded. Too many connections from your address."
10 "Unable to connect. Bad session id."
11 "Login server rejected session. Please try again."
12 "You need a members account to login to this world. Please subscribe, or use a different world."
13 "Could not complete login. Please try using a different world."
14 "The server is being updated. Please wait 1 minute and try again."
15 N/A
16 "Login attempts exceeded. Please wait 1 minute and try again."
17 "You are standing in a members-only area. To play on this world move to a free area first."
20 "Invalid loginserver requested. Please try using a different world."
21 "You have only just left another world. Your profile will be transferred in: (number) seconds."
22 "Malformed login packet. Please try again."
None of the above "Unexpected server response. Please try using a different world."

Server Session Key

The server-session-key is one of two ciphers used to encrypt the game protocol, using the ISAAC algorithms.

"Data File Version"

Unknown, quoted from a Winterlove private server.

User ID

The ID of the user.

Username

The username of the player, used to identify their account.

Password

The password of the player account, used so only they can log into their account.

Client Session Key

The client-session-key is one of two ciphers used to encrypt the game protocol, using the ISAAC algorithms.

Connect Status

The status of the connection.

Connect Status Value: 16

Signifies that the connection is new.

Connect Status Value: 18

Signifies that the session is reconnecting a previously lost connection.

Size

The size of the unencrypted login packet, used to determine how many bytes need to be read from the stream by the server.

Client Version

The memory-version of the game client.

Client Version Value: 0

Signifies that the client is a low-memory client.

Client Version Value: 1

Signifies that the client is a high-memory client.

CRC Values

Unknown.

Player Status

The in-game player status - player, player moderator, or administrator.

Player Status Value: 0

Signifies that this player is a normal player.

Player Status Value: 1

Signifies that this player is a player moderator.

Player Status Value: 2

Signifies that this player is an administrator.

Flagged

If set to 1, information about mouse movements etc. are sent to the server. Suspected bot accounts are flagged.

Login Process:

Stage 1: Client -> Server

Type Value
ubyte 14
ubyte "name hash"


Stage 2: Server -> Client

Type Value
byte 0
byte 0
byte 0
byte 0
byte 0
byte 0
byte 0
byte 0
byte "return code"
long "server session key"


Stage 3: Client -> Server

Type Value
byte 10
int "datafileversion"[0]
int "datafileversion"[1]
int "datafileversion"[2]
int "datafileversion"[3]
int "user id"
string "username"
string "password"
long "client session key"
long "server session key"
byte "connect status"
byte "size"
byte 255
short 342
byte "client version"
int "crc values"[0]
int "crc values"[1]
int "crc values"[2]
int "crc values"[3]
int "crc values"[4]
int "crc values"[5]
int "crc values"[6]
int "crc values"[7]
int "crc values"[8]


Stage 4: Server -> Client

Type Value
byte "return code"
byte "player status"
byte "flagged"


Game Protocol

(needs to be documented)

Server -> Client Packets

Opcode Type Length (bytes) Name Description
98 VARIABLE_BYTE N/A Send message Sends a server message (e.g. 'Welcome to RuneScape') or trade/duel request.
128 FIXED 0 Logout Disconnects the client from the server.

Client -> Server Packets

Opcode Type Length (bytes) Name Description
Retrieved from "https://old.runewiki.org/index.php?title=342_Protocol&oldid=222"