@@ -11,6 +11,7 @@ module Network.Wai.Parse
1111 , RequestBodyType (..)
1212 , getRequestBodyType
1313 , sinkRequestBody
14+ , sinkRequestBodyEx
1415 , BackEnd
1516 , lbsBackEnd
1617 , tempFileBackEnd
@@ -19,8 +20,23 @@ module Network.Wai.Parse
1920 , File
2021 , FileInfo (..)
2122 , parseContentType
22− , ParseRequestBodyOptions (..)
23+ , ParseRequestBodyOptions
24+ , defaultParseRequestBodyOptions
2325 , parseRequestBodyEx
26+ , setMaxRequestKeyLength
27+ , clearMaxRequestKeyLength
28+ , setMaxRequestNumFiles
29+ , clearMaxRequestNumFiles
30+ , setMaxRequestFileSize
31+ , clearMaxRequestFileSize
32+ , setMaxRequestFilesSize
33+ , clearMaxRequestFilesSize
34+ , setMaxRequestParmsSize
35+ , clearMaxRequestParmsSize
36+ , setMaxHeaderLines
37+ , clearMaxHeaderLines
38+ , setMaxHeaderLineLength
39+ , clearMaxHeaderLineLength
2440#if TEST
2541 , Bound (..)
2642 , findBound
@@ -35,7 +51,6 @@ import qualified Data.ByteString.Search as Search
3551import qualified Data.ByteString as S
3652import qualified Data.ByteString.Lazy as L
3753import qualified Data.ByteString.Char8 as S8
38−import Data.Default (Default, def)
3954import Data.Word (Word8)
4055import Data.Int (Int64)
4156import Data.Maybe (catMaybes, fromMaybe)
@@ -52,6 +67,8 @@ import Data.IORef
5267import Network.HTTP.Types (hContentType)
5368import Data.CaseInsensitive (mk)
5469
70+import Prelude hiding (lines)
71+
5572breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
5673breakDiscard w s =
5774 let (x, y) = S.break (== w) s
@@ -127,26 +144,103 @@ tempFileBackEndOpts getTmpDir pattrn internalState _ _ popper = do
127144-- the parseRequestBodyEx function.
128145data ParseRequestBodyOptions = ParseRequestBodyOptions
129146 { -- | The maximum length of a filename
130− prboKeyLength :: Int
147+ prboKeyLength :: Maybe Int
131148 , -- | The maximum number of files.
132− prboMaxNumFiles :: Int
149+ prboMaxNumFiles :: Maybe Int
133150 , -- | The maximum filesize per file.
134151 prboMaxFileSize :: Maybe Int64
135152 , -- | The maximum total filesize.
136153 prboMaxFilesSize :: Maybe Int64
137− , -- | The maximum size of the sum of all parameters values
138− prboMaxParmsValueSize :: Int
139− , -- | The maximum header lines per entry
140− prboMaxHeaderLines :: Int }
141−
142−instance Default ParseRequestBodyOptions where
143− def = ParseRequestBodyOptions
144− { prboKeyLength=32
145− , prboMaxNumFiles=10
146− , prboMaxFileSize=Nothing
147− , prboMaxFilesSize=Nothing
148− , prboMaxParmsValueSize=65336
149− , prboMaxHeaderLines=32 }
154+ , -- | The maximum size of the sum of all parameters
155+ prboMaxParmsSize :: Maybe Int
156+ , -- | The maximum header lines per mime/multipart entry
157+ prboMaxHeaderLines :: Maybe Int
158+ , -- | The maximum header line length per mime/multipart entry
159+ prboMaxHeaderLineLength :: Maybe Int }
160+
161+-- | Set the maximum length of a filename.
162+setMaxRequestKeyLength :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
163+setMaxRequestKeyLength l p = p { prboKeyLength=Just l }
164+
165+-- | Do not limit the length of filenames.
166+clearMaxRequestKeyLength :: ParseRequestBodyOptions -> ParseRequestBodyOptions
167+clearMaxRequestKeyLength p = p { prboKeyLength=Nothing }
168+
169+-- | Set the maximum number of files per request.
170+setMaxRequestNumFiles :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
171+setMaxRequestNumFiles l p = p { prboMaxNumFiles=Just l }
172+
173+-- | Do not limit the maximum number of files per request.
174+clearMaxRequestNumFiles :: ParseRequestBodyOptions -> ParseRequestBodyOptions
175+clearMaxRequestNumFiles p = p { prboMaxNumFiles=Nothing }
176+
177+-- | Set the maximum filesize per file.
178+setMaxRequestFileSize :: Int64 -> ParseRequestBodyOptions -> ParseRequestBodyOptions
179+setMaxRequestFileSize l p = p { prboMaxFileSize=Just l }
180+
181+-- | Do not limit the maximum filesize per file.
182+clearMaxRequestFileSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
183+clearMaxRequestFileSize p = p { prboMaxFileSize=Nothing }
184+
185+-- | Set the maximum size of all files per request.
186+setMaxRequestFilesSize :: Int64 -> ParseRequestBodyOptions -> ParseRequestBodyOptions
187+setMaxRequestFilesSize l p = p { prboMaxFilesSize=Just l }
188+
189+-- | Do not limit the maximum size of all files per request.
190+clearMaxRequestFilesSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
191+clearMaxRequestFilesSize p = p { prboMaxFilesSize=Nothing }
192+
193+-- | Set the maximum size of the sum of all parameters.
194+setMaxRequestParmsSize :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
195+setMaxRequestParmsSize l p = p { prboMaxParmsSize=Just l }
196+
197+-- | Do not limit the maximum size of the sum of all parameters.
198+clearMaxRequestParmsSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
199+clearMaxRequestParmsSize p = p { prboMaxParmsSize=Nothing }
200+
201+-- | Set the maximum header lines per mime/multipart entry.
202+setMaxHeaderLines :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
203+setMaxHeaderLines l p = p { prboMaxHeaderLines=Just l }
204+
205+-- | Do not limit the maximum header lines per mime/multipart entry.
206+clearMaxHeaderLines:: ParseRequestBodyOptions -> ParseRequestBodyOptions
207+clearMaxHeaderLines p = p { prboMaxHeaderLines=Nothing }
208+
209+-- | Set the maximum header line length per mime/multipart entry.
210+setMaxHeaderLineLength :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
211+setMaxHeaderLineLength l p = p { prboMaxHeaderLineLength=Just l }
212+
213+-- | Do not limit the maximum header lines per mime/multipart entry.
214+clearMaxHeaderLineLength :: ParseRequestBodyOptions -> ParseRequestBodyOptions
215+clearMaxHeaderLineLength p = p { prboMaxHeaderLineLength=Nothing }
216+
217+-- | A reasonable default set of parsing options.
218+-- Maximum key/filename length: 32 bytes;
219+-- maximum files: 10; filesize unlimited; maximum
220+-- size for parameters: 64kbytes; maximum number of header
221+-- lines: 32 bytes (applies only to headers of a mime/multipart message);
222+-- maximum header line length: 8190 bytes (applies only to headers of
223+-- a mime/multipart message)
224+defaultParseRequestBodyOptions :: ParseRequestBodyOptions
225+defaultParseRequestBodyOptions = ParseRequestBodyOptions
226+ { prboKeyLength=Just 32
227+ , prboMaxNumFiles=Just 10
228+ , prboMaxFileSize=Nothing
229+ , prboMaxFilesSize=Nothing
230+ , prboMaxParmsSize=Just 65336
231+ , prboMaxHeaderLines=Just 32
232+ , prboMaxHeaderLineLength=Just 8190 }
233+
234+-- | Do not impose any memory limits.
235+noLimitParseRequestBodyOptions :: ParseRequestBodyOptions
236+noLimitParseRequestBodyOptions = ParseRequestBodyOptions
237+ { prboKeyLength=Nothing
238+ , prboMaxNumFiles=Nothing
239+ , prboMaxFileSize=Nothing
240+ , prboMaxFilesSize=Nothing
241+ , prboMaxParmsSize=Nothing
242+ , prboMaxHeaderLines=Nothing
243+ , prboMaxHeaderLineLength=Nothing }
150244
151245-- | Information on an uploaded file.
152246data FileInfo c = FileInfo
@@ -221,10 +315,7 @@ parseContentType a = do
221315parseRequestBody :: BackEnd y
222316 -> Request
223317 -> IO ([Param], [File y])
224−parseRequestBody s r =
225− case getRequestBodyType r of
226− Nothing -> return ([], [])
227− Just rbt -> sinkRequestBody s rbt (requestBody r)
318+parseRequestBody = parseRequestBodyEx noLimitParseRequestBodyOptions
228319
229320-- | Parse the body of an HTTP request, limit resource usage.
230321-- The HTTP body can contain both parameters and files.
@@ -245,15 +336,7 @@ sinkRequestBody :: BackEnd y
245336 -> RequestBodyType
246337 -> IO S.ByteString
247338 -> IO ([Param], [File y])
248−sinkRequestBody s r body = do
249− ref <- newIORef (id, id)
250− let add x = atomicModifyIORef ref $ \(y, z) ->
251− case x of
252− Left y' -> ((y . (y':), z), ())
253− Right z' -> ((y, z . (z':)), ())
254− conduitRequestBody s r body add
255− (x, y) <- readIORef ref
256− return (x [], y [])
339+sinkRequestBody = sinkRequestBodyEx noLimitParseRequestBodyOptions
257340
258341sinkRequestBodyEx :: ParseRequestBodyOptions
259342 -> BackEnd y
@@ -267,26 +350,7 @@ sinkRequestBodyEx o s r body = do
267350 Left y' -> ((y':y, z), ())
268351 Right z' -> ((y, z':z), ())
269352 conduitRequestBodyEx o s r body add
270− readIORef ref
271−
272−conduitRequestBody :: BackEnd y
273− -> RequestBodyType
274− -> IO S.ByteString
275− -> (Either Param (File y) -> IO ())
276− -> IO ()
277−conduitRequestBody _ UrlEncoded rbody add = do
278− -- NOTE: in general, url-encoded data will be in a single chunk.
279− -- Therefore, I'm optimizing for the usual case by sticking with
280− -- strict byte strings here.
281− let loop front = do
282− bs <- rbody
283− if S.null bs
284− then return $ S.concat $ front []
285− else loop $ front . (bs:)
286− bs <- loop id
287− mapM_ (add . Left) $ H.parseSimpleQuery bs
288−conduitRequestBody backend (Multipart bound) rbody add =
289− parsePieces backend (S8.pack "--" `S.append` bound) rbody add
353+ (\(a, b) -> (reverse a, reverse b)) <$> readIORef ref
290354
291355conduitRequestBodyEx :: ParseRequestBodyOptions
292356 -> BackEnd y
@@ -298,18 +362,18 @@ conduitRequestBodyEx o _ UrlEncoded rbody add = do
298362 -- NOTE: in general, url-encoded data will be in a single chunk.
299363 -- Therefore, I'm optimizing for the usual case by sticking with
300364 -- strict byte strings here.
301− size <- newIORef 0
302− let loop front = do
365+ let loop size front = do
303366 bs <- rbody
304367 if S.null bs
305368 then return $ S.concat $ front []
306369 else do
307− newsize <- atomicModifyIORef size $
308− \cursize -> let newsize = cursize + S.length bs in (newsize, newsize)
309− when (newsize > prboMaxParmsValueSize o) $
310− error "Maximum size of parameters exceeded"
311− loop $ front . (bs:)
312− bs <- loop id
370+ let newsize = size + S.length bs
371+ case prboMaxParmsSize o of
372+ Just maxSize -> when (newsize > maxSize) $
373+ error "Maximum size of parameters exceeded"
374+ Nothing -> return ()
375+ loop newsize $ front . (bs:)
376+ bs <- loop 0 id
313377 mapM_ (add . Left) $ H.parseSimpleQuery bs
314378conduitRequestBodyEx o backend (Multipart bound) rbody add =
315379 parsePiecesEx o backend (S8.pack "--" `S.append` bound) rbody add
@@ -319,13 +383,16 @@ conduitRequestBodyEx o backend (Multipart bound) rbody add =
319383-- It makes sense to limit the maximum line length.
320384-- Apache's default is 8190 (http://httpd.apache.org/docs/2.2/mod/core.html#limitrequestline)
321385-- so we're using that here as well.
322−takeLine :: Source -> IO (Maybe S.ByteString)
323−takeLine src =
386+takeLine :: Maybe Int -> Source -> IO (Maybe S.ByteString)
387+takeLine maxlen src =
324388 go ""
325389 where
326390 go front = do
327391 bs <- readSource src
328− when (S.length front + S.length bs > 8190) $ error "Header line length exceeds allowed maximum."
392+ case maxlen of
393+ Just maxlen' -> when (S.length front + S.length bs > maxlen') $
394+ error "Header line length exceeds allowed maximum."
395+ Nothing -> return ()
329396 if S.null bs
330397 then close front
331398 else push front bs
@@ -339,30 +406,28 @@ takeLine src =
339406 when (S.length y > 1) $ leftover src $ S.drop 1 y
340407 return $ Just $ killCR $ front `S.append` x
341408
342−takeLines :: Source -> IO [S.ByteString]
343−takeLines src = do
344− res <- takeLine src
409+takeLines' :: Maybe Int -> Maybe Int -> Source -> IO [S.ByteString]
410+takeLines' lineLength maxLines source =
411+ reverse <$> takeLines'' [] lineLength maxLines source
412+
413+takeLines''
414+ :: [S.ByteString]
415+ -> Maybe Int
416+ -> Maybe Int
417+ -> Source
418+ -> IO [S.ByteString]
419+takeLines'' lines lineLength maxLines src = do
420+ case maxLines of
421+ Just maxLines' ->
422+ when (length lines > maxLines') $
423+ error "Too many lines in mime/multipart header"
424+ Nothing -> return ()
425+ res <- takeLine lineLength src
345426 case res of
346− Nothing -> return []
427+ Nothing -> return lines
347428 Just l
348− | S.null l -> return []
349− | otherwise -> do
350− ls <- takeLines src
351− return $ l : ls
352−
353−takeLines' :: Int -> Source -> IO [S.ByteString]
354−takeLines' a b = reverse <$> takeLines'' [] a b
355−
356−takeLines'' :: [S.ByteString] -> Int -> Source -> IO [S.ByteString]
357−takeLines'' lines maxLines src
358− | length lines > maxLines = error "Too many lines in mime/multipart header"
359− | otherwise = do
360− res <- takeLine src
361− case res of
362− Nothing -> return lines
363− Just l
364− | S.null l -> return lines
365− | otherwise -> takeLines'' (l:lines) maxLines src
429+ | S.null l -> return lines
430+ | otherwise -> takeLines'' (l:lines) lineLength maxLines src
366431
367432data Source = Source (IO S.ByteString) (IORef S.ByteString)
368433
@@ -381,53 +446,6 @@ readSource (Source f ref) = do
381446leftover :: Source -> S.ByteString -> IO ()
382447leftover (Source _ ref) bs = writeIORef ref bs
383448
384−parsePieces :: BackEnd y
385− -> S.ByteString
386− -> IO S.ByteString
387− -> (Either Param (File y) -> IO ())
388− -> IO ()
389−parsePieces sink bound rbody add =
390− mkSource rbody >>= loop
391− where
392− loop src = do
393− _boundLine <- takeLine src
394− res' <- takeLines src
395− unless (null res') $ do
396− let ls' = map parsePair res'
397− let x = do
398− cd <- lookup contDisp ls'
399− let ct = lookup contType ls'
400− let attrs = parseAttrs cd
401− name <- lookup "name" attrs
402− return (ct, name, lookup "filename" attrs)
403− case x of
404− Just (mct, name, Just filename) -> do
405− let ct = fromMaybe "application/octet-stream" mct
406− fi0 = FileInfo filename ct ()
407− ((wasFound, _fileSize), y) <- sinkTillBound' bound name fi0 sink src Nothing
408− add $ Right (name, fi0 { fileContent = y })
409− when wasFound (loop src)
410− Just (_ct, name, Nothing) -> do
411− let seed = id
412− let iter front bs = return $ front . (:) bs
413− ((wasFound, _fileSize), front) <- sinkTillBound bound iter seed src Nothing
414− let bs = S.concat $ front []
415− let x' = (name, bs)
416− add $ Left x'
417− when wasFound (loop src)
418− _ -> do
419− -- ignore this part
420− let seed = ()
421− iter () _ = return ()
422− ((wasFound, _fileSize), ()) <- sinkTillBound bound iter seed src Nothing
423− when wasFound (loop src)
424− where
425− contDisp = mk $ S8.pack "Content-Disposition"
426− contType = mk $ S8.pack "Content-Type"
427− parsePair s =
428− let (x, y) = breakDiscard 58 s -- colon
429− in (mk $ x, S.dropWhile (== 32) y) -- space
430−
431449parsePiecesEx :: ParseRequestBodyOptions
432450 -> BackEnd y
433451 -> S.ByteString
@@ -439,8 +457,9 @@ parsePiecesEx o sink bound rbody add =
439457 where
440458 loop :: Int -> Int -> Int -> Int64 -> Source -> IO ()
441459 loop numParms numFiles parmSize filesSize src = do
442− _boundLine <- takeLine src
443− res' <- takeLines' (prboMaxHeaderLines o) src
460+ _boundLine <- takeLine (prboMaxHeaderLineLength o) src
461+ res' <- takeLines' (prboMaxHeaderLineLength o)
462+ (prboMaxHeaderLines o) src
444463 unless (null res') $ do
445464 let ls' = map parsePair res'
446465 let x = do
@@ -451,10 +470,15 @@ parsePiecesEx o sink bound rbody add =
451470 return (ct, name, lookup "filename" attrs)
452471 case x of
453472 Just (mct, name, Just filename) -> do
454− when (S.length name > prboKeyLength o) $
455− error "Filename is too long"
456− when (numFiles >= prboMaxNumFiles o) $
457− error "Maximum number of files exceeded"
473+ case prboKeyLength o of
474+ Just maxKeyLength ->
475+ when (S.length name > maxKeyLength) $
476+ error "Filename is too long"
477+ Nothing -> return ()
478+ case prboMaxNumFiles o of
479+ Just maxFiles -> when (numFiles >= maxFiles) $
480+ error "Maximum number of files exceeded"
481+ Nothing -> return ()
458482 let ct = fromMaybe "application/octet-stream" mct
459483 fi0 = FileInfo filename ct ()
460484 fs = catMaybes [ prboMaxFileSize o
@@ -465,17 +489,22 @@ parsePiecesEx o sink bound rbody add =
465489 add $ Right (name, fi0 { fileContent = y })
466490 when wasFound $ loop numParms (numFiles + 1) parmSize newFilesSize src
467491 Just (_ct, name, Nothing) -> do
468− when (S.length name > prboKeyLength o) $
469− error "Parameter name is too long"
492+ case prboKeyLength o of
493+ Just maxKeyLength ->
494+ when (S.length name > maxKeyLength) $
495+ error "Parameter name is too long"
496+ Nothing -> return ()
470497 let seed = id
471498 let iter front bs = return $ front . (:) bs
472− ((wasFound, _fileSize), front) <- sinkTillBound bound iter seed src $
473− Just . fromIntegral . prboMaxParmsValueSize $ o
499+ ((wasFound, _fileSize), front) <- sinkTillBound bound iter seed src
500+ (fromIntegral <$> prboMaxParmsSize o)
474501 let bs = S.concat $ front []
475502 let x' = (name, bs)
476503 let newParmSize = parmSize + S.length name + S.length bs
477− when (newParmSize > prboMaxParmsValueSize o) $
478− error "Maximum size of parameters exceeded"
504+ case prboMaxParmsSize o of
505+ Just maxParmSize -> when (newParmSize > maxParmSize) $
506+ error "Maximum size of parameters exceeded"
507+ Nothing -> return ()
479508 add $ Left x'
480509 when wasFound $ loop (numParms + 1) numFiles
481510 newParmSize filesSize src
@@ -528,8 +557,8 @@ sinkTillBound' :: S.ByteString
528557 -> Source
529558 -> Maybe Int64
530559 -> IO ((Bool, Int64), y)
531−sinkTillBound' bound name fi sink src max = do
532− (next, final) <- wrapTillBound bound src max
560+sinkTillBound' bound name fi sink src max' = do
561+ (next, final) <- wrapTillBound bound src max'
533562 y <- sink name fi next
534563 b <- final
535564 return (b, y)
@@ -540,7 +569,7 @@ wrapTillBound :: S.ByteString -- ^ bound
540569 -> Source
541570 -> Maybe Int64
542571 -> IO (IO S.ByteString, IO (Bool, Int64)) -- ^ Bool indicates if the bound was found
543−wrapTillBound bound src max = do
572+wrapTillBound bound src max' = do
544573 ref <- newIORef $ WTBWorking id
545574 sref <- newIORef (0 :: Int64)
546575 return (go ref sref, final ref sref)
@@ -561,8 +590,8 @@ wrapTillBound bound src max = do
561590 bs <- readSource src
562591 cur <- atomicModifyIORef sref $ \ cur ->
563592 let new = cur + fromIntegral (S.length bs) in (new, new)
564− case max of
565− Just max' | cur > max' -> error "Maximum size exceeded"
593+ case max' of
594+ Just max'' | cur > max'' -> error "Maximum size exceeded"
566595 _ -> return ()
567596 if S.null bs
568597 then do
@@ -598,8 +627,8 @@ sinkTillBound :: S.ByteString
598627 -> Source
599628 -> Maybe Int64
600629 -> IO ((Bool, Int64), x)
601−sinkTillBound bound iter seed0 src max = do
602− (next, final) <- wrapTillBound bound src max
630+sinkTillBound bound iter seed0 src max' = do
631+ (next, final) <- wrapTillBound bound src max'
603632 let loop seed = do
604633 bs <- next
605634 if S.null bs