How to Install and USE Socat on Freebsd

Transferring data between computers on a public or private network can be a challenge, especially when you need to transfer data both ways. The socat command in FreeBSD provides a powerful and flexible solution for bidirectional data transfer between network connections.

In this article, we will learn how to use the socat command and provide practical examples to help you understand the use of the socat command. The goal is to establish a connection between two data sources, where each data source can be a file, Unix socket, UDP, TCP, or standard input.

On FreeBSD systems socat is not installed automatically like SSH or NTP. To be able to use Socat you have to install it first so you can experience the benefits of the Socat command.

1. Install Socat

On FreeBSD, Socat is installed in various ways, but most people use the PKG package or Ports system. So that all Socat libraries and dependencies can be built perfectly, we use the ports system to install Socat. Use the following command to start it.
root@ns3:~ # cd /usr/ports/net/socat
root@ns3:/usr/ports/net/socat # make config
root@ns3:/usr/ports/net/socat # make install clean
To complete the socat command, you also install the Curl and Bash applications, because when used, these applications are always used with socat.
root@ns3:/usr/ports/net/socat # pkg install curl bash
Same as other applications, Socat also has Start up rc.d. which can make Socat run automatically. But people rarely use the rc.d script, usually manual commands are used to run socat. But there's nothing wrong, we will discuss Start Up rc.d socat.

So that socat can run automatically on FreeBSD systems, enter the script below in the "/etc/rc.conf" file.


The socat configuration file is named "/usr/local/etc/socat-instances.conf", edit the file as needed. To run socat use the following command.
root@ns3:~ # service socat restart

2. Socat Binary Files

After the installation process is complete, Socat produces three bin files, namely:
  1. /usr/local/bin/filan
  2. /usr/local/bin/procan
  3. /usr/local/bin/socat
Socat is a command line based relay utility that establishes two bidirectional byte streams and is used for bidirectional data transfer between two independent data channels. Each of these data channels can be a file, a pipe, a device (terminal or modem etc.), a socket (UNIX, IP4, IP6 - raw, UDP, TCP), a file descriptor (stdin etc.), a program, or an arbitrary combination -the authority of these two.

Filan is a utility that can output information about its active file descriptor to stdout. Filan is used for debugging socat, but it may be useful for other purposes as well. Use the -h option to find more info.

Procan is a utility that can output information about process parameters to stdout. Procan is often used to better understand some UNIX process properties and for socat debugging, but it may be useful for other purposes as well.

3. How to Use Socat

Socat's syntax is quite simple and easy to write.

socat [options] <address> <address>

For socat to work, you must provide a source and destination address. The syntax for these addresses is:


a. Connects socat to TCP port 80 on a local or remote network
root@ns3:~ # socat -
root@ns3:~ # socat - TCP4:
In the example above, socat transfers data between STDIO (-) and TCP4 connections to port 80 on the host named and local host

b. Using the socat command as a TCP port forwarder

For a single connection
root@ns3:~ # socat TCP4-LISTEN:80 TCP4:
For multiple connections, use the fork option
root@ns3:~ # socat TCP4-LISTEN:81,fork,reuseaddr TCP4:TCP4:
root@ns3:~ # socat TCP-LISTEN:80,fork TCP:
In the example above, socat would listen on port 81, accept the connection, and forward the connection to port 80 on the remote host. In the second script, all TCP4 connections to port 80 will be redirected to You can end the connection by pressing [CTRL+C].
root@ns3:~ # socat TCP-LISTEN:3306,reuseaddr,fork UNIX-CONNECT:/tmp/mysql.sock
In the example script above, socat will listen on port 3306, accept the connection, and forward the connection to the Unix socket on the remote host.

c. Implementing socat as a simple network based message collector
root@ns3:~ # socat -u TCP4-LISTEN:3334,reuseaddr,fork OPEN:/tmp/test.log,creat,append
In the example script above, when a client connects to port 3334, a new child process will be generated, and all data sent by the client will be added to the /tmp/test.log file. If the file does not exist, socat will create it. The reuseaddr option allows the server process to be restarted immediately.

d. The socat command will send a broadcast to the local network
root@ns3:~ # socat - UDP4-DATAGRAM:,bind=:6666,ip-add-membership=
In the example script above, socat will transfer data from stdin to the specified multicast address using UDP via port 6666 for local and remote connections. This command also tells the nfeo interface to receive multicast packets for the specified group. nfe0 is your computer's ethernet card.

Socat is a great utility for connecting to remote servers. With the socat command you can create remote connections easily. In this example we will use socat for remote MySQL connections. We will try to connect a web server to a remote MySQL server by connecting via a local socket.

On your remote MySQL server, type the following command.
root@ns3:~ # socat TCP-LISTEN:3307,reuseaddr,fork UNIX-CONNECT:/tmp/mysql.sock &
The above command will start socat and configure it to listen and use port 3307. After that, on the web server on your computer, type the following command.
root@ns3:~ # socat UNIX-LISTEN:/tmp/mysql.sock,fork,reuseaddr,unlink-early,user=mysql,group=mysql,mode=777 TCP: &
The above command will connect the local IP to the remote server using port 3307. All the communication is done on the Unix socket /tmp/mysql.sock, and this makes it look like a local server.

The basic socat command in FreeBSD provides a powerful and flexible solution for bidirectional data transfer between networks. Using the socat command, you can create two endpoints to perform data transfer and connect them. Socat makes the job of data transfer easier over different network connections.
Iwan Setiawan

I Like Adventure: Mahameru Mount, Rinjani Mount I Like Writer FreeBSD

Post a Comment

Previous Post Next Post