sarg - package version 0.4 with user tab, ldap search and report limits

1 files changed, 219 insertions, 0 deletions

diff --git a/config/sarg/sarg_users.xml b/config/sarg/sarg_users.xml
new file mode 100644
index 00000000..7019af43
--- /dev/null
+++ b/config/sarg/sarg_users.xml
@@ -0,0 +1,219 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE packagegui SYSTEM "./schema/packages.dtd">
+<?xml-stylesheet type="text/xsl" href="./xsl/package.xsl"?>
+<packagegui>
+	<copyright>
+	<![CDATA[
+/* $Id$ */
+/* ========================================================================== */
+/*
+    sarg_users.xml
+    part of the sarg for pfSense
+    Copyright (C) 2012 Marcello Coutinho
+
+    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.
+                                                                              */
+/* ========================================================================== */
+	]]>
+	</copyright>
+	<description>Describe your package here</description>
+	<requirements>Describe your package requirements here</requirements>
+	<faq>Currently there are no FAQ items provided.</faq>
+	<name>sarguser</name>
+	<version>1.0</version>
+	<title>Status: Sarg User Settings</title>
+	<include_file>/usr/local/pkg/sarg.inc</include_file>
+	<tabs>
+		<tab>
+			<text>General</text>
+			<url>/pkg_edit.php?xml=sarg.xml&amp;id=0</url>
+		</tab>
+		<tab>
+			<text>Users</text>
+			<url>/pkg_edit.php?xml=sarg_users.xml&amp;id=0</url>
+			<active/>
+		</tab>
+		<tab>
+			<text>Schedule</text>
+			<url>/pkg.php?xml=sarg_schedule.xml&amp;id=0</url>
+		</tab>
+		<tab>
+			<text>View Report</text>
+			<url>/sarg_reports.php</url>
+		</tab>
+		<tab>
+			<text>Realtime</text>
+			<url>/sarg_realtime.php</url>
+		</tab>
+		<tab>
+			<text>XMLRPC Sync</text>
+			<url>/pkg_edit.php?xml=sarg_sync.xml&amp;id=0</url>
+		</tab>
+		<tab>
+			<text>Help</text>
+			<url>/sarg_about.php</url>
+		</tab>
+</tabs>
+	<fields>
+		<field>
+			<name>User Settings</name>
+			<type>listtopic</type>
+		</field>
+		<field>
+			<fielddescr>User Sort Field</fielddescr>
+			<fieldname>user_sort_field</fieldname>
+			<description><![CDATA[Sort field for the User Report.]]></description>
+	    	<type>select</type>
+ 				<options>
+ 				<option><name>BYTES(default)</name><value>BYTES</value></option>
+ 				<option><name>SITE normal</name><value>SITE</value></option>
+ 				<option><name>CONNECT</name><value>CONNECT</value></option>
+ 				<option><name>TIME</name><value>TIME</value></option>
+ 				</options>
+		</field>
+		<field>
+		 	<fielddescr>Ntlm User Format</fielddescr>
+			<fieldname>ntlm_user_format</fieldname>
+		 	<description><![CDATA[NTLM users format]]></description>
+			<type>select</type>
+			<options>
+			<option><name>domainname+username (default)</name><value>domainname+username</value></option>
+			<option><name>username</name><value>username</value></option>
+			</options>
+		</field>
+		<field>
+			<fielddescr>Exclude users</fielddescr>
+			<fieldname>exclude_userlist</fieldname>
+			<description><![CDATA[Users within the file will be excluded from reports.<br>
+									You can use indexonly to have only index.html file.<br>
+									<strong>Format: one user per line.</strong>]]></description>
+			<type>textarea</type>
+			<cols>70</cols>
+			<rows>10</rows>
+			<encoding>base64</encoding>
+		</field>
+		<field>
+			<fielddescr>Include users</fielddescr>
+			<fieldname>include_userlist</fieldname>
+			<description><![CDATA[Reports will be generated only for listed users.<br> 
+								<strong>Format: user1:user2:...:usern</strong>]]></description>
+			<type>input</type>
+			<size>70</size>
+		</field>
+		<field>
+			<fielddescr>Users association</fielddescr>
+			<fieldname>usertab</fieldname>
+			<description><![CDATA[You can change the "userid" or the "ip address" to be a real user name on the reports.<br>
+									If resolve_ip is active, the ip address is resolved before being looked up into this file.<br>
+									That is, if you want to map the ip address, be sure to set resolv_ip to no or the resolved name will be looked into the file instead of the ip address.<br>
+									Note that it can be used to resolve any ip address known to the dns and then map the unresolved ip addresses to a name found in the usertab file.<br>
+									<strong>Table syntax: userid name   or   ip address name</strong><br>
+									Eg:<br>SirIsaac Isaac Newton<br>
+									vinci Leonardo da Vinci<br>
+									192.168.10.1 Karol Wojtyla]]></description>
+			<type>textarea</type>
+			<cols>70</cols>
+			<rows>10</rows>
+			<encoding>base64</encoding>
+		</field>
+		<field>
+			<name>Ldap Settings</name>
+			<type>listtopic</type>
+		</field>
+		<field>
+			<fielddescr>Enable LDAP search</fielddescr>
+			<fieldname>ldap_enable</fieldname>
+			<description><![CDATA[Enable LDAP search for username replacement based on active directory info.<br>
+							This option is usefull to show full usernames in sarg reports instead of user logins.]]></description>
+			<type>checkbox</type>
+		</field>
+		<field>
+			<fielddescr>LDAP Hostname</fielddescr>
+			<fieldname>ldap_host</fieldname>
+			<description><![CDATA[FQDN or IP address of host with LDAP service or AD DC]]></description>
+			<type>input</type>
+			<size>60</size>
+		</field>
+		<field>
+			<fielddescr>LDAP Port</fielddescr>
+			<fieldname>ldap_port</fieldname>
+			<description><![CDATA[LDAP service port number.<br>Default is 389]]></description>
+			<type>input</type>
+			<size>10</size>
+		</field>
+		<field>
+			<fielddescr>LDAP Bind DN</fielddescr>
+			<fieldname>ldap_bind_dn</fieldname>
+			<description><![CDATA[DN of LDAP user, who is authorized to read user's names from LDAP base.<br>
+								Sample: CN=username,OU=group,DC=mydomain,DC=com<br>]]></description>
+			<type>input</type>
+			<size>60</size>
+		</field>
+		<field>
+			<fielddescr>LDAP Bind Password</fielddescr>
+			<fieldname>ldap_bind_pw</fieldname>
+			<description><![CDATA[LDAPBindPW secret Password of DN, who is authorized to read user's names from LDAP base.]]></description>
+			<type>password</type>
+			<size>10</size>
+		</field>
+		<field>
+			<fielddescr>LDAP Base Search</fielddescr>
+			<fieldname>ldap_base_search</fieldname>
+			<description><![CDATA[LDAP search base.<br>
+							Sample: OU=users,DC=mydomain,DC=com]]></description>
+			<type>input</type>
+			<size>60</size>
+		</field>
+		<field>
+			<fielddescr>LDAP filter Search</fielddescr>
+			<fieldname>ldap_filter_search</fieldname>
+			<description><![CDATA[LDAPFilterSearch (uid=%s)<br>
+							User search filter by user's logins in LDAP. First founded record will be used.<br>
+							%s - will be changed to userlogins from access.log file filter string can have up to 5 '%s' tags.<br>
+							Default value is '(uid=%s)']]></description>
+			<type>input</type>
+			<size>60</size>
+		</field>
+		<field>
+			<fielddescr>LDAP Target Attribute</fielddescr>
+			<fieldname>ldap_target_attr</fieldname>
+			<description><![CDATA[Name of the attribute containing a name of the user<br>
+									Default value is 'cn']]></description>
+			<type>input</type>
+			<size>60</size>
+		</field>
+	</fields>
+	<custom_php_install_command>
+	</custom_php_install_command>
+	<custom_php_deinstall_command>
+	</custom_php_deinstall_command>
+	<custom_php_validation_command>
+		sarg_validate_input($_POST, &amp;$input_errors);
+	</custom_php_validation_command>	
+	<custom_php_resync_config_command>
+		sync_package_sarg();
+	</custom_php_resync_config_command>
+</packagegui>