🌱 Add logging to certpoolwatcher and client #1684
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| package httputil | ||
|
There was a problem hiding this comment. it kind if weird that the certlog is in httputil pkg. Should we keep outside of httputil? Same comment for internal/httputil/certutil.go. It is nit pick and not blocker for this PR. There was a problem hiding this comment. I was thinking of moving the cert utility stuff into it's own package, but that can be done later. |
||
|
|
||
| import ( | ||
| "crypto/tls" | ||
| "crypto/x509" | ||
| "encoding/pem" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultLogLevel = 4 | ||
| ) | ||
|
|
||
| // Log the certificates that would be used for docker pull operations | ||
| // Assumes a /etc/docker/certs.d like path, where the directory contains | ||
| // <hostname>:<port> directories in which a CA certificate (generally | ||
| // named "ca.crt") is located. | ||
| func LogDockerCertificates(path string, log logr.Logger) { | ||
| // These are the default paths that containers/images looks at for host:port certs | ||
| // See containers/images: docker/docker_client.go | ||
| paths := []string{"/etc/docker/certs.d", "/etc/containers/certs.d"} | ||
| if path != "" { | ||
| paths = []string{path} | ||
| } | ||
| for _, path := range paths { | ||
| fi, err := os.Stat(path) | ||
| if err != nil { | ||
| log.Error(err, "statting directory", "directory", path) | ||
| continue | ||
| } | ||
| if !fi.IsDir() { | ||
| log.V(defaultLogLevel+1).Info("not a directory", "directory", path) | ||
| continue | ||
| } | ||
| dirEntries, err := os.ReadDir(path) | ||
| if err != nil { | ||
| log.Error(err, "reading directory", "directory", path) | ||
| continue | ||
| } | ||
| for _, e := range dirEntries { | ||
| hostPath := filepath.Join(path, e.Name()) | ||
| fi, err := os.Stat(hostPath) | ||
| if err != nil { | ||
| log.Error(err, "dumping certs", "path", hostPath) | ||
| continue | ||
| } | ||
| if !fi.IsDir() { | ||
| log.V(defaultLogLevel+1).Info("ignoring non-directory", "path", hostPath) | ||
| continue | ||
| } | ||
| logPath(hostPath, "dump docker certs", log) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // This function unwraps the given error to find an CertificateVerificationError. | ||
| // It then logs the list of certificates found in the unwrapped error | ||
| // Returns: | ||
| // * true if a CertificateVerificationError is found | ||
| // * false if no CertificateVerificationError is found | ||
| func LogCertificateVerificationError(err error, log logr.Logger) bool { | ||
| for err != nil { | ||
| var cvErr *tls.CertificateVerificationError | ||
| if errors.As(err, &cvErr) { | ||
| n := 1 | ||
| for _, cert := range cvErr.UnverifiedCertificates { | ||
| log.Error(err, "unverified cert", "n", n, "subject", cert.Subject, "issuer", cert.Issuer, "DNSNames", cert.DNSNames, "serial", cert.SerialNumber) | ||
| n = n + 1 | ||
| } | ||
| return true | ||
| } | ||
| err = errors.Unwrap(err) | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func logPath(path, action string, log logr.Logger) { | ||
| fi, err := os.Stat(path) | ||
| if err != nil { | ||
| log.Error(err, "error in os.Stat()", "path", path) | ||
| return | ||
| } | ||
| if !fi.IsDir() { | ||
| logFile(path, "", fmt.Sprintf("%s file", action), log) | ||
| return | ||
| } | ||
| action = fmt.Sprintf("%s directory", action) | ||
| dirEntries, err := os.ReadDir(path) | ||
| if err != nil { | ||
| log.Error(err, "error in os.ReadDir()", "path", path) | ||
| return | ||
| } | ||
| for _, e := range dirEntries { | ||
| file := filepath.Join(path, e.Name()) | ||
| fi, err := os.Stat(file) | ||
| if err != nil { | ||
| log.Error(err, "error in os.Stat()", "file", file) | ||
| continue | ||
| } | ||
| if fi.IsDir() { | ||
| log.V(defaultLogLevel+1).Info("ignoring subdirectory", "directory", file) | ||
| continue | ||
| } | ||
| logFile(e.Name(), path, action, log) | ||
| } | ||
| } | ||
|
|
||
| func logFile(filename, path, action string, log logr.Logger) { | ||
| filepath := filepath.Join(path, filename) | ||
| _, err := os.Stat(filepath) | ||
| if err != nil { | ||
| log.Error(err, "statting file", "file", filepath) | ||
| return | ||
| } | ||
| data, err := os.ReadFile(filepath) | ||
| if err != nil { | ||
| log.Error(err, "error in os.ReadFile()", "file", filepath) | ||
| return | ||
| } | ||
| logPem(data, filename, path, action, log) | ||
| } | ||
|
|
||
| func logPem(data []byte, filename, path, action string, log logr.Logger) { | ||
| for len(data) > 0 { | ||
| var block *pem.Block | ||
| block, data = pem.Decode(data) | ||
| if block == nil { | ||
| log.Info("error: no block returned from pem.Decode()", "file", filename) | ||
| return | ||
| } | ||
| crt, err := x509.ParseCertificate(block.Bytes) | ||
| if err != nil { | ||
| log.Error(err, "error in x509.ParseCertificate()", "file", filename) | ||
| return | ||
| } | ||
|
|
||
| args := []any{} | ||
| if path != "" { | ||
| args = append(args, "directory", path) | ||
| } | ||
| // Find an appopriate certificate identifier | ||
| args = append(args, "file", filename) | ||
| if s := crt.Subject.String(); s != "" { | ||
| args = append(args, "subject", s) | ||
| } else if crt.DNSNames != nil { | ||
| args = append(args, "DNSNames", crt.DNSNames) | ||
| } else if s := crt.SerialNumber.String(); s != "" { | ||
| args = append(args, "serial", s) | ||
| } | ||
| log.V(defaultLogLevel).Info(action, args...) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we ignoring the return here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because we don't need to log certs in
/etc/dockerhere, because this is used for catalogd connections, not pulling images, The other places this is called, the return is used to determine if we want to look at/etc/dockerUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, so we just called the function to log error in to the logfile.