KeychainManager.swift 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. //
  2. // KeychainManager.swift
  3. // Loop
  4. //
  5. // Created by Nate Racklyeft on 6/26/16.
  6. // Copyright © 2016 Nathan Racklyeft. All rights reserved.
  7. //
  8. import Foundation
  9. import Security
  10. public enum KeychainManagerError: Error {
  11. case add(OSStatus)
  12. case copy(OSStatus)
  13. case delete(OSStatus)
  14. case unknownResult
  15. }
  16. /**
  17. Influenced by https://github.com/marketplacer/keychain-swift
  18. */
  19. public struct KeychainManager {
  20. typealias Query = [String: NSObject]
  21. public init() { }
  22. var accessibility: CFString = kSecAttrAccessibleAfterFirstUnlock
  23. var accessGroup: String?
  24. public struct InternetCredentials: Equatable {
  25. public let username: String
  26. public let password: String
  27. public let url: URL
  28. public init(username: String, password: String, url: URL) {
  29. self.username = username
  30. self.password = password
  31. self.url = url
  32. }
  33. }
  34. // MARK: - Convenience methods
  35. private func query(by class: CFString) -> Query {
  36. var query: Query = [kSecClass as String: `class`]
  37. if let accessGroup = accessGroup {
  38. query[kSecAttrAccessGroup as String] = accessGroup as NSObject?
  39. }
  40. return query
  41. }
  42. private func queryForGenericPassword(by service: String) -> Query {
  43. var query = self.query(by: kSecClassGenericPassword)
  44. query[kSecAttrService as String] = service as NSObject?
  45. return query
  46. }
  47. private func queryForInternetPassword(account: String? = nil, url: URL? = nil, label: String? = nil) -> Query {
  48. var query = self.query(by: kSecClassInternetPassword)
  49. if let account = account {
  50. query[kSecAttrAccount as String] = account as NSObject?
  51. }
  52. if let url = url, let components = URLComponents(url: url, resolvingAgainstBaseURL: true) {
  53. for (key, value) in components.keychainAttributes {
  54. query[key] = value
  55. }
  56. }
  57. if let label = label {
  58. query[kSecAttrLabel as String] = label as NSObject?
  59. }
  60. return query
  61. }
  62. private func updatedQuery(_ query: Query, withPassword password: Data) throws -> Query {
  63. var query = query
  64. query[kSecValueData as String] = password as NSObject?
  65. query[kSecAttrAccessible as String] = accessibility
  66. return query
  67. }
  68. private func updatedQuery(_ query: Query, withPassword password: String) throws -> Query {
  69. guard let value = password.data(using: String.Encoding.utf8) else {
  70. throw KeychainManagerError.add(errSecDecode)
  71. }
  72. return try updatedQuery(query, withPassword: value)
  73. }
  74. func delete(_ query: Query) throws {
  75. let statusCode = SecItemDelete(query as CFDictionary)
  76. guard statusCode == errSecSuccess || statusCode == errSecItemNotFound else {
  77. throw KeychainManagerError.delete(statusCode)
  78. }
  79. }
  80. // MARK: – Generic Passwords
  81. public func deleteGenericPassword(forService service: String) throws {
  82. try delete(queryForGenericPassword(by: service))
  83. }
  84. public func replaceGenericPassword(_ password: String?, forService service: String) throws {
  85. var query = queryForGenericPassword(by: service)
  86. try delete(query)
  87. guard let password = password else {
  88. return
  89. }
  90. query = try updatedQuery(query, withPassword: password)
  91. let statusCode = SecItemAdd(query as CFDictionary, nil)
  92. guard statusCode == errSecSuccess else {
  93. throw KeychainManagerError.add(statusCode)
  94. }
  95. }
  96. public func replaceGenericPassword(_ password: Data?, forService service: String) throws {
  97. var query = queryForGenericPassword(by: service)
  98. try delete(query)
  99. guard let password = password else {
  100. return
  101. }
  102. query = try updatedQuery(query, withPassword: password)
  103. let statusCode = SecItemAdd(query as CFDictionary, nil)
  104. guard statusCode == errSecSuccess else {
  105. throw KeychainManagerError.add(statusCode)
  106. }
  107. }
  108. public func getGenericPasswordForServiceAsData(_ service: String) throws -> Data {
  109. var query = queryForGenericPassword(by: service)
  110. query[kSecReturnData as String] = kCFBooleanTrue
  111. query[kSecMatchLimit as String] = kSecMatchLimitOne
  112. var result: AnyObject?
  113. let statusCode = SecItemCopyMatching(query as CFDictionary, &result)
  114. guard statusCode == errSecSuccess else {
  115. throw KeychainManagerError.copy(statusCode)
  116. }
  117. guard let passwordData = result as? Data else {
  118. throw KeychainManagerError.unknownResult
  119. }
  120. return passwordData
  121. }
  122. public func getGenericPasswordForService(_ service: String) throws -> String {
  123. let passwordData = try getGenericPasswordForServiceAsData(service)
  124. guard let password = String(data: passwordData, encoding: String.Encoding.utf8) else {
  125. throw KeychainManagerError.unknownResult
  126. }
  127. return password
  128. }
  129. // MARK – Internet Passwords
  130. public func setInternetPassword(_ password: String, account: String, atURL url: URL, label: String? = nil) throws {
  131. var query = try updatedQuery(queryForInternetPassword(account: account, url: url, label: label), withPassword: password)
  132. query[kSecAttrAccount as String] = account as NSObject?
  133. if let components = URLComponents(url: url, resolvingAgainstBaseURL: true) {
  134. for (key, value) in components.keychainAttributes {
  135. query[key] = value
  136. }
  137. }
  138. if let label = label {
  139. query[kSecAttrLabel as String] = label as NSObject?
  140. }
  141. let statusCode = SecItemAdd(query as CFDictionary, nil)
  142. guard statusCode == errSecSuccess else {
  143. throw KeychainManagerError.add(statusCode)
  144. }
  145. }
  146. public func replaceInternetCredentials(_ credentials: InternetCredentials?, forAccount account: String) throws {
  147. let query = queryForInternetPassword(account: account)
  148. try delete(query)
  149. if let credentials = credentials {
  150. try setInternetPassword(credentials.password, account: credentials.username, atURL: credentials.url)
  151. }
  152. }
  153. public func replaceInternetCredentials(_ credentials: InternetCredentials?, forLabel label: String) throws {
  154. let query = queryForInternetPassword(label: label)
  155. try delete(query)
  156. if let credentials = credentials {
  157. try setInternetPassword(credentials.password, account: credentials.username, atURL: credentials.url, label: label)
  158. }
  159. }
  160. public func replaceInternetCredentials(_ credentials: InternetCredentials?, forURL url: URL) throws {
  161. let query = queryForInternetPassword(url: url)
  162. try delete(query)
  163. if let credentials = credentials {
  164. try setInternetPassword(credentials.password, account: credentials.username, atURL: credentials.url)
  165. }
  166. }
  167. public func getInternetCredentials(account: String? = nil, url: URL? = nil, label: String? = nil) throws -> InternetCredentials {
  168. var query = queryForInternetPassword(account: account, url: url, label: label)
  169. query[kSecReturnData as String] = kCFBooleanTrue
  170. query[kSecReturnAttributes as String] = kCFBooleanTrue
  171. query[kSecMatchLimit as String] = kSecMatchLimitOne
  172. var result: AnyObject?
  173. let statusCode: OSStatus = SecItemCopyMatching(query as CFDictionary, &result)
  174. guard statusCode == errSecSuccess else {
  175. throw KeychainManagerError.copy(statusCode)
  176. }
  177. if let result = result as? [AnyHashable: Any], let passwordData = result[kSecValueData as String] as? Data,
  178. let password = String(data: passwordData, encoding: String.Encoding.utf8),
  179. let url = URLComponents(keychainAttributes: result)?.url,
  180. let username = result[kSecAttrAccount as String] as? String
  181. {
  182. return InternetCredentials(username: username, password: password, url: url)
  183. }
  184. throw KeychainManagerError.unknownResult
  185. }
  186. }
  187. private enum SecurityProtocol {
  188. case http
  189. case https
  190. init?(scheme: String?) {
  191. switch scheme?.lowercased() {
  192. case "http"?:
  193. self = .http
  194. case "https"?:
  195. self = .https
  196. default:
  197. return nil
  198. }
  199. }
  200. init?(secAttrProtocol: CFString) {
  201. if secAttrProtocol == kSecAttrProtocolHTTP {
  202. self = .http
  203. } else if secAttrProtocol == kSecAttrProtocolHTTPS {
  204. self = .https
  205. } else {
  206. return nil
  207. }
  208. }
  209. var scheme: String {
  210. switch self {
  211. case .http:
  212. return "http"
  213. case .https:
  214. return "https"
  215. }
  216. }
  217. var secAttrProtocol: CFString {
  218. switch self {
  219. case .http:
  220. return kSecAttrProtocolHTTP
  221. case .https:
  222. return kSecAttrProtocolHTTPS
  223. }
  224. }
  225. }
  226. private extension URLComponents {
  227. init?(keychainAttributes: [AnyHashable: Any]) {
  228. self.init()
  229. if let secAttProtocol = keychainAttributes[kSecAttrProtocol as String] {
  230. scheme = SecurityProtocol(secAttrProtocol: secAttProtocol as! CFString)?.scheme
  231. }
  232. host = keychainAttributes[kSecAttrServer as String] as? String
  233. if let port = keychainAttributes[kSecAttrPort as String] as? Int, port > 0 {
  234. self.port = port
  235. }
  236. if let path = keychainAttributes[kSecAttrPath as String] as? String {
  237. self.path = path
  238. }
  239. }
  240. var keychainAttributes: [String: NSObject] {
  241. var query: [String: NSObject] = [:]
  242. if let `protocol` = SecurityProtocol(scheme: scheme) {
  243. query[kSecAttrProtocol as String] = `protocol`.secAttrProtocol
  244. }
  245. if let host = host {
  246. query[kSecAttrServer as String] = host as NSObject
  247. }
  248. if let port = port {
  249. query[kSecAttrPort as String] = port as NSObject
  250. }
  251. if !path.isEmpty {
  252. query[kSecAttrPath as String] = path as NSObject
  253. }
  254. return query
  255. }
  256. }