mobiletto 1.1.10 → 1.1.13

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 (116) hide show
  1. package/README.md +74 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +25 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +13 -9
  116. package/util/redis.js +2 -2
@@ -0,0 +1,481 @@
1
+ móvil
2
+ =========
3
+
4
+ Mobiletto es una capa de abstracción de almacenamiento de JavaScript, con cifrado transparente opcional del lado del cliente.
5
+
6
+ # Contenidos
7
+ * [¿Por qué Mobiletto?](#¿Por qué-Mobiletto?)
8
+ * [Inicio rápido](#Inicio rápido)
9
+ * [CLI de Mobiletto](#mobiletto-cli)
10
+ * [Fuente](#Fuente)
11
+ * [Instalación](#Instalación)
12
+ * [Apoyo y Financiamiento](#Apoyo-y-Financiamiento)
13
+ * [Uso básico](#Uso-básico)
14
+ * [Metadatos](#Metadatos)
15
+ * [Estilo de importación alternativo](#Estilo de importación alternativo)
16
+ * [Almacenamiento en caché](#Almacenamiento en caché)
17
+ * [Reflejo](#Reflejo)
18
+ * [Cifrado transparente](#Cifrado-transparente)
19
+ * [Rotación de clave](#Rotación de clave)
20
+ * [Interfaz del controlador](#Interfaz del controlador)
21
+ * [Registro](#Registro)
22
+
23
+ # Leer esto en otro idioma
24
+ Este documento README.md ha sido traducido, a través de [hokeylization](https://github.com/cobbzilla/hokeylization), a
25
+ **[¡todos los idiomas admitidos por Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Estoy seguro de que no es perfecto, ¡pero espero que sea mejor que nada!
28
+
29
+ [🇸🇦 Árabe](../ar/README.md)
30
+ [🇧🇩 bengalí](../bn/README.md)
31
+ [🇩🇪 Alemán](../de/README.md)
32
+ [🇺🇸 Español](../es/README.md)
33
+ [🇪🇸 Español](../es/README.md)
34
+ [🇫🇷 Francés](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 hindi](../hi/README.md)
37
+ [🇮🇩 Indonesio](../id/README.md)
38
+ [🇮🇹 Italiano](../it/README.md)
39
+ [🇯🇵 Japonés](../ja/README.md)
40
+ [🇰🇷 Coreano](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 Polaco](../pl/README.md)
43
+ [🇧🇷 Portugués](../pt/README.md)
44
+ [🇷🇺 Ruso](../ru/README.md)
45
+ [🇰🇪 Suajili](../sw/README.md)
46
+ [🇵🇭 Tagalo](../tl/README.md)
47
+ [🇹🇷 Turco](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 Vietnamita](../vi/README.md)
50
+ [🇨🇳 Chino](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Todos los idiomas ...](../README.md)**
54
+ ----
55
+
56
+ ### ¿Hay algún problema con esta traducción del LÉAME?
57
+ Esta traducción particular del [README] original (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ puede tener fallas -- * ¡las correcciones son muy bienvenidas! * Envíe una [solicitud de extracción en GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ o si no se siente cómodo haciéndolo, [abra un problema](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Cuando cree un nuevo problema de GitHub sobre una traducción, haga lo siguiente:
62
+ * incluir la URL de la página (copiar/pegar desde la barra de direcciones del navegador)
63
+ * incluir el texto exacto que está mal (copiar/pegar desde el navegador)
64
+ * por favor describa lo que está mal -- ¿la traducción es incorrecta? ¿El formato está roto de alguna manera?
65
+ * ofrezca amablemente una sugerencia de una mejor traducción, o cómo el texto debe formatearse correctamente
66
+ * **¡Gracias!**
67
+
68
+ ## ¿Por qué Mobiletto?
69
+
70
+ ### ¡Adiós al bloqueo de proveedores!
71
+ Los diversos proveedores de almacenamiento en la nube tienen API incompatibles. Incluso aquellos que luchan por la "compatibilidad con S3"
72
+ tienen comportamientos idiosincrásicos.
73
+
74
+ Cuando elige un proveedor de almacenamiento en particular para su aplicación, si codifica directamente a su API, su aplicación
75
+ ahora depende de ese servicio. A medida que pasa el tiempo y se acumula el código, cambiar de proveedor se vuelve
76
+ cada vez más insostenible. ¡Bienvenido al divertido mundo del bloqueo de proveedores!
77
+
78
+ Mobiletto fue diseñado para resolver este problema. Al codificar su aplicación para la API de mobiletto, puede fácilmente
79
+ cambie los proveedores de almacenamiento y sepa que la capa de almacenamiento de su aplicación se comportará de manera idéntica.
80
+
81
+ ### Pruebas exhaustivas
82
+ Todos los controladores se someten a pruebas de comportamiento idéntico con más de 60 pruebas para cada controlador.
83
+ Probamos todos los controladores con cada combinación de:
84
+ * Cifrado: tanto habilitado como deshabilitado
85
+ * Caché Redis: tanto habilitado como deshabilitado
86
+
87
+ Este enfoque nos da la tranquilidad de que mobiletto se comportará igual independientemente del controlador que utilice,
88
+ e independientemente de si habilita el almacenamiento en caché y/o el cifrado.
89
+
90
+ ### Compatibilidad con el controlador
91
+ Controladores de almacenamiento Mobiletto actuales:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : sistema de archivos local
95
+
96
+ *¡Las contribuciones para apoyar a más proveedores de almacenamiento en la nube son muy bienvenidas!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto está destinado a ser utilizado como biblioteca por otro código JavaScript.
100
+
101
+ Para trabajar con mobiletto en la línea de comandos, use [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Fuente
104
+ * [mobiletto en GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto en npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Apoyo y Financiamiento
108
+ Estoy tratando de ser un desarrollador profesional de software de código abierto. he estado trabajando en
109
+ la industria del software durante muchos años, comencé empresas exitosas y las vendí a empresas públicas.
110
+ Recientemente perdí mi trabajo, y realmente no tengo ningún otro trabajo en fila
111
+
112
+ Así que voy a intentar escribir un software útil y ver si funciona.
113
+
114
+ Si disfruta usando este software, estaría muy agradecido incluso por el
115
+ la [contribución mensual más pequeña a través de Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *¡Gracias!*
118
+
119
+ ## Instalación
120
+ Instale usando `npm` o `yarn` . Probablemente desee la versión `lite` que no incluye todos los
121
+ Archivos LÉAME traducidos:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Si realmente desea los archivos README en todos los idiomas, instale la versión completa:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Inicio rápido
132
+ Un breve ejemplo usando el controlador mobiletto `s3` .
133
+
134
+ Este código se ejecutaría igual si el controlador fuera `b2` o `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
+ ## Uso básico
165
+ Un ejemplo mucho más extenso, que muestra la mayoría de las características ofrecidas:
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
+ ## Metadatos
267
+ El comando `metadata` devuelve metadatos sobre una sola entrada del sistema de archivos.
268
+ Del mismo modo, el valor de retorno del comando `list` es una matriz de objetos de metadatos.
269
+
270
+ Un objeto de metadatos se ve así:
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
+ La propiedad `type` puede ser `file` , `dir` , `link` o `special` .
281
+
282
+ Según el tipo de controlador, es posible que un comando `list` no devuelva todos los campos. Las `name` y `type`
283
+ siempre debe estar presente. Un comando posterior de `metadata` devolverá todas las propiedades disponibles.
284
+
285
+ ## Estilo de importación alternativo
286
+ Importe el módulo de alcance completo y use la función `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
+ ## Almacenamiento en caché
294
+ Mobiletto funciona mejor con un caché <a href="https://redis.io">redis</a> .
295
+
296
+ Mobiletto intentará conectarse a una instancia de redis en 127.0.0.1:6379
297
+
298
+ Puede anular cualquiera de estos:
299
+ * Configure la variable de `MOBILETTO_REDIS_HOST` , mobilet para conectarse aquí en lugar de localhost
300
+ * Establecer el env var `MOBILETTO_REDIS_PORT` , se utilizará este puerto
301
+
302
+ Mobiletto almacenará todas sus claves redis con el prefijo `_mobiletto__` . Puedes cambiar esto
303
+ configurando la variable de entorno `MOBILETTO_REDIS_PREFIX` .
304
+
305
+ También puede configurar el almacenamiento en caché por conexión con el objeto `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
+ ### ¿No quieres el almacenamiento en caché de redis?
317
+ Para deshabilitar: pase `enabled: false` en su objeto `opts.redisConfig` cuando establezca su conexión.
318
+
319
+ Como se explica a continuación, deshabilitar el almacenamiento en caché tendrá un efecto adverso en el rendimiento e incurrirá en más solicitudes.
320
+ al almacenamiento que realmente necesita.
321
+
322
+ ### Guía de almacenamiento en caché
323
+ **Almacenamiento cifrado**: la lectura/escritura del almacenamiento cifrado es solo un poco más lenta de lo normal,
324
+ pero navegar por los directorios (que es lo que hacen algunas cosas) es bastante costoso. Usando un caché redis
325
+ le dará un impulso de rendimiento significativo.
326
+
327
+ El caché predeterminado es seguro, pero no funciona bien si tiene muchas operaciones de escritura/eliminación.
328
+ Cualquier operación de escritura o eliminación invalida toda la memoria caché, lo que garantiza que las lecturas posteriores verán el
329
+ Últimos cambios.
330
+
331
+ ### herramientas CLI
332
+ Si está utilizando una herramienta CLI como [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ definitivamente querrá que el caché redis esté habilitado, ya que dura a través de las invocaciones del comando `mo` .
334
+
335
+ ## Reflejo
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
+ El comando `mirror` realiza una copia única de todos los archivos de un móvil a otro.
344
+ No ejecuta ningún proceso para mantener el espejo a lo largo del tiempo. Ejecute el comando `mirror` nuevamente
345
+ para sincronizar los archivos que faltan.
346
+
347
+ El valor de retorno de `mirror` es un objeto simple con contadores de cuántos archivos fueron exitosos
348
+ reflejado y cuántos archivos tenían errores:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ ADVERTENCIA: Duplicar grandes conjuntos de datos puede llevar mucho tiempo y un uso intensivo del ancho de banda
356
+
357
+ Con la semántica de la llamada `mirror` , a veces puede ser confuso entender quién es el
358
+ lector y quién es el escritor. Imagínelo como una declaración de asignación: el "mobiletto de la mano izquierda"
359
+ es la cosa a la que se asigna (datos reflejados escritos), y el "mobiletto de la mano derecha" (el
360
+ argumento del método `mirror` ) es el valor que se asigna (se leen los datos reflejados).
361
+
362
+ ## Cifrado transparente
363
+ Habilite el cifrado transparente del lado del cliente:
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
+ ¿Qué esta pasando? Un directorio separado de "entrada de directorio" (dirent) (encriptado) rastrea qué archivos hay en ese
383
+ directorio (también conocido como el directorio dirent).
384
+ * El comando `list` lee los archivos de entrada del directorio, descifra cada ruta listada; luego devuelve metadatos para cada archivo
385
+ * Los comandos `list` son más ineficientes, especialmente para directorios con una gran cantidad de archivos
386
+ * El comando `write` escribe archivos diferentes en el directorio principal de cada padre, recursivamente; luego escribe el archivo
387
+ * Los comandos `write` incurrirán en O(N) escrituras, con N = profundidad en la jerarquía de directorios
388
+ * El comando `remove` elimina el archivo de directorio correspondiente, y su padre si está vacío, recursivamente; luego elimina el archivo
389
+ * Los comandos `remove` no recursivos generarán O(N) lecturas y potencialmente tantas eliminaciones, con N = profundidad en la jerarquía de directorios
390
+ * Los comandos `remove` en sistemas de archivos grandes y profundos pueden ser costosos
391
+
392
+ Tenga en cuenta que incluso con el cifrado del lado del cliente habilitado, un adversario con visibilidad completa de su lado del servidor cifrado
393
+ almacenamiento, incluso sin la clave, aún puede ver el número total de directorios y cuántos archivos hay en cada uno, y con
394
+ algún esfuerzo, descubra parte o la totalidad de la estructura general de la jerarquía de directorios.
395
+ *Nota: Use una estructura relativamente plana para mayor seguridad.*
396
+ El adversario no sabría los nombres de los directorios/archivos a menos que también supiera su encriptación
397
+ clave o de otro modo había descifrado con éxito el cifrado. ¡Todas las apuestas están canceladas entonces!
398
+
399
+ ### Rendimiento y almacenamiento en caché
400
+ Las operaciones en el almacenamiento cifrado pueden ser lentas. Las listas recursivas y las eliminaciones pueden ser muy lentas.
401
+ El almacenamiento en caché a través de redis es de gran ayuda, pero tenga en cuenta que el caché se vacía con cualquier escritura o eliminación.
402
+
403
+ ## Rotación de claves
404
+ Cree un mobiletto con su nueva clave, luego refleje los datos antiguos en él:
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
+ ## Interfaz del controlador
417
+ Un controlador es cualquier archivo JS que exporta una función 'storageClient' con esta firma:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : una cadena, su clave API (para el controlador `local` este es el directorio base)
422
+ * `secret` : una cadena, su secreto de API (se puede omitir para el controlador `local` )
423
+ * `opts` : un objeto, las propiedades son por controlador:
424
+ * Para `local` , las `fileMode` y `dirMode` determinan cómo se crean los nuevos archivos y directorios.
425
+ * Para `s3` , se requiere la propiedad `bucket` . Las propiedades opcionales son:
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
+ El objeto que devuelve la función storageClient debe definir estas funciones:
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
+ ## Inicio sesión
457
+ Mobiletto usa la biblioteca de registro [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Los registros **contendrán** rutas de archivos y mensajes de error, pero **nunca** contendrán claves, secretos,
460
+ o cualquier otra información de configuración de conexión.
461
+
462
+ ### Nivel de registro
463
+ Use la variable de entorno `MOBILETTO_LOG_LEVEL` para establecer el nivel de registro, usando uno
464
+ de los niveles `npm` definidos en [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ El nivel predeterminado es `error` . El nivel más detallado es `silly` , aunque actualmente mobiletto
467
+ no inicia sesión en niveles por debajo `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Archivo de registro
472
+ De forma predeterminada, el registrador escribe en la consola. Para enviar registros a un archivo, configure `MOBILETTO_LOG_FILE`
473
+ Variable ambiental. Al iniciar sesión en un archivo, los registros ya no se escribirán en la consola.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Para desactivar el registro:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>