Offsec資格のレポート作成を楽にするメモ with Obsidian
ToC
はじめに
Obsidianを使用したOffsec試験のレポート作成方法。
エディタとしてObsidian、Markdown → PDFへの変換ツールとしてpandocを使用する。
細かいところの設定を忘れがちなので備忘として。
Obsidianのインストール
ここから
obsidian-pandocのインストール
依存パッケージをインストール
sudo apt install texlive-latex-recommended texlive-fonts-extra texlive-latex-extra pandoc
Community Pluginの有効化
pandocで検索
Install
Enable
Options
pandoc path
which pandocのファイルパスをpandoc pathに入力する
Extra Pandoc argumentsに``のREADMEに記載のオプションを入力する
--template eisvogel
--from markdown+yaml_metadata_block+raw_html
--table-of-contents
--toc-depth 4
--number-sections
--top-level-division=chapter
--highlight-style breezedark
--resource-path=.:src
OSCP-Exam-Report-Template-Markdownから使用するテンプレートをダウンロードし、ObsidianにドラッグアンドドロップするなどしてVault内にコピーしておく。
wget https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/raw/master/src/OSCP-exam-report-template_whoisflynn_v3.2.md -O OSCP-exam-report-template.md
OSCP-Exam-Report-Template-Markdownが依存しているeisvogel.latexを~/.pandoc/templates/に配置する
mkdir -p ~/.pandoc/templates/
wget https://github.com/Wandmalfarbe/pandoc-latex-template/releases/download/2.4.2/Eisvogel-2.4.2.zip -O ~/.pandoc/templates/eisvogel.latex.zip
cd ~/.pandoc/templates
unzip eisvogel.latex.zip
ls -1 | grep -v -E '^eisvogel.latex$' | xargs rm -rf
この時点でCtrl+pからコマンドパレットにpandoc pdfと入力し、Pandoc Plugin: Export as PDF (via LaTeX)を選択するとMarkdownをPDFに変換できる。
注意点
画像のパス
設定によってObisidian上で貼り付けた画像(スクリーンショット等)のパスが認識されずPDF上に画像が出力されない可能性がある。
Markdown
この場合、設定のUse [[wikilinks]]を有効にすることで画像がPDFに出力されるようになります。
Markdown
CodeBlock内の文字列がはみ出す
CodeBlock内の文字列が長すぎる場合、紙面からコードがはみ出る場合がある。
Markdown
Extra Pandoc argumentsに--listingsを追加する。
--template eisvogel
--from markdown+yaml_metadata_block+raw_html
--table-of-contents
--toc-depth 4
--number-sections
--top-level-division=chapter
--highlight-style breezedark
--resource-path=.:src
+ --listings
この設定で再度PDFを出力すると、はみ出た部分が折り返される。
まとめ
OSCPで使ったけどめちゃくちゃ楽♥