ryzom/common/src/game_share/security_check.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2013  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #ifndef NL_SECURITY_CHECK_H
  21 #define NL_SECURITY_CHECK_H
  22
  23 #include "nel/misc/types_nl.h"
  24 #include "nel/net/login_cookie.h"
  25 #include "nel/misc/md5.h"
  26 #include "game_share/r2_basic_types.h"
  27
  28
  29 /**
  30  * CSecurityCode
  31  */
  32 class CSecurityCode
  33 {
  34 public:
  35         CSecurityCode() : AsNum(0) {}
  36         void serial( NLMISC::IStream& s ) { s.serial(AsNum); } // dependency on msg.xml:CLIENT_QUIT_REQUEST format
  37 private:
  38         union
  39         {
  40                 uint8 Data [2];
  41                 uint16 AsNum;
  42         };
  43
  44         friend class CSecurityCheckForFastDisconnection;
  45         friend bool operator!=( const CSecurityCode& sc1, const CSecurityCode& sc2 );
  46 };
  47
  48 inline bool operator!=( const CSecurityCode& sc1, const CSecurityCode& sc2 )
  49 {
  50         return sc1.AsNum != sc2.AsNum;
  51 }
  52
  53
  54 /**
  55  * CSecurityCheckForFastDisconnection
  56  */
  57 class CSecurityCheckForFastDisconnection
  58 {
  59 public:
  60         /// Default constructor
  61         CSecurityCheckForFastDisconnection();
  62         /// Set session (or can be set by receiveSecurityCode())
  63         void setSessionId(TSessionId sessionId) { Block.SessionId = sessionId; }
  64         /// Set cookie
  65         void setCookie(const NLNET::CLoginCookie& cookie) { Block.Cookie.set(cookie.getUserAddr(), cookie.getUserKey(), cookie.getUserId()); } // don't use the default generated bitwise assignment operator, because of padding junk that would be copied
  66         /// Return the security code
  67         CSecurityCode encode(const char *passPhrase);
  68         /// Check  the security code
  69         void check(const char *passPhrase);
  70
  71         /// Read some data from stream
  72         void receiveSecurityCode(NLMISC::IStream& msgin);
  73         /// Write some data to stream
  74         static void forwardSecurityCode(NLMISC::IStream& msgout, TSessionId sessionId, CSecurityCode& securityCode);
  75
  76 private:
  77         struct CBlock
  78         {
  79                 TSessionId SessionId;
  80                 NLNET::CLoginCookie Cookie;
  81                 char PassPhrase [10];
  82         };
  83         CBlock Block;
  84         CSecurityCode SecurityCode;
  85 };
  86
  87 #endif // NL_SECURITY_CHECK_H
  88
  89 /* End of security_check.h */