Exports

Overview

Complete reference of all exports from lighty-auth and their re-exports in lighty-launcher.

In lighty_auth

Core Trait

use lighty_auth::Authenticator;

Types

use lighty_auth::{
    UserProfile,     // Authenticated user data
    UserRole,        // User role/rank information
    AuthProvider,    // Provider type enum
    AuthResult<T>,   // Result type alias
};

Helper Functions

use lighty_auth::generate_offline_uuid;

Authentication Providers

use lighty_auth::{
    offline::OfflineAuth,
    microsoft::MicrosoftAuth,
    azuriom::AzuriomAuth,
};

Errors

use lighty_auth::AuthError;

In lighty_launcher (Re-exports)

use lighty_launcher::auth::{
    // Trait
    Authenticator,

    // Types
    UserProfile,
    UserRole,
    AuthProvider,
    AuthResult,

    // Helper
    generate_offline_uuid,

    // Providers
    offline::OfflineAuth,
    microsoft::MicrosoftAuth,
    azuriom::AzuriomAuth,

    // Errors
    AuthError,
};

Usage Patterns

Pattern 1: Direct Crate Import

use lighty_auth::{Authenticator, offline::OfflineAuth};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let mut auth = OfflineAuth::new("Player");

    #[cfg(not(feature = "events"))]
    let profile = auth.authenticate().await?;

    println!("{}", profile.username);
    Ok(())
}

Pattern 2: Via Main Launcher Crate

use lighty_launcher::auth::{Authenticator, microsoft::MicrosoftAuth};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let mut auth = MicrosoftAuth::new("client-id");

    #[cfg(not(feature = "events"))]
    let profile = auth.authenticate().await?;

    Ok(())
}

Type Details

UserProfile

pub struct UserProfile {
    pub id: Option<u64>,
    pub username: String,
    pub uuid: String,
    pub access_token: Option<String>,
    pub email: Option<String>,
    pub email_verified: bool,
    pub money: Option<f64>,
    pub role: Option<UserRole>,
    pub banned: bool,
}

UserRole

pub struct UserRole {
    pub name: String,
    pub color: Option<String>,
}

AuthProvider

pub enum AuthProvider {
    Offline,
    Azuriom { base_url: String },
    Microsoft { client_id: String },
    Custom { base_url: String },
}

AuthError

pub enum AuthError {
    NetworkError(String),
    InvalidCredentials,
    TwoFactorRequired,
    AccountBanned,
    MicrosoftAuthFailed(String),
    XboxLiveAuthFailed(String),
    MinecraftAuthFailed(String),
    ParseError(String),
    AzuriomError(String),
}

Module Structure

lighty_auth
├── auth
│   ├── Authenticator (trait)
│   ├── UserProfile
│   ├── UserRole
│   ├── AuthProvider
│   ├── AuthResult<T>
│   └── generate_offline_uuid
├── offline
│   └── OfflineAuth
├── microsoft
│   └── MicrosoftAuth
├── azuriom
│   └── AzuriomAuth
└── errors
    └── AuthError

Related Documentation

• How to Use - Practical usage examples

• Events - AuthEvent types

• Trait - Implementing custom authenticators

• Overview - Architecture overview