(legacy/ldap) trashed almost all old ldap code and made it less obscure..

When a user needs to use the web configurator, import the the user from the remote ldap server using "import users" on system_usermanager.php
For backward compatibility purposes ldap_backed still can authenticate without a local user, although the web config isn't usable then.
(this always costs an extra query to determine the distinguished name of the user)
We may need to consider if "authenticate only" should be a bit more explicit to the user, or choose to always import users into OPNsense....

src/etc/inc/authgui.inc

@@ -138,28 +138,15 @@ function getPrivPages(& $entry, & $allowed_pages) {
 function getAllowedPages($username) {
 	global $config, $_SESSION;
 
-	if (!function_exists("ldap_connect"))
-		return;
-
 	$allowed_pages = array();
 	$allowed_groups = array();
 
-	if (isset($config['system']['webgui']['authmode'])) {
-		$authcfg = auth_get_authserver($config['system']['webgui']['authmode']);
-	} else {
-		$authcfg['type'] = 'local';
-	}
-	// obtain ldap groups if we are in ldap mode
-	if ($authcfg['type'] == "ldap")
-		$allowed_groups = @ldap_get_groups($username, $authcfg);
-	else {
 	// search for a local user by name
 	$local_user = getUserEntry($username);
 	getPrivPages($local_user, $allowed_pages);
 
 	// obtain local groups if we have a local user
 	$allowed_groups = local_user_get_groups($local_user);
-	}
 
 	// build a list of allowed pages
 	if (is_array($config['system']['group']) && is_array($allowed_groups)) {
@@ -204,6 +191,7 @@ function session_auth() {
 		} else {
 			$authcfg = null;
 		}
+		// authenticate using config settings, or local if failed
 		if (authenticate_user($_POST['usernamefld'], $_POST['passwordfld'], $authcfg) ||
 		    authenticate_user($_POST['usernamefld'], $_POST['passwordfld'])) {
 			// Generate a new id to avoid session fixation

src/www/head.inc

@@ -41,6 +41,9 @@ $pagetitle = gentitle( $pgtitle );
 		<!-- Favicon -->
 		<link href="/themes/<?=$g['theme'];?>/assets/images/favicon.png" rel="shortcut icon">
 
+		<!-- Font awesome -->
+		<link rel="stylesheet" href="/ui/css/font-awesome.min.css">
+
 		<!--[if lt IE 9]><script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.2/html5shiv.min.js"></script><![endif]-->
 
 

src/www/system_usermanager.php

@@ -77,6 +77,9 @@ function get_user_privdesc(& $user)
 // start admin user code
 $pgtitle = array(gettext("System"),gettext("User Manager"));
 
+// find web ui authentication method
+$authcfg_type = auth_get_authserver($config['system']['webgui']['authmode'])['type'];
+
 $input_errors = array();
 
 if (isset($_POST['userid']) && is_numericint($_POST['userid'])) {
@@ -97,6 +100,7 @@ if (isset($_SERVER['HTTP_REFERER'])) {
 
 if (isset($id) && $a_user[$id]) {
     $pconfig['usernamefld'] = $a_user[$id]['name'];
+    $pconfig['user_dn'] = isset($a_user[$id]['user_dn']) ? $a_user[$id]['user_dn'] : null;
     $pconfig['descr'] = $a_user[$id]['descr'];
     $pconfig['expires'] = $a_user[$id]['expires'];
     $pconfig['groups'] = local_user_get_groups($a_user[$id]);
@@ -457,6 +461,15 @@ function sshkeyClicked(obj) {
 		document.getElementById("sshkeychck").style.display="";
 	}
 }
+
+function import_ldap_users() {
+  url="system_usermanager_import_ldap.php";
+  var oWin = window.open(url,"OPNsense","width=620,height=400,top=150,left=150");
+  if (oWin==null || typeof(oWin)=="undefined") {
+    alert("<?=gettext('Popup blocker detected.  Action aborted.');?>");
+  }
+}
+
 //]]>
 </script>
 
@@ -529,6 +542,16 @@ function sshkeyClicked(obj) {
                                 <input name="oldusername" type="hidden" id="oldusername" value="<?=htmlspecialchars($pconfig['usernamefld']);?>" />
                             </td>
                         </tr>
+<?php if (!empty($pconfig['user_dn'])):
+?>
+                        <tr>
+                            <td width="22%" valign="top" class="vncellreq"><?=gettext("User distinguished name");?></td>
+                            <td width="78%" class="vtable">
+                                <input name="user_dn" type="text" class="formfld user" id="user_dn" size="20" maxlength="16" value="<?=htmlspecialchars($pconfig['user_dn']);?>"/ readonly>
+                            </td>
+                        </tr>
+<?php endif;
+?>
                         <tr>
                             <td width="22%" valign="top" class="vncellreq" rowspan="2"><?=gettext("Password");?></td>
                             <td width="78%" class="vtable">
@@ -948,6 +971,16 @@ endif;?>
 										onclick="document.getElementById('act').value='<?php echo "new";?>';"
 										title="<?=gettext("add user");?>" data-toggle="tooltip" data-placement="left" ><span class="glyphicon glyphicon-plus"></span>
 									</button>
+<?php if ($authcfg_type == 'ldap') :
+?>
+                  <button type="submit" name="import"
+                          class="btn btn-default btn-xs"
+                          onclick="import_ldap_users();"
+                          title="<?=gettext("import users")?>">
+                      <i class="fa fa-cloud-download"></i>
+                  </button>
+<?php endif;
+?>
 								</td>
 							</tr>
 							<tr>

src/www/system_usermanager_import_ldap.php

+<?php
+/*
+	Copyright (C) 2014-2015 Deciso B.V.
+	Copyright (C) 2007 Scott Ullrich <sullrich@gmail.com>
+	All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+*/
+
+require_once("guiconfig.inc");
+require_once("auth.inc");
+
+function add_local_user($username, $userdn) {
+  global $config;
+  foreach ($config['system']['user'] as &$user) {
+      if ($user['name'] == $username && $user['name'] != 'root') {
+        // link local user to remote server by updating user_dn
+        $user['user_dn'] = $userdn;
+        return;
+      }
+  }
+  // new user, add
+  $new_user = array();
+  $new_user['scope'] = 'user';
+  $new_user['name'] = $username;
+  $new_user['user_dn'] = $userdn;
+  $new_user['uid'] = $config['system']['nextuid']++;
+  $config['system']['user'][] = $new_user;
+}
+
+global $config;
+// attributes used in page
+$ldap_users= array();
+$ldap_is_connected = false;
+$exit_form = false;
+
+// find gui auth server
+$authcfg = auth_get_authserver($config['system']['webgui']['authmode']);
+
+if ($authcfg['type'] == 'ldap') {
+  // setup peer ca
+  ldap_setup_caenv($authcfg);
+  // connect to ldap server
+  $ldap_auth = new OPNsense\Auth\LDAP($authcfg['ldap_basedn'], $authcfg['ldap_protver']);
+  $ldap_is_connected = $ldap_auth->connect($authcfg['ldap_full_url']
+                      , $authcfg['ldap_binddn']
+                      , $authcfg['ldap_bindpw']
+                    );
+  if ($ldap_is_connected) {
+    // collect list of current ldap users from config
+    $confDNs = array();
+    foreach ($config['system']['user'] as $confUser) {
+     if (!empty($confUser['user_dn'])) {
+       $confDNs[] = trim($confUser['user_dn']);
+     }
+    }
+
+    // search ldap
+    $result = $ldap_auth->searchUsers("*"
+              , $authcfg['ldap_attr_user']
+              , $authcfg['ldap_extended_query']
+            );
+
+    // actual form action, either save new accounts or list missing
+    if ($_SERVER['REQUEST_METHOD'] === 'POST') {
+      // create selected accounts
+      $exit_form = true;
+      if (isset($_POST['user_dn'])) {
+        $update_count = 0;
+        foreach ($result as $ldap_user ) {
+          foreach ($_POST['user_dn'] as $userDN) {
+            if ($userDN == $ldap_user['dn'] && !in_array($ldap_user['dn'], $confDNs)) {
+              add_local_user($ldap_user['name'] , $ldap_user['dn']);
+              $update_count++;
+            }
+          }
+          if ($update_count > 0){
+            // write config when changed
+            write_config();
+          }
+        }
+      }
+    } else {
+      // list all missing accounts
+      foreach ($result as $ldap_user ) {
+        if (!in_array($ldap_user['dn'], $confDNs)) {
+          $ldap_users[$ldap_user['name']] = $ldap_user['dn'];
+        }
+      }
+    }
+  }
+}
+
+include('head.inc');
+?>
+
+ <body>
+<?php if ($exit_form) :
+?>
+	<script type="text/javascript">
+    // exit form and reload parent after save
+    window.opener.location.href = window.opener.location.href;
+  	window.close();
+  </script>
+<?php elseif (!$ldap_is_connected) :
+?>
+	<p><?=gettext("Could not connect to the LDAP server. Please check your LDAP configuration.");?></p>
+	<input type='button' class="btn btn-default" value='<?=gettext("Close"); ?>' onClick="window.close();">
+<?php
+else :
+?>
+<form method="post">
+	<table class="table table-striped">
+		<tbody>
+			<tr>
+			<th colspan="3">
+				<?=gettext("Please select users to import:");?>
+			</th>
+			</tr>
+			<?php foreach ($ldap_users as $username => $userDN) :
+?>
+        <tr><td><?=$username?></td><td><?=$userDN?></td><td> <input type='checkbox' value="<?=$userDN?>" id='user_dn' name='user_dn[]'>  </td></tr>
+      <?php endforeach;
+?>
+			<tr>
+				<td align="left" colspan="3">
+					<input type='submit' class="btn btn-primary" value='<?=gettext("Save");?>'>
+				</td>
+			</tr>
+		</tbody>
+	</table>
+  </form>
+<?php
+endif; ?>
+<!-- bootstrap script -->
+<script type="text/javascript" src="/javascript/bootstrap.min.js"></script>
+<!-- Fancy select with search options -->
+<script type="text/javascript" src="/javascript/bootstrap-select.min.js"></script>
+ </body>
+</html>