Sa-Token-Go

Since v0.1.0, Sa-Token-Go supports a Single Import Mode. Instead of importing core, stputil, and a framework integration separately, you can import a single framework integration package (e.g., integrations/gin). This package re-exports all functionality from core and stputil, providing a single namespace for all Sa-Token-Go operations.

Advantages:

• Simpler dependencies: Only one package to import.
• Cleaner code: Fewer import statements.
• Better IDE support: All functions reside in one namespace.
• Backward compatibility: The old multi-import method still works.

import (
    sagin "github.com/sa-tokens/sa-token-go/integrations/gin"
    "github.com/sa-tokens/sa-token-go/storage/memory"
)

func main() {
    // All functionality is available via the 'sagin' package!
    config := sagin.DefaultConfig()
    storage := memory.NewStorage()
    manager := sagin.NewManager(storage, config)
    
    sagin.SetManager(manager)
    token, _ := sagin.Login(1000)
    
    plugin := sagin.NewPlugin(manager)
}

Sa-Token-Go provides advanced features for complex security requirements:

Contextual Identity (Switching Identity)

Use SetTokenValueToCtx to pass a token through a Go context.Context. You can use SwitchTo to temporarily change the identity within a context (useful for impersonation or administrative tasks).

Two-Factor/Safe Authentication

Use OpenSafe to trigger a secondary authentication requirement for a specific action (e.g., 'pay') for a set duration, and CheckSafe to verify it.

Multi-level Banning

DisableLevel allows banning a user for a specific service/module at a specific level. CheckDisableLevel checks if the user is blocked at or above a certain level.

Device Management

• GetTerminalListByLoginID(id): Lists all active terminals for a user.
• IsTrustDeviceID(id, deviceID): Checks if a device is trusted.
• AddTrustDeviceID(id, deviceID): Marks a device as trusted.

// 1. Contextual Identity
ctx := context.Background()
ctx = stputil.SetTokenValueToCtx(ctx, token)
ctx = stputil.SwitchTo(ctx, "admin-1001")
switchedID, _ := stputil.GetLoginIDFromCtx(ctx) // -> admin-1001

// 2. Two-Factor Authentication
_ = stputil.OpenSafe(token, "pay", 300) // Enable for 5 mins
_ = stputil.CheckSafe(token, "pay")    // Verify

// 3. Multi-level Banning
_ = stputil.DisableLevel(1000, "comment", 2, time.Hour)
_ = stputil.CheckDisableLevel(1000, "comment", 1) // Intercepts if level >= 1

Starting from v0.1.0, Sa-Token-Go supports a single import mode. Instead of importing core, stputil, and a framework integration separately, you can import just the framework integration package (e.g., github.com/sa-tokens/sa-token-go/integrations/gin). This package re-exports all functions and types from core and stputil into its own namespace, resulting in cleaner code and simpler dependencies.

Benefits

• Simpler dependencies: Only one package to manage.
• Cleaner code: Fewer import statements.
• Better IDE support: All functions are available in a single namespace.
• Backward compatible: The traditional multiple-import method still works.

import (
    sagin "github.com/sa-tokens/sa-token-go/integrations/gin"
    "github.com/sa-tokens/sa-token-go/storage/memory"
)

func main() {
    // All functions (core, stputil, and gin) are in the 'sagin' namespace
    config := sagin.DefaultConfig()
    storage := memory.NewStorage()
    manager := sagin.NewManager(storage, config)
    
    sagin.SetManager(manager)
    token, _ := sagin.Login(1000)
    
    plugin := sagin.NewPlugin(manager)
}

Sa-Token-Go supports multiple token generation styles that can be configured during the initialization of the Sa-Token manager using core.NewBuilder().TokenStyle(...).

Common styles include:

• core.TokenStyleUuid: Standard UUID v4 format.
• core.TokenStyleSimple: 16-character Base64 URL-safe string.
• core.TokenStyleRandom32: 32-character random string.
• core.TokenStyleRandom64: 64-character random string.
• core.TokenStyleRandom128: 128-character random string for high security.
• core.TokenStyleJwt: Standard JWT format (requires JwtSecretKey configuration).
• core.TokenStyleHash: 64-character SHA256 hash combining loginID, device, timestamp, and random data.
• core.TokenStyleTimestamp: Format timestamp_loginID_random for easy traceability.
• core.TokenStyleTik: 11-character alphanumeric short ID (TikTok style).

// Example: Configuring Hash style
stputil.SetManager(
    core.NewBuilder().
        Storage(memory.NewStorage()).
        TokenStyle(core.TokenStyleHash).
        Timeout(86400).
        Build(),
)