Restore main as the default branch

.editorconfig

@@ -19,3 +19,6 @@ indent_style = tab
 [*.yml]
 indent_style = space
 indent_size = 2
+
+[*.md]
+max_line_length = 100

.github/workflows/coverage.yml

@@ -1,6 +1,8 @@
-name: CI Coverage
+name: CI Coverage for PR
 
-on: [pull_request]
+on:
+ pull_request:
+ types: [opened, edited]
 
 jobs:
  coverage:
@@ -44,7 +46,7 @@ jobs:
  * Commit: ${process.env.COMMIT}
  * Current Coverage: ${process.env.SCORE_OLD}%
  * New Coverage: ${process.env.SCORE_NEW}%
- * Diff: ${process.env.SCORE_DIFF} 
+ * Diff: ${process.env.SCORE_DIFF}
  `;
  const { owner, repo, number } = context.issue;
  await github.rest.issues.createComment({ owner, repo, issue_number: number, body: comment });

.github/workflows/discord-notify.yml → .github/workflows/notify.yml

@@ -1,13 +1,19 @@
-name: "Discord Notification"
-
+name: "Notifications"
 
 on:
+ issues:
+ types:
+ - opened
+ - reopened
  push:
  branches:
  - main
  - dev
 
  pull_request:
+ types:
+ - opened
+ - closed
  branches:
  - main
  - dev
@@ -16,56 +22,53 @@ env:
  DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
 
 jobs:
- notify:
+ discord:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
  with:
  fetch-depth: 0
 
- - name: GEF Push Notification
+ - name: Notify/Push
  if: github.event_name == 'push' && github.repository_owner == 'hugsy'
- uses: sarisia/actions-status-discord@v1
+ uses: sarisia/actions-status-discord@v1.12
  with:
  nodetail: true
- title: "[${{ github.repository }}] ${{ github.actor }} pushed to `${{ github.ref }}`"
+ title: "[${{ github.repository }}] ${{ github.actor }} pushed to `${{ github.ref_name }}`"
  description: |
  **Commits**:
  ● ${{ join(github.event.commits.*.message, '
  ● ') }}
  ---
- **Link**: ${{ github.event.compare }}
-
- color: 0x0000ff
+ [Open Diff View](${{ github.event.compare }})
+ color: 0x00ff00
  username: ${{ github.actor }} via GithubBot
  avatar_url: ${{ github.actor.avatar_url }}
 
- - name: GEF Pull Request Notification
- if: github.event_name == 'pull_request' && github.event.action == 'opened'
- uses: sarisia/actions-status-discord@v1
+ - name: Notify/Pull Request
+ if: github.event_name == 'pull_request'
+ uses: sarisia/actions-status-discord@v1.12
  with:
  nodetail: true
- title: "[${{ github.repository }}] ${{ github.actor }} created a new Pull Request (`#${{ github.event.pull_request.number }}`)"
+ title: "[${{ github.repository }}] ${{ github.actor }} ${{ github.event.action }} PR #${{ github.event.pull_request.number }}"
  description: |
- **${{ github.event.pull_request.title }}**
-
+ **Title**: ${{ github.event.pull_request.title }}
  ---
- **Link**: ${{ github.event.pull_request.html_url }}
- color: 0x00ff00
+ [Goto PR](${{ github.event.pull_request.html_url }})
+ color: 0x0000ff
  username: ${{ github.actor }} via GithubBot
  avatar_url: ${{ github.actor.avatar_url }}
 
- - name: GEF Issue Notification
- if: github.event_name == 'issues' && github.event.action == 'opened' && github.repository_owner == 'hugsy'
- uses: sarisia/actions-status-discord@v1
+ - name: Notify/Issue
+ if: github.event_name == 'issues' && github.repository_owner == 'hugsy'
+ uses: sarisia/actions-status-discord@v1.12
  with:
  nodetail: true
- title: "[${{ github.repository }}] ${{ github.actor }} created a new Issue (`#${{ github.event.issue.number }}`)"
+ title: "[${{ github.repository }}] ${{ github.actor }} ${{ github.event.action}} issue #${{ github.event.issue.number }}"
  description: |
- **${{ github.event.issue.title }}**
-
+ **Title**: ${{ github.event.issue.title }}
  ---
- **Link**: ${{ github.event.issue.html_url }}
+ [Goto issue](${{ github.event.issue.html_url }})
  color: 0xff0000
  username: ${{ github.actor }} via GithubBot
  avatar_url: ${{ github.actor.avatar_url }}

.gitignore

@@ -13,3 +13,4 @@ debug.log
 .coverage
 htmlcov
 .benchmarks
+site/

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2022 crazy rabbidz
+Copyright (c) 2013-2023 crazy rabbidz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -3,18 +3,22 @@
 </p>
 
 <p align="center">
- <a href="https://discord.gg/HCS8Hg7"><img alt="Discord" src="https://img.shields.io/badge/Discord-BlahCats-yellow"></a>
+ <a href="https://discord.gg/hSbqxxBgRX"><img alt="Discord" src="https://img.shields.io/badge/Discord-BlahCats-yellow"></a>
  <a href="https://hugsy.github.io/gef"><img alt="Docs" src="https://img.shields.io/badge/Docs-gh--pages-brightgreen"></a>
  <a title="Use the IDs: gef/gef-demo" href="https://demo.gef.blah.cat"><img alt="Try GEF" src="https://img.shields.io/badge/Demo-Try%20GEF%20Live-blue"></a>
 </p>
 
-`GEF` (pronounced ʤɛf - "Jeff") is a set of commands for x86/64, ARM, MIPS, PowerPC and SPARC to assist exploit developers and reverse-engineers when using old school GDB. It provides additional features to GDB using the Python API to assist during the process of dynamic analysis and exploit development. Application developers will also benefit from it, as GEF lifts a great part of regular GDB obscurity, avoiding repeating traditional commands, or bringing out the relevant information from the debugging runtime.
-
-
+`GEF` (pronounced ʤɛf - "Jeff") is a set of commands for x86/64, ARM, MIPS, PowerPC and SPARC to
+assist exploit developers and reverse-engineers when using old school GDB. It provides additional
+features to GDB using the Python API to assist during the process of dynamic analysis and exploit
+development. Application developers will also benefit from it, as GEF lifts a great part of regular
+GDB obscurity, avoiding repeating traditional commands, or bringing out the relevant information
+from the debugging runtime.
 
 ## Instant Setup ##
 
-Simply make sure you have [GDB 8.0 or higher](https://www.gnu.org/s/gdb) compiled with Python3.6+ bindings, then:
+Simply make sure you have [GDB 8.0 or higher](https://www.gnu.org/s/gdb) compiled with Python3.6+
+bindings, then:
 
 
 ```bash
@@ -34,29 +38,43 @@ $ gdb -q
 (gdb) pi import urllib.request as u, tempfile as t; g=t.NamedTemporaryFile(suffix='-gef.py'); open(g.name, 'wb+').write(u.urlopen('https://tinyurl.com/gef-main').read()); gdb.execute('source %s' % g.name)
 ```
 
-_Note_: to fetch the latest of GEF (i.e. from the `dev` branch), simply replace in the URL to https://gef.blah.cat/dev.
+_Note_: to fetch the latest of GEF (i.e. from the `dev` branch), simply replace in the URL to
+https://gef.blah.cat/dev.
 
 You can immediately see that GEF is correctly installed by launching GDB:
 
 ![gef-context](https://i.imgur.com/E3EuQPs.png)
 
 A few of `GEF` features include:
 
- * **One** single GDB script
- * Entirely **architecture agnostic**, **NO** dependencies: `GEF` is battery-included and [is installable instantly](https://hugsy.github.io/gef/#setup)
- * **Fast** limiting the number of dependencies and optimizing code to make the commands as fast as possible
- * Provides a great variety of commands to drastically change your experience in GDB.
- * [**Easily** extensible](https://hugsy.github.io/gef/api/) to create other commands by providing more comprehensible layout to GDB Python API.
- * Full Python3 support ([Python2 support was dropped](https:/hugsy/gef/releases/tag/2020.03) - see [`gef-legacy`](https:/hugsy/gef-legacy)).
- * Built around an architecture abstraction layer, so all commands work in any GDB-supported architecture such as x86-32/64, ARMv5/6/7, AARCH64, SPARC, MIPS, PowerPC, etc.
- * Suited for real-life apps debugging, exploit development, just as much as CTF
-
-Check out the [Screenshot page](docs/screenshots.md) for more or [try it online](https://demo.gef.blah.cat) (user:`gef`/password:`gef-demo`)
+* **One** single GDB script
+* Entirely **architecture agnostic**, **NO** dependencies: `GEF` is battery-included and [is
+ installable instantly](https://hugsy.github.io/gef/#setup)
+* **Fast** limiting the number of dependencies and optimizing code to make the commands as fast as
+ possible
+* Provides a great variety of commands to drastically change your experience in GDB.
+* [**Easily** extensible](https://hugsy.github.io/gef/api/) to create other commands by providing
+d more comprehensible layout to GDB Python API.
+* Full Python3 support ([Python2 support was
+ dropped](https:/hugsy/gef/releases/tag/2020.03) - see
+ [`gef-legacy`](https:/hugsy/gef-legacy)).
+* Built around an architecture abstraction layer, so all commands work in any GDB-supported
+ architecture such as x86-32/64, ARMv5/6/7, AARCH64, SPARC, MIPS, PowerPC, etc.
+* Suited for real-life apps debugging, exploit development, just as much as CTF
+* And a lot more commands contributed by the community available on 
+ [GEF-Extras](https:/hugsy/gef-extras) !!
+
+Check out the [Screenshot page](docs/screenshots.md) for more or [try it
+online](https://demo.gef.blah.cat) (user:`gef`/password:`gef-demo`)
 
 
 ## Documentation ##
 
-Unlike other GDB plugins, GEF has an extensive and up-to-date [documentation](https://hugsy.github.io/gef/). Users are recommended to refer to it as it may help them in their attempts to use GEF. In particular, new users should navigate through it (see the [FAQ](https://hugsy.github.io/gef/faq/) for common installation problems), and the problem persists, try to reach out for help on the Discord channel or submit an issue.
+Unlike other GDB plugins, GEF has an extensive and up-to-date
+[documentation](https://hugsy.github.io/gef/). Users are recommended to refer to it as it may help
+them in their attempts to use GEF. In particular, new users should navigate through it (see the
+[FAQ](https://hugsy.github.io/gef/faq/) for common installation problems), and the problem persists,
+try to reach out for help on the Discord channel or submit an issue.
 
 
 ## Current status ##
@@ -68,11 +86,15 @@ Unlike other GDB plugins, GEF has an extensive and up-to-date [documentation](ht
 
 ## Contribute ##
 
-To get involved, refer to the [Contribution documentation](https://hugsy.github.io/gef/#contribution) and the [guidelines](https:/hugsy/gef/blob/dev/.github/CONTRIBUTING.md) to start.
+To get involved, refer to the [Contribution
+documentation](https://hugsy.github.io/gef/#contribution) and the
+[guidelines](https:/hugsy/gef/blob/dev/.github/CONTRIBUTING.md) to start.
 
 ## Sponsors ##
 
-Another way to contribute to keeping the project alive is by sponsoring it! Check out [the sponsoring documentation](https://hugsy.github.io/gef/#sponsors) for details so you can be part of the list of those [awesome sponsors](https:/sponsors/hugsy).
+Another way to contribute to keeping the project alive is by sponsoring it! Check out [the
+sponsoring documentation](https://hugsy.github.io/gef/#sponsors) for details so you can be part of
+the list of those [awesome sponsors](https:/sponsors/hugsy).
 
 
 ## Happy Hacking 🍻 ##