mobiletto 1.2.1 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -29
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
package/docs/uk/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto — це абстрактний рівень зберігання JavaScript із додатковим прозорим шифруванням на стороні клієнта.
5
-
6
- # Вміст
7
- * [Чому Mobiletto?](#Чому-Mobiletto?)
8
- * [Швидкий старт](#Швидкий старт)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Джерело](#Джерело)
11
- * [Встановлення](#Встановлення)
12
- * [Підтримка та фінансування](#Support-and-Funding)
13
- * [Основне використання](#Basic-usage)
14
- * [Метадані](#Метадані)
15
- * [Альтернативний стиль імпорту](#Alternate-import-style)
16
- * [Кешування](#Кешування)
17
- * [Дзеркалювання](#Дзеркалювання)
18
- * [Прозоре шифрування](#Transparent-encryption)
19
- * [Обертання клавіш](#Обертання клавіш)
20
- * [Інтерфейс драйвера](#Driver-interface)
21
- * [Логування](#Logging)
22
-
23
- # Прочитайте це іншою мовою
24
- Цей документ README.md було перекладено за допомогою [hokeylization](https://github.com/cobbzilla/hokeylization) на
25
- **[усі мови, які підтримує Перекладач Google](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Я впевнений, що це не ідеально, але я сподіваюся, що це краще, ніж нічого!
28
-
29
- [🇸🇦 арабською](../ar/README.md)
30
- [🇧🇩 Бенгальська](../bn/README.md)
31
- [🇩🇪 німецька](../de/README.md)
32
- [🇺🇸 англійською](../en/README.md)
33
- [🇪🇸 іспанська](../es/README.md)
34
- [🇫🇷 французька](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Хінді](../hi/README.md)
37
- [🇮🇩 індонезійська](../id/README.md)
38
- [🇮🇹 італійська](../it/README.md)
39
- [🇯🇵 японська](../ja/README.md)
40
- [🇰🇷 Корейська](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 польською](../pl/README.md)
43
- [🇧🇷 португальською](../pt/README.md)
44
- [🇷🇺 російська](../ru/README.md)
45
- [🇰🇪 суахілі](../sw/README.md)
46
- [🇵🇭 Тагальська](../tl/README.md)
47
- [🇹🇷 турецька](../tr/README.md)
48
- [🇵🇰 урду](../ur/README.md)
49
- [🇻🇳 в'єтнамська](../vi/README.md)
50
- [🇨🇳 китайська](../zh/README.md)
51
-
52
-
53
- **[📚 ... Усі мови ...](../README.md)**
54
- ----
55
-
56
- ### Чи є проблема з цим перекладом README?
57
- Цей конкретний переклад оригіналу [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- може мати недоліки -- *виправлення дуже вітаються!* Надішліть [запит на вилучення на GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- або якщо вам не зручно це робити, [відкрийте проблему](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Коли ви створюєте нову проблему GitHub щодо перекладу, виконайте:
62
- * включити URL-адресу сторінки (скопіювати/вставити з адресного рядка браузера)
63
- * включити точний неправильний текст (скопіювати/вставити з браузера)
64
- * опишіть, будь ласка, що не так -- переклад невірний? форматування якось порушено?
65
- * люб'язно запропонуйте кращий переклад або те, як правильно оформити текст
66
- * **Дякую!**
67
-
68
- ## Чому Mobiletto?
69
-
70
- ### До побачення, блокування постачальника!
71
- Різні постачальники хмарних сховищ мають несумісні API. Навіть ті, які прагнуть до «сумісності з S3»
72
- мають ідіосинкратичну поведінку.
73
-
74
- Коли ви обираєте певного постачальника сховища для своєї програми, якщо ви кодуєте безпосередньо його API, ваша програма
75
- зараз залежить від цієї служби. З часом і накопиченням коду змінюються постачальники
76
- все більш неспроможним. Ласкаво просимо до веселого світу блокування постачальників!
77
-
78
- Mobiletto був розроблений, щоб вирішити цю проблему. Закодувавши програму в API mobiletto, ви можете легко
79
- змініть постачальника сховища та знайте, що рівень сховища вашої програми поводитиметься однаково.
80
-
81
- ### Широке тестування
82
- Усі драйвери перевіряються на однакову поведінку за допомогою понад 60 тестів для кожного драйвера.
83
- Ми тестуємо всі драйвери з кожною комбінацією:
84
- * Шифрування: увімкнено та вимкнено
85
- * Кеш Redis: увімкнено та вимкнено
86
-
87
- Цей підхід дає нам спокій, що mobiletto поводитиметься однаково незалежно від того, який драйвер ви використовуєте,
88
- і незалежно від того, чи ввімкнено кешування та/або шифрування.
89
-
90
- ### Підтримка драйверів
91
- Поточні драйвери пам’яті Mobiletto:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : локальна файлова система
95
-
96
- *Внески для підтримки більшої кількості постачальників хмарних сховищ дуже вітаються!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto призначений для використання іншим кодом JavaScript як бібліотека.
100
-
101
- Для роботи з mobiletto в командному рядку використовуйте [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Джерело
104
- * [mobiletto на GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto на npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Підтримка та фінансування
108
- Я намагаюся бути професійним розробником програмного забезпечення з відкритим кодом. Я працював у
109
- У індустрії програмного забезпечення протягом багатьох років я створював успішні компанії та продавав їх державним компаніям.
110
- Нещодавно я втратив роботу, і в мене насправді немає іншої роботи
111
-
112
- Тож я спробую написати корисне програмне забезпечення та перевірю, чи це спрацює
113
-
114
- Якщо вам подобається користуватися цією програмою, я буду дуже вдячний навіть за
115
- найменший [щомісячний внесок через Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Дякую!*
118
-
119
- ## Встановлення
120
- Встановіть за допомогою `npm` або `yarn` . Ймовірно, вам потрібна `lite` версія, яка не включає всі
121
- перекладені файли README:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Якщо вам справді потрібні файли README кожною мовою, встановіть повну версію:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Швидкий початок
132
- Короткий приклад використання драйвера mobiletto `s3` .
133
-
134
- Цей код працюватиме так само, якби драйвер був `b2` або `local` .
135
-
136
- const storage = require('mobiletto')
137
- const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
-
139
- // list objects: returns array of metadata objects
140
- const listing = await bucket.list()
141
- const dirList = await bucket.list('some/dir/')
142
- const everything = await bucket.list('', {recursive: true})
143
-
144
- // write an entire file
145
- let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
-
147
- // write a file from a stream/generator
148
- bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
-
150
- // read an entire file
151
- // returns null if an exception would otherwise be thrown
152
- const bufferOrNull = await bucket.safeReadFile('some/path')
153
-
154
- // stream-read a file, passing data to callback
155
- const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
-
157
- // remove a file, returns the path removed
158
- let removed = await bucket.remove('some/path') // removed is a string
159
-
160
- // remove a directory, returns array of paths removed
161
- removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
-
163
- ----
164
- ## Базове використання
165
- Набагато розширеніший приклад, який демонструє більшість пропонованих функцій:
166
-
167
- const { mobiletto } = require('mobiletto')
168
-
169
- // General usage
170
- const api = await mobiletto(driverName, key, secret, opts)
171
-
172
- // To use 'local' driver:
173
- // * key: base directory
174
- // * secret: ignored, can be null
175
- // * opts object:
176
- // * readOnly: optional, never change anything on the filesystem; default is false
177
- // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
- // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
- const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
-
181
- // To use 's3' driver:
182
- // * key: AWS Access Key ID
183
- // * secret: AWS Secret Key
184
- // * opts object:
185
- // * readOnly: optional, never change anything on the bucket; default is false
186
- // * bucket: required, name of the S3 bucket
187
- // * region: optional, the AWS region to communicate with, default is us-east-1
188
- // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
- const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
-
192
- // To use 'b2' driver:
193
- // * key: Backblaze Key ID
194
- // * secret: Backblaze Application Key
195
- // * opts object:
196
- // * readOnly: optional, never change anything on the bucket; default is false
197
- // * bucket: required, the ID (**not the name**) of the B2 bucket
198
- // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
- // * partSize: optional, large files will be split into chunks of this size when uploading
201
- const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
-
203
- // List files
204
- api.list() // --> returns an array of metadata objects
205
-
206
- // List files recursively
207
- api.list({ recursive: true })
208
-
209
- // List files in a directory
210
- const path = 'some/path'
211
- api.list(path)
212
- api.list(path, { recursive: true }) // also supports recursive flag
213
-
214
- // Visit files in a directory -- visitor function must be async
215
- api.list(path, { visitor: myAsyncFunc })
216
- api.list(path, { visitor: myAsyncFunc, recursive: true })
217
-
218
- // The `list` method throws MobilettoNotFoundError if the path does not exist
219
- // When you call `safeList` on a non-existent path, it returns an empty array
220
- api.safeList('/path/that/does/not/exist') // returns []
221
-
222
- // Read metadata for a file
223
- api.metadata(path) // returns metadata object
224
-
225
- // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
- // When you call `safeMetadata` on a non-existent path, it returns null
227
- api.safeMetadata('/tmp/does_not_exist') // returns null
228
-
229
- // Read a file
230
- // Provide a callback that writes the data someplace
231
- const callback = (chunk) => { ... write chunk somewhere ... }
232
- api.read(path, callback) // returns count of bytes read
233
-
234
- // Read an entire file at once
235
- const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
-
237
- // Read an entire file at once
238
- // returns null if an exception would otherwise be thrown
239
- const bufferOrNull = await bucket.safeReadFile('some/path')
240
-
241
- // Write a file
242
- // Provide a generator function that yields chunks of data
243
- const generator = function* () {
244
- while ( ... more-data-to-return ... ) {
245
- data = ... load-data ...
246
- yield data
247
- }
248
- }
249
- local.api(path, generator) // returns count of bytes written
250
-
251
- // Write an entire file at once (convenience method)
252
- await api.writeFile(path, bufferOrString) // returns count of bytes written
253
-
254
- // Delete a file
255
- // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
- // Always returns a value or throws an error.
257
- // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
- const quiet = true
259
- api.remove(path, {quiet}) // returns single path removed
260
-
261
- // Recursively delete a directory and do it quietly (do not report errors)
262
- const recursive = true
263
- const quiet = true
264
- api.remove(path, {recursive, quiet}) // returns array of paths removed
265
-
266
- ## Метадані
267
- Команда `metadata` повертає метадані про один запис файлової системи.
268
- Подібним чином значення, яке повертає команда `list` , є масивом об’єктів метаданих.
269
-
270
- Об’єкт метаданих виглядає так:
271
-
272
- {
273
- "name": "fully/qualified/path/to/file",
274
- "type": "entry-type",
275
- "size": size-in-bytes,
276
- "ctime": creation-time-epoch-millis,
277
- "mtime": modification-time-epoch-millis
278
- }
279
-
280
- `type` може бути `file` , `dir` , `link` або `special` .
281
-
282
- Залежно від типу драйвера команда `list` може не повертати всі поля. `name` і `type`
283
- має бути присутнім завжди. Наступна команда `metadata` поверне всі доступні властивості.
284
-
285
- ## Альтернативний стиль імпорту
286
- Імпортуйте повний модуль і використовуйте функцію `connect` :
287
-
288
- const storage = require('mobiletto')
289
- const opts = {bucket: 'bk', region: 'us-east-1'}
290
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
- const objectData = await s3.readFile('some/path')
292
-
293
- ## Кешування
294
- <a href="https://redis.io">Mobiletto</a> найкраще працює з кеш-пам’яттю Redis.
295
-
296
- Mobiletto спробує підключитися до примірника redis на 127.0.0.1:6379
297
-
298
- Ви можете замінити будь-який із цих варіантів:
299
- * Установіть змінну env `MOBILETTO_REDIS_HOST` , мобільний пристрій підключатиметься тут замість локального хосту
300
- * Установіть змінну env `MOBILETTO_REDIS_PORT` , цей порт використовуватиметься
301
-
302
- Mobiletto зберігатиме всі свої ключі redis із префіксом `_mobiletto__` . Ви можете це змінити
303
- встановивши змінну env `MOBILETTO_REDIS_PREFIX` .
304
-
305
- Ви також можете встановити кешування кожного з’єднання за допомогою об’єкта `opts.redisConfig` :
306
-
307
- const redisConfig = {
308
- enabled: true, // optional, default is true. if false other props are ignored
309
- host: '127.0.0.1',
310
- port: 6379,
311
- prefix: '_mobiletto__'
312
- }
313
- const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
-
316
- ### Не хочете кешувати redis?
317
- Щоб вимкнути: передайте `enabled: false` у вашому об’єкті `opts.redisConfig` під час встановлення з’єднання.
318
-
319
- Як описано нижче, вимкнення кешування матиме негативний вплив на продуктивність і призведе до збільшення кількості запитів
320
- для зберігання, яке вам справді потрібно.
321
-
322
- ### Керівництво з кешування
323
- **Зашифроване сховище**: читання/запис зашифрованого сховища лише трохи повільніше, ніж зазвичай,
324
- але навігація по каталогах (що деякі речі роблять) досить дорога. Використання кешу Redis
325
- дасть вам значний приріст продуктивності.
326
-
327
- Кеш за замовчуванням є безпечним, але не працює добре, якщо у вас багато операцій запису/видалення.
328
- Будь-яка операція запису або видалення робить весь кеш недійсним, гарантуючи, що наступні читання побачать
329
- останні зміни.
330
-
331
- ### Інструменти CLI
332
- Якщо ви використовуєте такий інструмент CLI, як [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- ви точно захочете ввімкнути кеш redis, оскільки він триває під час викликів команди `mo` .
334
-
335
- ## Дзеркалювання
336
-
337
- // Copy a local filesystem mobiletto to S3
338
- s3.mirror(local)
339
-
340
- // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
- local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
-
343
- Команда `mirror` виконує одноразове копіювання всіх файлів з одного мобільного пристрою на інший.
344
- Він не запускає жодних процесів для підтримки дзеркала протягом тривалого часу. `mirror`
345
- щоб синхронізувати будь-які відсутні файли.
346
-
347
- Значення, яке повертає `mirror` , — це простий об’єкт із лічильниками кількості успішних файлів
348
- віддзеркалено та скільки файлів мали помилки:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- ПОПЕРЕДЖЕННЯ. Віддзеркалення великих наборів даних може зайняти багато часу та пропускної здатності
356
-
357
- Із семантикою виклику `mirror` іноді може бути заплутано зрозуміти, хто є
358
- читач і хто такий письменник. Уявіть це як оператор призначення: "лівий mobiletto"
359
- це річ, якій призначається (записані дзеркальні дані), і "правий mobiletto" (the
360
- аргумент методу `mirror` ) — це значення, яке присвоюється (зчитуються дзеркальні дані).
361
-
362
- ## Прозоре шифрування
363
- Увімкнути прозоре шифрування на стороні клієнта:
364
-
365
- // Pass encryption parameters
366
- const encryption = {
367
- // key is required, must be >= 16 chars
368
- key: randomstring.generate(128),
369
-
370
- // optional, the default is to derive IV from key
371
- // when set, IV must be >= 16 chars
372
- iv: randomstring.generate(128),
373
-
374
- // optional, the default is aes-256-cbc
375
- algo: 'aes-256-cbc'
376
- }
377
- const api = await mobiletto(driverName, key, secret, opts, encryption)
378
-
379
- // Subsequent write operations will encrypt data (client side) when writing
380
- // Subsequent read operations will decrypt data (client side) when reading
381
-
382
- Що відбувається? Окремий «запис каталогу» (dirent) каталог (зашифрований) відстежує, які файли в ньому знаходяться
383
- каталог (він же каталог dirent).
384
- * Команда `list` читає файли запису каталогу, розшифровує кожен шлях у списку; потім повертає метадані для кожного файлу
385
- * Команди `list` більш неефективні, особливо для каталогів з великою кількістю файлів
386
- * Команда `write` записує файли dirent у каталог dirent кожного батька; потім записує файл
387
- * Команди `write` викличуть O(N) записів, з N = глибиною в ієрархії каталогів
388
- * Команда `remove` видаляє відповідний dirent-файл і його батьківський файл, якщо він порожній; потім видаляє файл
389
- * Нерекурсивні команди `remove` викличуть O(N) читань і потенційно стільки ж видалень, з N = глибиною в ієрархії каталогів
390
- * Рекурсивні команди `remove` у великих і глибоких файлових системах можуть бути дорогими
391
-
392
- Зауважте, що навіть якщо шифрування на стороні клієнта ввімкнено, зловмисник з повною видимістю вашої зашифрованої сторони сервера
393
- сховище, навіть без ключа, може бачити загальну кількість каталогів і кількість файлів у кожному, а також з
394
- деякі зусилля, виявити частину або всю загальну структуру ієрархії каталогів.
395
- *Примітка. Для кращої безпеки використовуйте відносно плоску конструкцію.*
396
- Зловмисник не знав би назв каталогів/файлів, якщо б він також не знав ваше шифрування
397
- ключ або іншим чином успішно зламали шифрування. Тоді всі ставки зняті!
398
-
399
- ### Продуктивність і кешування
400
- Операції в зашифрованому сховищі можуть бути повільними. Рекурсивні списки та видалення можуть бути дуже повільними.
401
- Кешування через redis надзвичайно допомагає, але зауважте, що кеш очищається після будь-яких записів або видалень.
402
-
403
- ## Обертання ключів
404
- Створіть mobiletto з вашим новим ключем, а потім віддзеркаліть старі дані в ньому:
405
-
406
- const storage = require('mobiletto')
407
-
408
- const oldEncryption = { key: .... }
409
- const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
-
411
- const newEncryption = { key: .... }
412
- const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
-
414
- newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
-
416
- ## Інтерфейс драйвера
417
- Драйвер — це будь-який файл JS, який експортує функцію «storageClient» із таким підписом:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : рядок, ваш ключ API (для `local` драйвера це базовий каталог)
422
- * `secret` : рядок, ваш секрет API (можна опустити для драйвера `local` )
423
- * `opts` : об'єкт, властивості залежать від драйвера:
424
- * Для `local` local` властивості `fileMode` і `dirMode` визначають, як створюються нові створювані файли та каталоги
425
- * Для `s3` необхідна властивість `bucket` . Додаткові властивості:
426
- * `region`: the S3 region, default is us-east-1
427
- * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
- * `delimiter`: the directory delimiter, default is '/'
429
-
430
- Об’єкт, який повертає функція storageClient, повинен визначати ці функції:
431
-
432
- // Test the driver before using, ensure proper configuration
433
- async testConfig ()
434
-
435
- // List files in path (or from base-directory)
436
- // If recursive is true, list recursively
437
- // If visitor is defined, it will be an async function. await the visitor function on each file found
438
- // Otherwise, perform the listing and return an array of objects
439
- async list (path, recursive = false, visitor = null) // path may be omitted
440
-
441
- // Read metadata for a path
442
- async metadata (path)
443
-
444
- // Read a file
445
- // callback receives a chunk of data. endCallback is called at end-of-stream
446
- async read (path, callback, endCallback = null)
447
-
448
- // Write a file
449
- // driver must be able to handle a generator or a stream
450
- async write (path, generatorOrReadableStream)
451
-
452
- // Remove a file, or recursively delete a directory
453
- // returns a string of a single path removed, or an array of multiple paths removed
454
- async remove (path, recursive = false, quiet = false)
455
-
456
- ## Ведення журналу
457
- Mobiletto використовує бібліотеку журналювання [winston](https://www.npmjs.com/package/winston).
458
-
459
- Журнали **будуть** містити шляхи до файлів і повідомлення про помилки, але **ніколи** не будуть містити ключі, секрети,
460
- або будь-яку іншу інформацію про конфігурацію підключення.
461
-
462
- ### Рівень журналу
463
- Використовуйте змінну середовища `MOBILETTO_LOG_LEVEL` , щоб установити рівень журналу, використовуючи один
464
- рівнів `npm` , визначених у [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Типовим рівнем є `error` . Найбільш багатослівним рівнем є `silly` , хоча зараз mobiletto
467
- не реєструє на рівнях нижче `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Файл журналу
472
- За замовчуванням реєстратор записує на консоль. Щоб надсилати журнали у файл, установіть `MOBILETTO_LOG_FILE`
473
- змінна середовища. Під час входу у файл журнали більше не записуватимуться на консоль.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Щоб вимкнути журналювання:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>