-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Removed github oauth token in sample file. The token is a personal to… #20887
Removed github oauth token in sample file. The token is a personal to… #20887
Conversation
…ken and should not be used on the application level.
Hi @hostep. Thank you for your contribution
For more details, please, review the Magento Contributor Assistant documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello, @hostep,
thank you for your contribution.
This is a really good point.
The auth.json.sample is rather an example file that should meet the basic needs of a user in the authentication for repo.magento.com in order to install third-party Composer packages.
I guess we should remove the optional section matching the specific developer's needs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.
Hi @dmytro-ch, thank you for the review. |
Hi @hostep, thank you for your contribution! |
…ken and should not be used on the application level.
Description (*)
This is a follow up to Pull Request: #20416
As discussed in #20416 (comment), the github oauth token is a personal token. It should be used on user level in the system and not on application level. The file
auth.json
in the Magento root directory represents the application level.After reading the Magento documentation around this, it looks like it is communicated correctly in there, where it says the
auth.json
file with the github oauth token should be in your user directory, which is correct.So I don't think the documentation needs to be changed.
We could however add a link on the documentation to https://getcomposer.org/doc/articles/troubleshooting.md#api-rate-limit-and-oauth-tokens, to better explain why the github oauth token is needed.
Let me know if you think this needs to happen and I'll try to create a PR to the devdocs repo as well.
The reason why this PR is created, is because Magento users sometimes commit the
auth.json
file to the VCS, and if you add your github oauth token in that file and let your co-workers use the same token because it was added to VCS, then we have some sort of security-related problem where users other then yourself use your personal github oauth token.We shouldn't advise users of Magento to follow this practice.
/cc @brendanfalkowski, @okorshenko
Fixed Issues (if relevant)
Not relevant
Manual testing scenarios (*)
Not relevant
Contribution checklist (*)