OSCP-Notes-Template

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

OSCP-Notes-Template

★ 309 Open GitHub ↗

A template Obsidian Vault for storing your OSCP revision notes

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OSCP Notes Template

**Important Note**: if you use this repository, make sure you do not publicly share your OSCP notes by accident (i.e. in a public fork of this repo) or OffSec will be [angry](https://cdn.emojidex.com/emoji/seal/Angryping.png). I am not responsible if you do so and lose access to your course - please be careful and clone this resource locally rather than forking it! If you want your notes on GitHub (which I agree is useful) follow these steps to create a private fork: https://stackoverflow.com/questions/10065526/github-how-to-make-a-fork-of-public-repository-private

## Introduction

This is a template for an Obsidian Vault used to store OSCP notes. Obsidian allows building a highly connected, searchable resource that you can use to find examples of code snippets and connect related machines.

The [[Course Notes Index|Course Notes]], [[Exam Index|Exam]], and [[Labs Index|Labs]] folders contain template folders for you to add your notes for these respective sections to.

I cannot upload my OSCP notes due to OffSec policy, but I still wanted to share a useful resource. There are plenty of [[Report Templates]] out there, and some good [note-taking advice](https://www.youtube.com/watch?v=MQGozZzHUwQ), but I haven't seen a structured notes template before. Hopefully this will be useful for future students who want to supplement their learning.

I've added a few resources to each of the notes, but they are there for you to flesh out (or delete) at your will. This is simply a template, and more detailed notes are available in my [[Cybersecurity Notes]] repository.

## Installation

### Installing Obsidian

#### On Windows

Go to [the download page](https://obsidian.md/download)... and click Download. Once it's downloaded, double click the executable to run it.

#### On Linux

Go to [the download page](https://obsidian.md/download), and download the AppImage. Put it in any directory you want (I went with `~/Applications`)

You can either double click the file to run it, or run it with `/path/to/Obsidian-0.11.9.AppImage`

You may get the following error while running:

```bash
$ ./Obsidian-0.11.9.AppImage  
\[2122:0327/193255.690087:FATAL:setuid\_sandbox\_host.cc(158)\] The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing I'm aborting now. You need to make sure that /tmp/.mount\_Obsidi1nvAuD/chrome-sandbox is owned by root and has mode 4755.  
Trace/breakpoint trap
```

To fix this, run obsidian with the `--no-sandbox` flag.

I setup this alias in `~/.bashrc`:

```bash
alias obsidian="~/Applications/Obsidian-0.11.9.AppImage --no-sandbox"
```

Finally, if Obsidian stops responding on launch, you may need to update your machine:

```bash
$ sudo apt update
$ sudo apt full-upgrade -y
```

### Downloading the Vault

You will need to [download git](https://git-scm.com/downloads). This is a quick and easy process.

On Windows, open the Start Menu and search for 'Git Bash', then click it to open a bash terminal (or navigate to the folder you want to install the notes into, then right-click and press 'Git Bash Here'). On Unix, open a terminal of your choice.

In this Git Bash/terminal, type the following:

```bash
git clone git@github.com:Twigonometry/OSCP-Notes-Template.git
```

If you are uncomfortable using the command line, you can install [GitHub Desktop](https://desktop.github.com/) instead (but you'll need to learn it soon enough!)

Once you have cloned the repository, open Obsidian and click `Open folder as vault`, then select the `OSCP-Notes-Template` folder that was just created by Git. You're ready to go!

## Usage

### Approach

Everyone's note-taking approach is different. Some people might hate Obsidian, but personally I found it very useful for organising and linking my notes, especially when an OSCP box had an exploit I'd seen before and I could link the two notes together.

I could also use the graph to track where I'd found certain secrets across the network, and which boxes talked to each other. I stored both my machine writeups and my course content notes in the same vault, so I could also easily link examples in the course material to practical examples from the labs.

Here is an example of the graph Obsidian can generate, with all related notes linked together:

![[Pasted image 20210813180944.png]]

Organising notes this way may seem like a lot of overhead. I don't recommend making your notes this fleshed out while solving the box, but I do think it is useful to go back and complete this process after you've finished. It will help consolidate what you've learned, and make examples of exploits easier to find during the exam.

You can treat this as a true [Zettelkasten](https://zenkit.com/en/blog/a-beginners-guide-to-the-zettelkasten-method/), with each note representing a [[Find Writeable Directories|singular concept]] - or you can have notes that show [[15 - Shell as Andy|a narrative]]. I prefer a mix - notes on tools are good as singular items, and writeups of machines are good to read in one long document. Cheat sheets can be used to link the two with examples.

### Course Content

You can make notes on course content within the [[Course Notes Index|Course Notes]] folder. I like to include example commands within code fences (single/triple backtick ``` ` ``` characters).

I like keeping my notes within headings so that I can then link these headers to a practical example on a machine, using `[[course chapter#section]]`.

### Writing up Lab Machines

The [[Labs Index|Labs]] folder can be used to house writeups for machines in the labs. I've added a folder for each one, with `IP Address (Hostname)` as the title.

Within each folder is an index for the machine, which links all the related notes on the graph, an Overview which outlines key machine details, and usually a 'Lessons Learned' note which highlights important new skills or tools I learned solving the box (or things I did wrong).

See [[Labs/10.0.0.1 (Andy)/00 - Overview]] for a fleshed out example Box Overview.

I then create a note for each 'stage' of the box - commonly one for generic enumeration, one for each service I interact with beyond standard enum scripts, and one for each shell I gain as a specific user.

### Resources

You will find assorted OSCP resources in the `/Resources` folder. They vary from collections of advice posts on various forums, to extra cheatsheets and tools to make your life easier. Feel free to add to this folder as you find things.

### Obsidian Tricks

Obsidian makes it super easy to build good notes. Here are some of the best features:
- `Ctrl + K` for inserting links
- `[[note]]` for referencing an internal note and creating a graph. You can use a pipe (`|`) to name the link, or a hash (`#`) to link to a heading in the note
- `Ctrl + G` to view your graph
- `Ctrl + L` to view a 'local graph' for a note - this lets you explore connections to a note
- `Ctrl + Click` a note link to open it in a new tab (Obsidian [now supports tabs!](https://forum.obsidian.md/t/obsidian-release-v1-0-0/44873))

You can add screenshots, headings, and any other formatting option supported by markdown.

You can also make use of the document outline feature (in the right-hand side panel) for an automatically generated contents page.

#### Canvases

Obsidian has a neat new feature called a Canvas which can be used to lay out notes in a free-flowing diagram. You can link existing notes, add images, and create notes that only exist in the canvas. It's potentially useful for Active Directory sets - I've included an [[Active Directory Set.canvas|Example]] in the `/Exam` folder.

#### Workspaces

You can open a workspace using the workspace button in the left-hand sidebar - this loads a saved layout of notes. You can group together notes you open together frequently (such as a specific lab machine and notes on relevant exploits from the course material) and save your current workspace using the 'save' button.

#### PDF Generation

You can create a PDF of a note with the 'Export to PDF' button in the kebab menu at the top of each note.

![[Pasted image 20230324145839.png]]

Bear in mind that Obsidian links will no longer work.

#### Website-Friendly Note Conversion

If you want to host your notes on a website, you can convert them to a HTML-friendly format using my [writeup converter](https://github.com/Twigonometry/writeup-converter#website-formatter) tool - this combines all markdown files in a given folder into one HTML document, and reformats obsidian links (`[[]]`) and turns them into valid HTML tags.

Remember not to host your writeups or any OffSec course content online...

#### Screenshots

Attachments (i.e. images) are set to be stored in the `/Attachments` folder automatically. If you copy and paste an image into Obsidian it will be automatically named and indexed.

## Roadmap

To add to template:
- [x] Instructions for converting Lab report to a PDF
- [x] Workspaces
- [ ] Hotkeys
- [x] Exam tips
- [x] Cheatsheets
- [x] Enable outlines plugin
- [ ] Timeline plugin support
- [ ] Flameshot setup
- [x] Updated exam details
- [x] AD set layout
- [x] Example Canvas for AD set

OSCP-Notes-Template

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README