tokens

package
v1.13.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 7, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Websocket      = JwtScope("websocket")
	FileUpload     = JwtScope("file-upload")
	FileDownload   = JwtScope("file-download")
	BackupDownload = JwtScope("backup-download")
	ServerTransfer = JwtScope("transfer")
)

Variables

This section is empty.

Functions

func DenyForServer

func DenyForServer(s string, u string)

DenyForServer 將一個使用者 UUID 加入拒絕清單,把所有 已核發給該使用者的現有 JWT 標記為無效。這與該使用者相關聯。

func DenyJTI

func DenyJTI(jti string)

DenyJTI 將一個 JTI 加入拒絕清單,把所有使用相同 JTI 且 在目前時間之前產生的 JWT 標記為無效。

已棄用:請改用 DenyForServer

func ParseToken

func ParseToken(token []byte, data TokenData) error

ParseToken 依據 Daemon 已知的密鑰驗證提供的 JWT, 並回傳解析後的資料。這個函式「不會」驗證該 token 對連線的伺服器是否有效,也不會確保提供該 token 的使用者實際上能夠執行任何操作。

這裡單純只是回傳一個解析過的 token。

Types

type BackupPayload

type BackupPayload struct {
	jwt.Payload
	Scoped

	ServerUuid string `json:"server_uuid"`
	UserUuid   string `json:"user_uuid"`
	BackupUuid string `json:"backup_uuid"`
	UniqueId   string `json:"unique_id"`
}

func (*BackupPayload) Denylisted

func (p *BackupPayload) Denylisted() bool

Denylisted 如果這個 token 是在使用者對伺服器的存取權限 被撤銷之前核發的,就回傳 true。

func (*BackupPayload) GetPayload

func (p *BackupPayload) GetPayload() *jwt.Payload

GetPayload 回傳 JWT payload。

func (*BackupPayload) IsUniqueRequest

func (p *BackupPayload) IsUniqueRequest() bool

IsUniqueRequest 判斷這個 JWT 對於指定的請求週期是否有效。 如果 token 中傳入的唯一 ID 先前已經出現過,這會回傳 false。這讓我們可以把這個 JWT 當作一次性 token 來使用, 用來驗證整個請求。

type FilePayload

type FilePayload struct {
	jwt.Payload
	Scoped

	FilePath   string `json:"file_path"`
	ServerUuid string `json:"server_uuid"`
	UserUuid   string `json:"user_uuid"`
	UniqueId   string `json:"unique_id"`
}

func (*FilePayload) Denylisted

func (p *FilePayload) Denylisted() bool

Denylisted 如果這個 token 是在使用者對伺服器的存取權限 被撤銷之前核發的,就回傳 true。

func (*FilePayload) GetPayload

func (p *FilePayload) GetPayload() *jwt.Payload

GetPayload 回傳 JWT payload。

func (*FilePayload) IsUniqueRequest

func (p *FilePayload) IsUniqueRequest() bool

IsUniqueRequest 判斷這個 JWT 對於指定的請求週期是否有效。 如果 token 中傳入的唯一 ID 先前已經出現過,這會回傳 false。這讓我們可以把這個 JWT 當作一次性 token 來使用, 用來驗證整個請求。

type JwtScope

type JwtScope string

type Scoped

type Scoped struct {
	Scope string `json:"scope"`
}

func (Scoped) HasScope

func (s Scoped) HasScope(scope JwtScope) bool

func (Scoped) Scopes

func (s Scoped) Scopes() []string

type TokenData

type TokenData interface {
	GetPayload() *jwt.Payload
}

type TokenStore

type TokenStore struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*TokenStore) IsValidToken

func (t *TokenStore) IsValidToken(token string) bool

IsValidToken 檢查一個 token 是否有效。

type TransferPayload

type TransferPayload struct {
	jwt.Payload
	Scoped
}

func (*TransferPayload) GetPayload

func (p *TransferPayload) GetPayload() *jwt.Payload

GetPayload 回傳 JWT payload。

type UploadPayload

type UploadPayload struct {
	jwt.Payload
	Scoped

	ServerUuid string `json:"server_uuid"`
	UserUuid   string `json:"user_uuid"`
	UniqueId   string `json:"unique_id"`
}

func (*UploadPayload) Denylisted

func (p *UploadPayload) Denylisted() bool

Denylisted 如果這個 token 是在使用者對伺服器的存取權限 被撤銷之前核發的,就回傳 true。

func (*UploadPayload) GetPayload

func (p *UploadPayload) GetPayload() *jwt.Payload

GetPayload 回傳 JWT payload。

func (*UploadPayload) IsUniqueRequest

func (p *UploadPayload) IsUniqueRequest() bool

IsUniqueRequest 判斷這個 JWT 對於指定的請求週期是否有效。 如果 token 中傳入的唯一 ID 先前已經出現過,這會回傳 false。這讓我們可以把這個 JWT 當作一次性 token 來使用, 用來驗證整個請求。

type WebsocketPayload

type WebsocketPayload struct {
	jwt.Payload
	sync.RWMutex
	Scoped

	UserUUID    string   `json:"user_uuid"`
	ServerUUID  string   `json:"server_uuid"`
	Permissions []string `json:"permissions"`
}

WebsocketPayload 定義 websocket 連線的 JWT payload。 這個 JWT 在連線建立之後,會透過傳送 "auth" 事件傳遞給 websocket。

func (*WebsocketPayload) Denylisted

func (p *WebsocketPayload) Denylisted() bool

Denylisted 檢查這個 JWT 是否被此實例標記為拒絕, 原因可能是它在 Wings 啟動之前就已核發,或者是我們已經 拒絕了在指定時間之前、所有具有相同 JTI 的 token。

func (*WebsocketPayload) GetPayload

func (p *WebsocketPayload) GetPayload() *jwt.Payload

GetPayload 回傳 JWT payload。

func (*WebsocketPayload) GetServerUuid

func (p *WebsocketPayload) GetServerUuid() string

GetServerUuid 回傳與此 JWT 關聯的伺服器 UUID。

func (*WebsocketPayload) HasPermission

func (p *WebsocketPayload) HasPermission(permission string) bool

HasPermission 檢查指定的 token payload 是否具有某個 權限字串。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址