Changes for page 2. Authenticating with your OIDC client and fetch collab user info

Last modified by messines on 2021/06/08 17:32

From 8.1 to 9.1 From 17.3 to 17.4

From version 9.1

edited by messines
on 2020/07/15 18:34

Change comment: There is no comment for this version

To version 17.3

edited by messines
on 2020/09/15 11:23

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,15 +1,15 @@
  == Abstract ==
--You had been creating an OIDC client following our guide [[https:~~/~~/wiki.ebrains.eu/bin/view/Collabs/collaboratory-community-apps/Community%20App%20Developer%20Guide/Registering%20an%20OIDC%20client/>>https://wiki.ebrains.eu/bin/view/Collabs/collaboratory-community-apps/Community%20App%20Developer%20Guide/Registering%20an%20OIDC%20client/]]
++In order to create an OIDC client, see [[1. Registering an OIDC client>>https://wiki.ebrains.eu/bin/view/Collabs/collaboratory-community-apps/Community%20App%20Developer%20Guide/1.%20Registering%20an%20OIDC%20client/]]. After creating the OIDC client, you have a corresponding access token and secret.
--The redirect_uri is set with the url of your application, in this exemple we will use postman, a platform for api developement, use your own application, for exemple when you loggin to this wiki, the redirect uri is [[https:~~/~~/wiki.ebrains.eu/*>>https://wiki.ebrains.eu/*]]
++For the example below, we consider the case of someone wanting to provide access to https:~/~/www.getpostman.com as an app for Collaboratory users to access from their collabs. You should replace that URL by the one of your own app.
--The client is confidential with a secret, you obtain it throught the registering oidc client tutorial above.
++The redirect_uri is set with the URL of your application to which your users will be redirected after having been authenticated by their EBRAINS account. For example when you login to this wiki, the redirect URI is [[https:~~/~~/wiki.ebrains.eu/*>>https://wiki.ebrains.eu/*]]
  [[image:Screenshot 2020-07-15 at 17.47.12.png||height="517" width="758"]]
--The whole authentication flow presented here is based on the official OAuth2 rfc describe in the section 4.1
++The whole authentication flow presented here is based on the official OAuth2 RFC described in the section 4.1.
  [[https:~~/~~/tools.ietf.org/html/rfc6749#section-4.1>>https://tools.ietf.org/html/rfc6749#section-4.1]]
@@ -17,63 +17,71 @@
  == Authentication flow ==
--=== Authorization Code Grant ===
++=== Authorization Code Request ===
++The first step of the authentication protocol is to fetch an **authorization code **for your client and your user. This is done by directing your users to the URL of the EBRAINS login page (**IAM**) where they can enter their username and password.
++
  ==== Request ====
--/GET on [[https:~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth >>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth]]
++The authorization **code **is fetched by an HTTP request:
--with query parameters
++/GET: [[https:~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth]]
++with the following parameters:
++
  * response_type=code
--* client_id=community-apps-tutorial
--* redirect_uri=[[https:~~/~~/www.getpostman.com/oauth2/callback>>https://www.getpostman.com/oauth2/callback]]
  * login=true
--* scope=openid+group+team
++* client_id=**//community-apps-tutorial//**
++* redirect_uri=**//https:~/~/www.getpostman.com/oauth2/callback//**
++* scope=openid**//+group+team//**
--so
++with the italics indicating the fields you customize for your own app. The URL will look like:
--[[https:~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth?response_type=code&client_id=community-apps-tutorial&redirect_uri=https:~~/~~/www.getpostman.com/oauth2/callback&login=true&scope=openid+group+team>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth?response_type=code&client_id=community-apps-tutorial&redirect_uri=https://www.getpostman.com/oauth2/callback&login=true&scope=openid+group+team]]
++https:~/~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth?response_type=code&login=true&client_id=//**community-apps-tutorial**//&redirect_uri=//**https:~/~/www.getpostman.com/oauth2/callback**//&scope=openid//**+group+team**//
--Of course replace **client_id** and **redirect_uri** with your own configuration
++The **scope** parameter can include a combination of several values. Each user will be asked to consent to sharing that scope with your app upon first access.
--This will redirect you to the login page of **iam **where your user must enter they username/password
++* **openid: **This scope is required because we use the OIDC protocol. It will give your app access to the user's basic information such as username, email and full name.
++* **group **(optional)**: **If you request this scope, the future access token generated will authorize your app to identify which units and groups the user belongs to.
++* **team **(optional)**: **This scope is like the group scope lets your app identify the permissions of the user, but by identifying what collabs the user has access to and with what roles.
++* **clb.wiki.read **(optional): access to GET Collab API
++* **clb.wiki.write** (optional): access to DELETE/PUT/POST Collab API
++* **clb.drive:read **(optional): access to GET Drive API
++* **clb.drive:write** (optional): access to DELETE/PUT/POST Drive API
--==== Scope ====
++{{info}}
++The group and team scopes are a simple way for your app to grant permissions to its services and resources when you want to grant access to a very few units, groups, or collab teams. For more complex permission management, contact support.
++{{/info}}
--In the request you can see a scope **parameter**
--
--* **openid : **This scope is required in oidc, it contains basic information of the user such as it username, email and full name.
--* **group **( optional ) **: **This scope is provided by our service, if you add it to your authorization code grant request, the futur access token generated will be able to read which units and groups the logged user belongs, it can be very important for your application. You can notice on the screenshot in the abstract section that **Consent required **is **on, **it means that at loggin time, the user will be asked if he allow your application to access there unit and group membership
--* **team **( optional ) **: **Very same than group, but for collab, with this scope your application will know in which collab the authenticated user belong
--
  ==== Response ====
--After the loggin, you got a 301 redirection and 200 success http response with a **code** inside
++Once the user has logged in, your app gets an HTTP 301 redirection followed by an HTTP 200 success response with an authorization **code** inside. A typical response might look like:
--[[https:~~/~~/www.getpostman.com/oauth2/callback?session_state=a0ff8a68-2654-43ef-977a-6c15ce343546&code=f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7>>https://www.getpostman.com/oauth2/callback?session_state=a0ff8a68-2654-43ef-977a-6c15ce598886&code=f3f04f93-b98d-482d-ac3d-414cead54de0.a0ff8a68-2654-43ef-977a-6c15ce598886.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7]]
++https:~/~/www.getpostman.com/oauth2/callback?session_state=a0ff8a68-2654-43ef-977a-6c15ce343546&code=**f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7**
  (% class="box infomessage" %)
  (((
--the code is very important for the next step here the code is //f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7//
++The authorization **code** is the part in bold in the response above.
  )))
--
  === Access Token Request ===
++(% class="wikigeneratedid" id="HRequest-1" %)
++Now that your app has the **authorization** **code** for a user, it can fetch the user access token
++
  ==== Request ====
--Now that you have the **authorization** **code, **you can reach the **/token **endpoint and fetch the user access token
++/POST: [[https:~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token]]
--/POST : https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token
++with the following parameters:
--with params
++* grant_type: authorization_code
++* code: **//f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7//**
++* redirect_uri: **//[[https:~~/~~/www.getpostman.com/oauth2/callback>>https://www.getpostman.com/oauth2/callback]]//**
++* client_id: **//community-apps-tutorial//**
++* client_secret: **//your client secret obtained during client creation//**
--* grant_type : authorization_code
--* code : //f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7//
--* redirect_uri : [[https:~~/~~/www.getpostman.com/oauth2/callback>>https://www.getpostman.com/oauth2/callback]]
--* client_id : community-apps-tutorial
--* client_secret : your client secret obtained during client creation
++The image below shows a sample POST request generated from the Postman tool. [The fact that this page is based on getpostman.com as an example is pure coincidence.]
  [[image:Screenshot 2020-07-15 at 18.20.34.png]]
@@ -97,31 +97,33 @@
  }
  )))
--You get a response containing the access token and others
++Your app gets a response containing the **access token** and other information.
  == Access user info ==
--Now that your application got the access token of your user, it's really easy to fetch user info
++Now that your app has the access token of a user, it can fetch the user's info.
--(% class="box infomessage" %)
--(((
--/GET https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo
--)))
++==== Request ====
--and just provide the access token as **Authentication** header
++/GET: [[https:~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo]]
++with the following parameters:
++
++* Authorization: the access token preceded by the string "Bearer "
++
++The image below shows a sample GET request generated from the Postman tool. [The fact that this page is based on getpostman.com as an example is pure coincidence.]
++
  [[image:Screenshot 2020-07-15 at 18.28.28.png||height="161" width="566"]]
++==== Response ====
--As response you will have a json with all the information on the logged user, for my user
++As response your app receives a JSON with all the information about the logged user
  (% class="box" %)
  (((
  {
--    "sub": "fa2db206-3eb4-403c-894a-810ebaba98e1",
++    "sub": "fa2db206-3...0ebaba98e1",
      "unit": [
--        "/collab-devs",
--        "/collab-team",
          "/all/institutions/switzerland/epfl",
          "/all/projects/hbp/consortium/SGA2/SP05",
          "/all/projects/hbp/consortium/SGA3/WP6/T6_11"
@@ -134,13 +134,21 @@
              "feature:authenticate"
          ],
          "team": [
--            "collab-collaboratory-community-apps-editor"
++            "**collab**-collaboratory-community-apps-**editor**"
          ],
          "group": [
--            "group-collaboratory-developers",
--            "unit-all-projects-hbp-consortium-sga2-sp05-administrator"
++            "**group**-collaboratory-developers",
++            "**unit**-all-projects-hbp-consortium-sga2-sp05-**administrator**"
          ]
      },
--    "mitreid-sub": "305862"
++    "mitreid-sub": "30...62"
  }
  )))
++
++The unit field above lists Collaboratory Units which the user is a member of, with the unit name using slashes instead of the colons you see in the Collaboratory UI.
++
++jupyterhub and xwiki are OIDC clients with more advanced permission management.
++
++The team field above lists Collaboratory Teams which the user is a member of, in the form "collab-//collabname//-//role//" where //role //is one of admin, editor, or viewer according to the user's role in collab //collabname//.
++
++The group field above lists Collaboratory Groups which the user is a member of, in the form "group-//groupname//". It also lists Collaboratory Units which the user is an admin of, in the form "unit-//unitname//-administrator" with //unitname //using dashes instead of the colons you see in the Collaboratory UI.

Changes for page 2. Authenticating with your OIDC client and fetch collab user info

Summary

Details

Collaboratory Community Apps