safe-t-rest 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f925155d48c7167c173bcc5cfd8a4101d44ef9b7
-  data.tar.gz: 96fd9cc27ede58452d6e9e0b12d5abc2b9bbbdbf
+  metadata.gz: 1c5b84f69704cc3219c72edf56c1ba6414f4c16f
+  data.tar.gz: 4fd84f0b0e8a60ab0053d49df5392e5a47956d22
 SHA512:
-  metadata.gz: b55cb69e6378200c7b011baa54d9e6dfc6c639b9878e42c1ac7d21aedc4ce4bc425058ec4a31a66d3aff477bccdad000be2e107a162bdf5826fccad7a96de30e
-  data.tar.gz: 3b1168f81e5866fb21f1814fc528930a18bc323cac7d6bd3710b7ed6e0547697d31fe7abd2612f8a40324de2d79d6031c283ace3b79778be5c7078e10a419268
+  metadata.gz: 57b92c93fdb650e2ec8202a9b09fcb8eebb2f7461ab8af643628f6ae091dfe71f1ec868c6b4dc0f7f01c3fddcfb58b8178059d3d89b4a5b48f7ea320688ec7dc
+  data.tar.gz: 31ab84f5028d852037e9606c5e60dd38f031eeebd4c0b8b12159d46a9a1e0c13bbfb7a558b50940e65bb822ceb966be40ad21091e5f898a50d83c3a4ac806654

data/README.md

@@ -87,8 +87,141 @@ file = client.file_download(args) # Get back the file as a base64 string
 file = Base64.decode64(file) # decode the string
 File.write('file.txt', file) # write decoded file
 ```
+* New API  
+# RegisterSession - return json flow
+
+## Overview  
+
+```
+StatusCode=OK&StatusData=Base64Json
+```  
+Base64Json:
+```json
+{
+	"flow": [
+	"username_password",
+	"sms"
+         ]
+        "token": [
+        "3434",
+        "7676"
+      ]
+}
+if there is no token element, SDA need to generate token.
+```
+
+## Scenarios  
+ 
+### Scenario 1   
+
+- Login to portal: (https://securemft/Safe-T/login.aspx)  
+ - SDA will send a rest call with URL and add sType :     
+    `https://securemft/Safe-T/login.aspx&sType=login`
+    ```json
+      {"RoleID": "00006", "ExtensionID": "226602f2-4960-4542-a489-8250a551b804", "Username":"", "Password":"", "Method": "RegisterSession","Arguments": ["https://securemft/Safe-T/login.aspx&sType=login"]}
+    ```  
+
+  - Return value:  
+    `StatusCode=OK&StatusData=`  
+    ```json
+    {
+      "flow": [
+        "username_password",
+        "sms"
+      ]
+    }
+    ```  
+- Handle return value    
+    - on submit , call iVerifyUserAccount add the submitted user name and password in base64 arguments:   
+      first step : username_password -  call iVerifyUserAccount (no need to call mobile - all against the same SDE Authentication app):
+
+```json
+{
+  "RoleID": "00006",
+   "ExtensionID": "226602f2-4960-4542-a489-8250a551b804",
+   "Username":"",
+   "Password":"",
+   "Method": "iVerifyUserAccount",
+   "Arguments": ["base64username","base64pass",true]
+}
+```  
+	  Return value:  
+         OK:Q2xpZW50TW93NyI=
+         base64 string is  "05977777777"
+        
+    - If its ok + number :   
+       go to second step 
+       else handle retries and captcha  
+    - if there is no number ? we need to ask alex\eithan.  
+      
+    - second step : sms - send sms to the ClientMobileNumber and validate it  
+       else handle retries and captcha
+
+### Scenario 2  
+Any other case : https://securemft/Safe-T/login.aspx?folderType=x&(query_string_params) (packages related url's ,safe reply,package view, registration)
+
+1.	SDA will call RegisterSession with URL param: 
+
+```json
+{
+  "RoleID": "00006",
+   "ExtensionID": "226602f2-4960-4542-a489-8250a551b804",
+   "Username":"",
+   "Password":"",
+   "Method": "iVerifyUserAccount",
+   "Arguments": ["base64username","base64pass",true]
+}
+``` 
+
+Return value:
+
+in case of registers users:
+`StatusCode=OK&StatusData=`
+```json
+    {
+      "flow": [
+        "username_password",
+        "sms"
+      ]
+      "token": [
+        "3434",
+        "7676"
+      ]
+    }
+```
+
+2. Handle return : 
+```ruby
+	if flow is :
+	"username_password",
+        "sms"
+```  
+- Handle return value    
+    - on submit , call iVerifyUserAccount add the submitted user name and password in base64 arguments:   
+      first step : username_password -  call iVerifyUserAccount (no need to call mobile - all against the same SDE Authentication app):
+	```json
+{
+  "RoleID": "00006",
+   "ExtensionID": "226602f2-4960-4542-a489-8250a551b804",
+   "Username":"",
+   "Password":"",
+   "Method": "iVerifyUserAccount",
+   "Arguments": ["base64username","base64pass",true]
+}
+
+ Return value:  
+        OK:Q2xpZW50TW93NyI=
+        base64 string is  "05977777777"
+
+    - If its ok + number :   
+       go to second step 
+       else handle retries and captcha  
+    - if there is no number ? we need to ask alex\eithan.  
+
+    - second step : sms - send sms to the ClientMobileNumber and validate it  
+       else handle retries and captcha
 
 # RubyDoc
 http://www.rubydoc.info/github/bararchy/safe-t-rest/SafeTRest
 
-* Added example client under /bin
+* Added example client under /bin

data/lib/safe-t-rest.rb

@@ -1,72 +1,127 @@
 require 'rest-client'
+require 'base64'
+require 'json'
 
 class SafeTRest
-  attr_accessor :extension_id, :user_name, :password, :url, :role_id
 
   def initialize(config_hash={})
     @extension_id = config_hash[:extension_id]
-    @user_name = config_hash[:user_name]
-    @password = config_hash[:password]
-    @url = config_hash[:url]
-    @role_id = config_hash[:role_id]
+    @user_name    = Base64.strict_encode64(config_hash[:user_name])
+    @password     = Base64.strict_encode64(config_hash[:password])
+    @url          = config_hash[:url]
+    @role_id      = config_hash[:role_id]
   end
 
   def get_apps_process_state(guid)
-    send_request("GetAppsProcessState: ['#{guid}', false]}")
+    send_request("GetAppsProcessState", [guid, false])
   end
 
   def get_package_file_list(guid)
-    send_request("GetPackageFileList: ['#{guid}']}")
+    send_request("GetPackageFileList",[guid])
   end
 
   def verify_user_account
-    send_request("iVerifyUserAccount: ['#{@user_name}', '#{@password}', true]")
+    response = send_request("iVerifyUserAccount",[@user_name, @password, true])
+    status, message = response.split(':')
+    case status.downcase
+    when 'ok'
+      return Base64.decode64(message)
+    when 'error'
+      raise SafeTError.new(Base64.decode64(message))
+    else
+      raise SafeTError.new("Non-Standard status #{status}:#{Base64.decode64(message)}")
+    end
   end
 
   def get_user_history(days)
-    send_request("iGetHistory: ['#{@user_name}', '#{@password}', #{days}]")
+    send_request("iGetHistory", [@user_name, @password, days])
   end
 
   def user_account_address_list
-    send_request("iUserAccountAddressList: ['#{@user_name}', '#{@password}']")
+    send_request("iUserAccountAddressList",[@user_name, @password])
   end
 
   def get_folder_list(path)
-    send_request("iGetFolderList: ['#{@user_name}', '#{@password}', false, true, '#{path}', 417]")
+    send_request("iGetFolderList",[@user_name, @password, false, true, path, 417])
   end
 
   def safe_share_file(args)
-    send_request("iSafeShareFile: ['#{@user_name}', '#{@password}', '#{args[:files]}', '#{args[:recipients]}', '#{args[:sender_name]}', '#{args[:sender_address]}', '#{args[:subject]}', '#{args[:message]}', #{args[:message_encryption_level]}, #{args[:delivery_method]}, '#{args[:mobile_recipient]}', #{args[:return_receipt]}, #{args[:safe_reply]}, #{args[:max_downloads]}, #{args[:package_expiry]}, '#{args[:folder_path]}', #{args[:root_folder_id]}]")
+    send_request("iSafeShareFile:",[
+        @user_name,
+        @password,
+        args[:files],
+        args[:recipients],
+        args[:sender_name],
+        args[:sender_address],
+        args[:subject],
+        args[:message],
+        args[:message_encryption_level],
+        args[:delivery_method],
+        args[:mobile_recipient],
+        args[:return_receipt],
+        args[:safe_reply],
+        args[:max_downloads],
+        args[:package_expiry],
+        args[:folder_path],
+        args[:root_folder_id]
+    ])
   end
 
   def file_upload(args)
-    send_request("iFileUpload: ['#{@user_name}', '#{@password}', '#{args[:file_base64]}', '#{args[:file_name]}', '#{args[:folder_path]}', #{args[:root_folder_id]}]")
+    send_request("iFileUpload",[
+        @user_name,
+        @password,
+        args[:file_base64],
+        args[:file_name],
+        args[:folder_path],
+        args[:root_folder_id]
+    ])
   end
 
   def file_download(args)
-    send_request("iFileDownload: ['#{@user_name}', '#{@password}', '#{args[:file_name]}', '#{args[:folder_path]}', #{args[:root_folder_id]}]")
+    send_request("iFileDownload",[
+        @user_name,
+        @password,
+        args[:file_name],
+        args[:folder_path],
+        args[:root_folder_id]
+    ])
   end
 
   def register_session(url_string)
-    send_request("\'RegisterSession\': [\'#{url_string}\']")
-  end
-
-  def verify_session(post_parameters)
-    send_request("\'VerifySession\': [\'#{post_parameters}\']")
+    response = send_request("RegisterSession",[url_string])
+    status, message = response.split(':')
+    case status.downcase
+      when 'ok'
+        return JSON.parse(Base64.decode64(message), symbolize_names: true)
+      when 'error'
+        raise SafeTError.new(Base64.decode64(message))
+      else
+        raise SafeTError.new("Non-Standard status #{status}:#{Base64.decode64(message)}")
+    end
   end
 
   private
 
-  def send_request(request_string)
+  def send_request(method, parameters)
     RestClient::Request.execute(
       :verify_ssl => false,
       method: :post,
       url: @url,
       headers: {
         servletRequestID: 'MethodRequest',
-        BusinessLogic: "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extension_id}', #{request_string}}"
-      }
+      },
+      payload: {
+          "Username": "",
+          "Password": "",
+          "RoleID": "#{@role_id}",
+          "ExtensionID": "#{@extension_id}",
+          "Method": "#{method}",
+          "Arguments": parameters
+        }.to_json
     )
   end
 end
 
+class SafeTError < Exception; end
+

data/safe-t-rest.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'safe-t-rest'
-  s.version     = '0.1.3'
+  s.version     = '0.1.4'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.summary     = 'A ruby gem to interact with Safe-T Box.'
   s.description = 'Ruby gem to interact with Safe-T Box rest API. '

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe-t-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Bar Hofesh