{"id":24960369,"url":"https://github.com/brian-mcnamara/github-initializer","last_synced_at":"2026-06-22T19:31:07.997Z","repository":{"id":115531208,"uuid":"186956192","full_name":"brian-mcnamara/github-initializer","owner":"brian-mcnamara","description":"GitHub broker adding API endpoint for adding SSH / GPG key to users account","archived":false,"fork":false,"pushed_at":"2019-08-15T03:05:07.000Z","size":116,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-15T09:40:08.758Z","etag":null,"topics":["github","github-api","gpg","onboarding","service","ssh"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brian-mcnamara.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-16T05:17:45.000Z","updated_at":"2022-02-22T07:12:12.000Z","dependencies_parsed_at":"2023-07-17T07:17:01.719Z","dependency_job_id":null,"html_url":"https://github.com/brian-mcnamara/github-initializer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/brian-mcnamara/github-initializer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brian-mcnamara%2Fgithub-initializer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brian-mcnamara%2Fgithub-initializer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brian-mcnamara%2Fgithub-initializer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brian-mcnamara%2Fgithub-initializer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brian-mcnamara","download_url":"https://codeload.github.com/brian-mcnamara/github-initializer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brian-mcnamara%2Fgithub-initializer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34663522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-22T02:00:06.391Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","github-api","gpg","onboarding","service","ssh"],"created_at":"2025-02-03T08:07:53.610Z","updated_at":"2026-06-22T19:31:07.991Z","avatar_url":"https://github.com/brian-mcnamara.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/brian-mcnamara/github-initializer.svg?branch=master)](https://travis-ci.org/brian-mcnamara/github-initializer)\n[![Coverage Status](https://coveralls.io/repos/github/brian-mcnamara/github-initializer/badge.svg?branch=master)](https://coveralls.io/github/brian-mcnamara/github-initializer?branch=master)\n\n# GitHub Initializer\n\nSimple broker that provides API endpoints to securely upload a users SSH and/or GPG keys in order to\nupload them on behalf of the user after an Oauth dance.\n\nThe client upload their keys to `/upload` with a payload of\n```json\n{\n    \"sshKey\": {\n        \"title\" : \"title\",\n        \"key\": \"ssh-rsa...\"\n    },\n    \"gpgKey\": {\n        \"armored_public_key\": \"-----BEGIN PGP...\"\n    }\n}\n```\nwhich will return a JSON payload containing the id and the redirect URL pointing to the GitHub aouth authentication endpoint.\n\nThe Redirect will perform a Oauth dance eventually redirecting the user back to this service\nwhere a confirmation will require the user to agree to upload on their behalf. Upon confirmation, the service\ngrabs an access token and proceeds to upload the keys.\n\n## Endpoints\n\nThe following are the endpoints used by this service:\n\n* `POST /upload`:  \n    As mentioned above, Clients upload their public keys to this endpoint, initializing the service flow; returns the id and redirect url.\n* `GET /initiate`:  \n    This endpoint is the `Authorization callback URL` used by the GitHub Oauth App. Accepts\n    `code` and `state` params passed back from GH. Returns [verification.html](src/main/resources/templates/verification.html)\n* `POST /perform`:  \n    Performs the authentication and upload of the keys to GitHub. Requires: `code`: the GH access code, \n    `id`: the transaction id, `csrf`: a CSRF token from the `/initiate` endpoint. These parameters are \n    autofilled in the [verification.html](src/main/resources/templates/verification.html). Returns\n    [result.html](src/main/resources/templates/result.html)\n* `GET /status`:  \n    Returns the status of the transaction\n\n## Using client\n\nYou can use the client attached by invoking:\n` ./client.py upload --sshFile /path/to/id_rsa.pub --gpgId [GpGKeyId]`\n\n## Development\n\nAdd a `application-dev.properties` file under src/main/resources that contains\n`client.id` and `client.secret` from the GitHub Oauth app.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrian-mcnamara%2Fgithub-initializer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrian-mcnamara%2Fgithub-initializer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrian-mcnamara%2Fgithub-initializer/lists"}