NCEndToEndMetadataV20.swift 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486
  1. //
  2. // NCEndToEndMetadataV20.swift
  3. // Nextcloud
  4. //
  5. // Created by Marino Faggiana on 09/08/23.
  6. // Copyright © 2023 Marino Faggiana. All rights reserved.
  7. //
  8. // Author Marino Faggiana <marino.faggiana@nextcloud.com>
  9. //
  10. // This program is free software: you can redistribute it and/or modify
  11. // it under the terms of the GNU General Public License as published by
  12. // the Free Software Foundation, either version 3 of the License, or
  13. // (at your option) any later version.
  14. //
  15. // This program is distributed in the hope that it will be useful,
  16. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. // GNU General Public License for more details.
  19. //
  20. // You should have received a copy of the GNU General Public License
  21. // along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. //
  23. import Foundation
  24. import NextcloudKit
  25. import Gzip
  26. extension NCEndToEndMetadata {
  27. struct E2eeV20: Codable {
  28. struct Metadata: Codable {
  29. let ciphertext: String
  30. let nonce: String
  31. let authenticationTag: String
  32. struct ciphertext: Codable {
  33. let counter: Int
  34. let deleted: Bool?
  35. let keyChecksums: [String]?
  36. let files: [String: Files]?
  37. let folders: [String: String]?
  38. struct Files: Codable {
  39. let authenticationTag: String
  40. let filename: String
  41. let key: String
  42. let mimetype: String
  43. let nonce: String
  44. }
  45. }
  46. }
  47. struct Users: Codable {
  48. let userId: String
  49. let certificate: String
  50. let encryptedMetadataKey: String?
  51. }
  52. struct Filedrop: Codable {
  53. let ciphertext: String
  54. let nonce: String
  55. let authenticationTag: String
  56. let users: [UsersFiledrop]
  57. struct UsersFiledrop: Codable {
  58. let userId: String
  59. let encryptedFiledropKey: String
  60. }
  61. }
  62. let metadata: Metadata
  63. let users: [Users]?
  64. let filedrop: [String: Filedrop]?
  65. let version: String
  66. }
  67. struct E2eeV20Signature: Codable {
  68. struct Metadata: Codable {
  69. let ciphertext: String
  70. let nonce: String
  71. let authenticationTag: String
  72. }
  73. struct Users: Codable {
  74. let userId: String
  75. let certificate: String
  76. let encryptedMetadataKey: String?
  77. }
  78. let metadata: Metadata
  79. let users: [Users]?
  80. let version: String
  81. }
  82. // --------------------------------------------------------------------------------------------
  83. // MARK: Ecode JSON Metadata V2.0
  84. // --------------------------------------------------------------------------------------------
  85. func encodeMetadataV20(account: String, serverUrl: String, ocIdServerUrl: String, userId: String, addUserId: String?, addCertificate: String?, removeUserId: String?) -> (metadata: String?, signature: String?, counter: Int, error: NKError) {
  86. guard let directoryTop = utilityFileSystem.getDirectoryE2EETop(serverUrl: serverUrl, account: account), let certificate = NCKeychain().getEndToEndCertificate(account: account) else {
  87. return (nil, nil, 0, NKError(errorCode: NCGlobal.shared.errorUnexpectedResponseFromDB, errorDescription: "_e2e_error_"))
  88. }
  89. let isDirectoryTop = utilityFileSystem.isDirectoryE2EETop(account: account, serverUrl: serverUrl)
  90. var metadataKey: String?
  91. var keyChecksums: [String] = []
  92. var usersCodable: [E2eeV20.Users] = []
  93. var filesCodable: [String: E2eeV20.Metadata.ciphertext.Files] = [:]
  94. var folders: [String: String] = [:]
  95. var counter: Int = 1
  96. func addUser(userId: String?, certificate: String?, key: Data) {
  97. guard let userId, let certificate else { return }
  98. if let metadataKeyEncrypted = NCEndToEndEncryption.sharedManager().encryptAsymmetricData(key, certificate: certificate) {
  99. let encryptedMetadataKey = metadataKeyEncrypted.base64EncodedString()
  100. NCManageDatabase.shared.addE2EUsers(account: account, serverUrl: serverUrl, ocIdServerUrl: ocIdServerUrl, userId: userId, certificate: certificate, encryptedMetadataKey: encryptedMetadataKey, metadataKey: key)
  101. }
  102. }
  103. if isDirectoryTop {
  104. guard var key = NCEndToEndEncryption.sharedManager()?.generateKey() as? Data else {
  105. return (nil, nil, 0, NKError(errorCode: NCGlobal.shared.errorUnexpectedResponseFromDB, errorDescription: "_e2e_error_"))
  106. }
  107. if let tableUserId = NCManageDatabase.shared.getE2EUser(account: account, ocIdServerUrl: directoryTop.ocId, userId: userId),
  108. let metadataKey = tableUserId.metadataKey {
  109. key = metadataKey
  110. } else {
  111. addUser(userId: userId, certificate: certificate, key: key)
  112. }
  113. // ADDUSERID
  114. if let addUserId {
  115. addUser(userId: addUserId, certificate: addCertificate, key: key)
  116. }
  117. // REMOVEUSERID
  118. if let removeUserId {
  119. NCManageDatabase.shared.deleteE2EUsers(account: account, ocIdServerUrl: ocIdServerUrl, userId: removeUserId)
  120. }
  121. // FOR SECURITY recreate all users with key
  122. if let users = NCManageDatabase.shared.getE2EUsers(account: account, ocIdServerUrl: ocIdServerUrl) {
  123. for user in users {
  124. addUser(userId: user.userId, certificate: user.certificate, key: key)
  125. }
  126. }
  127. metadataKey = key.base64EncodedString()
  128. } else {
  129. guard let tableUserId = NCManageDatabase.shared.getE2EUser(account: account, ocIdServerUrl: directoryTop.ocId, userId: userId), let key = tableUserId.metadataKey else {
  130. return (nil, nil, 0, NKError(errorCode: NCGlobal.shared.errorUnexpectedResponseFromDB, errorDescription: "_e2e_error_"))
  131. }
  132. metadataKey = key.base64EncodedString()
  133. }
  134. // USERS
  135. // CHECKSUM
  136. //
  137. if let users = NCManageDatabase.shared.getE2EUsers(account: account, ocIdServerUrl: directoryTop.ocId) {
  138. for user in users {
  139. if isDirectoryTop {
  140. usersCodable.append(E2eeV20.Users(userId: user.userId, certificate: user.certificate, encryptedMetadataKey: user.encryptedMetadataKey))
  141. }
  142. if let hash = NCEndToEndEncryption.sharedManager().createSHA256(user.metadataKey) {
  143. keyChecksums.append(hash)
  144. }
  145. }
  146. }
  147. // COUNTER + 1
  148. //
  149. if let resultCounter = NCManageDatabase.shared.getCounterE2eMetadata(account: account, ocIdServerUrl: ocIdServerUrl) {
  150. counter = resultCounter + 1
  151. }
  152. // CIPERTEXT
  153. //
  154. let e2eEncryptions = NCManageDatabase.shared.getE2eEncryptions(predicate: NSPredicate(format: "account == %@ AND serverUrl == %@", account, serverUrl))
  155. for e2eEncryption in e2eEncryptions {
  156. if e2eEncryption.mimeType == "httpd/unix-directory" {
  157. folders[e2eEncryption.fileNameIdentifier] = e2eEncryption.fileName
  158. } else {
  159. let file = E2eeV20.Metadata.ciphertext.Files(authenticationTag: e2eEncryption.authenticationTag, filename: e2eEncryption.fileName, key: e2eEncryption.key, mimetype: e2eEncryption.mimeType, nonce: e2eEncryption.initializationVector)
  160. filesCodable.updateValue(file, forKey: e2eEncryption.fileNameIdentifier)
  161. }
  162. }
  163. do {
  164. var authenticationTag: NSString?
  165. var initializationVector: NSString?
  166. let json = try JSONEncoder().encode(E2eeV20.Metadata.ciphertext(counter: counter, deleted: false, keyChecksums: keyChecksums, files: filesCodable, folders: folders))
  167. let jsonZip = try json.gzipped()
  168. let ciphertextMetadata = NCEndToEndEncryption.sharedManager().encryptPayloadFile(jsonZip, key: metadataKey, initializationVector: &initializationVector, authenticationTag: &authenticationTag)
  169. guard var ciphertextMetadata, let initializationVector = initializationVector as? String, let authenticationTag = authenticationTag as? String else {
  170. return (nil, nil, counter, NKError(errorCode: NCGlobal.shared.errorE2EEEncryptPayloadFile, errorDescription: "_e2e_error_"))
  171. }
  172. // Add initializationVector [ANDROID]
  173. ciphertextMetadata = ciphertextMetadata + "|" + initializationVector
  174. let metadataCodable = E2eeV20.Metadata(ciphertext: ciphertextMetadata, nonce: initializationVector, authenticationTag: authenticationTag)
  175. let e2eeCodable = E2eeV20(metadata: metadataCodable, users: usersCodable, filedrop: nil, version: NCGlobal.shared.e2eeVersionV20)
  176. let e2eeData = try JSONEncoder().encode(e2eeCodable)
  177. e2eeData.printJson()
  178. let e2eeJson = String(data: e2eeData, encoding: .utf8)
  179. let signature = createSignature(account: account, userId: userId, metadata: metadataCodable, users: usersCodable, version: NCGlobal.shared.e2eeVersionV20, certificate: certificate)
  180. return (e2eeJson, signature, counter, NKError())
  181. } catch let error {
  182. return (nil, nil, counter, NKError(errorCode: NCGlobal.shared.errorE2EEJSon, errorDescription: error.localizedDescription))
  183. }
  184. }
  185. // --------------------------------------------------------------------------------------------
  186. // MARK: Decode JSON Metadata V2.0
  187. // --------------------------------------------------------------------------------------------
  188. func decodeMetadataV20(_ json: String, signature: String?, serverUrl: String, account: String, ocIdServerUrl: String, urlBase: String, userId: String) -> NKError {
  189. guard let data = json.data(using: .utf8),
  190. let directoryTop = utilityFileSystem.getDirectoryE2EETop(serverUrl: serverUrl, account: account) else {
  191. return NKError(errorCode: NCGlobal.shared.errorE2EEKeyDecodeMetadata, errorDescription: "_e2e_error_")
  192. }
  193. let isDirectoryTop = utilityFileSystem.isDirectoryE2EETop(account: account, serverUrl: serverUrl)
  194. func addE2eEncryption(fileNameIdentifier: String, filename: String, authenticationTag: String, key: String, initializationVector: String, metadataKey: String, mimetype: String) {
  195. if let metadata = NCManageDatabase.shared.getMetadata(predicate: NSPredicate(format: "account == %@ AND fileName == %@", account, fileNameIdentifier)) {
  196. let object = tableE2eEncryption.init(account: account, ocIdServerUrl: ocIdServerUrl, fileNameIdentifier: fileNameIdentifier)
  197. object.authenticationTag = authenticationTag
  198. object.fileName = filename
  199. object.key = key
  200. object.initializationVector = initializationVector
  201. object.metadataKey = metadataKey
  202. object.mimeType = mimetype
  203. object.serverUrl = serverUrl
  204. object.version = NCGlobal.shared.e2eeVersionV20
  205. // Write file parameter for decrypted on DB
  206. NCManageDatabase.shared.addE2eEncryption(object)
  207. // Update metadata on tableMetadata
  208. metadata.fileNameView = filename
  209. let results = NextcloudKit.shared.nkCommonInstance.getInternalType(fileName: filename, mimeType: metadata.contentType, directory: metadata.directory)
  210. metadata.contentType = results.mimeType
  211. metadata.iconName = results.iconName
  212. metadata.classFile = results.classFile
  213. NCManageDatabase.shared.addMetadata(metadata)
  214. }
  215. }
  216. do {
  217. let json = try JSONDecoder().decode(E2eeV20.self, from: data)
  218. let metadata = json.metadata
  219. let users = json.users
  220. let filesdrop = json.filedrop
  221. let version = json.version as String? ?? NCGlobal.shared.e2eeVersionV20
  222. if isDirectoryTop {
  223. // SAVE IN DB ALL USER
  224. //
  225. if let users {
  226. for user in users {
  227. var metadataKey: Data?
  228. if let encryptedMetadataKey = user.encryptedMetadataKey {
  229. let data = Data(base64Encoded: encryptedMetadataKey)
  230. if let decrypted = NCEndToEndEncryption.sharedManager().decryptAsymmetricData(data, privateKey: NCKeychain().getEndToEndPrivateKey(account: account)) {
  231. metadataKey = decrypted
  232. }
  233. }
  234. NCManageDatabase.shared.addE2EUsers(account: account, serverUrl: serverUrl, ocIdServerUrl: ocIdServerUrl, userId: user.userId, certificate: user.certificate, encryptedMetadataKey: user.encryptedMetadataKey, metadataKey: metadataKey)
  235. }
  236. }
  237. }
  238. // GET metadataKey, decryptedMetadataKey
  239. //
  240. guard let tableUser = NCManageDatabase.shared.getE2EUser(account: account, ocIdServerUrl: directoryTop.ocId, userId: userId),
  241. let metadataKey = tableUser.metadataKey?.base64EncodedString(),
  242. let decryptedMetadataKey = tableUser.metadataKey else {
  243. return NKError(errorCode: NCGlobal.shared.errorE2EENoUserFound, errorDescription: "_e2e_error_")
  244. }
  245. // SIGNATURE CHECK
  246. //
  247. if let signature {
  248. if !verifySignature(account: account, signature: signature, userId: tableUser.userId, metadata: metadata, users: users, version: version, certificate: tableUser.certificate) {
  249. return NKError(errorCode: NCGlobal.shared.errorE2EEKeyVerifySignature, errorDescription: "_e2e_error_")
  250. }
  251. }
  252. // FILEDROP
  253. //
  254. if let filesdrop {
  255. for filedop in filesdrop {
  256. let fileNameIdentifier = filedop.key
  257. let ciphertext = filedop.value.ciphertext
  258. let nonce = filedop.value.nonce
  259. let authenticationTag = filedop.value.authenticationTag
  260. for user in filedop.value.users where user.userId == userId {
  261. let data = Data(base64Encoded: user.encryptedFiledropKey)
  262. if let decryptedFiledropKey = NCEndToEndEncryption.sharedManager().decryptAsymmetricData(data, privateKey: NCKeychain().getEndToEndPrivateKey(account: account)) {
  263. let filedropKey = decryptedFiledropKey.base64EncodedString()
  264. guard let decryptedFiledrop = NCEndToEndEncryption.sharedManager().decryptPayloadFile(ciphertext, key: filedropKey, initializationVector: nonce, authenticationTag: authenticationTag),
  265. decryptedFiledrop.isGzipped else {
  266. return NKError(errorCode: NCGlobal.shared.errorE2EEKeyFiledropCiphertext, errorDescription: "_e2e_error_")
  267. }
  268. let data = try decryptedFiledrop.gunzipped()
  269. if let jsonText = String(data: data, encoding: .utf8) { print(jsonText) }
  270. let file = try JSONDecoder().decode(E2eeV20.Metadata.ciphertext.Files.self, from: data)
  271. print(file)
  272. addE2eEncryption(fileNameIdentifier: fileNameIdentifier, filename: file.filename, authenticationTag: file.authenticationTag, key: file.key, initializationVector: file.nonce, metadataKey: filedropKey, mimetype: file.mimetype)
  273. }
  274. }
  275. }
  276. }
  277. // CIPHERTEXT METADATA
  278. //
  279. guard let decryptedMetadata = NCEndToEndEncryption.sharedManager().decryptPayloadFile(metadata.ciphertext, key: metadataKey, initializationVector: metadata.nonce, authenticationTag: metadata.authenticationTag),
  280. decryptedMetadata.isGzipped else {
  281. return NKError(errorCode: NCGlobal.shared.errorE2EEKeyCiphertext, errorDescription: "_e2e_error_")
  282. }
  283. let data = try decryptedMetadata.gunzipped()
  284. if let jsonText = String(data: data, encoding: .utf8) { print(jsonText) }
  285. let jsonCiphertextMetadata = try JSONDecoder().decode(E2eeV20.Metadata.ciphertext.self, from: data)
  286. // CHECKSUM CHECK
  287. //
  288. if let keyChecksums = jsonCiphertextMetadata.keyChecksums {
  289. guard let hash = NCEndToEndEncryption.sharedManager().createSHA256(decryptedMetadataKey),
  290. keyChecksums.contains(hash) else {
  291. return NKError(errorCode: NCGlobal.shared.errorE2EEKeyChecksums, errorDescription: NSLocalizedString("_e2e_error_", comment: ""))
  292. }
  293. }
  294. print("\n\nCOUNTER -------------------------------")
  295. print("Counter: \(jsonCiphertextMetadata.counter)")
  296. // COUNTER CHECK
  297. //
  298. if let resultCounter = NCManageDatabase.shared.getCounterE2eMetadata(account: account, ocIdServerUrl: ocIdServerUrl) {
  299. print("Counter saved: \(resultCounter)")
  300. if jsonCiphertextMetadata.counter < resultCounter {
  301. // TODO: whats happen with < ?
  302. NCContentPresenter().showError(error: NKError(errorCode: NCGlobal.shared.errorE2EECounter, errorDescription: NSLocalizedString("_e2e_error_", comment: "")))
  303. } else if jsonCiphertextMetadata.counter > resultCounter {
  304. print("Counter UPDATED: \(jsonCiphertextMetadata.counter)")
  305. NCManageDatabase.shared.updateCounterE2eMetadata(account: account, ocIdServerUrl: ocIdServerUrl, counter: jsonCiphertextMetadata.counter)
  306. }
  307. } else {
  308. print("Counter RESET: \(jsonCiphertextMetadata.counter)")
  309. NCManageDatabase.shared.updateCounterE2eMetadata(account: account, ocIdServerUrl: ocIdServerUrl, counter: jsonCiphertextMetadata.counter)
  310. }
  311. // DELETE CHECK
  312. //
  313. if let deleted = jsonCiphertextMetadata.deleted, deleted {
  314. // TODO: We need to check deleted, id yes ???
  315. }
  316. NCManageDatabase.shared.addE2eMetadata(account: account,
  317. serverUrl: serverUrl,
  318. ocIdServerUrl: ocIdServerUrl,
  319. keyChecksums: jsonCiphertextMetadata.keyChecksums,
  320. deleted: jsonCiphertextMetadata.deleted ?? false,
  321. folders: jsonCiphertextMetadata.folders,
  322. version: version)
  323. if let files = jsonCiphertextMetadata.files {
  324. print("\nFILES ---------------------------------\n")
  325. for file in files {
  326. addE2eEncryption(fileNameIdentifier: file.key, filename: file.value.filename, authenticationTag: file.value.authenticationTag, key: file.value.key, initializationVector: file.value.nonce, metadataKey: metadataKey, mimetype: file.value.mimetype)
  327. print("filename: \(file.value.filename)")
  328. print("fileNameIdentifier: \(file.key)")
  329. print("mimetype: \(file.value.mimetype)")
  330. print("\n")
  331. }
  332. }
  333. if let folders = jsonCiphertextMetadata.folders {
  334. print("FOLDERS--------------------------------\n")
  335. for folder in folders {
  336. addE2eEncryption(fileNameIdentifier: folder.key, filename: folder.value, authenticationTag: metadata.authenticationTag, key: metadataKey, initializationVector: metadata.nonce, metadataKey: metadataKey, mimetype: "httpd/unix-directory")
  337. print("filename: \(folder.value)")
  338. print("fileNameIdentifier: \(folder.key)")
  339. print("\n")
  340. }
  341. }
  342. print("---------------------------------------\n\n")
  343. } catch let error {
  344. return NKError(errorCode: NCGlobal.shared.errorE2EEJSon, errorDescription: error.localizedDescription)
  345. }
  346. return NKError()
  347. }
  348. // MARK: -
  349. func createSignature(account: String, userId: String, metadata: E2eeV20.Metadata, users: [E2eeV20.Users]?, version: String, certificate: String) -> String? {
  350. guard let users else { return nil }
  351. var usersSignatureCodable: [E2eeV20Signature.Users] = []
  352. for user in users {
  353. usersSignatureCodable.append(E2eeV20Signature.Users(userId: user.userId, certificate: user.certificate, encryptedMetadataKey: user.encryptedMetadataKey))
  354. }
  355. let signatureCodable = E2eeV20Signature(metadata: E2eeV20Signature.Metadata(ciphertext: metadata.ciphertext, nonce: metadata.nonce, authenticationTag: metadata.authenticationTag), users: usersSignatureCodable, version: version)
  356. do {
  357. let jsonEncoder = JSONEncoder()
  358. let json = try jsonEncoder.encode(signatureCodable)
  359. let dataSerialization = try JSONSerialization.jsonObject(with: json, options: [])
  360. let decoded = try? JSONSerialization.data(withJSONObject: dataSerialization, options: [.sortedKeys, .withoutEscapingSlashes])
  361. let base64 = decoded!.base64EncodedString()
  362. if let base64Data = base64.data(using: .utf8),
  363. let signatureData = NCEndToEndEncryption.sharedManager().generateSignatureCMS(base64Data, certificate: certificate, privateKey: NCKeychain().getEndToEndPrivateKey(account: account), userId: userId) {
  364. return signatureData.base64EncodedString()
  365. }
  366. } catch {
  367. print("Error: \(error.localizedDescription)")
  368. }
  369. return nil
  370. }
  371. func verifySignature(account: String, signature: String, userId: String, metadata: E2eeV20.Metadata, users: [E2eeV20.Users]?, version: String, certificate: String) -> Bool {
  372. var signatureCodable: E2eeV20Signature?
  373. var certificates: [String] = []
  374. if let users {
  375. var usersSignatureCodable: [E2eeV20Signature.Users] = []
  376. for user in users {
  377. usersSignatureCodable.append(E2eeV20Signature.Users(userId: user.userId, certificate: user.certificate, encryptedMetadataKey: user.encryptedMetadataKey))
  378. }
  379. signatureCodable = E2eeV20Signature(metadata: E2eeV20Signature.Metadata(ciphertext: metadata.ciphertext, nonce: metadata.nonce, authenticationTag: metadata.authenticationTag), users: usersSignatureCodable, version: version)
  380. certificates = users.map { $0.certificate }
  381. } else {
  382. signatureCodable = E2eeV20Signature(metadata: E2eeV20Signature.Metadata(ciphertext: metadata.ciphertext, nonce: metadata.nonce, authenticationTag: metadata.authenticationTag), users: nil, version: version)
  383. certificates = [certificate]
  384. }
  385. do {
  386. let jsonEncoder = JSONEncoder()
  387. let json = try jsonEncoder.encode(signatureCodable)
  388. let dataSerialization = try JSONSerialization.jsonObject(with: json, options: [])
  389. if var dataSerialization = dataSerialization as? [String: Any?] {
  390. dataSerialization = dataSerialization.compactMapValues { $0 }
  391. let decodedSignatureCodable = try JSONSerialization.data(withJSONObject: dataSerialization, options: [.sortedKeys, .withoutEscapingSlashes])
  392. let base64 = decodedSignatureCodable.base64EncodedString()
  393. if let data = base64.data(using: .utf8), let signatureData = Data(base64Encoded: signature) {
  394. return NCEndToEndEncryption.sharedManager().verifySignatureCMS(signatureData, data: data, certificates: certificates)
  395. }
  396. }
  397. } catch {
  398. print("Error: \(error.localizedDescription)")
  399. }
  400. return false
  401. }
  402. }