added email hashing;

raw email shouldn't be sent to server

Author: mbi88

UserReport/UserReport/Helpers/HashingHelper.swift

@@ -0,0 +1,83 @@
+//
+//  HashingHelper.swift
+//  UserReportSDK
+//
+//  Created by Maksym Binkovskyi on 27.02.2020.
+//  Copyright © 2020 UserReport. All rights reserved.
+//
+import Foundation
+import CommonCrypto
+
+// Defines types of hash string outputs available
+public enum HashOutputType {
+    // standard hex string output
+    case hex
+    // base 64 encoded string output
+    case base64
+}
+
+// Defines types of hash algorithms available
+public enum HashType {
+    case md5
+    case sha1
+    case sha256
+    
+    var length: Int32 {
+        switch self {
+        case .md5: return CC_MD5_DIGEST_LENGTH
+        case .sha1: return CC_SHA1_DIGEST_LENGTH
+        case .sha256: return CC_SHA256_DIGEST_LENGTH
+        }
+    }
+}
+
+internal extension String {
+
+    /// Hashing algorithm for hashing a string instance.
+    ///
+    /// - Parameters:
+    ///   - type: The type of hash to use.
+    ///   - output: The type of output desired, defaults to .hex.
+    /// - Returns: The requested hash output or nil if failure.
+    func hashed(_ type: HashType, output: HashOutputType = .hex) -> String? {
+
+        // convert string to utf8 encoded data
+        guard let message = data(using: .utf8) else { return nil }
+        return message.hashed(type, output: output)
+    }
+}
+
+internal extension Data {
+
+    /// Hashing algorithm for hashing a Data instance.
+     ///
+     /// - Parameters:
+     ///   - type: The type of hash to use.
+     ///   - output: The type of hash output desired, defaults to .hex.
+     ///   - Returns: The requested hash output or nil if failure.
+     func hashed(_ type: HashType, output: HashOutputType = .hex) -> String? {
+
+         // setup data variable to hold hashed value
+         var digest = Data(count: Int(type.length))
+
+         _ = digest.withUnsafeMutableBytes{ digestBytes -> UInt8 in
+             self.withUnsafeBytes { messageBytes -> UInt8 in
+                 if let mb = messageBytes.baseAddress, let db = digestBytes.bindMemory(to: UInt8.self).baseAddress {
+                     let length = CC_LONG(self.count)
+                     switch type {
+                     case .md5: CC_MD5(mb, length, db)
+                     case .sha1: CC_SHA1(mb, length, db)
+                     case .sha256: CC_SHA256(mb, length, db)
+                     }
+                 }
+                 return 0
+             }
+         }
+
+         // return the value based on the specified output type.
+         switch output {
+         case .hex: return digest.map { String(format: "%02hhx", $0) }.joined()
+         case .base64: return digest.base64EncodedString()
+         }
+     }
+}

UserReport/UserReport/Models/User.swift

@@ -11,7 +11,18 @@ public class User: NSObject {
     // MARK: - Property
 
     internal var idfa: String
-    @objc public var email: String?
+    private var _email : String?
+    @objc public var email: String? {
+        set {
+            _email = newValue?.lowercased().trimmingCharacters(in: .whitespacesAndNewlines)
+            emailMd5 = _email?.hashed(.md5)
+            emailSha1 = _email?.hashed(.sha1)
+            emailSha256 = _email?.hashed(.sha256)
+        }
+        get {
+            return _email
+        }
+    }
     @objc public var emailMd5: String?
     @objc public var emailSha1: String?
     @objc public var emailSha256: String?
@@ -42,7 +53,6 @@ public class User: NSObject {
      */
     internal func dictObject() -> [String: Any?] {
         return ["idfa": self.idfa,
-                "email": self.email,
                 "emailMd5": self.emailMd5,
                 "emailSha1": self.emailSha1,
                 "emailSha256": self.emailSha256,

UserReport/UserReportSDK.xcodeproj/project.pbxproj

@@ -33,6 +33,7 @@
 		11C71E9A1F6966040081D9B4 /* Session.swift in Sources */ = {isa = PBXBuildFile; fileRef = 11C71E991F6966040081D9B4 /* Session.swift */; };
 		8A4CF05A23D5D2860081C2D8 /* QuarantineRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A4CF05923D5D2860081C2D8 /* QuarantineRequest.swift */; };
 		8A4CF05C23D5D2960081C2D8 /* QuarantineResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A4CF05B23D5D2960081C2D8 /* QuarantineResponse.swift */; };
+		8AE372B32408057700ED3AE0 /* HashingHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8AE372B22408057700ED3AE0 /* HashingHelper.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -76,6 +77,7 @@
 		11C71E991F6966040081D9B4 /* Session.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Session.swift; sourceTree = "<group>"; };
 		8A4CF05923D5D2860081C2D8 /* QuarantineRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = QuarantineRequest.swift; sourceTree = "<group>"; };
 		8A4CF05B23D5D2960081C2D8 /* QuarantineResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = QuarantineResponse.swift; sourceTree = "<group>"; };
+		8AE372B22408057700ED3AE0 /* HashingHelper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HashingHelper.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -123,6 +125,7 @@
 		110746C21F44921900150955 /* UserReport */ = {
 			isa = PBXGroup;
 			children = (
+				8AE372B424080FD500ED3AE0 /* Helpers */,
 				1107473F1F46FD1100150955 /* Logger */,
 				110747441F4AF96A00150955 /* Models */,
 				110747351F46FA6800150955 /* Network */,
@@ -217,6 +220,14 @@
 			path = Session;
 			sourceTree = "<group>";
 		};
+		8AE372B424080FD500ED3AE0 /* Helpers */ = {
+			isa = PBXGroup;
+			children = (
+				8AE372B22408057700ED3AE0 /* HashingHelper.swift */,
+			);
+			path = Helpers;
+			sourceTree = "<group>";
+		};
 /* End PBXGroup section */
 
 /* Begin PBXHeadersBuildPhase section */
@@ -329,6 +340,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				8AE372B32408057700ED3AE0 /* HashingHelper.swift in Sources */,
 				1107473B1F46FA6800150955 /* Result.swift in Sources */,
 				110747411F46FD1900150955 /* Logger.swift in Sources */,
 				110747541F4C766E00150955 /* Invitation.swift in Sources */,