/usr/share/doc/libghc-crypto-cipher-types-doc/html/src/Crypto-Cipher-Types-Base.html is in libghc-crypto-cipher-types-doc 0.0.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>Crypto/Cipher/Types/Base.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-- |</span>
<a name="line-2"></a><span class='hs-comment'>-- Module : Crypto.Cipher.Types.Base</span>
<a name="line-3"></a><span class='hs-comment'>-- License : BSD-style</span>
<a name="line-4"></a><span class='hs-comment'>-- Maintainer : Vincent Hanquez <vincent@snarc.org></span>
<a name="line-5"></a><span class='hs-comment'>-- Stability : Stable</span>
<a name="line-6"></a><span class='hs-comment'>-- Portability : Excellent</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- symmetric cipher basic types</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Crypto</span><span class='hs-varop'>.</span><span class='hs-conid'>Cipher</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span>
<a name="line-11"></a> <span class='hs-layout'>(</span> <span class='hs-conid'>KeyError</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-12"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>KeySizeSpecifier</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-13"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Key</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-14"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>IV</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-15"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Cipher</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-16"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>AuthTag</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>AEADMode</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-18"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>DataUnitOffset</span>
<a name="line-19"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-20"></a>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Byteable</span>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>SecureMem</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Word</span>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-25"></a>
<a name="line-26"></a><a name="KeyError"></a><span class='hs-comment'>-- | Possible Error that can be reported when initializating a key</span>
<a name="line-27"></a><a name="KeyError"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>KeyError</span> <span class='hs-keyglyph'>=</span>
<a name="line-28"></a> <span class='hs-conid'>KeyErrorTooSmall</span>
<a name="line-29"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>KeyErrorTooBig</span>
<a name="line-30"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>KeyErrorInvalid</span> <span class='hs-conid'>String</span>
<a name="line-31"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span><span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
<a name="line-32"></a>
<a name="line-33"></a><a name="KeySizeSpecifier"></a><span class='hs-comment'>-- | Different specifier for key size in bytes</span>
<a name="line-34"></a><a name="KeySizeSpecifier"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>KeySizeSpecifier</span> <span class='hs-keyglyph'>=</span>
<a name="line-35"></a> <span class='hs-conid'>KeySizeRange</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ in the range [min,max]</span>
<a name="line-36"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>KeySizeEnum</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Int</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ one of the specified values</span>
<a name="line-37"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>KeySizeFixed</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ a specific size</span>
<a name="line-38"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span><span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
<a name="line-39"></a>
<a name="line-40"></a><a name="DataUnitOffset"></a><span class='hs-comment'>-- | Offset inside an XTS data unit, measured in block size.</span>
<a name="line-41"></a><a name="DataUnitOffset"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>DataUnitOffset</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Word32</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="Key"></a><span class='hs-comment'>-- | a Key parametrized by the cipher</span>
<a name="line-44"></a><a name="Key"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Key</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Key</span> <span class='hs-conid'>SecureMem</span> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
<a name="line-45"></a>
<a name="line-46"></a><a name="instance%20ToSecureMem%20(Key%20c)"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>ToSecureMem</span> <span class='hs-layout'>(</span><span class='hs-conid'>Key</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-47"></a> <span class='hs-varid'>toSecureMem</span> <span class='hs-layout'>(</span><span class='hs-conid'>Key</span> <span class='hs-varid'>sm</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sm</span>
<a name="line-48"></a><a name="instance%20Byteable%20(Key%20c)"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Byteable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Key</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-49"></a> <span class='hs-varid'>toBytes</span> <span class='hs-layout'>(</span><span class='hs-conid'>Key</span> <span class='hs-varid'>sm</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toBytes</span> <span class='hs-varid'>sm</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="IV"></a><span class='hs-comment'>-- | an IV parametrized by the cipher</span>
<a name="line-52"></a><a name="IV"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>IV</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>IV</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
<a name="line-53"></a>
<a name="line-54"></a><a name="instance%20Byteable%20(IV%20c)"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Byteable</span> <span class='hs-layout'>(</span><span class='hs-conid'>IV</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-55"></a> <span class='hs-varid'>toBytes</span> <span class='hs-layout'>(</span><span class='hs-conid'>IV</span> <span class='hs-varid'>sm</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sm</span>
<a name="line-56"></a>
<a name="line-57"></a><a name="AuthTag"></a><span class='hs-comment'>-- | Authentification Tag for AE cipher mode</span>
<a name="line-58"></a><a name="AuthTag"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>AuthTag</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AuthTag</span> <span class='hs-conid'>ByteString</span>
<a name="line-59"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="instance%20Eq%20AuthTag"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Eq</span> <span class='hs-conid'>AuthTag</span> <span class='hs-keyword'>where</span>
<a name="line-62"></a> <span class='hs-layout'>(</span><span class='hs-conid'>AuthTag</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-varop'>==</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthTag</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>constEqBytes</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span>
<a name="line-63"></a><a name="instance%20Byteable%20AuthTag"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Byteable</span> <span class='hs-conid'>AuthTag</span> <span class='hs-keyword'>where</span>
<a name="line-64"></a> <span class='hs-varid'>toBytes</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthTag</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>bs</span>
<a name="line-65"></a>
<a name="line-66"></a><a name="AEADMode"></a><span class='hs-comment'>-- | AEAD Mode</span>
<a name="line-67"></a><a name="AEADMode"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>AEADMode</span> <span class='hs-keyglyph'>=</span>
<a name="line-68"></a> <span class='hs-conid'>AEAD_OCB</span>
<a name="line-69"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>AEAD_CCM</span>
<a name="line-70"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>AEAD_EAX</span>
<a name="line-71"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>AEAD_CWC</span>
<a name="line-72"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>AEAD_GCM</span>
<a name="line-73"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span><span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
<a name="line-74"></a>
<a name="line-75"></a><span class='hs-comment'>-- | Symmetric cipher class.</span>
<a name="line-76"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>Cipher</span> <span class='hs-varid'>cipher</span> <span class='hs-keyword'>where</span>
<a name="line-77"></a> <span class='hs-comment'>-- | Initialize a cipher context from a key</span>
<a name="line-78"></a> <span class='hs-varid'>cipherInit</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Key</span> <span class='hs-varid'>cipher</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>cipher</span>
<a name="line-79"></a> <span class='hs-comment'>-- | Cipher name</span>
<a name="line-80"></a> <span class='hs-varid'>cipherName</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>cipher</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-81"></a> <span class='hs-comment'>-- | return the size of the key required for this cipher.</span>
<a name="line-82"></a> <span class='hs-comment'>-- Some cipher accept any size for key</span>
<a name="line-83"></a> <span class='hs-varid'>cipherKeySize</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>cipher</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>KeySizeSpecifier</span>
</pre></body>
</html>
|