Skip to content

Commit a301e7a

Browse files
committed
Merge remote-tracking branch 'origin/main' into libafl-section
2 parents 029a9c5 + 4af612d commit a301e7a

File tree

11 files changed

+41
-21
lines changed

11 files changed

+41
-21
lines changed

.github/workflows/hugo.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ jobs:
3939
- name: Install Dart Sass Embedded
4040
run: sudo snap install dart-sass-embedded
4141
- name: Checkout
42-
uses: actions/checkout@v3
42+
uses: actions/checkout@v4
4343
with:
4444
submodules: recursive
4545
- name: Setup Pages
4646
id: pages
47-
uses: actions/configure-pages@v3
47+
uses: actions/configure-pages@v5
4848
- name: Install Node.js dependencies
4949
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
5050
- name: Build with Hugo
@@ -57,7 +57,7 @@ jobs:
5757
--minify \
5858
--baseURL "${{ steps.pages.outputs.base_url }}/"
5959
- name: Upload artifact
60-
uses: actions/upload-pages-artifact@v1
60+
uses: actions/upload-pages-artifact@v3
6161
with:
6262
path: ./public
6363

@@ -71,4 +71,4 @@ jobs:
7171
steps:
7272
- name: Deploy to GitHub Pages
7373
id: deployment
74-
uses: actions/deploy-pages@v1
74+
uses: actions/deploy-pages@v4

.github/workflows/markdown.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
path: .lycheecache
1919
key: cache-lychee-${{ github.sha }}
2020
restore-keys: cache-lychee-
21-
- uses: lycheeverse/lychee-action@2b973e86fc7b1f6b36a93795fe2c9c6ae1118621 # for v1.10.0
21+
- uses: lycheeverse/lychee-action@f613c4a64e50d792e0b31ec34bbcbba12263c6a6 # for v2.3.0
2222
with:
2323
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'
2424
fail: true
@@ -28,7 +28,7 @@ jobs:
2828
runs-on: ubuntu-latest
2929
steps:
3030
- uses: actions/checkout@v4
31-
- uses: DavidAnson/markdownlint-cli2-action@v15
31+
- uses: DavidAnson/markdownlint-cli2-action@v19
3232
with:
3333
globs: "**/*.md"
3434
# Spellcheck Markdown files using `retext` and `remark`

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ create a new GitHub issue and/or fix it in the new pull request.
8080
git checkout -b name-of-your-new-branch
8181
# or
8282
git checkout name-of-existing-branch
83+
```
8384

8485
4. Run the Hugo server with drafts turned on (`-D`) from the project's root directory.
8586
Your browser will be automatically refreshed with changes whenever you save a file.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: "Zero-knowledge protocols"
3+
weight: 4
4+
summary: "ZKDocs provides comprehensive, detailed, and interactive documentation on zero-knowledge proof systems and related primitives."
5+
bookCollapseSection: true
6+
# math: true
7+
# bookFlatSection: false
8+
# bookToc: true
9+
# bookHidden: false
10+
# bookComments: false
11+
# bookSearchExclude: false
12+
---
13+
# Zero-knowledge protocols
14+
15+
ZKDocs provides comprehensive, detailed, and interactive documentation on zero-knowledge proof systems and related primitives.
16+
17+
At [Trail of Bits](https://www.trailofbits.com/), we audit many implementations of non-standardized cryptographic protocols and often find the same issues. As we discovered more instances of these bugs, we wanted to find a way to prevent them in the future. Unfortunately, for these protocols, the burden is on the developers to figure out all of the low-level implementation details and security pitfalls.
18+
19+
We hope that ZKDocs can fill in this gap and benefit the larger cryptography community.
20+
21+
{{< hint info >}}
22+
**For in-depth resources and interactive guides on zero-knowledge proof systems, visit https://zkdocs.com.**
23+
{{< /hint >}}

content/docs/fuzzing/c-cpp/10-libfuzzer/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Note that libFuzzer has been in [maintenance-only](https://llvm.org/docs/LibFuzz
1414
The more performant AFL++ fuzzer is compatible with fuzzing harnesses written for libFuzzer, which means transitioning from libFuzzer to AFL++ is easy and requires only changing your compiler from `clang++` to `afl-clang-fast++`.
1515

1616
{{< fuzzing/intro-os >}}
17-
If possible, we recommend fuzzing on a local x64_64 VM or renting one on DigitalOcean, AWS, Hetzner, etc.
17+
If possible, we recommend fuzzing on a local x86_64 VM or renting one on DigitalOcean, AWS, Hetzner, etc.
1818

1919

2020
## Installation {#installation}

content/docs/fuzzing/c-cpp/11-aflpp/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -316,10 +316,6 @@ out/default/
316316

317317
{{< hint info >}}
318318
PRO TIP: The filename of a crash gives precise information about where it originated. The name `id:000000,sig:06,src:000002,time:286,execs:13105,op:havoc,rep:4` indicates that the crash with ID 0 caused a signal 6 in the SUT. The crash input originates from the source test case with ID 2. Test case 2 originates from the seed input with the test case ID 0. Additional data indicates, for example, when the crash was discovered or which mutation led to the discovery.
319-
320-
```shell
321-
./afl++ <host/docker> AFL_PIZZA_MODE=1 afl-fuzz -i seeds -o out -- ./fuzz
322-
```
323319
{{< /hint >}}
324320

325321

content/docs/fuzzing/c-cpp/techniques/01-coverage/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ PRO TIP: You should not use the statistics returned by your specific fuzzer to t
3939
The most comparable data is generated by tools specifically made for measuring coverage.
4040
{{< /hint >}}
4141

42-
The following section reviews two methods to generate coverage reports: the an LLVM-based instrumentation and a GCC-based one. LLVM offers a stable and very fast way to generate coverage reports. The LLVM toolkit supports the [SanitizerCoverage](https://clang.llvm.org/docs/SanitizerCoverage.html) instrumentation that is unique to Clang and the GCC-compatible [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) instrumentation. GCC only supports the gcov instrumentation.
42+
The following section reviews two methods to generate coverage reports: an LLVM-based instrumentation and a GCC-based one. LLVM offers a stable and very fast way to generate coverage reports. The LLVM toolkit supports the [SanitizerCoverage](https://clang.llvm.org/docs/SanitizerCoverage.html) instrumentation that is unique to Clang and the GCC-compatible [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) instrumentation. GCC only supports the gcov instrumentation.
4343

4444
Both methods allow the generation of a clear representation of coverage, with the resulting HTML report consisting of multiple pages. However, the report generation with gcov output is more inefficient and requires more time compared to the LLVM one.
4545

@@ -307,7 +307,7 @@ HTML coverage report generated by gcovr
307307
{{< /resourceFigure >}}
308308

309309

310-
**We already mentioned that gcov incrementally updates `.gcda` files over multiple runes of the coverage binaries. To start from scratch, you can manually delete all `.gcda` files after executing gcovr, or add the flag `--delete`.**
310+
**We already mentioned that gcov incrementally updates `.gcda` files over multiple runs of the coverage binaries. To start from scratch, you can manually delete all `.gcda` files after executing gcovr, or add the flag `--delete`.**
311311

312312

313313
## Real-world examples {#real-world-examples}

content/docs/static-analysis/semgrep/00-installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ A new version of Semgrep is available. See https://semgrep.dev/docs/upgrading
5656
```
5757

5858
You can also check for updates manually by visiting the
59-
[Semgrep Releases](https://github.com/returntocorp/semgrep/releases) page.
59+
[Semgrep Releases](https://github.com/semgrep/semgrep/releases) page.
6060

6161
#### Updating Semgrep
6262

@@ -228,7 +228,7 @@ according to your preferences and tooling.
228228
- Use the `--severity [INFO|WARNING|ERROR]` flag to report findings only from rules that match
229229
the specified severity (`INFO`/`WARNING`/`ERROR`).
230230
- There is currently no obvious flag to limit results based on specific rule metadata (e.g., impact).
231-
See the [Feature request: CLI support for filtering by rule metadata](https://github.com/returntocorp/semgrep/issues/6752)
231+
See the [Feature request: CLI support for filtering by rule metadata](https://github.com/semgrep/semgrep/issues/6752)
232232
GitHub issue for a possible workaround.
233233

234234
d. Data flow tracing:

content/docs/static-analysis/semgrep/10-advanced.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ semgrep --config /path/to/your/config --lang python --scan-unknown-extensions /p
2020
In this example, Semgrep will scan the `/path/to/your/file.xyz` file as a Python file,
2121
even though the `.xyz` extension is not a standard Python file extension.
2222

23-
See also the [Allow user to specify file extensions for languages #3090](https://github.com/returntocorp/semgrep/issues/3090)
23+
See also the [Allow user to specify file extensions for languages #3090](https://github.com/semgrep/semgrep/issues/3090)
2424
GitHub issue to work around restrictions if you want to use Semgrep against your specific language, even if the file
2525
extension is not standard.
2626

2727
### Files/directories
2828

2929
- By default, Semgrep follows the default
30-
[.semgrepignore](https://github.com/returntocorp/semgrep/blob/develop/cli/src/semgrep/templates/.semgrepignore) file.
30+
[.semgrepignore](https://github.com/semgrep/semgrep/blob/develop/cli/src/semgrep/templates/.semgrepignore) file.
3131
- If present, Semgrep will look at the repository's `.gitignore` file.
3232
- In case of a conflict between the two files, the `.semgrepignore` file takes precedence. This means that if the
3333
`.gitignore` file includes a file and the `.semgrepignore` file excludes it, Semgrep will not analyze the file.
@@ -109,7 +109,7 @@ for writing and testing rules. However, it is essential to consider the followin
109109
(e.g., `# ruleid: <id>`) into your test code to evaluate your rule's effectiveness while working in the Semgrep
110110
Playground (see [example](https://semgrep.dev/s/ezxE)).
111111
- **Note the limitations with comments**: Be aware that the Semgrep Playground does not retain comments when sharing
112-
a link or "forking" a rule (Ctrl+S). Refer to this [GitHub issue](https://github.com/returntocorp/semgrep/issues/7120)
112+
a link or "forking" a rule (Ctrl+S). Refer to this [GitHub issue](https://github.com/semgrep/semgrep/issues/7120)
113113
for more information.
114114

115115
### Building blocks
@@ -1019,7 +1019,7 @@ development. The channel is staffed by knowledgeable developers familiar with Se
10191019
They are usually quick to respond to questions. They can guide you in structuring your rules and in debugging any issues
10201020
that arise. Additionally, the Slack channel is a great place to connect with other developers working on similar
10211021
projects, allowing you to learn from others' experiences and share your insights.
1022-
- Use [Semgrep GitHub issues](https://github.com/returntocorp/semgrep/issues) to report bugs, suggest new features, and
1022+
- Use [Semgrep GitHub issues](https://github.com/semgrep/semgrep/issues) to report bugs, suggest new features, and
10231023
ask for help with specific issues.
10241024

10251025
## Thoroughly testing Semgrep rules for optimal performance

content/docs/static-analysis/semgrep/30-org.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ to reduce false positives/negatives.
9898
- Pay attention to the Semgrep Community Slack, where the Semgrep community helps with problems or writing custom
9999
rules.
100100
- Encourage the team to report existing limitations/bugs while using Semgrep to the Semgrep team by filling out
101-
GitHub issues (see this [example issue](https://github.com/returntocorp/semgrep/issues/4587) submitted by
101+
GitHub issues (see this [example issue](https://github.com/semgrep/semgrep/issues/4587) submitted by
102102
Trail of Bits).
103103

104104
7. Implement Semgrep in the CI/CD pipeline by getting acquainted with the Semgrep documentation related to your CI

0 commit comments

Comments
 (0)