mirror of
https://github.com/openlibrecommunity/olcrtc.git
synced 2026-05-26 15:13:40 +00:00
96 lines
3.4 KiB
Go
96 lines
3.4 KiB
Go
// Package auth defines how room credentials are produced for an engine.
|
|
//
|
|
// An auth provider is responsible for any service-specific HTTP / login flow
|
|
// (WB Stream, Yandex Telemost, Jitsi, ...) and produces a
|
|
// Credentials value that an engine can use to connect. Some auth providers
|
|
// also support creating new rooms; that capability is optional and is
|
|
// expressed via the RoomCreator interface.
|
|
//
|
|
// The "none" auth provider passes a caller-supplied URL+Token through
|
|
// unchanged — this is the path that sing-box and other downstream consumers
|
|
// take when they want to use olcrtc as a generic LiveKit/Goolom/Jitsi
|
|
// transport without any service-specific behaviour baked in.
|
|
package auth
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
)
|
|
|
|
var (
|
|
// ErrAuthNotFound is returned when a requested auth provider is not registered.
|
|
ErrAuthNotFound = errors.New("auth provider not found")
|
|
// ErrRoomCreationUnsupported is returned when an auth provider cannot create rooms.
|
|
ErrRoomCreationUnsupported = errors.New("auth provider does not support room creation")
|
|
// ErrRoomIDRequired is returned when an auth flow needs an existing room ID and none was supplied.
|
|
ErrRoomIDRequired = errors.New("room ID required")
|
|
)
|
|
|
|
// Credentials carry everything an engine needs to connect to an SFU.
|
|
//
|
|
// URL is the signaling endpoint (e.g. wss://livekit.example/). Token is the
|
|
// access token (LiveKit JWT, Goolom session credential, etc). Extra is for
|
|
// engine-specific bits that don't fit the common shape — engines should not
|
|
// rely on it being populated unless their paired auth provider documents it.
|
|
type Credentials struct {
|
|
URL string
|
|
Token string
|
|
Extra map[string]string
|
|
}
|
|
|
|
// Config is the input to an auth provider.
|
|
type Config struct {
|
|
// RoomURL is the user-facing room link (e.g. https://telemost.yandex.ru/j/123).
|
|
// Optional for providers that can also create rooms on demand.
|
|
RoomURL string
|
|
// Name is the display name to register with.
|
|
Name string
|
|
// DNSServer / ProxyAddr / ProxyPort are network knobs for outbound HTTP.
|
|
DNSServer string
|
|
ProxyAddr string
|
|
ProxyPort int
|
|
}
|
|
|
|
// Provider produces engine credentials.
|
|
type Provider interface {
|
|
// Engine reports which engine this auth provider feeds.
|
|
Engine() string
|
|
// DefaultServiceURL returns the well-known service URL for this provider
|
|
// (e.g. "https://stream.wb.ru"). Returns "" if no default exists — in that
|
|
// case the caller must supply -url explicitly.
|
|
DefaultServiceURL() string
|
|
// Issue obtains credentials for the given room.
|
|
Issue(ctx context.Context, cfg Config) (Credentials, error)
|
|
}
|
|
|
|
// RoomCreator is implemented by auth providers that can create new rooms
|
|
// against their backing service. Used by `olcrtc -mode gen`.
|
|
type RoomCreator interface {
|
|
CreateRoom(ctx context.Context, cfg Config) (roomID string, err error)
|
|
}
|
|
|
|
var registry = make(map[string]Provider) //nolint:gochecknoglobals // package-level state intentional
|
|
|
|
// Register adds an auth provider to the registry.
|
|
func Register(name string, p Provider) {
|
|
registry[name] = p
|
|
}
|
|
|
|
// Get returns a registered auth provider by name.
|
|
func Get(name string) (Provider, error) {
|
|
p, ok := registry[name]
|
|
if !ok {
|
|
return nil, ErrAuthNotFound
|
|
}
|
|
return p, nil
|
|
}
|
|
|
|
// Available returns the list of registered auth provider names.
|
|
func Available() []string {
|
|
names := make([]string, 0, len(registry))
|
|
for name := range registry {
|
|
names = append(names, name)
|
|
}
|
|
return names
|
|
}
|