OpenVPN no authenticated log generated

biggsy

For what it's worth, here's what I did some time ago to get some more useful stuff out of openVPN syslogs. I have the Verbosity level set to "none" in the OpenVPN config.

The openvpn.attributes.sh file will be overwritten by updates.

#!/bin/sh
#
# openvpn.attributes.sh
#
# part of pfSense (https://www.pfsense.org)
# Copyright (c) 2004-2016 Rubicon Communications, LLC (Netgate)
# All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

if [ "$script_type" = "client-connect" ]; then
	logger -t openvpn "User '${common_name}' at ${trusted_ip} connected on tunnel IP ${ifconfig_pool_remote_ip}."
	if [ -f /tmp/$common_name ]; then
		/bin/cat /tmp/$common_name > $1
		/bin/rm /tmp/$common_name
	fi
elif [ "$script_type" = "client-disconnect" ]; then
	logger -t openvpn "User '${common_name}' at ${trusted_ip} disconnected on tunnel IP ${ifconfig_pool_remote_ip}. Server sent ${bytes_sent} bytes, rcvd ${bytes_received} bytes"
	command="/sbin/pfctl -a 'openvpn/$common_name' -F rules"
	eval $command
	/sbin/pfctl -k $ifconfig_pool_remote_ip
	/sbin/pfctl -K $ifconfig_pool_remote_ip
fi

exit 0

tienpro113396

@biggsy But I don't run any update and the openvpn.attributes.sh not changed! In case this file overwritten to default, it should have authenticate log, right?

Gertjan

I don't know how this file is used, in what context, etc.

@tienpro113396 said in OpenVPN no authenticated log generated:

openvpn.attributes.sh

biggsy

@tienpro113396
Sorry, I don't know why it would have stopped logging but I think using logger is possibly a better way to do this.

Forgot to mention that there are functions available to format the numbers but that wasn't so important to me.

tienpro113396

@Gertjan Yes I need to logging users disconnect time, I do a research and know that I can edit that file to get the disconnected log in openvpn.log file. In 5 days I have both authenticated and disconnected log and boom only disconnected log appear there. No more authenticated log

Gertjan

Put on the second line in your script file openvpn.attributes.sh these commands :

/usr/bin/logger "test"
/usr/bin/logger $script_type

also, type

logger "test"

at the command line (console or SSH access - no GUI) and have a look at the main System log ^^

Now, test.
When this file gets used, it will log.

tienpro113396

@Gertjan great tips. And I dont have "test" on StatusSystem\Logs\OpenVPN :((
Change to that, right?

if [ "$script_type" = "client-connect" ]; then
        if [ -f /tmp/$common_name ]; then
                /usr/bin/logger "test"
                /usr/bin/logger $script_type
                /bin/cat /tmp/$common_name > $1
                /bin/rm /tmp/$common_name
                /bin/echo "$(date +'%b %d %H:%M:%S') pfSense2 openvpn: user '${common_name}' authenticated" >> /var/log/openvpn.log
                /bin/echo "$(date +'%b %d %H:%M:%S') pfSense2 openvpn: user '${common_name}' authenticated" >> /home/tien.tran/testlog.log
        fi
elif [ "$script_type" = "client-disconnect" ]; then
        command="/sbin/pfctl -a 'openvpn/$common_name' -F rules"
        eval $command
        /sbin/pfctl -k $ifconfig_pool_remote_ip
        /sbin/pfctl -K $ifconfig_pool_remote_ip
        /bin/echo "$(date +'%b %d %H:%M:%S') pfSense2 openvpn: user '${common_name}' disconnected" >> /var/log/openvpn.log
fi

exit 0

biggsy

There was also "explicit-exit-notify" and automatic timeouts.

You can see some discussion in Redmine: issue 9085

Gertjan

@tienpro113396 said in OpenVPN no authenticated log generated:

And I dont have "test" on StatusSystem\Logs\OpenVPN :((

That's right.
the "logger" command will log in the System log (as said above).

biggsy

... and Redmine 9108

Gertjan

That redmine ticket was closed because .... the (your) issue isn't an issue ;)

tienpro113396

@biggsy I added "explicit-exit-notify 3" before and got some error so I delete it :v

tienpro113396

@Gertjan Thanks! I see that log.I will check more about that

biggsy

@Gertjan

True - but there was some discussion that others might find interesting or useful.

noplan

hey all

does it really make sense to do scripting in core pfS files ?

i dont think so.

if you want to receive emails when vpn-clients log in or out
use the method described in this post

https://forum.netgate.com/topic/151351/email-notification-openvpn-client-connect-common-name/26

as far as some others are concerned if you read the post from top to bottom
you can use a nice working tool

truely mentioned
as @Gertjan mentioned you or someone can aff logger to the script to get more information into the log

the main question still remains
does it really make sense to do scripting in core pfS files ?

biggsy

@noplan said:

does it really make sense to do scripting in core pfS files ?

No, it's not ideal to modify the core files. However, did you see the note in 9085 about conflicting scripts?

Putting client-connect and client-disconnect entries in Custom options caused /usr/local/sbin/openvpn.attributes.sh to be overridden. (I wonder if users of the solution in the other topic are seeing that.)

As openvpn.attributes.sh appears to be cleaning up pf table entries on client-disconnect, it didn't seem wise to override it. Adding the two logger lines to it seemed to be the safer, if not the cleanest, way.

noplan

@Gertjan
how can they (.sh scripts) can make me coffee .... /me pretty interested ;)
but for real dyin from coffee overdose not the best way to leave this world ...

noplan

@biggsy

help me out, still early mornin here,
i get the concern at client-connect (point taken)
i dont get it at client-disconnect

so addin the logger lines to the scripts (connect and disconnect) will be a task for today.

i'll keep u posted on this one.

Gertjan

@noplan said in OpenVPN no authenticated log generated:

how can they (.sh scripts) can make me coffee .... /me pretty interested ;)

Scripts build cars, fly planes and launch nukes.
And coffee should be a problem ?

biggsy

@noplan said in OpenVPN no authenticated log generated:

@biggsy

help me out, still early mornin here,
i get the concern at client-connect (point taken)
i dont get it at client-disconnect

I'm just saying that the solution offered in the other topic (using user-written client-connect and client-disconnect scripts in Custom options) will conflict with and prevent the openvpn.attributes.sh script from running.

Because openvpn.attributes.sh uses pfctl to kill state entries when a client disconnects, I think it's better to just add in the logger calls and let the rest of the script do its thing.

By modifying openvpn.attributes.sh, though, you are changing one of the core pfSense files.