Some fixes to the automation and an updated manual

- made it easier to provide null values if the user would want to specify the n+1th parameter whilst leaving the nth on null

app/Controller/AttributesController.php

@@ -1098,6 +1098,10 @@ class AttributesController extends AppController {
 	// && - you can use && between two search values to put a logical OR between them. for value, 1.1.1.1&&2.2.2.2 would find attributes with the value being either of the two.
 	// ! - you can negate a search term. For example: google.com&&!mail would search for all attributes with value google.com but not ones that include mail. www.google.com would get returned, mail.google.com wouldn't.
 	public function restSearch($key='download', $value=null, $type=null, $category=null, $org=null, $tags=null) {
+		if ($value === 'null') $value = null;
+		if ($type === 'null') $type = null;
+		if ($category === 'null') $category = null;
+		if ($org === 'null') $org = null;
 		if ($key!=null && $key!='download') {
 			$user = $this->checkAuthUser($key);
 		} else {

app/Controller/EventsController.php

@@ -1192,7 +1192,8 @@ class EventsController extends AppController {
 	}
 
 	public function xml($key, $eventid=null, $withAttachment = false, $tags = '') {
-		if ($eventid === 'null') $eventid=null;
+		if ($eventid === 'null' || $eventid ==='false') $eventid=null;
+		if ($withAttachment === 'null' || $withAttachment ==='false') $withAttachment = false;
 		if ($key != 'download') {
 			// check if the key is valid -> search for users based on key
 			$user = $this->checkAuthUser($key);
@@ -1250,12 +1251,14 @@ class EventsController extends AppController {
 		}
 		if (!empty($orgFromFetch)) $org = $orgFromFetch;
 		else $org = $this->_checkOrg();
-		$results = $this->Event->fetchEvent($eventid, $idList, $org, $isSiteAdmin, $tags);
+		$results = $this->Event->fetchEvent($eventid, $idList, $org, $isSiteAdmin, null, $tags);
 		return $results;
 	}
 
 	public function nids($format = 'suricata', $key = '', $id = null, $continue = false, $tags = '') {
-
+		if ($id === 'null') $id = null;
+		if ($continue === 'false') $continue = false;
+		if ($continue === 'true') $continue = true;
 		// backwards compatibility, swap key and format
 		if ($format != 'snort' && $format != 'suricata') {
 			$key = $format;
@@ -1761,7 +1764,11 @@ class EventsController extends AppController {
 	// the last 4 fields accept the following operators:
 	// && - you can use && between two search values to put a logical OR between them. for value, 1.1.1.1&&2.2.2.2 would find attributes with the value being either of the two.
 	// ! - you can negate a search term. For example: google.com&&!mail would search for all attributes with value google.com but not ones that include mail. www.google.com would get returned, mail.google.com wouldn't.
-	public function restSearch($key=null, $value=null, $type=null, $category=null, $org=null) {
+	public function restSearch($key=null, $value=null, $type=null, $category=null, $org=null, $tags = '') {
+		if ($value === 'null') $value = null;
+		if ($type === 'null') $type = null;
+		if ($category === 'null') $category = null;
+		if ($org === 'null') $org = null;
 		if ($key!=null && $key!='download') {
 			$user = $this->checkAuthUser($key);
 		} else {
@@ -1781,7 +1788,6 @@ class EventsController extends AppController {
 		// add the values as specified in the 2nd parameter to the conditions
 		$values = explode('&&', $value);
 		$parameters = array('value', 'type', 'category', 'org');
-
 		foreach ($parameters as $k => $param) {
 			if (isset(${$parameters[$k]})) {
 				$elements = explode('&&', ${$parameters[$k]});
@@ -1828,6 +1834,23 @@ class EventsController extends AppController {
 			$subcondition['OR'][] = array('Event.org' => $user['User']['org']);
 			array_push($conditions['AND'], $subcondition);
 		}
+		
+		// If we sent any tags along, load the associated tag names for each attribute
+		if ($tags !== '') {
+			$args = $this->Event->Attribute->dissectArgs($tags);
+			$this->loadModel('Tag');
+			$tagArray = $this->Tag->fetchEventTagIds($args[0], $args[1]);
+			$temp = array();
+			foreach ($tagArray[0] as $accepted) {
+				$temp['OR'][] = array('Event.id' => $accepted);
+			}
+			$conditions['AND'][] = $temp;
+			$temp = array();
+			foreach ($tagArray[1] as $rejected) {
+				$temp['AND'][] = array('Event.id !=' => $rejected);
+			}
+			$conditions['AND'][] = $temp;
+		}
 
 		$params = array(
 			'conditions' => $conditions,

app/View/Events/automation.ctp

@@ -17,7 +17,7 @@ You can <?php echo $this->Html->link('reset', array('controller' => 'users', 'ac
 <p>If you only want to fetch a specific event append the eventid number:</p>
 <pre><?php echo Configure::read('MISP.baseurl');?>/events/xml/download/1</pre>
 <p>The xml download also accepts two additional (optional) parameters: a boolean field that determines whether attachments should be encoded and a second parameter that controls the eligible tags. To include a tag in the results just write its names into this parameter. To exclude a tag prepend it with a '!'. You can also chain several tag commands together with the '&&' operator. For example, to include tag1 and tag2 but exclude tag3 you would use:</p>
-<pre><?php echo Configure::read('MISP.baseurl');?>/events/xml/download/0/</pre>
+<pre><?php echo Configure::read('MISP.baseurl');?>/events/xml/download/null/true/tag1&&tag2&&!tag3</pre>
 <p>Also check out the <?php echo $this->Html->link(__('User Guide', true), array('controller' => 'pages', 'action' => 'display', 'using_the_system', '#' => 'rest')); ?> to read about the REST API.</p>
 <p></p>
 
@@ -26,7 +26,8 @@ You can <?php echo $this->Html->link('reset', array('controller' => 'users', 'ac
 <p>You can configure your tools to automatically download the following file:</p>
 <pre><?php echo Configure::read('MISP.baseurl');?>/events/nids/suricata/download
 <?php echo Configure::read('MISP.baseurl');?>/events/nids/snort/download</pre>
-<p></p>
+<p>In addition to the above mentioned, the NIDS exports can accept several additional parameters: an event ID to only create the signature based on a single event (null will still include every event), a boolean flag that determines whether it should be a standalone file with all the descriptions at the start (false) or whether it should just be the signature lines (true). The last parameter is the tagging syntax, as described for the XML export. An example for a suricata export for all events excluding those tagged tag1, without all of the commented information at the start of the file would look like this:</p>
+<pre><?php echo Configure::read('MISP.baseurl');?>/events/nids/suricata/download/null/true/!tag1</pre>
 <p>Administration is able to maintain a white-list containing host, domain name and IP numbers to exclude from the NIDS export.</p>
 
 <h3>Hash database export</h3>
@@ -36,7 +37,8 @@ You can <?php echo $this->Html->link('reset', array('controller' => 'users', 'ac
 <pre><?php echo Configure::read('MISP.baseurl');?>/events/hids/md5/download</pre>
 <h4>sha1</h4>
 <pre><?php echo Configure::read('MISP.baseurl');?>/events/hids/sha1/download</pre>
-<p></p>
+<p>You can also use the tag syntax similar to the XML import. For example, to only show sha1 values from events tagged tag1, use:</p>
+<pre><?php echo Configure::read('MISP.baseurl');?>/events/hids/sha1/download/tag1</pre>
 
 <h3>Text export</h3>
 <p>An automatic export of all attributes of a specific type to a plain text file.</p>
@@ -48,27 +50,32 @@ foreach ($sigTypes as $sigType) {
 }
 ?>
 </pre>
-<p></p>
+<p>To restrict the results by tags, use the usual syntax. To get ip-src values from events tagged tag1 but not tag2 use:</p>
+<pre>
+<?php 
+echo Configure::read('MISP.baseurl').'/attributes/text/download/ip-src/tag1&&!tag2';
+?>
+</pre>
 
 <h3>RESTful searches with XML result export</h3>
 <p>It is possible to search the database for attributes based on a list of criteria. </p>
 <p>To return an event with all of its attributes, relations, shadowAttributes, use the following syntax:</p>
 <pre>
 <?php
-	echo Configure::read('MISP.baseurl').'/events/restSearch/download/[value]/[type]/[category]/[org]';
+	echo Configure::read('MISP.baseurl').'/events/restSearch/download/[value]/[type]/[category]/[org]/[tag]';
 ?>
 </pre>
 <p>To just return a list of attributes, use the following syntax:</p>
 <pre>
 <?php
-	echo Configure::read('MISP.baseurl').'/attributes/restSearch/download/[value]/[type]/[category]/[org]';
+	echo Configure::read('MISP.baseurl').'/attributes/restSearch/download/[value]/[type]/[category]/[org]/[tag]';
 ?>
 </pre>
 <p>value, type, category and org are optional. It is possible to search for several terms in each category by joining them with the '&amp;&amp;' operator. It is also possible to negate a term with the '!' operator.
-For example, in order to search for all attributes created by your organisation that contain 192.168 or 127.0 but not 0.1 and are of the type ip-src use the following syntax:</p>
+For example, in order to search for all attributes created by your organisation that contain 192.168 or 127.0 but not 0.1 and are of the type ip-src, excluding the events that were tagged tag1 use the following syntax:</p>
 <pre>
 <?php
-	echo Configure::read('MISP.baseurl').'/attributes/restSearch/download/192.168&&127.0&&!0.1/ip-src/null/' . $me['org'];
+	echo Configure::read('MISP.baseurl').'/attributes/restSearch/download/192.168&&127.0&&!0.1/ip-src/null/' . $me['org'] . '/!tag1';
 ?>
 </pre>
 <p>You can also use search for IP addresses using CIDR. Make sure that you use '|' (pipe) instead of '/' (slashes). See below for an example: </p>