mirror of https://github.com/MISP/MISP
Feature/achievements widget (#6129)
* Additionnal protection against XSS, the response type defaults to html while it should be JSON. * new: widget: Achievements widget * Update AchievementsWidget.php * Update AchievementsWidget.php * Visual adjustments, new badges * i18n * indentation to MISP convention * AchievementsWidget minor textual improvements * Optimized query and fix issue with i18n Co-authored-by: Steve Clement <steve@localhost.lu> Co-authored-by: Christophe Vandeplas <christophe@vandeplas.com>pull/6230/head
Loïc Fortemps
GitHub
parent
242d25d5e4
commit
e0543e2fa2
|
|
@ -0,0 +1,205 @@
|
|||
<?php
|
||||
class AchievementsWidget
|
||||
{
|
||||
/*
|
||||
* Note: for this widget to display as expected, you need all icons to be accessible in your webroot. (img/custom)
|
||||
* Icons used:
|
||||
* - misp_event.png --> https://user-images.githubusercontent.com/1073662/87687773-6eff6d80-c786-11ea-9dcf-009a158a276c.png
|
||||
* - misp_object.png --> https://user-images.githubusercontent.com/1073662/87687775-6f980400-c786-11ea-985c-b3c15c01d63e.png
|
||||
* - tlp_green.png --> https://raw.githubusercontent.com/MISP/intelligence-icons/master/square_png/48/tlp_green.png
|
||||
* - attack.png --> https://raw.githubusercontent.com/mitre-attack/attack-website/master/attack-theme/static/images/attack-logo.png
|
||||
* - taxonomy.png --> https://raw.githubusercontent.com/MISP/intelligence-icons/master/square_png/48/taxonomy.png
|
||||
* - galaxy.png --> https://raw.githubusercontent.com/MISP/intelligence-icons/master/square_png/48/galaxy.png
|
||||
*
|
||||
*/
|
||||
|
||||
public $render = 'Achievements';
|
||||
public $title = 'Achievements of my organization';
|
||||
public $description = 'Earn badges and improve your usage of MISP.';
|
||||
public $width = 4;
|
||||
public $height = 10;
|
||||
public $cacheLifetime = false;
|
||||
public $autoRefreshDelay = false;
|
||||
public $params = array(
|
||||
'past_days' => 'The past number of days considered to look for criteria satisfaction (default 180)'
|
||||
);
|
||||
public $placeholder =
|
||||
'{
|
||||
"past_days": "180"
|
||||
}';
|
||||
|
||||
|
||||
/*
|
||||
* To add a new badge: add a new item to the list below and write a function check_<name>.
|
||||
*
|
||||
* The check function returns true if the badge is granted
|
||||
*/
|
||||
|
||||
private $badges;
|
||||
private $unlocked_badges;
|
||||
|
||||
public function __construct(){
|
||||
$this->badges = array(
|
||||
"events" => array(
|
||||
"icon" => "/img/custom/misp_event.png",
|
||||
"title" => __("MISP is all about sharing relevant data with each other. Start by creating your first event."),
|
||||
"help_page" => "https://www.circl.lu/doc/misp/using-the-system/#creating-an-event"
|
||||
),
|
||||
"tags" => array(
|
||||
"icon" => "/img/custom/tlp_green.png",
|
||||
"title" => __("By adding tags to your events, they can be categorized more easily."),
|
||||
"help_page" => "https://www.circl.lu/doc/misp/using-the-system/#tagging"
|
||||
),
|
||||
"objects" => array(
|
||||
"icon" => "/img/custom/misp_object.png",
|
||||
"title" => __("To enhance the structure of your events, use MISP Objects."),
|
||||
"help_page" => "https://github.com/MISP/misp-objects/blob/main/README.md"
|
||||
),
|
||||
"taxonomies" => array(
|
||||
"icon" => "/img/custom/taxonomy.png",
|
||||
"title" => __("Make sure to speak the same language as your counterparts by using taxonomies for your tags."),
|
||||
"help_page" => "https://www.circl.lu/doc/misp/taxonomy/"
|
||||
),
|
||||
"galaxies" => array (
|
||||
"icon" => "/img/custom/galaxy.png",
|
||||
"title" => __("Go above and beyond tags and taxonomies, and start using galaxies."),
|
||||
"help_page" => "https://www.circl.lu/doc/misp/galaxy/"
|
||||
),
|
||||
"attack" => array(
|
||||
"icon" => "/img/custom/attack.png",
|
||||
"title" => __("Add the TTPs following the MITRE ATT&CK framework to make your events even more interesting."),
|
||||
"help_page" => "https://www.misp-project.org/2018/06/27/MISP.2.4.93.released.html"
|
||||
)
|
||||
);
|
||||
|
||||
// The title is modified if the badge is unlocked
|
||||
$this->unlocked_badges = array(
|
||||
"objects" => __("The data you share has now a better structure thanks to the MISP Objects you used."),
|
||||
"events" => __("Congratulations, you have shared your first event!"),
|
||||
"tags" => __("You have been using tags, good job!"),
|
||||
"taxonomies" => __("Taxonomies have been used in your events."),
|
||||
"galaxies" => __("Galaxies have no secrets for you in this Threat Sharing universe."),
|
||||
"attack" => __("MISP & MITRE ATT&CK is a great combo.")
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
private function check_taxonomies($org_id) {
|
||||
return $this->lookup_tag_name_value($org_id, '%:%');
|
||||
}
|
||||
|
||||
private function check_galaxies($org_id) {
|
||||
return $this->lookup_tag_name_value($org_id, 'misp-galaxy:%');
|
||||
}
|
||||
|
||||
private function check_attack($org_id) {
|
||||
return $this->lookup_tag_name_value($org_id, 'misp-galaxy:mitre%');
|
||||
}
|
||||
|
||||
|
||||
private function check_tags($org_id) {
|
||||
$options['joins'] = array(
|
||||
array('table' => 'event_tags',
|
||||
'alias' => 'EventTag',
|
||||
'type' => 'INNER',
|
||||
'conditions' => array(
|
||||
'EventTag.event_id = Event.id',
|
||||
)
|
||||
)
|
||||
);
|
||||
$options['fields'] = 'Event.id';
|
||||
$options['limit'] = 1;
|
||||
$conditions = array('Event.orgc_id' => $org_id, 'Event.published' => 1, 'Event.timestamp >=' => $this->start_timestamp);
|
||||
$options['conditions'] = array('AND' => $conditions);
|
||||
$events = $this->Event->find('all', $options);
|
||||
return count($events) > 0;
|
||||
}
|
||||
|
||||
private function check_events($org_id) {
|
||||
$conditions = array('Event.orgc_id' => $org_id, 'Event.published' => 1, 'Event.timestamp >=' => $this->start_timestamp);
|
||||
$events = $this->Event->find('all', array('limit' => 1, 'conditions' => array('AND' => $conditions)));
|
||||
return count($events) > 0;
|
||||
}
|
||||
|
||||
private function check_objects($org_id) {
|
||||
$options['joins'] = array(
|
||||
array('table' => 'objects',
|
||||
'alias' => 'Objects',
|
||||
'type' => 'INNER',
|
||||
'conditions' => array(
|
||||
'Objects.event_id = Event.id',
|
||||
)
|
||||
)
|
||||
);
|
||||
$options['fields'] = 'Event.id';
|
||||
$options['limit'] = 1;
|
||||
$conditions = array('Event.orgc_id' => $org_id, 'Event.published' => 1, 'Event.timestamp >=' => $this->start_timestamp);
|
||||
$options['conditions'] = array('AND' => $conditions);
|
||||
$events = $this->Event->find('all', $options);
|
||||
return count($events) > 0;
|
||||
}
|
||||
|
||||
private function lookup_tag_name_value($org_id, $value) {
|
||||
$options['joins'] = array(
|
||||
array('table' => 'event_tags',
|
||||
'alias' => 'EventTag',
|
||||
'type' => 'INNER',
|
||||
'conditions' => array(
|
||||
'EventTag.event_id = Event.id',
|
||||
)
|
||||
),
|
||||
array('table' => 'tags',
|
||||
'alias' => 'Tag',
|
||||
'type' => 'INNER',
|
||||
'conditions' => array(
|
||||
'Tag.id = EventTag.tag_id'
|
||||
)
|
||||
)
|
||||
);
|
||||
$options['fields'] = 'Event.id';
|
||||
$options['limit'] = 1;
|
||||
$conditions = array('Event.orgc_id' => $org_id, 'Event.published' => 1, 'Event.timestamp >=' => $this->start_timestamp, 'Tag.name LIKE' => $value);
|
||||
$options['conditions'] = array('AND' => $conditions);
|
||||
$events = $this->Event->find('all', $options);
|
||||
return count($events) > 0;
|
||||
}
|
||||
|
||||
public function handler($user, $options = array())
|
||||
{
|
||||
$this->Org = ClassRegistry::init('Organisation');
|
||||
$this->Event = ClassRegistry::init('Event');
|
||||
|
||||
$days = 180;
|
||||
if(!empty($options['past_days'])) {
|
||||
$days = (int) $options['past_days'];
|
||||
}
|
||||
$this->start_timestamp = $this->Event->resolveTimeDelta($days.'d');
|
||||
|
||||
$org_id = $user['Organisation']['id'];
|
||||
$locked = array();
|
||||
$unlocked = array();
|
||||
|
||||
// We look through each badge and evaluate the condition
|
||||
foreach ($this->badges as $key => $item) {
|
||||
$fun = 'check_'.$key;
|
||||
if($this->$fun($org_id)) { // Condition for badge is met
|
||||
//we replace the text to the unlocked one
|
||||
if(isset($this->unlocked_badges[$key])) {
|
||||
$item['title'] = $this->unlocked_badges[$key];
|
||||
}
|
||||
$unlocked[] = $item;
|
||||
} else {
|
||||
$locked[] = $item;
|
||||
}
|
||||
}
|
||||
|
||||
$result = array();
|
||||
$result['locked'] = $locked;
|
||||
$result['unlocked'] = $unlocked;
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
?>
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
<div>
|
||||
<?php
|
||||
/*
|
||||
* This layout is split in two parts, the top part is the achiements already
|
||||
* unlocked and the bottom part contains the one to get next.
|
||||
*
|
||||
* The data array to be passed has therefore 2 root keys: locked and unlocked.
|
||||
* Each one is a list of item, each item must contain:
|
||||
* - icon (url to img file)
|
||||
- title (text description)
|
||||
- help_page (optional, link to an article)
|
||||
*
|
||||
* So the structure of the $data parameter must be something like:
|
||||
* { 'locked': [{ 'icon': '/path/to/img.png', 'title': 'my great achievement', 'help_page': 'http://wikimedia'}, {...}], 'unlocked': [{...}]}
|
||||
*/
|
||||
echo '<h3>'.__("Achievements Unlocked!").'</h3>';
|
||||
if(empty($data['unlocked'])) {
|
||||
echo '<p>'.__("You don't have any achievement yet. Check them below to get started!").'</p>';
|
||||
} else {
|
||||
echo '<table class="table table-striped table-hover table-condensed">';
|
||||
foreach ($data['unlocked'] as $item) {
|
||||
echo '<tr>';
|
||||
echo '<td><img class="badge-img" width=48 src='.h($item['icon']).' alt="badge"/></td>';
|
||||
echo '<td><div class="badge-description">'.h($item['title']).'</div></td>';
|
||||
echo '</tr>';
|
||||
}
|
||||
echo '</table>';
|
||||
}
|
||||
echo '<h3>'.__("Next on your list:").'</h3>';
|
||||
if(empty($data['locked'])) {
|
||||
echo '<p>'.__("Well done! You got them all.").'</p>';
|
||||
} else {
|
||||
echo '<table class="table table-striped table-hover table-condensed">';
|
||||
foreach ($data['locked'] as $item) {
|
||||
echo '<tr>';
|
||||
echo '<td><img class="badge-img" width=48 src='.h($item['icon']).' alt="badge"/></td>';
|
||||
echo '<td><div class="badge-description">'.h($item['title']).'</div></td>';
|
||||
if(!empty($item['help_page'])) {
|
||||
echo '<td><a href='.h($item['help_page']).' target="_blank">'.__("Read more here").'</a></td>';
|
||||
}
|
||||
echo '</tr>';
|
||||
}
|
||||
echo '</table>';
|
||||
}
|
||||
?>
|
||||
</div>
|
||||
|
||||
<style widget-scoped>
|
||||
.badge-description {
|
||||
font-size: 11pt;
|
||||
padding: 5px;
|
||||
height: 43px;
|
||||
width: 100%;
|
||||
}
|
||||
.badge-img {
|
||||
padding-top: 5px;
|
||||
width: 48px;
|
||||
max-width: 48px;
|
||||
}
|
||||
</style>
|
||||
Loading…
Reference in New Issue