Support deflate as parameter

README.md

@@ -226,6 +226,9 @@ This is the ``settings.json`` file:
     // Enable debug mode (outputs errors).
     "debug": true,
 
+    // Enable deflate mode (request compression).
+    "deflate": true,
+
     // Service Provider Data that we are deploying.
     "sp": {
         // Identifier of the SP entity  (must be a URI)
@@ -1049,6 +1052,7 @@ Configuration of the OneLogin Python Toolkit
 * ***set_strict*** Activates or deactivates the strict mode.
 * ***is_strict*** Returns if the ``strict`` mode is active.
 * ***is_debug_active*** Returns if the debug is active.
+* ***is_deflate_active*** Returns if the deflate is active.
 
 #### OneLogin_Saml2_Metadata - metadata.py ####
 

src/onelogin/saml2/authn_request.py

@@ -135,15 +135,13 @@ def _generate_request_id(self):
         """
         return OneLogin_Saml2_Utils.generate_unique_id()
 
-    def get_request(self, deflate=True):
+    def get_request(self):
         """
         Returns unsigned AuthnRequest.
-        :param deflate: It makes the deflate process optional
-        :type: bool
         :return: AuthnRequest maybe deflated and base64 encoded
         :rtype: str object
         """
-        if deflate:
+        if self.__settings.is_deflate_active():
             request = OneLogin_Saml2_Utils.deflate_and_base64_encode(self.__authn_request)
         else:
             request = OneLogin_Saml2_Utils.b64encode(self.__authn_request)

src/onelogin/saml2/logout_request.py

@@ -120,15 +120,13 @@ def __init__(self, settings, request=None, name_id=None, session_index=None, nq=
 
         self.__logout_request = compat.to_string(logout_request)
 
-    def get_request(self, deflate=True):
+    def get_request(self):
         """
         Returns the Logout Request deflated, base64encoded
-        :param deflate: It makes the deflate process optional
-        :type: bool
         :return: Logout Request maybe deflated and base64 encoded
         :rtype: str object
         """
-        if deflate:
+        if self.__settings.is_deflate_active():
             request = OneLogin_Saml2_Utils.deflate_and_base64_encode(self.__logout_request)
         else:
             request = OneLogin_Saml2_Utils.b64encode(self.__logout_request)

src/onelogin/saml2/settings.py

@@ -102,6 +102,7 @@ def __init__(self, settings=None, custom_base_path=None, sp_validation_only=Fals
         self.__paths = {}
         self.__strict = True
         self.__debug = False
+        self.__deflate = True
         self.__sp = {}
         self.__idp = {}
         self.__security = {}
@@ -229,6 +230,7 @@ def __load_settings_from_dict(self, settings):
             self.__idp = settings.get('idp', {})
             self.__strict = settings.get('strict', True)
             self.__debug = settings.get('debug', False)
+            self.__deflate = settings.get('deflate', True)
             self.__security = settings.get('security', {})
             self.__contacts = settings.get('contactPerson', {})
             self.__organization = settings.get('organization', {})
@@ -849,6 +851,15 @@ def is_debug_active(self):
         """
         return self.__debug
 
+    def is_deflate_active(self):
+        """
+        Returns if the deflate is active.
+
+        :returns: Deflate parameter
+        :rtype: boolean
+        """
+        return self.__deflate
+
     def _get_allow_single_label_domain(self, settings):
         security = settings.get('security', {})
         return 'allowSingleLabelDomains' in security.keys() and security['allowSingleLabelDomains']

tests/settings/settings1.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://stuff.com/endpoints/metadata.php",

tests/settings/settings10.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "sp": {
         "entityId": "http://stuff.com/endpoints/metadata.php",
         "assertionConsumerService": {

tests/settings/settings2.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://stuff.com/endpoints/metadata.php",

tests/settings/settings3.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://pytoolkit.com:8000/metadata/",

tests/settings/settings4.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://pytoolkit.com:8000/metadata/",

tests/settings/settings5.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://pytoolkit.com:8000/metadata/",

tests/settings/settings6.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://stuff.com/endpoints/metadata.php",

tests/settings/settings7.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://stuff.com/endpoints/metadata.php",

tests/settings/settings8.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://stuff.com/endpoints/metadata.php",

tests/settings/settings9.json

@@ -1,6 +1,7 @@
 {
     "strict": false,
     "debug": false,
+    "deflate": true,
     "custom_base_path": "../../../tests/data/customPath/",
     "sp": {
         "entityId": "http://stuff.com/endpoints/metadata.php",

tests/src/OneLogin/saml2_tests/auth_test.py

@@ -1217,7 +1217,7 @@ def testIsInValidLogoutResponseSign(self):
 
     def testIsValidLogoutRequestSign(self):
         """
-        Tests the is_valid method of the OneLogin_Saml2_LogoutRequest
+        Tests the is_valid method of the OneLogin_Saml2_Logout_Request
         """
         request_data = {
             'http_host': 'example.com',

tests/src/OneLogin/saml2_tests/authn_request_test.py

@@ -370,3 +370,26 @@ def testAttributeConsumingService(self):
         inflated = compat.to_string(OneLogin_Saml2_Utils.decode_base64_and_inflate(authn_request_encoded))
 
         self.assertRegex(inflated, 'AttributeConsumingServiceIndex="1"')
+
+    def testGetRequest(self):
+        """
+        Tests the get_request method of the OneLogin_Saml2_Authn_Request.
+        """
+        saml_settings = self.loadSettingsJSON()
+        saml_settings['deflate'] = True
+        settings = OneLogin_Saml2_Settings(saml_settings)
+
+        authn_request = OneLogin_Saml2_Authn_Request(settings)
+        authn_request_xml = authn_request.get_xml()
+
+        authn_request_encoded = authn_request.get_request()
+        self.assertEqual(authn_request_encoded, OneLogin_Saml2_Utils.deflate_and_base64_encode(authn_request_xml))
+
+        saml_settings['deflate'] = False
+        settings = OneLogin_Saml2_Settings(saml_settings)
+
+        authn_request = OneLogin_Saml2_Authn_Request(settings)
+        authn_request_xml = authn_request.get_xml()
+
+        authn_request_encoded = authn_request.get_request()
+        self.assertEqual(authn_request_encoded, OneLogin_Saml2_Utils.b64encode(authn_request_xml))

tests/src/OneLogin/saml2_tests/idp_metadata_parser_test.py

@@ -513,6 +513,7 @@ def test_merge_settings(self):
             "signMetadata": false
           },
           "debug": false,
+          "deflate": true,
           "organization": {
             "en-US": {
               "displayname": "SP test",
@@ -532,6 +533,7 @@ def test_merge_settings(self):
         expected_settings2_json = """
         {
           "debug": false,
+          "deflate": true,
           "idp": {
             "singleLogoutService": {
               "url": "http://idp.example.com/SingleLogoutService.php"
@@ -589,6 +591,7 @@ def test_merge_settings(self):
         expected_settings3_json = """
         {
           "debug": false,
+          "deflate": true,
           "strict": false,
           "custom_base_path": "../../../tests/data/customPath/",
           "sp": {