{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE TypeFamilies #-}
module Data.ByteString.Base64.URL
(
encodeBase64
, encodeBase64'
, encodeBase64Unpadded
, encodeBase64Unpadded'
, decodeBase64
, decodeBase64Untyped
, decodeBase64Unpadded
, decodeBase64UnpaddedUntyped
, decodeBase64Padded
, decodeBase64PaddedUntyped
, decodeBase64Lenient
, isBase64Url
, isValidBase64Url
) where
import Data.Base64.Types
import Data.Base64.Types.Internal
import qualified Data.ByteString as BS
import Data.ByteString.Internal (ByteString(..))
import Data.ByteString.Base64.Internal
import Data.ByteString.Base64.Internal.Head
import Data.ByteString.Base64.Internal.Tables
import Data.Either (isRight)
import Data.Text (Text)
import qualified Data.Text.Encoding as T
import System.IO.Unsafe
encodeBase64 :: ByteString -> Base64 'UrlPadded Text
encodeBase64 :: ByteString -> Base64 'UrlPadded Text
encodeBase64 = (ByteString -> Text)
-> Base64 'UrlPadded ByteString -> Base64 'UrlPadded Text
forall a b. (a -> b) -> Base64 'UrlPadded a -> Base64 'UrlPadded b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap ByteString -> Text
T.decodeUtf8 (Base64 'UrlPadded ByteString -> Base64 'UrlPadded Text)
-> (ByteString -> Base64 'UrlPadded ByteString)
-> ByteString
-> Base64 'UrlPadded Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ByteString -> Base64 'UrlPadded ByteString
encodeBase64'
{-# INLINE encodeBase64 #-}
encodeBase64' :: ByteString -> Base64 'UrlPadded ByteString
encodeBase64' :: ByteString -> Base64 'UrlPadded ByteString
encodeBase64' = ByteString -> Base64 'UrlPadded ByteString
forall (k :: Alphabet) a. a -> Base64 k a
assertBase64 (ByteString -> Base64 'UrlPadded ByteString)
-> (ByteString -> ByteString)
-> ByteString
-> Base64 'UrlPadded ByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. EncodingTable -> ByteString -> ByteString
encodeBase64_ EncodingTable
base64UrlTable
decodeBase64
:: UrlAlphabet k
=> Base64 k ByteString
-> ByteString
decodeBase64 :: forall (k :: Alphabet).
UrlAlphabet k =>
Base64 k ByteString -> ByteString
decodeBase64 b64 :: Base64 k ByteString
b64@(Base64 ByteString
bs)
| Bool -> Bool
not (Bool -> Bool) -> Bool -> Bool
forall a b. (a -> b) -> a -> b
$ ByteString -> Bool
BS.null ByteString
bs, HasCallStack => ByteString -> Word8
ByteString -> Word8
BS.last ByteString
bs Word8 -> Word8 -> Bool
forall a. Eq a => a -> a -> Bool
== Word8
0x3d = Base64 'UrlPadded ByteString -> ByteString
decodeBase64Padded (Base64 'UrlPadded ByteString -> ByteString)
-> Base64 'UrlPadded ByteString -> ByteString
forall a b. (a -> b) -> a -> b
$ Base64 k ByteString -> Base64 'UrlPadded ByteString
forall (j :: Alphabet) (k :: Alphabet) a. Base64 k a -> Base64 j a
coerceBase64 Base64 k ByteString
b64
| Bool
otherwise = Base64 'UrlUnpadded ByteString -> ByteString
decodeBase64Unpadded (Base64 'UrlUnpadded ByteString -> ByteString)
-> Base64 'UrlUnpadded ByteString -> ByteString
forall a b. (a -> b) -> a -> b
$ Base64 k ByteString -> Base64 'UrlUnpadded ByteString
forall (j :: Alphabet) (k :: Alphabet) a. Base64 k a -> Base64 j a
coerceBase64 Base64 k ByteString
b64
{-# inline decodeBase64 #-}
decodeBase64Untyped :: ByteString -> Either Text ByteString
decodeBase64Untyped :: ByteString -> Either Text ByteString
decodeBase64Untyped bs :: ByteString
bs@(PS ForeignPtr Word8
_ Int
_ !Int
l)
| Int
l Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
0 = ByteString -> Either Text ByteString
forall a b. b -> Either a b
Right ByteString
forall a. Monoid a => a
mempty
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
0 = IO (Either Text ByteString) -> Either Text ByteString
forall a. IO a -> a
unsafeDupablePerformIO (IO (Either Text ByteString) -> Either Text ByteString)
-> IO (Either Text ByteString) -> Either Text ByteString
forall a b. (a -> b) -> a -> b
$ ForeignPtr Word8 -> ByteString -> IO (Either Text ByteString)
decodeBase64_ ForeignPtr Word8
decodeB64UrlTable ByteString
bs
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
2 = IO (Either Text ByteString) -> Either Text ByteString
forall a. IO a -> a
unsafeDupablePerformIO (IO (Either Text ByteString) -> Either Text ByteString)
-> IO (Either Text ByteString) -> Either Text ByteString
forall a b. (a -> b) -> a -> b
$ ForeignPtr Word8 -> ByteString -> IO (Either Text ByteString)
decodeBase64_ ForeignPtr Word8
decodeB64UrlTable (ByteString -> IO (Either Text ByteString))
-> ByteString -> IO (Either Text ByteString)
forall a b. (a -> b) -> a -> b
$ ByteString -> ByteString -> ByteString
BS.append ByteString
bs ByteString
"=="
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
3 = ByteString -> IO (Either Text ByteString) -> Either Text ByteString
validateLastPad ByteString
bs (IO (Either Text ByteString) -> Either Text ByteString)
-> IO (Either Text ByteString) -> Either Text ByteString
forall a b. (a -> b) -> a -> b
$ ForeignPtr Word8 -> ByteString -> IO (Either Text ByteString)
decodeBase64_ ForeignPtr Word8
decodeB64UrlTable (ByteString -> IO (Either Text ByteString))
-> ByteString -> IO (Either Text ByteString)
forall a b. (a -> b) -> a -> b
$ ByteString -> ByteString -> ByteString
BS.append ByteString
bs ByteString
"="
| Bool
otherwise = Text -> Either Text ByteString
forall a b. a -> Either a b
Left Text
"Base64-encoded bytestring has invalid size"
where
!r :: Int
r = Int
l Int -> Int -> Int
forall a. Integral a => a -> a -> a
`rem` Int
4
{-# INLINE decodeBase64Untyped #-}
encodeBase64Unpadded :: ByteString -> Base64 'UrlUnpadded Text
encodeBase64Unpadded :: ByteString -> Base64 'UrlUnpadded Text
encodeBase64Unpadded = (ByteString -> Text)
-> Base64 'UrlUnpadded ByteString -> Base64 'UrlUnpadded Text
forall a b.
(a -> b) -> Base64 'UrlUnpadded a -> Base64 'UrlUnpadded b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap ByteString -> Text
T.decodeUtf8 (Base64 'UrlUnpadded ByteString -> Base64 'UrlUnpadded Text)
-> (ByteString -> Base64 'UrlUnpadded ByteString)
-> ByteString
-> Base64 'UrlUnpadded Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ByteString -> Base64 'UrlUnpadded ByteString
encodeBase64Unpadded'
{-# INLINE encodeBase64Unpadded #-}
encodeBase64Unpadded' :: ByteString -> Base64 'UrlUnpadded ByteString
encodeBase64Unpadded' :: ByteString -> Base64 'UrlUnpadded ByteString
encodeBase64Unpadded' = ByteString -> Base64 'UrlUnpadded ByteString
forall (k :: Alphabet) a. a -> Base64 k a
assertBase64 (ByteString -> Base64 'UrlUnpadded ByteString)
-> (ByteString -> ByteString)
-> ByteString
-> Base64 'UrlUnpadded ByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. EncodingTable -> ByteString -> ByteString
encodeBase64Nopad_ EncodingTable
base64UrlTable
decodeBase64Unpadded :: Base64 'UrlUnpadded ByteString -> ByteString
decodeBase64Unpadded :: Base64 'UrlUnpadded ByteString -> ByteString
decodeBase64Unpadded b64 :: Base64 'UrlUnpadded ByteString
b64@(Base64 (PS ForeignPtr Word8
_ Int
_ !Int
l))
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
2 = Base64 'UrlPadded ByteString -> ByteString
decodeBase64Padded (Base64 'UrlPadded ByteString -> ByteString)
-> Base64 'UrlPadded ByteString -> ByteString
forall a b. (a -> b) -> a -> b
$ Base64 'UrlUnpadded ByteString -> Base64 'UrlPadded ByteString
forall (j :: Alphabet) (k :: Alphabet) a. Base64 k a -> Base64 j a
coerceBase64 (Base64 'UrlUnpadded ByteString -> Base64 'UrlPadded ByteString)
-> Base64 'UrlUnpadded ByteString -> Base64 'UrlPadded ByteString
forall a b. (a -> b) -> a -> b
$ (ByteString -> ByteString -> ByteString
`BS.append` ByteString
"==") (ByteString -> ByteString)
-> Base64 'UrlUnpadded ByteString -> Base64 'UrlUnpadded ByteString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Base64 'UrlUnpadded ByteString
b64
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
3 = Base64 'UrlPadded ByteString -> ByteString
decodeBase64Padded (Base64 'UrlPadded ByteString -> ByteString)
-> Base64 'UrlPadded ByteString -> ByteString
forall a b. (a -> b) -> a -> b
$ Base64 'UrlUnpadded ByteString -> Base64 'UrlPadded ByteString
forall (j :: Alphabet) (k :: Alphabet) a. Base64 k a -> Base64 j a
coerceBase64 (Base64 'UrlUnpadded ByteString -> Base64 'UrlPadded ByteString)
-> Base64 'UrlUnpadded ByteString -> Base64 'UrlPadded ByteString
forall a b. (a -> b) -> a -> b
$ (ByteString -> ByteString -> ByteString
`BS.append` ByteString
"=") (ByteString -> ByteString)
-> Base64 'UrlUnpadded ByteString -> Base64 'UrlUnpadded ByteString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Base64 'UrlUnpadded ByteString
b64
| Bool
otherwise = Base64 'UrlPadded ByteString -> ByteString
decodeBase64Padded (Base64 'UrlPadded ByteString -> ByteString)
-> Base64 'UrlPadded ByteString -> ByteString
forall a b. (a -> b) -> a -> b
$ Base64 'UrlUnpadded ByteString -> Base64 'UrlPadded ByteString
forall (j :: Alphabet) (k :: Alphabet) a. Base64 k a -> Base64 j a
coerceBase64 Base64 'UrlUnpadded ByteString
b64
where
!r :: Int
r = Int
l Int -> Int -> Int
forall a. Integral a => a -> a -> a
`rem` Int
4
decodeBase64PaddedUntyped :: ByteString -> Either Text ByteString
decodeBase64PaddedUntyped :: ByteString -> Either Text ByteString
decodeBase64PaddedUntyped bs :: ByteString
bs@(PS ForeignPtr Word8
_ Int
_ !Int
l)
| Int
l Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
0 = ByteString -> Either Text ByteString
forall a b. b -> Either a b
Right ByteString
forall a. Monoid a => a
mempty
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
1 = Text -> Either Text ByteString
forall a b. a -> Either a b
Left Text
"Base64-encoded bytestring has invalid size"
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
/= Int
0 = Text -> Either Text ByteString
forall a b. a -> Either a b
Left Text
"Base64-encoded bytestring requires padding"
| Bool
otherwise = IO (Either Text ByteString) -> Either Text ByteString
forall a. IO a -> a
unsafeDupablePerformIO (IO (Either Text ByteString) -> Either Text ByteString)
-> IO (Either Text ByteString) -> Either Text ByteString
forall a b. (a -> b) -> a -> b
$ ForeignPtr Word8 -> ByteString -> IO (Either Text ByteString)
decodeBase64_ ForeignPtr Word8
decodeB64UrlTable ByteString
bs
where
!r :: Int
r = Int
l Int -> Int -> Int
forall a. Integral a => a -> a -> a
`rem` Int
4
{-# INLINE decodeBase64PaddedUntyped #-}
decodeBase64Padded :: Base64 'UrlPadded ByteString -> ByteString
decodeBase64Padded :: Base64 'UrlPadded ByteString -> ByteString
decodeBase64Padded = ForeignPtr Word8 -> Base64 'UrlPadded ByteString -> ByteString
forall (k :: Alphabet).
ForeignPtr Word8 -> Base64 k ByteString -> ByteString
decodeBase64Typed_ ForeignPtr Word8
decodeB64UrlTable
{-# INLINE decodeBase64Padded #-}
decodeBase64UnpaddedUntyped :: ByteString -> Either Text ByteString
decodeBase64UnpaddedUntyped :: ByteString -> Either Text ByteString
decodeBase64UnpaddedUntyped bs :: ByteString
bs@(PS ForeignPtr Word8
_ Int
_ !Int
l)
| Int
l Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
0 = ByteString -> Either Text ByteString
forall a b. b -> Either a b
Right ByteString
forall a. Monoid a => a
mempty
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
0 = ByteString -> IO (Either Text ByteString) -> Either Text ByteString
validateLastPad ByteString
bs (IO (Either Text ByteString) -> Either Text ByteString)
-> IO (Either Text ByteString) -> Either Text ByteString
forall a b. (a -> b) -> a -> b
$ ForeignPtr Word8 -> ByteString -> IO (Either Text ByteString)
decodeBase64_ ForeignPtr Word8
decodeB64UrlTable ByteString
bs
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
2 = ByteString -> IO (Either Text ByteString) -> Either Text ByteString
validateLastPad ByteString
bs (IO (Either Text ByteString) -> Either Text ByteString)
-> IO (Either Text ByteString) -> Either Text ByteString
forall a b. (a -> b) -> a -> b
$ ForeignPtr Word8 -> ByteString -> IO (Either Text ByteString)
decodeBase64_ ForeignPtr Word8
decodeB64UrlTable (ByteString -> IO (Either Text ByteString))
-> ByteString -> IO (Either Text ByteString)
forall a b. (a -> b) -> a -> b
$ ByteString -> ByteString -> ByteString
BS.append ByteString
bs ByteString
"=="
| Int
r Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
== Int
3 = ByteString -> IO (Either Text ByteString) -> Either Text ByteString
validateLastPad ByteString
bs (IO (Either Text ByteString) -> Either Text ByteString)
-> IO (Either Text ByteString) -> Either Text ByteString
forall a b. (a -> b) -> a -> b
$ ForeignPtr Word8 -> ByteString -> IO (Either Text ByteString)
decodeBase64_ ForeignPtr Word8
decodeB64UrlTable (ByteString -> IO (Either Text ByteString))
-> ByteString -> IO (Either Text ByteString)
forall a b. (a -> b) -> a -> b
$ ByteString -> ByteString -> ByteString
BS.append ByteString
bs ByteString
"="
| Bool
otherwise = Text -> Either Text ByteString
forall a b. a -> Either a b
Left Text
"Base64-encoded bytestring has invalid size"
where
!r :: Int
r = Int
l Int -> Int -> Int
forall a. Integral a => a -> a -> a
`rem` Int
4
{-# INLINE decodeBase64UnpaddedUntyped #-}
decodeBase64Lenient :: ByteString -> ByteString
decodeBase64Lenient :: ByteString -> ByteString
decodeBase64Lenient = ForeignPtr Word8 -> ByteString -> ByteString
decodeBase64Lenient_ ForeignPtr Word8
decodeB64UrlTable
{-# INLINE decodeBase64Lenient #-}
isBase64Url :: ByteString -> Bool
isBase64Url :: ByteString -> Bool
isBase64Url ByteString
bs
= ByteString -> Bool
isValidBase64Url ByteString
bs
Bool -> Bool -> Bool
&& Either Text ByteString -> Bool
forall a b. Either a b -> Bool
isRight (ByteString -> Either Text ByteString
decodeBase64Untyped ByteString
bs)
{-# INLINE isBase64Url #-}
isValidBase64Url :: ByteString -> Bool
isValidBase64Url :: ByteString -> Bool
isValidBase64Url = ByteString -> ByteString -> Bool
validateBase64Url ByteString
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"
{-# INLINE isValidBase64Url #-}