Network.Simple.WSS

Simple tools for establishing and using Secure WebSockets connections on top of TLS (i.e, wss://).

See the network-simple-ws package for insecure WebSockets (i.e, ws://) support.

Notice that, currently, this is package offers tools that are mostly intreresting from a client's point of view. Server side support will come later.

Documentation

data Connection

send :: MonadIO m => Connection -> ByteString -> m ()

Send bytes to the remote end.

Takes a lazy ByteString.

recv :: MonadIO m => Connection -> m ByteString

Receive bytes from the remote end.

Returns a strict ByteString.

Returns an empty string when the remote end gracefully closes the connection.

Client side

connect

Arguments

:: (MonadIO m, MonadMask m)

=> ClientSettings

TLS settings.

-> HostName

Secure WebSockets server host name (e.g., "www.example.com" or IP address).

-> ServiceName

Secure WebSockets server port (e.g., "443" or "www").

-> ByteString

Secure WebSockets resource (e.g., "/foo/qux?bar=wat&baz").

Leading '/' is optional.

-> [(ByteString, ByteString)]

Extra HTTP Headers (e.g., [("Authorization", "Basic dXNlcjpwYXNzd29yZA==")]).

-> ((Connection, SockAddr) -> m r)

Computation to run after establishing a Secure WebSockets to the remote server. Takes the WebSockets connection and remote end address.

-> m r

Connect to the specified Secure WebSockets server.

connectOverSOCKS5

Arguments

:: (MonadIO m, MonadMask m)

=> HostName

SOCKS5 proxy server hostname or IP address.

-> ServiceName

SOCKS5 proxy server service port name or number.

-> ClientSettings

TLS settings.

-> HostName

Destination Secure WebSockets server hostname or IP address. We connect to this host through the SOCKS5 proxy specified in the previous arguments.

Note that if hostname resolution on this HostName is necessary, it will happen on the proxy side for security reasons, not locally.

-> ServiceName

Destination Secure WebSockets server port (e.g., "443" or "www").

-> ByteString

WebSockets resource (e.g., "/foo/qux?bar=wat&baz").

Leading '/' is optional.

-> [(ByteString, ByteString)]

Extra HTTP Headers (e.g., [("Authorization", "Basic dXNlcjpwYXNzd29yZA==")]).

-> ((Connection, SockAddr, SockAddr) -> m r)

Computation taking a Connection for communicating with the destination Secure WebSockets server through the SOCKS5 server, the address of that SOCKS5 server, and the address of the destination WebSockets server, in that order.

-> m r

Like connect, but connects to the destination server through a SOCKS5 proxy.

Low level

streamFromContext :: MonadIO m => Context -> m Stream

Obtain a Stream implemented using the given TLS Context. You can use the network-simple-tls library to get one of those.