feat: optionally enable OIDC modules (#1516)

* feat: add optionally enable disable oidc module

Signed-off-by: Krishna Waske <[email protected]>

* chore: add some descriptive logs

Signed-off-by: Krishna Waske <[email protected]>

* fix: update the registration of experimental modules

Signed-off-by: Krishna Waske <[email protected]>

* fix: common function from utils

Signed-off-by: Krishna Waske <[email protected]>

---------

Signed-off-by: Krishna Waske <[email protected]>

Author: GHkrishna

.env.demo

@@ -144,6 +144,8 @@ ELK_PASSWORD=xxxxxx # ELK user password
 ORGANIZATION=credebl
 CONTEXT=platform
 APP=api
+# Default is true too, if nothing is passed
+HIDE_EXPERIMENTAL_OIDC_CONTROLLERS=true
 
 #Schema-file-server
 APP_PORT=4000

.env.sample

@@ -67,7 +67,8 @@ POSTGRES_PORT=5432
 POSTGRES_USER='postgres'
 POSTGRES_PASSWORD='xxxxx'
 POSTGRES_DATABASE= // Please provide your DB name
-
+# Default is true too, set to 'false', to view OIDC controllers in openAPI docs
+HIDE_EXPERIMENTAL_OIDC_CONTROLLERS=true
 SENDGRID_API_KEY=xxxxxxxxxxxxxx // Please provide your sendgrid API key
 
 FRONT_END_URL=http://localhost:3000

apps/api-gateway/src/app.module.ts

@@ -6,7 +6,7 @@ import { AppService } from './app.service';
 import { AuthzMiddleware } from './authz/authz.middleware';
 import { AuthzModule } from './authz/authz.module';
 import { ClientsModule, Transport } from '@nestjs/microservices';
-import { ConfigModule } from '@nestjs/config';
+import { ConditionalModule, ConfigModule } from '@nestjs/config';
 import { CredentialDefinitionModule } from './credential-definition/credential-definition.module';
 import { FidoModule } from './fido/fido.module';
 import { IssuanceModule } from './issuance/issuance.module';
@@ -33,6 +33,7 @@ import { ConfigModule as PlatformConfig } from '@credebl/config/config.module';
 import { Oid4vcIssuanceModule } from './oid4vc-issuance/oid4vc-issuance.module';
 import { X509Module } from './x509/x509.module';
 import { Oid4vpModule } from './oid4vc-verification/oid4vc-verification.module';
+import { shouldLoadOidcModules } from '@credebl/common/common.utils';
 
 @Module({
   imports: [
@@ -66,9 +67,9 @@ import { Oid4vpModule } from './oid4vc-verification/oid4vc-verification.module';
     CacheModule.register(),
     GeoLocationModule,
     CloudWalletModule,
-    Oid4vcIssuanceModule,
-    Oid4vpModule,
-    X509Module
+    ConditionalModule.registerWhen(Oid4vcIssuanceModule, shouldLoadOidcModules),
+    ConditionalModule.registerWhen(Oid4vpModule, shouldLoadOidcModules),
+    ConditionalModule.registerWhen(X509Module, shouldLoadOidcModules)
   ],
   controllers: [AppController],
   providers: [

apps/api-gateway/src/main.ts

@@ -118,5 +118,12 @@ async function bootstrap(): Promise<void> {
   );
   await app.listen(process.env.API_GATEWAY_PORT, `${process.env.API_GATEWAY_HOST}`);
   Logger.log(`API Gateway is listening on port ${process.env.API_GATEWAY_PORT}`);
+
+  if ('true' === (process.env.HIDE_EXPERIMENTAL_OIDC_CONTROLLERS || 'true').trim().toLowerCase()) {
+    Logger.warn('Hiding experimental OIDC Controllers: OID4VC, OID4VP, x509 in OpenAPI docs');
+    Logger.verbose(
+      "To enable the use of experimental OIDC controllers. Set, 'HIDE_EXPERIMENTAL_OIDC_CONTROLLERS' env variable to false"
+    );
+  }
 }
 bootstrap();

apps/api-gateway/src/oid4vc-issuance/oid4vc-issuance.controller.ts

@@ -54,6 +54,7 @@ import {
   GetAllCredentialOfferDto,
   UpdateCredentialRequestDto
 } from './dtos/issuer-sessions.dto';
+
 @Controller()
 @UseFilters(CustomExceptionFilter)
 @ApiTags('OID4VC')

apps/api-gateway/src/oid4vc-verification/oid4vc-verification.controller.ts

@@ -48,6 +48,7 @@ import { Oid4vcVerificationService } from './oid4vc-verification.service';
 import { CreateVerifierDto, UpdateVerifierDto } from './dtos/oid4vc-verifier.dto';
 import { PresentationRequestDto, VerificationPresentationQueryDto } from './dtos/oid4vc-verifier-presentation.dto';
 import { Oid4vpPresentationWhDto } from '../oid4vc-issuance/dtos/oid4vp-presentation-wh.dto';
+
 @Controller()
 @UseFilters(CustomExceptionFilter)
 @ApiTags('OID4VP')

libs/common/src/common.utils.ts

@@ -138,3 +138,9 @@ export const getAgentUrl = (agentEndPoint: string, urlFlag: string, paramId?: st
   const url = `${agentEndPoint}${resolvedUrlPath}`;
   return url;
 };
+
+export function shouldLoadOidcModules(): boolean {
+  const raw = process.env.HIDE_EXPERIMENTAL_OIDC_CONTROLLERS ?? 'true';
+  const hide = 'true' === raw.toLowerCase();
+  return !hide;
+}