147 Commits

Author SHA1 Message Date
Adnan Maolood
72d437c82e response: Limit response header size 2021-03-20 14:01:45 -04:00
Adnan Maolood
3dca29eb41 response: Don't use bufReadCloser 2021-03-20 13:41:53 -04:00
Adnan Maolood
a40b5dcd0b fs: Fix empty media type for directory index pages 2021-03-20 13:33:15 -04:00
Adnan Maolood
fffe86680e client: Only get cert if TrustCertificate is set 2021-03-20 12:54:41 -04:00
Adnan Maolood
d5af32e121 client: Close connection on error 2021-03-20 12:49:27 -04:00
Adnan Maolood
5141eaafaa Tweak request and response parsing 2021-03-20 12:27:20 -04:00
Adnan Maolood
e5c0afa013 response: Treat empty meta as invalid 2021-03-20 12:07:24 -04:00
Adnan Maolood
4c7c200f92 Remove unused field 2021-03-20 12:05:21 -04:00
Adnan Maolood
0a709da439 Remove charset=utf-8 from default media type 2021-03-20 12:04:42 -04:00
Adnan Maolood
1fdef9b608 Rename ServeMux to Mux 2021-03-15 15:44:35 -04:00
Adnan Maolood
2144e2c2f2 status: Reintroduce StatusSensitiveInput 2021-03-15 15:19:43 -04:00
Adnan Maolood
93a606b591 certificate.Store: Call os.MkdirAll on Load 2021-03-09 08:59:28 -05:00
Adnan Maolood
b00794f236 tofu: Use stricter file permissions 2021-03-09 08:58:36 -05:00
Noah Kleiner
3da7fe7cee tofu: Create path if not exists
This commit is a follow-up to 56774408 which does not take into account
the case that the parent directory of the known_hosts file does not already exist.
2021-03-09 08:50:42 -05:00
Adnan Maolood
dea7600f29 Remove StatusSensitiveInput 2021-03-08 14:08:45 -05:00
Adnan Maolood
7d958a4798 examples/client: Fix certificate trust check 2021-03-08 14:07:18 -05:00
Adnan Maolood
a5493b708a tofu: Fix known host unmarshaling 2021-03-06 15:49:11 -05:00
Adnan Maolood
6e5c2473e7 tofu: Use base64-encoded sha256 fingerprints 2021-03-06 15:24:15 -05:00
Adnan Maolood
c639233ea1 tofu: Fix format in error message 2021-03-06 15:13:06 -05:00
Adnan Maolood
5677440876 tofu: Automatically create file in KnownHosts.Load 2021-03-06 15:11:30 -05:00
Adnan Maolood
be3d09d7f4 certificate.Store: Don't call os.MkdirAll 2021-03-06 13:11:11 -05:00
Adnan Maolood
504da9afd8 certificate.Store: Don't check parent scopes in Lookup
Limit the scopes of client certificates to hostnames only instead of
hostnames and paths.
2021-03-06 12:59:33 -05:00
Adnan Maolood
d1cb8967b6 certificate.Store: Make 100 years the default duration 2021-03-05 23:29:56 -05:00
Adnan Maolood
107b3a1785 Move LoggingMiddleware out of examples/server.go 2021-03-05 11:35:01 -05:00
Adnan Maolood
e7a06a12bf certificate.Store: Clean scope path in Load
Clean the scope path so that trimming the path from the scope works for
relative paths.
2021-03-05 10:51:55 -05:00
Adnan Maolood
649b20659b Revert "certificate: Remove Subject from CreateOptions"
This reverts commit ce649ecc66.
2021-03-04 20:04:46 -05:00
Adnan Maolood
c9e2af98f3 Revert "certificate.Store: Allow using '*' in DNSNames"
This reverts commit de0b93a4f6.
2021-03-04 19:26:13 -05:00
Adnan Maolood
d6d02e398e certificate.Store: Bump default duration to 250 years 2021-03-04 16:55:09 -05:00
Adnan Maolood
de0b93a4f6 certificate.Store: Allow using '*' in DNSNames
This isn't exactly a valid DNSName, but it reduces the number of
certificates that need to be created. Clients should either accept it or
skip checking DNSNames.
2021-03-04 16:40:25 -05:00
Adnan Maolood
ce649ecc66 certificate: Remove Subject from CreateOptions 2021-03-04 16:27:16 -05:00
Adnan Maolood
688e7e2823 certificate: Fix deadlock in Store.Get 2021-03-04 16:20:57 -05:00
Adnan Maolood
b38311da00 certificate.Store: Fix hostname registration check 2021-03-04 16:12:36 -05:00
Adnan Maolood
8e2ac24830 tofu: Remove expiration timestamp from known hosts 2021-03-04 15:37:02 -05:00
Adnan Maolood
bfa3356d3a client: Remove hostname verification check 2021-03-04 14:36:31 -05:00
Adnan Maolood
9f3564936e client: Ignore certificate expiration time 2021-03-04 14:35:51 -05:00
Adnan Maolood
d8fb072826 Rename vendor.go to verify_hostname.go 2021-02-28 23:21:10 -05:00
Adnan Maolood
69f0913b3d Make Response implement io.WriterTo 2021-02-28 22:21:54 -05:00
Adnan Maolood
f7012b38da Request.WriteTo: return int64 2021-02-28 22:20:59 -05:00
Adnan Maolood
768ec6c17b Make Request implement io.WriterTo 2021-02-28 22:16:38 -05:00
Adnan Maolood
ae7d58549d Add message argument to TimeoutHandler 2021-02-28 22:07:24 -05:00
Adnan Maolood
ad5d78f08f Mention that Request methods don't work for clients 2021-02-28 21:59:19 -05:00
Adnan Maolood
4b92c71839 Remove Request.RemoteAddr helper method 2021-02-28 21:52:41 -05:00
Adnan Maolood
19f1d6693e Replace uses of ioutil with io 2021-02-28 21:38:36 -05:00
Adnan Maolood
0e87d64ffc Require Go 1.16 2021-02-28 21:38:17 -05:00
Adnan Maolood
845f8e9bd1 Reintroduce Response.Write method 2021-02-28 20:50:18 -05:00
Adnan Maolood
cf9ab18c1f certificate.Store: Check parent scopes in Lookup 2021-02-28 20:23:32 -05:00
Adnan Maolood
ada42ff427 certificate.Store: Support client certificates 2021-02-28 19:29:25 -05:00
Adnan Maolood
fcc71b76d9 examples/server: Clean up LoggingMiddleware 2021-02-27 14:53:37 -05:00
Adnan Maolood
6a1ccdc644 response: Add tests for maximum-length META 2021-02-27 14:08:31 -05:00
Adnan Maolood
f156be19b4 request: Add RemoteAddr helper function 2021-02-27 14:03:33 -05:00
Adnan Maolood
82bdffc1eb request: Add ServerName helper method 2021-02-27 14:02:30 -05:00
Adnan Maolood
a396ec77e4 request: Cache calls to TLS 2021-02-27 13:59:45 -05:00
Adnan Maolood
21ad3a2ded server: Disallow ServeConn usage after Shutdown 2021-02-24 19:25:52 -05:00
Adnan Maolood
2d7f28e152 Update examples/client.go 2021-02-24 19:21:31 -05:00
Adnan Maolood
1764e02d1e Remove ResponseWriter.Close method 2021-02-24 19:00:09 -05:00
Adnan Maolood
1bc5c68c3f response: Revert to using fields instead of methods 2021-02-24 18:50:40 -05:00
Adnan Maolood
867074d81b examples/client: Fix display of response status 2021-02-24 16:16:42 -05:00
Adnan Maolood
1da23ba07b Revert "Replace uses of ioutil with io"
This reverts commit 48c67bcead.
2021-02-24 14:45:57 -05:00
Adnan Maolood
cbfbeb6c22 Don't require Go 1.16 2021-02-24 14:29:29 -05:00
Adnan Maolood
c3418fdfed Add missing import 2021-02-24 14:28:47 -05:00
Adnan Maolood
6181751e8d Move mimetype registration to gemini.go 2021-02-24 14:27:49 -05:00
Adnan Maolood
48c67bcead Replace uses of ioutil with io 2021-02-24 11:11:10 -05:00
Adnan Maolood
25f441f573 fs: Remove build constraint 2021-02-24 11:01:02 -05:00
Adnan Maolood
cb7879c966 Add NewResponse function 2021-02-24 10:48:17 -05:00
Adnan Maolood
19bfca1cc3 examples/server: Cancel context 2021-02-24 10:27:28 -05:00
Adnan Maolood
991b18d526 examples/server: Add logging middleware 2021-02-24 10:25:08 -05:00
Adnan Maolood
b66b287f94 ResponseWriter: Remove unexported method 2021-02-24 10:01:46 -05:00
Adnan Maolood
bd29d76f66 client: Fix copying of request 2021-02-24 09:48:23 -05:00
Adnan Maolood
1d20a6c3c8 examples/client: Use Response methods 2021-02-24 09:22:25 -05:00
Adnan Maolood
6f46b2fa47 examples/auth: Use Request.TLS method 2021-02-24 09:22:01 -05:00
Adnan Maolood
15385e3095 fs: Fix Go build constraint comment 2021-02-24 09:00:28 -05:00
Adnan Maolood
3101856afa response: Move to methods 2021-02-24 08:43:57 -05:00
Adnan Maolood
094c16297b server: Fix comment 2021-02-24 08:38:08 -05:00
Adnan Maolood
08f5ddd41a TimeoutHandler: Mention returned error 2021-02-24 08:37:52 -05:00
Adnan Maolood
41c95add81 Add unexported method to timeout writer 2021-02-24 08:34:26 -05:00
Adnan Maolood
de339490f4 Move ResponseWriter Conn and TLS methods to Request 2021-02-24 08:24:49 -05:00
Adnan Maolood
b488146cc6 Remove ResponseWriter.Hijack method 2021-02-24 08:22:12 -05:00
Adnan Maolood
069b473c28 Implement TimeoutHandler by wrapping ResponseWriter 2021-02-24 08:18:23 -05:00
Kaleb Elwert
2c2d74bcb2 Only use fs.go when fs.FS is available 2021-02-24 07:41:53 -05:00
Adnan Maolood
3660698a4b Make ResponseWriter an interface
Make ResponseWriter an interface with an unexported method. Implementors
must embed a ResponseWriter from elsewhere. This gives us the
flexibility of an interface while allowing us to add new methods in the
future.
2021-02-24 00:13:46 -05:00
Adnan Maolood
526d232ab0 Remove ErrHandlerTimeout 2021-02-23 22:15:19 -05:00
Adnan Maolood
f08efa330f Move TimeoutHandler to handler.go 2021-02-23 22:12:04 -05:00
Adnan Maolood
310bd16344 Unexport NewResponseWriter 2021-02-23 22:02:47 -05:00
Adnan Maolood
9eae88f00c Reimplement TimeoutHandler 2021-02-23 21:59:16 -05:00
Adnan Maolood
b386a9ba41 response: Change field names 2021-02-23 21:51:42 -05:00
Adnan Maolood
f28a63ff0c Add ResponseWriter.Hijack method 2021-02-23 21:36:29 -05:00
Adnan Maolood
d35dd3d867 ResponseWriter: Add TLS and Conn methods 2021-02-23 20:59:04 -05:00
Adnan Maolood
75abb99518 request: Remove TLS and Conn methods 2021-02-23 20:57:53 -05:00
Adnan Maolood
e8d98ef4ec Move I/O utilities to io.go 2021-02-23 20:49:55 -05:00
Adnan Maolood
a65c3c3d4f Make ResponseWriter a struct
Make ResponseWriter a struct again so that it can be extended in a
backwards-compatible way.
2021-02-23 20:41:16 -05:00
Adnan Maolood
64f9381bbc handler: Mention when the context is canceled 2021-02-23 19:01:12 -05:00
Adnan Maolood
a34cf6dd1b handler: Mention ResponseWriter.Close method 2021-02-23 18:59:20 -05:00
Adnan Maolood
b3e8d9ccf3 client: Clarify usage of contexts 2021-02-23 18:56:18 -05:00
Adnan Maolood
a7c449a3cf Use HandlerFunc to implement StatusHandler 2021-02-23 18:52:00 -05:00
Adnan Maolood
02bbedc330 Update documentation 2021-02-23 18:45:58 -05:00
Adnan Maolood
5cf936d304 Update documentation 2021-02-23 17:52:47 -05:00
Adnan Maolood
f1f933925c Update examples/client.go 2021-02-23 17:52:34 -05:00
Adnan Maolood
e1c04ee605 Make Response an io.ReadCloser 2021-02-23 17:50:47 -05:00
Adnan Maolood
ae3fc2fc73 response: Add Close method 2021-02-23 17:32:23 -05:00
Adnan Maolood
311233a012 request: Fix documentation for TLS 2021-02-23 17:30:46 -05:00
Adnan Maolood
c688defefd request: Add Conn and TLS methods 2021-02-23 17:29:50 -05:00
Adnan Maolood
83c904913f response: Add Conn and TLS methods 2021-02-23 16:36:17 -05:00
Adnan Maolood
833edaf63d server: Cancel context on IO errors 2021-02-23 16:06:57 -05:00
Adnan Maolood
d07e9d99d1 client: Move context handling to do 2021-02-23 16:01:29 -05:00
Adnan Maolood
31e16d5a4c examples/client: Stream response body 2021-02-23 15:56:44 -05:00
Adnan Maolood
9974071657 client: Cancel context on IO errors
Also close the connection when the context expires.
2021-02-23 15:52:47 -05:00
Adnan Maolood
09e3393e4c examples/stream: Simplify 2021-02-23 15:31:41 -05:00
Adnan Maolood
1aa85d0683 timeout: Don't recover from panics 2021-02-23 15:30:44 -05:00
Adnan Maolood
62e22b4cf2 response: Remove TLS field 2021-02-23 15:29:27 -05:00
Adnan Maolood
eee7156b3a Update documentation 2021-02-23 14:29:37 -05:00
Adnan Maolood
d8b5fa716a client: Use present tense in documentation 2021-02-23 12:21:05 -05:00
Adnan Maolood
1080e95bb4 server: Document use of context in ListenAndServe 2021-02-23 12:10:55 -05:00
Adnan Maolood
f722747abd server: Make ErrorLog an interface 2021-02-23 11:10:35 -05:00
Adnan Maolood
4e25d2c3f9 ServeMux.HandleFunc: Take a HandlerFunc argument 2021-02-23 09:49:20 -05:00
Adnan Maolood
5ab7617efd server: Fix Shutdown with no active listeners
Shutdown and Close will hang if there are no active listeners or
connections. Try to close the done channel to avoid that.
2021-02-23 09:28:14 -05:00
Adnan Maolood
89f0b3f94b tofu: Update documentation 2021-02-23 09:21:21 -05:00
Adnan Maolood
964c17b99f text: Update documentation 2021-02-23 09:18:34 -05:00
Adnan Maolood
32f40523ed certificate.Store: Mention GetCertificate usage 2021-02-23 09:10:22 -05:00
Adnan Maolood
8190e819e8 server: Mention certificate store 2021-02-23 09:08:44 -05:00
Adnan Maolood
871a8fe3d2 certificate: Update documentation 2021-02-23 09:05:45 -05:00
Adnan Maolood
a4849c8eef certificate.Store: Update documentation 2021-02-23 09:03:38 -05:00
Adnan Maolood
f6bccb156a certificate.Store: Check '*' scope last 2021-02-23 08:52:12 -05:00
Adnan Maolood
3c9c087a25 certificate.Store: Allow certificate of scope '*' 2021-02-23 08:46:43 -05:00
Adnan Maolood
6de05c4b5d Update examples 2021-02-23 08:43:47 -05:00
Adnan Maolood
4c369072c8 certificate.Store: Remove client certificate support 2021-02-23 08:37:05 -05:00
Adnan Maolood
27299f537d client: Document use of contexts 2021-02-22 21:35:02 -05:00
Adnan Maolood
d61cf6318a server: Document use of contexts 2021-02-22 21:33:23 -05:00
Adnan Maolood
99e6c37d92 server: Remove unused constants 2021-02-22 21:28:18 -05:00
Adnan Maolood
31077afbbe server: Return context.Canceled after Shutdown 2021-02-22 21:27:44 -05:00
Adnan Maolood
3b8b5d6557 examples/stream: Remove /shutdown handler 2021-02-22 21:16:13 -05:00
Adnan Maolood
9aebcd362e examples/server: Shutdown on interrupt signal 2021-02-22 21:14:41 -05:00
Adnan Maolood
35f7958083 server: Revert to closing contexts on Shutdown 2021-02-22 21:13:44 -05:00
Adnan Maolood
c5b304216c examples/stream: Remove usage of Flusher 2021-02-22 20:07:37 -05:00
Adnan Maolood
118e019df0 server: Use channel to communicate shutdown 2021-02-22 20:06:19 -05:00
Adnan Maolood
2c64db3863 Rename ResponseWriter.MediaType to SetMediaType 2021-02-21 18:52:06 -05:00
Adnan Maolood
420f01da2a client: Remove Timeout
Clients should use context.WithTimeout instead.
2021-02-21 16:47:56 -05:00
Adnan Maolood
c3feafa90b Move Flush back to ResponseWriter 2021-02-21 16:06:56 -05:00
Adnan Maolood
0a3db2ce41 server: Don't close pending connections after Shutdown 2021-02-21 16:05:10 -05:00
Adnan Maolood
49dac34aff server: Export ServeConn method 2021-02-21 11:53:15 -05:00
Adnan Maolood
bb444fb364 server: Don't recover from panics 2021-02-21 11:04:45 -05:00
Adnan Maolood
a606c4fcc0 fs: Use better error messages 2021-02-21 09:56:59 -05:00
Adnan Maolood
2ece48b019 Move punycode functions to client.go 2021-02-21 09:43:23 -05:00
Adnan Maolood
a4b976c2dc client: Copy only what is needed from the Request 2021-02-21 09:41:00 -05:00
Adnan Maolood
b784442b6d Use StatusHandler in NotFoundHandler implementation 2021-02-21 09:32:07 -05:00
Adnan Maolood
57e541e103 fs: Remove unused context arguments 2021-02-21 09:29:21 -05:00
Adnan Maolood
c4c616518b Add ErrCertificateExpired 2021-02-21 09:27:12 -05:00
Adnan Maolood
352ad71af8 Remove unused ErrInvalidURL 2021-02-21 09:23:30 -05:00
26 changed files with 859 additions and 1026 deletions

View File

@@ -1,4 +1,4 @@
// Package certificate provides utility functions for TLS certificates. // Package certificate provides functions for creating and storing TLS certificates.
package certificate package certificate
import ( import (

View File

@@ -6,46 +6,55 @@ import (
"crypto/x509/pkix" "crypto/x509/pkix"
"errors" "errors"
"fmt" "fmt"
"os"
"path/filepath" "path/filepath"
"strings" "strings"
"sync" "sync"
"time" "time"
) )
// Store represents a certificate store. // A Store represents a TLS certificate store.
// The zero value for Store is an empty store ready to use. // The zero value for Store is an empty store ready to use.
// //
// Store can be used to store server certificates.
// Servers should provide a hostname or wildcard pattern as a certificate scope.
// Servers will most likely use the methods Register, Load and Get.
//
// Store can also be used to store client certificates.
// Clients should provide a hostname as a certificate scope.
// Clients will most likely use the methods Add, Load, and Lookup.
//
// Store is safe for concurrent use by multiple goroutines. // Store is safe for concurrent use by multiple goroutines.
type Store struct { type Store struct {
// CreateCertificate, if not nil, is called to create a new certificate // CreateCertificate, if not nil, is called by Get to create a new
// to replace a missing or expired certificate. If CreateCertificate // certificate to replace a missing or expired certificate.
// is nil, a certificate with a duration of 1 year will be created. // The provided scope is suitable for use in a certificate's DNSNames.
CreateCertificate func(scope string) (tls.Certificate, error) CreateCertificate func(scope string) (tls.Certificate, error)
certs map[string]tls.Certificate scopes map[string]struct{}
path string certs map[string]tls.Certificate
mu sync.RWMutex path string
mu sync.RWMutex
} }
// Register registers the provided scope in the certificate store. // Register registers the provided scope with the certificate store.
// The certificate will be created upon calling GetCertificate. // The scope can either be a hostname or a wildcard pattern (e.g. "*.example.com").
// To accept all hostnames, use the special pattern "*".
//
// Calls to Get will only succeed for registered scopes.
// Other methods are not affected.
func (s *Store) Register(scope string) { func (s *Store) Register(scope string) {
s.mu.Lock() s.mu.Lock()
defer s.mu.Unlock() defer s.mu.Unlock()
if s.certs == nil { if s.scopes == nil {
s.certs = make(map[string]tls.Certificate) s.scopes = make(map[string]struct{})
} }
s.certs[scope] = tls.Certificate{} s.scopes[scope] = struct{}{}
} }
// Add adds a certificate for the given scope to the certificate store. // Add registers the certificate for the given scope.
// If a certificate already exists for scope, Add will overwrite it.
func (s *Store) Add(scope string, cert tls.Certificate) error { func (s *Store) Add(scope string, cert tls.Certificate) error {
s.mu.Lock()
defer s.mu.Unlock()
if s.certs == nil {
s.certs = make(map[string]tls.Certificate)
}
// Parse certificate if not already parsed // Parse certificate if not already parsed
if cert.Leaf == nil { if cert.Leaf == nil {
parsed, err := x509.ParseCertificate(cert.Certificate[0]) parsed, err := x509.ParseCertificate(cert.Certificate[0])
@@ -55,20 +64,76 @@ func (s *Store) Add(scope string, cert tls.Certificate) error {
cert.Leaf = parsed cert.Leaf = parsed
} }
if err := s.write(scope, cert); err != nil {
return err
}
s.mu.Lock()
defer s.mu.Unlock()
if s.certs == nil {
s.certs = make(map[string]tls.Certificate)
}
s.certs[scope] = cert
return nil
}
func (s *Store) write(scope string, cert tls.Certificate) error {
s.mu.RLock()
defer s.mu.RUnlock()
if s.path != "" { if s.path != "" {
// Escape slash character certPath := filepath.Join(s.path, scope+".crt")
path := strings.ReplaceAll(scope, "/", ":") keyPath := filepath.Join(s.path, scope+".key")
certPath := filepath.Join(s.path, path+".crt")
keyPath := filepath.Join(s.path, path+".key")
if err := Write(cert, certPath, keyPath); err != nil { if err := Write(cert, certPath, keyPath); err != nil {
return err return err
} }
} }
s.certs[scope] = cert
return nil return nil
} }
// Get retrieves a certificate for the given hostname.
// If no matching scope has been registered, Get returns an error.
// Get generates new certificates as needed and rotates expired certificates.
// It calls CreateCertificate to create a new certificate if it is not nil,
// otherwise it creates certificates with a duration of 100 years.
//
// Get is suitable for use in a gemini.Server's GetCertificate field.
func (s *Store) Get(hostname string) (*tls.Certificate, error) {
s.mu.RLock()
_, ok := s.scopes[hostname]
if !ok {
// Try wildcard
wildcard := strings.SplitN(hostname, ".", 2)
if len(wildcard) == 2 {
hostname = "*." + wildcard[1]
_, ok = s.scopes[hostname]
}
}
if !ok {
// Try "*"
_, ok = s.scopes["*"]
}
if !ok {
s.mu.RUnlock()
return nil, errors.New("unrecognized scope")
}
cert := s.certs[hostname]
s.mu.RUnlock()
// If the certificate is empty or expired, generate a new one.
if cert.Leaf == nil || cert.Leaf.NotAfter.Before(time.Now()) {
var err error
cert, err = s.createCertificate(hostname)
if err != nil {
return nil, err
}
if err := s.Add(hostname, cert); err != nil {
return nil, fmt.Errorf("failed to add certificate for %s: %w", hostname, err)
}
}
return &cert, nil
}
// Lookup returns the certificate for the provided scope. // Lookup returns the certificate for the provided scope.
func (s *Store) Lookup(scope string) (tls.Certificate, bool) { func (s *Store) Lookup(scope string) (tls.Certificate, bool) {
s.mu.RLock() s.mu.RLock()
@@ -77,41 +142,6 @@ func (s *Store) Lookup(scope string) (tls.Certificate, bool) {
return cert, ok return cert, ok
} }
// GetCertificate retrieves the certificate for the given scope.
// If the retrieved certificate is expired or the scope is registered but
// has no certificate, it calls CreateCertificate to create a new certificate.
func (s *Store) GetCertificate(scope string) (*tls.Certificate, error) {
cert, ok := s.Lookup(scope)
if !ok {
// Try wildcard
wildcard := strings.SplitN(scope, ".", 2)
if len(wildcard) == 2 {
cert, ok = s.Lookup("*." + wildcard[1])
}
}
if !ok {
// Try "*"
_, ok = s.Lookup("*")
}
if !ok {
return nil, errors.New("unrecognized scope")
}
// If the certificate is empty or expired, generate a new one.
if cert.Leaf == nil || cert.Leaf.NotAfter.Before(time.Now()) {
var err error
cert, err = s.createCertificate(scope)
if err != nil {
return nil, err
}
if err := s.Add(scope, cert); err != nil {
return nil, fmt.Errorf("failed to add certificate for %s: %w", scope, err)
}
}
return &cert, nil
}
func (s *Store) createCertificate(scope string) (tls.Certificate, error) { func (s *Store) createCertificate(scope string) (tls.Certificate, error) {
if s.CreateCertificate != nil { if s.CreateCertificate != nil {
return s.CreateCertificate(scope) return s.CreateCertificate(scope)
@@ -121,17 +151,21 @@ func (s *Store) createCertificate(scope string) (tls.Certificate, error) {
Subject: pkix.Name{ Subject: pkix.Name{
CommonName: scope, CommonName: scope,
}, },
Duration: 365 * 24 * time.Hour, Duration: 100 * 365 * 24 * time.Hour,
}) })
} }
// Load loads certificates from the provided path. // Load loads certificates from the provided path.
// New certificates will be written to this path. // New certificates will be written to this path.
//
// The path should lead to a directory containing certificates // The path should lead to a directory containing certificates
// and private keys named "scope.crt" and "scope.key" respectively, // and private keys named "scope.crt" and "scope.key" respectively,
// where "scope" is the scope of the certificate. // where "scope" is the scope of the certificate.
func (s *Store) Load(path string) error { func (s *Store) Load(path string) error {
if err := os.MkdirAll(filepath.Dir(path), 0700); err != nil {
return err
}
path = filepath.Clean(path)
matches, err := filepath.Glob(filepath.Join(path, "*.crt")) matches, err := filepath.Glob(filepath.Join(path, "*.crt"))
if err != nil { if err != nil {
return err return err
@@ -142,12 +176,15 @@ func (s *Store) Load(path string) error {
if err != nil { if err != nil {
continue continue
} }
scope := strings.TrimSuffix(filepath.Base(crtPath), ".crt")
// Unescape slash character scope := strings.TrimPrefix(crtPath, path)
scope = strings.ReplaceAll(scope, ":", "/") scope = strings.TrimPrefix(scope, "/")
scope = strings.TrimSuffix(scope, ".crt")
s.Add(scope, cert) s.Add(scope, cert)
} }
s.SetPath(path) s.mu.Lock()
defer s.mu.Unlock()
s.path = path
return nil return nil
} }
@@ -166,5 +203,5 @@ func (s *Store) Entries() map[string]tls.Certificate {
func (s *Store) SetPath(path string) { func (s *Store) SetPath(path string) {
s.mu.Lock() s.mu.Lock()
defer s.mu.Unlock() defer s.mu.Unlock()
s.path = path s.path = filepath.Clean(path)
} }

129
client.go
View File

@@ -4,43 +4,38 @@ import (
"context" "context"
"crypto/tls" "crypto/tls"
"crypto/x509" "crypto/x509"
"errors"
"net" "net"
"net/url" "net/url"
"time" "unicode/utf8"
"golang.org/x/net/idna"
) )
// A Client is a Gemini client. Its zero value is a usable client. // A Client is a Gemini client. Its zero value is a usable client.
type Client struct { type Client struct {
// TrustCertificate is called to determine whether the client // TrustCertificate is called to determine whether the client should
// should trust the certificate provided by the server. // trust the certificate provided by the server.
// If TrustCertificate is nil, the client will accept any certificate. // If TrustCertificate is nil or returns nil, the client will accept
// If the returned error is not nil, the certificate will not be trusted // any certificate. Otherwise, the certificate will not be trusted
// and the request will be aborted. // and the request will be aborted.
// //
// See the tofu submodule for an implementation of trust on first use. // See the tofu submodule for an implementation of trust on first use.
TrustCertificate func(hostname string, cert *x509.Certificate) error TrustCertificate func(hostname string, cert *x509.Certificate) error
// Timeout specifies a time limit for requests made by this
// Client. The timeout includes connection time and reading
// the response body. The timer remains running after
// Get or Do return and will interrupt reading of the Response.Body.
//
// A Timeout of zero means no timeout.
Timeout time.Duration
// DialContext specifies the dial function for creating TCP connections. // DialContext specifies the dial function for creating TCP connections.
// If DialContext is nil, the client dials using package net. // If DialContext is nil, the client dials using package net.
DialContext func(ctx context.Context, network, addr string) (net.Conn, error) DialContext func(ctx context.Context, network, addr string) (net.Conn, error)
} }
// Get sends a Gemini request for the given URL. // Get sends a Gemini request for the given URL.
// The context controls the entire lifetime of a request and its response:
// obtaining a connection, sending the request, and reading the response
// header and body.
// //
// An error is returned if there was a Gemini protocol error. // An error is returned if there was a Gemini protocol error.
// A non-2x status code doesn't cause an error. // A non-2x status code doesn't cause an error.
// //
// If the returned error is nil, the Response will contain a non-nil Body // If the returned error is nil, the user is expected to close the Response.
// which the user is expected to close.
// //
// For more control over requests, use NewRequest and Client.Do. // For more control over requests, use NewRequest and Client.Do.
func (c *Client) Get(ctx context.Context, url string) (*Response, error) { func (c *Client) Get(ctx context.Context, url string) (*Response, error) {
@@ -51,16 +46,15 @@ func (c *Client) Get(ctx context.Context, url string) (*Response, error) {
return c.Do(ctx, req) return c.Do(ctx, req)
} }
// Do sends a Gemini request and returns a Gemini response, following // Do sends a Gemini request and returns a Gemini response.
// policy as configured on the client. // The context controls the entire lifetime of a request and its response:
// obtaining a connection, sending the request, and reading the response
// header and body.
// //
// An error is returned if there was a Gemini protocol error. // An error is returned if there was a Gemini protocol error.
// A non-2x status code doesn't cause an error. // A non-2x status code doesn't cause an error.
// //
// If the returned error is nil, the Response will contain a non-nil Body // If the returned error is nil, the user is expected to close the Response.
// which the user is expected to close.
//
// Generally Get will be used instead of Do.
func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) { func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) {
if ctx == nil { if ctx == nil {
panic("nil context") panic("nil context")
@@ -75,15 +69,17 @@ func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) {
if host != punycode { if host != punycode {
host = punycode host = punycode
// Make a copy of the request // Copy the URL and update the host
r2 := new(Request) u := new(url.URL)
*r2 = *req *u = *req.URL
r2.URL = new(url.URL) u.Host = net.JoinHostPort(host, port)
*r2.URL = *req.URL
req = r2
// Set the host // Use the new URL in the request so that the server gets
req.URL.Host = net.JoinHostPort(host, port) // the punycoded hostname
r := new(Request)
*r = *req
r.URL = u
req = r
} }
// Use request host if provided // Use request host if provided
@@ -98,17 +94,11 @@ func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) {
addr := net.JoinHostPort(host, port) addr := net.JoinHostPort(host, port)
// Connect to the host // Connect to the host
start := time.Now()
conn, err := c.dialContext(ctx, "tcp", addr) conn, err := c.dialContext(ctx, "tcp", addr)
if err != nil { if err != nil {
return nil, err return nil, err
} }
// Set the connection deadline
if c.Timeout != 0 {
conn.SetDeadline(start.Add(c.Timeout))
}
// Setup TLS // Setup TLS
conn = tls.Client(conn, &tls.Config{ conn = tls.Client(conn, &tls.Config{
InsecureSkipVerify: true, InsecureSkipVerify: true,
@@ -132,7 +122,7 @@ func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) {
res := make(chan result, 1) res := make(chan result, 1)
go func() { go func() {
resp, err := c.do(conn, req) resp, err := c.do(ctx, conn, req)
res <- result{resp, err} res <- result{resp, err}
}() }()
@@ -141,27 +131,40 @@ func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) {
conn.Close() conn.Close()
return nil, ctx.Err() return nil, ctx.Err()
case r := <-res: case r := <-res:
if r.err != nil {
conn.Close()
}
return r.resp, r.err return r.resp, r.err
} }
} }
func (c *Client) do(conn net.Conn, req *Request) (*Response, error) { func (c *Client) do(ctx context.Context, conn net.Conn, req *Request) (*Response, error) {
ctx, cancel := context.WithCancel(ctx)
done := ctx.Done()
w := &contextWriter{
ctx: ctx,
done: done,
cancel: cancel,
wc: conn,
}
rc := &contextReader{
ctx: ctx,
done: done,
cancel: cancel,
rc: conn,
}
// Write the request // Write the request
if err := req.Write(conn); err != nil { if _, err := req.WriteTo(w); err != nil {
return nil, err return nil, err
} }
// Read the response // Read the response
resp, err := ReadResponse(conn) resp, err := ReadResponse(rc)
if err != nil { if err != nil {
return nil, err return nil, err
} }
resp.conn = conn
// Store TLS connection state
if tlsConn, ok := conn.(*tls.Conn); ok {
state := tlsConn.ConnectionState()
resp.TLS = &state
}
return resp, nil return resp, nil
} }
@@ -170,23 +173,13 @@ func (c *Client) dialContext(ctx context.Context, network, addr string) (net.Con
if c.DialContext != nil { if c.DialContext != nil {
return c.DialContext(ctx, network, addr) return c.DialContext(ctx, network, addr)
} }
return (&net.Dialer{ return (&net.Dialer{}).DialContext(ctx, network, addr)
Timeout: c.Timeout,
}).DialContext(ctx, network, addr)
} }
func (c *Client) verifyConnection(cs tls.ConnectionState, hostname string) error { func (c *Client) verifyConnection(cs tls.ConnectionState, hostname string) error {
cert := cs.PeerCertificates[0]
// Verify hostname
if err := verifyHostname(cert, hostname); err != nil {
return err
}
// Check expiration date
if !time.Now().Before(cert.NotAfter) {
return errors.New("gemini: certificate expired")
}
// See if the client trusts the certificate // See if the client trusts the certificate
if c.TrustCertificate != nil { if c.TrustCertificate != nil {
cert := cs.PeerCertificates[0]
return c.TrustCertificate(hostname, cert) return c.TrustCertificate(hostname, cert)
} }
return nil return nil
@@ -202,3 +195,23 @@ func splitHostPort(hostport string) (host, port string) {
} }
return return
} }
func isASCII(s string) bool {
for i := 0; i < len(s); i++ {
if s[i] >= utf8.RuneSelf {
return false
}
}
return true
}
// punycodeHostname returns the punycoded version of hostname.
func punycodeHostname(hostname string) (string, error) {
if net.ParseIP(hostname) != nil {
return hostname, nil
}
if isASCII(hostname) {
return hostname, nil
}
return idna.Lookup.ToASCII(hostname)
}

15
doc.go
View File

@@ -4,7 +4,8 @@ Package gemini provides Gemini client and server implementations.
Client is a Gemini client. Client is a Gemini client.
client := &gemini.Client{} client := &gemini.Client{}
resp, err := client.Get("gemini://example.com") ctx := context.Background()
resp, err := client.Get(ctx, "gemini://example.com")
if err != nil { if err != nil {
// handle error // handle error
} }
@@ -21,16 +22,17 @@ Server is a Gemini server.
Servers should be configured with certificates: Servers should be configured with certificates:
certificates := &certificate.Store{} certificates := &certificate.Store{}
certificates.Register("localhost")
err := certificates.Load("/var/lib/gemini/certs") err := certificates.Load("/var/lib/gemini/certs")
if err != nil { if err != nil {
// handle error // handle error
} }
server.GetCertificate = certificates.GetCertificate server.GetCertificate = certificates.Get
ServeMux is a Gemini request multiplexer. Mux is a Gemini request multiplexer.
ServeMux can handle requests for multiple hosts and schemes. Mux can handle requests for multiple hosts and schemes.
mux := &gemini.ServeMux{} mux := &gemini.Mux{}
mux.HandleFunc("example.com", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) { mux.HandleFunc("example.com", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
fmt.Fprint(w, "Welcome to example.com") fmt.Fprint(w, "Welcome to example.com")
}) })
@@ -44,7 +46,8 @@ ServeMux can handle requests for multiple hosts and schemes.
To start the server, call ListenAndServe: To start the server, call ListenAndServe:
err := server.ListenAndServe(context.Background()) ctx := context.Background()
err := server.ListenAndServe(ctx)
if err != nil { if err != nil {
// handle error // handle error
} }

View File

@@ -30,7 +30,7 @@ func main() {
log.Fatal(err) log.Fatal(err)
} }
mux := &gemini.ServeMux{} mux := &gemini.Mux{}
mux.HandleFunc("/", profile) mux.HandleFunc("/", profile)
mux.HandleFunc("/username", changeUsername) mux.HandleFunc("/username", changeUsername)
@@ -38,7 +38,7 @@ func main() {
Handler: mux, Handler: mux,
ReadTimeout: 30 * time.Second, ReadTimeout: 30 * time.Second,
WriteTimeout: 1 * time.Minute, WriteTimeout: 1 * time.Minute,
GetCertificate: certificates.GetCertificate, GetCertificate: certificates.Get,
} }
if err := server.ListenAndServe(context.Background()); err != nil { if err := server.ListenAndServe(context.Background()); err != nil {
@@ -52,11 +52,12 @@ func fingerprint(cert *x509.Certificate) string {
} }
func profile(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) { func profile(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
if len(r.TLS.PeerCertificates) == 0 { tls := r.TLS()
if len(tls.PeerCertificates) == 0 {
w.WriteHeader(gemini.StatusCertificateRequired, "Certificate required") w.WriteHeader(gemini.StatusCertificateRequired, "Certificate required")
return return
} }
fingerprint := fingerprint(r.TLS.PeerCertificates[0]) fingerprint := fingerprint(tls.PeerCertificates[0])
user, ok := users[fingerprint] user, ok := users[fingerprint]
if !ok { if !ok {
user = &User{} user = &User{}
@@ -67,7 +68,8 @@ func profile(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
} }
func changeUsername(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) { func changeUsername(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
if len(r.TLS.PeerCertificates) == 0 { tls := r.TLS()
if len(tls.PeerCertificates) == 0 {
w.WriteHeader(gemini.StatusCertificateRequired, "Certificate required") w.WriteHeader(gemini.StatusCertificateRequired, "Certificate required")
return return
} }
@@ -77,7 +79,7 @@ func changeUsername(ctx context.Context, w gemini.ResponseWriter, r *gemini.Requ
w.WriteHeader(gemini.StatusInput, "Username") w.WriteHeader(gemini.StatusInput, "Username")
return return
} }
fingerprint := fingerprint(r.TLS.PeerCertificates[0]) fingerprint := fingerprint(tls.PeerCertificates[0])
user, ok := users[fingerprint] user, ok := users[fingerprint]
if !ok { if !ok {
user = &User{} user = &User{}

View File

@@ -6,7 +6,6 @@ package main
import ( import (
"bufio" "bufio"
"bytes"
"context" "context"
"crypto/x509" "crypto/x509"
"errors" "errors"
@@ -16,7 +15,6 @@ import (
"net/url" "net/url"
"os" "os"
"path/filepath" "path/filepath"
"time"
"git.sr.ht/~adnano/go-gemini" "git.sr.ht/~adnano/go-gemini"
"git.sr.ht/~adnano/go-gemini/tofu" "git.sr.ht/~adnano/go-gemini/tofu"
@@ -61,15 +59,14 @@ Otherwise, this should be safe to trust.
=> ` => `
func trustCertificate(hostname string, cert *x509.Certificate) error { func trustCertificate(hostname string, cert *x509.Certificate) error {
host := tofu.NewHost(hostname, cert.Raw, cert.NotAfter) host := tofu.NewHost(hostname, cert.Raw)
knownHost, ok := hosts.Lookup(hostname) knownHost, ok := hosts.Lookup(hostname)
if ok && time.Now().Before(knownHost.Expires) { if ok {
// Check fingerprint // Check fingerprint
if bytes.Equal(knownHost.Fingerprint, host.Fingerprint) { if knownHost.Fingerprint != host.Fingerprint {
return nil return errors.New("error: fingerprint does not match!")
} }
return errors.New("error: fingerprint does not match!") return nil
} }
fmt.Printf(trustPrompt, hostname, host.Fingerprint) fmt.Printf(trustPrompt, hostname, host.Fingerprint)
@@ -87,7 +84,7 @@ func trustCertificate(hostname string, cert *x509.Certificate) error {
} }
} }
func getInput(prompt string, sensitive bool) (input string, ok bool) { func getInput(prompt string) (input string, ok bool) {
fmt.Printf("%s ", prompt) fmt.Printf("%s ", prompt)
scanner.Scan() scanner.Scan()
return scanner.Text(), true return scanner.Text(), true
@@ -97,14 +94,15 @@ func do(req *gemini.Request, via []*gemini.Request) (*gemini.Response, error) {
client := gemini.Client{ client := gemini.Client{
TrustCertificate: trustCertificate, TrustCertificate: trustCertificate,
} }
resp, err := client.Do(context.Background(), req) ctx := context.Background()
resp, err := client.Do(ctx, req)
if err != nil { if err != nil {
return resp, err return resp, err
} }
switch resp.Status.Class() { switch resp.Status.Class() {
case gemini.StatusInput: case gemini.StatusInput:
input, ok := getInput(resp.Meta, resp.Status == gemini.StatusSensitiveInput) input, ok := getInput(resp.Meta)
if !ok { if !ok {
break break
} }
@@ -156,11 +154,10 @@ func main() {
// Handle response // Handle response
if resp.Status.Class() == gemini.StatusSuccess { if resp.Status.Class() == gemini.StatusSuccess {
body, err := io.ReadAll(resp.Body) _, err := io.Copy(os.Stdout, resp.Body)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
} }
fmt.Print(string(body))
} else { } else {
fmt.Printf("%d %s\n", resp.Status, resp.Meta) fmt.Printf("%d %s\n", resp.Status, resp.Meta)
os.Exit(1) os.Exit(1)

View File

@@ -8,6 +8,7 @@ import (
"context" "context"
"log" "log"
"os" "os"
"os/signal"
"time" "time"
"git.sr.ht/~adnano/go-gemini" "git.sr.ht/~adnano/go-gemini"
@@ -21,17 +22,37 @@ func main() {
log.Fatal(err) log.Fatal(err)
} }
mux := &gemini.ServeMux{} mux := &gemini.Mux{}
mux.Handle("/", gemini.FileServer(os.DirFS("/var/www"))) mux.Handle("/", gemini.FileServer(os.DirFS("/var/www")))
server := &gemini.Server{ server := &gemini.Server{
Handler: mux, Handler: gemini.LoggingMiddleware(mux),
ReadTimeout: 30 * time.Second, ReadTimeout: 30 * time.Second,
WriteTimeout: 1 * time.Minute, WriteTimeout: 1 * time.Minute,
GetCertificate: certificates.GetCertificate, GetCertificate: certificates.Get,
} }
if err := server.ListenAndServe(context.Background()); err != nil { // Listen for interrupt signal
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
errch := make(chan error)
go func() {
ctx := context.Background()
errch <- server.ListenAndServe(ctx)
}()
select {
case err := <-errch:
log.Fatal(err) log.Fatal(err)
case <-c:
// Shutdown the server
log.Println("Shutting down...")
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
err := server.Shutdown(ctx)
if err != nil {
log.Fatal(err)
}
} }
} }

View File

@@ -8,7 +8,6 @@ import (
"context" "context"
"fmt" "fmt"
"log" "log"
"sync"
"time" "time"
"git.sr.ht/~adnano/go-gemini" "git.sr.ht/~adnano/go-gemini"
@@ -22,71 +21,34 @@ func main() {
log.Fatal(err) log.Fatal(err)
} }
mux := &gemini.ServeMux{} mux := &gemini.Mux{}
mux.HandleFunc("/", stream) mux.HandleFunc("/", stream)
server := &gemini.Server{ server := &gemini.Server{
Handler: mux, Handler: mux,
ReadTimeout: 30 * time.Second, ReadTimeout: 30 * time.Second,
WriteTimeout: 1 * time.Minute, WriteTimeout: 1 * time.Minute,
GetCertificate: certificates.GetCertificate, GetCertificate: certificates.Get,
} }
var shutdownOnce sync.Once ctx := context.Background()
var wg sync.WaitGroup if err := server.ListenAndServe(ctx); err != nil {
wg.Add(1) log.Fatal(err)
defer wg.Wait()
mux.HandleFunc("/shutdown", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
fmt.Fprintln(w, "Shutting down...")
if flusher, ok := w.(gemini.Flusher); ok {
flusher.Flush()
}
go shutdownOnce.Do(func() {
server.Shutdown(context.Background())
wg.Done()
})
})
if err := server.ListenAndServe(context.Background()); err != nil {
log.Println(err)
} }
} }
// stream writes an infinite stream to w. // stream writes an infinite stream to w.
func stream(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) { func stream(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
flusher, ok := w.(gemini.Flusher)
if !ok {
w.WriteHeader(gemini.StatusTemporaryFailure, "Internal error")
return
}
ch := make(chan string)
ctx, cancel := context.WithCancel(ctx)
go func(ctx context.Context) {
for {
select {
case <-ctx.Done():
return
default:
ch <- fmt.Sprint(time.Now().UTC())
}
time.Sleep(time.Second)
}
// Close channel when finished.
// In this example this will never be reached.
close(ch)
}(ctx)
for { for {
s, ok := <-ch select {
if !ok { case <-ctx.Done():
break return
default:
} }
fmt.Fprintln(w, s) fmt.Fprintln(w, time.Now().UTC())
if err := flusher.Flush(); err != nil { if err := w.Flush(); err != nil {
cancel()
return return
} }
time.Sleep(time.Second)
} }
} }

48
fs.go
View File

@@ -2,6 +2,7 @@ package gemini
import ( import (
"context" "context"
"errors"
"fmt" "fmt"
"io" "io"
"io/fs" "io/fs"
@@ -12,12 +13,6 @@ import (
"strings" "strings"
) )
func init() {
// Add Gemini mime types
mime.AddExtensionType(".gmi", "text/gemini")
mime.AddExtensionType(".gemini", "text/gemini")
}
// FileServer returns a handler that serves Gemini requests with the contents // FileServer returns a handler that serves Gemini requests with the contents
// of the provided file system. // of the provided file system.
// //
@@ -33,7 +28,7 @@ type fileServer struct {
} }
func (fs fileServer) ServeGemini(ctx context.Context, w ResponseWriter, r *Request) { func (fs fileServer) ServeGemini(ctx context.Context, w ResponseWriter, r *Request) {
serveFile(ctx, w, r, fs, path.Clean(r.URL.Path), true) serveFile(w, r, fs, path.Clean(r.URL.Path), true)
} }
// ServeContent replies to the request using the content in the // ServeContent replies to the request using the content in the
@@ -42,15 +37,15 @@ func (fs fileServer) ServeGemini(ctx context.Context, w ResponseWriter, r *Reque
// //
// ServeContent tries to deduce the type from name's file extension. // ServeContent tries to deduce the type from name's file extension.
// The name is otherwise unused; it is never sent in the response. // The name is otherwise unused; it is never sent in the response.
func ServeContent(ctx context.Context, w ResponseWriter, r *Request, name string, content io.Reader) { func ServeContent(w ResponseWriter, r *Request, name string, content io.Reader) {
serveContent(ctx, w, name, content) serveContent(w, name, content)
} }
func serveContent(ctx context.Context, w ResponseWriter, name string, content io.Reader) { func serveContent(w ResponseWriter, name string, content io.Reader) {
// Detect mimetype from file extension // Detect mimetype from file extension
ext := path.Ext(name) ext := path.Ext(name)
mimetype := mime.TypeByExtension(ext) mimetype := mime.TypeByExtension(ext)
w.MediaType(mimetype) w.SetMediaType(mimetype)
io.Copy(w, content) io.Copy(w, content)
} }
@@ -64,8 +59,8 @@ func serveContent(ctx context.Context, w ResponseWriter, name string, content io
// //
// As a precaution, ServeFile will reject requests where r.URL.Path contains a // As a precaution, ServeFile will reject requests where r.URL.Path contains a
// ".." path element; this protects against callers who might unsafely use // ".." path element; this protects against callers who might unsafely use
// filepath.Join on r.URL.Path without sanitizing it and then use that // path.Join on r.URL.Path without sanitizing it and then use that
// filepath.Join result as the name argument. // path.Join result as the name argument.
// //
// As another special case, ServeFile redirects any request where r.URL.Path // As another special case, ServeFile redirects any request where r.URL.Path
// ends in "/index.gmi" to the same path, without the final "index.gmi". To // ends in "/index.gmi" to the same path, without the final "index.gmi". To
@@ -74,17 +69,17 @@ func serveContent(ctx context.Context, w ResponseWriter, name string, content io
// Outside of those two special cases, ServeFile does not use r.URL.Path for // Outside of those two special cases, ServeFile does not use r.URL.Path for
// selecting the file or directory to serve; only the file or directory // selecting the file or directory to serve; only the file or directory
// provided in the name argument is used. // provided in the name argument is used.
func ServeFile(ctx context.Context, w ResponseWriter, r *Request, fsys fs.FS, name string) { func ServeFile(w ResponseWriter, r *Request, fsys fs.FS, name string) {
if containsDotDot(r.URL.Path) { if containsDotDot(r.URL.Path) {
// Too many programs use r.URL.Path to construct the argument to // Too many programs use r.URL.Path to construct the argument to
// serveFile. Reject the request under the assumption that happened // serveFile. Reject the request under the assumption that happened
// here and ".." may not be wanted. // here and ".." may not be wanted.
// Note that name might not contain "..", for example if code (still // Note that name might not contain "..", for example if code (still
// incorrectly) used filepath.Join(myDir, r.URL.Path). // incorrectly) used path.Join(myDir, r.URL.Path).
w.WriteHeader(StatusBadRequest, "invalid URL path") w.WriteHeader(StatusBadRequest, "invalid URL path")
return return
} }
serveFile(ctx, w, r, fsys, name, false) serveFile(w, r, fsys, name, false)
} }
func containsDotDot(v string) bool { func containsDotDot(v string) bool {
@@ -101,7 +96,7 @@ func containsDotDot(v string) bool {
func isSlashRune(r rune) bool { return r == '/' || r == '\\' } func isSlashRune(r rune) bool { return r == '/' || r == '\\' }
func serveFile(ctx context.Context, w ResponseWriter, r *Request, fsys fs.FS, name string, redirect bool) { func serveFile(w ResponseWriter, r *Request, fsys fs.FS, name string, redirect bool) {
const indexPage = "/index.gmi" const indexPage = "/index.gmi"
// Redirect .../index.gmi to .../ // Redirect .../index.gmi to .../
@@ -118,14 +113,14 @@ func serveFile(ctx context.Context, w ResponseWriter, r *Request, fsys fs.FS, na
f, err := fsys.Open(name) f, err := fsys.Open(name)
if err != nil { if err != nil {
w.WriteHeader(StatusNotFound, "Not found") w.WriteHeader(toGeminiError(err))
return return
} }
defer f.Close() defer f.Close()
stat, err := f.Stat() stat, err := f.Stat()
if err != nil { if err != nil {
w.WriteHeader(StatusTemporaryFailure, "Temporary failure") w.WriteHeader(toGeminiError(err))
return return
} }
@@ -156,7 +151,8 @@ func serveFile(ctx context.Context, w ResponseWriter, r *Request, fsys fs.FS, na
} }
// Use contents of index.gmi if present // Use contents of index.gmi if present
index, err := fsys.Open(path.Join(name, indexPage)) name = path.Join(name, indexPage)
index, err := fsys.Open(name)
if err == nil { if err == nil {
defer index.Close() defer index.Close()
istat, err := index.Stat() istat, err := index.Stat()
@@ -173,7 +169,7 @@ func serveFile(ctx context.Context, w ResponseWriter, r *Request, fsys fs.FS, na
return return
} }
serveContent(ctx, w, name, f) serveContent(w, name, f)
} }
func dirList(w ResponseWriter, f fs.File) { func dirList(w ResponseWriter, f fs.File) {
@@ -204,3 +200,13 @@ func dirList(w ResponseWriter, f fs.File) {
fmt.Fprintln(w, link.String()) fmt.Fprintln(w, link.String())
} }
} }
func toGeminiError(err error) (status Status, meta string) {
if errors.Is(err, fs.ErrNotExist) {
return StatusNotFound, "Not found"
}
if errors.Is(err, fs.ErrPermission) {
return StatusNotFound, "Forbidden"
}
return StatusTemporaryFailure, "Internal server error"
}

View File

@@ -2,31 +2,33 @@ package gemini
import ( import (
"errors" "errors"
"mime"
) )
var crlf = []byte("\r\n") func init() {
// Add Gemini mime types
mime.AddExtensionType(".gmi", "text/gemini")
mime.AddExtensionType(".gemini", "text/gemini")
}
// Errors. // Errors.
var ( var (
ErrInvalidURL = errors.New("gemini: invalid URL")
ErrInvalidRequest = errors.New("gemini: invalid request") ErrInvalidRequest = errors.New("gemini: invalid request")
ErrInvalidResponse = errors.New("gemini: invalid response") ErrInvalidResponse = errors.New("gemini: invalid response")
// ErrBodyNotAllowed is returned by ResponseWriter.Write calls // ErrBodyNotAllowed is returned by ResponseWriter.Write calls
// when the response status code does not permit a body. // when the response status code does not permit a body.
ErrBodyNotAllowed = errors.New("gemini: response status code does not allow body") ErrBodyNotAllowed = errors.New("gemini: response status code does not allow body")
// ErrServerClosed is returned by the Server's Serve and ListenAndServe
// methods after a call to Shutdown or Close.
ErrServerClosed = errors.New("gemini: server closed")
// ErrAbortHandler is a sentinel panic value to abort a handler.
// While any panic from ServeGemini aborts the response to the client,
// panicking with ErrAbortHandler also suppresses logging of a stack
// trace to the server's error log.
ErrAbortHandler = errors.New("gemini: abort Handler")
// ErrHandlerTimeout is returned on ResponseWriter Write calls
// in handlers which have timed out.
ErrHandlerTimeout = errors.New("gemini: Handler timeout")
) )
var crlf = []byte("\r\n")
func trimCRLF(b []byte) ([]byte, bool) {
// Check for CR
if len(b) < 2 || b[len(b)-2] != '\r' {
return nil, false
}
// Trim CRLF
b = b[:len(b)-2]
return b, true
}

View File

@@ -1,9 +1,12 @@
package gemini package gemini
import ( import (
"bytes"
"context" "context"
"io"
"net/url" "net/url"
"strings" "strings"
"time"
) )
// A Handler responds to a Gemini request. // A Handler responds to a Gemini request.
@@ -13,14 +16,10 @@ import (
// valid to use the ResponseWriter after or concurrently with the completion // valid to use the ResponseWriter after or concurrently with the completion
// of the ServeGemini call. // of the ServeGemini call.
// //
// Handlers should not modify the provided Request. // The provided context is canceled when the client's connection is closed
// or the ServeGemini method returns.
// //
// If ServeGemini panics, the server (the caller of ServeGemini) assumes that // Handlers should not modify the provided Request.
// the effect of the panic was isolated to the active request. It recovers
// the panic, logs a stack trace to the server error log, and closes the
// network connection. To abort a handler so the client sees an interrupted
// response but the server doesn't log an error, panic with the value
// ErrAbortHandler.
type Handler interface { type Handler interface {
ServeGemini(context.Context, ResponseWriter, *Request) ServeGemini(context.Context, ResponseWriter, *Request)
} }
@@ -38,24 +37,15 @@ func (f HandlerFunc) ServeGemini(ctx context.Context, w ResponseWriter, r *Reque
// StatusHandler returns a request handler that responds to each request // StatusHandler returns a request handler that responds to each request
// with the provided status code and meta. // with the provided status code and meta.
func StatusHandler(status Status, meta string) Handler { func StatusHandler(status Status, meta string) Handler {
return &statusHandler{status, meta} return HandlerFunc(func(ctx context.Context, w ResponseWriter, r *Request) {
} w.WriteHeader(status, meta)
})
type statusHandler struct {
status Status
meta string
}
func (h *statusHandler) ServeGemini(ctx context.Context, w ResponseWriter, r *Request) {
w.WriteHeader(h.status, h.meta)
} }
// NotFoundHandler returns a simple request handler that replies to each // NotFoundHandler returns a simple request handler that replies to each
// request with a “51 Not found” reply. // request with a “51 Not found” reply.
func NotFoundHandler() Handler { func NotFoundHandler() Handler {
return HandlerFunc(func(ctx context.Context, w ResponseWriter, r *Request) { return StatusHandler(StatusNotFound, "Not found")
w.WriteHeader(StatusNotFound, "Not found")
})
} }
// StripPrefix returns a handler that serves Gemini requests by removing the // StripPrefix returns a handler that serves Gemini requests by removing the
@@ -84,3 +74,85 @@ func StripPrefix(prefix string, h Handler) Handler {
} }
}) })
} }
// TimeoutHandler returns a Handler that runs h with the given time limit.
//
// The new Handler calls h.ServeGemini to handle each request, but
// if a call runs for longer than its time limit, the handler responds with a
// 40 Temporary Failure status code and the given message in its response meta.
// After such a timeout, writes by h to its ResponseWriter will return
// context.DeadlineExceeded.
func TimeoutHandler(h Handler, dt time.Duration, message string) Handler {
return &timeoutHandler{
h: h,
dt: dt,
msg: message,
}
}
type timeoutHandler struct {
h Handler
dt time.Duration
msg string
}
func (t *timeoutHandler) ServeGemini(ctx context.Context, w ResponseWriter, r *Request) {
ctx, cancel := context.WithTimeout(ctx, t.dt)
defer cancel()
buf := &bytes.Buffer{}
tw := &timeoutWriter{
wr: &contextWriter{
ctx: ctx,
cancel: cancel,
done: ctx.Done(),
wc: nopCloser{buf},
},
}
done := make(chan struct{})
go func() {
t.h.ServeGemini(ctx, tw, r)
close(done)
}()
select {
case <-done:
w.WriteHeader(tw.status, tw.meta)
w.Write(buf.Bytes())
case <-ctx.Done():
w.WriteHeader(StatusTemporaryFailure, t.msg)
}
}
type timeoutWriter struct {
wr io.Writer
status Status
meta string
mediatype string
wroteHeader bool
}
func (w *timeoutWriter) SetMediaType(mediatype string) {
w.mediatype = mediatype
}
func (w *timeoutWriter) Write(b []byte) (int, error) {
if !w.wroteHeader {
w.WriteHeader(StatusSuccess, w.mediatype)
}
return w.wr.Write(b)
}
func (w *timeoutWriter) WriteHeader(status Status, meta string) {
if w.wroteHeader {
return
}
w.status = status
w.meta = meta
w.wroteHeader = true
}
func (w *timeoutWriter) Flush() error {
return nil
}

76
io.go Normal file
View File

@@ -0,0 +1,76 @@
package gemini
import (
"context"
"io"
)
type contextReader struct {
ctx context.Context
done <-chan struct{}
cancel func()
rc io.ReadCloser
}
func (r *contextReader) Read(p []byte) (int, error) {
select {
case <-r.done:
r.rc.Close()
return 0, r.ctx.Err()
default:
}
n, err := r.rc.Read(p)
if err != nil {
r.cancel()
}
return n, err
}
func (r *contextReader) Close() error {
r.cancel()
return r.rc.Close()
}
type contextWriter struct {
ctx context.Context
done <-chan struct{}
cancel func()
wc io.WriteCloser
}
func (w *contextWriter) Write(b []byte) (int, error) {
select {
case <-w.done:
w.wc.Close()
return 0, w.ctx.Err()
default:
}
n, err := w.wc.Write(b)
if err != nil {
w.cancel()
}
return n, err
}
func (w *contextWriter) Close() error {
w.cancel()
return w.wc.Close()
}
type nopCloser struct {
io.Writer
}
func (nopCloser) Close() error {
return nil
}
type nopReadCloser struct{}
func (nopReadCloser) Read(p []byte) (int, error) {
return 0, io.EOF
}
func (nopReadCloser) Close() error {
return nil
}

53
middleware.go Normal file
View File

@@ -0,0 +1,53 @@
package gemini
import (
"context"
"log"
)
// LoggingMiddleware returns a handler that wraps h and logs Gemini requests
// and their responses to the log package's standard logger.
// Requests are logged with the format "gemini: {host} {URL} {status code} {bytes written}".
func LoggingMiddleware(h Handler) Handler {
return HandlerFunc(func(ctx context.Context, w ResponseWriter, r *Request) {
lw := &logResponseWriter{rw: w}
h.ServeGemini(ctx, lw, r)
host := r.ServerName()
log.Printf("gemini: %s %q %d %d", host, r.URL, lw.Status, lw.Wrote)
})
}
type logResponseWriter struct {
Status Status
Wrote int
rw ResponseWriter
mediatype string
wroteHeader bool
}
func (w *logResponseWriter) SetMediaType(mediatype string) {
w.mediatype = mediatype
}
func (w *logResponseWriter) Write(b []byte) (int, error) {
if !w.wroteHeader {
w.WriteHeader(StatusSuccess, w.mediatype)
}
n, err := w.rw.Write(b)
w.Wrote += n
return n, err
}
func (w *logResponseWriter) WriteHeader(status Status, meta string) {
if w.wroteHeader {
return
}
w.wroteHeader = true
w.Status = status
w.Wrote += len(meta) + 5
w.rw.WriteHeader(status, meta)
}
func (w *logResponseWriter) Flush() error {
return nil
}

31
mux.go
View File

@@ -10,7 +10,7 @@ import (
"sync" "sync"
) )
// ServeMux is a Gemini request multiplexer. // Mux is a Gemini request multiplexer.
// It matches the URL of each incoming request against a list of registered // It matches the URL of each incoming request against a list of registered
// patterns and calls the handler for the pattern that // patterns and calls the handler for the pattern that
// most closely matches the URL. // most closely matches the URL.
@@ -55,17 +55,17 @@ import (
// scheme of "gemini". // scheme of "gemini".
// //
// If a subtree has been registered and a request is received naming the // If a subtree has been registered and a request is received naming the
// subtree root without its trailing slash, ServeMux redirects that // subtree root without its trailing slash, Mux redirects that
// request to the subtree root (adding the trailing slash). This behavior can // request to the subtree root (adding the trailing slash). This behavior can
// be overridden with a separate registration for the path without // be overridden with a separate registration for the path without
// the trailing slash. For example, registering "/images/" causes ServeMux // the trailing slash. For example, registering "/images/" causes Mux
// to redirect a request for "/images" to "/images/", unless "/images" has // to redirect a request for "/images" to "/images/", unless "/images" has
// been registered separately. // been registered separately.
// //
// ServeMux also takes care of sanitizing the URL request path and // Mux also takes care of sanitizing the URL request path and
// redirecting any request containing . or .. elements or repeated slashes // redirecting any request containing . or .. elements or repeated slashes
// to an equivalent, cleaner URL. // to an equivalent, cleaner URL.
type ServeMux struct { type Mux struct {
mu sync.RWMutex mu sync.RWMutex
m map[muxKey]Handler m map[muxKey]Handler
es []muxEntry // slice of entries sorted from longest to shortest es []muxEntry // slice of entries sorted from longest to shortest
@@ -106,7 +106,7 @@ func cleanPath(p string) string {
// Find a handler on a handler map given a path string. // Find a handler on a handler map given a path string.
// Most-specific (longest) pattern wins. // Most-specific (longest) pattern wins.
func (mux *ServeMux) match(key muxKey) Handler { func (mux *Mux) match(key muxKey) Handler {
// Check for exact match first. // Check for exact match first.
if r, ok := mux.m[key]; ok { if r, ok := mux.m[key]; ok {
return r return r
@@ -134,7 +134,7 @@ func (mux *ServeMux) match(key muxKey) Handler {
// This occurs when a handler for path + "/" was already registered, but // This occurs when a handler for path + "/" was already registered, but
// not for path itself. If the path needs appending to, it creates a new // not for path itself. If the path needs appending to, it creates a new
// URL, setting the path to u.Path + "/" and returning true to indicate so. // URL, setting the path to u.Path + "/" and returning true to indicate so.
func (mux *ServeMux) redirectToPathSlash(key muxKey, u *url.URL) (*url.URL, bool) { func (mux *Mux) redirectToPathSlash(key muxKey, u *url.URL) (*url.URL, bool) {
mux.mu.RLock() mux.mu.RLock()
shouldRedirect := mux.shouldRedirectRLocked(key) shouldRedirect := mux.shouldRedirectRLocked(key)
mux.mu.RUnlock() mux.mu.RUnlock()
@@ -146,8 +146,8 @@ func (mux *ServeMux) redirectToPathSlash(key muxKey, u *url.URL) (*url.URL, bool
// shouldRedirectRLocked reports whether the given path and host should be redirected to // shouldRedirectRLocked reports whether the given path and host should be redirected to
// path+"/". This should happen if a handler is registered for path+"/" but // path+"/". This should happen if a handler is registered for path+"/" but
// not path -- see comments at ServeMux. // not path -- see comments at Mux.
func (mux *ServeMux) shouldRedirectRLocked(key muxKey) bool { func (mux *Mux) shouldRedirectRLocked(key muxKey) bool {
if _, exist := mux.m[key]; exist { if _, exist := mux.m[key]; exist {
return false return false
} }
@@ -177,7 +177,7 @@ func getWildcard(hostname string) (string, bool) {
// the path is not in its canonical form, the handler will be an // the path is not in its canonical form, the handler will be an
// internally-generated handler that redirects to the canonical path. If the // internally-generated handler that redirects to the canonical path. If the
// host contains a port, it is ignored when matching handlers. // host contains a port, it is ignored when matching handlers.
func (mux *ServeMux) Handler(r *Request) Handler { func (mux *Mux) Handler(r *Request) Handler {
scheme := r.URL.Scheme scheme := r.URL.Scheme
host := r.URL.Hostname() host := r.URL.Hostname()
path := cleanPath(r.URL.Path) path := cleanPath(r.URL.Path)
@@ -212,14 +212,14 @@ func (mux *ServeMux) Handler(r *Request) Handler {
// ServeGemini dispatches the request to the handler whose // ServeGemini dispatches the request to the handler whose
// pattern most closely matches the request URL. // pattern most closely matches the request URL.
func (mux *ServeMux) ServeGemini(ctx context.Context, w ResponseWriter, r *Request) { func (mux *Mux) ServeGemini(ctx context.Context, w ResponseWriter, r *Request) {
h := mux.Handler(r) h := mux.Handler(r)
h.ServeGemini(ctx, w, r) h.ServeGemini(ctx, w, r)
} }
// Handle registers the handler for the given pattern. // Handle registers the handler for the given pattern.
// If a handler already exists for pattern, Handle panics. // If a handler already exists for pattern, Handle panics.
func (mux *ServeMux) Handle(pattern string, handler Handler) { func (mux *Mux) Handle(pattern string, handler Handler) {
if pattern == "" { if pattern == "" {
panic("gemini: invalid pattern") panic("gemini: invalid pattern")
} }
@@ -294,9 +294,6 @@ func appendSorted(es []muxEntry, e muxEntry) []muxEntry {
} }
// HandleFunc registers the handler function for the given pattern. // HandleFunc registers the handler function for the given pattern.
func (mux *ServeMux) HandleFunc(pattern string, handler func(context.Context, ResponseWriter, *Request)) { func (mux *Mux) HandleFunc(pattern string, handler HandlerFunc) {
if handler == nil { mux.Handle(pattern, handler)
panic("gemini: nil handler")
}
mux.Handle(pattern, HandlerFunc(handler))
} }

View File

@@ -10,7 +10,7 @@ type nopHandler struct{}
func (*nopHandler) ServeGemini(context.Context, ResponseWriter, *Request) {} func (*nopHandler) ServeGemini(context.Context, ResponseWriter, *Request) {}
func TestServeMuxMatch(t *testing.T) { func TestMuxMatch(t *testing.T) {
type Match struct { type Match struct {
URL string URL string
Ok bool Ok bool
@@ -292,7 +292,7 @@ func TestServeMuxMatch(t *testing.T) {
for i, test := range tests { for i, test := range tests {
h := &nopHandler{} h := &nopHandler{}
var mux ServeMux var mux Mux
mux.Handle(test.Pattern, h) mux.Handle(test.Pattern, h)
for _, match := range tests[i].Matches { for _, match := range tests[i].Matches {

View File

@@ -1,28 +0,0 @@
package gemini
import (
"net"
"unicode/utf8"
"golang.org/x/net/idna"
)
func isASCII(s string) bool {
for i := 0; i < len(s); i++ {
if s[i] >= utf8.RuneSelf {
return false
}
}
return true
}
// punycodeHostname returns the punycoded version of hostname.
func punycodeHostname(hostname string) (string, error) {
if net.ParseIP(hostname) != nil {
return hostname, nil
}
if isASCII(hostname) {
return hostname, nil
}
return idna.Lookup.ToASCII(hostname)
}

View File

@@ -12,7 +12,8 @@ func QueryEscape(query string) string {
return strings.ReplaceAll(url.PathEscape(query), "+", "%2B") return strings.ReplaceAll(url.PathEscape(query), "+", "%2B")
} }
// QueryUnescape is identical to url.PathUnescape. // QueryUnescape unescapes a Gemini URL query.
// It is identical to url.PathUnescape.
func QueryUnescape(query string) (string, error) { func QueryUnescape(query string) (string, error) {
return url.PathUnescape(query) return url.PathUnescape(query)
} }

View File

@@ -10,11 +10,8 @@ import (
// A Request represents a Gemini request received by a server or to be sent // A Request represents a Gemini request received by a server or to be sent
// by a client. // by a client.
//
// The field semantics differ slightly between client and server usage.
type Request struct { type Request struct {
// URL specifies the URL being requested (for server // URL specifies the URL being requested.
// requests) or the URL to access (for client requests).
URL *url.URL URL *url.URL
// For client requests, Host optionally specifies the server to // For client requests, Host optionally specifies the server to
@@ -23,9 +20,7 @@ type Request struct {
// For international domain names, Host may be in Punycode or // For international domain names, Host may be in Punycode or
// Unicode form. Use golang.org/x/net/idna to convert it to // Unicode form. Use golang.org/x/net/idna to convert it to
// either format if needed. // either format if needed.
// // This field is ignored by the Gemini server.
// For server requests, Host specifies the host on which the URL
// is sought.
Host string Host string
// For client requests, Certificate optionally specifies the // For client requests, Certificate optionally specifies the
@@ -33,24 +28,11 @@ type Request struct {
// This field is ignored by the Gemini server. // This field is ignored by the Gemini server.
Certificate *tls.Certificate Certificate *tls.Certificate
// RemoteAddr allows Gemini servers and other software to record conn net.Conn
// the network address that sent the request, usually for tls *tls.ConnectionState
// logging. This field is not filled in by ReadRequest.
// This field is ignored by the Gemini client.
RemoteAddr net.Addr
// TLS allows Gemini servers and other software to record
// information about the TLS connection on which the request
// was received. This field is not filled in by ReadRequest.
// The Gemini server in this package sets the field for
// TLS-enabled connections before invoking a handler;
// otherwise it leaves the field nil.
// This field is ignored by the Gemini client.
TLS *tls.ConnectionState
} }
// NewRequest returns a new request. // NewRequest returns a new request.
//
// The returned Request is suitable for use with Client.Do. // The returned Request is suitable for use with Client.Do.
// //
// Callers should be careful that the URL query is properly escaped. // Callers should be careful that the URL query is properly escaped.
@@ -69,45 +51,78 @@ func NewRequest(rawurl string) (*Request, error) {
// for specialized applications; most code should use the Server // for specialized applications; most code should use the Server
// to read requests and handle them via the Handler interface. // to read requests and handle them via the Handler interface.
func ReadRequest(r io.Reader) (*Request, error) { func ReadRequest(r io.Reader) (*Request, error) {
// Read URL // Limit request size
r = io.LimitReader(r, 1026) r = io.LimitReader(r, 1026)
br := bufio.NewReaderSize(r, 1026) br := bufio.NewReaderSize(r, 1026)
rawurl, err := br.ReadString('\r') b, err := br.ReadBytes('\n')
if err != nil { if err != nil {
if err == io.EOF {
return nil, ErrInvalidRequest
}
return nil, err return nil, err
} }
// Read terminating line feed // Read URL
if b, err := br.ReadByte(); err != nil { rawurl, ok := trimCRLF(b)
return nil, err if !ok {
} else if b != '\n' {
return nil, ErrInvalidRequest return nil, ErrInvalidRequest
} }
// Trim carriage return if len(rawurl) == 0 {
rawurl = rawurl[:len(rawurl)-1]
// Validate URL
if len(rawurl) > 1024 {
return nil, ErrInvalidRequest return nil, ErrInvalidRequest
} }
u, err := url.Parse(rawurl) u, err := url.Parse(string(rawurl))
if err != nil { if err != nil {
return nil, err return nil, err
} }
return &Request{URL: u}, nil return &Request{URL: u}, nil
} }
// Write writes a Gemini request in wire format. // WriteTo writes r to w in the Gemini request format.
// This method consults the request URL only. // This method consults the request URL only.
func (r *Request) Write(w io.Writer) error { func (r *Request) WriteTo(w io.Writer) (int64, error) {
bw := bufio.NewWriterSize(w, 1026) bw := bufio.NewWriterSize(w, 1026)
url := r.URL.String() url := r.URL.String()
if len(url) > 1024 { if len(url) > 1024 {
return ErrInvalidRequest return 0, ErrInvalidRequest
} }
if _, err := bw.WriteString(url); err != nil { var wrote int64
return err n, err := bw.WriteString(url)
wrote += int64(n)
if err != nil {
return wrote, err
} }
if _, err := bw.Write(crlf); err != nil { n, err = bw.Write(crlf)
return err wrote += int64(n)
if err != nil {
return wrote, err
} }
return bw.Flush() return wrote, bw.Flush()
}
// Conn returns the network connection on which the request was received.
// Conn returns nil for client requests.
func (r *Request) Conn() net.Conn {
return r.conn
}
// TLS returns information about the TLS connection on which the
// request was received.
// TLS returns nil for client requests.
func (r *Request) TLS() *tls.ConnectionState {
if r.tls == nil {
if tlsConn, ok := r.conn.(*tls.Conn); ok {
state := tlsConn.ConnectionState()
r.tls = &state
}
}
return r.tls
}
// ServerName returns the value of the TLS Server Name Indication extension
// sent by the client.
// ServerName returns an empty string for client requests.
func (r *Request) ServerName() string {
if tls := r.TLS(); tls != nil {
return tls.ServerName
}
return ""
} }

View File

@@ -2,7 +2,6 @@ package gemini
import ( import (
"bufio" "bufio"
"io"
"net/url" "net/url"
"strings" "strings"
"testing" "testing"
@@ -36,25 +35,25 @@ func TestReadRequest(t *testing.T) {
}, },
{ {
Raw: "\r\n", Raw: "\r\n",
URL: &url.URL{}, Err: ErrInvalidRequest,
}, },
{ {
Raw: "gemini://example.com\n", Raw: "gemini://example.com\n",
Err: io.EOF, Err: ErrInvalidRequest,
}, },
{ {
Raw: "gemini://example.com", Raw: "gemini://example.com",
Err: io.EOF, Err: ErrInvalidRequest,
}, },
{ {
// 1030 bytes // 1030 bytes
Raw: maxURL + "xxxxxx", Raw: maxURL + "xxxxxx",
Err: io.EOF, Err: ErrInvalidRequest,
}, },
{ {
// 1027 bytes // 1027 bytes
Raw: maxURL + "x" + "\r\n", Raw: maxURL + "x" + "\r\n",
Err: io.EOF, Err: ErrInvalidRequest,
}, },
{ {
// 1024 bytes // 1024 bytes
@@ -119,7 +118,7 @@ func TestWriteRequest(t *testing.T) {
t.Logf("%s", test.Req.URL) t.Logf("%s", test.Req.URL)
var b strings.Builder var b strings.Builder
bw := bufio.NewWriter(&b) bw := bufio.NewWriter(&b)
err := test.Req.Write(bw) _, err := test.Req.WriteTo(bw)
if err != test.Err { if err != test.Err {
t.Errorf("expected err = %v, got %v", test.Err, err) t.Errorf("expected err = %v, got %v", test.Err, err)
} }

View File

@@ -5,11 +5,12 @@ import (
"crypto/tls" "crypto/tls"
"fmt" "fmt"
"io" "io"
"net"
"strconv" "strconv"
) )
// The default media type for responses. // The default media type for responses.
const defaultMediaType = "text/gemini; charset=utf-8" const defaultMediaType = "text/gemini"
// Response represents the response from a Gemini request. // Response represents the response from a Gemini request.
// //
@@ -17,13 +18,12 @@ const defaultMediaType = "text/gemini; charset=utf-8"
// header has been received. The response body is streamed on demand // header has been received. The response body is streamed on demand
// as the Body field is read. // as the Body field is read.
type Response struct { type Response struct {
// Status contains the response status code. // Status is the response status code.
Status Status Status Status
// Meta contains more information related to the response status. // Meta returns the response meta.
// For successful responses, Meta should contain the media type of the response. // For successful responses, the meta should contain the media type of the response.
// For failure responses, Meta should contain a short description of the failure. // For failure responses, the meta should contain a short description of the failure.
// Meta should not be longer than 1024 bytes.
Meta string Meta string
// Body represents the response body. // Body represents the response body.
@@ -38,120 +38,105 @@ type Response struct {
// close Body. // close Body.
Body io.ReadCloser Body io.ReadCloser
// TLS contains information about the TLS connection on which the conn net.Conn
// response was received. It is nil for unencrypted responses.
TLS *tls.ConnectionState
} }
// ReadResponse reads a Gemini response from the provided io.ReadCloser. // ReadResponse reads a Gemini response from the provided io.ReadCloser.
func ReadResponse(rc io.ReadCloser) (*Response, error) { func ReadResponse(r io.ReadCloser) (*Response, error) {
resp := &Response{} resp := &Response{}
br := bufio.NewReader(rc)
// Read the status // Limit response header size
statusB := make([]byte, 2) lr := io.LimitReader(r, 1029)
if _, err := br.Read(statusB); err != nil { // Wrap the reader to remove the limit later on
wr := &struct{ io.Reader }{lr}
br := bufio.NewReader(wr)
// Read response header
b, err := br.ReadBytes('\n')
if err != nil {
if err == io.EOF {
return nil, ErrInvalidResponse
}
return nil, err return nil, err
} }
status, err := strconv.Atoi(string(statusB)) if len(b) < 3 {
return nil, ErrInvalidResponse
}
// Read the status
status, err := strconv.Atoi(string(b[:2]))
if err != nil { if err != nil {
return nil, ErrInvalidResponse return nil, ErrInvalidResponse
} }
resp.Status = Status(status) resp.Status = Status(status)
// Read one space // Read one space
if b, err := br.ReadByte(); err != nil { if b[2] != ' ' {
return nil, err
} else if b != ' ' {
return nil, ErrInvalidResponse return nil, ErrInvalidResponse
} }
// Read the meta // Read the meta
meta, err := br.ReadString('\r') meta, ok := trimCRLF(b[3:])
if err != nil { if !ok {
return nil, err
}
// Trim carriage return
meta = meta[:len(meta)-1]
// Ensure meta is less than or equal to 1024 bytes
if len(meta) > 1024 {
return nil, ErrInvalidResponse return nil, ErrInvalidResponse
} }
if resp.Status.Class() == StatusSuccess && meta == "" { if len(meta) == 0 || len(meta) > 1024 {
// Use default media type
meta = defaultMediaType
}
resp.Meta = meta
// Read terminating newline
if b, err := br.ReadByte(); err != nil {
return nil, err
} else if b != '\n' {
return nil, ErrInvalidResponse return nil, ErrInvalidResponse
} }
resp.Meta = string(meta)
if resp.Status.Class() == StatusSuccess { if resp.Status.Class() == StatusSuccess {
resp.Body = newReadCloserBody(br, rc) // Use unlimited reader
wr.Reader = r
type readCloser struct {
io.Reader
io.Closer
}
resp.Body = readCloser{br, r}
} else { } else {
resp.Body = nopReadCloser{} resp.Body = nopReadCloser{}
rc.Close() r.Close()
} }
return resp, nil return resp, nil
} }
type nopReadCloser struct{} // Conn returns the network connection on which the response was received.
func (r *Response) Conn() net.Conn {
func (nopReadCloser) Read(p []byte) (int, error) { return r.conn
return 0, io.EOF
} }
func (nopReadCloser) Close() error { // TLS returns information about the TLS connection on which the
// response was received.
func (r *Response) TLS() *tls.ConnectionState {
if tlsConn, ok := r.conn.(*tls.Conn); ok {
state := tlsConn.ConnectionState()
return &state
}
return nil return nil
} }
type readCloserBody struct { // WriteTo writes r to w in the Gemini response format, including the
br *bufio.Reader // used until empty
io.ReadCloser
}
func newReadCloserBody(br *bufio.Reader, rc io.ReadCloser) io.ReadCloser {
body := &readCloserBody{ReadCloser: rc}
if br.Buffered() != 0 {
body.br = br
}
return body
}
func (b *readCloserBody) Read(p []byte) (n int, err error) {
if b.br != nil {
if n := b.br.Buffered(); len(p) > n {
p = p[:n]
}
n, err = b.br.Read(p)
if b.br.Buffered() == 0 {
b.br = nil
}
return n, err
}
return b.ReadCloser.Read(p)
}
// Write writes r to w in the Gemini response format, including the
// header and body. // header and body.
// //
// This method consults the Status, Meta, and Body fields of the response. // This method consults the Status, Meta, and Body fields of the response.
// The Response Body is closed after it is sent. // The Response Body is closed after it is sent.
func (r *Response) Write(w io.Writer) error { func (r *Response) WriteTo(w io.Writer) (int64, error) {
if _, err := fmt.Fprintf(w, "%02d %s\r\n", r.Status, r.Meta); err != nil { var wrote int64
return err n, err := fmt.Fprintf(w, "%02d %s\r\n", r.Status, r.Meta)
wrote += int64(n)
if err != nil {
return wrote, err
} }
if r.Body != nil { if r.Body != nil {
defer r.Body.Close() defer r.Body.Close()
if _, err := io.Copy(w, r.Body); err != nil { n, err := io.Copy(w, r.Body)
return err wrote += n
if err != nil {
return wrote, err
} }
} }
return nil return wrote, nil
} }
// A ResponseWriter interface is used by a Gemini handler to construct // A ResponseWriter interface is used by a Gemini handler to construct
@@ -160,20 +145,20 @@ func (r *Response) Write(w io.Writer) error {
// A ResponseWriter may not be used after the Handler.ServeGemini method // A ResponseWriter may not be used after the Handler.ServeGemini method
// has returned. // has returned.
type ResponseWriter interface { type ResponseWriter interface {
// MediaType sets the media type that will be sent by Write for a // SetMediaType sets the media type that will be sent by Write for a
// successful response. If no media type is set, a default of // successful response. If no media type is set, a default media type of
// "text/gemini; charset=utf-8" will be used. // "text/gemini" will be used.
// //
// Setting the media type after a call to Write or WriteHeader has // Setting the media type after a call to Write or WriteHeader has
// no effect. // no effect.
MediaType(string) SetMediaType(mediatype string)
// Write writes the data to the connection as part of a Gemini response. // Write writes the data to the connection as part of a Gemini response.
// //
// If WriteHeader has not yet been called, Write calls WriteHeader with // If WriteHeader has not yet been called, Write calls WriteHeader with
// StatusSuccess and the media type set in MediaType before writing the data. // StatusSuccess and the media type set in SetMediaType before writing the data.
// If no media type was set, Write uses a default media type of // If no media type was set, Write uses a default media type of
// "text/gemini; charset=utf-8". // "text/gemini".
Write([]byte) (int, error) Write([]byte) (int, error)
// WriteHeader sends a Gemini response header with the provided // WriteHeader sends a Gemini response header with the provided
@@ -181,44 +166,31 @@ type ResponseWriter interface {
// //
// If WriteHeader is not called explicitly, the first call to Write // If WriteHeader is not called explicitly, the first call to Write
// will trigger an implicit call to WriteHeader with a successful // will trigger an implicit call to WriteHeader with a successful
// status code and the media type set in MediaType. // status code and the media type set in SetMediaType.
// //
// The provided code must be a valid Gemini status code. // The provided code must be a valid Gemini status code.
// The provided meta must not be longer than 1024 bytes. // The provided meta must not be longer than 1024 bytes.
// Only one header may be written. // Only one header may be written.
WriteHeader(status Status, meta string) WriteHeader(status Status, meta string)
}
// The Flusher interface is implemented by ResponseWriters that allow a
// Gemini handler to flush buffered data to the client.
//
// The default Gemini ResponseWriter implementation supports Flusher,
// but ResponseWriter wrappers may not. Handlers should always test
// for this ability at runtime.
type Flusher interface {
// Flush sends any buffered data to the client. // Flush sends any buffered data to the client.
Flush() error Flush() error
} }
type responseWriter struct { type responseWriter struct {
b *bufio.Writer bw *bufio.Writer
mediatype string mediatype string
wroteHeader bool wroteHeader bool
bodyAllowed bool bodyAllowed bool
} }
// NewResponseWriter returns a ResponseWriter that uses the provided io.Writer.
func NewResponseWriter(w io.Writer) ResponseWriter {
return newResponseWriter(w)
}
func newResponseWriter(w io.Writer) *responseWriter { func newResponseWriter(w io.Writer) *responseWriter {
return &responseWriter{ return &responseWriter{
b: bufio.NewWriter(w), bw: bufio.NewWriter(w),
} }
} }
func (w *responseWriter) MediaType(mediatype string) { func (w *responseWriter) SetMediaType(mediatype string) {
w.mediatype = mediatype w.mediatype = mediatype
} }
@@ -234,7 +206,7 @@ func (w *responseWriter) Write(b []byte) (int, error) {
if !w.bodyAllowed { if !w.bodyAllowed {
return 0, ErrBodyNotAllowed return 0, ErrBodyNotAllowed
} }
return w.b.Write(b) return w.bw.Write(b)
} }
func (w *responseWriter) WriteHeader(status Status, meta string) { func (w *responseWriter) WriteHeader(status Status, meta string) {
@@ -246,10 +218,10 @@ func (w *responseWriter) WriteHeader(status Status, meta string) {
w.bodyAllowed = true w.bodyAllowed = true
} }
w.b.WriteString(strconv.Itoa(int(status))) w.bw.WriteString(strconv.Itoa(int(status)))
w.b.WriteByte(' ') w.bw.WriteByte(' ')
w.b.WriteString(meta) w.bw.WriteString(meta)
w.b.Write(crlf) w.bw.Write(crlf)
w.wroteHeader = true w.wroteHeader = true
} }
@@ -257,6 +229,6 @@ func (w *responseWriter) Flush() error {
if !w.wroteHeader { if !w.wroteHeader {
w.WriteHeader(StatusTemporaryFailure, "Temporary failure") w.WriteHeader(StatusTemporaryFailure, "Temporary failure")
} }
// Write errors from writeHeader will be returned here. // Write errors from WriteHeader will be returned here.
return w.b.Flush() return w.bw.Flush()
} }

View File

@@ -37,6 +37,15 @@ func TestReadWriteResponse(t *testing.T) {
Meta: "/redirect", Meta: "/redirect",
SkipWrite: true, // skip write test since result won't match Raw SkipWrite: true, // skip write test since result won't match Raw
}, },
{
Raw: "32 " + maxURL + "\r\n",
Status: 32,
Meta: maxURL,
},
{
Raw: "33 " + maxURL + "xxxx" + "\r\n",
Err: ErrInvalidResponse,
},
{ {
Raw: "99 Unknown status code\r\n", Raw: "99 Unknown status code\r\n",
Status: 99, Status: 99,
@@ -56,15 +65,15 @@ func TestReadWriteResponse(t *testing.T) {
}, },
{ {
Raw: "", Raw: "",
Err: io.EOF, Err: ErrInvalidResponse,
}, },
{ {
Raw: "10 Search query", Raw: "10 Search query",
Err: io.EOF, Err: ErrInvalidResponse,
}, },
{ {
Raw: "20 text/gemini\nHello, world!", Raw: "20 text/gemini\nHello, world!",
Err: io.EOF, Err: ErrInvalidResponse,
}, },
{ {
Raw: "20 text/gemini\rHello, world!", Raw: "20 text/gemini\rHello, world!",
@@ -72,7 +81,7 @@ func TestReadWriteResponse(t *testing.T) {
}, },
{ {
Raw: "20 text/gemini\r", Raw: "20 text/gemini\r",
Err: io.EOF, Err: ErrInvalidResponse,
}, },
{ {
Raw: "abcdefghijklmnopqrstuvwxyz", Raw: "abcdefghijklmnopqrstuvwxyz",
@@ -86,7 +95,7 @@ func TestReadWriteResponse(t *testing.T) {
if err != test.Err { if err != test.Err {
t.Errorf("expected err = %v, got %v", test.Err, err) t.Errorf("expected err = %v, got %v", test.Err, err)
} }
if test.Err != nil { if err != nil {
// No response // No response
continue continue
} }
@@ -107,14 +116,12 @@ func TestReadWriteResponse(t *testing.T) {
if test.Err != nil || test.SkipWrite { if test.Err != nil || test.SkipWrite {
continue continue
} }
resp := &Response{
Status: test.Status,
Meta: test.Meta,
Body: io.NopCloser(strings.NewReader(test.Body)),
}
var b strings.Builder var b strings.Builder
if err := resp.Write(&b); err != nil { w := newResponseWriter(nopCloser{&b})
w.WriteHeader(test.Status, test.Meta)
io.Copy(w, strings.NewReader(test.Body))
if err := w.Flush(); err != nil {
t.Error(err) t.Error(err)
continue continue
} }

240
server.go
View File

@@ -6,9 +6,7 @@ import (
"errors" "errors"
"log" "log"
"net" "net"
"runtime"
"sync" "sync"
"sync/atomic"
"time" "time"
) )
@@ -40,21 +38,34 @@ type Server struct {
// //
// If GetCertificate is nil or returns nil, then no certificate // If GetCertificate is nil or returns nil, then no certificate
// will be used and the connection will be aborted. // will be used and the connection will be aborted.
//
// See the certificate submodule for a certificate store that creates
// and rotates certificates as needed.
GetCertificate func(hostname string) (*tls.Certificate, error) GetCertificate func(hostname string) (*tls.Certificate, error)
// ErrorLog specifies an optional logger for errors accepting connections, // ErrorLog specifies an optional logger for errors accepting connections,
// unexpected behavior from handlers, and underlying file system errors. // unexpected behavior from handlers, and underlying file system errors.
// If nil, logging is done via the log package's standard logger. // If nil, logging is done via the log package's standard logger.
ErrorLog *log.Logger ErrorLog interface {
Printf(format string, v ...interface{})
}
listeners map[*net.Listener]context.CancelFunc listeners map[*net.Listener]context.CancelFunc
conns map[*net.Conn]context.CancelFunc conns map[*net.Conn]context.CancelFunc
closed bool // true if Close or Shutdown called
shutdown bool // true if Shutdown called
doneChan chan struct{} doneChan chan struct{}
closed int32
mu sync.Mutex mu sync.Mutex
} }
// done returns a channel that's closed when the server has finished closing. func (srv *Server) isClosed() bool {
srv.mu.Lock()
defer srv.mu.Unlock()
return srv.closed
}
// done returns a channel that's closed when the server is closed and
// all listeners and connections are closed.
func (srv *Server) done() chan struct{} { func (srv *Server) done() chan struct{} {
srv.mu.Lock() srv.mu.Lock()
defer srv.mu.Unlock() defer srv.mu.Unlock()
@@ -68,16 +79,24 @@ func (srv *Server) doneLocked() chan struct{} {
return srv.doneChan return srv.doneChan
} }
// tryFinishShutdown closes srv.done() if there are no active listeners or requests. // tryCloseDone closes srv.done() if the server is closed and
func (srv *Server) tryFinishShutdown() { // there are no active listeners or connections.
func (srv *Server) tryCloseDone() {
srv.mu.Lock() srv.mu.Lock()
defer srv.mu.Unlock() defer srv.mu.Unlock()
srv.tryCloseDoneLocked()
}
func (srv *Server) tryCloseDoneLocked() {
if !srv.closed {
return
}
if len(srv.listeners) == 0 && len(srv.conns) == 0 { if len(srv.listeners) == 0 && len(srv.conns) == 0 {
done := srv.doneLocked() ch := srv.doneLocked()
select { select {
case <-done: case <-ch:
default: default:
close(done) close(ch)
} }
} }
} }
@@ -85,17 +104,23 @@ func (srv *Server) tryFinishShutdown() {
// Close immediately closes all active net.Listeners and connections. // Close immediately closes all active net.Listeners and connections.
// For a graceful shutdown, use Shutdown. // For a graceful shutdown, use Shutdown.
func (srv *Server) Close() error { func (srv *Server) Close() error {
if !atomic.CompareAndSwapInt32(&srv.closed, 0, 1) {
return ErrServerClosed
}
// Close active listeners and connections.
srv.mu.Lock() srv.mu.Lock()
for _, cancel := range srv.listeners { {
cancel() if srv.closed {
} srv.mu.Unlock()
for _, cancel := range srv.conns { return nil
cancel() }
srv.closed = true
srv.tryCloseDoneLocked()
// Close all active connections and listeners.
for _, cancel := range srv.listeners {
cancel()
}
for _, cancel := range srv.conns {
cancel()
}
} }
srv.mu.Unlock() srv.mu.Unlock()
@@ -106,27 +131,33 @@ func (srv *Server) Close() error {
} }
// Shutdown gracefully shuts down the server without interrupting any // Shutdown gracefully shuts down the server without interrupting any
// active connections. Shutdown works by first closing all open // active connections. Shutdown works by first closing all open listeners
// listeners and then waiting indefinitely for connections // and then waiting indefinitely for connections to close.
// to close and then shut down.
// If the provided context expires before the shutdown is complete, // If the provided context expires before the shutdown is complete,
// Shutdown returns the context's error. // Shutdown returns the context's error.
// //
// When Shutdown is called, Serve and ListenAndServer immediately // When Shutdown is called, Serve and ListenAndServe immediately
// return ErrServerClosed. Make sure the program doesn't exit and // return an error. Make sure the program doesn't exit and waits instead for
// waits instead for Shutdown to return. // Shutdown to return.
// //
// Once Shutdown has been called on a server, it may not be reused; // Once Shutdown has been called on a server, it may not be reused;
// future calls to methods such as Serve will return ErrServerClosed. // future calls to methods such as Serve will return an error.
func (srv *Server) Shutdown(ctx context.Context) error { func (srv *Server) Shutdown(ctx context.Context) error {
if !atomic.CompareAndSwapInt32(&srv.closed, 0, 1) {
return ErrServerClosed
}
// Close active listeners.
srv.mu.Lock() srv.mu.Lock()
for _, cancel := range srv.listeners { {
cancel() if srv.closed {
srv.mu.Unlock()
return nil
}
srv.closed = true
srv.shutdown = true
srv.tryCloseDoneLocked()
// Close all active listeners.
for _, cancel := range srv.listeners {
cancel()
}
} }
srv.mu.Unlock() srv.mu.Unlock()
@@ -141,15 +172,16 @@ func (srv *Server) Shutdown(ctx context.Context) error {
// ListenAndServe listens for requests at the server's configured address. // ListenAndServe listens for requests at the server's configured address.
// ListenAndServe listens on the TCP network address srv.Addr and then calls // ListenAndServe listens on the TCP network address srv.Addr and then calls
// Serve to handle requests on incoming connections. // Serve to handle requests on incoming connections. If the provided
// context expires, ListenAndServe closes l and returns the context's error.
// //
// If srv.Addr is blank, ":1965" is used. // If srv.Addr is blank, ":1965" is used.
// //
// ListenAndServe always returns a non-nil error. After Shutdown or Close, the // ListenAndServe always returns a non-nil error.
// returned error is ErrServerClosed. // After Shutdown or Closed, the returned error is context.Canceled.
func (srv *Server) ListenAndServe(ctx context.Context) error { func (srv *Server) ListenAndServe(ctx context.Context) error {
if atomic.LoadInt32(&srv.closed) == 1 { if srv.isClosed() {
return ErrServerClosed return context.Canceled
} }
addr := srv.Addr addr := srv.Addr
@@ -177,13 +209,17 @@ func (srv *Server) getCertificate(h *tls.ClientHelloInfo) (*tls.Certificate, err
return srv.GetCertificate(h.ServerName) return srv.GetCertificate(h.ServerName)
} }
func (srv *Server) trackListener(l *net.Listener, cancel context.CancelFunc) { func (srv *Server) trackListener(l *net.Listener, cancel context.CancelFunc) bool {
srv.mu.Lock() srv.mu.Lock()
defer srv.mu.Unlock() defer srv.mu.Unlock()
if srv.closed {
return false
}
if srv.listeners == nil { if srv.listeners == nil {
srv.listeners = make(map[*net.Listener]context.CancelFunc) srv.listeners = make(map[*net.Listener]context.CancelFunc)
} }
srv.listeners[l] = cancel srv.listeners[l] = cancel
return true
} }
func (srv *Server) deleteListener(l *net.Listener) { func (srv *Server) deleteListener(l *net.Listener) {
@@ -193,23 +229,22 @@ func (srv *Server) deleteListener(l *net.Listener) {
} }
// Serve accepts incoming connections on the Listener l, creating a new // Serve accepts incoming connections on the Listener l, creating a new
// service goroutine for each. The service goroutines read requests and // service goroutine for each. The service goroutines read the requests and
// then calls the appropriate Handler to reply to them. // then call the appropriate Handler to reply to them. If the provided
// context expires, Serve closes l and returns the context's error.
// //
// Serve always returns a non-nil error and closes l. After Shutdown or Close, // Serve always closes l and returns a non-nil error.
// the returned error is ErrServerClosed. // After Shutdown or Close, the returned error is context.Canceled.
func (srv *Server) Serve(ctx context.Context, l net.Listener) error { func (srv *Server) Serve(ctx context.Context, l net.Listener) error {
defer l.Close() defer l.Close()
if atomic.LoadInt32(&srv.closed) == 1 {
return ErrServerClosed
}
lnctx, cancel := context.WithCancel(ctx) lnctx, cancel := context.WithCancel(ctx)
defer cancel() defer cancel()
srv.trackListener(&l, cancel) if !srv.trackListener(&l, cancel) {
defer srv.tryFinishShutdown() return context.Canceled
}
defer srv.tryCloseDone()
defer srv.deleteListener(&l) defer srv.deleteListener(&l)
errch := make(chan error, 1) errch := make(chan error, 1)
@@ -219,9 +254,6 @@ func (srv *Server) Serve(ctx context.Context, l net.Listener) error {
select { select {
case <-lnctx.Done(): case <-lnctx.Done():
if atomic.LoadInt32(&srv.closed) == 1 {
return ErrServerClosed
}
return lnctx.Err() return lnctx.Err()
case err := <-errch: case err := <-errch:
return err return err
@@ -229,21 +261,10 @@ func (srv *Server) Serve(ctx context.Context, l net.Listener) error {
} }
func (srv *Server) serve(ctx context.Context, l net.Listener) error { func (srv *Server) serve(ctx context.Context, l net.Listener) error {
// how long to sleep on accept failure var tempDelay time.Duration // how long to sleep on accept failure
var tempDelay time.Duration
for { for {
rw, err := l.Accept() rw, err := l.Accept()
if err != nil { if err != nil {
select {
case <-ctx.Done():
if atomic.LoadInt32(&srv.closed) == 1 {
return ErrServerClosed
}
return ctx.Err()
default:
}
// If this is a temporary error, sleep // If this is a temporary error, sleep
if ne, ok := err.(net.Error); ok && ne.Temporary() { if ne, ok := err.(net.Error); ok && ne.Temporary() {
if tempDelay == 0 { if tempDelay == 0 {
@@ -258,22 +279,27 @@ func (srv *Server) serve(ctx context.Context, l net.Listener) error {
time.Sleep(tempDelay) time.Sleep(tempDelay)
continue continue
} }
return err return err
} }
tempDelay = 0 tempDelay = 0
go srv.serveConn(ctx, rw) go srv.serveConn(ctx, rw, false)
} }
} }
func (srv *Server) trackConn(conn *net.Conn, cancel context.CancelFunc) { func (srv *Server) trackConn(conn *net.Conn, cancel context.CancelFunc, external bool) bool {
srv.mu.Lock() srv.mu.Lock()
defer srv.mu.Unlock() defer srv.mu.Unlock()
// Reject the connection under the following conditions:
// - Shutdown or Close has been called and conn is external (from ServeConn)
// - Close (not Shutdown) has been called and conn is internal (from Serve)
if srv.closed && (external || !srv.shutdown) {
return false
}
if srv.conns == nil { if srv.conns == nil {
srv.conns = make(map[*net.Conn]context.CancelFunc) srv.conns = make(map[*net.Conn]context.CancelFunc)
} }
srv.conns[conn] = cancel srv.conns[conn] = cancel
return true
} }
func (srv *Server) deleteConn(conn *net.Conn) { func (srv *Server) deleteConn(conn *net.Conn) {
@@ -282,31 +308,26 @@ func (srv *Server) deleteConn(conn *net.Conn) {
delete(srv.conns, conn) delete(srv.conns, conn)
} }
// serveConn serves a Gemini response over the provided connection. // ServeConn serves a Gemini response over the provided connection.
// It closes the connection when the response has been completed. // It closes the connection when the response has been completed.
func (srv *Server) serveConn(ctx context.Context, conn net.Conn) { // If the provided context expires before the response has completed,
defer conn.Close() // ServeConn closes the connection and returns the context's error.
func (srv *Server) ServeConn(ctx context.Context, conn net.Conn) error {
return srv.serveConn(ctx, conn, true)
}
if atomic.LoadInt32(&srv.closed) == 1 { func (srv *Server) serveConn(ctx context.Context, conn net.Conn, external bool) error {
return defer conn.Close()
}
ctx, cancel := context.WithCancel(ctx) ctx, cancel := context.WithCancel(ctx)
defer cancel() defer cancel()
srv.trackConn(&conn, cancel) if !srv.trackConn(&conn, cancel, external) {
defer srv.tryFinishShutdown() return context.Canceled
}
defer srv.tryCloseDone()
defer srv.deleteConn(&conn) defer srv.deleteConn(&conn)
defer func() {
if err := recover(); err != nil && err != ErrAbortHandler {
const size = 64 << 10
buf := make([]byte, size)
buf = buf[:runtime.Stack(buf, false)]
srv.logf("gemini: panic serving %v: %v\n%s", conn.RemoteAddr(), err, buf)
}
}()
if d := srv.ReadTimeout; d != 0 { if d := srv.ReadTimeout; d != 0 {
conn.SetReadDeadline(time.Now().Add(d)) conn.SetReadDeadline(time.Now().Add(d))
} }
@@ -314,45 +335,52 @@ func (srv *Server) serveConn(ctx context.Context, conn net.Conn) {
conn.SetWriteDeadline(time.Now().Add(d)) conn.SetWriteDeadline(time.Now().Add(d))
} }
done := make(chan struct{}) errch := make(chan error, 1)
go func() { go func() {
srv.respond(ctx, conn) errch <- srv.goServeConn(ctx, conn)
close(done)
}() }()
select { select {
case <-ctx.Done(): case <-ctx.Done():
case <-done: return ctx.Err()
case err := <-errch:
return err
} }
} }
func (srv *Server) respond(ctx context.Context, conn net.Conn) { func (srv *Server) goServeConn(ctx context.Context, conn net.Conn) error {
w := newResponseWriter(conn) ctx, cancel := context.WithCancel(ctx)
defer w.Flush() done := ctx.Done()
cw := &contextWriter{
ctx: ctx,
done: done,
cancel: cancel,
wc: conn,
}
r := &contextReader{
ctx: ctx,
done: done,
cancel: cancel,
rc: conn,
}
req, err := ReadRequest(conn) w := newResponseWriter(cw)
req, err := ReadRequest(r)
if err != nil { if err != nil {
w.WriteHeader(StatusBadRequest, "Bad request") w.WriteHeader(StatusBadRequest, "Bad request")
return return w.Flush()
} }
req.conn = conn
// Store the TLS connection state
if tlsConn, ok := conn.(*tls.Conn); ok {
state := tlsConn.ConnectionState()
req.TLS = &state
req.Host = state.ServerName
}
// Store remote address
req.RemoteAddr = conn.RemoteAddr()
h := srv.Handler h := srv.Handler
if h == nil { if h == nil {
w.WriteHeader(StatusNotFound, "Not found") w.WriteHeader(StatusNotFound, "Not found")
return return w.Flush()
} }
h.ServeGemini(ctx, w, req) h.ServeGemini(ctx, w, req)
return w.Flush()
} }
func (srv *Server) logf(format string, args ...interface{}) { func (srv *Server) logf(format string, args ...interface{}) {

19
text.go
View File

@@ -9,38 +9,39 @@ import (
// Line represents a line of a Gemini text response. // Line represents a line of a Gemini text response.
type Line interface { type Line interface {
// String formats the line for use in a Gemini text response.
String() string String() string
line() // private function to prevent other packages from implementing Line line() // private function to prevent other packages from implementing Line
} }
// A link line. // LineLink is a link line.
type LineLink struct { type LineLink struct {
URL string URL string
Name string Name string
} }
// A preformatting toggle line. // LinePreformattingToggle is a preformatting toggle line.
type LinePreformattingToggle string type LinePreformattingToggle string
// A preformatted text line. // LinePreformattedText is a preformatted text line.
type LinePreformattedText string type LinePreformattedText string
// A first-level heading line. // LineHeading1 is a first-level heading line.
type LineHeading1 string type LineHeading1 string
// A second-level heading line. // LineHeading2 is a second-level heading line.
type LineHeading2 string type LineHeading2 string
// A third-level heading line. // LineHeading3 is a third-level heading line.
type LineHeading3 string type LineHeading3 string
// An unordered list item line. // LineListItem is an unordered list item line.
type LineListItem string type LineListItem string
// A quote line. // LineQuote is a quote line.
type LineQuote string type LineQuote string
// A text line. // LineText is a text line.
type LineText string type LineText string
func (l LineLink) String() string { func (l LineLink) String() string {

View File

@@ -1,110 +0,0 @@
package gemini
import (
"bytes"
"context"
"sync"
"time"
)
// TimeoutHandler returns a Handler that runs h with the given time limit.
//
// The new Handler calls h.ServeGemini to handle each request, but
// if a call runs for longer than its time limit, the handler responds with a
// 40 Temporary Failure error. After such a timeout, writes by h to its
// ResponseWriter will return ErrHandlerTimeout.
//
// TimeoutHandler does not support the Hijacker or Flusher interfaces.
func TimeoutHandler(h Handler, dt time.Duration) Handler {
return &timeoutHandler{
h: h,
dt: dt,
}
}
type timeoutHandler struct {
h Handler
dt time.Duration
}
func (t *timeoutHandler) ServeGemini(ctx context.Context, w ResponseWriter, r *Request) {
ctx, cancel := context.WithTimeout(ctx, t.dt)
defer cancel()
done := make(chan struct{})
tw := &timeoutWriter{}
panicChan := make(chan interface{}, 1)
go func() {
defer func() {
if p := recover(); p != nil {
panicChan <- p
}
}()
t.h.ServeGemini(ctx, tw, r)
close(done)
}()
select {
case p := <-panicChan:
panic(p)
case <-done:
tw.mu.Lock()
defer tw.mu.Unlock()
if !tw.wroteHeader {
tw.status = StatusSuccess
}
w.WriteHeader(tw.status, tw.meta)
w.Write(tw.b.Bytes())
case <-ctx.Done():
tw.mu.Lock()
defer tw.mu.Unlock()
w.WriteHeader(StatusTemporaryFailure, "Timeout")
tw.timedOut = true
}
}
type timeoutWriter struct {
mu sync.Mutex
b bytes.Buffer
status Status
meta string
mediatype string
wroteHeader bool
timedOut bool
}
func (w *timeoutWriter) MediaType(mediatype string) {
w.mu.Lock()
defer w.mu.Unlock()
w.mediatype = mediatype
}
func (w *timeoutWriter) Write(b []byte) (int, error) {
w.mu.Lock()
defer w.mu.Unlock()
if w.timedOut {
return 0, ErrHandlerTimeout
}
if !w.wroteHeader {
w.writeHeaderLocked(StatusSuccess, w.mediatype)
}
return w.b.Write(b)
}
func (w *timeoutWriter) WriteHeader(status Status, meta string) {
w.mu.Lock()
defer w.mu.Unlock()
if w.timedOut {
return
}
w.writeHeaderLocked(status, meta)
}
func (w *timeoutWriter) writeHeaderLocked(status Status, meta string) {
if w.wroteHeader {
return
}
w.status = status
w.meta = meta
w.wroteHeader = true
}

View File

@@ -4,17 +4,16 @@ package tofu
import ( import (
"bufio" "bufio"
"bytes" "bytes"
"crypto/sha512" "crypto/sha256"
"crypto/x509" "crypto/x509"
"errors" "encoding/base64"
"fmt" "fmt"
"io" "io"
"os" "os"
"path/filepath"
"sort" "sort"
"strconv"
"strings" "strings"
"sync" "sync"
"time"
) )
// KnownHosts represents a list of known hosts. // KnownHosts represents a list of known hosts.
@@ -84,7 +83,11 @@ func (k *KnownHosts) WriteTo(w io.Writer) (int64, error) {
// Load loads the known hosts entries from the provided path. // Load loads the known hosts entries from the provided path.
func (k *KnownHosts) Load(path string) error { func (k *KnownHosts) Load(path string) error {
f, err := os.Open(path) if err := os.MkdirAll(filepath.Dir(path), 0700); err != nil {
return err
}
f, err := os.OpenFile(path, os.O_CREATE|os.O_RDONLY, 0644)
if err != nil { if err != nil {
return err return err
} }
@@ -133,6 +136,9 @@ func (k *KnownHosts) Parse(r io.Reader) error {
if err != nil { if err != nil {
continue continue
} }
if h.Algorithm != "sha256" {
continue
}
k.hosts[h.Hostname] = h k.hosts[h.Hostname] = h
} }
@@ -143,22 +149,17 @@ func (k *KnownHosts) Parse(r io.Reader) error {
// TOFU implements basic trust on first use. // TOFU implements basic trust on first use.
// //
// If the host is not on file, it is added to the list. // If the host is not on file, it is added to the list.
// If the host on file is expired, a new entry is added to the list.
// If the fingerprint does not match the one on file, an error is returned. // If the fingerprint does not match the one on file, an error is returned.
func (k *KnownHosts) TOFU(hostname string, cert *x509.Certificate) error { func (k *KnownHosts) TOFU(hostname string, cert *x509.Certificate) error {
host := NewHost(hostname, cert.Raw, cert.NotAfter) host := NewHost(hostname, cert.Raw)
knownHost, ok := k.Lookup(hostname) knownHost, ok := k.Lookup(hostname)
if !ok || time.Now().After(knownHost.Expires) { if !ok {
k.Add(host) k.Add(host)
return nil return nil
} }
if host.Fingerprint != knownHost.Fingerprint {
// Check fingerprint
if !bytes.Equal(knownHost.Fingerprint, host.Fingerprint) {
return fmt.Errorf("fingerprint for %q does not match", hostname) return fmt.Errorf("fingerprint for %q does not match", hostname)
} }
return nil return nil
} }
@@ -217,7 +218,8 @@ type PersistentHosts struct {
writer *HostWriter writer *HostWriter
} }
// NewPersistentHosts returns a new persistent set of known hosts. // NewPersistentHosts returns a new persistent set of known hosts that stores
// known hosts in hosts and writes new hosts to writer.
func NewPersistentHosts(hosts *KnownHosts, writer *HostWriter) *PersistentHosts { func NewPersistentHosts(hosts *KnownHosts, writer *HostWriter) *PersistentHosts {
return &PersistentHosts{ return &PersistentHosts{
hosts, hosts,
@@ -265,21 +267,16 @@ func (p *PersistentHosts) Entries() []Host {
// TOFU implements trust on first use with a persistent set of known hosts. // TOFU implements trust on first use with a persistent set of known hosts.
// //
// If the host is not on file, it is added to the list. // If the host is not on file, it is added to the list.
// If the host on file is expired, a new entry is added to the list.
// If the fingerprint does not match the one on file, an error is returned. // If the fingerprint does not match the one on file, an error is returned.
func (p *PersistentHosts) TOFU(hostname string, cert *x509.Certificate) error { func (p *PersistentHosts) TOFU(hostname string, cert *x509.Certificate) error {
host := NewHost(hostname, cert.Raw, cert.NotAfter) host := NewHost(hostname, cert.Raw)
knownHost, ok := p.Lookup(hostname) knownHost, ok := p.Lookup(hostname)
if !ok || time.Now().After(knownHost.Expires) { if !ok {
return p.Add(host) return p.Add(host)
} }
if host.Fingerprint != knownHost.Fingerprint {
// Check fingerprint
if !bytes.Equal(knownHost.Fingerprint, host.Fingerprint) {
return fmt.Errorf("fingerprint for %q does not match", hostname) return fmt.Errorf("fingerprint for %q does not match", hostname)
} }
return nil return nil
} }
@@ -290,22 +287,20 @@ func (p *PersistentHosts) Close() error {
// Host represents a host entry with a fingerprint using a certain algorithm. // Host represents a host entry with a fingerprint using a certain algorithm.
type Host struct { type Host struct {
Hostname string // hostname Hostname string // hostname
Algorithm string // fingerprint algorithm e.g. SHA-512 Algorithm string // fingerprint algorithm e.g. sha256
Fingerprint Fingerprint // fingerprint Fingerprint string // fingerprint
Expires time.Time // unix time of the fingerprint expiration date
} }
// NewHost returns a new host with a SHA-512 fingerprint of // NewHost returns a new host with a SHA256 fingerprint of
// the provided raw data. // the provided raw data.
func NewHost(hostname string, raw []byte, expires time.Time) Host { func NewHost(hostname string, raw []byte) Host {
sum := sha512.Sum512(raw) sum := sha256.Sum256(raw)
return Host{ return Host{
Hostname: hostname, Hostname: hostname,
Algorithm: "SHA-512", Algorithm: "sha256",
Fingerprint: sum[:], Fingerprint: base64.StdEncoding.EncodeToString(sum[:]),
Expires: expires,
} }
} }
@@ -323,95 +318,19 @@ func (h Host) String() string {
b.WriteByte(' ') b.WriteByte(' ')
b.WriteString(h.Algorithm) b.WriteString(h.Algorithm)
b.WriteByte(' ') b.WriteByte(' ')
b.WriteString(h.Fingerprint.String()) b.WriteString(h.Fingerprint)
b.WriteByte(' ')
b.WriteString(strconv.FormatInt(h.Expires.Unix(), 10))
return b.String() return b.String()
} }
// UnmarshalText unmarshals the host from the provided text. // UnmarshalText unmarshals the host from the provided text.
func (h *Host) UnmarshalText(text []byte) error { func (h *Host) UnmarshalText(text []byte) error {
const format = "hostname algorithm hex-fingerprint expiry-unix-ts"
parts := bytes.Split(text, []byte(" ")) parts := bytes.Split(text, []byte(" "))
if len(parts) != 4 { if len(parts) != 3 {
return fmt.Errorf("expected the format %q", format) return fmt.Errorf("expected the format 'hostname algorithm fingerprint'")
}
if len(parts[0]) == 0 {
return errors.New("empty hostname")
} }
h.Hostname = string(parts[0]) h.Hostname = string(parts[0])
h.Algorithm = string(parts[1])
algorithm := string(parts[1]) h.Fingerprint = string(parts[2])
if algorithm != "SHA-512" {
return fmt.Errorf("unsupported algorithm %q", algorithm)
}
h.Algorithm = algorithm
fingerprint := make([]byte, 0, sha512.Size)
scanner := bufio.NewScanner(bytes.NewReader(parts[2]))
scanner.Split(scanFingerprint)
for scanner.Scan() {
b, err := strconv.ParseUint(scanner.Text(), 16, 8)
if err != nil {
return fmt.Errorf("failed to parse fingerprint hash: %w", err)
}
fingerprint = append(fingerprint, byte(b))
}
if len(fingerprint) != sha512.Size {
return fmt.Errorf("invalid fingerprint size %d, expected %d",
len(fingerprint), sha512.Size)
}
h.Fingerprint = fingerprint
unix, err := strconv.ParseInt(string(parts[3]), 10, 0)
if err != nil {
return fmt.Errorf("invalid unix timestamp: %w", err)
}
h.Expires = time.Unix(unix, 0)
return nil return nil
} }
func scanFingerprint(data []byte, atEOF bool) (advance int, token []byte, err error) {
if atEOF && len(data) == 0 {
return 0, nil, nil
}
if i := bytes.IndexByte(data, ':'); i >= 0 {
// We have a full newline-terminated line.
return i + 1, data[0:i], nil
}
// If we're at EOF, we have a final, non-terminated hex byte
if atEOF {
return len(data), data, nil
}
// Request more data.
return 0, nil, nil
}
// Fingerprint represents a fingerprint.
type Fingerprint []byte
// String returns a string representation of the fingerprint.
func (f Fingerprint) String() string {
var sb strings.Builder
for i, b := range f {
if i > 0 {
sb.WriteByte(':')
}
fmt.Fprintf(&sb, "%02X", b)
}
return sb.String()
}

212
vendor.go
View File

@@ -1,212 +0,0 @@
// Hostname verification code from the crypto/x509 package.
// Modified to allow Common Names in the short term, until new certificates
// can be issued with SANs.
// Copyright 2011 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package gemini
import (
"crypto/x509"
"net"
"strings"
"unicode/utf8"
)
var oidExtensionSubjectAltName = []int{2, 5, 29, 17}
func hasSANExtension(c *x509.Certificate) bool {
for _, e := range c.Extensions {
if e.Id.Equal(oidExtensionSubjectAltName) {
return true
}
}
return false
}
func validHostnamePattern(host string) bool { return validHostname(host, true) }
func validHostnameInput(host string) bool { return validHostname(host, false) }
// validHostname reports whether host is a valid hostname that can be matched or
// matched against according to RFC 6125 2.2, with some leniency to accommodate
// legacy values.
func validHostname(host string, isPattern bool) bool {
if !isPattern {
host = strings.TrimSuffix(host, ".")
}
if len(host) == 0 {
return false
}
for i, part := range strings.Split(host, ".") {
if part == "" {
// Empty label.
return false
}
if isPattern && i == 0 && part == "*" {
// Only allow full left-most wildcards, as those are the only ones
// we match, and matching literal '*' characters is probably never
// the expected behavior.
continue
}
for j, c := range part {
if 'a' <= c && c <= 'z' {
continue
}
if '0' <= c && c <= '9' {
continue
}
if 'A' <= c && c <= 'Z' {
continue
}
if c == '-' && j != 0 {
continue
}
if c == '_' {
// Not a valid character in hostnames, but commonly
// found in deployments outside the WebPKI.
continue
}
return false
}
}
return true
}
// commonNameAsHostname reports whether the Common Name field should be
// considered the hostname that the certificate is valid for. This is a legacy
// behavior, disabled by default or if the Subject Alt Name extension is present.
//
// It applies the strict validHostname check to the Common Name field, so that
// certificates without SANs can still be validated against CAs with name
// constraints if there is no risk the CN would be matched as a hostname.
// See NameConstraintsWithoutSANs and issue 24151.
func commonNameAsHostname(c *x509.Certificate) bool {
return !hasSANExtension(c) && validHostnamePattern(c.Subject.CommonName)
}
func matchExactly(hostA, hostB string) bool {
if hostA == "" || hostA == "." || hostB == "" || hostB == "." {
return false
}
return toLowerCaseASCII(hostA) == toLowerCaseASCII(hostB)
}
func matchHostnames(pattern, host string) bool {
pattern = toLowerCaseASCII(pattern)
host = toLowerCaseASCII(strings.TrimSuffix(host, "."))
if len(pattern) == 0 || len(host) == 0 {
return false
}
patternParts := strings.Split(pattern, ".")
hostParts := strings.Split(host, ".")
if len(patternParts) != len(hostParts) {
return false
}
for i, patternPart := range patternParts {
if i == 0 && patternPart == "*" {
continue
}
if patternPart != hostParts[i] {
return false
}
}
return true
}
// toLowerCaseASCII returns a lower-case version of in. See RFC 6125 6.4.1. We use
// an explicitly ASCII function to avoid any sharp corners resulting from
// performing Unicode operations on DNS labels.
func toLowerCaseASCII(in string) string {
// If the string is already lower-case then there's nothing to do.
isAlreadyLowerCase := true
for _, c := range in {
if c == utf8.RuneError {
// If we get a UTF-8 error then there might be
// upper-case ASCII bytes in the invalid sequence.
isAlreadyLowerCase = false
break
}
if 'A' <= c && c <= 'Z' {
isAlreadyLowerCase = false
break
}
}
if isAlreadyLowerCase {
return in
}
out := []byte(in)
for i, c := range out {
if 'A' <= c && c <= 'Z' {
out[i] += 'a' - 'A'
}
}
return string(out)
}
// verifyHostname returns nil if c is a valid certificate for the named host.
// Otherwise it returns an error describing the mismatch.
//
// IP addresses can be optionally enclosed in square brackets and are checked
// against the IPAddresses field. Other names are checked case insensitively
// against the DNSNames field. If the names are valid hostnames, the certificate
// fields can have a wildcard as the left-most label.
//
// The legacy Common Name field is ignored unless it's a valid hostname, the
// certificate doesn't have any Subject Alternative Names, and the GODEBUG
// environment variable is set to "x509ignoreCN=0". Support for Common Name is
// deprecated will be entirely removed in the future.
func verifyHostname(c *x509.Certificate, h string) error {
// IP addresses may be written in [ ].
candidateIP := h
if len(h) >= 3 && h[0] == '[' && h[len(h)-1] == ']' {
candidateIP = h[1 : len(h)-1]
}
if ip := net.ParseIP(candidateIP); ip != nil {
// We only match IP addresses against IP SANs.
// See RFC 6125, Appendix B.2.
for _, candidate := range c.IPAddresses {
if ip.Equal(candidate) {
return nil
}
}
return x509.HostnameError{c, candidateIP}
}
names := c.DNSNames
if commonNameAsHostname(c) {
names = []string{c.Subject.CommonName}
}
candidateName := toLowerCaseASCII(h) // Save allocations inside the loop.
validCandidateName := validHostnameInput(candidateName)
for _, match := range names {
// Ideally, we'd only match valid hostnames according to RFC 6125 like
// browsers (more or less) do, but in practice Go is used in a wider
// array of contexts and can't even assume DNS resolution. Instead,
// always allow perfect matches, and only apply wildcard and trailing
// dot processing to valid hostnames.
if validCandidateName && validHostnamePattern(match) {
if matchHostnames(match, candidateName) {
return nil
}
} else {
if matchExactly(match, candidateName) {
return nil
}
}
}
return x509.HostnameError{c, h}
}