• Introduction
• Features
• Usage guide
• Client IMBC autologin

This is an Auth Server emu ready for production usage. It handle player connections, authentication and game server selection.

It support many database (default configuration is for SQL Server), clients/GS since epic 2 (running fine with 5.2 GS and newer).

See features bellow for more details.

It is portable on Windows and Linux, raspberry pi.

This server support any database that have an ODBC driver, this include:

• SQL Server (supported by all Windows OS out of the box)
• Oracle
• MySql
• PostgreSQL
• SQLite

For some of them you will need a correct connection string to give parameters to configure the connection. Connection string for almost all known database are available here: http://www.connectionstrings.com/ (for example, to get the connection string to a SQLite database, type "sqlite connection string odbc" in google, click on the first link and look for the driver you have in "ODBC drivers").

The list of available ODBC drivers can be retrieved with this tool: On windows x64: C:\WINDOWS\SysWOW64\odbcad32.exe On windows x86: C:\WINDOWS\System32\odbcad32.exe

The server has most of the feature of the official auth server with some additional features:

• Auth server using RSA/AES or DES
• Auth server using IMBC autologin
• Auto server reconnect to SQL database on failure
• Guild icon server with an integrated mini webserver (can serve only JPG images, it is not supposed to replace IIS or apache)
• Network traffic dump in hex and JSON format (not enabled by default)
• Supports epic 2 to latest
• Supports GS reconnection without GS restart with GS autoreconnect (in case of bad network connection between auth and GS or auth restart)
• Supports security password (for bank access, character delete, ...)
• Optionnaly encrypted database password/connection string (both old DES and 9.1 encryption)
• Send log to Log Server

By default, original auth server restrict which characters that can be used. This restriction is enabled in this auth server too, thus authentication with accounts with other characters than letters or digits are refused. Be sure that your sign up page does not allow other characters than these for the account name.

You can disable this restriction using auth.clients.restrictchars (see also in the Usage guide).

To use the auth server, you must have a correct configuration. For that two methods are available:

• Use command line switches
• Use a configuration file

For example, changing the ip of the Database server you need to change the variable auth.db.server

Command line switches use this formats:

/<variable_name>:<value>

/ can be replaced by - and : can be replaced by =.

This method override values set in the configuration file. The configuration file location can be changed using this method with the argument /configfile:filename.opt.

Example:

rzauth.exe /configfile:auth_for_epic82.opt /admin.console.autostart:true /admin.console.port:6235 /auth.db.salt:2011

By default, the configuration file is named auth.opt (This can be overridden by changing configfile value using the command line)

The file has one configuration value per line with empty lines or lines beginning with the # character ignored (this allows comments) A configuration file has this format:

<variable_name>:<value>
<variable_name>=<value>

The separator is : and =. Any spaces are treated as the value or name of the variable (including trailing spaces, only leading spaces before the variable name are ignored)

It's possible to include another config file using the special command %include. This following command will include configuration from common.opt file:

%include common.opt

Example of configuration file:

#Database configuration
auth.db.server:127.0.0.1
auth.db.port:1433
auth.db.name:Auth
auth.db.account:sa

#MD5 salt
auth.db.salt:2011
#The password is in plain text for auth.db.password if you have one
auth.db.password:
#Use auth.db.cryptedpassword instead of auth.db.password to use an encrypted password
auth.db.cryptedpassword:<password encrypted using Pyrok tool>

#Enable traffic dump, will be in traffic_log folder (default off)
#trafficdump.enable:true

#Where clients will connect (this is default values)
auth.clients.ip:0.0.0.0
auth.clients.port:4500

#Where the gameserver will connect (this is default values)
auth.gameserver.ip:127.0.0.1
auth.gameserver.port:4502

#Upload configuration, use "upload" folder for guild icons
upload.dir=upload
upload.clients.ip=0.0.0.0
upload.clients.port=4617
#Use port 5000 for the guild icon mini webserver
upload.iconserver.ip=0.0.0.0
upload.iconserver.port:5000

#Where the gameserver will connect (this is default values)
upload.gameserver.ip:127.0.0.1
upload.gameserver.port:4616

#Only for SQL Server: speed up selects with NOLOCK
sql.db_account.query:SELECT * FROM account WITH(NOLOCK) WHERE account = ? AND password = ?;

#Configure security password query. If this query return at least one row, the security password is accepted
#sql.db_securitynocheck.query:SELECT securty_no FROM account WHERE account = ? AND securty_no = ?;
#You can also use a stored procedure
#sql.db_securitynocheck.query:{CALL smp_new_check_security(?, ?)}

#Logging level
core.log.level:debug
core.log.consolelevel:info

The telnet-like interface is the way to interact with the server. This allows:

• Change or display a configuration value
• Start or stop a server component (like start the auth client server when all game servers are connected)

This way it's possible to change a server port or change the log level without restarting the emu.

When you connect to the admin server, it shows this:

Auth server - Administration server - Type "help" for a list of available commands
>

After every command, when the server waits for a new command, it sends the command prompt > .

The available commands are (also available with the "help" command):

• get <variable_name> Show the value of the variable.
• set <variable_name> <value> Set a new value for the variable.
• start <server_name> Start the server server_name. If <server_name> is "all", then start all server with their variable "autostart" set to "true".
• stop <server_name> Stop the server server_name. If <server_name> is "all" then stop all servers (this will cause the emu to terminate).
• list List all connected gameservers and infos about them: index, name, IP address, players count on it, screenshot url
• mem List emu's objects counts.
• closedb Close all idle DB connections. Use this to bring the auth database offline without stopping the auth server.
• help Show the list of available commands with a description (like this list).
• terminate Stop the emu (equivalent to stop all).

In any case, when all servers are stopped (either by using stop all or by stopping all servers one by one), the emu will terminate.

Available server names are:

• auth.clients The auth server listening for clients
• auth.gameserver The auth server listening for game servers
• auth.billing The billing telnet server listening for billing notifications
• auth.logclient The Log Server connection to send activity logs
• upload.clients The upload server listening for clients for guild icon uploads
• upload.iconserver The web server listening for clients to download guild icons
• upload.gameserver The upload server listening for game servers
• admin.console The telnet administration server used to interact with the Emu

To connect to the telnet server, you can use PuTTY. To connect to it, use 127.0.0.1 as hostname, 4501 as the port and use RAW mode (4501 is the default port, see configuration variable admin.console.port). Change values as needed for your configuration.

The format used to display configuration variable information is the same between the startup dump and the result of the get command on a telnet interface.

The format is:

<type><is_default><variable_name>:<value>

<type> can be:

• B : Boolean
• N : Number (integer)
• F : Float
• S : String

<is_default> can be either a space or a star. If there is a star, the value is the default one. The default value can depend on other configuration variable, for example auth.db.connectionstring use other auth.db.* values.

Example of output:

B*auth.gameserver.autostart:true
S*auth.gameserver.ip:127.0.0.1
N auth.gameserver.port:5014

All configuration variables about the database live under auth.db.

This configure how clients and gameservers must connect to the auth server. All configuration variables about the auth server live under auth.clients and auth.gameserver.

About hidding gameservers for devs only or for a closed beta server: If you want:

• All servers with index <= 10 to be public (by default, anyone can see them),
• All servers with index between 11 and 20 (included) to be used for closed tests (ie: closed beta) with access for only a limited amount of players,
• All servers with index between 21 to 50 for tests purpose with only access for devs

Then use these config values: Set auth.clients.maxpublicserveridx to 10 Default value for the server_idx_offset columns in Account table is set to 0 Players that can access closed beta test gameservers have their server_idx_offset column set to 10 (they can access all servers with index <= auth.clients.maxpublicserveridx + server_idx_offset, so index <= 10+10 Set server_idx_offset column for Devs to 40 so they can access all servers with index <= 10 + 40, so index <= 50

The server_idx_offset column in the Account table can be renamed using the config parameter sql.db_account.column.serveridxoffset.

This configure the connection to the Log Server. Operation like account connection, disconnection or kick is logged to the Log Server.

This configure the telnet server accepting billing_notify blank <account_id> commands. When the emu receive such command, it will send a notification to the game server so the player will have a notification in its chat window about having received a new item from item shop.

This configure the upload server. All configuration variables about the upload server live under upload.

The value of app.name of game servers must contains only letters (a-z and A-Z), digits (0-9), _ or -

Here is an example of guild icon configuration for the gameserver.opt:

S game.guild_icon_base_url:/
S game.url_list:guild_icon_upload.ip|< auth emu external IP >|guild_icon_upload.port|< upload.clients.port >|guild_test_download.url|upload/|web_download|< auth emu external IP >:< upload.clients.webport >

This configure which SQL query to do for the auth server. All configuration variables about SQL queries live under sql.

It's possible to use stored procedures instead of SQL queries. For example, to use official stored procedures:

sql.db_account.param.account:1
sql.db_account.param.ip:2
sql.db_account.param.password:3
sql.db_account.query:{CALL smp_account(?, ?, ?)}
sql.db_updatelastserveridx.param.accountid:1
sql.db_updatelastserveridx.param.serveridx:2
sql.db_updatelastserveridx.query:{CALL smp_update_last_login_server_idx(?, ?)}
sql.db_securitynocheck.param.account:1
sql.db_securitynocheck.param.securityno:2
sql.db_securitynocheck.query:{CALL smp_check_security(?, ?)}

All configuration variables about the telnet server live under admin.

To get the current opened connections to the Emu, calculate stats.connections - stats.disconnections or use "mem" command and check for the number of "Socket".

IMBC autologin allow to start SFrame.exe with an account and password set in the command line. So the client does not ask for account & password when started, but directly authenticate the provided account in the command line.

The SFrame command line to use to enable this feature is this one:

/imbclogin /account:<account_name> /password:<password>

/!\ The password is in plain text. Be aware that the command line used to run an application is visible to any other program running on your computer. This feature should be used along with a Launcher that does the player authentication and generate One Time passwords.

The idea is to make the password passed to SFrame.exe usable only once. To do that, you probably need to change the auth emu query to use another SQL table:

sql.db_account.query:SELECT * FROM one_time_passwords WHERE account = ? AND password = ?;

And all rows in the one_time_passwords table would be temporary. The one time passwords need to be hashed like a normal password, that is using MD5 and a salt like "2011".

If Windows complains about missing msvcr100.dll or msvcp100.dll, install the Visual C++ 2010 runtime redistributable x86.