Changes for page Securing your SOAP Webservice

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-novice-file-based-connectivity-characterset
	1	+Securing your SOAP Webservice

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.ebakker
	1	+XWiki.dfirdausy

Content

...	...	@@ -1,104 +1,114 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-In some cases, you want to treat each unique part of your input file as its message instead of processing the complete file as its message. In this microlearning, we will learn how you can process a (large) file on a per-line basis.
	2	+In this microlearning, we’ll focus on securing your SOAP web service within eMagiz. Proper authentication is crucial to ensure that only authorized clients can access your service. We’ll cover the essentials of setting up authentication, including API key verification. By the end of this session, you'll understand how to configure your SOAP web service to handle client authentication securely. Let’s dive into how you can effectively set up and manage these security features.
3	3
4		-Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
	4	+Should you have any questions, please contact academy@emagiz.com.
5	5
6		-* Last update: May 31th, 2021
7		-* Required reading time: 7 minutes
8		-
9	9	== 1. Prerequisites ==
10		-
11	11	* Basic knowledge of the eMagiz platform
12	12
13	13	== 2. Key concepts ==
	10	+This microlearning centers around configuring your SOAP web service.
14	14
15		-This microlearning centers around learning how to process an incoming file per line.
	12	+By configuring, we mean: Designing and determining the characteristics of the SOAP web service
16	16
17		-By processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message
	14	+Crucial parts in the configuration are:
	15	+* Operation Name
	16	+* SOAP Webservice Namespace
	17	+* Validation
	18	+* Authentication
18	18
19		-* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
20		-* Ability to process each line based on distinctive logic that is relevant on line level
21		-* Can be used for flat file as well as XML input files
	20	+Of these four points, we will zoom in on the authentication part of our SOAP Webservice in this microlearning.
22	22
23		-== 3. Processing a File per Line ==
	22	+== 3. Securing your SOAP Webservice ==
24	24
25		-In some cases, you want to treat each unique part of your input file as its message instead of processing the complete file as its message. In this microlearning, we will learn how you can process a (large) file on a per-line basis.
	24	+When setting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point. One of those options is by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. In this microlearning, we will zoom in on the part that security plays on a client level when hosting a SOAP web service.
26	26
27		-To make this work in eMagiz you need to navigate to the Create phase of eMagiz and open the entry flow in which you want to retrieve the file to a certain location. Within the context of this flow, we need to add functionality that will ensure that each line is read and processed separately and will become its unique message. To do so first enter "Start Editing" mode on flow level. After you have done so please add a file item reader message source to the flow. We will use this component to read and process our input file on a per-line basis.
	26	+Crucial parts in the configuration are:
	27	+* Operation Name
	28	+* SOAP Webservice Namespace
	29	+* Validation
	30	+* Authentication
28	28
29		-The first step would be to define the directory from which we read our messages. As always reference to the directory with the help of a property.
	32	+Of these four points, we will zoom in on the authentication part of our SOAP Webservice in this microlearning. When hosting your SOAP web service in the eMagiz Cloud the endpoint will be HTTPS secured on default. If you want to mimic the same result for an on-premise environment you should define the valid SSL settings, as explained in this [[Q&A>>https://my.emagiz.com/p/question/172825635700357186||target="blank"]].
30	30
31		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]]
	34	+Apart from that aspect of security, we should also consider how clients that call the SOAP Web service will authenticate themselves upon entry. Within eMagiz, we advise a two-step approach. Each client that wants to call your SOAP Webservice should:
32	32
33		-Secondly, just as when reading the file as a whole ensure that you use a filter to retrieve only the correct files from the directory.
	36	+* Send along a client certificate
	37	+* Send along an API key in a SOAP Header that references to the word apiKey (i.e. apiKey)
34	34
35		-=== 3.1 Item reader Type ===
	39	+To verify both parts some configuration is needed. The first aspect, checking for a valid client certificate is done on cloud level. For more information on how to exactly configure this please take a look at the [[Securing a hosted web service with certificates in the eMagiz Cloud>>Main.eMagiz Academy.Microlearnings.Intermediate Level.Securing Data Traffic.intermediate-securing-your-data-traffic-securing-a-hosted-webservice-with-certificates-in-the-emagiz-cloud||target="blank"]] microlearning.
36	36
37		-Now it is time to select our Item reader Type. As the help text of the eMagiz component suggest there are two choices with this component. The first (and most frequently used) option is the Flat file item reader. With this option, you can read each line within the flat file input file and output is at a separate message. The second option is called the Stax event item reader. With this option, you can read your input XML and output messages on a per-record basis.
	41	+In this microlearning, we will focus on the second part of the configuration.
38	38
39		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]
	43	+=== 3.1 API Key verification ===
40	40
41		-Based on your choice the exact configuration will differ.
	45	+To verify whether the client has sent a valid API Key we need to change the configuration within the entry flow in the Create phase of eMagiz. The configuration consists of three steps:
42	42
43		-==== 3.1.1 Stax Event Item Reader ====
	47	+* Get value from SOAP Header
	48	+* Check value against a list
	49	+* Respond based on results
44	44
45		-For the Stax event item reader, you need to define the name of the element on which you want to split the XML and define whether you want to throw an error in case no such element exists in the input file (By (de)selecting the option Strict). The default setting of eMagiz is advisable for this option.
	51	+==== 3.1.1 Get value from SOAP Header ====
46	46
47		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]]
	53	+Let us move to the entry flow by going to the Create phase of eMagiz, opening the correct flow, and entering "Start Editing" mode. After you have done so we need to add a support object to the flow. The support we need is called 'Complex SOAP header mapper'. In this component, we need the bottom section.
48	48
49		-==== 3.1.2 Flat File Item Reader ====
	55	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-securing-your-soap-webservice--complex-soap-header-mapper.png]]
50	50
51		-For the Flat File item reader, there are some more choices and configurations to be made. There are three options you can choose from:
52		-- Pass through line mapper
53		-- Default line mapper
54		-- Pattern matching composite line mapper
	57	+Here we define a new header by entering a name and a valid XPath expression.
55	55
56		-Each of these options has some advantages and disadvantages. Adhering to the best practices of eMagiz (i.e. no transformation in the entry) the best option would be to use the pass-through line mapper. As the name suggests this option does nothing except give a string back to the flow on a per line basis. However, choosing this option means that the actual transformation from that string to XML needs to happen later in the process (most likely in the onramp) with the help of a flat-file to XML transformer (more on that component in a later course).
	59	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-securing-your-soap-webservice--complex-soap-header-mapper-config.png]]
57	57
58		-The other two options transform the input line into an XML output. So you win one step in the process. However, no standard eMagiz error handling is advisable when you start transforming data within the entry. So in case, something goes wrong to analyze the error will become more difficult. Furthermore, another potential disadvantage is that when one line fails the processing of the rest of the file also halts.
	61	+When you are satisfied you can press Save twice to store the support object. After we have configured the support object we need to link it to our web service inbound gateway. To do so open the component, navigate to the advanced tab and select the Header mapper you have just created.
59	59
60		-For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen.
	63	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-securing-your-soap-webservice--link-complex-soap-header-mapper.png]]
61	61
62		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]]
	65	+==== 3.1.2 Check value against list ====
63	63
64		-As you can see on the Basic level we are done. However, it is always good to check out the settings on the Advanced tab, especially in this case, to see if there are additional configuration options that could benefit us. The setting of most interest, in this case, is the Lines to Skip setting (default setting is 0). With this setting, you can define whether or not you want to process the header line(s) that exists within your input file. The remainder of the settings is (in most cases) good the way eMagiz has set them up.
	67	+Now that we placed the value the client has entered in the apiKey SOAP header on our message we can check whether the value exists in a list of predefined valid values. To do add two headers to the standard header enricher component in your flow. The first one ensures that the apiKey is removed from the header (to prevent the API key from being publicly seen by others). The second one searches for the client name that corresponds with the apiKey and returns the name of the client in the header. This search action is done with the help of a SpEL expression, more on that later on. In this case the SpEL expression we use is set up as follows:
65	65
66		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]]
	69	+{{code}}headers['spwbsrv_apiKey'] != null and {${authentication.api-keys}}.contains(headers.spwbsrv_apiKey) ? {${authentication.tenant-ids}}[{${authentication.api-keys}}.indexOf(headers.spwbsrv_apiKey)] : null{{/code}}
67	67
68		-=== 3.2 Poller ===
	71	+With this SpEL expression, we check whether there is an API key and whether that apiKey can be found in a predefined list. If so we search for the corresponding name based on the index of where a certain apiKey is within the list. If not the header is not created. Combining this logic in one component should look similar to the following.
69	69
70		-Now that we have selected and configured the item reader type it becomes time to fill in the last part of the configuration, the poller. For polling eMagiz offers three options:
	73	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-securing-your-soap-webservice--check-headers.png]]
71	71
72		-- Fixed Delay Trigger
73		-- Fixed Rate Trigger
74		-- Cron Trigger
	75	+==== 3.1.3 Respond based on results ====
75	75
76		-Of these options, the cron trigger is used most frequently in eMagiz. The reason being is that you can define this option via a property that you can alter without having to alter the flow version in Create.
	77	+After we have searched for the API key in the list and we have defined the client that is sending the information (or not) we can respond to the client whether or not the client is authorized to call our SOAP web service. To execute this check we first need a standard filter component. In this component, we will check whether the spwbsrv_client header we have just created is not null.
77	77
78		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--poller-config.png]]
	79	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-securing-your-soap-webservice--standard-filter.png]]
79	79
80		-After finishing all these configuration steps we can press Save to save our work and ensure that we can process the input file on a per-line basis.
	81	+If it is indeed not null we can pass the empty message back to the client telling the client that the message was delivered successfully. If the header is null we need to tell the client that he/she is unauthorized to call the operation. To do so we need to add a component called 'custom error message activator'. In this component, we define the message we want to give back to the client in case of an error. In this case, we simply give back 'Unauthorized'.
81	81
82		-== 4. Assignment ==
	83	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-securing-your-soap-webservice--custom-error-message.png]]
83	83
84		-Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
85		-This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
	85	+With all this done we have successfully secured our SOAP web service according to the best practices.
86	86
87		-== 5. Key takeaways ==
	87	+== 4. Key takeaways ==
88	88
89		-* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
90		-* Ability to process each line based on distinctive logic that is relevant on line level
91		-* Can be used for flat file as well as XML input files
92		-* Try to avoid complex transformations within the entry
	89	+* Crucial parts in the configuration are:
	90	+ ** Operation Name
	91	+ ** SOAP Webservice Namespace
	92	+ ** Validation
	93	+ ** Authentication
	94	+* Hosting your SOAP web service in the eMagiz cloud results in standard HTTPS
	95	+* Use a combination of client certificate + API key for authentication
93	93
94		-== 6. Suggested Additional Readings ==
	97	+== 5. Suggested Additional Readings ==
95	95
96		-There are no suggested additional readings on this topic
	99	+* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
	100	+** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]]
	101	+*** [[Configure your SOAP web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-configure-your-soap-webservice-gen3.WebHome||target="blank"]]
	102	+*** [[Validate Incoming Messages (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-validate-incoming-messages-gen3.WebHome||target="blank"]]
	103	+*** [[Endpoint Check (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-endpoint-check-gen3.WebHome||target="blank"]]
	104	+*** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]]
	105	+*** [[Calling a SOAP Web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-calling-a-soap-webservice||target="blank"]]
	106	+*** [[Authorization - Calling a SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-authorization-calling-a-soap-webservice||target="blank"]]
	107	+* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
	108	+** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]]
	109	+* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
	110	+** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]]
	111	+* [[SOAP Web service (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22soap+web+service%22||target="blank"]]
97	97
98		-== 7. Silent demonstration video ==
99	99
100		-This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
101		-
102		-{{video attachment="novice-file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
103		-
104	104	)))((({{toc/}}))){{/container}}{{/container}}