Skip to content

Commit 1741009

Browse files
authored
Merge branch 'main' into libafl-section
2 parents ce2759b + 655a66e commit 1741009

File tree

81 files changed

+3415
-58
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+3415
-58
lines changed

.github/workflows/hugo.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
build:
3131
runs-on: ubuntu-latest
3232
env:
33-
HUGO_VERSION: 0.122.0
33+
HUGO_VERSION: 0.133.0
3434
steps:
3535
- name: Install Hugo CLI
3636
run: |

.github/workflows/markdown.yml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,23 @@ jobs:
1111
markdown-link-check:
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@master
15-
- uses: gaurav-nelson/github-action-markdown-link-check@v1
14+
- uses: actions/checkout@v4
15+
- name: Restore lychee cache
16+
uses: actions/cache@v4
1617
with:
17-
use-quiet-mode: 'yes'
18+
path: .lycheecache
19+
key: cache-lychee-${{ github.sha }}
20+
restore-keys: cache-lychee-
21+
- uses: lycheeverse/lychee-action@2b973e86fc7b1f6b36a93795fe2c9c6ae1118621 # for v1.10.0
22+
with:
23+
args: --base . -a 100..=103,200..=299,429 --verbose --no-progress --cache --max-cache-age 1d --scheme http --scheme https './**/*.md' './layout/shortcodes/fuzzing/*.html'
24+
fail: true
1825
# Lint Markdown files
1926
# Uses: a custom configuration file
2027
markdown-linter:
2128
runs-on: ubuntu-latest
2229
steps:
23-
- uses: actions/checkout@v3
30+
- uses: actions/checkout@v4
2431
- uses: DavidAnson/markdownlint-cli2-action@v15
2532
with:
2633
globs: "**/*.md"
@@ -29,7 +36,7 @@ jobs:
2936
spellcheck:
3037
runs-on: ubuntu-latest
3138
steps:
32-
- uses: actions/checkout@v3
39+
- uses: actions/checkout@v4
3340
- uses: tbroadley/spellchecker-cli-action@v1
3441
with:
3542
# No need to use a dictionary file with the disabled spell plugin

.github/workflows/preview.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
build-deploy:
2525
runs-on: ubuntu-latest
2626
env:
27-
HUGO_VERSION: 0.122.0
27+
HUGO_VERSION: 0.133.0
2828
steps:
2929
- name: Install Hugo CLI
3030
run: |
@@ -33,7 +33,7 @@ jobs:
3333
- name: Install Dart Sass Embedded
3434
run: sudo snap install dart-sass-embedded
3535
- name: Checkout
36-
uses: actions/checkout@v3
36+
uses: actions/checkout@v4
3737
with:
3838
submodules: recursive
3939
- name: Install Node.js dependencies

.markdownlint.jsonc

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -75,30 +75,30 @@
7575

7676
// MD013/line-length - Line length
7777

78-
"MD013": {
79-
// Number of characters
80-
"line_length": 130,
81-
// Number of characters for headings
82-
"heading_line_length": 120,
83-
// Number of characters for code blocks
84-
"code_block_line_length": 120,
85-
// Include code blocks
86-
"code_blocks": true,
87-
// Include tables
88-
"tables": true,
89-
// Include headings
90-
"headings": true,
91-
// Include headings
92-
"headers": true,
93-
// Strict length checking
94-
"strict": false,
95-
// Stern length checking
96-
"stern": false
97-
},
78+
// "MD013": {
79+
// // Number of characters
80+
// "line_length": 130,
81+
// // Number of characters for headings
82+
// "heading_line_length": 120,
83+
// // Number of characters for code blocks
84+
// "code_block_line_length": 120,
85+
// // Include code blocks
86+
// "code_blocks": true,
87+
// // Include tables
88+
// "tables": true,
89+
// // Include headings
90+
// "headings": true,
91+
// // Include headings
92+
// "headers": true,
93+
// // Strict length checking
94+
// "strict": false,
95+
// // Stern length checking
96+
// "stern": false
97+
// },
9898

9999

100100
// Disable line length check:
101-
// "MD013" : false,
101+
"MD013" : false,
102102

103103
// MD014/commands-show-output - Dollar signs used before commands without showing output
104104
"MD014": true,

README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,19 @@ hope to demystify static and dynamic analysis techniques such as fuzzing and tai
2929
|[Semgrep](https://appsec.guide/docs/static-analysis/semgrep/)| [Announcing the Trail of Bits Testing Handbook](https://blog.trailofbits.com/2023/07/26/announcing-the-trail-of-bits-testing-handbook/)|2023|
3030
|[CodeQL](https://appsec.guide/docs/static-analysis/codeql/)| [Say hello to the next chapter of the Testing Handbook!](https://blog.trailofbits.com/2023/12/11/say-hello-to-the-next-chapter-of-the-testing-handbook/)|2023|
3131
|[Fuzzing](https://appsec.guide/docs/fuzzing/)| [Master fuzzing with our new Testing Handbook chapter](https://blog.trailofbits.com/2024/02/09/master-fuzzing-with-our-new-testing-handbook-chapter/)|2024|
32+
|[Burp](https://appsec.guide/docs/web/burp/)| [Announcing the Burp Suite Professional chapter in the Testing Handbook](https://blog.trailofbits.com/2024/06/14/announcing-the-burp-suite-professional-chapter-in-the-testing-handbook/)|2024|
33+
| [Cryptographic testing - Wycheproof and Constant time analysis tooling](https://appsec.guide/docs/crypto/) | TBD | 2024 |
3234

3335
### 🎥 Webinars
3436

3537
| Topic | Link |
3638
|---|---|
3739
| Introduction to Semgrep | https://www.youtube.com/watch?v=yKQlTbVlf0Q |
3840
| Introduction to CodeQL: Examples, Tools and CI Integration | https://www.youtube.com/watch?v=rQRlnUQPXDw |
41+
| Mastering Web Research with Burp Suite | https://www.youtube.com/watch?v=0PV5QEQTmPg |
3942

4043
### 🚧 Under construction
4144

42-
- Burp Suite Professional
4345
- Formal verification and Tamarin
4446
- Rust
4547

@@ -111,7 +113,7 @@ Your browser will be automatically refreshed with changes whenever you save a fi
111113
112114
- The GitHub workflow in this repository verifies the correctness of Markdown files through three checks:
113115
1. **Markdown Link Check**: This step extracts links from Markdown files and verifies if they are valid and accessible.
114-
It uses the [github-action-markdown-link-check](https://github.com/gaurav-nelson/github-action-markdown-link-check) action.
116+
It uses the [lychee link checking action](https://github.com/lycheeverse/lychee-action).
115117
2. **Markdown Linter**: This step ensures that Markdown files adhere to the desired style and formatting rules.
116118
It uses a custom configuration file (`.github/workflows/.markdownlint.jsonc`) and the
117119
[markdownlint-cli2-action](https://github.com/DavidAnson/markdownlint-cli2-action) action.
@@ -135,22 +137,7 @@ since it is the title of a document. But if you'd like to avoid the capitalizati
135137
136138
### Workflow: From Google Docs
137139
138-
1. Make your document viewable via a link share.
139-
2. Create a Google account or use your private one (If you use this method, your document should be considered public but unpublished).
140-
3. Install [Docs to Markdown](https://workspace.google.com/marketplace/app/docs_to_markdown/700168918607).
141-
This addon works better than the pandoc.
142-
4. Open the document and make a copy.
143-
5. Open the copy and run the Addon.
144-
6. Export the markdown and apply fixes:
145-
- Search for occurrences of `<code>` or `<strong>` or any other html tags
146-
- Replace HTML tables with markdown ones (<https://jmalarcon.github.io/markdowntables/>)
147-
- If you split your document, fix internal links.
148-
- Add missing images.
149-
- Fix `&lt;`, …, “, ’
150-
- Adjust markdown captions ## -> #
151-
- Verify missing formatting in PRO TIPs
152-
- . at the end of fig captions?
153-
- Note that index bundles do not use the "slug"
140+
You can export the document from Google Docs as Markdown. Open the document in Google Docs. Click `File` > `Download`, and then select `Markdown (.md)`.
154141
155142
### Custom environments
156143

assets/_custom.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,4 +160,4 @@ html {
160160
::-webkit-scrollbar-thumb {
161161
background: var(--gray-500);
162162
border-radius: $padding-8;
163-
}
163+
}

config.toml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ enableEmoji = true
1010
# Comment to make pages uneditable with a github link ("Edit this page" in the footer):
1111
BookRepo = "https://github.com/trailofbits/testing-handbook"
1212
BookEditBranch = "main"
13+
math = false
1314

1415
[params.render_hooks.link]
1516
errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
@@ -30,4 +31,12 @@ enableEmoji = true
3031
[markup.goldmark.renderer]
3132
unsafe = false
3233
[markup.goldmark.parser.attribute]
33-
block = true
34+
block = true
35+
[markup.goldmark]
36+
[markup.goldmark.extensions]
37+
[markup.goldmark.extensions.passthrough]
38+
enable = true
39+
[markup.goldmark.extensions.passthrough.delimiters]
40+
block = [['$$', '$$']]
41+
inline = [['\(', '\)']]
42+

content/_index.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,21 @@ We currently cover the following tools and techniques:
6565
### Dynamic analysis
6666

6767
- [Fuzzing]({{< relref "fuzzing" >}})
68+
- [Burp Suite Professional]({{< relref "/docs/web/burp/" >}})
6869

6970
{{< /columns >}}
7071

7172
We are working on expanding the tools we cover here. We are also planning to
72-
cover several dynamic analysis tools. Stay tuned for updates from our team!
73+
cover several other security-related topics. Stay tuned for updates from our team!
74+
75+
### Upcoming (!)
76+
77+
- Formal verification and Tamarin
78+
- Rust security
79+
- How to apply taint analysis in a directed fuzzing loop or/and for results verification
80+
- Taking effective notes for security engagements
81+
- mitmproxy
82+
- Leveraging grep in security audits
7383

7484
## Custom queries for static analysis tools
7585

content/docs/crypto/_index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
weight: 2
3+
bookFlatSection: true
4+
title: "Cryptographic testing"
5+
---
6+
7+
# Cryptographic testing
8+
9+
This section presents testing tools to verify implementations of cryptographic algorithms.
10+
For each tool, we cover topics such as:
11+
12+
- Explain the workings of these tools
13+
- Installation and basic use
14+
- Provide examples
15+
16+
{{< section >}}

0 commit comments

Comments
 (0)