Single sign-on met GitHub
Saldo vereist HTTP-tunnels
Op deze pagina 4 secties
Laat bezoekers inloggen met hun GitHub-account voordat ze een HTTP-tunnel kunnen openen. Je registreert een OAuth-app op GitHub, voegt die als provider toe aan Localtonet en zet hem daarna aan voor de tunnel.
Voordat je begint #
- Een HTTP-tunnel en saldo op je account. Zie het overzicht van Single sign-on.
- Een GitHub-account. Om de app voor een organisatie te registreren, heb je toegang tot de instellingen van die organisatie nodig.
Stappen #
-
Een OAuth-app registreren op GitHub #
De eigen handleiding van GitHub is Creating an OAuth app. In het kort:
- Open op GitHub het menu onder je profielfoto en kies Settings, dan Developer settings, dan OAuth apps.
- Kies New OAuth App. Als je nog geen app hebt, staat er op de knop Register a new application.
- Vul het formulier in met de onderstaande waarden en kies Register application.
- Kopieer op de pagina van de nieuwe app de Client ID, kies dan Generate a new client secret en kopieer het geheim meteen.
GitHub-veld Waarde Application name Een naam die je bezoekers herkennen. GitHub toont hem wanneer het hen om autorisatie vraagt. Homepage URL Een webadres dat de app beschrijft, bijvoorbeeld je website. Authorization callback URL http://auth.localtonet.com/auth/callbackEnable Device Flow Laat dit uit. Je kiest op GitHub geen scopes. Het inlogverzoek noemt ze zelf:
read:userenuser:email. GitHub vraagt de bezoeker om ze goed te keuren wanneer die voor het eerst inlogt. -
De provider toevoegen in Localtonet #
Open Mijn tunnels › HTTP en kies bovenaan de pagina SSO. Kies in het dialoogvenster SSO-providers de knop Provider toevoegen.
Veld Waarde Providernaam Een willekeurige naam, bijvoorbeeld GitHub. Je ziet hem in de tunnelinstellingen.Providertype GitHub. Als je het type van een opgeslagen provider wijzigt, wordt Client-ID leeggemaakt, dus voer de client-ID en het clientgeheim opnieuw in. Actief Aan Client-ID De client-ID van GitHub. Clientgeheim Het clientgeheim van GitHub. Na het opslaan wordt het nooit meer getoond. Onder Endpoints & callback worden de standaardadressen van GitHub automatisch ingevuld. Laat ze zoals ze zijn:
Veld Ingevulde waarde Autorisatie-endpoint https://github.com/login/oauth/authorizeToken-endpoint https://github.com/login/oauth/access_tokenGebruikersinfo-endpoint https://api.github.com/userCallbackpad /auth/callback/githubVul eventueel Toegangsregels voor e-mail in en kies dan Provider opslaan.
-
Zet hem aan voor een tunnel #
Kies onder Je tunnels de knop Instellingen bij de tunnel en daarna Beheren naast SSO-providers. Zet in het dialoogvenster Single sign-on Inloggen vereisen en de schakelaar van je GitHub-provider aan. Kies Opslaan.
Iedereen kan een GitHub-account aanmaken. Zonder regel kan elke GitHub-gebruiker die het adres kent de tunnel openen. Vul Wie kan inloggen bij de tunnel in, of Toegestane e-maildomeinen bij de provider. De lijsten worden uitgelegd in het overzicht.
-
Test het #
Open de URL van de tunnel in een privévenster van de browser. Localtonet toont Sign in to continue met een knop voor je provider. GitHub vraagt je de eerste keer de app te autoriseren. Daarna word je teruggestuurd naar de tunnel en laadt je service.
Problemen oplossen #
GitHub meldt een redirect-URI-mismatch
De fout van GitHub is redirect_uri_mismatch: "The redirect_uri MUST match the registered callback URL for this application." Geen enkele callback-URL van de OAuth-app komt overeen met het adres dat is verzonden. Stel op GitHub Authorization callback URL in op precies http://auth.localtonet.com/auth/callback.
Een bezoeker wordt geweigerd terwijl zijn adres in de lijst staat
Het standaard Gebruikersinfo-endpoint, https://api.github.com/user, geeft mogelijk geen e-mailadres terug wanneer de GitHub-gebruiker in zijn profiel geen openbaar e-mailadres heeft ingesteld. Vraag de bezoeker te controleren welk adres in zijn GitHub-profiel als openbaar e-mailadres is ingesteld en vergelijk dat met je lijsten.
"403 - Access Denied" na een geslaagde GitHub-aanmelding
Een Localtonet-regel heeft het account geweigerd. Controleer Toegangsregels voor e-mail bij de provider en Wie kan inloggen bij de tunnel. Wacht na het corrigeren van een regel een minuut en laad opnieuw.
Inloggen mislukt voor of na de autorisatiepagina van GitHub
Vergelijk de Client-ID en het Clientgeheim die in Localtonet zijn opgeslagen met de OAuth-app. Plak de client-ID opnieuw, genereer op GitHub een nieuw clientgeheim, plak het in de provider en kies Provider opslaan.
Er staat geen GitHub-knop op de inlogpagina
De provider is voor deze tunnel niet aangezet, of staat op inactief. Controleer beide.