feat: allow koa context argument in idFactory and secretFactory

resolves #455
panva · Jan 26, 2020 · 76aa942 · 76aa942
1 parent df12141
commit 76aa942
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1292,7 +1292,7 @@ Function used to generate random client identifiers during dynamic client regist
 
 _**default value**_:
 ```js
-function idFactory() {
+function idFactory(ctx) {
   return nanoid();
 }
 ```
@@ -1432,7 +1432,7 @@ Function used to generate random client secrets during dynamic client registrati
 
 _**default value**_:
 ```js
-function secretFactory() {
+function secretFactory(ctx) {
   return base64url.encodeBuffer(crypto.randomBytes(64)); // 512 base64url random bits
 }
 ```

diff --git a/lib/actions/registration.js b/lib/actions/registration.js
@@ -93,7 +93,7 @@ module.exports = {
       const { oidc: { provider } } = ctx;
       const { idFactory, secretFactory } = instance(provider).configuration('features.registration');
       const properties = {};
-      const clientId = idFactory();
+      const clientId = idFactory(ctx);
 
       const rat = new provider.RegistrationAccessToken({ clientId });
       ctx.oidc.entity('RegistrationAccessToken', rat);
@@ -108,7 +108,7 @@ module.exports = {
 
       if (secretRequired) {
         Object.assign(properties, {
-          client_secret: secretFactory(),
+          client_secret: secretFactory(ctx),
           client_secret_expires_at: 0,
         });
       } else {
@@ -225,7 +225,7 @@ module.exports = {
 
       if (secretRequired) {
         Object.assign(properties, {
-          client_secret: secretFactory(),
+          client_secret: secretFactory(ctx),
           client_secret_expires_at: 0,
         });
       } else {

diff --git a/lib/helpers/defaults.js b/lib/helpers/defaults.js
@@ -987,7 +987,7 @@ const DEFAULTS = {
        * description: Function used to generate random client identifiers during dynamic
        *   client registration
        */
-      idFactory: function idFactory() {
+      idFactory: function idFactory(ctx) { // eslint-disable-line no-unused-vars
         return nanoid();
       },
 
@@ -997,7 +997,7 @@ const DEFAULTS = {
        * description: Function used to generate random client secrets during dynamic
        *   client registration
        */
-      secretFactory: function secretFactory() {
+      secretFactory: function secretFactory(ctx) { // eslint-disable-line no-unused-vars
         return base64url.encodeBuffer(crypto.randomBytes(64)); // 512 base64url random bits
       },
     },

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -886,8 +886,8 @@ export interface Configuration {
       policies?: {
         [key: string]: (ctx: KoaContextWithOIDC, metadata: ClientMetadata) => CanBePromise<void | undefined>;
       };
-      idFactory?: () => string;
-      secretFactory?: () => string;
+      idFactory?: (ctx: KoaContextWithOIDC) => string;
+      secretFactory?: (ctx: KoaContextWithOIDC) => string;
     };
 
     registrationManagement?: {