diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/cpio-conduit.cabal b/cpio-conduit.cabal new file mode 100644 --- /dev/null +++ b/cpio-conduit.cabal @@ -0,0 +1,46 @@ +name: cpio-conduit +version: 0.7.0 +synopsis: Conduit-based CPIO +description: + This is a native Haskell implementation of the CPIO protocol over the Conduit library. See . + + Only the commonly used CPIO formats are supported (crc and newc). + +homepage: http://github.com/da-x/cpio-conduit +license: Apache-2.0 +license-file: LICENSE +author: Dan Aloni +maintainer: alonid@gmail.com +category: Data +build-type: Simple +cabal-version: >=1.10 + +library + hs-source-dirs: src + exposed-modules: + Data.CPIO + build-depends: base >=4.7 && <= 5 + , conduit + , conduit-extra + , bytestring + , base16-bytestring + , binary + default-language: Haskell2010 + +source-repository head + type: git + location: https://github.com/da-x/cpio-conduit.git + +test-suite cpio-test + default-language: Haskell2010 + hs-source-dirs: tests + type: exitcode-stdio-1.0 + main-is: Main.hs + build-depends: base >=4.7 && <= 5 + , conduit + , conduit-extra + , bytestring + , base16-bytestring + , binary + , cpio-conduit + , resourcet diff --git a/src/Data/CPIO.hs b/src/Data/CPIO.hs new file mode 100644 --- /dev/null +++ b/src/Data/CPIO.hs @@ -0,0 +1,167 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE NoMonomorphismRestriction #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE Rank2Types #-} + +-- +-- This is the main interface. APIs should be quite self-explainatory. +-- + +module Data.CPIO + ( readCPIO + , writeCPIO + , Entry(..) + , FormatError(..) + , isEntryDirectory + ) where + +import Control.Applicative ((<$>)) +import qualified Control.Exception as E +import Control.Monad (forM_, when) +import Data.Binary.Get (getWord32be, runGet) +import Data.Binary.Put (putWord32be, runPut) +import Data.Bits ((.&.)) +import Data.ByteString (ByteString) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Base16 as B16 +import qualified Data.ByteString.Lazy as BL +import Data.Conduit +import qualified Data.Conduit.Binary as CB +import Data.Int (Int64) +import Data.Typeable (Typeable) +import Data.Word (Word32) + +data Entry = Entry + { cpioInode :: !Word32 + , cpioMode :: !Word32 + , cpioUid :: !Word32 + , cpioGid :: !Word32 + , cpioNLink :: !Word32 + , cpioMTime :: !Word32 + , cpioFileSize :: !Word32 + , cpioDevMaj :: !Word32 + , cpioDevMin :: !Word32 + , cpioRDevMaj :: !Word32 + , cpioRDevMin :: !Word32 + , cpioCRC32 :: Maybe Word32 + , cpioFileName :: ByteString + , cpioFileData :: BL.ByteString + } deriving (Show, Read, Eq) + +data FormatError + = TruncatedArchive + | InvalidMagic ByteString + | InvalidHex ByteString + deriving (Typeable) + +instance E.Exception FormatError + +isEntryDirectory :: Entry -> Bool +isEntryDirectory entry = (cpioMode entry) .&. 0o040000 /= 0 + +instance Show FormatError where + show TruncatedArchive = "truncated cpio archive" + show (InvalidMagic s) = "invalid magic: " ++ (show s) + show (InvalidHex s) = "invalid hex: " ++ (show s) + +takeExactlyLazy :: Monad m => Int64 -> Consumer ByteString m BL.ByteString +takeExactlyLazy len = do + x <- CB.take $ fromIntegral len + if BL.length x == len + then return x + else E.throw TruncatedArchive + +takeExactly :: Monad m => Int64 -> Consumer ByteString m ByteString +takeExactly len = fmap (BS.concat . BL.toChunks) $ takeExactlyLazy len + +trailerText :: ByteString +trailerText = "TRAILER!!!" + +alignTo4 :: Integral a => a -> a +alignTo4 0 = 0 +alignTo4 n = 3 - ((n - 1) `mod` 4) + +readCPIO :: Monad m => Conduit ByteString m Entry +readCPIO = do + magic <- fmap (BS.concat . BL.toChunks) $ CB.take 6 + has_crc <- + case magic of + "070701" -> return False + "070702" -> return True + _ -> E.throw (InvalidMagic magic) + inode <- decodeR32 + mode <- decodeR32 + uid <- decodeR32 + gid <- decodeR32 + nlink <- decodeR32 + mtime <- decodeR32 + filesize <- decodeR32 + devmaj <- decodeR32 + devmin <- decodeR32 + rdevmaj <- decodeR32 + rdevmin <- decodeR32 + filenamesize <- decodeR32 + crc32 <- decodeR32 + let filenamesize_ = fromInteger $ toInteger filenamesize + filename <- (BS.takeWhile (/= 0)) <$> takeExactly + filenamesize_ + _ <- takeExactly $ alignTo4 $ 110 + filenamesize_ + let filesize_ = (fromInteger $ toInteger filesize) + filedata <- takeExactlyLazy filesize_ + let entry = + Entry inode mode uid gid nlink mtime filesize devmaj + devmin rdevmaj rdevmin + (if has_crc then Nothing else Just crc32) filename filedata + when (filename /= trailerText) $ do + yield entry + _ <- takeExactly $ alignTo4 filesize_ + readCPIO + + where + decodeR32 = do + v <- takeExactly 8 + case B16.decode v of + (decoded, "") -> + return $ runGet getWord32be $ BL.fromChunks [ decoded ] + (_, _) -> + E.throw (InvalidHex v) + +writeCPIO :: Monad m => Conduit Entry m ByteString +writeCPIO = do + entry_ <- await + case entry_ of + Nothing -> + write_entry $ Entry 0 0 0 0 0 0 0 0 0 0 0 (Just 0) trailerText "" + Just entry -> do + write_entry entry + writeCPIO + where + encodeR32 x = yield $ B16.encode $ BS.concat $ BL.toChunks $ runPut (putWord32be x) + write_entry entry = do + case cpioCRC32 entry of + Nothing -> yield "070701" + Just _ -> yield "070702" + encodeR32 $ cpioInode entry + encodeR32 $ cpioMode entry + encodeR32 $ cpioUid entry + encodeR32 $ cpioGid entry + encodeR32 $ cpioNLink entry + encodeR32 $ cpioMTime entry + let file_size = cpioFileSize entry + encodeR32 $ file_size + encodeR32 $ cpioDevMaj entry + encodeR32 $ cpioDevMin entry + encodeR32 $ cpioRDevMaj entry + encodeR32 $ cpioRDevMin entry + let filename_length = + 1 + (fromInteger $ toInteger $ BS.length $ cpioFileName entry) + encodeR32 $ (filename_length :: Word32) + case cpioCRC32 entry of + Nothing -> encodeR32 0 + Just x -> encodeR32 x + yield $ cpioFileName entry + yield $ "\NUL" + yield $ BS.replicate (alignTo4 $ 110 + filename_length) 0 + forM_ (BL.toChunks $ cpioFileData entry) yield + yield $ BS.replicate (alignTo4 (fromInteger $ toInteger file_size)) 0 diff --git a/tests/Main.hs b/tests/Main.hs new file mode 100644 --- /dev/null +++ b/tests/Main.hs @@ -0,0 +1,40 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE DeriveDataTypeable #-} + +import Control.Monad (when) +import Control.Monad.Trans.Resource (runResourceT) +import Data.Typeable (Typeable) +import qualified Data.ByteString as BS +import Data.Conduit +import qualified Data.Conduit.Binary as CB +import qualified Data.Conduit.List as CL +import Data.CPIO +import qualified Control.Exception as E + +fileCpio :: [Entry] +fileCpio = [Entry {cpioInode = 19005793, cpioMode = 16893, cpioUid = 1000, cpioGid = 1000, cpioNLink = 3, cpioMTime = 1438703216, cpioFileSize = 0, cpioDevMaj = 8, cpioDevMin = 8, cpioRDevMaj = 0, cpioRDevMin = 0, cpioCRC32 = Nothing, cpioFileName = "1", cpioFileData = ""},Entry {cpioInode = 19005794, cpioMode = 33204, cpioUid = 1000, cpioGid = 1000, cpioNLink = 1, cpioMTime = 1438703214, cpioFileSize = 7, cpioDevMaj = 8, cpioDevMin = 8, cpioRDevMaj = 0, cpioRDevMin = 0, cpioCRC32 = Nothing, cpioFileName = "1/README.txt", cpioFileData = "Hello\n\n"},Entry {cpioInode = 19005795, cpioMode = 16893, cpioUid = 1000, cpioGid = 1000, cpioNLink = 2, cpioMTime = 1438703220, cpioFileSize = 0, cpioDevMaj = 8, cpioDevMin = 8, cpioRDevMaj = 0, cpioRDevMin = 0, cpioCRC32 = Nothing, cpioFileName = "1/subdir", cpioFileData = ""},Entry {cpioInode = 19005796, cpioMode = 33204, cpioUid = 1000, cpioGid = 1000, cpioNLink = 1, cpioMTime = 1438703220, cpioFileSize = 0, cpioDevMaj = 8, cpioDevMin = 8, cpioRDevMaj = 0, cpioRDevMin = 0, cpioCRC32 = Nothing, cpioFileName = "1/subdir/somefile.txt", cpioFileData = ""}] + +encoded = "07070101220161000041fd000003e8000003e80000000355c0de70000000000000000800000008000000000000000000000002000000001\NUL07070101220162000081b4000003e8000003e80000000155c0de6e00000007000000080000000800000000000000000000000d000000001/README.txt\NUL\NULHello\n\n\NUL07070101220163000041fd000003e8000003e80000000255c0de74000000000000000800000008000000000000000000000009000000001/subdir\NUL\NUL07070101220164000081b4000003e8000003e80000000155c0de74000000000000000800000008000000000000000000000016000000001/subdir/somefile.txt\NUL07070200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000b00000000TRAILER!!!\NUL\NUL\NUL\NUL" + +instance E.Exception TestError + +data TestError + = Msg String + deriving (Typeable) + +instance Show TestError where + show (Msg s) = "test error: " ++ s + +err :: String -> a +err s = E.throw $ Msg s + +main :: IO () +main = do + let filename = "tests/file.cpio" + lst <- runResourceT $ CB.sourceFile filename $$ readCPIO =$ CL.consume + when (lst /= fileCpio) $ do + err $ "Invalid output: " ++ (show lst) + new <- fmap BS.concat $ CL.sourceList lst $$ writeCPIO =$ CL.consume + when (new /= encoded) $ do + putStrLn $ "new: " ++ (show new) + err $ "Invalid content generated"