-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
83 lines (60 loc) · 2.92 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# mitre
<!-- badges: start -->
[![Travis build status](https://www.travis-ci.com/motherhack3r/mitre.svg?branch=master)](https://www.travis-ci.com/motherhack3r/mitre)
[![CRAN status](https://www.r-pkg.org/badges/version/mitre)](https://cran.r-project.org/package=mitre)
[![](https://cranlogs.r-pkg.org/badges/grand-total/mitre)](https://cran.r-project.org/package=mitre)
[![](https://www.rdocumentation.org/badges/version/mitre)](https://www.rdocumentation.org/packages/mitre)
<!-- badges: end -->
mitre package is designed to provide easy access to cybersecurity data standards.
You can expect functions to get data frames for every standard object.
It provide a directed graph with all relationships for deep exploratory analysis.
You could avoid full parsing process using the latest public Rdata sets.
## Installation
You can install the released version of mitre from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("mitre")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("motherhack3r/mitre")
```
## Basic usage
This is a basic example which shows you how to view shield tactics ids and names:
```{r example}
library(mitre)
shield <- mitre::shield.tactics
shield[, c("id", "name")]
```
This example shows the number of ATT&CK Techniques by domain:
```{r example2}
# table(mitredata$standards$attck$techniques$domain)
```
## Network visualization
This is a example which shows you how to visualize shield network:
```{r example3}
# library(visNetwork)
# g <- visNetwork::visNetwork(nodes = shield$shieldnet$nodes,
# edges = shield$shieldnet$edges)
# g
```
![Shield network zoom in](inst/doc/images/readme_example.png)
Find some more examples in vignettes to build your own graph like [this](https://security.shinyapps.io/mitreshield/).
## Advanced exploratory analysis
Check [this](https://datadrivensecurity-project.web.app/) proof of concept project. It is a Rmarkdown document performing an exploratory analysis with mitre network and [this data set](https://github.com/hrbrmstr/attckr/tree/master/inst/extdat).
- [Exploratory analysis](https://github.com/Barbero95/DataDrivenSecurity-Project): developed by [barbero95](https://github.com/Barbero95) and [Marta](https://github.com/martavilab).
- Sample incidents data set from rpackage [attckr](https://github.com/hrbrmstr/attckr/tree/master/inst/extdat) developed by [Bob Rudis](https://github.com/hrbrmstr).
## Code of conduct
Please note that this project is released with a [Contributor Code of Conduct](https://pkgdown.r-lib.org/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.