Apply review suggestions

ballerina-platform · Oct 15, 2024 · 89aec51 · 89aec51
1 parent 9ae8629
commit 89aec51
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -131,7 +131,7 @@ These policies empower SOAP clients to enhance the security of their web service
 
 #### Inbound Security Configurations
 
-- `InboundSecurityConfig`: Represents the record for outbound security configurations to verify and decrypt SOAP envelopes.
+- `InboundSecurityConfig`: Represents the record for inbound security configurations to verify and decrypt SOAP envelopes.
   - Fields:
     - `crypto:PublicKey` verificationKey : The public key to verify the signature of the SOAP envelope
     - `crypto:PrivateKey`|`crypto:PublicKey` decryptionKey : The private key to decrypt the SOAP envelope

diff --git a/ballerina/modules/soap11/soap11.bal b/ballerina/modules/soap11/soap11.bal
@@ -37,8 +37,8 @@ public isolated client class Client {
             check soap:validateTransportBindingPolicy(config);
             self.soapClient = check new (url, config.httpConfig);
             readonly & soap:ClientConfig readonlyConfig = soap:getReadOnlyClientConfig(config);
-            self.outboundSecurity = readonlyConfig.outboundSecurity;
             self.inboundSecurity = readonlyConfig.inboundSecurity;
+            self.outboundSecurity = readonlyConfig.outboundSecurity;
         } on fail var err {
             return error Error(SOAP_CLIENT_ERROR, err);
         }
@@ -82,13 +82,13 @@ public isolated client class Client {
                 response = check soap:sendReceive(securedBody, self.soapClient, action, headers, path, false);
             }
             lock {
-                soap:InboundSecurityConfig? inboundSecurity = self.inboundSecurity.clone();
+                wssec:InboundConfig? inboundSecurity = self.inboundSecurity.clone();
                 do {
-                    if inboundSecurity is soap:InboundSecurityConfig && inboundSecurity != {} {
+                    if inboundSecurity is wssec:InboundConfig && inboundSecurity != {} {
                         if response is xml {
-                            return check soap:applyOutboundConfig(<wssec:InboundConfig>inboundSecurity.clone(), response.clone(), false);
+                            return check soap:applyOutboundConfig(inboundSecurity.clone(), response.clone(), false);
                         } else {
-                            return check soap:applyOutboundConfig(<wssec:InboundConfig>inboundSecurity.clone(), 
+                            return check soap:applyOutboundConfig(inboundSecurity.clone(), 
                                                                   check response[0].getXml().clone(), false);
                         }
                     }

diff --git a/ballerina/modules/soap11/tests/soap11_client_test.bal b/ballerina/modules/soap11/tests/soap11_client_test.bal
@@ -398,7 +398,10 @@ function testSoapReceiveWithAsymmetricBindingAndInboundConfig() returns error? {
                 }
             },
             inboundSecurity: {
-                keystore: {path: KEY_STORE_PATH_2, password: PASSWORD},
+                keystore: {
+                    path: KEY_STORE_PATH_2, 
+                    password: PASSWORD
+                },
                 verificationKey: publicKey,
                 signatureAlgorithm: wssec:RSA_SHA256,
                 decryptionAlgorithm: wssec:AES_128

diff --git a/ballerina/modules/wssec/records.bal b/ballerina/modules/wssec/records.bal
@@ -114,9 +114,10 @@ public type NoPolicy "NoPolicy";
 
 # Represents the record for outbound security configurations to verify and decrypt SOAP envelopes.
 #
+# + keystore - The keystore to store the private key
 # + verificationKey - The public key to verify the signature of the SOAP envelope
-# + decryptionKey - The private key to decrypt the SOAP envelope
 # + signatureAlgorithm - The algorithm to verify the SOAP envelope
+# + decryptionKey - The private key to decrypt the SOAP envelope
 # + decryptionAlgorithm - The algorithm to decrypt the SOAP body
 public type InboundConfig record {|
     crypto:KeyStore keystore?;

diff --git a/ballerina/types.bal b/ballerina/types.bal
@@ -40,15 +40,15 @@ public enum EncryptionAlgorithm {
     RSA_ECB = "http://www.w3.org/2001/04/xmlenc#rsa-1_5"
 }
 
-# Represents the record for outbound security configurations to verify and decrypt SOAP envelopes.
-# 
+# Represents the record for inbound security configurations to verify and decrypt SOAP envelopes.
+#
+# + keystore - The keystore to store the private key
 # + verificationKey - The public key to verify the signature of the SOAP envelope
-# + decryptionKey - The private key to decrypt the SOAP envelope
 # + signatureAlgorithm - The algorithm to verify the SOAP envelope
+# + decryptionKey - The private key to decrypt the SOAP envelope
 # + decryptionAlgorithm - The algorithm to decrypt the SOAP body
-public type InboundSecurityConfig record {
-    *wssec:InboundConfig;
-};
+public type InboundSecurityConfig wssec:InboundConfig;
 
-# Union type of all the inbound web service security configurations.
+# Union type of all the outbound web service security configurations.
 public type OutboundSecurityConfig wssec:OutboundSecurityConfig;
+
diff --git a/native/src/main/java/org/wssec/WsSecurity.java b/native/src/main/java/org/wssec/WsSecurity.java
@@ -244,7 +244,7 @@ private static Crypto getCryptoInstance(String path, String password) throws WSS
 
     private static void validateSoapHeader(Boolean soap12, Document document) {
         Init.init();
-        String namespace = (soap12) ? WSConstants.URI_SOAP12_ENV : WSConstants.URI_SOAP11_ENV;
+        String namespace = soap12 ? WSConstants.URI_SOAP12_ENV : WSConstants.URI_SOAP11_ENV;
         Element header = (Element) document.getElementsByTagNameNS(namespace, ELEM_HEADER).item(0);
         if (header == null) {
             throw new IllegalStateException("SOAP Envelope must have a Header");