-
Notifications
You must be signed in to change notification settings - Fork 3
/
mkdocs.yml
330 lines (330 loc) · 15 KB
/
mkdocs.yml
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
site_name: Vultron CVD Protocol
site_url: 'https://certcc.github.io/Vultron/'
site_description: 'A protocol for coordinated vulnerability disclosure'
site_author: 'CERT Coordination Center'
copyright: >
Copyright © 2021-2024 Carnegie Mellon University.
<br/><a href="#__consent">Change cookie settings</a>
nav:
- Home: 'https://certcc.github.io/'
- Vultron: 'index.md'
- Learning Vultron: 'tutorials/index.md'
- Understanding Vultron:
- 'topics/index.md'
- Background:
- 'topics/background/index.md'
- Interoperability: 'topics/background/interoperability.md'
- Defining CVD Success: 'topics/background/cvd_success.md'
- Documentation Overview: 'topics/background/overview.md'
- Terms and Definitions: 'topics/background/terms.md'
- Notation: 'topics/background/notation.md'
- Versioning: 'topics/background/versioning.md'
- Process Models:
- 'topics/process_models/index.md'
- Report Management:
- 'topics/process_models/rm/index.md'
- RM Participant Interactions: 'topics/process_models/rm/rm_interactions.md'
- Embargo Management:
- 'topics/process_models/em/index.md'
- Embargo Principles: 'topics/process_models/em/principles.md'
- Default Embargoes: 'topics/process_models/em/defaults.md'
- Negotiating Embargoes: 'topics/process_models/em/negotiating.md'
- Adding Participants: 'topics/process_models/em/working_with_others.md'
- Early Termination: 'topics/process_models/em/early_termination.md'
- Case Splits and Merges: 'topics/process_models/em/split_merge.md'
- Case State:
- 'topics/process_models/cs/index.md'
- Vulnerability Lifecycle Events: 'topics/process_models/cs/events.md'
- CS States: 'topics/process_models/cs/cs_model.md'
- CS Transitions: 'topics/process_models/cs/transitions.md'
- CS Process Model: 'topics/process_models/cs/model_definition.md'
- Model Interactions:
- 'topics/process_models/model_interactions/index.md'
- RM and EM Interactions: 'topics/process_models/model_interactions/rm_em.md'
- RM, EM, CS Interactions: 'topics/process_models/model_interactions/rm_em_cs.md'
- The Vultron Protocol:
- 'topics/formal_protocol/index.md'
- Worked Example: 'topics/formal_protocol/worked_example.md'
- Behavior Logic:
- 'topics/behavior_logic/index.md'
- CVD Behaviors: 'topics/behavior_logic/cvd_bt.md'
- Vulnerability Discovery Behavior: 'topics/behavior_logic/vuldisco_bt.md'
- RM Behaviors:
- 'topics/behavior_logic/rm_bt.md'
- Validation: 'topics/behavior_logic/rm_validation_bt.md'
- Prioritization: 'topics/behavior_logic/rm_prioritization_bt.md'
- Closure: 'topics/behavior_logic/rm_closure_bt.md'
- EM Behaviors:
- 'topics/behavior_logic/em_bt.md'
- Evaluate Proposed Embargo Behavior: 'topics/behavior_logic/em_eval_bt.md'
- Propse Embargo Behavior: 'topics/behavior_logic/em_propose_bt.md'
- Terminate Embargo Behavior: 'topics/behavior_logic/em_terminate_bt.md'
- Do Work Behaviors:
- 'topics/behavior_logic/do_work_bt.md'
- Deployment: 'topics/behavior_logic/deployment_bt.md'
- Fix Development: 'topics/behavior_logic/fix_dev_bt.md'
- Reporting: 'topics/behavior_logic/reporting_bt.md'
- Publication: 'topics/behavior_logic/publication_bt.md'
- Monitoring Threats: 'topics/behavior_logic/monitor_threats_bt.md'
- ID Assignment: 'topics/behavior_logic/id_assignment_bt.md'
- Exploit Acquisition: 'topics/behavior_logic/acquire_exploit_bt.md'
- Receive Messages Behaviors:
- 'topics/behavior_logic/msg_intro_bt.md'
- Receive RM Messages: 'topics/behavior_logic/msg_rm_bt.md'
- Receive EM Messages: 'topics/behavior_logic/msg_em_bt.md'
- Receive CS Messages: 'topics/behavior_logic/msg_cs_bt.md'
- Receive Other Messages: 'topics/behavior_logic/msg_other_bt.md'
- Measuring CVD:
- 'topics/measuring_cvd/index.md'
- Possible Histories: 'topics/measuring_cvd/possible_histories.md'
- Desirable Histories: 'topics/measuring_cvd/desirable_histories.md'
- Random Walks: 'topics/measuring_cvd/random_walk.md'
- Reasoning Over Histories: 'topics/measuring_cvd/reasoning_over_histories.md'
- Discriminating Skill from Luck: 'topics/measuring_cvd/discriminating_skill_and_luck.md'
- Observing Skill: 'topics/measuring_cvd/observing_skill.md'
- Benchmarking CVD: 'topics/measuring_cvd/benchmarking.md'
- Benchmarking MPCVD: 'topics/measuring_cvd/benchmarking_mpcvd.md'
- Other Uses of Vultron:
- 'topics/other_uses/index.md'
- Stakeholder Roles: 'topics/other_uses/roles_influence.md'
- Defining Zero Days: 'topics/other_uses/zero_day.md'
- Policy Formalization: 'topics/other_uses/policy_formalization.md'
- Situation Awareness: 'topics/other_uses/situation_awareness.md'
- VEP: 'topics/other_uses/vep.md'
- CVD Action Rules: 'topics/other_uses/action_rules.md'
- User Stories: 'topics/user_stories/index.md'
- Future Work:
- 'topics/future_work/index.md'
- CS Model Limitations: 'topics/future_work/cs_model_limitations.md'
- CVD Directory: 'topics/future_work/cvd_directory.md'
- Reward Functions: 'topics/future_work/reward_functions.md'
- Ontology: 'topics/future_work/ontology.md'
- Modeling and Simulation: 'topics/future_work/mod_sim.md'
- Implementing Vultron:
- 'howto/index.md'
- A Case Object: 'howto/case_object.md'
- Process Implementation: 'howto/process_implementation.md'
- Vultron ActivityPub:
- 'howto/activitypub/index.md'
- Vultron AS Objects: 'howto/activitypub/objects.md'
- Vultron AS Activities:
- Intro: 'howto/activitypub/activities/index.md'
- Reporting a Vulnerability: 'howto/activitypub/activities/report_vulnerability.md'
- Initializing a Case: 'howto/activitypub/activities/initialize_case.md'
- Managing a Case: 'howto/activitypub/activities/manage_case.md'
- Transferring a Case: 'howto/activitypub/activities/transfer_ownership.md'
- Suggest an Actor for a Case: 'howto/activitypub/activities/suggest_actor.md'
- Invite an Actor to a Case: 'howto/activitypub/activities/invite_actor.md'
- Initialize a Participant: 'howto/activitypub/activities/initialize_participant.md'
- Manage Case Participants: 'howto/activitypub/activities/manage_participants.md'
- Establish an Embargo: 'howto/activitypub/activities/establish_embargo.md'
- Manage an Embargo: 'howto/activitypub/activities/manage_embargo.md'
- Status Updates: 'howto/activitypub/activities/status_updates.md'
- Acknowledging a Report: 'howto/activitypub/activities/acknowledge.md'
- Error Handling: 'howto/activitypub/activities/error.md'
- EM and iCalendar: 'howto/em_icalendar.md'
- General Notes: 'howto/general_implementation.md'
- Reference:
- 'reference/index.md'
- Formal Protocol:
- 'reference/formal_protocol/index.md'
- States: 'reference/formal_protocol/states.md'
- Messages: 'reference/formal_protocol/messages.md'
- Transitions: 'reference/formal_protocol/transitions.md'
- Protocol Summary: 'reference/formal_protocol/conclusion.md'
- Case States:
- 'reference/case_states/index.md'
- vfdpxa: 'reference/case_states/state_vfdpxa.md'
- vfdpxA: 'reference/case_states/state_vfdpx_a_.md'
- vfdpXa: 'reference/case_states/state_vfdp_x_a.md'
- vfdpXA: 'reference/case_states/state_vfdp_x__a_.md'
- vfdPxa: 'reference/case_states/state_vfd_p_xa.md'
- vfdPxA: 'reference/case_states/state_vfd_p_x_a_.md'
- vfdPXa: 'reference/case_states/state_vfd_p__x_a.md'
- vfdPXA: 'reference/case_states/state_vfd_p__x__a_.md'
- Vfdpxa: 'reference/case_states/state__v_fdpxa.md'
- VfdpxA: 'reference/case_states/state__v_fdpx_a_.md'
- VfdpXa: 'reference/case_states/state__v_fdp_x_a.md'
- VfdpXA: 'reference/case_states/state__v_fdp_x__a_.md'
- VfdPxa: 'reference/case_states/state__v_fd_p_xa.md'
- VfdPxA: 'reference/case_states/state__v_fd_p_x_a_.md'
- VfdPXa: 'reference/case_states/state__v_fd_p__x_a.md'
- VfdPXA: 'reference/case_states/state__v_fd_p__x__a_.md'
- VFdpxa: 'reference/case_states/state__v__f_dpxa.md'
- VFdpxA: 'reference/case_states/state__v__f_dpx_a_.md'
- VFdpXa: 'reference/case_states/state__v__f_dp_x_a.md'
- VFdpXA: 'reference/case_states/state__v__f_dp_x__a_.md'
- VFdPxa: 'reference/case_states/state__v__f_d_p_xa.md'
- VFdPxA: 'reference/case_states/state__v__f_d_p_x_a_.md'
- VFdPXa: 'reference/case_states/state__v__f_d_p__x_a.md'
- VFdPXA: 'reference/case_states/state__v__f_d_p__x__a_.md'
- VFDpxa: 'reference/case_states/state__v__f__d_pxa.md'
- VFDpxA: 'reference/case_states/state__v__f__d_px_a_.md'
- VFDpXa: 'reference/case_states/state__v__f__d_p_x_a.md'
- VFDpXA: 'reference/case_states/state__v__f__d_p_x__a_.md'
- VFDPxa: 'reference/case_states/state__v__f__d__p_xa.md'
- VFDPxA: 'reference/case_states/state__v__f__d__p_x_a_.md'
- VFDPXa: 'reference/case_states/state__v__f__d__p__x_a.md'
- VFDPXA: 'reference/case_states/state__v__f__d__p__x__a_.md'
- Code:
- vultron: 'reference/code/index.md'
- case_states: 'reference/code/case_states.md'
- Behavior Trees:
- BT: 'reference/code/bt/behavior_trees.md'
- Base: 'reference/code/bt//bt_base.md'
- Nodes: 'reference/code/bt/bt_base_nodes.md'
- Pacman Demo: 'reference/code/bt/pacman_demo.md'
- Robot Demo: 'reference/code/bt/robot_demo.md'
- Vultrabot Demo: 'reference/code/bt/vultrabot_demo.md'
- Vultron Case State BT: 'reference/code/bt/case_states.md'
- ActivityStreams Vocabulary:
- 'reference/code/as_vocab/index.md'
- Base Package: 'reference/code/as_vocab/as_base.md'
- Base Objects: 'reference/code/as_vocab/as_objects.md'
- Base Links: 'reference/code/as_vocab/as_links.md'
- Base Activities: 'reference/code/as_vocab/as_activities.md'
- Vultron Extensions: 'reference/code/as_vocab/vultron.md'
- Vultron Objects: 'reference/code/as_vocab/v_objects.md'
- Vultron Activities: 'reference/code/as_vocab/v_activities.md'
- Ontology:
- 'reference/ontology/index.md'
- Vultron_AS: 'reference/ontology/vultron_as.md'
- Vultron_Protocol: 'reference/ontology/vultron_protocol.md'
- Vultron_Process: 'reference/ontology/vultron_process.md'
- DFA: 'reference/ontology/dfa.md'
- RFC 2119: 'reference/ontology/rfc2119.md'
- ISO Crosswalk:
- 'reference/iso_crosswalks/index.md'
- ISO 30111: 'reference/iso_crosswalks/iso_30111_2019.md'
- ISO 29147: 'reference/iso_crosswalks/iso_29147_2018.md'
- ISO 5895: 'reference/iso_crosswalks/iso_5895_2022.md'
- SSVC Crosswalk: 'reference/ssvc_crosswalk.md'
- Decision Records:
- 'adr/index.md'
- Record decisions: 'adr/0000-record-architecture-decisions.md'
- Use MADR: 'adr/0001-use-markdown-any-decision-records.md'
- Use Behavior Trees: 'adr/0002-model-processes-with-behavior-trees.md'
- Build a Behavior Tree library: 'adr/0003-build-custom-python-bt-engine.md'
- Use Factory Pattern for BT nodes: 'adr/0004-use-factory-methods-for-common-bt-node-types.md'
- Use ActivityStreams Vocabulary as Message Format: 'adr/0005-activitystreams-vocabulary-as-vultron-message-format.md'
- Use CalVer for Versioning: 'adr/0006-use-calver-for-project-versioning.md'
- About:
- Contributing: 'about/contributing.md'
- FAQ: 'about/faq.md'
- Acknowledgements: 'about/acknowledgements.md'
- License: 'about/license.md'
not_in_nav: |
_*.md
_*/**/*.md
includes/*
topics/user_stories/story_*.md
*diagram*.md
*table*.md
*.ttl
theme:
logo: 'assets/cert_seal.svg'
name: 'material'
features:
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- navigation.prune
- navigation.indexes
- search.highlight
- search.suggest
- toc.follow
palette:
scheme: 'cmu'
accent: 'red'
icon:
repo: fontawesome/brands/github
plugins:
- bibtex:
bib_file: 'references.bib'
- include-markdown:
comments: false
- mkdocstrings:
enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
handlers:
python:
paths: [ 'src' ]
options:
show_bases: true
show_root_heading: true
heading_level: 2
- markdown-exec
- search
# NOTE print-site MUST be the last plugin in the list (see its docs for why)
- print-site
repo_url: 'https://github.com/CERTCC/Vultron'
repo_name: 'CERTCC/Vultron'
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.arithmatex:
generic: true
- pymdownx.critic
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.keys
- pymdownx.mark
- pymdownx.snippets:
auto_append:
- docs/_acronyms/index.md
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- tables
extra:
analytics:
provider: google
property: G-87WECW6HCS
consent:
title: About our use of cookies on this site
description: >-
We use cookies to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
See our <a href="https://www.sei.cmu.edu/legal/privacy-notice/index.cfm">Privacy Notice</a> for more.
social:
- icon: fontawesome/solid/bug
link: https://github.com/CERTCC/Vultron/issues
name: Report an Issue or Suggest a Change
- icon: fontawesome/brands/github
link: https://github.com/CERTCC/Vultron
name: CERTCC/Vultron on Github
- icon: fontawesome/regular/envelope
link: mailto:[email protected]?subject=Vultron%20Protocol%20Feedback
name: Email CERT/CC
- icon: fontawesome/solid/house
link: https://www.sei.cmu.edu/
name: Software Engineering Institute
extra_javascript:
# to render math
- javascripts/mathjax.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# to sort tables
- https://unpkg.com/[email protected]/dist/tablesort.min.js
- javascripts/tablesort.js
extra_css:
- stylesheets/extra.css