Refactor KnownHosts

This commit is contained in:
Adnan Maolood 2020-11-05 15:27:12 -05:00
parent 53390dad6b
commit b76080c863
6 changed files with 72 additions and 96 deletions

11
cert.go
View File

@ -52,16 +52,9 @@ func (c *CertificateStore) Add(scope string, cert tls.Certificate) error {
} }
// Lookup returns the certificate for the given scope. // Lookup returns the certificate for the given scope.
func (c *CertificateStore) Lookup(scope string) (*tls.Certificate, error) { func (c *CertificateStore) Lookup(scope string) (tls.Certificate, bool) {
cert, ok := c.store[scope] cert, ok := c.store[scope]
if !ok { return cert, ok
return nil, ErrCertificateNotFound
}
// Ensure that the certificate is not expired
if cert.Leaf != nil && cert.Leaf.NotAfter.Before(time.Now()) {
return &cert, ErrCertificateExpired
}
return &cert, nil
} }
// Load loads certificates from the given path. // Load loads certificates from the given path.

View File

@ -4,6 +4,7 @@ import (
"bufio" "bufio"
"crypto/tls" "crypto/tls"
"crypto/x509" "crypto/x509"
"errors"
"net" "net"
"net/url" "net/url"
"path" "path"
@ -164,7 +165,7 @@ func (c *Client) do(req *Request, via []*Request) (*Response, error) {
} }
} else if len(via) > 5 { } else if len(via) > 5 {
// Default policy of no more than 5 redirects // Default policy of no more than 5 redirects
return resp, ErrTooManyRedirects return resp, errors.New("gemini: too many redirects")
} }
return c.do(redirect, via) return c.do(redirect, via)
} }
@ -182,13 +183,14 @@ func (c *Client) getClientCertificate(req *Request) (*tls.Certificate, error) {
// Search recursively for the certificate // Search recursively for the certificate
scope := req.URL.Hostname() + strings.TrimSuffix(req.URL.Path, "/") scope := req.URL.Hostname() + strings.TrimSuffix(req.URL.Path, "/")
for { for {
cert, err := c.Certificates.Lookup(scope) cert, ok := c.Certificates.Lookup(scope)
if err == nil { if ok {
// Store the certificate // Ensure that the certificate is not expired
req.Certificate = cert if cert.Leaf != nil && !time.Now().After(cert.Leaf.NotAfter) {
return cert, err // Store the certificate
} req.Certificate = &cert
if err == ErrCertificateExpired { return &cert, nil
}
break break
} }
scope = path.Dir(scope) scope = path.Dir(scope)
@ -216,21 +218,27 @@ func (c *Client) verifyConnection(req *Request, cs tls.ConnectionState) error {
return nil return nil
} }
// Check the known hosts // Check the known hosts
err := c.KnownHosts.Lookup(hostname, cert) knownHost, ok := c.KnownHosts.Lookup(hostname)
switch err { if ok && time.Now().After(cert.NotAfter) {
case ErrCertificateExpired, ErrCertificateNotFound: // Not expired
// See if the client trusts the certificate fingerprint := NewFingerprint(cert)
if c.TrustCertificate != nil { if knownHost.Hex != fingerprint.Hex {
switch c.TrustCertificate(hostname, cert) { return errors.New("gemini: fingerprint does not match")
case TrustOnce:
c.KnownHosts.AddTemporary(hostname, cert)
return nil
case TrustAlways:
c.KnownHosts.Add(hostname, cert)
return nil
}
} }
return ErrCertificateNotTrusted return nil
} }
return err
// Unknown certificate
// See if the client trusts the certificate
if c.TrustCertificate != nil {
switch c.TrustCertificate(hostname, cert) {
case TrustOnce:
c.KnownHosts.AddTemporary(hostname, cert)
return nil
case TrustAlways:
c.KnownHosts.Add(hostname, cert)
return nil
}
}
return errors.New("gemini: certificate not trusted")
} }

View File

@ -33,7 +33,8 @@ func init() {
client.Timeout = 30 * time.Second client.Timeout = 30 * time.Second
client.KnownHosts.LoadDefault() client.KnownHosts.LoadDefault()
client.TrustCertificate = func(hostname string, cert *x509.Certificate) gemini.Trust { client.TrustCertificate = func(hostname string, cert *x509.Certificate) gemini.Trust {
fmt.Printf(trustPrompt, hostname, gemini.Fingerprint(cert)) fingerprint := gemini.NewFingerprint(cert)
fmt.Printf(trustPrompt, hostname, fingerprint.Hex)
scanner.Scan() scanner.Scan()
switch scanner.Text() { switch scanner.Text() {
case "t": case "t":

View File

@ -9,13 +9,9 @@ var crlf = []byte("\r\n")
// Errors. // Errors.
var ( var (
ErrInvalidURL = errors.New("gemini: invalid URL") ErrInvalidURL = errors.New("gemini: invalid URL")
ErrInvalidResponse = errors.New("gemini: invalid response") ErrInvalidResponse = errors.New("gemini: invalid response")
ErrCertificateExpired = errors.New("gemini: certificate expired") ErrBodyNotAllowed = errors.New("gemini: response body not allowed")
ErrCertificateNotFound = errors.New("gemini: certificate not found")
ErrCertificateNotTrusted = errors.New("gemini: certificate not trusted")
ErrBodyNotAllowed = errors.New("gemini: response body not allowed")
ErrTooManyRedirects = errors.New("gemini: too many redirects")
) )
// defaultClient is the default client. It is used by Get and Do. // defaultClient is the default client. It is used by Get and Do.

View File

@ -3,6 +3,7 @@ package gemini
import ( import (
"bufio" "bufio"
"crypto/tls" "crypto/tls"
"errors"
"log" "log"
"net" "net"
"net/url" "net/url"
@ -150,12 +151,12 @@ func (s *Server) getCertificate(h *tls.ClientHelloInfo) (*tls.Certificate, error
func (s *Server) getCertificateFor(hostname string) (*tls.Certificate, error) { func (s *Server) getCertificateFor(hostname string) (*tls.Certificate, error) {
if _, ok := s.hosts[hostname]; !ok { if _, ok := s.hosts[hostname]; !ok {
return nil, ErrCertificateNotFound return nil, errors.New("hostname not registered")
} }
cert, err := s.Certificates.Lookup(hostname)
switch err { // Generate a new certificate if it is missing or expired
case ErrCertificateNotFound, ErrCertificateExpired: cert, ok := s.Certificates.Lookup(hostname)
if !ok || cert.Leaf != nil && !time.Now().After(cert.Leaf.NotAfter) {
if s.CreateCertificate != nil { if s.CreateCertificate != nil {
cert, err := s.CreateCertificate(hostname) cert, err := s.CreateCertificate(hostname)
if err == nil { if err == nil {
@ -165,9 +166,9 @@ func (s *Server) getCertificateFor(hostname string) (*tls.Certificate, error) {
} }
return &cert, err return &cert, err
} }
return nil, errors.New("no certificate")
} }
return &cert, nil
return cert, err
} }
// respond responds to a connection. // respond responds to a connection.

77
tofu.go
View File

@ -8,9 +8,7 @@ import (
"io" "io"
"os" "os"
"path/filepath" "path/filepath"
"strconv"
"strings" "strings"
"time"
) )
// Trust represents the trustworthiness of a certificate. // Trust represents the trustworthiness of a certificate.
@ -25,7 +23,7 @@ const (
// KnownHosts represents a list of known hosts. // KnownHosts represents a list of known hosts.
// The zero value for KnownHosts is an empty list ready to use. // The zero value for KnownHosts is an empty list ready to use.
type KnownHosts struct { type KnownHosts struct {
hosts map[string]certInfo hosts map[string]Fingerprint
file *os.File file *os.File
} }
@ -80,53 +78,34 @@ func (k *KnownHosts) AddTemporary(hostname string, cert *x509.Certificate) {
func (k *KnownHosts) add(hostname string, cert *x509.Certificate, write bool) { func (k *KnownHosts) add(hostname string, cert *x509.Certificate, write bool) {
if k.hosts == nil { if k.hosts == nil {
k.hosts = map[string]certInfo{} k.hosts = map[string]Fingerprint{}
} }
info := certInfo{ fingerprint := NewFingerprint(cert)
Algorithm: "SHA-512", k.hosts[hostname] = fingerprint
Fingerprint: Fingerprint(cert),
Expires: cert.NotAfter.Unix(),
}
k.hosts[hostname] = info
// Append to the file // Append to the file
if write && k.file != nil { if write && k.file != nil {
appendKnownHost(k.file, hostname, info) appendKnownHost(k.file, hostname, fingerprint)
} }
} }
// Lookup looks for the provided certificate in the list of known hosts. // Lookup returns the fingerprint of the certificate corresponding to
// If the hostname is not in the list, Lookup returns ErrCertificateNotFound. // the given hostname.
// If the fingerprint doesn't match, Lookup returns ErrCertificateNotTrusted. func (k *KnownHosts) Lookup(hostname string) (Fingerprint, bool) {
// Otherwise, Lookup returns nil. c, ok := k.hosts[hostname]
func (k *KnownHosts) Lookup(hostname string, cert *x509.Certificate) error { return c, ok
now := time.Now().Unix()
fingerprint := Fingerprint(cert)
if c, ok := k.hosts[hostname]; ok {
if c.Expires <= now {
// Certificate is expired
return ErrCertificateExpired
}
if c.Fingerprint != fingerprint {
// Fingerprint does not match
return ErrCertificateNotTrusted
}
// Certificate is found
return nil
}
return ErrCertificateNotFound
} }
// Parse parses the provided reader and adds the parsed known hosts to the list. // Parse parses the provided reader and adds the parsed known hosts to the list.
// Invalid lines are ignored. // Invalid lines are ignored.
func (k *KnownHosts) Parse(r io.Reader) { func (k *KnownHosts) Parse(r io.Reader) {
if k.hosts == nil { if k.hosts == nil {
k.hosts = map[string]certInfo{} k.hosts = map[string]Fingerprint{}
} }
scanner := bufio.NewScanner(r) scanner := bufio.NewScanner(r)
for scanner.Scan() { for scanner.Scan() {
text := scanner.Text() text := scanner.Text()
parts := strings.Split(text, " ") parts := strings.Split(text, " ")
if len(parts) < 4 { if len(parts) < 3 {
continue continue
} }
@ -136,15 +115,10 @@ func (k *KnownHosts) Parse(r io.Reader) {
continue continue
} }
fingerprint := parts[2] fingerprint := parts[2]
expires, err := strconv.ParseInt(parts[3], 10, 0)
if err != nil {
continue
}
k.hosts[hostname] = certInfo{ k.hosts[hostname] = Fingerprint{
Algorithm: algorithm, Algorithm: algorithm,
Fingerprint: fingerprint, Hex: fingerprint,
Expires: expires,
} }
} }
} }
@ -156,18 +130,18 @@ func (k *KnownHosts) Write(w io.Writer) {
} }
} }
type certInfo struct { func appendKnownHost(w io.Writer, hostname string, f Fingerprint) (int, error) {
Algorithm string // fingerprint algorithm e.g. SHA-512 return fmt.Fprintf(w, "%s %s %s\n", hostname, f.Algorithm, f.Hex)
Fingerprint string // fingerprint in hexadecimal, with ':' between each octet
Expires int64 // unix time of certificate notAfter date
} }
func appendKnownHost(w io.Writer, hostname string, c certInfo) (int, error) { // Fingerprint represents a fingerprint using a certain algorithm.
return fmt.Fprintf(w, "%s %s %s %d\n", hostname, c.Algorithm, c.Fingerprint, c.Expires) type Fingerprint struct {
Algorithm string // fingerprint algorithm e.g. SHA-512
Hex string // fingerprint in hexadecimal, with ':' between each octet
} }
// Fingerprint returns the SHA-512 fingerprint of the provided certificate. // NewFingerprint returns the SHA-512 fingerprint of the provided certificate.
func Fingerprint(cert *x509.Certificate) string { func NewFingerprint(cert *x509.Certificate) Fingerprint {
sum512 := sha512.Sum512(cert.Raw) sum512 := sha512.Sum512(cert.Raw)
var b strings.Builder var b strings.Builder
for i, f := range sum512 { for i, f := range sum512 {
@ -176,7 +150,10 @@ func Fingerprint(cert *x509.Certificate) string {
} }
fmt.Fprintf(&b, "%02X", f) fmt.Fprintf(&b, "%02X", f)
} }
return b.String() return Fingerprint{
Algorithm: "SHA-512",
Hex: b.String(),
}
} }
// defaultKnownHostsPath returns the default known_hosts path. // defaultKnownHostsPath returns the default known_hosts path.