bfheroesFesl

Open Heroes Backend

Setting up

Follow instructions in our wiki.
Remember to configure GOPATH to match your github directory.

Configuration

Enviroment (.env) variables You can look in ./config/config.go for more details

WARNING for Production environment! Use Safe values!

Example .env file

DATABASE_NAME=tutorialDB
DATABASE_HOST=127.0.0.1
DATABASE_PASSWORD=dbPass
LOG_LEVEL=DEBUG

FESL PROTOCOL

This explains the Protocol for gameClient.exe/gameServer.exe => MasterServer(Fesl Login)Theater Server for gameplay

Overview

Battlefield Heroes uses a network protocol similar to many other online games, named GameSpy. it's also used in other titles, such as BF2/BF2142. Need For Speed, and more.

It works basically as :

1. gameClient.exe: the front-end gameClient(BFHeroes.exe) - for Production mode that runs on the player's computer. Consists mainly of a graphical userinterface and some game-logic.

2. gameServer.exe: the server that acts as a central game coordinator for the players in a match. And hosts the game shared area.

3.FESL Login Server. A login System. Used mostly for authentication/account and Stats retrieving. We don't know the meaning of FESL, probably front end socket-lawyer?

1. Theater Server: Another back-end server that stores player and server data and responsible for other functions like: match-making/ranking/leveling up/server bookmarks. This server provides a sync with the gameClient to gameServer.

2. "Magma": an HTTP API , used for login,validation and for the web_token(sessionId),& more game requests(Store,Entitlements,FriendSystem ,ServerBookmark), the reponse is parsed as XML.

TLS

On Start, both the game client and the game server will first connect to the FESL server(working as a Login). The address of the FESL server is inside the game client/server exe HEX.

Changing it with an Hex editor

Search for "bfwest" , and put your IP / DNS there then search for ".com", and also replace with you IP / DNS

The game checks if the TLS certificate is Valid and disconnects if doesn't match the EA certificate. We use A Patch for this. From aluigi http://aluigi.altervista.org/patches/fesl.lpatch

After the TLS handshake, FESL format the Messages like this:

Packet structure

http://old.zenhax.com/post10292.html

The FESLData field is a key-value map where each pair is seperated by a newline (\n), and the key and value are seperated by '='. For example:

Key1=Value1
Key2=Value2

Message types

The 'TXN' key is used to determine the current Message field , and it's Order it's suposed to mean 'TAXON' Response Packets are always sent with the same Type and ID values as the query Packet.

TXN = Hello, game client/server => FESL server

This is the first Pkt that is sent when a FESL connection is made.

TXN = Hello, FESL server => game client/server

TXN = MemCheck, FESL server => game client/server

This message is sent every 10 seconds, and acts a heartbeat. If either stops receiving the MemCheck messages, connection loss is assumed.

TXN = MemCheck, game client/server => FESL server

This message is always a response to a MemCheck query message by the FESL server.

TXN = NuLogin, game client/server => FESL server

This message is sent by clients/servers to authenticate.

TXN = NuLogin, FESL server => game client/server, on error

TXN = NuLogin, FESL server => game client/server, on success

TXN = NuGetPersonas, game client/server => FESL server

This message is a query to lookup all characters owned by a user.

TXN = NuGetPersonas, FESL server => game client/server

|Key |Example value |Note | |--------------------------|---------------------------|-------------------- --| |personas.i |xXx_1337Sn1per_xXx |1 entry for each hero | |personas.[] |1 |The amount of heroes |

TXN = NuGetAccount, game client/server => FESL server

This message retrieves general account information, based on the parameters sent.

TXN = NuGetAccount, FESL server => game client/server

TXN = NuLoginPersona, game client/server => FESL server

This message is sent to login to a character/server.

TXN = NuLoginPersona, FESL server => game client/server

TXN = GetStatsForOwners, game client/server => FESL server

This message is sent to retrieve info for the character selection screen.

TXN = GetStatsForOwners, FESL server => game client/server

TXN = GetStats, game client/server => FESL server

This message is sent to retrieve info about a character/user.

TXN = NuLookupUserInfo, game client/server => FESL server

This message is sent to retrieve basic information about a user.

TXN = NuLookupUserInfo, FESL server => game client/server

This is a query for a list of endpoints to test for the lowest latency on a game client. This is not working at the moment, maybe EA used it to change from DataCenters , based on Ping like LoadBalancer

TXN = GetPingSites, FESL server => game client/server

TXN = UpdateStats, game client/server => FESL server

This message is sent to update character stats.

TXN = UpdateStats, FESL server => game client/server

TXN = GetTelemetryToken, game client/server => FESL server

Returns a unique token for game telemetry. This is only used in 2009 client ?

TXN = GetTelemetryToken, FESL server => game client/server

only requested in 2009 client and 2015 client

TXN = Start, game client/server => FESL server

This message is sent to initiate a "playnow".

TXN = Start, FESL server => game client/server

Magma server

On start, the game will connect to an HTTPS server. called MAGMA, this connection is encrypted using TLS. Multiple Magma server domains are in the game executable.

The following HTTPS paths are listed in the game executable:

* /dc/submit
* /nucleus/authToken
* /nucleus/check/%s/%I64d
* /nucleus/entitlement/%s/status/%s
* /nucleus/entitlement/%s/useCount/%d
* /nucleus/entitlements/%I64d
* /nucleus/entitlements/%I64d
* /nucleus/entitlements/%I64d?entitlementTag=%s
* /nucleus/name/%I64d
* /nucleus/personas/%s
* /nucleus/refundAbilities/%I64d
* /nucleus/wallets/%I64d
* /nucleus/wallets/%I64d/%s/%d/%s
* /ofb/products
* /ofb/purchase/%I64d/%s
* /relationships/acknowledge/nucleus:%I64d/%I64d
* /relationships/acknowledge/server:%s/%I64d
* /relationships/decrease/nucleus:%I64d/nucleus:%I64d/%s
* /relationships/decrease/nucleus:%I64d/server:%s/%s
* /relationships/decrease/server:%s/nucleus:%I64d/%s
* /relationships/increase/nucleus:%I64d/nucleus:%I64d/%s
* /relationships/increase/nucleus:%I64d/server:%s/%s
* /relationships/increase/server:%s/nucleus:%I64d/%s
* /relationships/roster/nucleus:%I64d
* /relationships/roster/nucleus:%I64d
* /relationships/roster/server:%s
* /relationships/roster/server:%s/bvip/1,3
* /relationships/status/nucleus:%I64d
* /relationships/status/server:%s
* /user
* /user/updateUserProfile/%I64d

## /nucleus/authToken
  For game servers:
    ```<success><token>$serverSECRET$</token></success>```

  `$SECRET$` equal to the value of the `X-SERVER-KEY` and "+Secret" given in start parameter

  For game clients:

    <success><token code="NEW_TOKEN">$userKey$</token></success>

  where `$userKey$` is the web token ID.

### /relationships/roster/{type}:{id}
    <update>
        <id>1</id>
        <name>Test</name>
        <state>ACTIVE</state>
        <type>server</type>
        <status>Online</status>
        <realid>$id$</realid>
    </update>
  with $id$ equal to the id in the URL.

### /nucleus/entitlements/{heroID}  // this is not a valid response

    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <entitlements>
        <entitlement>
            <entitlementId>1</entitlementId>
            <entitlementTag>WEST_Custom_Item_142</entitlementTag>
            <status>ACTIVE</status>
            <userId>$heroID$</userId>
        </entitlement>
        <entitlement>
            <entitlementId>1253</entitlementId>
            <entitlementTag>WEST_Custom_Item_142</entitlementTag>
            <status>ACTIVE</status>
            <userId>$heroID$</userId>
        </entitlement>
    </entitlements>
  with $heroID$ equal to heroID in the URL.

### /nucleus/wallets/{heroID}
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <billingAccounts>
        <walletAccount>
            <currency>hp</currency>
            <balance>1</balance>
        </walletAccount>
    </billingAccounts>

### /ofb/products // this is not a valid response
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <products>
        <product overwrite="false" default_locale="en_US" status="Published" productId="">
            <status>Published</status>
            <productId>142</productId>
            <productName>WEST_Custom_Item_142</productName>
            <attributes>
                <attribute value="WEST_Custom_Item_142" name="productName"/>
                <attribute value="WEST_Custom_Item_142" name="Product Name"/>
                <attribute value="WEST_Custom_Item_142" name="Long Description"/>
                <attribute value="WEST_Custom_Item_142" name="Short Description"/>
                <attribute value="BFHPC_Neck" name="groupName"/>
                <attribute value="WEST_Custom_Item_142" name="entitlementTag"/>
                <attribute value="142" name="entitlementId"/>
                <attribute value="1" name="sortKey"/>
                <attribute value="1" name="duration" />
                <attribute value="MONTH" name="durationType"/>
            </attributes>
        </product>
        <product overwrite="false" default_locale="en_US" status="Published" productId="">
            <status>Published</status>
            <productId>142</productId>
            <productName>WEST_Custom_Item_142</productName>
            <attributes>
                <attribute value="WEST_Custom_Item_141" name="productName"/>
                <attribute value="WEST_Custom_Item_141" name="Product Name"/>
                <attribute value="WEST_Custom_Item_141" name="Long Description"/>
                <attribute value="WEST_Custom_Item_141" name="Short Description"/>
                <attribute value="BFHPC_Neck" name="groupName"/>
                <attribute value="WEST_Custom_Item_141" name="entitlementTag"/>
                <attribute value="141" name="entitlementId"/>
                <attribute value="1" name="sortKey"/>
                <attribute value="1" name="duration" />
                <attribute value="MONTH" name="durationType"/>
            </attributes>
        </product>
        <product overwrite="false" default_locale="en_US" status="Published" productId="">
            <status>Published</status>
            <productId>142</productId>
            <productName>WEST_Custom_Item_142</productName>
            <attributes>
                <attribute value="WEST_Custom_Item_140" name="productName"/>
                <attribute value="WEST_Custom_Item_140" name="Product Name"/>
                <attribute value="WEST_Custom_Item_140" name="Long Description"/>
                <attribute value="WEST_Custom_Item_140" name="Short Description"/>
                <attribute value="BFHPC_Neck" name="groupName"/>
                <attribute value="WEST_Custom_Item_140" name="entitlementTag"/>
                <attribute value="140" name="entitlementId"/>
                <attribute value="1" name="sortKey"/>
                <attribute value="1" name="duration" />
                <attribute value="MONTH" name="durationType"/>
            </attributes>
        </product>
    </products>

Theater Protocol

Theater

The 3rd type of connection is the Theater connection and runs over TCP and UDP Ports used are listed at the Readme.txt inside the original files Packets received or sent from the UDP port are decoded/encoded using the "gamespy XOR" more info will be added soon.