Beruflich Dokumente
Kultur Dokumente
Tutorial
1. INTRODUCTION .............................................................................. 1
2. REQUIREMENTS ............................................................................. 2
3. INSTALLATION & START OF THE STARTER KIT ......................... 2
4. SAMPLE SCENARIO ....................................................................... 3
4.1.
4.2.
SOA Gateway........................................................................................................................ 14
4.3.
4.4.
5. ADVICE .......................................................................................... 27
5.1.
5.3.
5.4.
1.
Introduction
Thank you very much for your interest in the Open SOA Gateway.
With the Open SOA Gateway Demonstrator you will receive a preconfigured package for
evaluation of the security solution. Besides the Open SOA Gateway, additionally there is a
sample web service as well as a TCP Monitor (TCPMon) included in the Demonstrator. This
enables the rapid performance of sample scenarios without set-up of additional
infrastructure.
2.
Requirements
443
2000,2200,2500
1900,2100,2300,2400,2600
2301,2302
3.
The starter kit is delivered as ZIP archive, containing an installation of all components
modified for demo purposes.
Unpack the ZIP archive directly to C:\. Within the archive there is a predefined file structure.
After extracting the CORISECIO directory should display the following structure:
For the start of all components a Batch file is used (startDemonstrator.cmd). Execute this file
to start the starter kit.
4.
Sample scenario
To enable a quick evaluation of the solution, CORISECIO provides a Demo Web Services as
well as a TCP monitor.
The sample scenario protects an order process in a book shop. It sends two requests to
different recipients (Services).
The communication between the shop and the recipients is unencrypted in this initial
constellation.
This scenario is a segment of the example attended to in the BSIs SOA Security
compendium. The following image displays the whole scenario.
The order process is protected by the Open SOA Gateway. The protection is done between
Web Shop and merchant as well as between Web Shop and financial services provider. The
connection between Web Shop and warehouse is ignored here.
By using three Security Gateways the complete data set between Web Shop and
merchant as well as the payment information to the financial services provider are protected.
A complete protection of the transportation route between merchant and payment provider
could also be done but is omitted to gain a better overview of the scenario. Here the
connection from merchant to payment provider is assumed to be protected otherwise.
The protected set-up of the sample scenario is as follows:
Based on the five TCP monitors contained in the package the protection of the connection
may be simulated. Here the content of the first TCP monitor should exemplarily be used for
demonstration of the SOAP message and the elements to be encrypted.
The Open SOA Gateway protect the connection using SAML authentication, XML Signature
and XML Encryption. In this scenario a message for two different recipients is protected. On
one hand, the whole data set for the merchant is encrypted and signed and on the other
hand the access data for the payment provider is especially encrypted separately.
Below the detailed procedure is described:
The first Open SOA Gateway (order + payment encryption in the diagram)
inserts a SAML authentication to the message. Then paymentInformation is
CORISECIO GmbH - Uhlandstr. 9 - 64927 Darmstadt - Germany - www.corisecio.com
encrypted using the certificate of the third Open SOA Gateway (payment decryption
in the diagram).
Subsequently the message (SOAP Envelope) is signed and encrypted. Here the whole
Order element (see SOAP message graphic above) for the second Security Connector
(order decryption in the diagram) is encrypted. Then the message is forwarded to
the second Open SOA Gateway e.g. via the Internet.
Now the second Open SOA Gateway scans the SAML authentication, decrypts the
message and verifies the signature. The paymentInformation data remains
encrypted. The message is forwarded to the merchant.
The third Open SOA Gateway decrypts the paymentInformation data and forwards it
to the payment provider.
The configuration of the individual Open SOA Gateway is described more detailed under
point 4.2. No further configuration of the Open SOA Gateway is required for execution of this
sample scenario.
To be able to view the communication between the individual paragraphs, several TCP
monitors are used. Using these TCP monitors actions processed on the SOAP message
can be viewed. In the sample scenario, 5 TCP monitors are started in one window.
As only the way out is secured, always only the upper part of the TCP monitor is relevant. In
the following image this part is marked in red.
4.1.
The
is
now
ready-for-use
http://localhost:8080/WSDemo/.
and
may
be
called
up
under
To obtain help for the use of the Demo scenario, you may move the mouse over the button
Demo Help (
) on each page. Here a help for the required steps is displayed on the
respective page.
Start the book order with a click on Start Demo in the middle of the window.
Chose one or more articles from the assortment and then confirm with Add to Shopping
Cart at the end of the page (the maximum amount per item is limited to 10).
Enter sample data in address and payment data request and confirm with Send Order (the
credit card number must be a 16-digit number).
Then you will see the respective messages on the TCP monitors. Here this is shown
exemplarily using excerpts of the individual monitors. The other demo shop sites are only for
information purposes. By clicking on Send Order the operation is completed.
CORISECIO GmbH - Uhlandstr. 9 - 64927 Darmstadt - Germany - www.corisecio.com
10
Signature
Encryption
The whole Order element has been encrypted. As described in the scenario, also the
paymentInformation element was previously encrypted. This will be shown in the
next TCP monitor.
11
12
Finally
you
may
call
up
summary
of
the
payment
provider
http://localhost:8080/WSDemo/pp
13
under
Please kindly note that the configured TCP monitors are not designed for long-term usage or
load tests. If protection of web services seems to be slow, you may deactivate the TCP
monitors. The required procedure is described in chapter 5.4.
You have successfully completed the prepared scenario. You may now see and edit the
Security Connector settings in the following chapter.
4.2.
SOA Gateway
The configuration of the Open SOA Gateway is done via the Workflow Manager on the
local secRT entity. The local administration is done via a web console, accessible via
browser.
The three Security Gateways are accessible under the following addresses (see scenario
diagram):
https://localhost/consumer
https://localhost/provider
https://localhost/payment
https://localhost/proxy
You may log-in with the password secRT on the respective Security Gateway.
14
Now choose Workflow Manager from the left-hand menu to see or edit the respective
SOA Gateways.
15
Via the Workflow Manager several Workflows within a secRT may be administrated.
Therefore, the overview page of the available workflows is displayed first. For the sample
scenario only one workflow per secRT is configured. Click on the Edit button after the
name of the configured workflow each, to view the detail configuration. The active workflows
in the standard configuration are consumer, provider and payment.
Hereafter the configurations of the individual Open SOA Gateway from the sample scenario
are shown.
16
17
18
SetSecRTEntity
Configuration of the entity name, the private key and the certificate.
ExtractFromRequest
19
encryptXPathForCertificate
SignSOAPEnvelopeWithXPath
Signature of the SOAP message; the signature is done by the elements referenced
by the given X-Path.
EnvelopeInRequest
Proxy
decryptXPath
verifySOAPEnvelope
4.3.
Verification of signature
Using the protection of the return path as an example in this chapter will be demonstrated
how Web Services may be protected easily with the help of Open SOA Gateway. The http
response between the entities consumer and provider is protected. For this purpose the
workflow of both entities has to be adapted in the demonstrator.
1. Open a browser and enter the address https://localhost/provider.
2. Log-in at the Open SOA Gateway using the password secRT.
CORISECIO GmbH - Uhlandstr. 9 - 64927 Darmstadt - Germany - www.corisecio.com
20
5. Add the following functions in the area Workflow Sequence using the Drop-Down
Box Function:
ExtractFromResponse
EncryptXPathForCertificate
EnvelopeInResponse
21
15. Add the following functions using the Drop-Down Box Functions:
ExtractFromResponse
DecryptXPath
EnvelopeInResponse
CORISECIO GmbH - Uhlandstr. 9 - 64927 Darmstadt - Germany - www.corisecio.com
22
23
4.4.
For the following scenario another secRT entity was pre-configured and a workflow was
pre-defined. In this scenario the turnover tax advance return for each transaction is done
automated at the local tax office. This process represents the lowermost part of the
overall scenario already introduced. For this a provided WSDL definition is used and the
value of the current transaction is entered.
1. Open a browser and enter the address https://localhost/wsdl.
2. Click Admin on the menu bar and select Import / Export.
3. Select Workflows under Import in the Drop-Down Box.
4. Now click the Browse button and chose the file C:\CORISECIO\workflow.csv.
With this file a preconfigured workflow is imported in the secRT.
24
25
ExtractFromRequest
XMLValueToExecutionVariable
Reading of an XML variable (order value) from the order and saving in a variable.
CreateSOAPMessageFromWSDL
SetValueOfXPath
Envelope in Request
Proxy
26
5.
Advice
5.1.
SSL Connection
As the connection with the secRT entities is protected via a self-issued SSL certificate, you
will receive warning messages in your browser. In this chapter is described, how you may
access the secRT entities despite of warnings (under Microsoft Internet Explorer and Mozilla
Firefox). Furthermore, a replacement of the SSL certificate used is explained.
5.1.1.
If the HTTPS TCP Port is used on your server already, you may change the Apache Tomcat
configuration.
Close
the
complete
demonstrator
and
open
the
file
C:\CORISECIO\Tomcat\conf\server.xml. In the line port="443" instead of 443
enter the required TCP Port.
5.1.2.
When accessing the secRT entities a notification appears in the Internet Explorer that there
is a problem with the certificate of the web site.
5.1.3.
When accessing the secRT entities or the demo web shop a notification in Firefox appears
that the connection is not to be trusted.
27
The button Add Exception appears in Firefox. Please click this button. A dialog for Adding
of security exception rules is opened.
28
5.1.4.
To replace the Apache Tomcat SSL certificate, first terminate all running entities. A suitable
P12 Container is required for the SSL configuration. Finally act as follows:
In the row keystoreFile replace the entry secrt.p12 with the file you require.
In the row keystorePass replace the password for the P12 file.
CORISECIO GmbH - Uhlandstr. 9 - 64927 Darmstadt - Germany - www.corisecio.com
29
Start
the
demonstrator
by
C:\CORISECIO\startDemonstrator.cmd.
5.2.
calling
the
file
Please kindly note that the standard configuration was designed for 300 objects at user and
role.
5.3.
OutOfMemory error
The starter kit was configured with the standard value 1024MB RAM. If you would like to run
more complex tests, it is advisable to increase the available memory. In order to do so the
file C:\CORISECIO\Tomcat\bin\catalina.bat needs to be adjusted.
For this open the file with a text editor of your choice and search for the value set
JAVA_OPTS=%JAVA_OPTS%. In this row increase the maximum heap size value (Xmx1536M) to increase the RAM limit to 1536 Megabyte. Please kindly note that the limit for
32 bits operating systems is 1600 MB.
Example:
set JAVA_OPTS=%JAVA_OPTS% -Xmx1536M -XX:MaxPermSize=256m Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager Djava.util.logging.config.file="%CATALINA_BASE%\conf\logging.propert
ies"
Please ensure that the Xmx entry as well as the MaxPermsize Parameter (-Xmx1536M XX:MaxPermSize=256m) are set at your Apache Tomcat entity.
5.4.
Please kindly note that 5 TCP monitor entities have been inserted between each section.
The TCP monitors are used for control of exchanged data. If you would like to run
performance or load tests, you may deactivate the use of the TCP monitors.
For this it is required to terminate the TCP monitors and to activate each workflow with the
add-on (no TCP Monitor) in the three secRT entities.
Additionally you have to terminate the Apache Tomcat and to replace the content of the file
C:\CORISECIO\Tomcat\webapps\WSDemo\config.xml with the content of the file
config_withoutTCPMonitor.xml
30
Please kindly note that the TCP monitors are called up automatically at each re-start of the
demonstrator. This can be changed by deleting the row start tcpmon.bat in the file
C:\CORISECIO\startDemonstrator.bat.
To re-use the TCP monitors, act as follows: in the three secRT entities the workflows have to
be reset to the initial state. Please stop the Apache Tomcat entity and replace the content of
the file C:\CORISECIO\Tomcat\webapps\WSDemo\config.xml with the content of the
file config_withTCPMonitor.xml in the same directory. Then start the demonstrator by calling
the file C:\CORISECIO\startDemonstrator.cmd.
31