-
Notifications
You must be signed in to change notification settings - Fork 212
Expand file tree
/
Copy pathFileProtection.swift
More file actions
179 lines (153 loc) · 6.02 KB
/
FileProtection.swift
File metadata and controls
179 lines (153 loc) · 6.02 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
//
// FileProtection.swift
// FileKit
//
// The MIT License (MIT)
//
// Copyright (c) 2015-2017 Nikolai Vazquez
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
import Foundation
#if os(iOS) || os(watchOS) || os(tvOS)
/// The values that can be obtained from `FileAttributeKey.protectionKey` on a
/// file's attributes. Only available on iOS, watchOS, and tvOS.
public enum FileProtection: String {
/// The file has no special protections associated with it.
case none
/// The file is stored in an encrypted format on disk and cannot be read
/// from or written to while the device is locked or booting.
case complete
/// The file is stored in an encrypted format on disk. Files can be created
/// while the device is locked, but once closed, cannot be opened again
/// until the device is unlocked.
case completeUnlessOpen
/// The file is stored in an encrypted format on disk and cannot be accessed
/// until after the device has booted.
case completeUntilFirstUserAuthentication
/// Initializes `self` from a file protection value.
///
/// - Parameter rawValue: The raw value to initialize from.
///
public init?(rawValue: String) {
switch rawValue {
case FileProtectionType.none.rawValue:
self = .none
case FileProtectionType.complete.rawValue:
self = .complete
case FileProtectionType.completeUnlessOpen.rawValue:
self = .completeUnlessOpen
case FileProtectionType.completeUntilFirstUserAuthentication.rawValue:
self = .completeUntilFirstUserAuthentication
default:
return nil
}
}
/// The file protection string value of `self`.
public var rawValue: String {
switch self {
case .none:
return FileProtectionType.none.rawValue
case .complete:
return FileProtectionType.complete.rawValue
case .completeUnlessOpen:
return FileProtectionType.completeUnlessOpen.rawValue
case .completeUntilFirstUserAuthentication:
return FileProtectionType.completeUntilFirstUserAuthentication.rawValue
}
}
/// Return the equivalent Data.WritingOptions
public var dataWritingOption: NSData.WritingOptions {
switch self {
case .none:
return .noFileProtection
case .complete:
return .completeFileProtection
case .completeUnlessOpen:
return .completeFileProtectionUnlessOpen
case .completeUntilFirstUserAuthentication:
return .completeFileProtectionUntilFirstUserAuthentication
}
}
}
extension Path {
// MARK: File Protection
/// The protection of the file at the path.
public var fileProtection: FileProtection? {
guard let value = attributes[FileAttributeKey.protectionKey] as? String,
let protection = FileProtection(rawValue: value) else {
return nil
}
return protection
}
/// Creates a file at path with specified file protection.
///
/// - Parameter fileProtection: the protection to apply to the file.
///
/// Throws an error if the file cannot be created.
///
/// - Throws: `FileKitError.CreateFileFail`
///
public func createFile(_ fileProtection: FileProtection) throws {
let manager = FileManager()
let attributes: [FileAttributeKey: Any] = [.protectionKey: fileProtection] // todo test
if !manager.createFile(atPath: _safeRawValue, contents: nil, attributes: attributes) {
throw FileKitError.createFileFail(path: self)
}
}
}
extension File {
// MARK: File Protection
/// The protection of `self`.
public var protection: FileProtection? {
return path.fileProtection
}
/// Creates the file with specified file protection.
///
/// - Parameter fileProtection: the protection to apply to the file.
///
/// Throws an error if the file cannot be created.
///
/// - Throws: `FileKitError.CreateFileFail`
///
public func create(_ fileProtection: FileProtection) throws {
try path.createFile(fileProtection)
}
}
extension File where DataType: NSData {
/// Writes data to the file.
///
/// - Parameter data: The data to be written to the file.
/// - Parameter fileProtection: the protection to apply to the file.
/// - Parameter atomically: If `true`, the data is written to an
/// auxiliary file that is then renamed to the
/// file. If `false`, the data is written to
/// the file directly.
///
/// - Throws: `FileKitError.WriteToFileFail`
///
public func write(_ data: DataType, fileProtection: FileProtection, atomically: Bool = true) throws {
var options = fileProtection.dataWritingOption
if atomically {
options.formUnion(Foundation.Data.WritingOptions.atomic)
}
try self.write(data, options: options)
}
}
#endif