WebSVN – web_pages – Diff – /trunk/totp_opnsense/opnsense-totp-ovpn-export

 #     Added a lock file to not allow the script to run if it is already running. If we can not
 #       get an exclusive lock on $lockFile in $lockRetryTime*$lockRetries seconds, script will abort
 #     Added both the full path to the data directories as well as the relative, to help
 #       the web site (relative) and the script (full path, even if we're running from a different)
 #       location to work easily (less code)
+#  v1.1.0 2026-01-04 RWR
+#     Removed hardcoded additionalOvpnStrings variable
+#     Added support for formats hash in router configuration
+#     Modified makeVPNConfigFile to accept filename template with ROUTER and USER placeholders
+#     Added support for multiple OVPN files per user based on formats configuration
+#     Formats structure allows specifying filename and additionalStrings per format
+#     Expands \n in additionalStrings to actual newlines in config files
 use strict;
 use warnings;
 # use libraries from the directory this script is in
 use GD::Barcode::QRcode; # for creating the QR code images
 use MIME::Base64 qw( decode_base64 ); # for decoding the ovpn file returned from the API
 use File::Path qw( make_path ); # for creating directories
 use Fcntl qw(:flock); # Import locking constants
-our $VERSION = '1.0.1';
+our $VERSION = '1.1.0';
 # Check if running as root
 if ($> != 0) {
    die "Error: This script must be run as root.\n";
+}
 my $usersFile = $scriptDir . '/users.json';
 my $qrLocation =  './qrcodes';
 my $ovpnFileLocation =  './openvpn_configs';
 # size of the QR code modules, basically a magnification factor
 my $moduleSize = 10;
-# strings to add to the ovpn file if not already present
-my $additionalOvpnStrings = "static-challenge 'Enter Auth Code' 0\nauth-nocache\n";
 # using a lock file to ensure script does not run while another request has it running
 my $lockFile = '/tmp/opnsense.lock';
 my $lockRetryTime = 10; # number of seconds between subsequent tries for a lock
 my $lockRetries = 6; # number of times we will attempt to get a lock before failing
+}
 #-----------------------------
 # makeVPNConfigFile: Creates a VPN configuration file for the user
 # $contents - reference to the hash containing the 'content' key with base64 encoded ovpn file
-# $routerName - name of the router (used in filename)
+# $routerName - name of the router (used in filename template replacement)
-# $userName - name of the user (used in filename)
+# $userName - name of the user (used in filename template replacement)
 # $ovpnLocation - The relative path to the output directory
 # $absDir - The absolute path to the output directory
+# $filenameTemplate - template for filename with ROUTER and USER placeholders
-# $additionalOvpnStrings - additional strings to add to the ovpn file if not already present
+# $additionalOvpnStrings - additional strings to add to the ovpn file, \n will be expanded to newlines
 # returns the filename of the created ovpn file
 #-----------------------------
 sub makeVPNConfigFile {
-   my ($contents, $routerName, $userName, $ovpnLocation, $absDir, $additionalOvpnStrings) = @_;
+   my ($contents, $routerName, $userName, $ovpnLocation, $absDir, $filenameTemplate, $additionalOvpnStrings) = @_;
    return '' unless $contents && $contents->{'content'};
+   # Replace ROUTER and USER in the filename template
-   my $fileName = ($routerName ? $routerName . '_' : '' ) . $userName . '.ovpn';
+   my $fileName = $filenameTemplate;
+   $fileName =~ s/ROUTER/$routerName/g;
+   $fileName =~ s/USER/$userName/g;
    $contents->{'content'} = decode_base64($contents->{'content'});
    $contents->{'content'} .= "\n";
    $contents->{'content'} =~ s/(\r?\n)+/\n/g; # normalize line endings
    my $comment = '';
    if ( $contents->{'content'} !~ /# Added by loadOpnSense.pl/ ) {
       $comment = "# Added by loadOpnSense.pl\n";
+   }
+   # Expand \n to actual newlines in additionalOvpnStrings
+   $additionalOvpnStrings =~ s/\\n/\n/g if $additionalOvpnStrings;
-   foreach my $string ( split( /\n/, $additionalOvpnStrings ) ) {
+   foreach my $string ( split( /\n/, $additionalOvpnStrings || '' ) ) {
+      next if $string eq '';
-      unless ( $contents->{'content'} =~ /\$string/ ) {
+      unless ( $contents->{'content'} =~ /\Q$string\E/ ) {
          $contents->{'content'} .= "$comment$string\n";
          $comment = ''; # only add comment once
+      }
+   }
    # This allows us to retain the relative file path for storage, but ensuring we write the file to
 # get the router name from the command line
 my $router = shift @ARGV or die "Usage: $0 <router_name>\n";
 # Load existing configuration or initialize a new one
 my $config = &loadConfig($configFile, $router );
 die "Configuration for router $router not found in $configFile\n" unless $config && ref($config) eq 'HASH';
+# die Dumper( $config ) . "\n";
 # load the users file. We will update the entry for this router
 my $users = &loadUsers( $usersFile );
 # if there is no entry for this router, create an empty one
             $users->{$router}->{'qrLocation'},
             $users->{$router}->{'qrLocationFileystem'}
             ) :
       '';
-   # Create the VPN configuration file, if it exists. If multiple certs, only create the first one
+   # Create the VPN configuration file(s), if they exist. If multiple certs, only use the first one
    # warn user if there are multiple certs
    if ( scalar(@{$users->{$router}->{'users'}->{$entry}->{'certs'}}) > 1 ) {
       warn "$entry has multiple certs, using first one only\n";
+   }
    my $cert = $opnsense->getVpnConfig( $users->{$router}->{'users'}->{$entry}->{'certs'}->[0] );
    if ( !$cert || ref($cert) ne 'HASH' || !exists $cert->{'content'} ) {
       warn "Could not get VPN configuration for $entry, cert $users->{$router}->{'users'}->{$entry}->{'certs'}->[0]\n";
       next;
+   }
+   # Process formats to create multiple OVPN files if formats are defined
+   my @ovpnFiles = ();
+   my $formats = $config->{'formats'};
+   # die Dumper($config) . "\n";
+   # die Dumper($formats) . "\n";
+   if ( $formats && ref($formats) eq 'HASH' && keys %$formats ) {
+      # Iterate through each format
+      foreach my $formatName ( keys %$formats ) {
+         my $format = $formats->{$formatName};
+         next unless ref($format) eq 'HASH';
+         my $filename = $format->{'filename'} || '';
+         my $additionalStrings = $format->{'additionalStrings'} || '';
+         next if $filename eq '';
+         my $ovpnFile = &makeVPNConfigFile(
+            $cert,
+            $router,
+            $entry,
+            $users->{$router}->{'ovpnLocation'},
-   $users->{$router}->{'users'}->{$entry}->{'ovpnFile'} =
+            $users->{$router}->{'ovpnLocationFileSystem'},
+            $filename,
+            $additionalStrings
+         );
+         push @ovpnFiles, $ovpnFile if $ovpnFile;
+      }
+   }
+   # If no formats defined or no files created, create a default file
+   if ( scalar(@ovpnFiles) == 0 ) {
+      my $defaultFilename = $router . '_' . $entry . '.ovpn';
-      &makeVPNConfigFile(
+      my $ovpnFile = &makeVPNConfigFile(
          $cert,
          $router,
          $entry,
          $users->{$router}->{'ovpnLocation'},
          $users->{$router}->{'ovpnLocationFileSystem'},
-         $additionalOvpnStrings );
+         $defaultFilename,
+         "static-challenge 'Enter Auth Code' 0\nauth-nocache"
+      );
+      push @ovpnFiles, $ovpnFile if $ovpnFile;
+   }
+   # Store as array if multiple files, or single string if only one
+   $users->{$router}->{'users'}->{$entry}->{'ovpnFile'} =
+      scalar(@ovpnFiles) > 1 ? \@ovpnFiles : $ovpnFiles[0];
+}
 # update the timestamp for the current router
 $users->{$router}->{'lastUpdate'} = time;
 # save the users file
 &saveUsers( $usersFile, $users );

Subversion Repositories web_pages

(root)/trunk/totp_opnsense/opnsense-totp-ovpn-export – Rev 18 → 20