mobiletto 1.2.0 → 2.0.0

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 (127) 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 -10
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
  125. package/util/crypt.js +0 -80
  126. package/util/logger.js +0 -27
  127. package/util/redis.js +0 -233
package/docs/ru/README.md DELETED
@@ -1,481 +0,0 @@
1
- Мобилетто
2
- =========
3
-
4
- Mobiletto — это уровень абстракции хранилища JavaScript с дополнительным прозрачным шифрованием на стороне клиента.
5
-
6
- # Содержание
7
- * [Почему Mobiletto?](#Почему-Mobiletto?)
8
- * [Быстрый старт](#Быстрый старт)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Источник](#Источник)
11
- * [Установка](#Установка)
12
- * [Поддержка и финансирование](#Поддержка-и-финансирование)
13
- * [Основное использование](#Basic-использование)
14
- * [Метаданные](#Метаданные)
15
- * [Альтернативный стиль импорта](#Альтернативный-стиль импорта)
16
- * [Кэширование](#Кэширование)
17
- * [Зеркальное отображение](#Зеркальное отображение)
18
- * [Прозрачное шифрование](#Прозрачное-шифрование)
19
- * [Вращение ключа](#Вращение ключа)
20
- * [Интерфейс драйвера](#Driver-interface)
21
- * [Ведение журнала](#Ведение журнала)
22
-
23
- # Прочтите это на другом языке
24
- Этот документ README.md был переведен с помощью [hokeylization](https://github.com/cobbzilla/hokeylization) на
25
- **[все языки, поддерживаемые Google Translate](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
- [🇹🇩 Хауса](../ha/README.md)
36
- [🇮🇳 Хинди](../hi/README.md)
37
- [🇮🇩 Индонезийский](../id/README.md)
38
- [🇮🇹 итальянский](../it/README.md)
39
- [🇯🇵 Японский](../ja/README.md)
40
- [🇰🇷 Корейский](../ko/README.md)
41
- [🇮🇳 Маранти](../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
- ## Почему Мобилетто?
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-кли
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
- Mobiletto лучше всего работает с кешем <a href="https://redis.io">Redis</a> .
295
-
296
- Mobiletto попытается подключиться к экземпляру Redis по адресу 127.0.0.1:6379.
297
-
298
- Вы можете переопределить любой из них:
299
- * Установите `MOBILETTO_REDIS_HOST` , чтобы мобильное соединение подключалось сюда вместо локального хоста
300
- * Установите `MOBILETTO_REDIS_PORT` , этот порт будет использоваться
301
-
302
- Mobiletto будет хранить все свои ключи Redis с префиксом `_mobiletto__` . Вы можете изменить это
303
- установив переменную окружения `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
- ### Инструменты командной строки
332
- Если вы используете инструмент командной строки, например [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
- читатель и кто писатель. Представьте себе это как оператор присваивания: «левый мобилетто».
359
- это вещь, которой присваивается (записаны зеркальные данные), и «правый мобильетто» (
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
- каталог (также известный как прямой каталог).
384
- * Команда `list` читает файлы входа в каталог, расшифровывает каждый указанный путь; затем возвращает метаданные для каждого файла
385
- * команды `list` менее эффективны, особенно для каталогов с большим количеством файлов
386
- * Команда `write` записывает файлы в каталог dirent каждого родителя; затем записывает файл
387
- * Команды `write` O(N) операций записи, где N = глубина в иерархии каталогов
388
- * Команда `remove` удаляет соответствующий прямой файл и его родительский файл, если он пуст; затем удаляет файл
389
- * Нерекурсивные команды `remove` O(N) операций чтения и, возможно, столько же операций удаления, где N = глубина иерархии каталогов.
390
- * Рекурсивные команды `remove` на больших и глубоких файловых системах могут быть дорогими.
391
-
392
- Обратите внимание, что даже при включенном шифровании на стороне клиента злоумышленник с полным доступом к вашей зашифрованной стороне сервера
393
- хранилище, даже без ключа, все еще может видеть общее количество каталогов и сколько файлов в каждом, а с
394
- приложив некоторые усилия, откройте часть или всю общую структуру иерархии каталогов.
395
- *Примечание. Используйте относительно плоскую структуру для большей безопасности.*
396
- Злоумышленник не знал бы имен каталогов/файлов, если бы они также не знали ваше шифрование.
397
- ключ или иным образом успешно взломал шифрование. Тогда все ставки сняты!
398
-
399
- ### Производительность и кэширование
400
- Операции с зашифрованным хранилищем могут быть медленными. Рекурсивные списки и удаления могут быть очень медленными.
401
- Кэширование через Redis очень помогает, но обратите внимание, что кеш сбрасывается при любой записи или удалении.
402
-
403
- ## Ключевое вращение
404
- Создайте мобильное устройство с новым ключом, а затем отразите в нем старые данные:
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` свойства `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>