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 500 501 502
//! Authentication Flow interface
use std::collections::BTreeMap;
use std::fmt;
use crate::routing::Route;
use crate::types::auth::AccessToken;
use crate::types::Message;
use crate::Modio;
use crate::Result;
pub use crate::types::auth::{Link, Links, Terms};
/// [mod.io](https://mod.io) credentials. API key with optional OAuth2 access token.
#[derive(Clone, Eq, PartialEq)]
pub struct Credentials {
pub api_key: String,
pub token: Option<Token>,
}
/// Access token and optional Unix timestamp of the date this token will expire.
#[derive(Clone, Eq, PartialEq)]
pub struct Token {
pub value: String,
pub expired_at: Option<u64>,
}
impl fmt::Debug for Credentials {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if self.token.is_some() {
f.write_str("Credentials(apikey+token)")
} else {
f.write_str("Credentials(apikey)")
}
}
}
impl Credentials {
pub fn new<S: Into<String>>(api_key: S) -> Credentials {
Credentials {
api_key: api_key.into(),
token: None,
}
}
pub fn with_token<S: Into<String>, T: Into<String>>(api_key: S, token: T) -> Credentials {
Credentials {
api_key: api_key.into(),
token: Some(Token {
value: token.into(),
expired_at: None,
}),
}
}
}
impl From<&str> for Credentials {
fn from(api_key: &str) -> Credentials {
Credentials::new(api_key)
}
}
impl From<(&str, &str)> for Credentials {
fn from((api_key, token): (&str, &str)) -> Credentials {
Credentials::with_token(api_key, token)
}
}
impl From<String> for Credentials {
fn from(api_key: String) -> Credentials {
Credentials::new(api_key)
}
}
impl From<(String, String)> for Credentials {
fn from((api_key, token): (String, String)) -> Credentials {
Credentials::with_token(api_key, token)
}
}
/// Authentication Flow interface to retrieve access tokens. See the [mod.io Authentication
/// docs](https://docs.mod.io/#email-exchange) for more information.
///
/// # Example
/// ```no_run
/// use std::io::{self, Write};
///
/// use modio::{Credentials, Modio, Result};
///
/// fn prompt(prompt: &str) -> io::Result<String> {
/// print!("{}", prompt);
/// io::stdout().flush()?;
/// let mut buffer = String::new();
/// io::stdin().read_line(&mut buffer)?;
/// Ok(buffer.trim().to_string())
/// }
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let modio = Modio::new(Credentials::new("api-key"))?;
///
/// let email = prompt("Enter email: ").expect("read email");
/// modio.auth().request_code(&email).await?;
///
/// let code = prompt("Enter security code: ").expect("read code");
/// let token = modio.auth().security_code(&code).await?;
///
/// // Consume the endpoint and create an endpoint with new credentials.
/// let _modio = modio.with_credentials(token);
///
/// Ok(())
/// }
/// ```
#[derive(Clone)]
pub struct Auth {
modio: Modio,
}
impl Auth {
pub(crate) fn new(modio: Modio) -> Self {
Self { modio }
}
/// Get text and links for user agreement and consent prior to authentication. [required: apikey]
///
/// See the [mod.io docs](https://docs.mod.io/#terms) for more information.
pub async fn terms(self) -> Result<Terms> {
self.modio.request(Route::Terms).send().await
}
/// Request a security code be sent to the email of the user. [required: apikey]
pub async fn request_code(self, email: &str) -> Result<()> {
self.modio
.request(Route::OAuthEmailRequest)
.form(&[("email", email)])
.send::<Message>()
.await?;
Ok(())
}
/// Get the access token for a security code. [required: apikey]
pub async fn security_code(self, code: &str) -> Result<Credentials> {
let t = self
.modio
.request(Route::OAuthEmailExchange)
.form(&[("security_code", code)])
.send::<AccessToken>()
.await?;
let token = Token {
value: t.value,
expired_at: t.expired_at,
};
Ok(Credentials {
api_key: self.modio.inner.credentials.api_key.clone(),
token: Some(token),
})
}
/// Authenticate via external services ([Steam], [Switch], [Xbox], [Discord], [Oculus], [Google]).
///
/// See the [mod.io docs](https://docs.mod.io/#authentication-2) for more information.
///
/// [Steam]: SteamOptions
/// [Oculus]: OculusOptions
/// [Switch]: SwitchOptions
/// [Xbox]: XboxOptions
/// [Discord]: DiscordOptions
/// [Google]: GoogleOptions
///
/// # Examples
///
/// ```no_run
/// # use modio::{Credentials, Modio, Result};
/// # #[tokio::main]
/// # async fn run() -> Result<()> {
/// # let modio = modio::Modio::new("apikey")?;
/// use modio::auth::SteamOptions;
/// let opts = SteamOptions::new("ticket");
/// modio.auth().external(opts).await?;
/// # Ok(())
/// # }
/// ```
pub async fn external<T>(self, auth_options: T) -> Result<Credentials>
where
T: Into<AuthOptions>,
{
let AuthOptions { route, params } = auth_options.into();
let t = self
.modio
.request(route)
.form(¶ms)
.send::<AccessToken>()
.await?;
let token = Token {
value: t.value,
expired_at: t.expired_at,
};
Ok(Credentials {
api_key: self.modio.inner.credentials.api_key.clone(),
token: Some(token),
})
}
/// Logout by revoking the current access token.
pub async fn logout(self) -> Result<()> {
self.modio
.request(Route::OAuthLogout)
.send::<Message>()
.await?;
Ok(())
}
}
/// Options for external authentication.
pub struct AuthOptions {
route: Route,
params: BTreeMap<&'static str, String>,
}
// impl From<*Options> for AuthOptions {{{
impl From<OculusOptions> for AuthOptions {
fn from(options: OculusOptions) -> AuthOptions {
AuthOptions {
route: Route::ExternalAuthMeta,
params: options.params,
}
}
}
impl From<SteamOptions> for AuthOptions {
fn from(options: SteamOptions) -> AuthOptions {
AuthOptions {
route: Route::ExternalAuthSteam,
params: options.params,
}
}
}
impl From<SwitchOptions> for AuthOptions {
fn from(options: SwitchOptions) -> AuthOptions {
AuthOptions {
route: Route::ExternalAuthSwitch,
params: options.params,
}
}
}
impl From<XboxOptions> for AuthOptions {
fn from(options: XboxOptions) -> AuthOptions {
AuthOptions {
route: Route::ExternalAuthXbox,
params: options.params,
}
}
}
impl From<DiscordOptions> for AuthOptions {
fn from(options: DiscordOptions) -> AuthOptions {
AuthOptions {
route: Route::ExternalAuthDiscord,
params: options.params,
}
}
}
impl From<GoogleOptions> for AuthOptions {
fn from(options: GoogleOptions) -> AuthOptions {
AuthOptions {
route: Route::ExternalAuthGoogle,
params: options.params,
}
}
}
// }}}
/// Authentication options for an encrypted gog app ticket.
///
/// See the [mod.io docs](https://docs.mod.io/#gog-galaxy) for more information.
pub struct GalaxyOptions {
params: BTreeMap<&'static str, String>,
}
impl GalaxyOptions {
pub fn new<T>(ticket: T) -> Self
where
T: Into<String>,
{
let mut params = BTreeMap::new();
params.insert("appdata", ticket.into());
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a common year.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
/// Authentication options for an itch.io JWT token.
///
/// See the [mod.io docs](https://docs.mod.io/#itch-io) for more information.
pub struct ItchioOptions {
params: BTreeMap<&'static str, String>,
}
impl ItchioOptions {
pub fn new<T>(token: T) -> Self
where
T: Into<String>,
{
let mut params = BTreeMap::new();
params.insert("itchio_token", token.into());
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a week.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
/// Authentication options for an Oculus user.
///
/// See the [mod.io docs](https://docs.mod.io/#meta-quest) for more information.
pub struct OculusOptions {
params: BTreeMap<&'static str, String>,
}
impl OculusOptions {
pub fn new_for_quest<T>(nonce: T, user_id: u64, auth_token: T) -> Self
where
T: Into<String>,
{
OculusOptions::new("quest".to_owned(), nonce.into(), user_id, auth_token.into())
}
pub fn new_for_rift<T>(nonce: T, user_id: u64, auth_token: T) -> Self
where
T: Into<String>,
{
OculusOptions::new("rift".to_owned(), nonce.into(), user_id, auth_token.into())
}
fn new(device: String, nonce: String, user_id: u64, auth_token: String) -> Self {
let mut params = BTreeMap::new();
params.insert("device", device);
params.insert("nonce", nonce);
params.insert("user_id", user_id.to_string());
params.insert("auth_token", auth_token);
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a common year.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
/// Authentication options for an encrypted steam app ticket.
///
/// See the [mod.io docs](https://docs.mod.io/#steam) for more information.
pub struct SteamOptions {
params: BTreeMap<&'static str, String>,
}
impl SteamOptions {
pub fn new<T>(ticket: T) -> Self
where
T: Into<String>,
{
let mut params = BTreeMap::new();
params.insert("appdata", ticket.into());
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a common year.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
/// Authentication options for the NSA ID token.
///
/// See the [mod.io docs](https://docs.mod.io/#nintendo-switch) for more information.
pub struct SwitchOptions {
params: BTreeMap<&'static str, String>,
}
impl SwitchOptions {
pub fn new<T>(id_token: T) -> Self
where
T: Into<String>,
{
let mut params = BTreeMap::new();
params.insert("id_token", id_token.into());
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a common year.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
/// Authentication options for an Xbox Live token.
///
/// See the [mod.io docs](https://docs.mod.io/#xbox-live) for more information.
pub struct XboxOptions {
params: BTreeMap<&'static str, String>,
}
impl XboxOptions {
pub fn new<T>(token: T) -> Self
where
T: Into<String>,
{
let mut params = BTreeMap::new();
params.insert("xbox_token", token.into());
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a common year.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
/// Authentication options for an Discord token.
///
/// See the [mod.io docs](https://docs.mod.io/#discord) for more information.
pub struct DiscordOptions {
params: BTreeMap<&'static str, String>,
}
impl DiscordOptions {
pub fn new<T>(token: T) -> Self
where
T: Into<String>,
{
let mut params = BTreeMap::new();
params.insert("discord_token", token.into());
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a week.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
/// Authentication options for an Google token.
///
/// See the [mod.io docs](https://docs.mod.io/#google) for more information.
pub struct GoogleOptions {
params: BTreeMap<&'static str, String>,
}
impl GoogleOptions {
pub fn new<T>(token: T) -> Self
where
T: Into<String>,
{
let mut params = BTreeMap::new();
params.insert("id_token", token.into());
Self { params }
}
option!(email >> "email");
option!(
/// Unix timestamp of date in which the returned token will expire. Value cannot be higher
/// than the default value which is a week.
expired_at u64 >> "date_expires"
);
option!(terms_agreed bool >> "terms_agreed");
}
// vim: fdm=marker