docs(args): clarify reserved args (DEBUG/NOASLR) map to context, not args#2753
Open
citizen204 wants to merge 1 commit into
Open
docs(args): clarify reserved args (DEBUG/NOASLR) map to context, not args#2753citizen204 wants to merge 1 commit into
citizen204 wants to merge 1 commit into
Conversation
Reserved magic arguments such as DEBUG and NOASLR are consumed as hooks that adjust context (context.log_level, context.aslr) and are never stored in the args dict, so args.NOASLR is always the empty string. The pwnup template comment previously claimed these settings 'show up in args', which reinforced the wrong mental model and led users to check args.NOASLR instead of context.aslr. Clarify both the template comment and the pwnlib.args module docstring. Fixes Gallopsled#2564
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
As reported in #2564, users try to check
args.NOASLRand find it is always empty. The root cause is a documentation gap: reserved "magic arguments" likeDEBUGandNOASLRare consumed as hooks inpwnlib/args.pythat adjustcontext(context.log_level,context.aslr). They are never stored in theargsdict, soargs.NOASLRalways evaluates to the empty string.The generated
pwnupexploit template — the first thing most users see — reinforced the wrong mental model by commenting that these settings "show up in args". This PR corrects that comment and adds a matching clarification to thepwnlib.argsmodule docstring.Fixes #2564
Changes
pwnlib/data/templates/pwnup.mako: reword the command-line-arguments comment so it distinguishes reserved arguments (DEBUG/NOASLR →context) from arguments that actually appear inargs(HOST, PORT, EXE, ...).pwnlib/args.py: extend the module docstring to state that reserved arguments adjustcontextand that their effect is read fromcontext(e.g.context.aslr), notargs.