Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Executable Packing #2151

Merged
merged 6 commits into from Feb 13, 2022
Merged

Add Executable Packing #2151

merged 6 commits into from Feb 13, 2022

Conversation

dhondta
Copy link
Contributor

@dhondta dhondta commented Jan 13, 2022

https://github.com/dhondta/awesome-executable-packing

This provides a full bibliography, links to packers, unpackers and other related tools for executable formats (PE, ELF, ...). This aims to complement the Malware Analysis list.

By submitting this pull request I confirm I've read and complied with the below requirements πŸ––

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting β€œlooks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • βœ… Add Swift
    • βœ… Add Software Architecture
    • ❌ Update readme.md
    • ❌ Add Awesome Swift
    • ❌ Add swift
    • ❌ add Swift
    • ❌ Adding Swift
    • ❌ Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • βœ… - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • βœ… - [Framer](…) - Prototyping interactive UI designs.
    • ❌ - [iOS](…) - Resources and tools for iOS development.
    • ❌ - [Framer](…)
    • ❌ - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • βœ… Mobile operating system for Apple phones and tablets.
    • βœ… Prototyping interactive UI designs.
    • ❌ Resources and tools for iOS development.
    • ❌ Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • βœ… awesome-swift
    • βœ… awesome-web-typography
    • ❌ awesome-Swift
    • ❌ AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • βœ… # Awesome Swift
    • βœ… # Awesome Web Typography
    • ❌ # awesome-swift
    • ❌ # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't use hard-wrapping.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

Executable (PE, ELF, ...) packing, complementing *Malware Analysis*.
Added a description with the link.
Completed the link with the #readme anchor.
Made the description comply with the contributing guidelines.
@dhondta
Copy link
Contributor Author

dhondta commented Jan 13, 2022

unicorn

Copy link

@Anib13 Anib13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No lo entiendo ?? Quiere que solo explicalo total y compresivamente

@catdevnull
Copy link
Contributor

The description is meta. See:

  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    - βœ… Mobile operating system for Apple phones and tablets.
    - βœ… Prototyping interactive UI designs.
    - ❌ Resources and tools for iOS development.
    - ❌ Awesome Framer packages and tools.

Also, there's five different commits. You might want to combine them into one.

@catdevnull catdevnull mentioned this pull request Jan 14, 2022
@dhondta
Copy link
Contributor Author

dhondta commented Jan 15, 2022

The description is meta. See:

  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • white_check_mark Mobile operating system for Apple phones and tablets.
    • white_check_mark Prototyping interactive UI designs.
    • x Resources and tools for iOS development.
    • x Awesome Framer packages and tools.

Also, there's five different commits. You might want to combine them into one.

Hi @catdevnull
Thank you for your review. What do you mean by "the description is meta" ? Is there anything to improve ?
For the five commits, they will be merged as a single one through the PR. This is not an issue.

@catdevnull
Copy link
Contributor

Thank you for your review. What do you mean by "the description is meta" ? Is there anything to improve ?

What I mean is that the guidelines suggest talking about the subject of the list instead of the list itself.

@dhondta
Copy link
Contributor Author

dhondta commented Jan 18, 2022

Thank you for your review. What do you mean by "the description is meta" ? Is there anything to improve ?

What I mean is that the guidelines suggest talking about the subject of the list instead of the list itself.

Hi @catdevnull
You're probably right but I included a description in the same format such as awesome-malware-analysis. I've seen many other awesome lists having such a format so far. I don't think it's that critical. How would you adapt it ?

@catdevnull
Copy link
Contributor

catdevnull commented Jan 20, 2022 via email

Repository owner deleted a comment from Anib13 Jan 23, 2022
@sindresorhus
Copy link
Owner

The list description in the list readme needs to be improved.

@sindresorhus
Copy link
Owner

Many entries are missing a description.

@sindresorhus
Copy link
Owner

Descriptions should not be title-case.

@dhondta
Copy link
Contributor Author

dhondta commented Jan 25, 2022

@sindresorhus Thank you for your remarks.

The list description in the list readme needs to be improved.

Sorry, but I don't see how to improve it. What do you think is unclear in what is currently described ?

Edit: I improved it. @sindresorhus : Does it fit in the current state ?

Many entries are missing a description.

This is still work in progress ; I generate the README from a Zotero knowledge base and I'm progressively filling in entries.

Edit: All descriptions are filled in.

Descriptions should not be title-case.

Which descriptions are you talking about ? If you mean the Bibliography section, it's normal as these are titles of the papers, books and other resources, which always have cased titles.

Edit: Fixed.

@dhondta
Copy link
Contributor Author

dhondta commented Feb 6, 2022

I agree, I don't think it's that critical. I just thought it wasn't quite aligned with what the guidelines said. I can't really define executable packing in one sentence; maybe something along the lines of:
…
Executable packing is the art(?) of the different methods of compressing, obfuscating and packing files into an executable file.

@catdevnull : FYI ; I added a definition of packing. Thank you for the suggestion.

@dhondta
Copy link
Contributor Author

dhondta commented Feb 13, 2022

@sindresorhus
I fixed all issues you mentioned. Can you recheck, please ?

@sindresorhus sindresorhus merged commit fcc1311 into sindresorhus:main Feb 13, 2022
@sindresorhus
Copy link
Owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants