| Server IP : 157.230.181.24 / Your IP : 216.73.217.11 Web Server : Apache/2.4.58 (Ubuntu) System : Linux conductive 6.8.0-117-generic #117-Ubuntu SMP PREEMPT_DYNAMIC Tue May 5 19:26:24 UTC 2026 x86_64 User : ( 1000) PHP Version : 8.3.31 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /var/www/vhosts/ceagon/open-oscar-server/config/ |
Upload File : |
package config
import (
"errors"
"fmt"
"net"
"net/url"
"strings"
"time"
)
var (
// Simple error for duplicate listener definitions
errDuplicateListener = errors.New("duplicate listener definition")
// Simple error for missing BOS listeners
errNoBOSListeners = errors.New("at least one BOS listener is required")
)
// Custom error types for URI-related errors
type uriFormatError struct {
URI string
Err error
}
func (e uriFormatError) Error() string {
return fmt.Sprintf("invalid listener URI %q: %v. Valid format: SCHEME://HOST:PORT (e.g., LOCAL://0.0.0.0:5190)", e.URI, e.Err)
}
type Build struct {
Version string `json:"version"`
Commit string `json:"commit"`
Date string `json:"date"`
}
type Listener struct {
BOSListenAddress string
BOSAdvertisedHostPlain string
BOSAdvertisedHostSSL string
KerberosListenAddress string
HasSSL bool
}
//go:generate go run ../cmd/config_generator unix settings.env ssl
type Config struct {
BOSListeners []string `envconfig:"OSCAR_LISTENERS" required:"true" basic:"LOCAL://0.0.0.0:5190" ssl:"LOCAL://0.0.0.0:5190" description:"Network listeners for core OSCAR services. For multi-homed servers, allows users to connect from multiple networks. For example, you can allow both LAN and Internet clients to connect to the same server using different connection settings.\n\nFormat:\n\t- Comma-separated list of [NAME]://[HOSTNAME]:[PORT]\n\t- Listener names and ports must be unique\n\t- Listener names are user-defined\n\t- Each listener needs a listener in OSCAR_ADVERTISED_LISTENERS_PLAIN\n\nExamples:\n\t// Listen on all interfaces\n\tLAN://0.0.0.0:5190\n\t// Separate Internet and LAN config\n\tWAN://142.250.176.206:5190,LAN://192.168.1.10:5191"`
BOSAdvertisedHostsPlain []string `envconfig:"OSCAR_ADVERTISED_LISTENERS_PLAIN" required:"true" basic:"LOCAL://127.0.0.1:5190" ssl:"LOCAL://127.0.0.1:5190" description:"Hostnames published by the server that clients connect to for accessing various OSCAR services. These hostnames are NOT the bind addresses. For multi-homed use servers, allows clients to connect using separate hostnames per network.\n\nFormat:\n\t- Comma-separated list of [NAME]://[HOSTNAME]:[PORT]\n\t- Each listener config must correspond to a config in OSCAR_LISTENERS\n\t- Clients MUST be able to connect to these hostnames\n\nExamples:\n\t// Local LAN config, server behind NAT\n\tLAN://192.168.1.10:5190\n\t// Separate Internet and LAN config\n\tWAN://aim.example.com:5190,LAN://192.168.1.10:5191"`
BOSAdvertisedHostsSSL []string `envconfig:"OSCAR_ADVERTISED_LISTENERS_SSL" required:"false" basic:"" ssl:"LOCAL://ras.dev:5193" description:"Same as OSCAR_ADVERTISED_LISTENERS_PLAIN, except the hostname is for the server that terminates SSL."`
KerberosListeners []string `envconfig:"KERBEROS_LISTENERS" required:"false" basic:"" ssl:"LOCAL://0.0.0.0:1088" description:"Network listeners for Kerberos authentication. See OSCAR_LISTENERS doc for more details.\n\nExamples:\n\t// Listen on all interfaces\n\tLAN://0.0.0.0:1088\n\t// Separate Internet and LAN config\n\tWAN://142.250.176.206:1088,LAN://192.168.1.10:1087"`
TOCListeners []string `envconfig:"TOC_LISTENERS" required:"true" basic:"0.0.0.0:9898" ssl:"0.0.0.0:9898" description:"Network listeners for TOC protocol service.\n\nFormat: Comma-separated list of hostname:port pairs.\n\nExamples:\n\t// All interfaces\n\t0.0.0.0:9898\n\t// Multiple listeners\n\t0.0.0.0:9898,192.168.1.10:9899"`
APIListener string `envconfig:"API_LISTENER" required:"true" basic:"127.0.0.1:8080" ssl:"127.0.0.1:8080" description:"Network listener for management API binds to. Only 1 listener can be specified. (Default 127.0.0.1 restricts to same machine only)."`
WebAPIListeners []string `envconfig:"WEBAPI_LISTENERS" required:"false" basic:"0.0.0.0:8081" ssl:"0.0.0.0:8081" description:"Network listeners for WebAPI. See OSCAR_LISTENERS doc for more details.\n\nExamples:\n\t// Listen on all interfaces\n\tLAN://0.0.0.0:8081\n\t// Separate Internet and LAN config\n\tWAN://142.250.176.206:8081,LAN://192.168.1.10:8082"`
DBPath string `envconfig:"DB_PATH" required:"true" basic:"oscar.sqlite" ssl:"oscar.sqlite" description:"The path to the SQLite database file. The file and DB schema are auto-created if they doesn't exist."`
DisableAuth bool `envconfig:"DISABLE_AUTH" required:"true" basic:"true" ssl:"true" description:"Disable password check and auto-create new users at login time. Useful for quickly creating new accounts during development without having to register new users via the management API."`
DisableMultiLoginNotif bool `envconfig:"DISABLE_MULTI_LOGIN_NOTIF" required:"false" basic:"true" ssl:"true" description:"Disable notification sent when another client signs in with the same screen name."`
LogLevel string `envconfig:"LOG_LEVEL" required:"true" basic:"info" ssl:"info" description:"Set logging granularity. Possible values: 'trace', 'debug', 'info', 'warn', 'error'."`
// ICQ Legacy Protocol Configuration
ICQLegacy ICQLegacyConfig
}
// ICQLegacyConfig holds configuration for legacy ICQ protocol support (v2-v5)
type ICQLegacyConfig struct {
Enabled bool `envconfig:"ICQ_LEGACY_ENABLED" required:"false" basic:"true" ssl:"true" description:"Enable legacy ICQ protocol support (v2-v5). Allows vintage ICQ clients to connect."`
UDPListener string `envconfig:"ICQ_LEGACY_UDP_LISTENER" required:"false" basic:"0.0.0.0:4000" ssl:"0.0.0.0:4000" description:"UDP listener address for legacy ICQ protocols.\n\nFormat: HOST:PORT\n\nExamples:\n\t// All interfaces\n\t0.0.0.0:4000\n\t// Specific interface\n\t192.168.1.10:4000"`
SupportedVersions []int `envconfig:"ICQ_LEGACY_VERSIONS" required:"false" basic:"2,3,4,5" ssl:"2,3,4,5" description:"Comma-separated list of supported ICQ protocol versions. Valid values: 1, 2, 3, 4, 5 (V1 is experimental)."`
SessionTimeout time.Duration `envconfig:"ICQ_LEGACY_SESSION_TIMEOUT" required:"false" basic:"120s" ssl:"120s" description:"Session timeout for legacy ICQ connections. Sessions are cleaned up after this duration of inactivity."`
KeepAliveInterval time.Duration `envconfig:"ICQ_LEGACY_KEEPALIVE_INTERVAL" required:"false" basic:"120s" ssl:"120s" description:"Expected keep-alive interval from clients. Used for timeout calculations."`
AutoRegistration bool `envconfig:"ICQ_LEGACY_AUTO_REGISTRATION" required:"false" basic:"false" ssl:"false" description:"Allow automatic user registration from legacy clients. When enabled, new UINs can be created via the legacy protocol."`
DepartmentsEnabled bool `envconfig:"ICQ_LEGACY_DEPARTMENTS_ENABLED" required:"false" basic:"false" ssl:"false" description:"Enable department listing feature (groupware functionality)."`
BroadcastEnabled bool `envconfig:"ICQ_LEGACY_BROADCAST_ENABLED" required:"false" basic:"true" ssl:"true" description:"Enable broadcast message functionality."`
WWPEnabled bool `envconfig:"ICQ_LEGACY_WWP_ENABLED" required:"false" basic:"true" ssl:"true" description:"Enable Web Pager (WWP) message support."`
DirectConnections []int `envconfig:"ICQ_LEGACY_DIRECT_CONNECTIONS" required:"false" basic:"5" ssl:"5" description:"Comma-separated list of protocol versions that send real connection info (IP, port) in user online notifications. Disabled for privacy and interoperability. Required for peer-to-peer features (file transfer, direct chat). Example: 5 or 3,4,5"`
}
// DefaultICQLegacyConfig returns the default configuration for ICQ legacy protocol
func DefaultICQLegacyConfig() ICQLegacyConfig {
return ICQLegacyConfig{
Enabled: true,
UDPListener: "0.0.0.0:4000",
SupportedVersions: []int{2, 3, 4, 5},
SessionTimeout: 120 * time.Second,
KeepAliveInterval: 120 * time.Second,
AutoRegistration: false,
DepartmentsEnabled: false,
BroadcastEnabled: true,
WWPEnabled: true,
}
}
// SupportsVersion checks if a specific protocol version is enabled
func (c *ICQLegacyConfig) SupportsVersion(version int) bool {
for _, v := range c.SupportedVersions {
if v == version {
return true
}
}
return false
}
// DirectConnectionEnabled checks if direct connections are enabled for a specific protocol version
func (c *ICQLegacyConfig) DirectConnectionEnabled(version int) bool {
for _, v := range c.DirectConnections {
if v == version {
return true
}
}
return false
}
func (c *Config) ParseListenersCfg() ([]Listener, error) {
// Helper function to parse and validate a single URI
parseURI := func(uriStr string) (*url.URL, error) {
uriStr = strings.TrimSpace(uriStr)
if uriStr == "" {
return nil, nil
}
u, err := url.Parse(uriStr)
if err != nil {
return nil, uriFormatError{URI: uriStr, Err: err}
}
switch {
case u.Scheme == "":
return nil, uriFormatError{URI: uriStr, Err: errors.New("missing scheme")}
case u.Hostname() == "":
return nil, uriFormatError{URI: uriStr, Err: errors.New("missing host")}
case u.Port() == "":
return nil, uriFormatError{URI: uriStr, Err: errors.New("missing port")}
}
return u, nil
}
m := make(map[string]*Listener)
// Parse BOS listeners
for _, uriStr := range c.BOSListeners {
u, err := parseURI(uriStr)
if err != nil {
return nil, err
}
if u == nil {
continue
}
if _, ok := m[u.Scheme]; !ok {
m[u.Scheme] = &Listener{}
}
if m[u.Scheme].BOSListenAddress != "" {
return nil, errDuplicateListener
}
m[u.Scheme].BOSListenAddress = net.JoinHostPort(u.Hostname(), u.Port())
}
// Parse plaintext BOS advertised listeners
for _, uriStr := range c.BOSAdvertisedHostsPlain {
u, err := parseURI(uriStr)
if err != nil {
return nil, err
}
if u == nil {
continue
}
if _, ok := m[u.Scheme]; !ok {
m[u.Scheme] = &Listener{}
}
if m[u.Scheme].BOSAdvertisedHostPlain != "" {
return nil, errDuplicateListener
}
m[u.Scheme].BOSAdvertisedHostPlain = net.JoinHostPort(u.Hostname(), u.Port())
}
// Parse SSL BOS advertised listeners
for _, uriStr := range c.BOSAdvertisedHostsSSL {
u, err := parseURI(uriStr)
if err != nil {
return nil, err
}
if u == nil {
continue
}
if _, ok := m[u.Scheme]; !ok {
m[u.Scheme] = &Listener{}
}
if m[u.Scheme].BOSAdvertisedHostSSL != "" {
return nil, errDuplicateListener
}
m[u.Scheme].HasSSL = true
m[u.Scheme].BOSAdvertisedHostSSL = net.JoinHostPort(u.Hostname(), u.Port())
}
// Parse Kerberos listeners
for _, uriStr := range c.KerberosListeners {
u, err := parseURI(uriStr)
if err != nil {
return nil, err
}
if u == nil {
continue
}
if _, ok := m[u.Scheme]; !ok {
m[u.Scheme] = &Listener{}
}
if m[u.Scheme].KerberosListenAddress != "" {
return nil, errDuplicateListener
}
m[u.Scheme].KerberosListenAddress = net.JoinHostPort(u.Hostname(), u.Port())
}
ret := make([]Listener, 0, len(m))
for k, v := range m {
switch {
case v.BOSAdvertisedHostPlain == "":
return nil, fmt.Errorf("missing BOS advertise address for listener `%s://`", k)
case v.BOSListenAddress == "":
return nil, fmt.Errorf("missing BOS listen address for listener `%s://`", k)
}
ret = append(ret, *v)
}
if len(ret) == 0 {
return nil, errNoBOSListeners
}
return ret, nil
}
func (c *Config) Validate() error {
// Validate TOCListeners (format: hostname:port pairs)
for _, listener := range c.TOCListeners {
listener = strings.TrimSpace(listener)
if listener == "" {
continue
}
host, port, err := net.SplitHostPort(listener)
if err != nil {
return fmt.Errorf("invalid TOC listener %q: %v. Valid format: HOST:PORT (e.g., 0.0.0.0:9898)", listener, err)
}
if host == "" {
return fmt.Errorf("invalid TOC listener %q: missing host. Valid format: HOST:PORT (e.g., 0.0.0.0:9898)", listener)
}
if port == "" {
return fmt.Errorf("invalid TOC listener %q: missing port. Valid format: HOST:PORT (e.g., 0.0.0.0:9898)", listener)
}
}
// Validate APIListener (format: hostname:port pair, no scheme)
apiListener := strings.TrimSpace(c.APIListener)
if apiListener == "" {
return fmt.Errorf("APIListener is required and cannot be empty")
}
host, port, err := net.SplitHostPort(apiListener)
if err != nil {
return fmt.Errorf("invalid API listener %q: %v. Valid format: HOST:PORT (e.g., 127.0.0.1:8080)", c.APIListener, err)
}
if host == "" {
return fmt.Errorf("invalid API listener %q: missing host. Valid format: HOST:PORT (e.g., 127.0.0.1:8080)", c.APIListener)
}
if port == "" {
return fmt.Errorf("invalid API listener %q: missing port. Valid format: HOST:PORT (e.g., 127.0.0.1:8080)", c.APIListener)
}
// Validate WebAPIListeners (format: hostname:port pairs, no scheme)
for _, listener := range c.WebAPIListeners {
listener = strings.TrimSpace(listener)
if listener == "" {
continue
}
host, port, err := net.SplitHostPort(listener)
if err != nil {
return fmt.Errorf("invalid web API listener %q: %v. Valid format: HOST:PORT (e.g., 0.0.0.0:8081)", listener, err)
}
if host == "" {
return fmt.Errorf("invalid web API listener %q: missing host. Valid format: HOST:PORT (e.g., 0.0.0.0:8081)", listener)
}
if port == "" {
return fmt.Errorf("invalid web API listener %q: missing port. Valid format: HOST:PORT (e.g., 0.0.0.0:8081)", listener)
}
}
return nil
}