tuplehash-utils (empty) → 0.0.0.0
raw patch · 5 files changed
+454/−0 lines, 5 filesdep +basedep +bytestringdep +integer-logarithmssetup-changed
Dependencies added: base, bytestring, integer-logarithms
Files
- ChangeLog.md +6/−0
- LICENSE +202/−0
- Setup.hs +2/−0
- lib/Crypto/Encoding/SHA3/TupleHash.hs +212/−0
- tuplehash-utils.cabal +32/−0
+ ChangeLog.md view
@@ -0,0 +1,6 @@+# Revision history for tuplehash-utils++## 0.0.0.0 -- 2024-03-21++* First version. Needs a proper test suite. Implicitly covered by g3p-hash and+ phkdf's test suite.
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ lib/Crypto/Encoding/SHA3/TupleHash.hs view
@@ -0,0 +1,212 @@+{-# LANGUAGE OverloadedStrings, BangPatterns, ScopedTypeVariables, ViewPatterns #-}++module Crypto.Encoding.SHA3.TupleHash+ ( leftEncodeZero+ , leftEncodeInteger+ , leftEncodeIntegerFromBytes+ , leftEncode+ , leftEncodeFromBytes+ , encodeString+ , encodedByteLength+ , encodedVectorByteLength+ , bareEncodeZero+ , bareEncodeInteger+ , bareEncodeIntegerFromBytes+ , bareEncode+ , bareEncodeFromBytes+ , lengthOfBareEncode+ , lengthOfBareEncodeFromBytes+ , lengthOfBareEncodeInteger+ , lengthOfBareEncodeIntegerFromBytes+ , lengthOfLeftEncode+ , lengthOfLeftEncodeFromBytes+ , lengthOfLeftEncodeInteger+ , lengthOfLeftEncodeIntegerFromBytes+ ) where++import Data.Monoid((<>))+import Data.ByteString(ByteString)+import qualified Data.ByteString as B+import Data.Bits+import Data.List(foldl')+import Data.Word+import Math.NumberTheory.Logarithms(integerLog2)++downFrom :: (Num a, Enum a) => a -> [a]+downFrom x = [x-1,x-2..0]++leftEncodeZero :: ByteString+leftEncodeZero = "\x01\x00"++-- I don't like the current interface in that:+-- leftEncodeInteger returns Nothing when provided a negative result, but+-- leftEncode (on FiniteBits) returns leftEncodeZero when provided the same+-- If there were a way in Haskell to constrain the latter bit to unsigned Words, I'd do it+-- Then the more generic version that works on finite signed ints would return (Maybe ByteString)+-- The current interface is a bit of a compromise++leftEncodeInteger :: Integer -> Maybe ByteString+leftEncodeInteger n =+ case compare n 0 of+ LT -> Nothing+ EQ -> Just leftEncodeZero+ -- Note that the bit length is integerLog2 plus one+ -- Round up to the nearest byte by adding 7, then divide by 8+ -- simplifying, we can divide integerLog2 by eight, and then add one+ GT -> case shiftR (integerLog2 n) 3 + 1 of+ nSigBytes+ | nSigBytes > 255 -> Nothing+ | otherwise -> Just (B.pack (go (fromIntegral nSigBytes)))+ where+ go nSigBytes = fromIntegral nSigBytes : map getByte (downFrom nSigBytes)+ -- FIXME: using shiftR here results in a quadratic algorithm+ getByte ix = fromIntegral (shiftR n (8*ix) .&. 0xFF)++leftEncodeIntegerFromBytes :: Integer -> Maybe ByteString+leftEncodeIntegerFromBytes n = leftEncodeInteger (8*n)++leftEncode :: forall b. (Integral b, FiniteBits b) => b -> ByteString+leftEncode n+ | n <= 0 = leftEncodeZero+ | otherwise = B.pack output+ where+ wordLen = finiteBitSize n+ zeros = countLeadingZeros n+ nSigBits = wordLen - zeros+ nSigBytes = max 1 (shiftR (nSigBits + 7) 3)+ getByte :: Int -> Word8+ getByte ix = fromIntegral (shiftR n (8 * ix) .&. 255)+ output = fromIntegral nSigBytes : map getByte (downFrom nSigBytes)++leftEncodeFromBytes :: (Integral b, FiniteBits b) => b -> ByteString+leftEncodeFromBytes n+ | n <= 0 = leftEncodeZero+ | otherwise = B.pack output+ where+ wordLen = finiteBitSize n+ zeros = countLeadingZeros n+ nSigBits = wordLen - zeros + 3+ nSigBytes = max 1 (shiftR (nSigBits + 7) 3)+ getByte ix = fromIntegral (shift n (3 - 8 * ix) .&. 0xFF)+ output = fromIntegral nSigBytes : map getByte (downFrom nSigBytes)++{--+-- FIXME: this doesn't work for x0 > 7+leftEncodeBytesMinusBits :: Word -> Word8 -> ByteString+leftEncodeBytesMinusBits n0 x0 = B.pack (fromIntegral nSigBytes : output)+ where+ n = n0 - fromIntegral (fromEnum (x /= 0))+ wordLen = finiteBitSize n+ zeros = countLeadingZeros n+ nSigBits = wordLen - zeros + 3+ nSigBytes = fromIntegral (max 1 (shiftR (nSigBits + 7) 3)) :: Word8+ getByte ix = fromIntegral byte .|. mx+ where byte = shift n (3 - 8 * ix) .&. 0xFF+ mx = (-x) * fromIntegral (fromEnum (ix /= 0))+ output = map getByte (nSigBytes `downTo` 0)++-- rightEncode :: Int -> ByteString+--}++encodeString :: ByteString -> ByteString+encodeString bytes+ | byteLen <= 0 = leftEncodeZero+ | otherwise = leftEncodeFromBytes byteLen <> bytes+ where+ byteLen = fromIntegral (B.length bytes) :: Word++encodedByteLength :: ByteString -> Int+encodedByteLength (B.length -> n) = lengthOfLeftEncode n + n++encodedVectorByteLength :: Foldable f => f ByteString -> Int+encodedVectorByteLength = foldl' (\a x -> a + encodedByteLength x) 0++{--+encodeBitString :: Word8 -> ByteString -> [ByteString]+encodeBitString truncBits bytes+ | byteLen <= 0 = [ "\x01\x00" ]+ | otherwise = [ leftEncodeBytesMinusBits byteLen truncBits+++ leftEncode bitL, take (byteLength - 1) bytes,+--}++bareEncodeZero :: ByteString+bareEncodeZero = "\x00"++bareEncodeInteger :: Integer -> Maybe ByteString+bareEncodeInteger n =+ case compare n 0 of+ LT -> Nothing+ EQ -> Just leftEncodeZero+ GT -> let nSigBytes = shiftR (integerLog2 n) 3 + 1+ in Just (B.pack (go (fromIntegral nSigBytes)))+ where+ go nSigBytes = fromIntegral nSigBytes : map getByte (downFrom nSigBytes)+ -- FIXME: using shiftR here results in a quadratic algorithm+ getByte ix = fromIntegral (shiftR n (8*ix) .&. 0xFF)++bareEncodeIntegerFromBytes :: Integer -> Maybe ByteString+bareEncodeIntegerFromBytes = fmap (B.drop 1) . leftEncodeIntegerFromBytes++bareEncode :: (Integral b, FiniteBits b) => b -> ByteString+bareEncode = B.drop 1 . leftEncode++bareEncodeFromBytes :: (Integral b, FiniteBits b) => b -> ByteString+bareEncodeFromBytes = B.drop 1 . leftEncodeFromBytes++lengthOfBareEncode :: (Integral b, FiniteBits b) => b -> Int+lengthOfBareEncode n+ | n <= 0 = 1+ | otherwise = nSigBytes+ where+ wordLen = finiteBitSize n+ zeros = countLeadingZeros n+ nSigBits = wordLen - zeros + 3+ nSigBytes = max 1 (shiftR (nSigBits + 7) 3)++lengthOfBareEncodeFromBytes :: (Integral b, FiniteBits b) => b -> Int+lengthOfBareEncodeFromBytes n+ | n <= 0 = 1+ | otherwise = nSigBytes+ where+ wordLen = finiteBitSize n+ zeros = countLeadingZeros n+ nSigBits = wordLen - zeros + 3+ nSigBytes = max 1 (shiftR (nSigBits + 7) 3)++lengthOfBareEncodeInteger :: Integer -> Maybe Int+lengthOfBareEncodeInteger n =+ case compare n 0 of+ LT -> Nothing+ EQ -> Just 1+ GT -> Just (shiftR (integerLog2 n) 3 + 1)++lengthOfBareEncodeIntegerFromBytes :: Integer -> Maybe Int+lengthOfBareEncodeIntegerFromBytes n =+ case compare n 0 of+ LT -> Nothing+ EQ -> Just 1+ GT -> Just (shiftR (integerLog2 n + 3) 3 + 1)++lengthOfLeftEncode :: (Integral b, FiniteBits b) => b -> Int+lengthOfLeftEncode = (+1) . lengthOfBareEncode++lengthOfLeftEncodeFromBytes :: (Integral b, FiniteBits b) => b -> Int+lengthOfLeftEncodeFromBytes = (+1) . lengthOfBareEncodeFromBytes++lengthOfLeftEncodeInteger :: Integer -> Maybe Int+lengthOfLeftEncodeInteger n =+ case lengthOfBareEncodeInteger n of+ Nothing -> Nothing+ Just nSigBytes+ | nSigBytes > 255 -> Nothing+ | otherwise -> Just (nSigBytes+1)++lengthOfLeftEncodeIntegerFromBytes :: Integer -> Maybe Int+lengthOfLeftEncodeIntegerFromBytes n =+ case lengthOfBareEncodeIntegerFromBytes n of+ Nothing -> Nothing+ Just nSigBytes+ | nSigBytes > 255 -> Nothing+ | otherwise -> Just (nSigBytes+1)
+ tuplehash-utils.cabal view
@@ -0,0 +1,32 @@+name: tuplehash-utils+version: 0.0.0.0+synopsis: Left Encode and friends from SHA-3's TupleHash+description:+ See NIST Special Publication 800-185: SHA-3 Derived Functions: cSHAKE, KMAC,+ TupleHash and ParallelHash.+ <https://www.nist.gov/publications/sha-3-derived-functions-cshake-kmac-tuplehash-and-parallelhash>+ Note that this does not implement TupleHash itself, though it could be used+ to implement TupleHash given an implementation of Keccak/SHA-3. This only+ implements the data-encoding portions of TupleHash, and does not directly+ implement any kind of cryptographic state machine.++license: Apache-2.0+license-file: LICENSE+author: Leon P Smith+maintainer: Auth Global+copyright: Auth Global+category: Cryptography+build-type: Simple+extra-source-files: ChangeLog.md+cabal-version: >=1.10++library+ exposed-modules: Crypto.Encoding.SHA3.TupleHash+ -- other-modules:+ -- other-extensions:+ ghc-options: -Wall+ build-depends: base < 5,+ bytestring,+ integer-logarithms+ hs-source-dirs: lib+ default-language: Haskell2010