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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 and AllowGIDs control peer credential enforcement.
//
// Gate logic: enforcement is triggered when len(AllowUIDs) > 0 OR
// len(AllowGIDs) > 0. Inside checkPeerCred both lists are checked with
// AND semantics, but an empty list passes automatically (inList returns true
// for an empty list). Consequences:
//
// - Setting only AllowUIDs leaves AllowGIDs unrestricted (any GID accepted).
// - Setting only AllowGIDs leaves AllowUIDs unrestricted (any UID accepted).
// - Setting both enforces UID AND GID.
// - Setting neither disables peer-cred checking entirely.
//
// If you intend to restrict by both UID and GID, you must populate both lists.
//
// Platform semantics:
// Linux — checks real UID and real GID from SO_PEERCRED (UCred.Uid / UCred.Gid).
// Darwin — checks effective UID and primary effective group (XUCRED Groups[0]).
// Supplementary group membership is NOT checked on either platform.
AllowUIDs []uint32 // if set, require peer real/effective UID in this list
AllowGIDs []uint32 // if set, require peer primary real/effective GID in this list
Handler func(net.Conn) error // REQUIRED: per-conn handler
}
Config holds UDS listener options.
Source Files