| 1 |
\documentclass[a4paper]{article} |
| 2 |
|
| 3 |
\usepackage{lmodern} |
| 4 |
\usepackage[margin=25mm]{geometry} |
| 5 |
\usepackage[hidelinks]{hyperref} |
| 6 |
\usepackage{array} |
| 7 |
\usepackage{xcolor} |
| 8 |
\usepackage{verbatim} |
| 9 |
\usepackage{fvextra} |
| 10 |
\usepackage{corasdiagram} |
| 11 |
|
| 12 |
\title{\texttt{corasdiagram} Manual} |
| 13 |
\date{Version \corasdiagramversion} |
| 14 |
\newcommand{\keydefault}[1]{\underline{\texttt{#1}}} |
| 15 |
|
| 16 |
\begin{document} |
| 17 |
|
| 18 |
\maketitle |
| 19 |
\tableofcontents |
| 20 |
|
| 21 |
\section{Overview} |
| 22 |
|
| 23 |
\texttt{corasdiagram} is a notation-first LaTeX package for the five core CORAS |
| 24 |
diagram families: |
| 25 |
|
| 26 |
\begin{itemize} |
| 27 |
\item asset diagrams |
| 28 |
\item threat diagrams |
| 29 |
\item risk diagrams |
| 30 |
\item treatment diagrams |
| 31 |
\item treatment overview diagrams |
| 32 |
\end{itemize} |
| 33 |
|
| 34 |
The package also provides high-level analysis risk tables with CORAS header |
| 35 |
icons. The package ships with pre-rendered CORAS icons, semantic diagram |
| 36 |
environments, concept-level node macros, and semantic edge macros. The current |
| 37 |
supported engines are \texttt{pdflatex} and \texttt{lualatex}. |
| 38 |
|
| 39 |
\section{Installation} |
| 40 |
|
| 41 |
\subsection{Repository-Local Use} |
| 42 |
|
| 43 |
Compile from the repository root with: |
| 44 |
|
| 45 |
\begin{verbatim} |
| 46 |
TEXINPUTS=tex/latex//: pdflatex -interaction=nonstopmode -halt-on-error \ |
| 47 |
examples/corasdiagram-minimal.tex |
| 48 |
\end{verbatim} |
| 49 |
|
| 50 |
\subsection{User TEXMF Tree} |
| 51 |
|
| 52 |
Copy \texttt{tex/latex/corasdiagram/} to |
| 53 |
\texttt{\$HOME/texmf/tex/latex/corasdiagram/}. Refresh the TeX filename |
| 54 |
database if your TeX distribution requires it. |
| 55 |
|
| 56 |
\subsection{Release Bundle} |
| 57 |
|
| 58 |
The release tooling assembles a CTAN-friendly bundle. Once the package is |
| 59 |
published, installation can happen through the normal TeX package manager. |
| 60 |
|
| 61 |
\section{Package Options} |
| 62 |
|
| 63 |
\begin{center} |
| 64 |
\begin{tabular}{>{\ttfamily}p{0.22\linewidth}p{0.18\linewidth}p{0.46\linewidth}} |
| 65 |
\hline |
| 66 |
Option & Default & Meaning \\ |
| 67 |
\hline |
| 68 |
iconset=color|bw & color & Select the color or black-and-white icon set for the base, outlined, and shaded icon variants. \\ |
| 69 |
icons-path=<path> & package icons & Override the icon directory path. \\ |
| 70 |
\hline |
| 71 |
\end{tabular} |
| 72 |
\end{center} |
| 73 |
|
| 74 |
\section{Diagram Environments} |
| 75 |
|
| 76 |
\begin{description} |
| 77 |
\item[\texttt{corasassetdiagram}] Stakeholders, assets, asset relations, |
| 78 |
and scope containers. |
| 79 |
\item[\texttt{corasthreatdiagram}] Threat sources, vulnerabilities, threat |
| 80 |
scenarios, unwanted incidents, and impacted assets. |
| 81 |
\item[\texttt{corasriskdiagram}] Threat sources, risks, and impacted assets. |
| 82 |
\item[\texttt{corastreatmentdiagram}] Treatment nodes together with the |
| 83 |
selected threat chain they mitigate. |
| 84 |
\item[\texttt{corastreatmentoverviewdiagram}] Treatments, risks, assets, and |
| 85 |
treatment fan-in via a junction. |
| 86 |
\end{description} |
| 87 |
|
| 88 |
Each environment enforces its legal CORAS vocabulary. Illegal node types or |
| 89 |
edge relations raise package errors during compilation. |
| 90 |
|
| 91 |
\section{High-Level Analysis Tables} |
| 92 |
|
| 93 |
The package provides \texttt{corashighlevelanalysistable} and the alias |
| 94 |
\texttt{corashighlevelrisktable} for the high-level analysis table style used |
| 95 |
in CORAS reports. The environments are built on \texttt{longtable}, so they |
| 96 |
can span multiple pages while repeating the icon header. |
| 97 |
|
| 98 |
\begin{center} |
| 99 |
\begin{tabular}{>{\ttfamily}p{0.18\linewidth}p{0.27\linewidth}p{0.45\linewidth}} |
| 100 |
\hline |
| 101 |
Key & Values & Description \\ |
| 102 |
\hline |
| 103 |
caption & empty or free text & Optional longtable caption shown above the first header. \\ |
| 104 |
label & empty or reference key & Optional \texttt{\textbackslash label} written together with the caption. \\ |
| 105 |
cause heading & \keydefault{Who/what causes it?} or free text & Header text for the left column. \\ |
| 106 |
event heading & \keydefault{How? What is the scenario or incident? What is harmed?} or free text & Header text for the middle column. \\ |
| 107 |
possibility heading & \keydefault{What makes it possible?} or free text & Header text for the right column. \\ |
| 108 |
cause width & \keydefault{24\% of \textbackslash textwidth} or dimension & Width of the left text column. \\ |
| 109 |
event width & \keydefault{40\% of \textbackslash textwidth} or dimension & Width of the middle text column. \\ |
| 110 |
possibility width & \keydefault{30\% of \textbackslash textwidth} or dimension & Width of the right text column. \\ |
| 111 |
column sep & \keydefault{10pt} or dimension & Horizontal spacing between columns. \\ |
| 112 |
row sep & \keydefault{0.8ex} or dimension & Extra vertical space inserted after each data row. \\ |
| 113 |
icon scale & \keydefault{1} or positive factor & Scales the header icon groups. Useful when the table is placed in a narrow minipage or column. \\ |
| 114 |
cause icons & default CORAS threat-source header content or raw TeX content & Override the icon content in the left header cell. \\ |
| 115 |
event icons & default CORAS scenario/incident/asset header content or raw TeX content & Override the icon content in the middle header cell. \\ |
| 116 |
possibility icons & default CORAS vulnerability header content or raw TeX content & Override the icon content in the right header cell. \\ |
| 117 |
\hline |
| 118 |
\end{tabular} |
| 119 |
\end{center} |
| 120 |
|
| 121 |
Data rows are emitted with \texttt{\textbackslash corashighlevelanalysisrow} or |
| 122 |
the alias \texttt{\textbackslash corashighlevelriskrow}. Both commands take |
| 123 |
three mandatory arguments: cause, scenario/incident/harmed asset text, and |
| 124 |
possibility text. |
| 125 |
|
| 126 |
\begin{verbatim} |
| 127 |
\begin{corashighlevelanalysistable}[ |
| 128 |
caption={Documenting the high-level analysis} |
| 129 |
] |
| 130 |
\corashighlevelanalysisrow |
| 131 |
{Hacker} |
| 132 |
{Breaks into system and compromises integrity\\ |
| 133 |
or confidentiality of databases} |
| 134 |
{Use of web application and remote access;\\ |
| 135 |
insufficient access control} |
| 136 |
\end{corashighlevelanalysistable} |
| 137 |
\end{verbatim} |
| 138 |
|
| 139 |
\section{Public API} |
| 140 |
|
| 141 |
\subsection{Canonical Node Macros} |
| 142 |
|
| 143 |
\begin{center} |
| 144 |
\begin{tabular}{>{\ttfamily}p{0.34\linewidth}p{0.52\linewidth}} |
| 145 |
\hline |
| 146 |
Macro & Meaning \\ |
| 147 |
\hline |
| 148 |
\textbackslash corashighlevelanalysisrow & One data row in a high-level analysis table. \\ |
| 149 |
\textbackslash corashighlevelriskrow & Alias for \textbackslash corashighlevelanalysisrow. \\ |
| 150 |
\textbackslash corasasset & Asset node with CORAS asset icon. \\ |
| 151 |
\textbackslash corasindirectasset & Indirect asset node with the dotted indirect-asset icon. \\ |
| 152 |
\textbackslash corasstakeholder & Stakeholder node with stakeholder icon. \\ |
| 153 |
\textbackslash corasthreataccidental & Accidental human threat source. \\ |
| 154 |
\textbackslash corasthreatdeliberate & Deliberate human threat source. \\ |
| 155 |
\textbackslash corasthreatnonhuman & Non-human threat source. \\ |
| 156 |
\textbackslash corasvulnerability & Vulnerability node. \\ |
| 157 |
\textbackslash corasscenario & Threat scenario node. \\ |
| 158 |
\textbackslash corasincident & Unwanted incident node. \\ |
| 159 |
\textbackslash corasunwantedincident & Alias for \textbackslash corasincident. \\ |
| 160 |
\textbackslash corasrisk & Risk node with title and level metadata. \\ |
| 161 |
\textbackslash corastreatment & Treatment node. \\ |
| 162 |
\textbackslash corasjunction & Junction node for treatment overview fan-in. \\ |
| 163 |
\hline |
| 164 |
\end{tabular} |
| 165 |
\end{center} |
| 166 |
|
| 167 |
\paragraph{Indirect Assets} |
| 168 |
|
| 169 |
\texttt{\textbackslash corasindirectasset} is semantically an asset node with a |
| 170 |
distinct dotted indirect-asset symbol. It can therefore be used anywhere the |
| 171 |
package expects an asset concept, including asset-diagram auto-layout lanes, |
| 172 |
asset-scope grouping, and the normal asset relation macros. |
| 173 |
|
| 174 |
\paragraph{Change-Modeling Perspectives} |
| 175 |
|
| 176 |
The \texttt{perspective} key is the public change-modeling switch used across |
| 177 |
icon-backed nodes and mounted-icon body nodes: |
| 178 |
\texttt{before} keeps the base icon, |
| 179 |
\texttt{before-after} selects the outlined transition variant, and |
| 180 |
\texttt{after} selects the shaded result variant. |
| 181 |
|
| 182 |
This applies to icon-backed nodes such as |
| 183 |
\texttt{\textbackslash corasasset}, |
| 184 |
\texttt{\textbackslash corasindirectasset}, |
| 185 |
\texttt{\textbackslash corasstakeholder}, |
| 186 |
the threat-source macros, and |
| 187 |
\texttt{\textbackslash corasvulnerability}; |
| 188 |
to mounted-icon body nodes such as |
| 189 |
\texttt{\textbackslash corasscenario}, |
| 190 |
\texttt{\textbackslash corasunwantedincident}, |
| 191 |
\texttt{\textbackslash corasrisk}, and |
| 192 |
\texttt{\textbackslash corastreatment}; |
| 193 |
and to |
| 194 |
\texttt{\textbackslash corasriskref}. |
| 195 |
|
| 196 |
Underlined values in the key tables below are the defaults used by the package. |
| 197 |
|
| 198 |
\paragraph{Worked Perspective Example} |
| 199 |
|
| 200 |
\begin{center} |
| 201 |
\begin{corasassetdiagram}[x=.85cm,y=.85cm,layout=manual] |
| 202 |
\corasasset[ |
| 203 |
at={(0,0)}, |
| 204 |
title={Asset}, |
| 205 |
perspective=before |
| 206 |
] |
| 207 |
\corasindirectasset[ |
| 208 |
at={(3.2,0)}, |
| 209 |
title={Indirect\\Asset}, |
| 210 |
perspective=before-after |
| 211 |
] |
| 212 |
\corasstakeholder[ |
| 213 |
at={(6.4,0)}, |
| 214 |
title={Stakeholder}, |
| 215 |
perspective=after |
| 216 |
] |
| 217 |
\end{corasassetdiagram} |
| 218 |
\end{center} |
| 219 |
|
| 220 |
\begin{center} |
| 221 |
\begin{corastreatmentdiagram}[x=.85cm,y=.85cm,layout=manual] |
| 222 |
\corasscenario[ |
| 223 |
at={(0,0)}, |
| 224 |
title={Scenario}, |
| 225 |
meta={1 per year}, |
| 226 |
perspective=before |
| 227 |
] |
| 228 |
\corasunwantedincident[ |
| 229 |
at={(4.5,0)}, |
| 230 |
title={Incident}, |
| 231 |
perspective=before-after |
| 232 |
] |
| 233 |
\corastreatment[ |
| 234 |
at={(8.6,0)}, |
| 235 |
title={Treatment}, |
| 236 |
perspective=after |
| 237 |
] |
| 238 |
\end{corastreatmentdiagram} |
| 239 |
\end{center} |
| 240 |
|
| 241 |
\noindent |
| 242 |
The first row shows the three perspective states on icon-backed nodes. The |
| 243 |
second row shows the same key on mounted-icon body nodes, where only the icon |
| 244 |
changes and the underlying ellipse or rectangle geometry stays the same. |
| 245 |
|
| 246 |
\begin{center} |
| 247 |
\begin{tabular}{>{\ttfamily}p{0.18\linewidth}p{0.27\linewidth}p{0.45\linewidth}} |
| 248 |
\hline |
| 249 |
Key & Values & Description \\ |
| 250 |
\hline |
| 251 |
name & auto-generated identifier & Public node name used by later edges, scopes, and references. \\ |
| 252 |
title & free text & Primary label text rendered in the node. \\ |
| 253 |
meta & empty or free text & Secondary metadata line below the title. \\ |
| 254 |
level & empty or free text & Secondary level line, mainly used by risk nodes. \\ |
| 255 |
perspective & \keydefault{before} | \texttt{before-after} | \texttt{after} & Selects the CORAS change-modeling perspective: base icon, outlined icon, or shaded icon. \\ |
| 256 |
scope & empty or scope name & Adds the node to a named scope fit group. \\ |
| 257 |
at & empty or TikZ coordinate & Explicit placement; wins over automatic placement. \\ |
| 258 |
order & empty or positive integer & Sets the lane order used by auto layout. \\ |
| 259 |
text width & empty or dimension & Overrides the node type's built-in text wrapping width. \\ |
| 260 |
layout & \keydefault{auto} | \texttt{manual} & Overrides the diagram's placement mode for a node. \\ |
| 261 |
min edge gap & empty or dimension & Node-level override for the minimum border-to-border spacing enforced by auto layout and relative placement helpers. \\ |
| 262 |
right of & empty or node name & Relative placement to the right of another node. \\ |
| 263 |
below of & empty or node name & Relative placement below another node. \\ |
| 264 |
incident of & empty or node name & Relative placement to the right of an incident node. \\ |
| 265 |
treats & empty or node name & Relative placement above the treated node. \\ |
| 266 |
harms & empty or node name & Relative placement to the left of the harmed node. \\ |
| 267 |
horizontal gap & \keydefault{12mm} or dimension & Horizontal offset used by relative placement helpers. \\ |
| 268 |
vertical gap & \keydefault{14mm} or dimension & Vertical offset used by relative placement helpers. \\ |
| 269 |
tikz & empty or raw TikZ options & Advanced style override passed to the underlying node. \\ |
| 270 |
\hline |
| 271 |
\end{tabular} |
| 272 |
\end{center} |
| 273 |
|
| 274 |
\subsection{Semantic Edge Macros} |
| 275 |
|
| 276 |
\begin{center} |
| 277 |
\begin{tabular}{>{\ttfamily}p{0.28\linewidth}p{0.58\linewidth}} |
| 278 |
\hline |
| 279 |
Macro & Meaning \\ |
| 280 |
\hline |
| 281 |
\textbackslash corascauses & Solid causal edge with open line arrowhead. \\ |
| 282 |
\textbackslash corasrelates & Solid relation/impact edge with open line arrowhead. \\ |
| 283 |
\textbackslash corasconcerns & Dashed concern edge, typically stakeholder to asset. \\ |
| 284 |
\textbackslash corasassociates & Dashed non-causal association edge. \\ |
| 285 |
\textbackslash corastreats & Dashed curved treatment edge leaving the source orthogonally. \\ |
| 286 |
\hline |
| 287 |
\end{tabular} |
| 288 |
\end{center} |
| 289 |
|
| 290 |
\begin{center} |
| 291 |
\begin{tabular}{>{\ttfamily}p{0.18\linewidth}p{0.27\linewidth}p{0.45\linewidth}} |
| 292 |
\hline |
| 293 |
Key & Values & Description \\ |
| 294 |
\hline |
| 295 |
from & node name & Start node for the edge. \\ |
| 296 |
to & node name & End node for the edge. \\ |
| 297 |
label & empty or free text & Optional label placed on the edge. \\ |
| 298 |
pos & \keydefault{.5} or number & Relative position for the edge label or risk reference anchor. \\ |
| 299 |
route & \keydefault{auto} | \texttt{straight} | \texttt{hv} | \texttt{vh} & Selects the default routing strategy for non-treatment edges. \\ |
| 300 |
path & empty or raw TikZ path operator & Advanced override for the edge path, such as \texttt{-|}. \\ |
| 301 |
tikz & empty or raw TikZ draw options & Advanced style override passed to the underlying draw command. \\ |
| 302 |
label options & \keydefault{fill=white,inner sep=1pt} or raw TikZ options & Advanced style override for the edge label node. \\ |
| 303 |
\hline |
| 304 |
\end{tabular} |
| 305 |
\end{center} |
| 306 |
|
| 307 |
The higher-level semantic edge macros choose the underlying edge type and |
| 308 |
semantic relation automatically, so the low-level \texttt{type} and |
| 309 |
\texttt{semantic} keys are normally only needed with |
| 310 |
\texttt{\textbackslash corasedge}. |
| 311 |
|
| 312 |
\subsection{Scopes and Containers} |
| 313 |
|
| 314 |
\texttt{\textbackslash corasscope} is the public scope/container helper. The |
| 315 |
important keys are: |
| 316 |
|
| 317 |
\begin{center} |
| 318 |
\begin{tabular}{>{\ttfamily}p{0.18\linewidth}p{0.27\linewidth}p{0.45\linewidth}} |
| 319 |
\hline |
| 320 |
Key & Values & Description \\ |
| 321 |
\hline |
| 322 |
name & auto-generated identifier & Public scope/container node name. \\ |
| 323 |
title & empty or free text & Optional title shown on the scope. \\ |
| 324 |
scope & empty or scope name & Reuses all nodes previously tagged with the same scope name. \\ |
| 325 |
fit & empty or TikZ fit list & Explicit fit list such as \texttt{(a) (b) (c)}. \\ |
| 326 |
kind & \keydefault{system} | \texttt{asset-scope} | \texttt{analysis} | \texttt{risk-group} | \texttt{treatment-scope} & Selects the container styling. \\ |
| 327 |
padding & \keydefault{5mm} or dimension & General scope padding; \texttt{asset-scope} falls back to \keydefault{1.0mm}. \\ |
| 328 |
stakeholder & empty or node name & Selects the stakeholder node used for the asset-scope corner compartment. \\ |
| 329 |
stakeholder corner & \keydefault{left} | \texttt{right} & Chooses which top corner gets the stakeholder compartment. \\ |
| 330 |
stakeholder xsep & empty or dimension & Horizontal padding inside the asset-scope stakeholder square; defaults to \keydefault{0.25mm}. \\ |
| 331 |
stakeholder ysep & empty or dimension & Vertical padding inside the asset-scope stakeholder square; defaults to \keydefault{0.25mm}. \\ |
| 332 |
tikz & empty or raw TikZ options & Advanced style override for the container node. \\ |
| 333 |
title tikz & empty or raw TikZ options & Advanced style override for the scope title node. \\ |
| 334 |
\hline |
| 335 |
\end{tabular} |
| 336 |
\end{center} |
| 337 |
|
| 338 |
The \texttt{asset-scope} kind renders the rounded asset-diagram container with |
| 339 |
the stakeholder corner compartment. The official threat, risk, treatment, and |
| 340 |
treatment overview examples do not use containers. |
| 341 |
|
| 342 |
\subsection{Advanced Compatibility API} |
| 343 |
|
| 344 |
The package still ships the lower-level primitives |
| 345 |
\texttt{\textbackslash corasnode}, \texttt{\textbackslash corasedge}, and |
| 346 |
\texttt{\textbackslash corascontainer}. They remain available for advanced |
| 347 |
usage and backward compatibility, but the semantic wrappers are the preferred |
| 348 |
public API. |
| 349 |
|
| 350 |
\section{Layout Behavior} |
| 351 |
|
| 352 |
The package supports both explicit coordinates and role-aware automatic |
| 353 |
placement. Manual placement always wins when \texttt{at=<...>} is given. |
| 354 |
The \texttt{min edge gap} key acts as a lower bound on visible |
| 355 |
border-to-border spacing for both auto placement and the relative helper keys. |
| 356 |
Explicit \texttt{horizontal gap} and \texttt{vertical gap} values still matter, |
| 357 |
but they can only increase that spacing. |
| 358 |
|
| 359 |
Important layout-related keys: |
| 360 |
|
| 361 |
\begin{center} |
| 362 |
\begin{tabular}{>{\ttfamily}p{0.18\linewidth}p{0.27\linewidth}p{0.45\linewidth}} |
| 363 |
\hline |
| 364 |
Key & Values & Description \\ |
| 365 |
\hline |
| 366 |
layout & \keydefault{auto} | \texttt{manual} & Switch between role-aware automatic placement and fully explicit placement. \\ |
| 367 |
at & empty or TikZ coordinate & Place a node directly at a coordinate; takes precedence over all other layout keys. \\ |
| 368 |
order & empty or positive integer & Controls row ordering inside the role lane used by auto layout. \\ |
| 369 |
min edge gap & \keydefault{8mm} or dimension & Minimum border-to-border spacing preserved for auto placement and relative helpers; ignored when \texttt{at=<...>} is given. \\ |
| 370 |
scope & empty or scope name & Groups asset-diagram nodes into a fit-based container. \\ |
| 371 |
right of & empty or node name & Places a node to the right of another node using \texttt{horizontal gap}. \\ |
| 372 |
below of & empty or node name & Places a node below another node using \texttt{vertical gap}. \\ |
| 373 |
incident of & empty or node name & Places a node to the right of an incident node. \\ |
| 374 |
treats & empty or node name & Places a node above the treated node. \\ |
| 375 |
harms & empty or node name & Places a node to the left of the harmed node. \\ |
| 376 |
\hline |
| 377 |
\end{tabular} |
| 378 |
\end{center} |
| 379 |
|
| 380 |
\section{Complete Examples} |
| 381 |
|
| 382 |
\subsection{Asset Diagram} |
| 383 |
|
| 384 |
This example uses \texttt{\textbackslash corasindirectasset} for the dependent |
| 385 |
asset. Semantically it is still an asset node, but it renders with the dotted |
| 386 |
indirect-asset symbol. |
| 387 |
|
| 388 |
\begin{center} |
| 389 |
\begin{corasassetdiagram}[x=.8cm,y=.8cm] |
| 390 |
\corasstakeholder[ |
| 391 |
name=doc-stakeholder, |
| 392 |
scope=doc-asset-scope, |
| 393 |
order=1, |
| 394 |
title={Stakeholder} |
| 395 |
] |
| 396 |
\corasasset[ |
| 397 |
name=doc-asset, |
| 398 |
scope=doc-asset-scope, |
| 399 |
order=1, |
| 400 |
title={Asset} |
| 401 |
] |
| 402 |
\corasindirectasset[ |
| 403 |
name=doc-indirect, |
| 404 |
scope=doc-asset-scope, |
| 405 |
order=2, |
| 406 |
title={Indirect\\Asset} |
| 407 |
] |
| 408 |
\corasscope[ |
| 409 |
name=doc-asset-box, |
| 410 |
scope=doc-asset-scope, |
| 411 |
kind=asset-scope, |
| 412 |
stakeholder=doc-stakeholder, |
| 413 |
stakeholder corner=left |
| 414 |
] |
| 415 |
\corasrelates[from=doc-asset,to=doc-indirect] |
| 416 |
\end{corasassetdiagram} |
| 417 |
\end{center} |
| 418 |
|
| 419 |
\subsection{Threat Diagram} |
| 420 |
|
| 421 |
\begin{center} |
| 422 |
\begin{corasthreatdiagram}[x=.75cm,y=.75cm] |
| 423 |
\corasthreataccidental[name=doc-employee,order=1,title={Employee}] |
| 424 |
\corasscenario[ |
| 425 |
name=doc-remote, |
| 426 |
order=1, |
| 427 |
title={Remote access}, |
| 428 |
meta={1 per 6 months} |
| 429 |
] |
| 430 |
\corasvulnerability[ |
| 431 |
name=doc-oldweb, |
| 432 |
order=1, |
| 433 |
title={Old\\webserver} |
| 434 |
] |
| 435 |
\corasunwantedincident[ |
| 436 |
name=doc-disclosure, |
| 437 |
order=1, |
| 438 |
title={Disclosure\\of data} |
| 439 |
] |
| 440 |
\corasasset[ |
| 441 |
name=doc-privacy, |
| 442 |
order=1, |
| 443 |
title={Data\\privacy} |
| 444 |
] |
| 445 |
\corascauses[from=doc-employee,to=doc-oldweb] |
| 446 |
\corascauses[from=doc-oldweb,to=doc-remote] |
| 447 |
\corascauses[from=doc-remote,to=doc-disclosure] |
| 448 |
\corasrelates[from=doc-disclosure,to=doc-privacy] |
| 449 |
\end{corasthreatdiagram} |
| 450 |
\end{center} |
| 451 |
|
| 452 |
\subsection{Risk Diagram} |
| 453 |
|
| 454 |
\begin{center} |
| 455 |
\begin{corasriskdiagram}[x=.8cm,y=.8cm] |
| 456 |
\corasthreatnonhuman[ |
| 457 |
name=doc-infra, |
| 458 |
order=1, |
| 459 |
title={IT-infrastructure} |
| 460 |
] |
| 461 |
\corasrisk[ |
| 462 |
name=doc-risk, |
| 463 |
order=1, |
| 464 |
title={Application\\outage}, |
| 465 |
meta={1 per year}, |
| 466 |
level=medium |
| 467 |
] |
| 468 |
\corasasset[ |
| 469 |
name=doc-availability, |
| 470 |
order=1, |
| 471 |
title={Application\\availability} |
| 472 |
] |
| 473 |
\corascauses[from=doc-infra,to=doc-risk] |
| 474 |
\corasrelates[from=doc-risk,to=doc-availability] |
| 475 |
\end{corasriskdiagram} |
| 476 |
\end{center} |
| 477 |
|
| 478 |
\subsection{Treatment Diagram} |
| 479 |
|
| 480 |
\begin{center} |
| 481 |
\begin{corastreatmentdiagram}[x=.75cm,y=.75cm] |
| 482 |
\corasthreataccidental[name=doc-user,order=1,title={Employee}] |
| 483 |
\corasvulnerability[ |
| 484 |
name=doc-vulnerability, |
| 485 |
order=1, |
| 486 |
title={Old\\webserver} |
| 487 |
] |
| 488 |
\corasscenario[ |
| 489 |
name=doc-threat, |
| 490 |
order=1, |
| 491 |
title={Remote access}, |
| 492 |
meta={1 per 6 months} |
| 493 |
] |
| 494 |
\corasunwantedincident[ |
| 495 |
name=doc-incident, |
| 496 |
order=1, |
| 497 |
title={Disclosure\\of data}, |
| 498 |
meta={1 per year} |
| 499 |
] |
| 500 |
\corasasset[ |
| 501 |
name=doc-asset2, |
| 502 |
order=1, |
| 503 |
title={Data\\privacy} |
| 504 |
] |
| 505 |
\corastreatment[ |
| 506 |
name=doc-training, |
| 507 |
order=1, |
| 508 |
title={Security\\training} |
| 509 |
] |
| 510 |
\corascauses[from=doc-user,to=doc-vulnerability] |
| 511 |
\corascauses[from=doc-vulnerability,to=doc-threat] |
| 512 |
\corascauses[from=doc-threat,to=doc-incident] |
| 513 |
\corasrelates[from=doc-incident,to=doc-asset2] |
| 514 |
\corastreats[from=doc-training,to=doc-threat] |
| 515 |
\end{corastreatmentdiagram} |
| 516 |
\end{center} |
| 517 |
|
| 518 |
\subsection{Treatment Overview Diagram} |
| 519 |
|
| 520 |
\begin{center} |
| 521 |
\begin{corastreatmentoverviewdiagram}[x=.75cm,y=.75cm] |
| 522 |
\corasrisk[ |
| 523 |
name=doc-risk1, |
| 524 |
order=1, |
| 525 |
title={Disclosure\\of data}, |
| 526 |
meta={direct asset}, |
| 527 |
level=unacceptable |
| 528 |
] |
| 529 |
\corasasset[ |
| 530 |
name=doc-asset3, |
| 531 |
order=1, |
| 532 |
title={Data\\privacy} |
| 533 |
] |
| 534 |
\corasjunction[name=doc-junction] |
| 535 |
\corastreatment[ |
| 536 |
name=doc-treatment1, |
| 537 |
order=1, |
| 538 |
title={Limit access} |
| 539 |
] |
| 540 |
\corastreatment[ |
| 541 |
name=doc-treatment2, |
| 542 |
order=2, |
| 543 |
title={Upgrade\\server} |
| 544 |
] |
| 545 |
\corasrelates[from=doc-risk1,to=doc-asset3] |
| 546 |
\corastreats[from=doc-treatment1,to=doc-junction] |
| 547 |
\corastreats[from=doc-treatment2,to=doc-junction] |
| 548 |
\corastreats[from=doc-junction,to=doc-risk1] |
| 549 |
\end{corastreatmentoverviewdiagram} |
| 550 |
\end{center} |
| 551 |
|
| 552 |
\subsection{High-Level Analysis Table} |
| 553 |
|
| 554 |
\begingroup |
| 555 |
\small |
| 556 |
\begin{corashighlevelanalysistable}[ |
| 557 |
caption={Documenting the high-level analysis} |
| 558 |
] |
| 559 |
\corashighlevelanalysisrow |
| 560 |
{Hacker} |
| 561 |
{Breaks into system and compromises integrity or confidentiality of databases} |
| 562 |
{Use of web application and remote access; insufficient access control} |
| 563 |
|
| 564 |
\corashighlevelanalysisrow |
| 565 |
{Employee} |
| 566 |
{Sloppiness compromises integrity or confidentiality of databases} |
| 567 |
{Lack of competence; work processes not aligned with policy} |
| 568 |
|
| 569 |
\corashighlevelanalysisrow |
| 570 |
{System failure} |
| 571 |
{Online store goes down because of failure of web application or loss of network connection} |
| 572 |
{Immature technology; loss of network connection} |
| 573 |
|
| 574 |
\corashighlevelanalysisrow |
| 575 |
{Employee} |
| 576 |
{Collection and processing of personal data diverge from data protection laws} |
| 577 |
{Lack of competence on data protection laws; insufficient routines for processing personal data} |
| 578 |
\end{corashighlevelanalysistable} |
| 579 |
\endgroup |
| 580 |
|
| 581 |
\section{Source Files} |
| 582 |
|
| 583 |
The repository ships these main author-facing files: |
| 584 |
|
| 585 |
\begin{itemize} |
| 586 |
\item \texttt{tex/latex/corasdiagram/corasdiagram.sty} |
| 587 |
\item \texttt{examples/corasdiagram-minimal.tex} |
| 588 |
\item \texttt{examples/corasdiagram-demo.tex} |
| 589 |
\item \texttt{tests/corasdiagram/*.tex} |
| 590 |
\end{itemize} |
| 591 |
|
| 592 |
\section{Build and Release Tooling} |
| 593 |
|
| 594 |
The project includes helper scripts for: |
| 595 |
|
| 596 |
\begin{itemize} |
| 597 |
\item building icon PDFs from the original SVG files |
| 598 |
\item running semantic failure tests |
| 599 |
\item assembling a CTAN-friendly release bundle |
| 600 |
\item building a static documentation site with rendered screenshots |
| 601 |
\end{itemize} |
| 602 |
|
| 603 |
See \texttt{CONTRIBUTING.md} for the current repository-root commands. |
| 604 |
|
| 605 |
\section{License} |
| 606 |
\IfFileExists{LICENSE}{% |
| 607 |
\verbatiminput{LICENSE}% |
| 608 |
}{% |
| 609 |
\verbatiminput{../LICENSE}% |
| 610 |
} |
| 611 |
|
| 612 |
\section{Notice} |
| 613 |
\IfFileExists{NOTICE}{% |
| 614 |
\VerbatimInput[ |
| 615 |
breaklines=true, |
| 616 |
breakanywhere=true |
| 617 |
]{NOTICE}% |
| 618 |
}{% |
| 619 |
\VerbatimInput[ |
| 620 |
breaklines=true, |
| 621 |
breakanywhere=true |
| 622 |
]{../NOTICE}% |
| 623 |
} |
| 624 |
|
| 625 |
\end{document} |