[APIC]DataPower 의 MPGW 를 직접 수정하여 extension 기능 추가하기

안녕하세요 이정운 입니다.

이번에 DeveloperWorks 에 IBM API Connect 관련하여 DataPower 의 MPGW 를 직접 수정하여 extension 기능을 추가하는 좋은 예제가 소개되어 있어서 공유드리오니 참고하시기 바라겠습니다.

비록 영어이긴 하지만 step-by-step 형태로 정의되어 있어서 쉽게 참고하실 수 있지 않을까 합니다.

https://developer.ibm.com/recipes/tutorials/api-connect-customising-http-headers-for-client-id-and-secret/

API Connect : Customising HTTP Headers for Client ID and Secret

Often we are asked by customers how they can modify the headers for the client id and client secret. Our standard response has been this is a trivial extension in IBM DataPower by adding an extra transform to the Multi Protocol Gateway. However not everyone understands what we mean!

Chris Phillips
Published on March 30, 2017 / Updated on May 25, 2017

Overview

Skill Level: Any Skill Level

Knowledge of DataPower will help

API Connect requires Client ID and Client Secret to be published with x-ibm-client-id & x-ibm-secret-id. This guide will tell you how to add a transform policy allowing you to set any header and map the values on to the x-ibm-client-id & x-ibm-secret-id.

Ingredients

• API Cloud, Containing at least
  
  • API Manager (V5.0.X)
  • Datapower (V7.5.2.X)
• Text Editor

 

Points to consider.

• In this tutorial we explain how to save this configuration as a Gateway Extension. If the Gateway Extension is not configured API Connect will overwrite these changes during a future upgrade or any event that requires a resynchronisation. 
• The example provided here does not stop the API Connect Out of the Box headers from working if the custom headers are not set.
• The Developer Portal will always show the Out of the Box Headers not the custom headers.
• This will not work in IBM BlueMix Public

Step-by-step

Name the headers

Decide what values you want to use for the Client ID and Client Secret header. Though these can be changed later it can break your existing consumers if you need to change.

The example in this recipie uses myClientIDHeader and mySecretIDHeader.

A sample curl command would look like below, where clientidval is the ClientID value and secretidval is the SecretID value.

curl -v -H “myClientIDHeader:clientidval” -H “mySecretIDHeader:secretidval”
https://Datapower:443/

XSLT Transform

Take the following XSLT and replace myClientIDHeader and mySecretIDHeader with your desired values. Save this as an xslt file on your local system. It is recommended that you check this file into a source code management system.

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" extension-element-prefixes="dp" 
exclude-result-prefixes="dp" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
xmlns:dp="http://www.datapower.com/extensions">
 <xsl:template match="/">
 <xsl:variable name="clientid" select="dp:http-request-header('myClientIDHeader')"/>
 <xsl:variable name="secretid" select="dp:http-request-header('mySecretIDHeader')"/>
 <xsl:message dp:priority="debug">
 <xsl:value-of select="$clientid"/>
 </xsl:message>
 <xsl:if test="$secretid">
 <dp:set-request-header name="'x-ibm-secret-id'" value="$secretid"/>
 </xsl:if>
 <xsl:if test="$clientid">
 <dp:set-request-header name="'x-ibm-client-id'" value="$clientid"/>
 </xsl:if>
 </xsl:template>
</xsl:stylesheet>

Log into a DataPower that contains an API Connect Domain



Go to the API Connect Domain



Go to the webapi Multi-Protocol Gateway






Then click on webapi.



Click on the pencil by the Multi-Protocol Gateway Policy




Drag a transform from the tool bar to the start of the flow. This should end up after the first matching policy as shown in the diagram.

Double click on the new transform

Ensure Local:// is selected in the Transform File and click Upload

Navigate to the xslt you saved in step 3.

curl -v -H “myClientIDHeader:clientidval” -H “mySecretIDHeader:secretidval”
https://Datapower:443/

Applying this to an entire DataPower Service

Assuming the Test in 14. passed we now need to export these changes as a Gateway Extension.

 

Though it might be tempting to not create a Gateway Extension but instead to just make the changes in each DataPower Domain I recommend against this.

API Connect will redeploy the DataPower domain overwriting any configuration it is not aware of.

In IBM DataPower go to Export Configuration

Press Next

Select Processing Request from the available objects and webapi-mpgw-request-fw. Click “Include data for all objects that the selected objects require” and “Export only file for selected objects “

Click Download

Go to the CMC Console http://APIManager/cmc

Click on Services

For each DataPower service you wish to apply this to click on the Cog

Click Choose File and browse to the file exported from data power.

Each IBM DataPower Node in that service will now be refreshed and apply the gateway extension, this will take about ten minutes

Thats It!