extras: Add meaningful description to BoringSSL errors #237
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.
Motivation
When an error occurs in a BoringSSL call, we typically embed the packed error code in a
CryptoKitError.underlyingCoreCryptoError(error: Int32)
. This packed error code consists of the library and the reason and BoringSSL has functions for unpacking these and getting descriptive messages for them. I often spend my time in a debugger, manually calling these C functions and then looking things up in header files.Modifications
In
_CryptoExtras
(not inCrypto
) add a (possibly retroactive) conformance toCustomStringConvertible
.Result
If
_CryptoExtras
is imported, errors will likely be much more informative. For example,