mirror of
				https://github.com/PabloMK7/citra.git
				synced 2025-10-30 21:30:04 +00:00 
			
		
		
		
	WebService: Verify username and token (#2930)
* WebService: Verify username and token; Log errors in PostJson * Fixup: added docstrings to the functions * Webservice: Added Icons to the verification, imrpved error detection in cpr, fixup nits * fixup: fmt warning
This commit is contained in:
		
							parent
							
								
									255fd8768d
								
							
						
					
					
						commit
						28c726f205
					
				
					 18 changed files with 322 additions and 38 deletions
				
			
		|  | @ -1,10 +1,12 @@ | |||
| set(SRCS | ||||
|             telemetry_json.cpp | ||||
|             verify_login.cpp | ||||
|             web_backend.cpp | ||||
|             ) | ||||
| 
 | ||||
| set(HEADERS | ||||
|             telemetry_json.h | ||||
|             verify_login.h | ||||
|             web_backend.h | ||||
|             ) | ||||
| 
 | ||||
|  |  | |||
							
								
								
									
										28
									
								
								src/web_service/verify_login.cpp
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								src/web_service/verify_login.cpp
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,28 @@ | |||
| // Copyright 2017 Citra Emulator Project
 | ||||
| // Licensed under GPLv2 or any later version
 | ||||
| // Refer to the license.txt file included.
 | ||||
| 
 | ||||
| #include <json.hpp> | ||||
| #include "web_service/verify_login.h" | ||||
| #include "web_service/web_backend.h" | ||||
| 
 | ||||
| namespace WebService { | ||||
| 
 | ||||
| std::future<bool> VerifyLogin(std::string& username, std::string& token, | ||||
|                               const std::string& endpoint_url, std::function<void()> func) { | ||||
|     auto get_func = [func, username](const std::string& reply) -> bool { | ||||
|         func(); | ||||
|         if (reply.empty()) | ||||
|             return false; | ||||
|         nlohmann::json json = nlohmann::json::parse(reply); | ||||
|         std::string result; | ||||
|         try { | ||||
|             result = json["username"]; | ||||
|         } catch (const nlohmann::detail::out_of_range&) { | ||||
|         } | ||||
|         return result == username; | ||||
|     }; | ||||
|     return GetJson<bool>(get_func, endpoint_url, false, username, token); | ||||
| } | ||||
| 
 | ||||
| } // namespace WebService
 | ||||
							
								
								
									
										24
									
								
								src/web_service/verify_login.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								src/web_service/verify_login.h
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,24 @@ | |||
| // Copyright 2017 Citra Emulator Project
 | ||||
| // Licensed under GPLv2 or any later version
 | ||||
| // Refer to the license.txt file included.
 | ||||
| 
 | ||||
| #pragma once | ||||
| 
 | ||||
| #include <functional> | ||||
| #include <future> | ||||
| #include <string> | ||||
| 
 | ||||
| namespace WebService { | ||||
| 
 | ||||
| /**
 | ||||
|  * Checks if username and token is valid | ||||
|  * @param username Citra username to use for authentication. | ||||
|  * @param token Citra token to use for authentication. | ||||
|  * @param endpoint_url URL of the services.citra-emu.org endpoint. | ||||
|  * @param func A function that gets exectued when the verification is finished | ||||
|  * @returns Future with bool indicating whether the verification succeeded | ||||
|  */ | ||||
| std::future<bool> VerifyLogin(std::string& username, std::string& token, | ||||
|                               const std::string& endpoint_url, std::function<void()> func); | ||||
| 
 | ||||
| } // namespace WebService
 | ||||
|  | @ -18,6 +18,19 @@ static constexpr char API_VERSION[]{"1"}; | |||
| 
 | ||||
| static std::unique_ptr<cpr::Session> g_session; | ||||
| 
 | ||||
| void Win32WSAStartup() { | ||||
| #ifdef _WIN32 | ||||
|     // On Windows, CPR/libcurl does not properly initialize Winsock. The below code is used to
 | ||||
|     // initialize Winsock globally, which fixes this problem. Without this, only the first CPR
 | ||||
|     // session will properly be created, and subsequent ones will fail.
 | ||||
|     WSADATA wsa_data; | ||||
|     const int wsa_result{WSAStartup(MAKEWORD(2, 2), &wsa_data)}; | ||||
|     if (wsa_result) { | ||||
|         LOG_CRITICAL(WebService, "WSAStartup failed: %d", wsa_result); | ||||
|     } | ||||
| #endif | ||||
| } | ||||
| 
 | ||||
| void PostJson(const std::string& url, const std::string& data, bool allow_anonymous, | ||||
|               const std::string& username, const std::string& token) { | ||||
|     if (url.empty()) { | ||||
|  | @ -31,16 +44,7 @@ void PostJson(const std::string& url, const std::string& data, bool allow_anonym | |||
|         return; | ||||
|     } | ||||
| 
 | ||||
| #ifdef _WIN32 | ||||
|     // On Windows, CPR/libcurl does not properly initialize Winsock. The below code is used to
 | ||||
|     // initialize Winsock globally, which fixes this problem. Without this, only the first CPR
 | ||||
|     // session will properly be created, and subsequent ones will fail.
 | ||||
|     WSADATA wsa_data; | ||||
|     const int wsa_result{WSAStartup(MAKEWORD(2, 2), &wsa_data)}; | ||||
|     if (wsa_result) { | ||||
|         LOG_CRITICAL(WebService, "WSAStartup failed: %d", wsa_result); | ||||
|     } | ||||
| #endif | ||||
|     Win32WSAStartup(); | ||||
| 
 | ||||
|     // Built request header
 | ||||
|     cpr::Header header; | ||||
|  | @ -56,8 +60,81 @@ void PostJson(const std::string& url, const std::string& data, bool allow_anonym | |||
|     } | ||||
| 
 | ||||
|     // Post JSON asynchronously
 | ||||
|     static cpr::AsyncResponse future; | ||||
|     future = cpr::PostAsync(cpr::Url{url.c_str()}, cpr::Body{data.c_str()}, header); | ||||
|     static std::future<void> future; | ||||
|     future = cpr::PostCallback( | ||||
|         [](cpr::Response r) { | ||||
|             if (r.error) { | ||||
|                 LOG_ERROR(WebService, "POST returned cpr error: %u:%s", | ||||
|                           static_cast<u32>(r.error.code), r.error.message.c_str()); | ||||
|                 return; | ||||
|             } | ||||
|             if (r.status_code >= 400) { | ||||
|                 LOG_ERROR(WebService, "POST returned error status code: %u", r.status_code); | ||||
|                 return; | ||||
|             } | ||||
|             if (r.header["content-type"].find("application/json") == std::string::npos) { | ||||
|                 LOG_ERROR(WebService, "POST returned wrong content: %s", | ||||
|                           r.header["content-type"].c_str()); | ||||
|                 return; | ||||
|             } | ||||
|         }, | ||||
|         cpr::Url{url}, cpr::Body{data}, header); | ||||
| } | ||||
| 
 | ||||
| template <typename T> | ||||
| std::future<T> GetJson(std::function<T(const std::string&)> func, const std::string& url, | ||||
|                        bool allow_anonymous, const std::string& username, | ||||
|                        const std::string& token) { | ||||
|     if (url.empty()) { | ||||
|         LOG_ERROR(WebService, "URL is invalid"); | ||||
|         return std::async(std::launch::async, [func{std::move(func)}]() { return func(""); }); | ||||
|     } | ||||
| 
 | ||||
|     const bool are_credentials_provided{!token.empty() && !username.empty()}; | ||||
|     if (!allow_anonymous && !are_credentials_provided) { | ||||
|         LOG_ERROR(WebService, "Credentials must be provided for authenticated requests"); | ||||
|         return std::async(std::launch::async, [func{std::move(func)}]() { return func(""); }); | ||||
|     } | ||||
| 
 | ||||
|     Win32WSAStartup(); | ||||
| 
 | ||||
|     // Built request header
 | ||||
|     cpr::Header header; | ||||
|     if (are_credentials_provided) { | ||||
|         // Authenticated request if credentials are provided
 | ||||
|         header = {{"Content-Type", "application/json"}, | ||||
|                   {"x-username", username.c_str()}, | ||||
|                   {"x-token", token.c_str()}, | ||||
|                   {"api-version", API_VERSION}}; | ||||
|     } else { | ||||
|         // Otherwise, anonymous request
 | ||||
|         header = cpr::Header{{"Content-Type", "application/json"}, {"api-version", API_VERSION}}; | ||||
|     } | ||||
| 
 | ||||
|     // Get JSON asynchronously
 | ||||
|     return cpr::GetCallback( | ||||
|         [func{std::move(func)}](cpr::Response r) { | ||||
|             if (r.error) { | ||||
|                 LOG_ERROR(WebService, "GET returned cpr error: %u:%s", | ||||
|                           static_cast<u32>(r.error.code), r.error.message.c_str()); | ||||
|                 return func(""); | ||||
|             } | ||||
|             if (r.status_code >= 400) { | ||||
|                 LOG_ERROR(WebService, "GET returned error code: %u", r.status_code); | ||||
|                 return func(""); | ||||
|             } | ||||
|             if (r.header["content-type"].find("application/json") == std::string::npos) { | ||||
|                 LOG_ERROR(WebService, "GET returned wrong content: %s", | ||||
|                           r.header["content-type"].c_str()); | ||||
|                 return func(""); | ||||
|             } | ||||
|             return func(r.text); | ||||
|         }, | ||||
|         cpr::Url{url}, header); | ||||
| } | ||||
| 
 | ||||
| template std::future<bool> GetJson(std::function<bool(const std::string&)> func, | ||||
|                                    const std::string& url, bool allow_anonymous, | ||||
|                                    const std::string& username, const std::string& token); | ||||
| 
 | ||||
| } // namespace WebService
 | ||||
|  |  | |||
|  | @ -4,6 +4,8 @@ | |||
| 
 | ||||
| #pragma once | ||||
| 
 | ||||
| #include <functional> | ||||
| #include <future> | ||||
| #include <string> | ||||
| #include "common/common_types.h" | ||||
| 
 | ||||
|  | @ -20,4 +22,18 @@ namespace WebService { | |||
| void PostJson(const std::string& url, const std::string& data, bool allow_anonymous, | ||||
|               const std::string& username = {}, const std::string& token = {}); | ||||
| 
 | ||||
| /**
 | ||||
|  * Gets JSON from services.citra-emu.org. | ||||
|  * @param func A function that gets exectued when the json as a string is received | ||||
|  * @param url URL of the services.citra-emu.org endpoint to post data to. | ||||
|  * @param allow_anonymous If true, allow anonymous unauthenticated requests. | ||||
|  * @param username Citra username to use for authentication. | ||||
|  * @param token Citra token to use for authentication. | ||||
|  * @return future that holds the return value T of the func | ||||
|  */ | ||||
| template <typename T> | ||||
| std::future<T> GetJson(std::function<T(const std::string&)> func, const std::string& url, | ||||
|                        bool allow_anonymous, const std::string& username = {}, | ||||
|                        const std::string& token = {}); | ||||
| 
 | ||||
| } // namespace WebService
 | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue