{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"877333d6-ed00-4c90-9209-c8a56c5b3bd8"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"paragraph","content":[{"text":"In this guide we are going to explain how you to extend the platform functionality by developing plugins. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This feature is only available in the Enteprise version. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Furthermore, it is currently in PREVIEW state, so when if a product wants to use it, please refer ","type":"text"},{"text":"support@onesaiplatform.com","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@onesaiplatform.com"}}]},{"text":" for activation.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Developing a custom Token Enhancer for the Identity Manager","type":"text"}]},{"type":"paragraph","content":[{"text":"Suppose you want to customize the way the JWT token is built at the Identity Manager.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"New maven project","type":"text"}]},{"type":"paragraph","content":[{"text":"First of all, start by creating a new maven project on which you’ll develop the proposed functionality.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":306,"id":"680f99d4-c4da-4401-8e18-1c8f38efe2a5","collection":"contentId-448856078","type":"file","height":137}}]},{"type":"paragraph","content":[{"text":"In order to guarantee 100% compatibility with the platform’s modules, version 1.5.9.RELEASE of Spring Boot and Java 1.8 should be used.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":457,"id":"b03df677-d424-4d73-be5e-20bd26cb511f","collection":"contentId-448856078","type":"file","height":196}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Developing the functionality","type":"text"}]},{"type":"paragraph","content":[{"text":"Let's start by creating a class that implements the interface TokenEnhancer on where we are going to add a simple property to the Oauth Access Token.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":630,"id":"134f961c-9a41-4761-bcdc-9d4fada868f8","collection":"contentId-448856078","type":"file","height":165}}]},{"type":"paragraph","content":[{"text":"In order for the Authorization Server to use this Enhancer, you’ll need to create a @Configuration class which will extend AuthorizationServerConfigurerAdapter. In such class, you’ll override the method which configures the endpoints.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this configure method, you’ll add the PluginTokenEnhancer itself to the existing Token Enhancer Chain:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":549,"id":"524c8abc-6dab-4842-83a0-5431107518ba","collection":"contentId-448856078","type":"file","height":192}}]},{"type":"paragraph","content":[{"text":"In this way, your enhancer will be applied as the last link of the Enhancer Chain, before building the final JWT token.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Build the JAR","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Lightweight JAR","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"You will use this method when NOT using external dependencies that Spring Boot does not bring","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"For the Identity Manager to use the plugin, you’ll need to package the project into a JAR file, either with ","type":"text"},{"text":"mvn clean install","type":"text","marks":[{"type":"em"}]},{"text":" or ","type":"text"},{"text":"mvn clean package","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Once the JAR is built, you shall upload it to a server accesible from the internet, or at least accesible from the server where the platform is deployed.","type":"text"}]},{"type":"paragraph","content":[{"text":"This server or repository could be for example a Nexus, where you’ll copy the link to the JAR file:","type":"text"}]},{"type":"paragraph","content":[{"text":"https://nexus.onesaitplatform.com/nexus/service/local/repositories/releases/content/com/minsait/onesait/platform/onesaitplatform-base-plugin/1.0.0/onesaitplatform-base-plugin-1.0.0.jar","type":"text","marks":[{"type":"link","attrs":{"href":"https://nexus.onesaitplatform.com/nexus/service/local/repositories/releases/content/com/minsait/onesait/platform/onesaitplatform-base-plugin/1.0.0/onesaitplatform-base-plugin-1.0.0.jar"}}]}]},{"type":"paragraph","content":[{"text":"Or it could be the binary repository of the platform itself:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1174,"id":"2ea5f1bf-aa2d-4a0d-a346-0399f095759a","collection":"contentId-448856078","type":"file","height":58}}]},{"type":"paragraph","content":[{"text":"https://development.onesaitplatform.com/controlpanel/files/5e71fb0e7ec58a000bf6f966","type":"text","marks":[{"type":"link","attrs":{"href":"https://development.onesaitplatform.com/controlpanel/files/5e71fb0e7ec58a000bf6f966"}}]}]},{"type":"paragraph","content":[{"text":"Please note that whatever the repository is, the file needs to be public, as the Identity Manager will try to download it without any kind of authentication.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"FAT JAR","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"You will use this method whenever you DO use external dependencies that does not come with Spring Boot","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"em"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"The process is slightly different. In this case you’ll want to add the maven assembly plugin to your pom.xml","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\t\n\t\t\n\t\t\tmaven-assembly-plugin\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tjar-with-dependencies\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tmake-assembly \n\t\t\t\t\tpackage \n\t\t\t\t\t\n\t\t\t\t\t\tsingle\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Then you’ll generate your plugin with ","type":"text"},{"text":"mvn package","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Keep in mind that this will generate a JAR with all dependencies, and therefore considerably increase the size of the plugin.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Define the URI of the plugin in the Identity Manager (Oauth Server)","type":"text"}]},{"type":"paragraph","content":[{"text":"As the last step, you’ll need to let the module know where the plugin is, this is done by setting the environment variable PLUGIN_URI to the URI(s) where the JAR is located. In case there is more than one plugin, URIs must be separated with the character ';'","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":947,"id":"0e3290c7-2922-4b27-8a95-9a998067d969","collection":"contentId-448856078","type":"file","height":59}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Now at the startup, the identity manager will attempt to find and load the plugins:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":712,"id":"6c57a682-c362-40fc-a45e-73ec906be48f","collection":"contentId-448856078","type":"file","height":254}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"JWT Token: test","type":"text"}]},{"type":"paragraph","content":[{"text":"Finally, you can test your plugin by making a request to the Identity Manger and check for the new parameter that your Enhancer is adding.","type":"text"}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1116,"id":"05bbf62f-c6e0-405b-a873-b8ca37134fee","collection":"contentId-448856078","type":"file","height":501}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Resources","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"1420a69e-5aea-4865-912a-a3a6e2498c2a","collection":"contentId-448856078","type":"file"}}]},{"type":"paragraph"}],"version":1}

Browser not supported