usocket

Documentation

Overview

Copyright © 2025 Vicknesh Suppramaniam <vicknesh@handletec.my>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2025 Vicknesh Suppramaniam <vicknesh@handletec.my>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2025 Vicknesh Suppramaniam <vicknesh@handletec.my>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Config
  • func NewConfig(handler func(net.Conn) error) Config
• type Listener
  • func New() *Listener
  • func (u *Listener) Close() error
  • func (u *Listener) Init(logger *slog.Logger, socketpath string, _ int, tlsConfig *tls.Config) error
  • func (u *Listener) Name() string
  • func (u *Listener) SetConfig(config any) error
  • func (u *Listener) Start() error

Types

type Config

type Config struct {
	Perm          os.FileMode          // e.g. 0o660
	OwnerUID      int                  // -1 = no chown
	GroupGID      int                  // -1 = no chown
	RemoveStale   bool                 // remove stale socket file before bind (only if it's a socket)
	AcceptBackoff time.Duration        // backoff for temporary Accept errors (default 100ms)
	MaxConns      int                  // 0 = unlimited concurrent handlers
	ReadTimeout   time.Duration        // per-conn read deadline; 0 = none
	WriteTimeout  time.Duration        // per-conn write deadline; 0 = none
	AllowUIDs     []uint32             // if set, require SO_PEERCRED/XUCRED uid in this list
	AllowGIDs     []uint32             // if set, require SO_PEERCRED/XUCRED gid in this list
	Handler       func(net.Conn) error // REQUIRED: per-conn handler
}

Config holds UDS listener options.

func NewConfig

func NewConfig(handler func(net.Conn) error) Config

NewConfig returns a Config with sane defaults. - 0660 perms, no chown - remove stale socket file safely - 100ms accept backoff - no read/write deadlines (0) - no peer-cred restrictions by default Provide a non-nil handler; SetConfig will error if Handler is nil.

type Listener

type Listener struct {
	// contains filtered or unexported fields
}

Listener implements a hardened UNIX-domain-socket listener.

func New

func New() *Listener

New constructs a UNIX-socket listener.

func (*Listener) Close

func (u *Listener) Close() error

func (*Listener) Init

func (u *Listener) Init(logger *slog.Logger, socketpath string, _ int, tlsConfig *tls.Config) error

Init sets socket path and (ignored) tls config. Port is ignored for UDS.

func (*Listener) Name

func (u *Listener) Name() string

func (*Listener) SetConfig

func (u *Listener) SetConfig(config any) error

func (*Listener) Start

func (u *Listener) Start() error