tcp-streams

One stop solution for tcp client and server with tls support.

Version on this page:0.4.0.0
LTS Haskell 21.25:1.0.1.1
Stackage Nightly 2023-06-21:1.0.1.1
Latest on Hackage:1.0.1.1

See all snapshots tcp-streams appears in

BSD-3-Clause licensed by winterland1989
Maintained by [email protected]
This version can be pinned in stack with:tcp-streams-0.4.0.0@sha256:47993c4a38d8e6164fd02f3534c2cbdb2351109885fb1012b93545edea05e151,2912

Module documentation for 0.4.0.0

tcp-streams

Hackage Build Status

One stop solution for tcp client and server with tls support!

  • use io-streams for auto read buffering and easy streamming process.

  • use tls or HsOpenSSL for tls connection.

Built-in mozilla CA list date: 2016/04/20.

Mac user may need manually passing openssl library path if linker can’t find them:

cabal install --extra-include-dirs=/usr/local/opt/openssl/include --extra-lib-dirs=/usr/local/opt/openssl/lib tcp-streams

You can disable openssl support with cabal install -f -openssl.

Also take a look at wire-stream, for serialize/deserialize data. Happy hacking!

Example

import qualified System.IO.Streams         as Stream
import qualified System.IO.Streams.TCP     as TCP
import qualified Data.TLSSetting           as TLS
import qualified System.IO.Streams.TLS     as TLS

--  TCP Client
...
(is, os, sock) <- TCP.connect "127.0.0.1" 8888
Stream.write os =<< ..  -- sending
Stream.read is >>=  ..  -- receiving
TCP.close sock   ..  -- closing
...


-- TCP Server
...
sock <- TCP.bindAndListen 8888 1024
(is, os, csock, _) <- TCP.accept sock
Stream.write os =<< ..  -- sending
Stream.read is >>= ..   -- receiving
...


--  TLS Client
...
cp <- TLS.makeTLSClientParams (TLS.CustomCAStore "myCA.pem")
(is, os, ctx) <- TCP.connect cp (Just "myCAName") "127.0.0.1" 8888
Stream.write os =<< ..  -- sending
Stream.read is >>=  ..  -- receiving
TLS.close ctx    ..  -- closing
...


--  TLS Server
...
sp <- TLS.makeServerParams "server.crt" [] "server.key"
sock <- TCP.bindAndListen 8889 1024
(is, os, ctx, sockAddr) <- TLS.accept sp sock
Stream.write os =<< ..  -- sending
Stream.read is >>= ..   -- receiving
...


-- HTTPS Client
...
cp <- TLS.makeClientParams TLS.MozillaCAStore
(is, os, ctx) <- TLS.connect cp Nothing "www.google.com" 443
Stream.write (Just "GET / HTTP/1.1\r\n") os
Stream.write (Just "Host: www.google.com\r\n") os
Stream.write (Just "\r\n") os
bs <- Stream.readExactly 1024 is
...

License

Copyright (c) 2016, Winterland

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 winterland1989 nor the names of other
  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.

Changes

Revision history for tcp-simple

0.4.0.0

  • auto add withOpenSSL.
  • add extra-libraries to cabal file.

0.3.0.0

  • Add qualified notes, rename closeTLS/closeSSL to close.
  • fix Bad pipe error in tls’s close

0.2.3.0

  • Add acceptWithBufferSize, socketToStreamsWithBufferSize, fix recv exception handler.

0.2.2.0

  • Clean and document exception behavior.

0.2.1.0

  • Fix broken document.

0.2.0.0

  • Add support for openssl using HsOpenSSL package.

0.1.0.0

  • First version. Released on an unsuspecting world.