|
| 1 | +package httputil |
| 2 | + |
| 3 | +import ( |
| 4 | + "crypto/tls" |
| 5 | + "crypto/x509" |
| 6 | + "encoding/pem" |
| 7 | + "errors" |
| 8 | + "fmt" |
| 9 | + "os" |
| 10 | + "path/filepath" |
| 11 | + |
| 12 | + "github.com/go-logr/logr" |
| 13 | +) |
| 14 | + |
| 15 | +const ( |
| 16 | + defaultLogLevel = 0 // 4 |
| 17 | +) |
| 18 | + |
| 19 | +// Log the certificates that would be used for docker pull operations |
| 20 | +// Assumes a /etc/docker/certs.d like path, where the directory contains |
| 21 | +// <hostname>:<port> directories in which a CA certificate (generally |
| 22 | +// named "ca.crt") is located. |
| 23 | +func LogDockerCertificates(path string, log logr.Logger) { |
| 24 | + var paths []string |
| 25 | + if path == "" { |
| 26 | + paths = []string{"/etc/docker/certs.d", "/etc/containers/certs.d"} |
| 27 | + } else { |
| 28 | + paths = []string{path} |
| 29 | + } |
| 30 | + for _, path := range paths { |
| 31 | + fi, err := os.Stat(path) |
| 32 | + if err != nil { |
| 33 | + log.Error(err, "statting directory", "directory", path) |
| 34 | + continue |
| 35 | + } |
| 36 | + if !fi.IsDir() { |
| 37 | + log.V(defaultLogLevel).V(1).Info("not a directory", "directory", path) |
| 38 | + continue |
| 39 | + } |
| 40 | + dirEntries, err := os.ReadDir(path) |
| 41 | + if err != nil { |
| 42 | + log.Error(err, "reading directory", "directory", path) |
| 43 | + continue |
| 44 | + } |
| 45 | + count := 0 |
| 46 | + for _, e := range dirEntries { |
| 47 | + hostPath := filepath.Join(path, e.Name()) |
| 48 | + fi, err := os.Stat(hostPath) |
| 49 | + count++ |
| 50 | + if err != nil { |
| 51 | + log.Error(err, "dumping certs", "path", hostPath) |
| 52 | + continue |
| 53 | + } |
| 54 | + if !fi.IsDir() { |
| 55 | + log.V(defaultLogLevel).V(1).Info("ignoring non-directory", "path", hostPath) |
| 56 | + continue |
| 57 | + } |
| 58 | + logPath(hostPath, "dump docker certs", log) |
| 59 | + } |
| 60 | + } |
| 61 | +} |
| 62 | + |
| 63 | +// This function unwraps the given error to find an CertificateVerificationError. |
| 64 | +// It then logs the list of certificates found in the unwrapped error |
| 65 | +// Returns: |
| 66 | +// * true if a CertificateVerificationError is found |
| 67 | +// * false if no CertificateVerificationError is found |
| 68 | +func LogCertificateVerificationError(err error, log logr.Logger) bool { |
| 69 | + for err != nil { |
| 70 | + var cvErr *tls.CertificateVerificationError |
| 71 | + if errors.As(err, &cvErr) { |
| 72 | + n := 1 |
| 73 | + for _, cert := range cvErr.UnverifiedCertificates { |
| 74 | + log.Error(err, "unverified cert", "n", n, "subject", cert.Subject, "issuer", cert.Issuer, "DNSNames", cert.DNSNames, "serial", cert.SerialNumber) |
| 75 | + n = n + 1 |
| 76 | + } |
| 77 | + return true |
| 78 | + } |
| 79 | + err = errors.Unwrap(err) |
| 80 | + } |
| 81 | + return false |
| 82 | +} |
| 83 | + |
| 84 | +func logPath(path, action string, log logr.Logger) { |
| 85 | + fi, err := os.Stat(path) |
| 86 | + if err != nil { |
| 87 | + log.Error(err, "error in os.Stat()", "path", path) |
| 88 | + return |
| 89 | + } |
| 90 | + if !fi.IsDir() { |
| 91 | + logFile(path, "", fmt.Sprintf("%s file", action), log) |
| 92 | + return |
| 93 | + } |
| 94 | + action = fmt.Sprintf("%s directory", action) |
| 95 | + dirEntries, err := os.ReadDir(path) |
| 96 | + if err != nil { |
| 97 | + log.Error(err, "error in os.ReadDir()", "path", path) |
| 98 | + return |
| 99 | + } |
| 100 | + for _, e := range dirEntries { |
| 101 | + file := filepath.Join(path, e.Name()) |
| 102 | + fi, err := os.Stat(file) |
| 103 | + if err != nil { |
| 104 | + log.Error(err, "error in os.Stat()", "file", file) |
| 105 | + continue |
| 106 | + } |
| 107 | + if fi.IsDir() { |
| 108 | + log.V(defaultLogLevel).V(1).Info("ignoring subdirectory", "directory", file) |
| 109 | + continue |
| 110 | + } |
| 111 | + logFile(e.Name(), path, action, log) |
| 112 | + } |
| 113 | +} |
| 114 | + |
| 115 | +func logFile(filename, path, action string, log logr.Logger) { |
| 116 | + filepath := filepath.Join(path, filename) |
| 117 | + _, err := os.Stat(filepath) |
| 118 | + if err != nil { |
| 119 | + log.Error(err, "statting file", "file", filepath) |
| 120 | + return |
| 121 | + } |
| 122 | + data, err := os.ReadFile(filepath) |
| 123 | + if err != nil { |
| 124 | + log.Error(err, "error in os.ReadFile()", "file", filepath) |
| 125 | + return |
| 126 | + } |
| 127 | + logPem(data, filename, path, action, log) |
| 128 | +} |
| 129 | + |
| 130 | +func logPem(data []byte, filename, path, action string, log logr.Logger) { |
| 131 | + for len(data) > 0 { |
| 132 | + var block *pem.Block |
| 133 | + block, data = pem.Decode(data) |
| 134 | + if block == nil { |
| 135 | + log.Info("error: no block returned from pem.Decode()", "file", filename) |
| 136 | + return |
| 137 | + } |
| 138 | + crt, err := x509.ParseCertificate(block.Bytes) |
| 139 | + if err != nil { |
| 140 | + log.Error(err, "error in x509.ParseCertificate()", "file", filename) |
| 141 | + return |
| 142 | + } |
| 143 | + |
| 144 | + args := []any{} |
| 145 | + if path != "" { |
| 146 | + args = append(args, "directory", path) |
| 147 | + } |
| 148 | + // Find an appopriate certificate identifier |
| 149 | + args = append(args, "file", filename) |
| 150 | + if s := crt.Subject.String(); s != "" { |
| 151 | + args = append(args, "subject", s) |
| 152 | + } else if crt.DNSNames != nil { |
| 153 | + args = append(args, "DNSNames", crt.DNSNames) |
| 154 | + } else if s := crt.SerialNumber.String(); s != "" { |
| 155 | + args = append(args, "serial", s) |
| 156 | + } |
| 157 | + log.V(defaultLogLevel).Info(action, args...) |
| 158 | + } |
| 159 | +} |
0 commit comments