Skip to content

Commit

Permalink
INITIAL: Initial commit for Cybersecurity Work Org Mode Templates
Browse files Browse the repository at this point in the history
  • Loading branch information
eduardo-robles committed May 30, 2023
0 parents commit ee7a355
Show file tree
Hide file tree
Showing 11 changed files with 285 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Capture Templates/bullet.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* NEXT %^{task} %^G
Scheduled: %T
Captured: %u
10 changes: 10 additions & 0 deletions Capture Templates/contacts.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
** %^{Name} %^G
:PROPERTIES:
:EMAIL: %^{Email}
:PHONE: %^{Phone}
:ALIAS: %^{Alias}
:NICKNAME:
:NOTE: %^{Note}
:ADDRESS: %^{Address}
:BIRTHDAY:
:END:
32 changes: 32 additions & 0 deletions Capture Templates/investigations.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
** IN-PROGRESS Investigation#:%^{Investigaton} Date Created: %T
:properties:
:export_file_name: %^{filename}
:end:
*** Vendor
%^{Vendor|AAAA|BBBB|CCCC|DDDD}
*** Title
%^{Title}
*** Assigned:
%^{Assigned}
*** Contacts
%^{Contacts}
*** Description
%^{Description}
*** Questions
1.
2.
3.
*** Solutions [%]
- [ ]
- [ ]
- [ ]
*** Notes
:LOGBOOK:
:END:
*** Debug/Troubleshooting Logs
:LOGBOOK:
:END:
*** Email/Chat Logs
:LOGBOOK:

:END:
29 changes: 29 additions & 0 deletions Capture Templates/issue.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
* IN-PROGRESS Issue:%^{Issue} Date Created: %T %^G
:properties:
:export_file_name: %^{filename}
:end:
** %^{Title}

** Description*
%^{Description}

** Notes


** Questions
1.
2.
3.

** Solution [%]
- [ ]
- [ ]
- [ ]

** Contacts
-

** Email/Chat Logs
:LOGBOOK:

:END:
26 changes: 26 additions & 0 deletions Capture Templates/meeting.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#+TITLE: Meetings Template
#+SETUPFILE:
#+AUTHOR:
#+EMAIL:

* Title

* Date

* Purpose:

* Location:

* Attendees:

* Discussion:
:LOGBOOK:

:END:
* Action Items:

* Next Steps:

* Next Meeting:

* Notes:
4 changes: 4 additions & 0 deletions Capture Templates/notes.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* %^{Name} Captured %^G
%^{Note Type|note|quote|one-liner|code|link}
Created on: %T
%?
14 changes: 14 additions & 0 deletions Capture Templates/project.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
** %^{Title} %^G
:properties:
:export_file_name: %^{filename}
:end:
*** Description
%^{Description}
*** Scope: [%]
- [ ]
- [ ]
- [ ]
*** Solution: [%]
- [ ]
- [ ]
- [ ]
65 changes: 65 additions & 0 deletions Capture Templates/readme-template.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
* %^{PROJECT TITLE}
:PROPERTIES:
:EXPORT_FILE_NAME: %^{exportfilename}
:CUSTOM_ID: %^{customheadingid}
:END:


** Vendor Information

** Description

An in-depth paragraph about your project and overview of use.

** Getting Started

*** Dependencies

- Describe any prerequisites, libraries, OS version, etc., needed before
installing program.
- ex. Windows 10

*** Installing

- How/where to download your program
- Any modifications needed to be made to files/folders

*** Executing program

- How to run the program
- Step-by-step bullets

#+BEGIN_SRC
code blocks for commands
#+END_SRC
** Help

Any advise for common problems or issues.

command to run if program contains helper info

** Authors

Contributors names and contact info

ex. Dominique Pizzie
ex. [[https://twitter.com/dompizzie][@DomPizzie]]

** Version History

- 0.2
- Various bug fixes and optimizations
- See [[][commit change]] or See [[][release history]]
- 0.1
- Initial Release

** License

This project is licensed under the [NAME HERE] License - see the
LICENSE.md file for details

** Acknowledgments

Inspiration, code snippets, etc.
[[https://github.com/matiassingers/awesome-readme][awesome-readme]]
[[https://gist.github.com/PurpleBooth/109311bb0361f32d87a2][PurpleBooth]]
29 changes: 29 additions & 0 deletions Capture Templates/supportcases.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
* IN-PROGRESS Case Number#:%^{Case-Number} Date Created: %T
** Vendor
%^{Vendor|AAAA|BBBB|CCCC}
** Title
%^{Title}
** Contacts
%^{Contacts}
** Description
%^{Description}
** Notes
:LOGBOOK:

:END:
** Questions
1.
2.
3.
** Solutions
- [ ]
- [ ]
- [ ]
** Email/Chat Logs
:LOGBOOK:

:END:
** Debug/Troubleshooting Logs
:LOGBOOK:

:END:
2 changes: 2 additions & 0 deletions Capture Templates/todo.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* TODO %^{todo} %^G
Scheduled: %T
71 changes: 71 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
#+TITLE: Cybersecurity Work Org Mode Templates
#+AUTHOR: Eduardo Robles
#+EMAIL: [email protected]

* Cybersecurity Work Org Mode Templates
:PROPERTIES:
:CUSTOM_ID: cybersecurity-work-orgmode-templates
:END:
** About
:PROPERTIES:
:CUSTOM_ID: about
:END:
In the cybersecurity work environment staying organized and good note taking is vital. You can track notes on incidents, investigations, support tickets, meeting, and much more. In my day to day work as a Cybersecurity Analyst I use [[https://www.gnu.org/software/emacs/][GNU Emacs]] and [[https://orgmode.org/][Org Mode]] to stay organized. The new and shiny applications that resemble this workflow are Obsidian, Notion, and LogSeq. The benefit of using GNU Emacs is you get to weave your documentation with actual code in a [[https://en.wikipedia.org/wiki/Literate_programming][Literate Programming]] kind of manner. This make collaboration and sharing easier and feature rich.

As explained by their concept of [[https://howardism.org/Technical/Emacs/literate-devops.html][Literate Devops]], Howard Abrams states:

#+BEGIN_QUOTE
While my literate devops approach shouldn’t replace real DevOps (OpsDev?) automation, I have found this approach useful for two reasons:

1. As a good way to take notes before writing a cookbook.
2. As an easy approach to compose emails to teammates when stuck.
#+END_QUOTE

You can extend the concepts of Literate Programming and Literate DevOps to Cybersecurity work. You find yourself stuck during a Pentest? Just ~org-mime-org-buffer-htmlize~ to export the section your stuck and send to a coworker. Howard Abrams talks about using the power of [[https://orgmode.org/worg/org-contrib/babel/][Org Babel]] and [[https://www.gnu.org/software/tramp/][Tramp]] to work with servers, VMs, and remote machines. There is nothing stopping you from doing the same with these templates. Maybe this is the start of /Literate Pentesting/?

*** Prerequisites
:PROPERTIES:
:CUSTOM_ID: prerequisites
:END:
- GNU Emacs 26+
- Org Mode

*** Installing
:PROPERTIES:
:CUSTOM_ID: installing
:END:
- Download this repo and place the templates in your template directory or wherever you see fit.
- Create the main document where your capture templates will be "captured" too.
1.
- Setup your Org Capture templates to use these templates

For example:
#+BEGIN_SRC elisp
(setq org-capture-templates
'(("t" "Todo" entry (file+headline "~/Org/log.org" "Tasks")(file "~/templates/todo.org"))
("c" "Contact" entry (file+headline "~/Org/contacts.org" "Work Contacts")(file "~/templates/contacts.org"))
("s" "Support Case" entry (file+headline "~/documents/external/vendor_supportcases.org" "Cases")(file "~/templates/supportcases.org"))
("p" "Projects" entry (file+headline "~/documents/internal/projects/projects.org" "Projects")(file "~/templates/project.org"))
("e" "Issues" entry (file+headline "~/documents/internal/projects/projects.org" "Projects")(file "~/templates/issue.org"))
("i" "Investigations" entry (file+headline "~/documents/internal/incident/investigations.org" "Investigations")(file "~/templates/investigations.org"))
("m" "README" entry (file+headline "~/Org/READMES/all_readme_files.org" "READMES")(file "~/templates/README.org")))
#+END_SRC
** Usage
:PROPERTIES:
:CUSTOM_ID: usage
:END:
You can create you own files to capture data into. For example I use the following scheme:

- ~/documents/incidents/investigations.org~

Then I capture all my data into /investigations.org/ which gets timestamped.
** Authors
[[https:eduardorobles.com][Eduardo Robles]] - Idea and Initial work
** Acknowledgements
- Literate DevOps by Howard Abrams
** License
#+BEGIN_EXPORT html
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
#+END_EXPORT
** Contributions
[[https://www.buymeacoffee.com/eduardorobles][https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png]]

0 comments on commit ee7a355

Please sign in to comment.