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
/*
* Copyright (C) 2024 Mincraft-essnetials
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
* License for more details.
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#![doc = include_str!("../README.md")]
#![forbid(unsafe_code, missing_docs, rustdoc::all)]
#![warn(clippy::pedantic)]
mod code;
mod mojang;
mod oauth;
mod xbox;
mod errors;
// Imports
pub use mojang::AuthInfo as AuthData;
/// Scopes Required for Xbox Live And Minecraft Authentcation.
pub const SCOPE: &str = "XboxLive.signin%20XboxLive.offline_access";
/// A Message for experimental Features.
pub const MESSAGE: &'static str = "\x1b[33mNOTICE: You are using and Experiemntal Feature.\x1b[0m";
/// Minecraft OAuth Authentification Method.
pub struct Oauth {
url: String,
port: u16,
client_id: String,
}
/// Minecraft Device Code Authentification Method.
pub struct DeviceCode {
/// Returns the url
pub url: String,
/// Returns the instuctions
pub message: String,
/// Provides expires
pub expires_in: u32,
/// The code you give to the user
pub user_code: String,
/// Device code for the Code:authenticate_device Proccess
pub device_code: String,
client_id: String,
}
/// Implemation of the oauth.
impl Oauth {
/// Creates a new instance of Oauth.
pub fn new(clientid: &str, port: Option<u16>) -> Self {
// Uses port 8000 by deafult but the optional u16 is avalible if needed.
let port = port.unwrap_or(8000);
// Request Mode for params.
const REQUEST_MODE: &str = "query";
// Request Type for params.
const REQUEST_TYPE: &str = "code";
// Creates the url with the params that microsoft needs.
let params = format!("client_id={}&response_type={}&redirect_uri=http://localhost:{}&response_mode={}&scope={}&state=12345", clientid, REQUEST_TYPE, port, REQUEST_MODE, SCOPE);
// Create the url for microsoft authentcation.
let url = format!(
"https://login.microsoftonline.com/consumers/oauth2/v2.0/authorize/?{}",
params
);
// Returns the port and url as self.
Self {
url,
port,
client_id: clientid.to_string(),
}
}
/// Returns the url from the new instance.
pub fn url(&self) -> &str {
&self.url
}
/// Launches the Minecraft Oauth Authentifcation proccess.
/// Note: Please Keep your client Secret Safe.
pub async fn launch(
&self,
bedrockrelm: bool,
client_secret: &str,
) -> Result<AuthData, Box<dyn std::error::Error>> {
// Launches the temporary http server.
let http_server = oauth::server(self.port).await?;
let token = oauth::token(
http_server
.code
.expect("\x1b[31mXbox Expected code.\x1b[0m")
.as_str(),
&self.client_id,
self.port,
&client_secret,
)
.await?;
// Launches the Xbox UserHash And Xbl Token Process.
let xbox = xbox::xbl(&token.access_token).await?;
// Launches the Xsts Token Process.
let xts = xbox::xsts_token(
// Gets the token from the xbox struct.
&xbox.token,
// Gets the bedrockRelm from input.
bedrockrelm,
)
.await?;
// Checks if bedrockrelm is true if true then returns just the xts token.
if bedrockrelm == true {
return Ok(AuthData {
// Sets the access token to null.
access_token: "null".to_string(),
// Sets the uuid to null.
uuid: "null".to_string(),
// Sets the expires in to null.
expires_in: 0,
// Sets the xts token to the xts token.
xts_token: Some(xts.token),
});
} else {
// Returns just the access Token and UUID For Luanching
return Ok(mojang::token(&xbox.display_claims.xui[0].uhs, &xts.token).await?);
}
}
}
/// Implemation of the device code.
impl DeviceCode {
/// Proccess to get the code.
pub async fn new(client_id: &str) -> Result<Self, reqwest::Error> {
println!("{}", MESSAGE);
println!("-------");
// Function to start a new device code.
let response_data = code::device_authentication_code(client_id).await?;
let client_id_str = client_id.to_string();
// Returns the outputs as self.
Ok(Self {
url: response_data.verification_uri,
message: response_data.message,
expires_in: response_data.expires_in,
user_code: response_data.user_code,
device_code: response_data.device_code,
client_id: client_id_str,
})
}
/// To Recive details for the device code.
pub fn prelaunch(&self) -> (&str, &str, u32, &str) {
(&self.url, &self.message, self.expires_in, &self.user_code)
}
/// Launches the device code authentifcation.
pub async fn launch(&self, bedrockrelm: bool) -> Result<AuthData, Box<dyn std::error::Error>> {
let token = code::authenticate_device(&self.device_code, &self.client_id).await?;
let xbox = xbox::xbl(&token.token).await?;
let xts = xbox::xsts_token(&xbox.token, bedrockrelm).await?;
if bedrockrelm == true {
return Ok(AuthData {
access_token: "null".to_string(),
uuid: "null".to_string(),
expires_in: 0,
// Sets the xts token to the xts token.
xts_token: Some(xts.token),
});
} else {
return Ok(mojang::token(&xbox.display_claims.xui[0].uhs, &xts.token).await?);
}
}
}
/// Tests for the Framework for development
#[cfg(test)]
mod tests {
use super::*;
use dotenv_vault::dotenv;
use std::env;
#[tokio::test]
async fn test_oauth_url() {
let _ = dotenv();
let client_id = env::var("Client_ID").expect("Expected Client ID");
let oauth = Oauth::new(&client_id, None);
let params = format!("client_id={}&response_type=code&redirect_uri=http://localhost:8000&response_mode=query&scope={}&state=12345", client_id, SCOPE);
let expected_url = format!(
"https://login.microsoftonline.com/consumers/oauth2/v2.0/authorize/?{}",
params
);
assert_eq!(oauth.url(), expected_url);
}
#[tokio::test]
async fn test_device_code_prelaunch() {
let _ = dotenv();
let client_id = env::var("Client_ID").expect("Expected Client ID.");
let device_code = DeviceCode::new(&client_id).await.unwrap();
// Act
let (url, message, expires_in, user_code) = device_code.prelaunch();
// Assert
assert_eq!(url, device_code.url);
assert_eq!(message, device_code.message);
assert_eq!(expires_in, device_code.expires_in);
assert_eq!(user_code, device_code.user_code);
}
}