Merge pull request #134 from christophehenry/133

Solves #133: add client_name, logo_uri and contacts fields to client …

README.md

@@ -155,6 +155,31 @@ and emits the following events:
 - `logout ()` when a user logs out
 - `session (session: Session | null)` when a user logs in or out
 
+### Client registration
+
+`SolidAuthClient` automatically registers your OIDC client application if it is
+unknown to the authorization server, following
+[the registration request spec](https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationRequest).
+
+You can specify some fields of this registration request by passing them to the
+`loginSession` parameter of `solid.auth.login`.
+
+Supported fields are:
+
+*  `client_name` and internationalized variants (`clientName` property)
+* `contacts` (`contacts` property)
+* `logo_uri` (`contacts` property)
+
+**Example**:
+
+```js
+solid.auth.login(idp, {
+    clientName: 'My Example',
+    'clientName#ja-Jpan-JP': 'クライアント名',
+    logoUri: 'https://client.example.org/logo.png',
+    contacts: ['ve7jtb@example.org', 'mary@example.org']
+})
+````
 
 ## Advanced usage
 

src/__test__/solid-auth-client.spec.js

@@ -195,6 +195,36 @@ describe('login', () => {
       expect(location.searchParams.get('scope')).toEqual('openid')
       expect(location.searchParams.get('client_id')).toEqual('the-client-id')
     })
+
+    it('performs the client registration the the correct provided registration parameters', async () => {
+      let requestBody = {}
+      nock('https://localhost/')
+        .get('/.well-known/openid-configuration')
+        .reply(200, oidcConfiguration)
+        .get('/jwks')
+        .reply(200, jwks)
+        .post('/register', body => {
+          requestBody = body
+          return true
+        })
+        .reply(200, oidcRegistration)
+
+      await instance.login('https://localhost', {
+        clientName: 'My Example',
+        'clientName#ja-Jpan-JP': 'クライアント名',
+        logoUri: 'https://client.example.org/logo.png',
+        contacts: ['ve7jtb@example.org', 'mary@example.org']
+      })
+
+      expect(requestBody).toMatchObject({
+        client_name: 'My Example',
+        'client_name#ja-Jpan-JP': 'クライアント名',
+        contacts: ['ve7jtb@example.org', 'mary@example.org'],
+        logo_uri: 'https://client.example.org/logo.png'
+      })
+
+      expect.assertions(1)
+    })
   })
 })
 

src/solid-auth-client.js

@@ -15,6 +15,9 @@ const globalFetch = fetch
 
 export type loginOptions = {
   callbackUri: string,
+  clientName?: string,
+  contacts?: Array<string>,
+  logoUri?: string,
   popupUri: string,
   storage: AsyncStorage
 }

src/webid-oidc.js

@@ -125,18 +125,34 @@ async function storeRp(
   return rp
 }
 
-function registerRp(
-  idp: string,
-  { storage, callbackUri }: loginOptions
-): Promise<RelyingParty> {
+function registerRp(idp: string, opts: loginOptions): Promise<RelyingParty> {
+  const { storage, callbackUri } = opts
   const responseType = 'id_token token'
+
+  const clientNameI18n = {}
+  Object.entries(opts)
+    .filter(([key, _]) => key.startsWith('clientName#'))
+    .forEach(
+      ([key, value]) =>
+        (clientNameI18n[key.replace('clientName#', 'client_name#')] = value)
+    )
+
+  const supplementaryOptions = {
+    logo_uri: opts.logoUri,
+    contacts: opts.contacts,
+    client_name: opts.clientName
+  }
+
   const registration = {
     issuer: idp,
     grant_types: ['implicit'],
     redirect_uris: [callbackUri],
     response_types: [responseType],
-    scope: 'openid profile'
+    scope: 'openid profile',
+    ...clientNameI18n,
+    ...supplementaryOptions
   }
+
   const options = {
     defaults: {
       authenticate: {
@@ -146,6 +162,7 @@ function registerRp(
     },
     store: storage
   }
+
   return RelyingParty.register(idp, registration, options)
 }