Improve error checking #24
Merged
Conversation
This file contains 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
added 3 commits
January 21, 2019 13:13
The PKCS11Session.Close() method was ignoring the error return from the PKCS#11 library. Impossible to fix this without breaking existing code, so this function is deprecated and the awkwardly named CloseSession() succeeds it.
nickrmc83
approved these changes
Jan 22, 2019
dmjones
force-pushed
the
improve-error-checking
branch
from
00f97c3 to
448ffac
Compare
optnfast
reviewed
Jan 25, 2019
| file, err := os.Open(configLocation) | ||
| if err != nil { | ||
| log.Printf("Could not open config file: %s", configLocation) | ||
| return nil, err | ||
| } | ||
| defer file.Close() | ||
| defer func() { | ||
| err = file.Close() |
There was a problem hiding this comment.
That doesn't look right. Suppose the file contents are malformed. Decode below will return a non-nil error and try to return it, but file.Close() will return nil. The result will be that ConfigureFromFile returns nil despite an error having occurred.
See https://play.golang.org/p/rzTxJM85e0c for a reduced example.
There was a problem hiding this comment.
Yikes, good spot. I'll take a look for other places I may have introduced the same bug with this pattern. Thanks :-)
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
The test code had very little error checking, which would make integration experiments difficult to grok. There were also places in the main code that ignored errors. This has also been addressed in this change.
The most interesting part of this is the deprecation of
PKCS11Session.Close(). This function ignores the errors from the underlying library, which is unfortunate. There's no way to change this in a backwards-compatible fashion, so I've deprecated it and create an alternative function.