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 a metadata resource for instances #49

Merged
merged 12 commits into from
Dec 29, 2022

Conversation

gabriel-samfira
Copy link
Member

Currently, garm leverages the user data feature of providers to create runners and set them up. Storing the runner registration token may be a security vulnerability in some situations (see #48). This PR adds a new API endpoint that can be used by instances to retrieve a github runner registration token.

This new endpoint uses the same authentication middleware as the status update endpoint used by the instances to call home and report their state. The authentication middleware has also been changed to only allow access to instances that are in the pending or installing state. once the instance transitions to any other state (installed, failed, etc), the instance can no longer access the two resources.

This change adds a github registration endpoint that instances can use
to fetch a github registration token.

This change also invalidates disables access to an instance to the token
and status updates endpoints once the instance transitions from
"pending" or "installing" to any other state.
Define a metadata subrouter and move the token endpoint there. We may
end up needing multiple endpoints for various purposes in the future.

Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
@gabriel-samfira gabriel-samfira changed the title Add a metadata resource for instances [WiP] Add a metadata resource for instances Dec 5, 2022
Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
@gabriel-samfira gabriel-samfira changed the title [WiP] Add a metadata resource for instances Add a metadata resource for instances Dec 7, 2022
Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
  * Add logging middleware
  * Remove some noise from logs
  * Add some safety checks when managing runners
@gabriel-samfira
Copy link
Member Author

An additional safeguard was added to limit the number of tokens that can be requested by a bearer token belonging to a particular instance. If an instance token has fetched a github runner registration token, any subsequent attempt to fetch another runner token will fail.

@gabriel-samfira gabriel-samfira merged commit 59ddb41 into cloudbase:main Dec 29, 2022
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.

1 participant