1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
|
package gemini
import (
"bytes"
"crypto/tls"
"crypto/x509"
"fmt"
"io"
"net"
"net/url"
"os"
"strconv"
"strings"
"time"
"golang.org/x/net/idna"
)
func punycodeHost(host string) (string, error) {
hostname, port, err := net.SplitHostPort(host)
if err != nil {
// Likely means no port
hostname = host
port = ""
}
if net.ParseIP(hostname) != nil {
// Hostname is IP address, not domain
return host, nil
}
pc, err := idna.ToASCII(hostname)
if err != nil {
return host, err
}
if port == "" {
return pc, nil
}
return net.JoinHostPort(pc, port), nil
}
func punycodeHostFromURL(u string) (string, error) {
parsed, err := url.Parse(u)
if err != nil {
return "", err
}
return punycodeHost(parsed.Host)
}
// GetPunycodeURL takes a full URL that potentially has Unicode in the
// domain name, and returns a URL with the domain punycoded.
func GetPunycodeURL(u string) (string, error) {
parsed, err := url.Parse(u)
if err != nil {
return "", nil
}
host, err := punycodeHostFromURL(u)
if err != nil {
return "", err
}
parsed.Host = host
return parsed.String(), nil
}
// Response represents the response from a Gemini server.
type Response struct {
Status int
Meta string
Body io.ReadCloser
Cert *x509.Certificate
conn net.Conn
}
type header struct {
status int
meta string
}
// ProxyFunc. See Client documentation
type ProxyFunc func(dialer *net.Dialer, address string) (net.Conn, error)
type Client struct {
// NoTimeCheck allows connections with expired or future certs if set to true.
NoTimeCheck bool
// NoHostnameCheck allows connections when the cert doesn't match the
// requested hostname or IP.
NoHostnameCheck bool
// Insecure disables all TLS-based checks, use with caution.
// It overrides all the variables above.
Insecure bool
// AllowOutOfRangeStatuses means the client won't raise an error if a status
// that is out of range is returned.
// Use CleanStatus() to handle statuses that are in range but not specified in
// the spec.
AllowOutOfRangeStatuses bool
// ConnectTimeout is equivalent to the Timeout field in net.Dialer.
// It's the max amount of time allowed for the initial connection/handshake.
// The timeout of the DefaultClient is 15 seconds.
//
// If ReadTimeout is not set, then this value is also used to time out on getting
// the header after the connection is made.
ConnectTimeout time.Duration
// ReadTimeout is the max amount of time reading to a server can take.
// This should not be set if you want to support streams.
// It is equivalent to net.Conn.SetDeadline, see that func for more documentation.
//
// For example, if this is set to 30 seconds, then no more reading from the connection
// can happen 30 seconds after the initial handshake.
ReadTimeout time.Duration
// Proxy is a function that returns an existing connection. The TLS client
// will use this as the underlying transport, instead of making a direct TCP
// connection.
//
// go-gemini requires setting a dialer on the underlying connection, to impose
// a timeout on making the initial connection. This dialer is provided as an
// argument to the proxy function.
//
// The other argument provided is the address being connected to. For example
// "example.com:1965".
//
// Any errors returned will prevent a connection from occurring.
//
// This is not "gemini proxying", aka the proxying functionality built in to
// the Gemini protocol. This is for proxying requests over TOR, or SOCKS5, etc.
//
// func(dialer *net.Dialer, address string) (net.Conn, error)
//
Proxy ProxyFunc
}
var DefaultClient = &Client{ConnectTimeout: 15 * time.Second}
// getHost returns a full host for the given URL, always including a port.
// It also punycodes the host, in case it contains Unicode.
func getHost(parsedURL *url.URL) string {
host, _ := punycodeHostFromURL(parsedURL.String())
if parsedURL.Port() == "" {
host = net.JoinHostPort(parsedURL.Hostname(), "1965")
}
return host
}
// SetReadTimeout changes the read timeout after the connection has been made.
// You can set it to 0 or less to disable the timeout. Otherwise, the duration
// is relative to the time the function was called.
func (r *Response) SetReadTimeout(d time.Duration) error {
if d <= 0 {
return r.conn.SetDeadline(time.Time{})
}
return r.conn.SetDeadline(time.Now().Add(d))
}
// TODO: apply punycoding to hosts
// Fetch a resource from a Gemini server with the given URL.
// It assumes port 1965 if no port is specified.
func (c *Client) Fetch(rawURL string) (*Response, error) {
parsedURL, err := url.Parse(rawURL)
if err != nil {
return nil, fmt.Errorf("failed to parse URL: %w", err)
}
return c.FetchWithHost(getHost(parsedURL), rawURL)
}
// FetchWithHost fetches a resource from a Gemini server at the given host, with the given URL.
// This can be used for Gemini proxying, where the URL host and actual server don't match.
// It assumes the host is using port 1965 if no port number is provided.
func (c *Client) FetchWithHost(host, rawURL string) (*Response, error) {
// Call with empty PEM bytes to skip using a cert
return c.FetchWithHostAndCert(host, rawURL, []byte{}, []byte{})
}
// FetchWithCert fetches a resource from a Gemini server with the given URL.
// It allows you to provide the bytes of a PEM encoded block for a client
// certificate and its key. This allows you to make requests using client
// certs.
//
// It assumes port 1965 if no port is specified.
func (c *Client) FetchWithCert(rawURL string, certPEM, keyPEM []byte) (*Response, error) {
parsedURL, err := url.Parse(rawURL)
if err != nil {
return nil, fmt.Errorf("failed to parse URL: %w", err)
}
// Call with empty PEM bytes to skip using a cert
return c.FetchWithHostAndCert(getHost(parsedURL), rawURL, certPEM, keyPEM)
}
// FetchWithHostAndCert combines FetchWithHost and FetchWithCert.
func (c *Client) FetchWithHostAndCert(host, rawURL string, certPEM, keyPEM []byte) (*Response, error) {
u, err := GetPunycodeURL(rawURL)
if err != nil {
return nil, fmt.Errorf("error when punycoding URL: %w", err)
}
parsedURL, _ := url.Parse(u)
if len(u) > URLMaxLength {
// Out of spec
return nil, fmt.Errorf("url is too long")
}
// Add port to host if needed
_, _, err = net.SplitHostPort(host)
if err != nil {
// Error likely means there's no port in the host
host = net.JoinHostPort(host, "1965")
}
ogHost := host
host, err = punycodeHost(host)
if err != nil {
return nil, fmt.Errorf("failed to punycode host %s: %w", ogHost, err)
}
// Build tls.Certificate
var cert tls.Certificate
if len(certPEM) == 0 && len(keyPEM) == 0 {
// Cert bytes were intentionally left empty
cert = tls.Certificate{}
} else {
cert, err = tls.X509KeyPair(certPEM, keyPEM)
if err != nil {
return nil, fmt.Errorf("failed to parse cert/key PEM: %w", err)
}
}
res := Response{}
// Connect
start := time.Now()
conn, err := c.connect(&res, host, parsedURL, cert)
if err != nil {
return nil, fmt.Errorf("failed to connect to the server: %w", err)
}
// Send request
if c.ReadTimeout == 0 && c.ConnectTimeout != 0 {
// No r/w timeout, so a timeout for sending the request must be set
conn.SetDeadline(start.Add(c.ConnectTimeout))
}
err = sendRequest(conn, u)
if err != nil {
conn.Close()
return nil, err
}
if c.ReadTimeout == 0 && c.ConnectTimeout != 0 {
// Undo deadline
conn.SetDeadline(time.Time{})
}
// Get header
if c.ReadTimeout == 0 && c.ConnectTimeout != 0 {
// No r/w timeout, so a timeout for getting the header
conn.SetDeadline(start.Add(c.ConnectTimeout))
}
err = getResponse(&res, conn)
if err != nil {
conn.Close()
return nil, err
}
if c.ReadTimeout == 0 && c.ConnectTimeout != 0 {
// Undo deadline
conn.SetDeadline(time.Time{})
}
// Check status code
if !c.AllowOutOfRangeStatuses && !StatusInRange(res.Status) {
conn.Close()
return nil, fmt.Errorf("invalid status code: %v", res.Status)
}
return &res, nil
}
// Fetch a resource from a Gemini server with the given URL.
// It assumes port 1965 if no port is specified.
func Fetch(url string) (*Response, error) {
return DefaultClient.Fetch(url)
}
// FetchWithCert fetches a resource from a Gemini server with the given URL.
// It allows you to provide the bytes of a PEM encoded block for a client
// certificate and its key. This allows you to make requests using client
// certs.
//
// It assumes port 1965 if no port is specified.
func FetchWithCert(url string, certPEM, keyPEM []byte) (*Response, error) {
return DefaultClient.FetchWithCert(url, certPEM, keyPEM)
}
// FetchWithHost fetches a resource from a Gemini server at the given host, with the given URL.
// This can be used for proxying, where the URL host and actual server don't match.
// It assumes the host is using port 1965 if no port number is provided.
func FetchWithHost(host, url string) (*Response, error) {
return DefaultClient.FetchWithHost(host, url)
}
// FetchWithHostAndCert combines FetchWithHost and FetchWithCert.
func FetchWithHostAndCert(host, url string, certPEM, keyPEM []byte) (*Response, error) {
return DefaultClient.FetchWithHostAndCert(host, url, certPEM, keyPEM)
}
func (c *Client) connect(res *Response, host string, parsedURL *url.URL, clientCert tls.Certificate) (net.Conn, error) {
conf := &tls.Config{
MinVersion: tls.VersionTLS12,
InsecureSkipVerify: true, // This must be set to allow self-signed certs
}
if clientCert.Certificate != nil {
// There is data, not an empty struct
conf.Certificates = []tls.Certificate{clientCert}
}
// Support logging TLS keys for debugging - See PR #5
keylogfile := os.Getenv("SSLKEYLOGFILE")
if keylogfile != "" {
w, err := os.OpenFile(keylogfile, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0600)
if err == nil {
conf.KeyLogWriter = w
defer w.Close()
}
}
var conn *tls.Conn
var err error
if c.Proxy == nil {
// Dialer timeout for handshake
conn, err = tls.DialWithDialer(&net.Dialer{Timeout: c.ConnectTimeout}, "tcp", host, conf)
res.conn = conn
if err != nil {
return conn, err
}
} else {
// Use proxy
proxyConn, err := c.Proxy(&net.Dialer{Timeout: c.ConnectTimeout}, host)
if err != nil {
return nil, err
}
conn = tls.Client(proxyConn, conf)
// Make handshake manually to start connection, so later call to
// conn.ConnectionState() works
if err := conn.Handshake(); err != nil {
return nil, err
}
}
if c.ReadTimeout != 0 {
conn.SetDeadline(time.Now().Add(c.ReadTimeout))
}
cert := conn.ConnectionState().PeerCertificates[0]
res.Cert = cert
if c.Insecure {
return conn, nil
}
// Verify hostname
if !c.NoHostnameCheck {
// Cert hostname has to match connection host, not request host
hostname, _, _ := net.SplitHostPort(host)
if err := verifyHostname(cert, hostname); err != nil {
// Try with Unicode version
uniHost, uniErr := idna.ToUnicode(hostname)
err2 := verifyHostname(cert, uniHost)
if uniErr != nil {
return nil, fmt.Errorf("punycoded hostname does not verify and could not be converted to Unicode: %w", err)
}
if err2 != nil {
return nil, fmt.Errorf("hostname does not verify: %w", err2)
}
return nil, fmt.Errorf("hostname does not verify: %w", err)
}
}
// Verify expiry
if !c.NoTimeCheck {
if cert.NotBefore.After(time.Now()) {
return nil, fmt.Errorf("server cert is for the future")
} else if cert.NotAfter.Before(time.Now()) {
return nil, fmt.Errorf("server cert is expired")
}
}
return conn, nil
}
func sendRequest(conn io.Writer, requestURL string) error {
_, err := fmt.Fprintf(conn, "%s\r\n", requestURL)
if err != nil {
return fmt.Errorf("could not send request to the server: %w", err)
}
return nil
}
func getResponse(res *Response, conn io.ReadCloser) error {
header, err := getHeader(conn)
if err != nil {
conn.Close()
return fmt.Errorf("failed to get header: %w", err)
}
res.Status = header.status
res.Meta = header.meta
res.Body = conn
return nil
}
func getHeader(conn io.Reader) (header, error) {
line, err := readHeader(conn)
if err != nil {
return header{}, fmt.Errorf("failed to read header: %w", err)
}
fields := strings.Fields(string(line))
if len(fields) < 2 && line[len(line)-1] != ' ' {
return header{}, fmt.Errorf("header not formatted correctly")
}
status, err := strconv.Atoi(fields[0])
if err != nil {
return header{}, fmt.Errorf("unexpected status value %v: %w", fields[0], err)
}
var meta string
if len(line) <= 3 {
meta = ""
} else {
meta = string(line)[len(fields[0])+1:]
}
if len(meta) > MetaMaxLength {
return header{}, fmt.Errorf("meta string is too long")
}
return header{status, meta}, nil
}
func readHeader(conn io.Reader) ([]byte, error) {
var line []byte
delim := []byte("\r\n")
// A small buffer is inefficient but the maximum length of the header is small so it's okay
buf := make([]byte, 1)
for {
n, err := conn.Read(buf)
if err == io.EOF && n <= 0 {
return []byte{}, err
} else if err != nil && err != io.EOF {
return []byte{}, err
}
line = append(line, buf...)
if bytes.HasSuffix(line, delim) {
return line[:len(line)-len(delim)], nil
}
}
}
|