tls-session-manager-0.0.2.1/0000755000000000000000000000000013505323363013734 5ustar0000000000000000tls-session-manager-0.0.2.1/Setup.hs0000644000000000000000000000005613505323363015371 0ustar0000000000000000import Distribution.Simple main = defaultMain tls-session-manager-0.0.2.1/LICENSE0000644000000000000000000000276513505323363014753 0ustar0000000000000000Copyright (c) 2017, IIJ Innovation Institute Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. tls-session-manager-0.0.2.1/ChangeLog.md0000644000000000000000000000032013505323363016100 0ustar0000000000000000# 0.1.0.0 - Using ShortByteString internally to avoid ByteString's fragmentation. - The default value of dbMaxSize is now 1,000. # 0.0.1.0 - Supporting sessionResumeOnlyOnce. # 0.0.0.0 - A first release. tls-session-manager-0.0.2.1/tls-session-manager.cabal0000644000000000000000000000171013505323363020612 0ustar0000000000000000name: tls-session-manager version: 0.0.2.1 synopsis: In-memory TLS session manager description: TLS session manager with limitation, automatic pruning, energy saving and replay resistance license: BSD3 license-file: LICENSE author: Kazu Yamamoto maintainer: kazu@iij.ad.jp -- copyright: category: Web build-type: Simple extra-source-files: ChangeLog.md cabal-version: >= 1.10 library exposed-modules: Network.TLS.SessionManager other-modules: Network.TLS.Imports -- other-extensions: build-depends: base >= 4.7 && < 5 , auto-update , basement , bytestring , clock , memory , psqueues >= 0.2.3 , tls -- hs-source-dirs: default-language: Haskell2010 ghc-options: -Wall tls-session-manager-0.0.2.1/Network/0000755000000000000000000000000013505323363015365 5ustar0000000000000000tls-session-manager-0.0.2.1/Network/TLS/0000755000000000000000000000000013505323363016027 5ustar0000000000000000tls-session-manager-0.0.2.1/Network/TLS/SessionManager.hs0000644000000000000000000001363413505323363021310 0ustar0000000000000000{-# LANGUAGE BangPatterns #-} {-# LANGUAGE CPP #-} -- | In-memory TLS session manager. -- -- * Limitation: you can set the maximum size of the session data database. -- * Automatic pruning: old session data over their lifetime are pruned automatically. -- * Energy saving: no dedicate pruning thread is running when the size of session data database is zero. -- * (Replay resistance: each session data is used at most once to prevent replay attacks against 0RTT early data of TLS 1.3.) module Network.TLS.SessionManager ( Config(..) , defaultConfig , newSessionManager ) where import Basement.Block (Block) import Data.ByteArray (convert) import Control.Exception (assert) import Control.Reaper import Data.ByteString (ByteString) import Data.IORef import Data.OrdPSQ (OrdPSQ) import qualified Data.OrdPSQ as Q import Network.TLS #if !MIN_VERSION_tls(1,5,0) import Network.TLS.Compression #endif import qualified System.Clock as C import Network.TLS.Imports ---------------------------------------------------------------- -- | Configuration for session managers. data Config = Config { -- | Ticket lifetime in seconds. ticketLifetime :: !Int -- | Pruning delay in seconds. This is set to 'reaperDelay'. , pruningDelay :: !Int -- | The limit size of session data entries. , dbMaxSize :: !Int } -- | Lifetime: 1 day , delay: 10 minutes, max size: 1000 entries. defaultConfig :: Config defaultConfig = Config { ticketLifetime = 86400 , pruningDelay = 6000 , dbMaxSize = 1000 } ---------------------------------------------------------------- toKey :: ByteString -> Block Word8 toKey = convert toValue :: SessionData -> SessionDataCopy #if MIN_VERSION_tls(1,5,0) toValue (SessionData v cid comp msni sec mg mti malpn siz) = SessionDataCopy v cid comp msni sec' mg mti malpn' siz where !sec' = convert sec !malpn' = convert <$> malpn #else toValue (SessionData v cid comp msni sec) = SessionDataCopy v cid comp msni sec' where !sec' = convert sec #endif fromValue :: SessionDataCopy -> SessionData #if MIN_VERSION_tls(1,5,0) fromValue (SessionDataCopy v cid comp msni sec' mg mti malpn' siz) = (SessionData v cid comp msni sec mg mti malpn siz) where !sec = convert sec' !malpn = convert <$> malpn' #else fromValue (SessionDataCopy v cid comp msni sec') = (SessionData v cid comp msni sec) where !sec = convert sec' #endif ---------------------------------------------------------------- type SessionIDCopy = Block Word8 data SessionDataCopy = SessionDataCopy { ssVersion :: !Version , ssCipher :: !CipherID , ssCompression :: !CompressionID , ssClientSNI :: !(Maybe HostName) , ssSecret :: Block Word8 #if MIN_VERSION_tls(1,5,0) , ssGroup :: !(Maybe Group) , ssTicketInfo :: !(Maybe TLS13TicketInfo) , ssALPN :: !(Maybe (Block Word8)) , ssMaxEarlyDataSize :: Int #endif } deriving (Show,Eq) type Sec = Int64 type Value = (SessionDataCopy, IORef Availability) type DB = OrdPSQ SessionIDCopy Sec Value type Item = (SessionIDCopy, Sec, Value, Operation) data Operation = Add | Del data Use = SingleUse | MultipleUse data Availability = Fresh | Used ---------------------------------------------------------------- -- | Creating an in-memory session manager. newSessionManager :: Config -> IO SessionManager newSessionManager conf = do let lifetime = fromIntegral $ ticketLifetime conf maxsiz = dbMaxSize conf reaper <- mkReaper defaultReaperSettings { reaperEmpty = Q.empty , reaperCons = cons maxsiz , reaperAction = clean , reaperNull = Q.null , reaperDelay = pruningDelay conf * 1000000 } return SessionManager { sessionResume = resume reaper MultipleUse #if MIN_VERSION_tls(1,5,0) , sessionResumeOnlyOnce = resume reaper SingleUse #endif , sessionEstablish = establish reaper lifetime , sessionInvalidate = invalidate reaper } cons :: Int -> Item -> DB -> DB cons lim (k,t,v,Add) db | lim <= 0 = Q.empty | Q.size db == lim = case Q.minView db of Nothing -> assert False $ Q.insert k t v Q.empty Just (_,_,_,db') -> Q.insert k t v db' | otherwise = Q.insert k t v db cons _ (k,_,_,Del) db = Q.delete k db clean :: DB -> IO (DB -> DB) clean olddb = do currentTime <- C.sec <$> C.getTime C.Monotonic let !pruned = snd $ Q.atMostView currentTime olddb return $ merge pruned where ins db (k,p,v) = Q.insert k p v db -- There is not 'merge' API. -- We hope that newdb is smaller than pruned. merge pruned newdb = foldl' ins pruned entries where entries = Q.toList newdb ---------------------------------------------------------------- establish :: Reaper DB Item -> Sec -> SessionID -> SessionData -> IO () establish reaper lifetime k sd = do ref <- newIORef Fresh !p <- ((+ lifetime) . C.sec) <$> C.getTime C.Monotonic let !v = (sd',ref) reaperAdd reaper (k',p,v,Add) where !k' = toKey k !sd' = toValue sd resume :: Reaper DB Item -> Use -> SessionID -> IO (Maybe SessionData) resume reaper use k = do db <- reaperRead reaper case Q.lookup k' db of Nothing -> return Nothing Just (p,v@(sd,ref)) -> do case use of SingleUse -> do available <- atomicModifyIORef' ref check reaperAdd reaper (k',p,v,Del) return $ if available then Just (fromValue sd) else Nothing MultipleUse -> return $ Just (fromValue sd) where check Fresh = (Used,True) check Used = (Used,False) !k' = toKey k invalidate :: Reaper DB Item -> SessionID -> IO () invalidate reaper k = do db <- reaperRead reaper case Q.lookup k' db of Nothing -> return () Just (p,v) -> reaperAdd reaper (k',p,v,Del) where !k' = toKey k tls-session-manager-0.0.2.1/Network/TLS/Imports.hs0000644000000000000000000000052213505323363020017 0ustar0000000000000000module Network.TLS.Imports ( module Control.Applicative , module Control.Monad , module Data.Int , module Data.List , module Data.Maybe , module Data.Monoid , module Data.Word ) where import Control.Applicative import Control.Monad import Data.Int import Data.List import Data.Maybe import Data.Monoid import Data.Word