lluserauth.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lluserauth.h
  3.  * @brief LLUserAuth class header file
  4.  *
  5.  * $LicenseInfo:firstyear=2003&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2003-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LLUSERAUTH_H
  33. #define LLUSERAUTH_H
  34. #include <string>
  35. #include <vector>
  36. #include <map>
  37. #include "llsingleton.h"
  38. typedef struct _xmlrpc_value* XMLRPC_VALUE;
  39. // forward ecl of types from xlrpc.h
  40. class LLXMLRPCTransaction;
  41. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42. // Class LLUserAuth
  43. //
  44. // This class encapsulates the authentication and initialization from
  45. // the login server. Construct an instance of this object, and call
  46. // the authenticate() method, and call authResponse() until it returns
  47. // a non-negative value. If that method returns E_OK, you can start
  48. // asking for responses via the getResponse() method. Here is some
  49. // sample code that gets the session id if login was successful:
  50. //
  51. //  auth.authenticate(...);
  52. //  while((auth.authResponse() < 0)) {sleep(1);}
  53. //  LLUUID session_id;
  54. //  if(0 == strcmp(auth.getResponse("login"), "true"))
  55. //  {
  56. //    const char* session_id_str = auth.getResponse("session-id");
  57. //    if(session_id_str) session_id.set(session_id_str);
  58. //  }
  59. //
  60. // Format for responses as maintained in login.cgi:
  61. // login = 'true' | 'false'
  62. // reason = [ 'data'  |    -- insufficient or poorly formatted data
  63. //            'ban' |      -- user is banned
  64. //            'update' |   -- viewer requires update
  65. //            'optional' | -- optional viewer update
  66. //            'key' |      -- mismatched first/last/passwd
  67. // message = human readable message for client
  68. // session-id = auth key
  69. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  70. class LLUserAuth : public LLSingleton<LLUserAuth>
  71. {
  72. public:
  73. LLUserAuth();
  74. ~LLUserAuth();
  75. // These codes map to the curl return codes...
  76. typedef enum {
  77. E_NO_RESPONSE_YET = -2,
  78. E_DOWNLOADING = -1,
  79. E_OK = 0,
  80. E_COULDNT_RESOLVE_HOST,
  81. E_SSL_PEER_CERTIFICATE,
  82. E_SSL_CACERT,
  83. E_SSL_CONNECT_ERROR,
  84. E_UNHANDLED_ERROR,
  85. E_LAST // never use!
  86. } UserAuthcode;
  87. // used for holding options
  88. typedef std::map<std::string, std::string> response_t;
  89. typedef std::vector<response_t> options_t;
  90. // viewer auth version
  91. void authenticate(
  92. const std::string& auth_uri,
  93. const std::string& auth_method,
  94. const std::string& firstname,
  95. const std::string& lastname,
  96. LLUUID web_login_key,
  97. const std::string& start,
  98. BOOL skip_optional_update,
  99. BOOL accept_tos,
  100. BOOL accept_critical_message,
  101. BOOL last_exec_froze, 
  102. const std::vector<const char*>& requested_options,
  103. const std::string& hashed_mac,
  104. const std::string& hashed_volume_serial);
  105. // legacy version
  106. void authenticate(
  107. const std::string& auth_uri,
  108. const std::string& auth_method,
  109. const std::string& firstname,
  110. const std::string& lastname,
  111. const std::string& password,
  112. const std::string& start,
  113. BOOL skip_optional_update,
  114. BOOL accept_tos,
  115. BOOL accept_critical_message,
  116. BOOL last_exec_froze, 
  117. const std::vector<const char*>& requested_options,
  118. const std::string& hashed_mac,
  119. const std::string& hashed_volume_serial);
  120. UserAuthcode authResponse();
  121. // clears out internal data cache.
  122. void reset();
  123. std::string errorMessage() const { return mErrorMessage; }
  124. // function to get a direct reponse from the login api by
  125. // name. returns NULL if the named response was not found.
  126. const std::string& getResponse(const std::string& name) const;
  127. BOOL getOptions(const std::string& name, options_t& options) const;
  128. F64 getLastTransferRateBPS() const { return mLastTransferRateBPS; }
  129. private:
  130. LLXMLRPCTransaction* mTransaction;
  131. UserAuthcode mAuthResponse;
  132. std::string mErrorMessage;
  133. // dealing with the XML
  134. typedef std::map<std::string, options_t> all_options_t;
  135. response_t mResponses;
  136. all_options_t mOptions;
  137. UserAuthcode parseResponse();
  138. F64 mLastTransferRateBPS; // bits per second, only valid after a big transfer like inventory
  139. };
  140. #endif /* LLUSERAUTH_H */