crypton-socks

SOCKS Protocol Version 5

http://github.com/mpilgrem/crypton-socks

LTS Haskell 24.0:0.6.2
Stackage Nightly 2025-07-14:0.6.2
Latest on Hackage:0.6.2

See all snapshots crypton-socks appears in

BSD-3-Clause licensed by Vincent Hanquez
Maintained by Mike Pilgrem, Kazu Yamamoto
This version can be pinned in stack with:crypton-socks-0.6.2@sha256:19f8f9a8c1973905ec000ea431bb4454a9c437b80f1e5f5f83ff84b964c49885,2017

Module documentation for 0.6.2

Used by 1 package in nightly-2025-07-14(full list with versions):
crypton-socks

crypton-socks

Originally forked from socks-0.6.1.

Haskell library implementing the SOCKS Protocol Version 5.

Usage

See example/Example.hs for really simple and straighforward examples. The main API of the library is three functions:

  • socksConnectWithSocket which connects to a SocksAddress specifying a SocksHostAddress (SocksAddrIPV4, SocksAddrDomainName or SocksAddrIPV6). The name resolution is done on the client side.
  • socksConnect connects a new socket to a SOCKS server, with socksConnectWithSocket.
  • socksConnectName which connects to a fully qualified domain name (FQDN) (for example, www.example.com). The name resolution is done by the proxy server.

History

The socks package was originated and then maintained by Vincent Hanquez. For published reasons, he does not intend to develop the package further after version 0.6.1 but he also does not want to introduce other maintainers.

Changes

Change log for crypton-socks

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to the Haskell Package Versioning Policy.

0.6.2

  • Move library modules to directory src and example application to directory example.
  • Change data types SocksHello and SocksHelloResponse (each with a single, unary data constructor without strictness annotation) to newtype.
  • Add missing top-level signatures to library.
  • Name the example application crypton-socks-example, and move it being built behind Cabal flag example (default: false).
  • Export the SocksFQDN type synonym, representing fully-qualified domain names (FQDN) under the SOCKS Protocol Version 5. The API assumes that such values comprise only ASCII characters. Domain names that include other Unicode code points should be Punycode encoded.
  • Remove dependency on the basement package.
  • Deprecate defaultSocksConfFromSockAddr, soft deprecated from 22 April 2019.

0.6.1