neko-obfs (empty) → 0.1.0.0
raw patch · 11 files changed
+569/−0 lines, 11 filesdep +asyncdep +attoparsecdep +basesetup-changed
Dependencies added: async, attoparsec, base, binary, bytestring, lens, network, network-simple, optparse-generic, pipes, pipes-attoparsec, pipes-network, pipes-safe, random, text, transformers
Files
- ChangeLog.md +5/−0
- LICENSE +202/−0
- Readme.md +14/−0
- Setup.hs +2/−0
- neko-obfs.cabal +46/−0
- src/Helper.hs +35/−0
- src/Main.hs +147/−0
- src/Options.hs +46/−0
- src/Parser.hs +21/−0
- src/Type.hs +43/−0
- src/Unsafe.hs +8/−0
+ ChangeLog.md view
@@ -0,0 +1,5 @@+# Revision history for neko-obfs++## 0.1.0.0 -- YYYY-mm-dd++* First version. Released on an unsuspecting world.
+ 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.
+ Readme.md view
@@ -0,0 +1,14 @@+* This tunnel should be used inside an encrypted tunnel+* For example:++ ss-local (rc4)++ -> neko-obfs -> ss-tunnel (aes-256-cfb)++ -> gfw -> internet++ -> ss-tunnel (aes-256-cfb) -> neko-obfs ++ -> ss-server (rc4)+* Note it's the `ss-tunnel` layer that protects the obfuscation, otherwise+ data and noise length are clearly visable.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ neko-obfs.cabal view
@@ -0,0 +1,46 @@+-- Initial neko-obfs.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/++name: neko-obfs+version: 0.1.0.0+synopsis: a TCP tunnel with packet length obfuscation+description: Just another tool that helps accessing the internet+license: Apache-2.0+license-file: LICENSE+author: Jinjing Wang+maintainer: nfjinjing@gmail.com+-- copyright: +category: Network+build-type: Simple+extra-source-files: ChangeLog.md+ Readme.md+cabal-version: >=1.10+homepage: http://github.com/nfjinjing/neko-obfs++executable neko-obfs+ main-is: Main.hs++ other-modules: Helper+ , Options+ , Parser+ , Type+ , Unsafe+ -- other-extensions: + build-depends: base >=4.9 && <4.10+ , async+ , attoparsec+ , binary+ , bytestring+ , lens+ , network+ , network-simple+ , optparse-generic+ , pipes+ , pipes-attoparsec+ , pipes-network+ , pipes-safe+ , random+ , text+ , transformers+ hs-source-dirs: src+ default-language: Haskell2010
+ src/Helper.hs view
@@ -0,0 +1,35 @@+{-# LANGUAGE OverloadedStrings #-}++-- |++module Helper where++import Control.Lens+import Prelude hiding ((-), log)++import Control.Concurrent.MVar (withMVar)+import Control.Monad (forever, when)+import Control.Monad.IO.Class (MonadIO(..))+import Data.ByteString (ByteString)+import qualified Data.ByteString as B+import Data.Monoid ((<>))+import Data.Text (Text)+import qualified Data.Text.IO as T+import Data.Text.Strict.Lens+import Pipes (Pipe, for, cat, yield)+import Pipes.Safe (catchP)++import Unsafe (logLock)++{-# INLINE (-) #-}+infixr 0 -+(-) :: (a -> b) -> a -> b+f - x = f x++sync :: MonadIO m => IO a -> m a+sync io = liftIO - withMVar logLock - const io++log :: MonadIO m => Text -> m ()+log x = sync - T.putStrLn x++
+ src/Main.hs view
@@ -0,0 +1,147 @@+{-# LANGUAGE OverloadedStrings #-}++module Main where++import Helper ((-), log)+import Prelude hiding ((-), log)++import Control.Concurrent.Async (async, waitAnyCatchCancel, waitEitherCancel)+import Control.Lens+import Control.Monad (replicateM_, join)+import Control.Monad.IO.Class (MonadIO(..))+import Control.Monad.Trans.State.Strict (runStateT)+import Data.Attoparsec.ByteString (parse, maybeResult)+import Data.ByteString (ByteString)+import qualified Data.ByteString as B+import qualified Data.ByteString.Builder as Builder+import qualified Data.ByteString.Char8 as BC+import Data.Monoid ((<>))+import qualified Data.Text as T+import Data.Text.Lens+import Data.Text.Strict.Lens (utf8)+import Network.Simple.TCP (send)+import qualified Network.Socket as NS+import Pipes (runEffect, (>->), Pipe, for, yield, cat, Producer, Consumer)+import qualified Pipes.Attoparsec as PA+import Pipes.Network.TCP.Safe+import qualified Pipes.Prelude as P+import Pipes.Safe+import System.Random (randomIO)+import Options.Generic++import Options (toConfig)+import Parser+import Type+++obfsEncode :: (MonadIO m) => Integer -> Integer -> Pipe ByteString ByteString m a+obfsEncode bound randomness = do+ for cat - \x -> do+ let payloadLen = (fromIntegral - B.length x)++ randomLen <-+ if (payloadLen > fromIntegral bound)+ then pure 0+ else liftIO - randomIO <&> (`mod` fromIntegral randomness)++ yield - view strict - Builder.toLazyByteString - Builder.word32BE randomLen+ replicateM_ (fromIntegral randomLen) - yield - BC.singleton 'a'++ yield - view strict - Builder.toLazyByteString - Builder.word32BE payloadLen+ yield x+++obfsDecode :: (MonadIO m) => Producer ByteString m a -> (ByteString -> m ()) -> m ()+obfsDecode pull sink = do+ (r, next) <- runStateT (PA.parse obfsParser) pull+ case r of+ Just (Right result@(_,_,_,payload)) -> do+ -- log - view packed - show result+ sink payload+ obfsDecode next sink+ _ -> pure ()++main :: IO ()+main = do+ config <- getRecord "a TCP tunnel with packet length obfuscation" <&> toConfig++ log - T.pack - show config++ let mtu = 4096+ timeout = fromIntegral - config ^. timeoutInSeconds * 1000000++ let _localHost = config ^. localHost . re packed+ _localPort = show - config ^. localPort++ _remoteHost = config ^. remoteHost . re packed+ _remotePort = show - config ^. remotePort++ _fromSocket = fromSocketTimeout timeout+ _toSocket = toSocketTimeout timeout++ localThread <- pure -+ runSafeT . runEffect - serve (Host _localHost) _localPort - \(localSock, localSockAddr) -> do+ log - "local accepted: " <> view packed (show localSockAddr)++ runSafeT . runEffect -+ connect _remoteHost _remotePort - \(remoteSock, remoteSockAddr) -> do++ let+ localPull = _fromSocket localSock mtu++ remotePull = _fromSocket remoteSock mtu+ remotePush = _toSocket remoteSock+++ sendThread <- liftIO - async - runEffect - do+ localPull >-> obfsEncode (config ^. bound) (config ^. randomness)+ >-> remotePush+ liftIO - NS.shutdown remoteSock NS.ShutdownSend++ recvThread <- liftIO - async - do+ obfsDecode remotePull - send localSock+ liftIO - NS.shutdown localSock NS.ShutdownSend++ liftIO - waitEitherCancel sendThread recvThread++ pure ()++ remoteThread <- pure -+ runSafeT . runEffect - serve (Host _remoteHost) _remotePort - \(remoteSock, remoteSockAddr) -> do+ log - "remote accepted: " <> view packed (show remoteSockAddr)++ let _forwardHost = config ^. forwardHost . re packed+ _forwardPort = show - config ^. forwardPort++ runSafeT . runEffect -+ connect _forwardHost _forwardPort - \(forwardSock, forwardSockAddr) -> do++ let+ remotePull = _fromSocket remoteSock mtu+ remotePush = _toSocket remoteSock++ forwardPull = _fromSocket forwardSock mtu++ sendThread <- liftIO - async - do+ obfsDecode remotePull - send forwardSock+ liftIO - NS.shutdown forwardSock NS.ShutdownSend++ recvThread <- liftIO - async - runEffect - do+ forwardPull >-> obfsEncode (config ^. bound) (config ^. randomness)+ >-> remotePush+ liftIO - NS.shutdown remoteSock NS.ShutdownSend++ liftIO - waitEitherCancel sendThread recvThread++ pure ()+++ case config ^. role of+ Local -> do+ _ <- localThread+ pure ()+ Remote -> do+ _ <- remoteThread+ pure ()++ pure ()
+ src/Options.hs view
@@ -0,0 +1,46 @@+-- |++{-# LANGUAGE DeriveGeneric #-}++module Options where++import Options.Generic+import Data.Maybe (fromMaybe)++import Type (Config(..), Role(..), defaultConfig)++data TunnelOptions = TunnelOptions+ {+ localHost :: Maybe Text+ , localPort :: Maybe Integer+ , remoteHost :: Text+ , remotePort :: Integer+ , forwardHost :: Maybe Text+ , forwardPort :: Maybe Integer+ , remote :: Bool+ , bound :: Maybe Integer+ , randomness :: Maybe Integer+ , timeoutInSeconds :: Maybe Integer+ }+ deriving (Generic, Show, Eq)++instance ParseRecord TunnelOptions+++toConfig :: TunnelOptions -> Config+toConfig o =+ let c = defaultConfig+ in+ Config+ {+ _localHost = fromMaybe (_localHost c) (localHost o)+ , _localPort = fromMaybe (_localPort c) (localPort o)+ , _remoteHost = remoteHost o+ , _remotePort = remotePort o+ , _forwardHost = fromMaybe (_forwardHost c) (forwardHost o)+ , _forwardPort = fromMaybe (_forwardPort c) (forwardPort o)+ , _role = if remote o then Remote else Local+ , _bound = fromMaybe (_bound c) (bound o)+ , _randomness = fromMaybe (_randomness c) (randomness o)+ , _timeoutInSeconds = fromMaybe (_timeoutInSeconds c) (timeoutInSeconds o)+ }
+ src/Parser.hs view
@@ -0,0 +1,21 @@++{-# LANGUAGE OverloadedStrings #-}+module Parser where++import Control.Lens ((<&>), view, lazy)+import Data.Attoparsec.ByteString (Parser)+import qualified Data.Attoparsec.ByteString as P+import Data.Binary.Get+import Data.ByteString.Char8 (ByteString)+import Data.Word (Word32)+import GHC.Word (Word8)++obfsParser :: Parser (Word32, ByteString, Word32, ByteString)+obfsParser = do+ randomLen <- P.take 4 <&> runGet getWord32be . view lazy++ random <- P.take (fromIntegral randomLen)+ payloadLen <- P.take 4 <&> runGet getWord32be . view lazy++ payload <- P.take (fromIntegral payloadLen)+ pure (randomLen, random, payloadLen, payload)
+ src/Type.hs view
@@ -0,0 +1,43 @@+{-# LANGUAGE TemplateHaskell #-}+{-# LANGUAGE OverloadedStrings #-}++module Type where+++import Control.Lens+import Data.Text (Text)++data Role = Local | Remote+ deriving (Show, Eq)++data Config = Config+ {+ _localHost :: Text+ , _localPort :: Integer+ , _remoteHost :: Text+ , _remotePort :: Integer+ , _forwardHost :: Text+ , _forwardPort :: Integer+ , _role :: Role+ , _bound :: Integer+ , _randomness :: Integer+ , _timeoutInSeconds :: Integer+ }+ deriving (Show, Eq)++makeLenses ''Config+++defaultConfig = Config+ {+ _localHost = "127.0.0.1"+ , _localPort = 1080+ , _remoteHost = "127.0.0.1"+ , _remotePort = 13148+ , _forwardHost = "127.0.0.1"+ , _forwardPort = 1080+ , _role = Local+ , _bound = 1024+ , _randomness = 300+ , _timeoutInSeconds = 3600+ }
+ src/Unsafe.hs view
@@ -0,0 +1,8 @@+module Unsafe where+++import Control.Concurrent.MVar+import System.IO.Unsafe++logLock :: MVar ()+logLock = unsafePerformIO (newMVar ())