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

Describe dependency confusion mitigations in "Secure installs" docs #11722

Open
1 task done
di opened this issue Jan 11, 2023 · 9 comments · May be fixed by #11810
Open
1 task done

Describe dependency confusion mitigations in "Secure installs" docs #11722

di opened this issue Jan 11, 2023 · 9 comments · May be fixed by #11810
Labels
good first issue A good item for first time contributors to work on type: docs Documentation related

Comments

@di
Copy link
Member

di commented Jan 11, 2023

What's the problem this feature will solve?

The docs at https://pip.pypa.io/en/stable/topics/secure-installs/ do not describe how to avoid dependency confusion attacks that can arise when using --extra-index-url (as described in #8606).

Describe the solution you'd like

The docs at https://pip.pypa.io/en/stable/topics/secure-installs/ should describe how to avoid dependency confusion attacks (e.g., don't use --extra-index-url, use --index-url instead, or --find-links combined with --no-index)

Alternative Solutions

One alternative is to resolve #8606 or deprecate/remove --extra-index-url instead. Without stating an opinion on whether either of those should happen, I think we should document this in the short term regardless.

Additional context

#11694 is related, but is about adding this to the --extra-index-url docs instead. IMO, we should do both (likely link to one from the other).

Happy to work on this if it's agreed this is worthwhile!

Code of Conduct

@di di added type: feature request Request for a new feature S: needs triage Issues/PRs that need to be triaged labels Jan 11, 2023
@uranusjr uranusjr added type: docs Documentation related good first issue A good item for first time contributors to work on and removed type: feature request Request for a new feature S: needs triage Issues/PRs that need to be triaged labels Jan 12, 2023
@fabiobarkoski
Copy link

Can I try to work on this issue?

@pradyunsg
Copy link
Member

Sure, please feel welcome to!

@fabiobarkoski
Copy link

Thanks! Maybe I will need some help :)

@pradyunsg
Copy link
Member

Please feel free to ask questions here!

@fabiobarkoski
Copy link

Do I need to create a news entry after made the pull request?

@pradyunsg
Copy link
Member

pradyunsg commented Feb 18, 2023

No, you can create it manually prior to filing a PR.

@fabiobarkoski
Copy link

Ok, and the PR will go after the news or with the news?

@pradyunsg
Copy link
Member

With the news

fabiobarkoski added a commit to fabiobarkoski/pip that referenced this issue Feb 20, 2023
added to secure-installs topic how to avoid dependency confusion,
where is better use --index-url or --find-links with --no-index
instead --extra-index-url.

resolve: pypa#11722
@fabiobarkoski
Copy link

alright, thanks for the help :)

fabiobarkoski added a commit to fabiobarkoski/pip that referenced this issue Oct 6, 2023
added to secure-installs topic how to avoid dependency confusion,
where is better use --index-url or --find-links with --no-index
instead --extra-index-url.

resolve: pypa#11722
fabiobarkoski added a commit to fabiobarkoski/pip that referenced this issue Oct 11, 2023
added to secure-installs topic how to avoid dependency confusion,
where is better use --index-url or --find-links with --no-index
instead --extra-index-url.

resolve: pypa#11722

Co-authored-by: chrysle <fritzihab@posteo.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good item for first time contributors to work on type: docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants