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

Support more generic deployment key mappings #128

Open
mpdude opened this issue Sep 1, 2022 · 1 comment
Open

Support more generic deployment key mappings #128

mpdude opened this issue Sep 1, 2022 · 1 comment

Comments

@mpdude
Copy link
Member

mpdude commented Sep 1, 2022

As described in https://github.com/webfactory/ssh-agent#support-for-github-deploy-keys, this action supports giving GitHub repository URLs in SSH key comments.

It will then configure git to replace different variants of how the repo can be specified with an URL pointing to a made-up hostname.

This hostname will cause dedicated SSH config to be selected, which maps back to the right github.com hostname while selecting a particular SSH key to use.

All this was written with only github.com URLs in mind, since we have a fairly good understanding of how these URLs are made up, and we know about the different variants (including the https:// scheme) that we can safely rewrite.

Now, different requests have been made to support either repo URLs outside of github.com (possibly self-hosted GitHub Enterprise), or being able to use key comments to map keys not to repositories, but whole GitHub organisations.

In general, I'd be open to support this, but we would need to find patterns that cover a sufficiently broad range of repo URLs, figure out how flexible/generic the Git .insteadof configuration can/needs to be and how to avoid this becoming a maintenance burden.

@jommeke22f
Copy link

Zoals beschreven in https://github.com/webfactory/ssh-agent#support-for-github-deploy-keys ondersteunt deze actie het opgeven van GitHub-repository-URL's in SSH-sleutelopmerkingen.

Vervolgens wordt het zo geconfigureerd gitdat verschillende varianten van de manier waarop de repository kan worden gespecificeerd, worden vervangen door een URL die verwijst naar een verzonnen hostnaam.

Deze hostnaam zorgt ervoor dat er een speciale SSH-configuratie wordt geselecteerd, die wordt gekoppeld aan de juiste github.comhostnaam bij het selecteren van een specifieke SSH-sleutel die moet worden gebruikt.

Dit alles is geschreven met alleen github.comURL's in gedachten, omdat we redelijk goed begrijpen hoe deze URL's zijn opgebouwd en we op de hoogte zijn van de verschillende varianten (inclusief het https://schema) die we veilig kunnen herschrijven.

Er zijn nu verschillende verzoeken gedaan om repo-URL's buiten github.com(mogelijk het zelf gehoste GitHub Enterprise) te ondersteunen of om sleutelopmerkingen te kunnen gebruiken om sleutels niet aan repositories toe te wijzen, maar aan hele GitHub-organisaties.

Over het algemeen zou ik dit willen ondersteunen, maar dan moeten we wel patronen vinden die een voldoende breed scala aan repo-URL's bestrijken. Ook moeten we uitzoeken hoe flexibel/generiek de Git- .insteadofconfiguratie kan/moet zijn en hoe we kunnen voorkomen dat dit een onderhoudslast wordt.

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

No branches or pull requests

2 participants