Data usage log?

How to customize and extend your OpenVPN installation.
Post Reply
dnilgreb
OpenVpn Newbie
Posts: 18
Joined: Fri Mar 04, 2016 12:13 pm

Data usage log?

Post by dnilgreb » Thu Dec 03, 2020 7:13 pm

Hello,

I am running an OpenVPN server that I´ve been running for quite some time. It´s version 2.4.6.
Now, I want to log data usage for each client. Like the info in the status.log, but permanently saved, so I can look at previous sessions etc.
My first attempt was to add the log option to the server.conf, but I can´t find anything about data usage in the files that get logged. Even if i up the verbosity.
Is there a way to do this? Am I going to have to set up at database in order to acheive this, or can OpenVPN log it to a file in a simpler way? That would be great!

In case it´s interesting, the server is running in a jail on my FreeNAS box (FreeBSD 11.4).

User avatar
Pippin
Forum Team
Posts: 957
Joined: Wed Jul 01, 2015 8:03 am

Re: Data usage log?

Post by Pippin » Thu Dec 03, 2020 8:32 pm

You would have to write something yourself using the management interface:
https://github.com/OpenVPN/openvpn/blob ... -notes.txt
or search for something existing like:
https://github.com/furlongm/openvpn-monitor

dnilgreb
OpenVpn Newbie
Posts: 18
Joined: Fri Mar 04, 2016 12:13 pm

Re: Data usage log?

Post by dnilgreb » Sun Dec 06, 2020 7:29 pm

I found this: https://github.com/QueuingKoala/openvpn ... accounting

It has two scripts. One for client-connect hook. That works fine.
The other one, for client-diconnect however, I can´t get to work.

Server config
#################################################
# Sample OpenVPN 2.0 config file for #
# multi-client server. #
# #
# This file is for the server side #
# of a many-clients one-server #
# OpenVPN configuration. #
# #
# OpenVPN also supports #
# single-machine single-machine #
# configurations (See the Examples page #
# on the web site for more info). #
# #
# This config should work on Windows #
# or Linux/BSD systems. Remember on #
# Windows to quote pathnames and use #
# double backslashes, e.g.: #
# "C:\\Program Files\\OpenVPN\\config\\foo.key" #
# #
# Comments are preceded with '#' or ';' #
#################################################

# Which local IP address should OpenVPN
# listen on? (optional)
local 192.168.1.209

# Which TCP/UDP port should OpenVPN listen on?
# If you want to run multiple OpenVPN instances
# on the same machine, use a different port
# number for each one. You will need to
# open up this port on your firewall.
port 1194

# TCP or UDP server?
;proto tcp
proto udp

# "dev tun" will create a routed IP tunnel,
# "dev tap" will create an ethernet tunnel.
# Use "dev tap0" if you are ethernet bridging
# and have precreated a tap0 virtual interface
# and bridged it with your ethernet interface.
# If you want to control access policies
# over the VPN, you must create firewall
# rules for the the TUN/TAP interface.
# On non-Windows systems, you can give
# an explicit unit number, such as tun0.
# On Windows, use "dev-node" for this.
# On most systems, the VPN will not function
# unless you partially or fully disable
# the firewall for the TUN/TAP interface.
;dev tap
dev tun

# Windows needs the TAP-Windows adapter name
# from the Network Connections panel if you
# have more than one. On XP SP2 or higher,
# you may need to selectively disable the
# Windows firewall for the TAP adapter.
# Non-Windows systems usually don't need this.
;dev-node MyTap

# SSL/TLS root certificate (ca), certificate
# (cert), and private key (key). Each client
# and the server must have their own cert and
# key file. The server and all clients will
# use the same ca file.
#
# See the "easy-rsa" directory for a series
# of scripts for generating RSA certificates
# and private keys. Remember to use
# a unique Common Name for the server
# and each of the client certificates.
#
# Any X509 key management system can be used.
# OpenVPN can also use a PKCS #12 formatted key file
# (see "pkcs12" directive in man page).
ca /usr/local/etc/openvpn/pki/ca.crt
cert /usr/local/etc/openvpn/pki/issued/VPNSERVER.crt
key /usr/local/etc/openvpn/pki/private/VPNSERVER.key # This file should be kept secret

# Diffie hellman parameters.
# Generate your own with:
# openssl dhparam -out dh1024.pem 1024
# Substitute 2048 for 1024 if you are using
# 2048 bit keys.
dh /usr/local/etc/openvpn/pki/dh.pem

#Enable CRL in order to block revoked certs
crl-verify /usr/local/etc/openvpn/easy-rsa/pki/crl.pem

# Configure server mode and supply a VPN subnet
# for OpenVPN to draw client addresses from.
# The server will take 10.8.0.1 for itself,
# the rest will be made available to clients.
# Each client will be able to reach the server
# on 10.8.0.1. Comment this line out if you are
# ethernet bridging. See the man page for more info.
server 10.8.0.0 255.255.255.0

# Maintain a record of client virtual IP address
# associations in this file. If OpenVPN goes down or
# is restarted, reconnecting clients can be assigned
# the same virtual IP address from the pool that was
# previously assigned.
#ifconfig-pool-persist /usr/local/etc/openvpn/ipp.txt

# Configure server mode for ethernet bridging.
# You must first use your OS's bridging capability
# to bridge the TAP interface with the ethernet
# NIC interface. Then you must manually set the
# IP/netmask on the bridge interface, here we
# assume 10.8.0.4/255.255.255.0. Finally we
# must set aside an IP range in this subnet
# (start=10.8.0.50 end=10.8.0.100) to allocate
# to connecting clients. Leave this line commented
# out unless you are ethernet bridging.
;server-bridge 10.8.0.4 255.255.255.0 10.8.0.50 10.8.0.100

# Push routes to the client to allow it
# to reach other private subnets behind
# the server. Remember that these
# private subnets will also need
# to know to route the OpenVPN client
# address pool (10.8.0.0/255.255.255.0)
# back to the OpenVPN server.
#push "route 192.168.10.0 255.255.255.0"
push "route 192.168.1.0 255.255.255.0"

###Push a gateway to turn VPN network into a private(secure) on for Windows
###WebGUI will be inaccessibale from within the LAN
###It still comes from 192-address even if VPN is connected
push "route-metric 512"
push "route 0.0.0.0 0.0.0.0"

# To assign specific IP addresses to specific
# clients or if a connecting client has a private
# subnet behind it that should also have VPN access,
# use the subdirectory "ccd" for client-specific
# configuration files (see man page for more info).

# EXAMPLE: Suppose the client
# having the certificate common name "Thelonious"
# also has a small subnet behind his connecting
# machine, such as 192.168.40.128/255.255.255.248.
# First, uncomment out these lines:
;client-config-dir ccd
;route 192.168.40.128 255.255.255.248
# Then create a file ccd/Thelonious with this line:
# iroute 192.168.40.128 255.255.255.248
# This will allow Thelonious' private subnet to
# access the VPN. This example will only work
# if you are routing, not bridging, i.e. you are
# using "dev tun" and "server" directives.

# EXAMPLE: Suppose you want to give
# Thelonious a fixed VPN IP address of 10.9.0.1.
# First uncomment out these lines:
client-config-dir ccd
route 10.8.0.0 255.255.255.0

# Then add this line to ccd/Thelonious:
# ifconfig-push 10.9.0.1 10.9.0.2

# Suppose that you want to enable different
# firewall access policies for different groups
# of clients. There are two methods:
# (1) Run multiple OpenVPN daemons, one for each
# group, and firewall the TUN/TAP interface
# for each group/daemon appropriately.
# (2) (Advanced) Create a script to dynamically
# modify the firewall in response to access
# from different clients. See man
# page for more info on learn-address script.
;learn-address ./script

# If enabled, this directive will configure
# all clients to redirect their default
# network gateway through the VPN, causing
# all IP traffic such as web browsing and
# and DNS lookups to go through the VPN
# (The OpenVPN server machine may need to NAT
# the TUN/TAP interface to the internet in
# order for this to work properly).
# CAVEAT: May break client's network config if
# client's local DHCP server packets get routed
# through the tunnel. Solution: make sure
# client's local DHCP server is reachable via
# a more specific route than the default route
# of 0.0.0.0/0.0.0.0.
;push "redirect-gateway"

# Certain Windows-specific network settings
# can be pushed to clients, such as DNS
# or WINS server addresses. CAVEAT:
# http://openvpn.net/faq.html#dhcpcaveats
;push "dhcp-option DNS 10.8.0.1"
;push "dhcp-option WINS 10.8.0.1"

# Uncomment this directive to allow different
# clients to be able to "see" each other.
# By default, clients will only see the server.
# To force clients to only see the server, you
# will also need to appropriately firewall the
# server's TUN/TAP interface.
client-to-client

# Uncomment this directive if multiple clients
# might connect with the same certificate/key
# files or common names. This is recommended
# only for testing purposes. For production use,
# each client should have its own certificate/key
# pair.
#
# IF YOU HAVE NOT GENERATED INDIVIDUAL
# CERTIFICATE/KEY PAIRS FOR EACH CLIENT,
# EACH HAVING ITS OWN UNIQUE "COMMON NAME",
# UNCOMMENT THIS LINE OUT.
;duplicate-cn

# The keepalive directive causes ping-like
# messages to be sent back and forth over
# the link so that each side knows when
# the other side has gone down.
# Ping every 10 seconds, assume that remote
# peer is down if no ping received during
# a 120 second time period.
keepalive 10 120

# For extra security beyond that provided
# by SSL/TLS, create an "HMAC firewall"
# to help block DoS attacks and UDP port flooding.
#
# Generate with:
# openvpn --genkey --secret ta.key
#
# The server and each client must have
# a copy of this key.
# The second parameter should be '0'
# on the server and '1' on the clients.
tls-auth /usr/local/etc/openvpn/pki/private/ta.key 0 # This file is secret

# Select a cryptographic cipher.
# This config item must be copied to
# the client config file as well.
;cipher BF-CBC # Blowfish (default)
;cipher AES-128-CBC # AES
;cipher DES-EDE3-CBC # Triple-DES
cipher AES-256-CBC

# Enable compression on the VPN link.
# If you enable it here, you must also
# enable it in the client config file.
comp-lzo

# The maximum number of concurrently connected
# clients we want to allow.
;max-clients 100

# It's a good idea to reduce the OpenVPN
# daemon's privileges after initialization.
#
# You can uncomment this out on
# non-Windows systems.
;user nobody
;group nobody

# The persist options will try to avoid
# accessing certain resources on restart
# that may no longer be accessible because
# of the privilege downgrade.
persist-key
persist-tun

# Output a short status file showing
# current connections, truncated
# and rewritten every minute.
status /var/log/openvpn/openvpn-status.log

# By default, log messages will go to the syslog (or
# on Windows, if running as a service, they will go to
# the "\Program Files\OpenVPN\log" directory).
# Use log or log-append to override this default.
# "log" will truncate the log file on OpenVPN startup,
# while "log-append" will append to it. Use one
# or the other (but not both).
;log openvpn.log
;log-append /var/log/openvpn/test.log

# Set the appropriate level of log
# file verbosity.
#
# 0 is silent, except for fatal errors
# 4 is reasonable for general usage
# 5 and 6 can help to debug connection problems
# 9 is extremely verbose
verb 3

#telnet
management localhost 7505

script-security 3
client-connect /usr/local/etc/openvpn/scripts/client-connect.sh
client-disconnect /usr/local/etc/openvpn/scripts/client-disconnect.sh

# Silence repeating messages. At most 20
# sequential messages of the same message
# category will be output to the log.
;mute 20


client-connect.sh

Code: Select all

#!/bin/sh

# Copyright Josh Cepek
# This file is part of the openvpn-dynamic project, available from:
# https://github.com/QueuingKoala/openvpn-dynamic
# Dual-licensed under GPLv3 and BSD-3-clause

# BEGIN User Connect Accounting

log_file="/var/log/openvpn/connect.log"

# Vars used:
date_now="$(date +'%F-%H:%M')"

line="User '$common_name' \
at $date_now \
using $ifconfig_pool_remote_ip \
from ${trusted_ip}:${trusted_port}"

# Append to the log
echo "$line" >> "$log_file"

# END User Connect Accounting

exit 0
client-disconnect.sh

Code: Select all

#!/bin/sh
# Copyright Josh Cepek
# This file is part of the openvpn-dynamic project, available from:
# https://github.com/QueuingKoala/openvpn-dynamic
# Dual-licensed under GPLv3 and BSD-3-clause
# BEGIN User Disconnect Accounting
log_file="/var/log/openvpn/connect.log"
# Be platform friendly to both GNU and BSD-userland:
echo "hej hopp" >> "$log_file"
if date --help >/dev/null 2>&1; then
        get_date() { date -d "@$1" +'%F-%H:%M'; }
else
        get_date() { date -r "$1" +'%F-%H:%M'; }
fi

# Vars used in log line:
#time:
date_from="$(get_date $time_unix)"
echo "ok here" >> "$log_file"
set
unix_to=$(($time_unix + $time_duration))
echo "two" >> "$log_file"
date_to="$(get_date $unix_to)"
echo "three" >> "$log_file"
time_h=$(($time_duration / 3600))
echo "four" >> "$log_file"
time_m=$(( $time_duration % 3600 / 60 ))

#bw:
bw_up="$(( $bytes_received / 1000**2 ))\
.$(( $bytes_received % 1000**2 / 1000 ))"
w_down="$(( $bytes_sent / 1000**2 ))\
.$(( $bytes_sent % 1000**2 / 1000 ))"

# Format the line for export:
line="User '$common_name' \
using $ifconfig_pool_remote_ip \
from $trusted_ip:$trusted_port \
for $date_from to $date_to ($time_h:$time_m) \
BW(up/down) $bw_up/$bw_down"
# Append it to the log
echo "$line" >> "$log_file"
# END User Disconnect Accounting
exit 0
Error message from /var/log/messages:

Code: Select all

WARNING: Failed running command (--client-disconnect): could not execute external program
Can anyone see the problem?
Last edited by Pippin on Sun Dec 06, 2020 7:42 pm, edited 1 time in total.
Reason: Formatting

dnilgreb
OpenVpn Newbie
Posts: 18
Joined: Fri Mar 04, 2016 12:13 pm

Re: Data usage log?

Post by dnilgreb » Tue Dec 08, 2020 10:57 am

I solved it.

Since I couldn´t get an idea about the error, I started writing my own shell script for doing this. After doing this a while, with the same or similar errors, I came across a webpage telling me to check the syntax of my server.conf file by running

Code: Select all

openvpn server.conf
That produced an error completely unrelated to this topic. Once i had corrected that, which was easily done once I knew about it, everything worked, logging included.

Post Reply