Version 13.1 by mmorgan on 2020/07/16 03:29
Hide last authors
messines 1.2 1 == Abstract ==
2
mmorgan 13.1 3 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.
messines 1.2 4
mmorgan 13.1 5 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.
messines 1.2 6
mmorgan 13.1 7 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/*]]
messines 1.2 8
messines 9.1 9 [[image:Screenshot 2020-07-15 at 17.47.12.png||height="517" width="758"]]
messines 1.2 10
messines 2.2 11
mmorgan 13.1 12 The whole authentication flow presented here is based on the official OAuth2 RFC described in the section 4.1.
messines 2.2 13
14 [[https:~~/~~/tools.ietf.org/html/rfc6749#section-4.1>>https://tools.ietf.org/html/rfc6749#section-4.1]]
15
messines 8.1 16 [[image:Screenshot 2020-07-15 at 18.32.14.png||height="410" width="474"]]
17
messines 2.2 18 == Authentication flow ==
19
mmorgan 13.1 20 === Authorization Code Request ===
messines 2.2 21
mmorgan 13.1 22 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.
messines 11.1 23
messines 2.2 24 ==== Request ====
25
mmorgan 13.1 26 The authorization **code **is fetched by an HTTP request:
messines 2.2 27
mmorgan 13.1 28 /GET: [[https:~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth]]
messines 2.2 29
mmorgan 13.1 30 with the following parameters:
31
messines 2.2 32 * response_type=code
33 * login=true
mmorgan 13.1 34 * client_id=**//community-apps-tutorial//**
35 * redirect_uri=**//https:~/~/www.getpostman.com/oauth2/callback//**
36 * scope=openid**//+group+team//**
messines 2.2 37
mmorgan 13.1 38 with the italics indicating the fields you customize for your own app. The URL will look like:
messines 2.2 39
mmorgan 13.1 40 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**//
messines 2.2 41
mmorgan 13.1 42 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.
messines 2.2 43
mmorgan 13.1 44 * **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.
45 * **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.
46 * **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.
messines 2.2 47
mmorgan 13.1 48 {{info}}
49 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.
50 {{/info}}
messines 2.2 51
52 ==== Response ====
53
mmorgan 13.1 54 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:
messines 2.2 55
mmorgan 13.1 56 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**
messines 2.2 57
58 (% class="box infomessage" %)
59 (((
mmorgan 13.1 60 The authorization **code** is the part in bold in the response above.
messines 2.2 61 )))
62
messines 3.2 63 === Access Token Request ===
64
mmorgan 13.1 65 (% class="wikigeneratedid" id="HRequest-1" %)
66 Now that your app has the **authorization** **code** for a user, it can fetch the user access token
67
68 (% class="wikigeneratedid" %)
messines 3.2 69 ==== Request ====
70
mmorgan 13.1 71 /POST: [[https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token>>url:https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token]]
messines 3.2 72
mmorgan 13.1 73 with the following parameters:
messines 3.2 74
mmorgan 13.1 75 * grant_type: authorization_code
76 * code: **//f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7//**
77 * redirect_uri: **//[[https:~~/~~/www.getpostman.com/oauth2/callback>>https://www.getpostman.com/oauth2/callback]]//**
78 * client_id: **//community-apps-tutorial//**
79 * client_secret: **//your client secret obtained during client creation//**
messines 3.2 80
mmorgan 13.1 81 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.]
messines 3.2 82
83 [[image:Screenshot 2020-07-15 at 18.20.34.png]]
84
85
86 ==== Response ====
87
88 200 OK
89
90 (% class="box" %)
91 (((
92 {
93 "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAi...pP5vaNwvvsaNGEA",
94 "expires_in": 604773,
95 "refresh_expires_in": 604773,
96 "refresh_token": "eyJh...vC5eIR1rNhRJ4d8",
97 "token_type": "bearer",
98 "id_token": "eyJ...YOwdQ",
99 "not-before-policy": 0,
100 "session_state": "76e553bf-ba2e-45b6-8c6c-c867772b40ec",
101 "scope": "openid"
102 }
103 )))
104
mmorgan 13.1 105 Your app gets a response containing the **access token** and other information.
messines 5.1 106
107 == Access user info ==
108
mmorgan 13.1 109 Now that your app has the access token of a user, it can fetch the user's info.
110
messines 10.1 111 ==== Request ====
112
mmorgan 13.1 113 /GET: [[https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo>>url:https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo]]
messines 5.1 114
mmorgan 13.1 115 with the following parameters:
messines 5.1 116
mmorgan 13.1 117 * Authorization: the access token preceded by the string "Bearer "
messines 5.1 118
mmorgan 13.1 119 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.]
120
messines 5.1 121 [[image:Screenshot 2020-07-15 at 18.28.28.png||height="161" width="566"]]
122
messines 10.1 123 ==== Response ====
124
mmorgan 13.1 125 As response your app receives a JSON with all the information on the logged user
messines 5.1 126
127 (% class="box" %)
128 (((
129 {
mmorgan 13.1 130 "sub": "fa2db206-3...0ebaba98e1",
messines 5.1 131 "unit": [
132 "/collab-devs",
133 "/collab-team",
134 "/all/institutions/switzerland/epfl",
135 "/all/projects/hbp/consortium/SGA2/SP05",
136 "/all/projects/hbp/consortium/SGA3/WP6/T6_11"
137 ],
138 "roles": {
139 "jupyterhub": [
140 "feature:authenticate"
141 ],
142 "xwiki": [
143 "feature:authenticate"
144 ],
145 "team": [
mmorgan 13.1 146 "**collab**-collaboratory-community-apps-**editor**"
messines 5.1 147 ],
148 "group": [
mmorgan 13.1 149 "**group**-collaboratory-developers",
150 "**unit**-all-projects-hbp-consortium-sga2-sp05-administrator"
messines 5.1 151 ]
152 },
mmorgan 13.1 153 "mitreid-sub": "30...62"
messines 5.1 154 }
155 )))
mmorgan 13.1 156
157 The group field above lists Collaboratory Groups in the form "group-//groupname//" and Collaboratory Units in the form "unit-//unitname//" with the unitname using dashes instead of the colons you see in the Collaboratory UI.
158
159 The team field above lists Collaboratory Teams in the form "collab-//collabname//-//role//" where //role //is one of admin, editor, or viewer according to the user's role in collab //collabname//.
160
161 jupyterhub and xwiki are OIDC clients.
162
163 The unit field above lists [useless noise?].
164
165