5

OAuth klient pre REST API Githubu cez Spring Boot

 1 year ago
source link: https://novotnyr.github.io/scrolls/oauth-spring-github-client/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

OAuth klient pre REST API Githubu cez Spring Boot

OAuth klient pre REST API Githubu cez Spring Boot

2023/04/02

Ako zobraziť svoje vlastné repozitáre na GitHube cez REST API?

Ukážeme si:

  • ako pristúpiť k REST API Githubu

  • ako sa autentifikovať v aplikácii pomocou OAuth 2.0

  • ako vytvoriť na GitHube aplikáciu, ktorá vie získať používateľove údaje v jeho mene a to kontrolovaným spôsobom

  • ako implementovať klienta k REST API Githubu v Sprint Boote

REST API GitHubu

GitHub ponúka bohaté REST API a to vrátane dokumentácie.

To umožňuje budovať aplikácie, ktoré získavajú údaje o dôležitých entitách, napríklad:

  • repozitároch

  • organizáciách

  • tímoch

  • používateľoch

Autentifikácia

Ak chceme vytvoriť aplikáciu, ktorá dokáže získať repozitáre v mene používateľa (On Behalf Of), môžeme použiť OAuth.

GitHub ako platforma dokáže vystupovať:

Naša aplikácia v Spring Boote bude v role klienta OAuth.

Registrácia aplikácie

Klienta zaregistrujme v autorizačnom serveri GitHub.

  1. Navštívme https://github.com/settings/developers

  2. Zvoľme Register a new application.

  3. Vyplňme údaje.

    register oauth app

    1. Application name: názov aplikácie, ktorý sa objaví v UI pre používateľov

    2. Homepage URL: cesta k domovskej stránke. Použijeme port 9999.

    3. Authorization Callback URL: cesta, na ktorú presmeruje autorizačný server používateľov prehliadač po úspešnom prihlásení. Túto URL zabezpečí modul Springu. Rovnako použijeme port 9999.

  4. Na prehľadovom okne získame:

    1. Client ID: identifikátor klienta v OAuth

    2. Client Secret: ten si nechajme jednorazovo vygenerovať.

Máme všetko, čo potrebujeme pre integráciu.

Tvorba aplikácie

Cez Spring Initializr vytvorme aplikáciu reprezentujúcu klienta OAuth 2, ktorá bude v mene prihláseného používateľa získavať informácie z resource servera (GitHub REST API) o repozitároch.

Použime:

  • OAuth 2 Client: spring-boot-starter-oauth2-client

  • Web: spring-boot-starter-web pre naše vlastné REST API

  • WebFlux: spring-webflux v ktorom sa nachádza klientská strana pre prístup k REST API GitHubu.

Konfiguračný súbor application.properties.

application.properties
1 Port, na ktorom pobeží naša aplikácia. Port sa objavil v registrácii aplikácie na GitHube!
2 Identifikátor klienta OAuth.
3 Tajomstvo medzi klientom a autorizačným serverom.
Spring OAuth 2 Client obsahuje automatické nastavenie pre známe autorizačné servery (GitHub, Facebook, Okta, Google).

Volanie REST API GitHubu

Naša aplikácia bude prakticky proxy — zverejní REST API, ktoré zavolá REST API GitHubu.

Spring OAuth Client poskytuje podporu pre triedu WebClient a jej priamu integráciu s OAuth. Takýto WebClient sa postará o správne získanie tokenov, ich aktualizáciu cez obnovovacie tokeny (refresh tokens).

WebClient je neblokujúca alternatíva k triede RestTemplate, ktorá bude v budúcich verziách Springu preferovanou možnosťou pre prístup k REST API.
1 Deklarujeme bean pre klienta. Aby sme ho obmedzili len na volania pre GitHub a neurobili ho globálny, dodáme mu kvalifikátor. Toto nie je povinná časť, ak máme v projekte len jedinú singleton inštanciu.
2 Budeme potrebovať:

  1. ClientRegistrationRepository: repozitár konfiguračných nastavení klientov. U nás máme jediného klienta — pre GitHub — nakonfigurovaného implicitne a zároveň pomocou application.properties.

  2. OAuth2AuthorizedClientRepository, ktorý udržiava autentifikačné údaje počas prihlasovacieho sedenia medzi prehliadačom a touto aplikáciou.
3 Vyrobíme funkciu, ktorá sa postará o technikálie OAuth2: získavanie tokenov, obnovu tokenov a asociovanie správnych hlavičiek.
4 Explicitne povieme, že táto funkcia sa vzťahuje len na klienta pre GitHub.
5 Nakonfigurujeme webklienta tak, aby sa riadil možnosťami OAuth.

Teraz nastavme naše REST API.

Vytvorme klasický kontrolér pre REST API, ktorý bude „proxy“ovať volania na GitHub.

ApiController.java
1 Bežný kontrolér pre REST API.
2 Nechajme si cez autowiring dodať inštanciu webklienta pre GitHub. Nezabudnime na kvalifikátor!
3 Webklient použije HTTP GET a adresu URL pre REST API GitHubu. Táto adresa získa všetky repozitáre prihláseného používateľa.
4 Výsledok príde ako JSON, v podobe zoznamu objektov, ktoré namapujeme na náš vlastný záznam Repository (record)
5 Webklient je neblokujúci a reaktívny, ale my budeme blokovať, aby sme vrátili štandardný zoznam objektov.
Práca s webklientom je mimo záberu tohto článku.

Záznam pre repozitár je jednoduchý — slúži len na to, aby sme odfiltrovali nepotrebné vlastnosti z JSONu.

Repository.java

Otestovanie aplikácie

Navštívme cez prehliadač naše REST API na http://localhost:9999/api/repositories.

Spring Boot zistí, že ako používateľ nie som autentifikovaný, a ako vlastník zdrojov (OAuth Resource Owner) som neudelil súhlas klientskej aplikácii na prístup k údajom.

Presmeruje ma na adresu GitHubu, kde tento súhlas udelím:

github consent

Následne sa vykoná séria presmerovaní podľa grantu Authorization Code až sa prehliadač ocitne na pôvodnej adrese, ktorá zobrazí odfiltrovaný JSON.

Vidíme, ako sa o autorizáciu postaral Spring OAuth Client. V tejto chvíli náš klient pristupuje k údajom prihláseného používateľa v jeho mene.
Ak by sme neboli prihlásení na GitHube, uvidíme ešte prihlasovací formulár GitHubu. Ako používateľ totiž musím byť autentifikovaný oproti autorizačnému serveru.

Zdroje

Zdrojový projekt je na GitHube v repozitári novotnyr/github-oauth-client-spring-boot.

>> Home


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK