doc/socket_wrapper.1.txt

   1 socket_wrapper(1)
   2 =================
   3 :revdate: 2018-11-28
   4 :author: Samba Team
   5
   6 NAME
   7 ----
   8
   9 socket_wrapper - A library passing all socket communications through unix sockets.
  10
  11 SYNOPSIS
  12 --------
  13
  14 LD_PRELOAD=libsocket_wrapper.so SOCKET_WRAPPER_DIR=/tmp/tmp.bQRELqDrhM SOCKET_WRAPPER_DEFAULT_IFACE=10 *./myapplication*
  15
  16 DESCRIPTION
  17 -----------
  18
  19 socket_wrapper aims to help client/server software development teams willing to
  20 gain full functional test coverage. It makes possible to run several instances
  21 of the full software stack on the same machine and perform locally functional
  22 testing of complex network configurations.
  23
  24 - Redirects all network communication to happen over Unix sockets.
  25 - Support for IPv4 and IPv6 socket and addressing emulation.
  26 - Ability to capture network traffic in pcap format.
  27
  28 ENVIRONMENT VARIABLES
  29 ---------------------
  30
  31 *SOCKET_WRAPPER_DIR*::
  32
  33 The user defines a directory where to put all the unix sockets using the
  34 environment variable "SOCKET_WRAPPER_DIR=/path/to/socket_dir". When a server
  35 opens a port or a client wants to connect, socket_wrapper will translate IP
  36 addresses to a special socket_wrapper name and look for the relevant Unix
  37 socket in the SOCKET_WRAPPER_DIR.
  38
  39 *SOCKET_WRAPPER_IPV4_NETWORK*::
  40
  41 By default the loopback IPv4 network "127.0.0.0/8" and the
  42 "127.0.0.x" can be used. In order to make more realistic testing
  43 possible it is possible to use the "10.0.0.0/8" IPv4 network instead.
  44 But note within "10.0.0.0/8" only "10.53.57.<ID>" can be used,
  45 but the broadcast address is "10.255.255.255".
  46 The following two value are allowed:
  47 SOCKET_WRAPPER_IPV4_NETWORK="127.0.0.0" (the default) and
  48 SOCKET_WRAPPER_IPV4_NETWORK="10.53.57.0".
  49
  50 *SOCKET_WRAPPER_DEFAULT_IFACE*::
  51
  52 Additionally, the default interface to be used by an application is defined with
  53 "SOCKET_WRAPPER_DEFAULT_IFACE=<ID>" where the valid range for <ID> starts with 1
  54 (the default) and ends with 64. This is analogous to use the IPv4 addresses
  55 "127.0.0.<ID>"/"10.53.57.<ID>" or IPv6 addresses "fd00::5357:5f<IDx>" (where
  56 <IDx> is a hexadecimal presentation of <ID>). You should always set the default
  57 interface. If you listen on INADDR_ANY then it will use the default interface to
  58 listen on.
  59
  60 *SOCKET_WRAPPER_PCAP_FILE*::
  61
  62 When debugging, it is often interesting to investigate the network traffic
  63 between the client and server within your application. If you define
  64 SOCKET_WRAPPER_PCAP_FILE=/path/to/file.pcap, socket_wrapper will dump all your
  65 network traffic to the specified file. After the test has been finished you're
  66 able to open the file for example with Wireshark.
  67
  68 *SOCKET_WRAPPER_MTU*::
  69
  70 With this variable you can change the MTU size. However we do not recomment to
  71 do that as the default size of 1500 byte is best for formatting PCAP files.
  72
  73 The minimum value you can set is 512 and the maximum 32768.
  74
  75 *SOCKET_WRAPPER_MAX_SOCKETS*::
  76
  77 This variable can be used to set the maximum number of sockets to be used by
  78 an application.
  79
  80 The default value is set to 65535 and the maximum 256000.
  81
  82 *SOCKET_WRAPPER_DEBUGLEVEL*::
  83
  84 If you need to see what is going on in socket_wrapper itself or try to find a
  85 bug, you can enable logging support in socket_wrapper if you built it with
  86 debug symbols.
  87
  88 - 0 = ERROR
  89 - 1 = WARNING
  90 - 2 = DEBUG
  91 - 3 = TRACE
  92
  93 *SOCKET_WRAPPER_DISABLE_DEEPBIND*::
  94
  95 This allows you to disable deep binding in socket_wrapper. This is useful for
  96 running valgrind tools or sanitizers like (address, undefined, thread).
  97
  98 *SOCKET_WRAPPER_DIR_ALLOW_ORIG*::
  99
 100 SOCKET_WRAPPER_DIR is resolved by socket_wrapper using realpath(3).
 101 Given that Unix sockets are constructed relative to this directory,
 102 the resulting path can sometimes be too long to allow valid socket
 103 paths to be constructed due to length restrictions.  Setting this
 104 variable (to any value) allows socket_wrapper to fall back to the
 105 original value of SOCKET_WRAPPER_DIR if realpath(3) makes it too long
 106 to be usable.
 107
 108 EXAMPLE
 109 -------
 110
 111   # Open a console and create a directory for the unix sockets.
 112   $ mktemp -d
 113   /tmp/tmp.bQRELqDrhM
 114
 115   # Then start nc to listen for network traffic using the temporary directory.
 116   $ LD_PRELOAD=libsocket_wrapper.so \
 117     SOCKET_WRAPPER_DIR=/tmp/tmp.bQRELqDrhM \
 118     SOCKET_WRAPPER_DEFAULT_IFACE=10 nc -v -l 127.0.0.10 7
 119
 120   # (If nc, listens on 0.0.0.0 then listener will be open on 127.0.0.10 because
 121   #  it is the default interface)
 122
 123   # Now open another console and start 'nc' as a client to connect to the server:
 124   $ LD_PRELOAD=libsocket_wrapper.so \
 125     SOCKET_WRAPPER_DIR=/tmp/tmp.bQRELqDrhM \
 126     SOCKET_WRAPPER_DEFAULT_IFACE=100 nc -v 127.0.0.10 7
 127
 128   # (The client will use the address 127.0.0.100 when connecting to the server)
 129   # Now you can type 'Hello!' which will be sent to the server and should appear
 130   # in the console output of the server.