d9a3992b3b
This type of field appears in more than one of our APIs, so this package will provide a single source of truth for validating and parsing inputs. Signed-off-by: Matt Moyer <moyerm@vmware.com>
72 lines
2.3 KiB
Go
72 lines
2.3 KiB
Go
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package endpointaddr implements parsing and validation of "<host>[:<port>]" strings for Pinniped APIs.
|
|
package endpointaddr
|
|
|
|
import (
|
|
"fmt"
|
|
"net"
|
|
"strconv"
|
|
|
|
"k8s.io/apimachinery/pkg/util/validation"
|
|
)
|
|
|
|
type HostPort struct {
|
|
// Host is the validated host part of the input, which may be a hostname or IP.
|
|
//
|
|
// This string can be be used as an x509 certificate SAN.
|
|
Host string
|
|
|
|
// Port is the validated port number, which may be defaulted.
|
|
Port uint16
|
|
}
|
|
|
|
// Endpoint is the host:port validated from the input, where port may be a default value.
|
|
//
|
|
// This string can be passed to net.Dial.
|
|
func (h *HostPort) Endpoint() string {
|
|
return net.JoinHostPort(h.Host, strconv.Itoa(int(h.Port)))
|
|
}
|
|
|
|
// Parse an "endpoint address" string, providing a default port. The input can be in several valid formats:
|
|
//
|
|
// - "<hostname>" (DNS hostname)
|
|
// - "<IPv4>" (IPv4 address)
|
|
// - "<IPv6>" (IPv6 address)
|
|
// - "<hostname>:<port>" (DNS hostname with port)
|
|
// - "<IPv4>:<port>" (IPv4 address with port)
|
|
// - "[<IPv6>]:<port>" (IPv6 address with port, brackets are required)
|
|
//
|
|
// If the input does not not specify a port number, then defaultPort will be used.
|
|
func Parse(endpoint string, defaultPort uint16) (HostPort, error) {
|
|
// Try parsing it both with and without an implicit port 443 at the end.
|
|
host, port, err := net.SplitHostPort(endpoint)
|
|
|
|
// If we got an error parsing the raw input, try adding the default port.
|
|
if err != nil {
|
|
host, port, err = net.SplitHostPort(net.JoinHostPort(endpoint, strconv.Itoa(int(defaultPort))))
|
|
}
|
|
|
|
// Give up if there's still an error splitting the host and port.
|
|
if err != nil {
|
|
return HostPort{}, err
|
|
}
|
|
|
|
// Parse the port number is an integer in the range of valid ports.
|
|
integerPort, _ := strconv.Atoi(port)
|
|
if len(validation.IsValidPortNum(integerPort)) > 0 {
|
|
return HostPort{}, fmt.Errorf("invalid port %q", port)
|
|
}
|
|
|
|
// Check if the host part is a IPv4 or IPv6 address or a valid hostname according to RFC 1123.
|
|
switch {
|
|
case len(validation.IsValidIP(host)) == 0:
|
|
case len(validation.IsDNS1123Subdomain(host)) == 0:
|
|
default:
|
|
return HostPort{}, fmt.Errorf("host %q is not a valid hostname or IP address", host)
|
|
}
|
|
|
|
return HostPort{Host: host, Port: uint16(integerPort)}, nil
|
|
}
|