1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
//! A simple, easy-to-use library for interfacing with the Mojang API. //! //! All functions involving IO in this crate are asynchronous and utilize //! async/await. As a result, you will have to use nightly Rust until async/await //! is stabilized. //! //! This crate provides a number of functions: //! //! * Server-side authentication with the Mojang API, used to verify //! that clients have logged in correctly. This is available using the //! [`server_auth`](fn.server_auth.html) function. //! * Obtaining the "server hash" required for authentication, available using //! [`server_hash`](fn.server_hash.html). Since Mojang uses abnormal hash digests //! for obtaining the value, this crate provides a simple way to obtain it. //! //! # Examples //! Authenticating a client on a server: //! ```no_run //! # #[tokio::main] //! # async fn main() -> Result<(), mojang_api::Error> { //! # let shared_secret = [0; 16]; //! # let username = "test"; //! # let public_key = &[0]; //! //! // Obtain the "server hash" //! let server_hash = mojang_api::server_hash( //! "", // Note that the "server ID" is always an empty string //! shared_secret, //! public_key, //! ); //! //! // Make the API request //! let response = mojang_api::server_auth(&server_hash, username).await?; //! //! // Now do something with it... //! # Ok(()) //! # } //! ``` #![forbid(unsafe_code, missing_docs, missing_debug_implementations, warnings)] #![doc(html_root_url = "https://docs.rs/mojang-api/0.6.1")] use lazy_static::lazy_static; use log::trace; use num_bigint::BigInt; use reqwest::header::CONTENT_TYPE; use reqwest::{Client, StatusCode}; use serde::{Deserialize, Serialize}; use serde_json::json; use sha1::Sha1; use std::fmt; use std::fmt::{Display, Formatter}; use std::io; use std::string::FromUtf8Error; use uuid::Uuid; type StdResult<T, E> = std::result::Result<T, E>; /// Result type used by this crate. This is equivalent /// to `std::result::Result<T, mojang_api::Error>`. pub type Result<T> = StdResult<T, Error>; lazy_static! { static ref CLIENT_TOKEN: Uuid = Uuid::new_v4(); } /// Error type for this crate. #[derive(Debug)] pub enum Error { /// Indicates that an IO error occurred. Io(io::Error), /// Indicates that an HTTP error occurred. Http(reqwest::Error), /// Indicates that the UTF8 bytes failed to parse. Utf8(FromUtf8Error), /// Indicates that the response included malformed JSON. /// This could also indicate that, for example, authentication /// failed, because the response would have unexpected fields. Json(serde_json::Error), /// Client authentication returned an incorrect status code. ClientAuthFailure(String, u32), } impl Display for Error { fn fmt(&self, f: &mut Formatter) -> StdResult<(), fmt::Error> { match self { Error::Io(e) => write!(f, "{}", e)?, Error::Http(e) => write!(f, "{}", e)?, Error::Utf8(e) => write!(f, "{}", e)?, Error::Json(e) => write!(f, "{}", e)?, Error::ClientAuthFailure(body, code) => write!( f, "client authentication did not return OK: body {}, response code {}", body, code )?, } Ok(()) } } impl PartialEq for Error { fn eq(&self, other: &Self) -> bool { match (self, other) { (Error::Io(e1), Error::Io(e2)) => e1.to_string() == e2.to_string(), (Error::Http(e1), Error::Http(e2)) => e1.to_string() == e2.to_string(), (Error::Utf8(e1), Error::Utf8(e2)) => e1.to_string() == e2.to_string(), (Error::Json(e1), Error::Json(e2)) => e1.to_string() == e2.to_string(), _ => false, } } } impl std::error::Error for Error {} /// Represents the response received when performing /// server-side authentication with the Mojang API. /// /// The response includes the player's UUID, username, /// and optionally some `ProfileProperty`s, which may /// represent, for example, the player's skin. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] pub struct ServerAuthResponse { /// The UUID of the player. pub id: Uuid, /// The current username of the player. pub name: String, /// The player's profile properties. #[serde(default)] // If none returned, use empty vector pub properties: Vec<ProfileProperty>, } /// Represents a profile property returned in the server /// authentication request. /// /// The most common profile property is called "textures" /// and contains the skin of the player. /// /// Note that both `value` and `signature` are base64-encoded /// strings. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] pub struct ProfileProperty { /// The name of this profile property. pub name: String, /// The base64-encoded value of this profile property. pub value: String, /// The signature of this profile property, signed with Yggdrasil's private key. pub signature: String, } /// Performs server-side authentication using the given server hash /// and username. /// /// The server hash can be retrieved using [`server_hash`](fn.server_hash.html). /// Obtaining it requires the server's public RSA key and the secret key /// being used for encryption with the client. /// /// Performing this request also requires the client's username. /// Servers should use the value sent in the Login Start packet. /// /// The request is performed asynchronously, and this function is `async`. /// /// See [wiki.vg](https://wiki.vg/Protocol_Encryption#Server) for more /// information. /// /// # Examples /// ```no_run /// # #[tokio::main] /// # async fn main() -> Result<(), mojang_api::Error> { /// # fn server_hash() -> String { "".to_string() } /// # fn username() -> String { "".to_string() } /// // Obtain the server hash and username... /// let hash = server_hash(); /// let username = username(); /// /// // Make the API request /// let response = mojang_api::server_auth(&hash, &username).await?; /// # Ok(()) /// # } /// ``` pub async fn server_auth(server_hash: &str, username: &str) -> Result<ServerAuthResponse> { #[cfg(not(test))] let url = format!( "https://sessionserver.mojang.com/session/minecraft/hasJoined?username={}&serverId={}&unsigned=false", username, server_hash ); #[cfg(test)] let url = format!("{}/{}/{}", mockito::server_url(), username, server_hash,); let string = Client::new() .get(&url) .send() .await .map_err(Error::Http)? .text() .await .map_err(Error::Http)?; trace!("Authentication response: {}", string); let response = serde_json::from_str(&string).map_err(Error::Json)?; Ok(response) } /// Computes the "server hash" required for authentication /// based on the server ID, the shared secret used for /// communication with the client, and the server's /// public RSA key. /// /// On modern Minecraft versions, the server ID /// is always an empty string. /// /// # Examples /// ``` /// # fn shared_secret() -> [u8; 16] { [0; 16] } /// # fn pub_key() -> &'static [u8] { &[1] } /// let hash = mojang_api::server_hash("", shared_secret(), pub_key()); /// ``` pub fn server_hash(server_id: &str, shared_secret: [u8; 16], pub_key: &[u8]) -> String { let mut hasher = Sha1::new(); hasher.update(server_id.as_bytes()); hasher.update(&shared_secret); hasher.update(pub_key); hexdigest(&hasher) } /// Generates a digest for the given hasher using /// Minecraft's unorthodox hex digestion method. /// /// # Examples /// ``` /// use sha1::Sha1; /// let mut hasher = Sha1::new(); /// hasher.update(b"Notch"); /// assert_eq!( /// mojang_api::hexdigest(&hasher), /// "4ed1f46bbe04bc756bcb17c0c7ce3e4632f06a48" /// ); /// ``` pub fn hexdigest(hasher: &Sha1) -> String { let output = hasher.digest().bytes(); let bigint = BigInt::from_signed_bytes_be(&output); format!("{:x}", bigint) } /// Represents the response received from the client authentication endpoint. /// /// The response includes an access token, used for client-side authentication, /// as well as information about the user which was authenticated. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] #[serde(rename_all = "camelCase")] pub struct ClientLoginResponse { /// The access token which can later be used for client-side authentication /// when logging into a server. pub access_token: String, /// Contains information about the user which authenticated. pub user: User, /// Contains information about the user profile. #[serde(rename = "selectedProfile")] pub profile: SelectedProfile, } /// Information about a user's profile, including their name, UUID, etc. Similar to `User`. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] pub struct SelectedProfile { /// UUID. #[serde(rename = "id")] pub uuid: Uuid, /// Username. pub name: String, } /// Information about a user, including UUID, email, username, etc. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] #[serde(rename_all = "camelCase")] pub struct User { /// User ID. pub id: String, /// User's email. pub email: Option<String>, /// Username. pub username: String, // TODO: properties } /// Authenticates a user, returning a client access token and metadata for the user. /// /// The returned access token can later be used with `client_auth` to log in to a server. /// /// # Examples /// ```no_run /// # #[tokio::main] /// # async fn main() -> mojang_api::Result<()> { /// let response: mojang_api::ClientLoginResponse = mojang_api::client_login("username", "password").await?; /// println!("Access token: {}", response.access_token); /// println!("User email: {}", response.user.email); /// # Ok(()) /// # } /// ``` pub async fn client_login(username: &str, password: &str) -> Result<ClientLoginResponse> { #[cfg(test)] let url = format!("{}/authenticate", mockito::server_url()); #[cfg(not(test))] let url = String::from("https://authserver.mojang.com/authenticate"); let client_token = *CLIENT_TOKEN; let payload = json!({ "agent": { "name": "Minecraft", "version": 1 }, "username": username, "password": password, "clientToken": client_token, "requestUser": true }) .to_string(); let client = Client::new(); let response = client .post(&url) .header(CONTENT_TYPE, "application/json") .body(payload) .send() .await .map_err(Error::Http)? .text() .await .map_err(Error::Http)?; serde_json::from_str(&response).map_err(Error::Json) } /// Performs client-side authentication with the given access /// token and server hash. /// /// The access token can be obtained using `client_login`; /// the server hash can be computed with `server_hash`. /// /// This API endpoint returns no response. If all goes well, /// then no error will be returned, and the client can proceed /// with the login process. /// /// # Examples /// ```no_run /// # #[tokio::main] async fn main() -> mojang_api::Result<()> { /// let login = mojang_api::client_login("username", "password").await?; /// let server_hash = mojang_api::server_hash("", [0u8; 16], &[1]); /// /// mojang_api::client_auth(&login.access_token, login.profile.uuid, &server_hash); /// # Ok(()) /// # } /// ``` pub async fn client_auth(access_token: &str, uuid: Uuid, server_hash: &str) -> Result<()> { #[cfg(not(test))] let url = String::from("https://sessionserver.mojang.com/session/minecraft/join"); #[cfg(test)] let url = mockito::server_url(); let selected_profile = uuid.to_simple().to_string(); let payload = json!({ "accessToken": access_token, "selectedProfile": selected_profile, "serverId": server_hash }); let client = Client::new(); let response = client .post(&url) .header(CONTENT_TYPE, "application/json") .body(payload.to_string()) .send() .await .map_err(Error::Http)?; let status = response.status(); if status != StatusCode::NO_CONTENT { return Err(Error::ClientAuthFailure( response.text().await.map_err(Error::Http)?, status.as_u16() as u32, )); } Ok(()) } #[cfg(test)] mod tests { use super::*; use std::io::ErrorKind; use uuid::Uuid; #[test] fn test_error_equality() { assert_eq!( Error::Io(io::Error::new(ErrorKind::NotFound, "Test error")), Error::Io(io::Error::new(ErrorKind::NotFound, "Test error")) ); assert_ne!( Error::Io(io::Error::new(ErrorKind::NotFound, "Test error")), Error::Io(io::Error::new(ErrorKind::NotFound, "Different test error")) ); } #[test] fn test_hexdigest() { // Examples from wiki.vg let mut hasher = Sha1::new(); hasher.update(b"Notch"); assert_eq!( hexdigest(&hasher), "4ed1f46bbe04bc756bcb17c0c7ce3e4632f06a48" ); let mut hasher = Sha1::new(); hasher.update(b"jeb_"); assert_eq!( hexdigest(&hasher), "-7c9d5b0044c130109a5d7b5fb5c317c02b4e28c1" ); let mut hasher = Sha1::new(); hasher.update(b"simon"); assert_eq!( hexdigest(&hasher), "88e16a1019277b15d58faf0541e11910eb756f6" ); } #[tokio::test] async fn test_server_auth() -> Result<()> { let uuid = Uuid::new_v4(); let username = "test_"; let prop_name = "test_prop"; let prop_val = "test_val"; let prop_signature = "jioiodqwqiowoiqf"; let prop = ProfileProperty { name: prop_name.to_string(), value: prop_val.to_string(), signature: prop_signature.to_string(), }; let response = ServerAuthResponse { name: username.to_string(), id: uuid, properties: vec![prop], }; println!("{}", serde_json::to_string(&response).unwrap()); let hash = server_hash("", [0; 16], &[0]); let _m = mockito::mock("GET", format!("/{}/{}", username, hash).as_str()) .with_body(serde_json::to_string(&response).unwrap()) .create(); let result = server_auth(&hash, username).await?; assert_eq!(result.id, uuid); assert_eq!(result.name, username); assert_eq!(result.properties.len(), 1); let prop = result.properties.first().unwrap(); assert_eq!(prop.name, prop_name); assert_eq!(prop.value, prop_val); assert_eq!(prop.signature, prop_signature); Ok(()) } #[tokio::test] async fn test_client_login() { let expected_response = ClientLoginResponse { access_token: String::from("test_29408"), user: User { id: Uuid::new_v4().to_string(), email: Some("test@example.com".to_string()), username: "test".to_string(), }, profile: SelectedProfile { uuid: Default::default(), name: "".to_string(), }, }; let _m = mockito::mock("POST", "/authenticate") .with_body(serde_json::to_string(&expected_response).unwrap()) .create(); let response = client_login("test", "password").await.unwrap(); assert_eq!(response, expected_response); } }