Cropty

Asymmetric Encryption

newtype PrivateKey

A secret identity which one should be very careful about storing and sharing. If others get it, they will be able to read messages intended for you.

Constructors

PrivateKey

Fields

• privateKey :: PrivateKey

Instances

Eq PrivateKey

Defined in Cropty

Methods

(==) :: PrivateKey -> PrivateKey -> Bool

(/=) :: PrivateKey -> PrivateKey -> Bool

Ord PrivateKey

Defined in Cropty

Methods

compare :: PrivateKey -> PrivateKey -> Ordering

(<) :: PrivateKey -> PrivateKey -> Bool

(<=) :: PrivateKey -> PrivateKey -> Bool

(>) :: PrivateKey -> PrivateKey -> Bool

(>=) :: PrivateKey -> PrivateKey -> Bool

max :: PrivateKey -> PrivateKey -> PrivateKey

min :: PrivateKey -> PrivateKey -> PrivateKey

Read PrivateKey

Defined in Cropty

Methods

readsPrec :: Int -> ReadS PrivateKey

readList :: ReadS [PrivateKey]

readPrec :: ReadPrec PrivateKey

readListPrec :: ReadPrec [PrivateKey]

Show PrivateKey

Defined in Cropty

Methods

showsPrec :: Int -> PrivateKey -> ShowS

show :: PrivateKey -> String

showList :: [PrivateKey] -> ShowS

Binary PrivateKey

Defined in Cropty

Methods

put :: PrivateKey -> Put

get :: Get PrivateKey

putList :: [PrivateKey] -> Put

privateToPublic :: PrivateKey -> PublicKey

Get a PublicKey which corresponds to the given PrivateKey

data PublicKey

A public identity which corresponds to your secret one, allowing you to tell other people how to encrypt things for you. If you sign something with the PrivateKey associated with this public one, someone will be able to verify it was you with your public key.

Constructors

PublicKey

Fields

• publicKey :: PublicKey

Instances

Eq PublicKey

Defined in Cropty

Methods

(==) :: PublicKey -> PublicKey -> Bool

(/=) :: PublicKey -> PublicKey -> Bool

Ord PublicKey

Defined in Cropty

Methods

compare :: PublicKey -> PublicKey -> Ordering

(<) :: PublicKey -> PublicKey -> Bool

(<=) :: PublicKey -> PublicKey -> Bool

(>) :: PublicKey -> PublicKey -> Bool

(>=) :: PublicKey -> PublicKey -> Bool

max :: PublicKey -> PublicKey -> PublicKey

min :: PublicKey -> PublicKey -> PublicKey

Read PublicKey

Defined in Cropty

Methods

readsPrec :: Int -> ReadS PublicKey

readList :: ReadS [PublicKey]

readPrec :: ReadPrec PublicKey

readListPrec :: ReadPrec [PublicKey]

Show PublicKey

Defined in Cropty

Methods

showsPrec :: Int -> PublicKey -> ShowS

show :: PublicKey -> String

showList :: [PublicKey] -> ShowS

Binary PublicKey

Defined in Cropty

Methods

put :: PublicKey -> Put

get :: Get PublicKey

putList :: [PublicKey] -> Put

Efficient Encryption

data Message

An message encrypted for a specific PublicKey. Contains an encryptSmalled AEP key which only the owner of the corresponding PrivateKey can unlock, and a symmetrically encrypted message for them to decrypt once they decryptSmall their AEP key.

Constructors

Message

Fields

• encryptedKey :: ByteString
• encryptedBytes :: ByteString

Instances

Read Message

Defined in Cropty

Methods

readsPrec :: Int -> ReadS Message

readList :: ReadS [Message]

readPrec :: ReadPrec Message

readListPrec :: ReadPrec [Message]

Show Message

Defined in Cropty

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Generic Message

Defined in Cropty

Associated Types

type Rep Message :: Type -> Type

Methods

from :: Message -> Rep Message x

to :: Rep Message x -> Message

Binary Message

Defined in Cropty

Methods

put :: Message -> Put

get :: Get Message

putList :: [Message] -> Put

type Rep Message

Defined in Cropty

type Rep Message = D1 ('MetaData "Message" "Cropty" "cropty-0.3.1.0-Kj3nrqpcf3M6FZNfZi8ZJC" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) (S1 ('MetaSel ('Just "encryptedKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "encryptedBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

encrypt :: PublicKey -> ByteString -> IO Message

Encrypt a ByteString for the given PublicKey, storing the results into a Message.

data EncryptionException

The sort of exception we might get during encryption.

Constructors

EncryptionException RSAError

Instances

Show EncryptionException

Defined in Cropty

Methods

showsPrec :: Int -> EncryptionException -> ShowS

show :: EncryptionException -> String

showList :: [EncryptionException] -> ShowS

Exception EncryptionException

Defined in Cropty

Methods

toException :: EncryptionException -> SomeException

fromException :: SomeException -> Maybe EncryptionException

displayException :: EncryptionException -> String

decrypt :: PrivateKey -> Message -> IO ByteString

Decrypt a Message into a ByteString, the original message.

data DecryptionException

The sort of exception we might get during decryption.

Constructors

DecryptionException RSAError

Instances

Show DecryptionException

Defined in Cropty

Methods

showsPrec :: Int -> DecryptionException -> ShowS

show :: DecryptionException -> String

showList :: [DecryptionException] -> ShowS

Exception DecryptionException

Defined in Cropty

Methods

toException :: DecryptionException -> SomeException

fromException :: SomeException -> Maybe DecryptionException

displayException :: DecryptionException -> String

Digital Signatures

newtype Signature

The result of signing a ByteString. View this as a digital improvement on the written signature: if you sign something with your PrivateKey, anyone with your PublicKey can verify that signature's legitimacy.

Constructors

Signature

Fields

• signatureBytes :: ByteString

Instances

Eq Signature

Defined in Cropty

Methods

(==) :: Signature -> Signature -> Bool

(/=) :: Signature -> Signature -> Bool

Ord Signature

Defined in Cropty

Methods

compare :: Signature -> Signature -> Ordering

(<) :: Signature -> Signature -> Bool

(<=) :: Signature -> Signature -> Bool

(>) :: Signature -> Signature -> Bool

(>=) :: Signature -> Signature -> Bool

max :: Signature -> Signature -> Signature

min :: Signature -> Signature -> Signature

Read Signature

Defined in Cropty

Methods

readsPrec :: Int -> ReadS Signature

readList :: ReadS [Signature]

readPrec :: ReadPrec Signature

readListPrec :: ReadPrec [Signature]

Show Signature

Defined in Cropty

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

Generic Signature

Defined in Cropty

Associated Types

type Rep Signature :: Type -> Type

Methods

from :: Signature -> Rep Signature x

to :: Rep Signature x -> Signature

Binary Signature

Defined in Cropty

Methods

put :: Signature -> Put

get :: Get Signature

putList :: [Signature] -> Put

type Rep Signature

Defined in Cropty

type Rep Signature = D1 ('MetaData "Signature" "Cropty" "cropty-0.3.1.0-Kj3nrqpcf3M6FZNfZi8ZJC" 'True) (C1 ('MetaCons "Signature" 'PrefixI 'True) (S1 ('MetaSel ('Just "signatureBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

sign :: PrivateKey -> ByteString -> IO Signature

Sign a message with your private key, producing a ByteString that others cannot fabricate for new messages.

verify :: PublicKey -> ByteString -> Signature -> Bool

Verify the signature of a message.

data Signed a

A convenient type in which to wrap signed things.

Instances

Eq (Signed a)

Defined in Cropty

Methods

(==) :: Signed a -> Signed a -> Bool

(/=) :: Signed a -> Signed a -> Bool

Ord (Signed a)

Defined in Cropty

Methods

compare :: Signed a -> Signed a -> Ordering

(<) :: Signed a -> Signed a -> Bool

(<=) :: Signed a -> Signed a -> Bool

(>) :: Signed a -> Signed a -> Bool

(>=) :: Signed a -> Signed a -> Bool

max :: Signed a -> Signed a -> Signed a

min :: Signed a -> Signed a -> Signed a

Read a => Read (Signed a)

Defined in Cropty

Methods

readsPrec :: Int -> ReadS (Signed a)

readList :: ReadS [Signed a]

readPrec :: ReadPrec (Signed a)

readListPrec :: ReadPrec [Signed a]

Show a => Show (Signed a)

Defined in Cropty

Methods

showsPrec :: Int -> Signed a -> ShowS

show :: Signed a -> String

showList :: [Signed a] -> ShowS

Generic (Signed a)

Defined in Cropty

Associated Types

type Rep (Signed a) :: Type -> Type

Methods

from :: Signed a -> Rep (Signed a) x

to :: Rep (Signed a) x -> Signed a

Binary a => Binary (Signed a)

Defined in Cropty

Methods

put :: Signed a -> Put

get :: Get (Signed a)

putList :: [Signed a] -> Put

type Rep (Signed a)

Defined in Cropty

type Rep (Signed a) = D1 ('MetaData "Signed" "Cropty" "cropty-0.3.1.0-Kj3nrqpcf3M6FZNfZi8ZJC" 'False) (C1 ('MetaCons "Signed" 'PrefixI 'True) ((S1 ('MetaSel ('Just "signed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "signedEncoded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :*: (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Signature) :*: S1 ('MetaSel ('Just "signedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PublicKey))))

signed :: Signed a -> a

signedBy :: Signed a -> PublicKey

signature :: Signed a -> Signature

signedEncoded :: Signed a -> ByteString

mkSigned :: Binary a => PrivateKey -> a -> IO (Signed a)

Create a Signed piece of data.

verifySigned :: Signed a -> Bool

Verify a Signed piece of data.

Encrypt/Decrypt Small Strings

encryptSmall :: PublicKey -> ByteString -> IO (Either RSAError ByteString)

Encrypt a ByteString of length less than or equal to the KeySize. Skips the symmetric encryption step. For the most part, this should be avoided, but there is no reason not to expose it.

decryptSmall :: PrivateKey -> ByteString -> IO (Either RSAError ByteString)

Decrypt a ByteString of length less than or equal to the KeySize. Skips the symmetric encryption step. For the most part, this should be avoided, but there is no reason not to expose it.

Supported Key Sizes

data KeySize

The various supported key sizes for the underlying RSA implementation

Constructors

KeySize256

KeySize512

KeySize1024

KeySize2048

KeySize4096

Instances

Bounded KeySize

Defined in Cropty

Methods

minBound :: KeySize

maxBound :: KeySize

Enum KeySize

Defined in Cropty

Methods

succ :: KeySize -> KeySize

pred :: KeySize -> KeySize

toEnum :: Int -> KeySize

fromEnum :: KeySize -> Int

enumFrom :: KeySize -> [KeySize]

enumFromThen :: KeySize -> KeySize -> [KeySize]

enumFromTo :: KeySize -> KeySize -> [KeySize]

enumFromThenTo :: KeySize -> KeySize -> KeySize -> [KeySize]

Eq KeySize

Defined in Cropty

Methods

(==) :: KeySize -> KeySize -> Bool

(/=) :: KeySize -> KeySize -> Bool

Ord KeySize

Defined in Cropty

Methods

compare :: KeySize -> KeySize -> Ordering

(<) :: KeySize -> KeySize -> Bool

(<=) :: KeySize -> KeySize -> Bool

(>) :: KeySize -> KeySize -> Bool

(>=) :: KeySize -> KeySize -> Bool

max :: KeySize -> KeySize -> KeySize

min :: KeySize -> KeySize -> KeySize

keySizeInt :: KeySize -> Int

Get the size of the key in the form of an Int

keySizeFromInt :: Int -> Maybe KeySize

Get the size of a

Key generation

generatePrivateKey :: KeySize -> IO PrivateKey

Generate a new PrivateKey of the given KeySize

generatePrivateKeyWithPublicExponent :: Integer -> KeySize -> IO PrivateKey

Generate a new PrivateKey of the given KeySize, providing the RSA public exponent as well.

Symmetric Encryption

newtype Key

A key for symmetric (AEP) encryption

Constructors

Key

Fields

• keyBytes :: ByteString

Instances

Eq Key

Defined in Cropty

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

Ord Key

Defined in Cropty

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Read Key

Defined in Cropty

Methods

readsPrec :: Int -> ReadS Key

readList :: ReadS [Key]

readPrec :: ReadPrec Key

readListPrec :: ReadPrec [Key]

Show Key

Defined in Cropty

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Generic Key

Defined in Cropty

Associated Types

type Rep Key :: Type -> Type

Methods

from :: Key -> Rep Key x

to :: Rep Key x -> Key

Binary Key

Defined in Cropty

Methods

put :: Key -> Put

get :: Get Key

putList :: [Key] -> Put

type Rep Key

Defined in Cropty

type Rep Key = D1 ('MetaData "Key" "Cropty" "cropty-0.3.1.0-Kj3nrqpcf3M6FZNfZi8ZJC" 'True) (C1 ('MetaCons "Key" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

generateKey :: IO Key

Generate a new Key. It must have 32 bytes, because we are using AES256, and there are 8 bits in a byte. In other words: 32 * 8 = 256.

encryptSym :: Key -> ByteString -> Either SymEncryptionException ByteString

Encrypt a ByteString such that anyone else who has the Key can decryptSym it later.

data SymEncryptionException

Constructors

SymEncryptionException'CryptoniteError CryptoError

Instances

Show SymEncryptionException

Defined in Cropty

Methods

showsPrec :: Int -> SymEncryptionException -> ShowS

show :: SymEncryptionException -> String

showList :: [SymEncryptionException] -> ShowS

Exception SymEncryptionException

Defined in Cropty

Methods

toException :: SymEncryptionException -> SomeException

fromException :: SomeException -> Maybe SymEncryptionException

displayException :: SymEncryptionException -> String

decryptSym :: Key -> ByteString -> Either SymDecryptionException ByteString

Decrypt a ByteString which has been encryptSymed with the given Key.

data SymDecryptionException

Constructors

SymDecryptionException'CryptoniteError CryptoError

SymDecryptionException'CroptyError CroptyError

Instances

Show SymDecryptionException

Defined in Cropty

Methods

showsPrec :: Int -> SymDecryptionException -> ShowS

show :: SymDecryptionException -> String

showList :: [SymDecryptionException] -> ShowS

Exception SymDecryptionException

Defined in Cropty

Methods

toException :: SymDecryptionException -> SomeException

fromException :: SomeException -> Maybe SymDecryptionException

displayException :: SymDecryptionException -> String

Errors Re-Exported from Cryptonite

type RSAError = Error

import qualified Crypto.PubKey.RSA.Types as RSA (Error (..))

data CryptoError

Enumeration of all possible errors that can be found in this library

Constructors

CryptoError_KeySizeInvalid

CryptoError_IvSizeInvalid

CryptoError_SeedSizeInvalid

CryptoError_AEADModeNotSupported

CryptoError_SecretKeySizeInvalid

CryptoError_SecretKeyStructureInvalid

CryptoError_PublicKeySizeInvalid

CryptoError_SharedSecretSizeInvalid

CryptoError_EcScalarOutOfBounds

CryptoError_PointSizeInvalid

CryptoError_PointFormatInvalid

CryptoError_PointFormatUnsupported

CryptoError_PointCoordinatesInvalid

CryptoError_ScalarMultiplicationInvalid

CryptoError_MacKeyInvalid

CryptoError_AuthenticationTagSizeInvalid

CryptoError_PrimeSizeInvalid

CryptoError_SaltTooSmall

CryptoError_OutputLengthTooSmall

CryptoError_OutputLengthTooBig

Instances

Enum CryptoError

Defined in Crypto.Error.Types

Methods

succ :: CryptoError -> CryptoError

pred :: CryptoError -> CryptoError

toEnum :: Int -> CryptoError

fromEnum :: CryptoError -> Int

enumFrom :: CryptoError -> [CryptoError]

enumFromThen :: CryptoError -> CryptoError -> [CryptoError]

enumFromTo :: CryptoError -> CryptoError -> [CryptoError]

enumFromThenTo :: CryptoError -> CryptoError -> CryptoError -> [CryptoError]

Eq CryptoError

Defined in Crypto.Error.Types

Methods

(==) :: CryptoError -> CryptoError -> Bool

(/=) :: CryptoError -> CryptoError -> Bool

Data CryptoError

Defined in Crypto.Error.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CryptoError -> c CryptoError

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CryptoError

toConstr :: CryptoError -> Constr

dataTypeOf :: CryptoError -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CryptoError)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CryptoError)

gmapT :: (forall b. Data b => b -> b) -> CryptoError -> CryptoError

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CryptoError -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CryptoError -> r

gmapQ :: (forall d. Data d => d -> u) -> CryptoError -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CryptoError -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CryptoError -> m CryptoError

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CryptoError -> m CryptoError

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CryptoError -> m CryptoError

Show CryptoError

Defined in Crypto.Error.Types

Methods

showsPrec :: Int -> CryptoError -> ShowS

show :: CryptoError -> String

showList :: [CryptoError] -> ShowS

Exception CryptoError

Defined in Crypto.Error.Types

Methods

toException :: CryptoError -> SomeException

fromException :: SomeException -> Maybe CryptoError

displayException :: CryptoError -> String