Skip to content

Add missing FFI error exceptions #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dancewithheart wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add missing FFI error exceptions #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions botan-bindings/src/Botan/Bindings/Error.hsc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ module Botan.Bindings.Error (
, pattern BOTAN_FFI_ERROR_TLS_ERROR
, pattern BOTAN_FFI_ERROR_HTTP_ERROR
, pattern BOTAN_FFI_ERROR_ROUGHTIME_ERROR
, pattern BOTAN_FFI_ERROR_TPM_ERROR
, pattern BOTAN_FFI_ERROR_UNKNOWN_ERROR
, botan_error_description
, botan_error_last_exception_message
Expand Down Expand Up @@ -73,6 +74,7 @@ pattern BOTAN_FFI_SUCCESS
, BOTAN_FFI_ERROR_TLS_ERROR
, BOTAN_FFI_ERROR_HTTP_ERROR
, BOTAN_FFI_ERROR_ROUGHTIME_ERROR
, BOTAN_FFI_ERROR_TPM_ERROR
, BOTAN_FFI_ERROR_UNKNOWN_ERROR
:: (Eq a, Num a) => a

Expand Down Expand Up @@ -139,11 +141,12 @@ pattern BOTAN_FFI_ERROR_HTTP_ERROR = #const BOTAN_FFI_ERROR_HTTP_ERROR
-- | Note: this code is undocumented in @botan/ffi.h@.
pattern BOTAN_FFI_ERROR_ROUGHTIME_ERROR = #const BOTAN_FFI_ERROR_ROUGHTIME_ERROR

-- | An error occurred when performing TPM2 interactions.
pattern BOTAN_FFI_ERROR_TPM_ERROR = #const BOTAN_FFI_ERROR_TPM_ERROR

-- | Something bad happened, but we are not sure why or how.
pattern BOTAN_FFI_ERROR_UNKNOWN_ERROR = #const BOTAN_FFI_ERROR_UNKNOWN_ERROR

-- TODO: add a binding for BOTAN_FFI_TEMP_ERROR. See issue #44.

foreign import capi safe "botan/ffi.h botan_error_description"
botan_error_description
:: CInt -- ^ __err__
Expand Down
4 changes: 4 additions & 0 deletions botan-low/src/Botan/Low/Error.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ module Botan.Low.Error (
, Internal.InvalidObjectStateException(..)
, Internal.NotImplementedException(..)
, Internal.InvalidObjectException(..)
, Internal.TLSErrorException(..)
, Internal.HTTPErrorException(..)
, Internal.RoughtimeErrorException(..)
, Internal.TPMErrorException(..)
, Internal.UnknownException(..)
) where

Expand Down
29 changes: 29 additions & 0 deletions botan-low/src/Botan/Low/Error/Internal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ module Botan.Low.Error.Internal (
, NotImplementedException(..)
, InvalidObjectException(..)
, UnknownException(..)
, TLSErrorException(..)
, HTTPErrorException(..)
, RoughtimeErrorException(..)
, TPMErrorException(..)
-- ** Throwing and catching
, throwBotanError
, throwBotanIfNegative
Expand Down Expand Up @@ -203,6 +207,26 @@ data InvalidObjectException
deriving stock (Show)
deriving Exception via ViaSomeBotanException InvalidObjectException

data TLSErrorException
= TLSErrorException BotanErrorCode BotanErrorMessage CallStack
deriving stock Show
deriving Exception via ViaSomeBotanException TLSErrorException

data HTTPErrorException
= HTTPErrorException BotanErrorCode BotanErrorMessage CallStack
deriving stock Show
deriving Exception via ViaSomeBotanException HTTPErrorException

data RoughtimeErrorException
= RoughtimeErrorException BotanErrorCode BotanErrorMessage CallStack
deriving stock Show
deriving Exception via ViaSomeBotanException RoughtimeErrorException

data TPMErrorException
= TPMErrorException BotanErrorCode BotanErrorMessage CallStack
deriving stock Show
deriving Exception via ViaSomeBotanException TPMErrorException

data UnknownException
= UnknownException BotanErrorCode BotanErrorMessage CallStack
deriving stock (Show)
Expand Down Expand Up @@ -277,6 +301,11 @@ throwBotanErrorWithCallstack e cs = do
BOTAN_FFI_ERROR_INVALID_OBJECT_STATE -> throwIO $ InvalidObjectStateException bec emsg cs
BOTAN_FFI_ERROR_NOT_IMPLEMENTED -> throwIO $ NotImplementedException bec emsg cs
BOTAN_FFI_ERROR_INVALID_OBJECT -> throwIO $ InvalidObjectException bec emsg cs
BOTAN_FFI_ERROR_INVALID_OBJECT -> throwIO $ InvalidObjectException bec emsg cs
BOTAN_FFI_ERROR_TLS_ERROR -> throwIO $ TLSErrorException bec emsg cs
BOTAN_FFI_ERROR_HTTP_ERROR -> throwIO $ HTTPErrorException bec emsg cs
BOTAN_FFI_ERROR_ROUGHTIME_ERROR -> throwIO $ RoughtimeErrorException bec emsg cs
BOTAN_FFI_ERROR_TPM_ERROR -> throwIO $ TPMErrorException bec emsg cs
_ -> throwIO $ UnknownException bec emsg cs
where
bec = BotanErrorCode e