// Package fshttp contains the common http parts of the config, Transport and Client package fshttp import ( "bytes" "context" "crypto/tls" "crypto/x509" "encoding/pem" "errors" "fmt" "net" "net/http" "net/http/cookiejar" "net/http/httputil" "net/url" "os" "sync" "time" "github.com/rclone/rclone/fs" "github.com/rclone/rclone/fs/accounting" "github.com/rclone/rclone/fs/config/obscure" "github.com/rclone/rclone/lib/structs" "github.com/youmark/pkcs8" "golang.org/x/net/publicsuffix" ) const ( separatorReq = ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>" separatorResp = "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<" ) var ( transport *Transport noTransport = new(sync.Once) cookieJar, _ = cookiejar.New(&cookiejar.Options{PublicSuffixList: publicsuffix.List}) logMutex sync.Mutex // UnixSocketConfig describes the option to configure the path to a unix domain socket to connect to UnixSocketConfig = fs.Option{ Name: "unix_socket", Help: "Path to a unix domain socket to dial to, instead of opening a TCP connection directly", Advanced: true, Default: "", } ) // ResetTransport resets the existing transport, allowing it to take new settings. // Should only be used for testing. func ResetTransport() { noTransport = new(sync.Once) } // LoadKeyPair loads a TLS certificate and private key from PEM-encoded files, // with extended support for encrypted private keys. // // This function is designed as a robust replacement for tls.X509KeyPair, // providing the same core functionality but adding support for // password-protected private keys. // // The certificate file (certFile) must contain one or more PEM-encoded // certificates. The first certificate is treated as the leaf certificate, and // any subsequent certificates are treated as its chain. // // The key file (keyFile) must contain a PEM-encoded private key. Supported // formats are: // // - Unencrypted PKCS#1 ("BEGIN RSA PRIVATE KEY") // - Unencrypted PKCS#8 ("BEGIN PRIVATE KEY") // - Encrypted PKCS#8 ("BEGIN ENCRYPTED PRIVATE KEY") // - Legacy PEM encryption (e.g., DEK-Info headers), which are automatically detected. // // The password parameter is used to decrypt the private key. If the // key is not encrypted, this parameter is ignored and can be an empty // string. The password should be an obscured string. // // On success, it returns a fully populated tls.Certificate struct, including the // Leaf certificate field. func LoadKeyPair(certFile, keyFile, password string) (cert tls.Certificate, err error) { certPEM, err := os.ReadFile(certFile) if err != nil { return cert, fmt.Errorf("read cert: %w", err) } keyPEM, err := os.ReadFile(keyFile) if err != nil { return cert, fmt.Errorf("read key: %w", err) } if password != "" { password, err = obscure.Reveal(password) if err != nil { return cert, fmt.Errorf("reveal key password: %w", err) } } // Fast path: unencrypted PKCS#1/PKCS#8 cert, err = tls.X509KeyPair(certPEM, keyPEM) if err == nil { if len(cert.Certificate) == 0 { return cert, errors.New("no certificates parsed") } leaf, err := x509.ParseCertificate(cert.Certificate[0]) if err != nil { return cert, fmt.Errorf("parse leaf: %w", err) } cert.Leaf = leaf return cert, nil } // Decrypt / parse key manually block, rest := pem.Decode(keyPEM) if block == nil { return cert, errors.New("no PEM block in key") } if len(rest) != 0 { fs.Debugf(nil, "Trailing data (%d bytes) in key PEM loaded from %q", len(rest), keyFile) } var privKey any switch { case block.Type == "ENCRYPTED PRIVATE KEY": if password == "" { return cert, errors.New("key is encrypted but no --client-pass provided") } privKey, err = pkcs8.ParsePKCS8PrivateKey(block.Bytes, []byte(password)) if err != nil { return cert, fmt.Errorf("parse encrypted PKCS#8: %w", err) } case x509.IsEncryptedPEMBlock(block): //nolint:staticcheck // this is Legacy and insecure if password == "" { return cert, errors.New("key is encrypted but no --client-pass provided") } der, err := x509.DecryptPEMBlock(block, []byte(password)) //nolint:staticcheck // this is Legacy and insecure if err != nil { return cert, fmt.Errorf("decrypt PEM key: %w", err) } // Try PKCS#8, then RSA PKCS#1, then EC if k, kerr1 := x509.ParsePKCS8PrivateKey(der); kerr1 == nil { privKey = k } else if k, kerr2 := x509.ParsePKCS1PrivateKey(der); kerr2 == nil { privKey = k } else if k, kerr3 := x509.ParseECPrivateKey(der); kerr3 == nil { privKey = k } else { return cert, fmt.Errorf("parse decrypted key: pkcs8: %v, pkcs1: %v, ec: %v", kerr1, kerr2, kerr3) } default: // Unencrypted specific types switch block.Type { case "PRIVATE KEY": k, kerr := x509.ParsePKCS8PrivateKey(block.Bytes) if kerr != nil { return cert, fmt.Errorf("parse PKCS#8: %w", kerr) } privKey = k case "RSA PRIVATE KEY": k, kerr := x509.ParsePKCS1PrivateKey(block.Bytes) if kerr != nil { return cert, fmt.Errorf("parse PKCS#1 RSA: %w", kerr) } privKey = k case "EC PRIVATE KEY": k, kerr := x509.ParseECPrivateKey(block.Bytes) if kerr != nil { return cert, fmt.Errorf("parse EC: %w", kerr) } privKey = k default: return cert, fmt.Errorf("unsupported key type %q", block.Type) } } // Build cert chain from PEM var certDERs [][]byte for rest := certPEM; ; { var b *pem.Block b, rest = pem.Decode(rest) if b == nil { break } if b.Type == "CERTIFICATE" { certDERs = append(certDERs, b.Bytes) } } if len(certDERs) == 0 { return cert, fmt.Errorf("no CERTIFICATE blocks in %s", certFile) } cert = tls.Certificate{ Certificate: certDERs, PrivateKey: privKey, } // Leaf is always the first certificate cert.Leaf, err = x509.ParseCertificate(cert.Certificate[0]) if err != nil { return cert, fmt.Errorf("parse leaf: %w", err) } return cert, nil } // NewTransportCustom returns an http.RoundTripper with the correct timeouts. // The customize function is called if set to give the caller an opportunity to // customize any defaults in the Transport. func NewTransportCustom(ctx context.Context, customize func(*http.Transport)) *Transport { ci := fs.GetConfig(ctx) // Start with a sensible set of defaults then override. // This also means we get new stuff when it gets added to go t := new(http.Transport) structs.SetDefaults(t, http.DefaultTransport.(*http.Transport)) if ci.HTTPProxy != "" { proxyURL, err := url.Parse(ci.HTTPProxy) if err != nil { t.Proxy = func(*http.Request) (*url.URL, error) { return nil, fmt.Errorf("failed to set --http-proxy from %q: %w", ci.HTTPProxy, err) } } else { t.Proxy = http.ProxyURL(proxyURL) } } else { t.Proxy = http.ProxyFromEnvironment } t.MaxIdleConnsPerHost = 2 * (ci.Checkers + ci.Transfers + 1) t.MaxIdleConns = 2 * t.MaxIdleConnsPerHost t.TLSHandshakeTimeout = time.Duration(ci.ConnectTimeout) t.ResponseHeaderTimeout = time.Duration(ci.Timeout) t.DisableKeepAlives = ci.DisableHTTPKeepAlives // TLS Config t.TLSClientConfig = &tls.Config{ InsecureSkipVerify: ci.InsecureSkipVerify, } // Load client certs if ci.ClientCert != "" || ci.ClientKey != "" { if ci.ClientCert == "" || ci.ClientKey == "" { fs.Fatalf(nil, "Both --client-cert and --client-key must be set") } cert, err := LoadKeyPair(ci.ClientCert, ci.ClientKey, ci.ClientPass) if err != nil { fs.Fatalf(nil, "Failed to load --client-cert/--client-key pair: %v", err) } t.TLSClientConfig.Certificates = []tls.Certificate{cert} } // Load CA certs if len(ci.CaCert) != 0 { caCertPool := x509.NewCertPool() for _, cert := range ci.CaCert { caCert, err := os.ReadFile(cert) if err != nil { fs.Fatalf(nil, "Failed to read --ca-cert file %q : %v", cert, err) } ok := caCertPool.AppendCertsFromPEM(caCert) if !ok { fs.Fatalf(nil, "Failed to add certificates from --ca-cert file %q", cert) } } t.TLSClientConfig.RootCAs = caCertPool } t.DisableCompression = ci.NoGzip t.DialContext = func(reqCtx context.Context, network, addr string) (net.Conn, error) { return NewDialer(ctx).DialContext(reqCtx, network, addr) } t.IdleConnTimeout = 60 * time.Second t.ExpectContinueTimeout = time.Duration(ci.ExpectContinueTimeout) if ci.Dump&(fs.DumpHeaders|fs.DumpBodies|fs.DumpAuth|fs.DumpRequests|fs.DumpResponses) != 0 { fs.Debugf(nil, "You have specified to dump information. Please be noted that the "+ "Accept-Encoding as shown may not be correct in the request and the response may not show "+ "Content-Encoding if the go standard libraries auto gzip encoding was in effect. In this case"+ " the body of the request will be gunzipped before showing it.") } if ci.DisableHTTP2 { t.TLSNextProto = map[string]func(string, *tls.Conn) http.RoundTripper{} } // customize the transport if required if customize != nil { customize(t) } // Wrap that http.Transport in our own transport return newTransport(ci, t) } // NewTransport returns an http.RoundTripper with the correct timeouts func NewTransport(ctx context.Context) *Transport { (*noTransport).Do(func() { transport = NewTransportCustom(ctx, nil) }) return transport } // NewClient returns an http.Client with the correct timeouts func NewClient(ctx context.Context) *http.Client { return NewClientCustom(ctx, nil) } // NewClientCustom returns an http.Client with the correct timeouts. // It allows customizing the transport, using NewTransportCustom. func NewClientCustom(ctx context.Context, customize func(*http.Transport)) *http.Client { ci := fs.GetConfig(ctx) client := &http.Client{ Transport: NewTransportCustom(ctx, customize), } if ci.Cookie { client.Jar = cookieJar } return client } // NewClientWithUnixSocket returns an http.Client with the correct timeout. // It internally uses NewClientCustom with a custom dialer connecting to // the specified unix domain socket. func NewClientWithUnixSocket(ctx context.Context, path string) *http.Client { return NewClientCustom(ctx, func(t *http.Transport) { t.DialContext = func(reqCtx context.Context, network, addr string) (net.Conn, error) { return NewDialer(ctx).DialContext(reqCtx, "unix", path) } }) } // Transport is our http Transport which wraps an http.Transport // * Sets the User Agent // * Does logging // * Updates metrics type Transport struct { *http.Transport ci *fs.ConfigInfo dump fs.DumpFlags filterRequest func(req *http.Request) userAgent string headers []*fs.HTTPOption metrics *Metrics // Mutex for serializing attempts at reloading the certificates reloadMutex sync.Mutex } // newTransport wraps the http.Transport passed in and logs all // roundtrips including the body if logBody is set. func newTransport(ci *fs.ConfigInfo, transport *http.Transport) *Transport { return &Transport{ Transport: transport, ci: ci, dump: ci.Dump, userAgent: ci.UserAgent, headers: ci.Headers, metrics: DefaultMetrics, } } // SetRequestFilter sets a filter to be used on each request func (t *Transport) SetRequestFilter(f func(req *http.Request)) { t.filterRequest = f } // A mutex to protect this map var checkedHostMu sync.RWMutex // A map of servers we have checked for time var checkedHost = make(map[string]struct{}, 1) // Check the server time is the same as ours, once for each server func checkServerTime(req *http.Request, resp *http.Response) { host := req.URL.Host if req.Host != "" { host = req.Host } checkedHostMu.RLock() _, ok := checkedHost[host] checkedHostMu.RUnlock() if ok { return } dateString := resp.Header.Get("Date") if dateString == "" { return } date, err := http.ParseTime(dateString) if err != nil { fs.Debugf(nil, "Couldn't parse Date: from server %s: %q: %v", host, dateString, err) return } dt := time.Since(date) const window = 5 * 60 * time.Second if dt > window || dt < -window { fs.Logf(nil, "Time may be set wrong - time from %q is %v different from this computer", host, dt) } checkedHostMu.Lock() checkedHost[host] = struct{}{} checkedHostMu.Unlock() } // cleanAuth gets rid of one authBuf header within the first 4k func cleanAuth(buf, authBuf []byte) []byte { // Find how much buffer to check n := min(len(buf), 4096) // See if there is an Authorization: header i := bytes.Index(buf[:n], authBuf) if i < 0 { return buf } i += len(authBuf) // Overwrite the next 4 chars with 'X' for j := 0; i < len(buf) && j < 4; j++ { if buf[i] == '\n' { break } buf[i] = 'X' i++ } // Snip out to the next '\n' j := bytes.IndexByte(buf[i:], '\n') if j < 0 { return buf[:i] } n = copy(buf[i:], buf[i+j:]) return buf[:i+n] } var authBufs = [][]byte{ []byte("Authorization: "), []byte("X-Auth-Token: "), } // cleanAuths gets rid of all the possible Auth headers func cleanAuths(buf []byte) []byte { for _, authBuf := range authBufs { buf = cleanAuth(buf, authBuf) } return buf } var expireWindow = 30 * time.Second func isCertificateExpired(cc *tls.Config) bool { return len(cc.Certificates) > 0 && cc.Certificates[0].Leaf != nil && time.Until(cc.Certificates[0].Leaf.NotAfter) < expireWindow } func (t *Transport) reloadCertificates() { t.reloadMutex.Lock() defer t.reloadMutex.Unlock() // Check that the certificate is expired before trying to reload it // it might have been reloaded while we were waiting to lock the mutex if !isCertificateExpired(t.TLSClientConfig) { return } cert, err := LoadKeyPair(t.ci.ClientCert, t.ci.ClientKey, t.ci.ClientPass) if err != nil { fs.Fatalf(nil, "Failed to load --client-cert/--client-key pair: %v", err) } t.TLSClientConfig.Certificates = []tls.Certificate{cert} } // RoundTrip implements the RoundTripper interface. func (t *Transport) RoundTrip(req *http.Request) (resp *http.Response, err error) { // Check if certificates are being used and the certificates are expired if isCertificateExpired(t.TLSClientConfig) { t.reloadCertificates() } // Limit transactions per second if required accounting.LimitTPS(req.Context()) // Force user agent req.Header.Set("User-Agent", t.userAgent) // Set user defined headers for _, option := range t.headers { req.Header.Set(option.Key, option.Value) } // Filter the request if required if t.filterRequest != nil { t.filterRequest(req) } // Logf request if t.dump&(fs.DumpHeaders|fs.DumpBodies|fs.DumpAuth|fs.DumpRequests|fs.DumpResponses) != 0 { buf, _ := httputil.DumpRequestOut(req, t.dump&(fs.DumpBodies|fs.DumpRequests) != 0) if t.dump&fs.DumpAuth == 0 { buf = cleanAuths(buf) } logMutex.Lock() fs.Debugf(nil, "%s", separatorReq) fs.Debugf(nil, "%s (req %p)", "HTTP REQUEST", req) fs.Debugf(nil, "%s", string(buf)) fs.Debugf(nil, "%s", separatorReq) logMutex.Unlock() } // Do round trip resp, err = t.Transport.RoundTrip(req) // Logf response if t.dump&(fs.DumpHeaders|fs.DumpBodies|fs.DumpAuth|fs.DumpRequests|fs.DumpResponses) != 0 { logMutex.Lock() fs.Debugf(nil, "%s", separatorResp) fs.Debugf(nil, "%s (req %p)", "HTTP RESPONSE", req) if err != nil { fs.Debugf(nil, "Error: %v", err) } else { buf, _ := httputil.DumpResponse(resp, t.dump&(fs.DumpBodies|fs.DumpResponses) != 0) fs.Debugf(nil, "%s", string(buf)) } fs.Debugf(nil, "%s", separatorResp) logMutex.Unlock() } // Update metrics t.metrics.onResponse(req, resp) if err == nil { checkServerTime(req, resp) } return resp, err }