doc/md5_hashcheck.txt

   1 //===== rAthena Documentation ================================
   2 //= MD5 Hash Check
   3 //===== By: ==================================================
   4 //= rAthena Dev Team
   5 //===== Last Updated: ========================================
   6 //= 20140208
   7 //===== Description: =========================================
   8 //= This file outlines the login server's MD5 hash check.
   9 //============================================================
  10
  11 The login server is able to perform a check of the client's MD5 hash.
  12 This will ensure that a user has not tampered with the client and that
  13 the client is the one specific to your server.
  14
  15 The client can only send the correct MD5 hash to the server on certain
  16 server types, so a client diff is required to ensure the hash is sent.
  17 Please refer to your client diff tool manual for the appropriate patch,
  18 called "Force Send Client Hash Packet" or a similar name. A link
  19 containing the WeeDiffGen plugin can be found at:
  20 http://rathena.org/board/topic/70841-r16771-client-md5-hash-check/
  21
  22 The server-side settings for the hash check are located in
  23 'conf\login_athena.conf':
  24
  25 // Client MD5 hash check
  26 // If turned on, the login server will check if the client's hash matches
  27 // the value below, and will not connect tampered clients.
  28 // Note: see 'doc/md5_hashcheck.txt' for more details.
  29 client_hash_check: off
  30
  31 // Client MD5 hashes
  32 // The client with the specified hash can be used to log in by players with
  33 // a group_id equal to or greater than the given value.
  34 // If you specify 'disabled' as hash, players with a group_id greater than or
  35 // equal to the given value will be able to log in regardless of hash (and even
  36 // if their client does not send a hash at all.)
  37 // Format: group_id, hash
  38 // Note: see 'doc/md5_hashcheck.txt' for more details.
  39 client_hash: 0, 113e195e6c051bb1cfb12a644bb084c5
  40 client_hash: 10, cb1ea78023d337c38e8ba5124e2338ae
  41 client_hash: 99, disabled
  42
  43 To enable MD5 hash checks, set 'client_hash_check' to 'on' and add one
  44 'client_hash' entry for each client you want to use.
  45 The group_id can be any of the groups in 'conf/groups.conf', and it is
  46 useful in case if you want to allow GMs to use a different client
  47 than normal players; for example, a GM client could be hexed
  48 differently, perhaps with dual-clienting enabled and chat flood
  49 disabled.
  50 You will need to replace the example MD5 hashes with the actual hash of
  51 your client. You can use any MD5 hash tools to generate it, e.g.:
  52 - md5sum (command line) on linux
  53 - WinMD5 on Windows
  54 - md5 (command line) on Mac OS X