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
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto è un livello di astrazione dello storage JavaScript, con crittografia lato client trasparente opzionale.
5
+
6
+ # Contenuti
7
+ * [Perché Mobiletto?](#Perché-Mobiletto?)
8
+ * [Avvio rapido](#Avvio rapido)
9
+ * [CLI Mobiletto](#mobiletto-cli)
10
+ * [Fonte](#Fonte)
11
+ * [Installazione](#Installazione)
12
+ * [Supporto e finanziamento](#Supporto e finanziamento)
13
+ * [Utilizzo di base](#Utilizzo di base)
14
+ * [Metadati](#Metadati)
15
+ * [Stile di importazione alternativo](#Stile di importazione alternativo)
16
+ * [Memorizzazione nella cache](#Memorizzazione nella cache)
17
+ * [Mirroring](#Mirroring)
18
+ * [Crittografia trasparente](#Crittografia trasparente)
19
+ * [Rotazione chiave](#Rotazione chiave)
20
+ * [Interfaccia del driver](#Interfaccia del driver)
21
+ * [Registrazione](#Registrazione)
22
+
23
+ # Leggi questo in un'altra lingua
24
+ Questo documento README.md è stato tradotto, tramite [hokeylization](https://github.com/cobbzilla/hokeylization), in
25
+ **[ogni lingua supportata da Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Sono certa che non sia perfetto, ma spero sia meglio di niente!
28
+
29
+ [🇸🇦 Arabo](../ar/README.md)
30
+ [🇧🇩 Bengali](../bn/README.md)
31
+ [🇩🇪 Tedesco](../de/README.md)
32
+ [🇺🇸 Inglese](../en/README.md)
33
+ [🇪🇸 Spagnolo](../es/README.md)
34
+ [🇫🇷 Francese](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 Indonesiano](../id/README.md)
38
+ [🇮🇹 Italiano](../it/README.md)
39
+ [🇯🇵 Giapponese](../ja/README.md)
40
+ [🇰🇷 Coreano](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 Polacco](../pl/README.md)
43
+ [🇧🇷 Portoghese](../pt/README.md)
44
+ [🇷🇺 Russo](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 Turco](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 Vietnamita](../vi/README.md)
50
+ [🇨🇳 Cinese](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Tutte le lingue ...](../README.md)**
54
+ ----
55
+
56
+ ### C'è un problema con questa traduzione del README?
57
+ Questa particolare traduzione dell'originale [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ potrebbe essere difettoso -- *le correzioni sono molto gradite!* Si prega di inviare una [richiesta pull su GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ o se non ti senti a tuo agio nel farlo, [apri un problema](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Quando crei un nuovo problema GitHub su una traduzione, esegui:
62
+ * includi l'URL della pagina (copia/incolla dalla barra degli indirizzi del browser)
63
+ * includi il testo esatto che è sbagliato (copia/incolla dal browser)
64
+ * per favore descrivi cosa c'è che non va -- la traduzione è errata? la formattazione è rotta in qualche modo?
65
+ * offrire gentilmente un suggerimento per una traduzione migliore o come formattare correttamente il testo
66
+ * **Grazie!**
67
+
68
+ ## Perché Mobiletto?
69
+
70
+ ### Addio blocco del venditore!
71
+ I vari provider di archiviazione cloud hanno API incompatibili. Anche quelli che lottano per la "compatibilità S3"
72
+ avere comportamenti idiosincratici.
73
+
74
+ Quando scegli un particolare fornitore di storage per la tua app, se codifichi direttamente la sua API, la tua app
75
+ ora dipende da quel servizio. Col passare del tempo e il codice si accumula, cambiano i fornitori
76
+ sempre più insostenibile. Benvenuto nel divertente mondo del blocco dei fornitori!
77
+
78
+ Mobiletto è stato progettato per risolvere questo problema. Codificando la tua app sull'API di mobiletto, puoi facilmente
79
+ cambia provider di archiviazione e sappi che il livello di archiviazione della tua app si comporterà in modo identico.
80
+
81
+ ### Test approfonditi
82
+ Tutti i driver vengono testati per il comportamento identico con oltre 60 test per ciascun pilota.
83
+ Testiamo tutti i driver con ogni combinazione di:
84
+ * Crittografia: sia abilitata che disabilitata
85
+ * Cache Redis: sia abilitato che disabilitato
86
+
87
+ Questo approccio ci dà la tranquillità che mobiletto si comporterà allo stesso modo indipendentemente dal driver utilizzato,
88
+ e indipendentemente dal fatto che tu abiliti la memorizzazione nella cache e/o la crittografia.
89
+
90
+ ### Supporto per i driver
91
+ Driver di archiviazione Mobiletto attuali:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : filesystem locale
95
+
96
+ *I contributi per supportare più fornitori di servizi di archiviazione cloud sono molto graditi!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto è concepito per essere utilizzato come libreria da altro codice JavaScript.
100
+
101
+ Per lavorare con mobiletto dalla riga di comando, usa [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Fonte
104
+ * [mobiletto su GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto su npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Supporto e finanziamento
108
+ Sto cercando di essere uno sviluppatore di software open source professionista. Ci ho lavorato
109
+ nell'industria del software per molti anni, ho avviato società di successo e le ho vendute a società pubbliche.
110
+ Recentemente ho perso il lavoro, e non ho altro in programma
111
+
112
+ Quindi proverò a scrivere un software utile e vedere se funziona
113
+
114
+ Se ti piace usare questo software, ti sarei molto grato anche per il
115
+ il più piccolo [contributo mensile tramite Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Grazie!*
118
+
119
+ ## Installazione
120
+ Installa usando `npm` o `yarn` . Probabilmente vuoi la versione `lite` che non include tutti i file
121
+ file README tradotti:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Se vuoi davvero i file README in ogni lingua, installa la versione completa:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Avvio veloce
132
+ Un breve esempio usando il driver mobiletto `s3` .
133
+
134
+ Questo codice funzionerebbe allo stesso modo se il driver fosse `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
+ ## Utilizzo di base
165
+ Un esempio molto più ampio, che mostra la maggior parte delle funzionalità offerte:
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
+ ## Metadati
267
+ Il comando `metadata` restituisce i metadati su una singola voce del filesystem.
268
+ Allo stesso modo, il valore restituito dal comando `list` è un array di oggetti di metadati.
269
+
270
+ Un oggetto di metadati ha il seguente aspetto:
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 proprietà `type` type` può essere `file` , `dir` , `link` o `special` .
281
+
282
+ A seconda del tipo di driver, un comando `list` potrebbe non restituire tutti i campi. Le proprietà `name` e `type`
283
+ dovrebbe essere sempre presente. Un successivo comando `metadata` restituirà tutte le proprietà disponibili.
284
+
285
+ ## Stile di importazione alternativo
286
+ Importa il modulo con ambito completo e usa la funzione `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
+ ## Memorizzazione nella cache
294
+ Mobiletto funziona meglio con una cache <a href="https://redis.io">redis</a> .
295
+
296
+ Mobiletto tenterà di connettersi a un'istanza redis su 127.0.0.1:6379
297
+
298
+ Puoi sovrascrivere uno di questi:
299
+ * Impostare `MOBILETTO_REDIS_HOST` env var, mobiletto connect qui invece di localhost
300
+ * Imposta la `MOBILETTO_REDIS_PORT` env var, questa porta verrà utilizzata
301
+
302
+ Mobiletto memorizzerà tutte le sue chiavi redis con il prefisso `_mobiletto__` . Puoi cambiarlo
303
+ impostando il `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Puoi anche impostare la memorizzazione nella cache per connessione con l'oggetto `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
+ ### Non vuoi redis memorizzare nella cache?
317
+ Per disabilitare: passa `enabled: false` nel tuo oggetto `opts.redisConfig` quando stabilisci la connessione.
318
+
319
+ Come discusso di seguito, la disabilitazione della memorizzazione nella cache avrà un effetto negativo sulle prestazioni e comporterà più richieste
320
+ allo spazio di archiviazione di cui hai davvero bisogno.
321
+
322
+ ### Guida alla memorizzazione nella cache
323
+ **Archiviazione crittografata**: la lettura/scrittura dello spazio di archiviazione crittografato è solo leggermente più lenta del normale,
324
+ ma navigare nelle directory (cosa che fanno alcune cose) è piuttosto costoso. Utilizzo di una cache redis
325
+ ti darà un notevole aumento delle prestazioni.
326
+
327
+ La cache predefinita è sicura, ma non funziona bene se hai molte operazioni di scrittura/rimozione.
328
+ Qualsiasi operazione di scrittura o rimozione invalida l'intera cache, assicurando che le letture successive vedranno il file
329
+ ultime modifiche.
330
+
331
+ ### Strumenti dell'interfaccia a riga di comando
332
+ Se stai utilizzando uno strumento CLI come [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ vorrai sicuramente abilitare la cache redis, poiché dura durante le invocazioni del comando `mo` .
334
+
335
+ ## Specchio
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
+ Il comando `mirror` esegue una copia unica di tutti i file da un mobiletto all'altro.
344
+ Non esegue alcun processo per mantenere lo specchio nel tempo. Esegui di nuovo il comando `mirror`
345
+ per sincronizzare eventuali file mancanti.
346
+
347
+ Il valore restituito da `mirror` è un semplice oggetto con contatori di quanti file sono stati eseguiti correttamente
348
+ con mirroring e quanti file hanno avuto errori:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ AVVISO: il mirroring di set di dati di grandi dimensioni può richiedere molto tempo e la larghezza di banda
356
+
357
+ Con la semantica della chiamata `mirror` a volte può essere fonte di confusione capire chi è il
358
+ lettore e chi è lo scrittore. Immaginalo come una dichiarazione di assegnazione: il "mobiletto di sinistra"
359
+ è la cosa a cui si assegna (scrittura dei dati speculari), e il "mobiletto di destra" (il
360
+ argomento del metodo `mirror` ) è il valore assegnato (i dati speculari vengono letti).
361
+
362
+ ## Crittografia trasparente
363
+ Abilita la crittografia lato client trasparente:
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
+ Cosa sta succedendo? Una directory separata "voce di directory" (direct) (crittografata) tiene traccia dei file in essa contenuti
383
+ directory (ovvero la directory diretta).
384
+ * Il comando `list` legge i file di ingresso della directory, decrittografa ogni percorso elencato; quindi restituisce i metadati per ogni file
385
+ * I comandi `list` sono più inefficienti, specialmente per le directory con un gran numero di file
386
+ * Il comando `write` scrive i file diretti nella directory diretta di ciascun genitore, in modo ricorsivo; quindi scrive il file
387
+ * I comandi `write` comporteranno O(N) scritture, con N = profondità nella gerarchia delle directory
388
+ * Il comando `remove` rimuove il file diretto corrispondente e il suo genitore, se vuoto, in modo ricorsivo; quindi rimuove il file
389
+ * I comandi `remove` non ricorsivi comporteranno O(N) letture e potenzialmente altrettante eliminazioni, con N = profondità nella gerarchia delle directory
390
+ * I comandi ricorsivi `remove` su filesystem grandi e profondi possono essere costosi
391
+
392
+ Tieni presente che anche con la crittografia lato client abilitata, un avversario con piena visibilità sul lato server crittografato
393
+ l'archiviazione, anche senza la chiave, può ancora vedere il numero totale di directory e quanti file ci sono in ciascuna e con
394
+ qualche sforzo, scoprire parte o tutta la struttura generale della gerarchia di directory.
395
+ *Nota: utilizzare una struttura relativamente piatta per una maggiore sicurezza.*
396
+ L'avversario non conoscerebbe i nomi delle directory/file a meno che non conoscesse anche la tua crittografia
397
+ chiave o altrimenti ha violato con successo la crittografia. Allora tutte le scommesse sono finite!
398
+
399
+ ### Prestazioni e memorizzazione nella cache
400
+ Le operazioni sull'archiviazione crittografata possono essere lente. Le inserzioni e le rimozioni ricorsive possono essere molto lente.
401
+ La memorizzazione nella cache tramite redis aiuta enormemente, ma tieni presente che la cache viene svuotata in caso di scrittura o rimozione.
402
+
403
+ ## Rotazione chiave
404
+ Crea un mobiletto con la tua nuova chiave, quindi rispecchia i vecchi dati al suo interno:
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
+ ## Interfaccia del driver
417
+ Un driver è qualsiasi file JS che esporta una funzione 'storageClient' con questa firma:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : una stringa, la tua chiave API (per il driver `local` questa è la directory di base)
422
+ * `secret` : una stringa, il tuo segreto API (può essere omesso per il driver `local` )
423
+ * `opts` : un oggetto, le proprietà sono per driver:
424
+ * Per `local` , le `fileMode` e `dirMode` determinano come vengono creati i nuovi file e directory di creazione
425
+ * Per `s3` è richiesta la proprietà `bucket` . Le proprietà opzionali sono:
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
+ L'oggetto restituito dalla funzione storageClient deve definire queste funzioni:
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
+ ## Registrazione
457
+ Mobiletto utilizza la libreria di registrazione [winston](https://www.npmjs.com/package/winston).
458
+
459
+ I registri **conterranno** percorsi di file e messaggi di errore, ma **non conterranno mai** chiavi, segreti,
460
+ o qualsiasi altra informazione sulla configurazione della connessione.
461
+
462
+ ### Livello di registro
463
+ Usa la variabile d'ambiente `MOBILETTO_LOG_LEVEL` per impostare il livello di log, usandone uno
464
+ dei livelli `npm` definiti in [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Il livello predefinito è `error` . Il livello più dettagliato è `silly` , sebbene attualmente mobiletto
467
+ non registra a livelli inferiori a `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### File di registro
472
+ Per impostazione predefinita, il logger scrive sulla console. Per inviare i log a un file, impostare il `MOBILETTO_LOG_FILE`
473
+ variabile d'ambiente. Quando si accede a un file, i registri non verranno più scritti nella console.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Per disattivare la registrazione:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>