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/ca/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto és una capa d'abstracció d'emmagatzematge de JavaScript, amb xifratge transparent opcional del costat del client.
5
-
6
- # Continguts
7
- * [Per què Mobiletto?](#Per què-Mobiletto?)
8
- * [Inici ràpid](#Inici ràpid)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Font](#Font)
11
- * [Instal·lació](#Instal·lació)
12
- * [Suport i finançament](#Support-and-Funding)
13
- * [Ús bàsic](#Ús bàsic)
14
- * [Metadades](#Metadades)
15
- * [Estil d'importació alternatiu](#Estil d'importació alternatiu)
16
- * [Memòria en memòria cau](#Caching)
17
- * [Mirroring](#Mirroring)
18
- * [Xifrat transparent](#Transparent-encryption)
19
- * [Rotació de tecles](#Rotació de tecles)
20
- * [Interfície del controlador](#Interfície del controlador)
21
- * [Registre](#Registre)
22
-
23
- # Llegeix això en un altre idioma
24
- Aquest document README.md s'ha traduït, mitjançant [hokeylization](https://github.com/cobbzilla/hokeylization), a
25
- **[cada idioma compatible amb Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Estic segur que no és perfecte, però espero que sigui millor que res!
28
-
29
- [🇸🇦 Àrab](../ar/README.md)
30
- [🇧🇩 bengalí](../bn/README.md)
31
- [🇩🇪 Alemany](../de/README.md)
32
- [🇺🇸 Anglès](../en/README.md)
33
- [🇪🇸 Espanyol](../es/README.md)
34
- [🇫🇷 Francès](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Hindi](../hi/README.md)
37
- [🇮🇩 indonesi](../id/README.md)
38
- [🇮🇹 italià](../it/README.md)
39
- [🇯🇵 Japonès](../ja/README.md)
40
- [🇰🇷 coreà](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Polonès](../pl/README.md)
43
- [🇧🇷 portuguès](../pt/README.md)
44
- [🇷🇺 Rus](../ru/README.md)
45
- [🇰🇪 suahili](../sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Turc](../tr/README.md)
48
- [🇵🇰 Urdu](../ur/README.md)
49
- [🇻🇳 vietnamita](../vi/README.md)
50
- [🇨🇳 Xinès](../zh/README.md)
51
-
52
-
53
- **[📚 ... Tots els idiomes ...](../README.md)**
54
- ----
55
-
56
- ### Hi ha algun problema amb aquesta traducció del README?
57
- Aquesta traducció particular de l'original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- pot ser defectuós -- *les correccions són molt benvingudes!* Envieu una [sol·licitud d'extracció a GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- o si no et sents còmode fent-ho, [obre un problema](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Quan creeu un nou problema de GitHub sobre una traducció, feu el següent:
62
- * incloure l'URL de la pàgina (copiar/enganxar des de la barra d'adreces del navegador)
63
- * inclou el text exacte que és incorrecte (copiar/enganxar des del navegador)
64
- * si us plau, descriu què està malament: la traducció és incorrecta? el format està trencat d'alguna manera?
65
- * Oferiu amablement un suggeriment d'una millor traducció o com s'hauria de formatar correctament el text
66
- * **Gràcies!**
67
-
68
- ## Per què Mobiletto?
69
-
70
- ### Adéu bloqueig de venedors!
71
- Els diferents proveïdors d'emmagatzematge al núvol tenen API incompatibles. Fins i tot aquells que s'esforcen per la "compatibilitat S3"
72
- tenen comportaments idiosincràtics.
73
-
74
- Quan trieu un proveïdor d'emmagatzematge concret per a la vostra aplicació, si codifiqueu directament a la seva API, la vostra aplicació
75
- ara depèn d'aquest servei. A mesura que passa el temps i el codi s'acumula, els venedors esdevenen canviants
76
- cada cop més insostenible. Benvingut al divertit món del bloqueig de venedors!
77
-
78
- Mobiletto va ser dissenyat per resoldre aquest problema. Si codifiqueu la vostra aplicació a l'API de mobiletto, podeu fer-ho fàcilment
79
- canvieu de proveïdor d'emmagatzematge i sàpiga que la capa d'emmagatzematge de la vostra aplicació es comportarà de la mateixa manera.
80
-
81
- ### Extenses proves
82
- Tots els conductors són provats per a un comportament idèntic amb més de 60 proves per a cada conductor.
83
- Provem tots els controladors amb totes les combinacions de:
84
- * Xifratge: tant activat com desactivat
85
- * Memòria cau Redis: tant activada com desactivada
86
-
87
- Aquest enfocament ens proporciona tranquil·litat que mobiletto es comportarà de la mateixa manera independentment del controlador que utilitzeu,
88
- i independentment de si activeu la memòria cau i/o el xifratge.
89
-
90
- ### Suport al conductor
91
- Controladors d'emmagatzematge de Mobiletto actuals:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : sistema de fitxers local
95
-
96
- *Les contribucions per donar suport a més proveïdors d'emmagatzematge al núvol són molt benvingudes!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto està pensat per ser utilitzat com a biblioteca per altres codis JavaScript.
100
-
101
- Per treballar amb mobiletto a la línia d'ordres, utilitzeu [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Font
104
- * [mobiletto a GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto a npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Suport i finançament
108
- Estic intentant ser un desenvolupador professional de programari de codi obert. Hi he estat treballant
109
- la indústria del programari durant molts anys, he creat empreses d'èxit i les he venut a empreses públiques.
110
- Recentment he perdut la meva feina, i realment no tinc cap altra feina preparada
111
-
112
- Així que intentaré escriure programari útil i veure si funciona
113
-
114
- Si us agrada utilitzar aquest programari, us agrairia fins i tot el
115
- més petita [contribució mensual a través de Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Gràcies!*
118
-
119
- ## Instal·lació
120
- Instal·leu amb `npm` o `yarn` . Probablement vulgueu la versió `lite` que no inclogui tots els fitxers
121
- fitxers README traduïts:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Si realment voleu els fitxers README en tots els idiomes, instal·leu la versió completa:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Començament ràpid
132
- Un breu exemple amb el controlador mobiletto `s3` .
133
-
134
- Aquest codi s'executaria igual si el controlador fos `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
- ## Ús bàsic
165
- Un exemple molt més ampli, que mostra la majoria de les funcions que s'ofereixen:
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
- ## Metadades
267
- L'ordre `metadata` retorna metadades sobre una única entrada del sistema de fitxers.
268
- De la mateixa manera, el valor de retorn de l'ordre `list` és una matriu d'objectes de metadades.
269
-
270
- Un objecte de metadades té aquest aspecte:
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 propietat " `type` pot ser `file` ", `dir` ", `link` o `special` .
281
-
282
- Depenent del tipus de controlador, una ordre `list` pot no retornar tots els camps. Les propietats `name` " i `type` .
283
- hauria d'estar sempre present. Una ordre `metadata` posterior retornarà totes les propietats disponibles.
284
-
285
- ## Estil d'importació alternatiu
286
- Importeu el mòdul d'abast complet i utilitzeu la funció `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
- ## Emmagatzematge a la memòria cau
294
- Mobiletto funciona millor amb una memòria cau <a href="https://redis.io">redis</a> .
295
-
296
- Mobiletto intentarà connectar-se a una instància redis a 127.0.0.1:6379
297
-
298
- Podeu anul·lar qualsevol d'aquests:
299
- * Establiu la var env `MOBILETTO_REDIS_HOST` , mobileper connectar-vos aquí en lloc de localhost
300
- * Establiu la var env `MOBILETTO_REDIS_PORT` , s'utilitzarà aquest port
301
-
302
- Mobiletto emmagatzemarà totes les seves claus redis amb el prefix `_mobiletto__` . Podeu canviar això
303
- mitjançant la configuració de la var env `MOBILETTO_REDIS_PREFIX`
304
-
305
- També podeu establir la memòria cau per connexió amb l'objecte `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 voleu la memòria cau de redis?
317
- Per desactivar: passeu `enabled: false` al vostre objecte `opts.redisConfig` quan establiu la vostra connexió.
318
-
319
- Com es comenta a continuació, la desactivació de la memòria cau tindrà un efecte advers en el rendiment i generarà més sol·licituds
320
- a l'emmagatzematge que realment necessiteu.
321
-
322
- ### Guia per a la memòria cau
323
- **Emmagatzematge encriptat**: la lectura/escriptura d'emmagatzematge encriptat és només una mica més lent del normal,
324
- però navegar pels directoris (cosa que fan algunes coses) és bastant car. Utilitzant una memòria cau redis
325
- us donarà un augment significatiu del rendiment.
326
-
327
- La memòria cau per defecte és segura, però no funciona bé si teniu moltes operacions d'escriptura/eliminació.
328
- Qualsevol operació d'escriptura o eliminació invalida tota la memòria cau, assegurant que les lectures posteriors veuran el fitxer
329
- els últims canvis.
330
-
331
- ### Eines CLI
332
- Si utilitzeu una eina CLI com [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- Definitivament, voldreu que la memòria cau redis estigui habilitada, ja que dura durant les invocacions de l'ordre `mo` .
334
-
335
- ## Mirall
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
- L'ordre `mirror` realitza una còpia única de tots els fitxers d'un mòbil a un altre.
344
- No executa cap procés per mantenir el mirall al llarg del temps. Executeu l'ordre `mirror` nou
345
- per sincronitzar els fitxers que falten.
346
-
347
- El valor de retorn de `mirror` és un objecte senzill amb comptadors per quants fitxers s'han realitzat correctament
348
- duplicats i quants fitxers tenien errors:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- ADVERTÈNCIA: La duplicació de grans conjunts de dades pot consumir molt de temps i ample de banda
356
-
357
- Amb la semàntica de la crida `mirror` vegades pot resultar confús entendre qui és
358
- lector i qui és l'escriptor. Imagineu-ho com una declaració d'assignació: el "mobiletto de la mà esquerra"
359
- és la cosa a què s'assigna (dades escrites reflectides) i el "mobiletto de la dreta" (el
360
- argument al mètode `mirror` ) és el valor que s'assigna (es llegeixen les dades reflectides).
361
-
362
- ## Xifratge transparent
363
- Activa el xifratge transparent del costat del client:
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
- Que està passant? Un directori separat (xifrat) "entrada de directori" (directori) fa un seguiment dels fitxers que hi ha
383
- directori (també conegut com el directori dirent).
384
- * L'ordre `list` llegeix els fitxers d'entrada del directori, desxifra cada camí de la llista; després retorna les metadades per a cada fitxer
385
- * Les ordres `list` són més ineficients, especialment per a directoris amb un gran nombre de fitxers
386
- * L'ordre `write` escriu fitxers dirent al directori dirent de cada pare, de manera recursiva; després escriu el fitxer
387
- * `write` ordres d'escriptura provocaran escriptures O(N), amb N = profunditat a la jerarquia de directoris
388
- * L'ordre `remove` elimina el fitxer dirent corresponent, i el seu pare si està buit, de forma recursiva; llavors elimina el fitxer
389
- * Les ordres `remove` no recursives provocaran lectures O (N) i potencialment tantes supressions, amb N = profunditat a la jerarquia de directoris
390
- * Les ordres recursives `remove` en sistemes de fitxers grans i profunds poden ser cares
391
-
392
- Tingueu en compte que fins i tot amb el xifratge del costat del client habilitat, un adversari amb visibilitat total del vostre servidor xifrat
393
- L'emmagatzematge, fins i tot sense la clau, encara pot veure el nombre total de directoris i quants fitxers hi ha a cadascun, i amb
394
- algun esforç, descobrir part o tota l'estructura global de la jerarquia de directoris.
395
- *Nota: utilitzeu una estructura relativament plana per a una millor seguretat.*
396
- L'adversari no sabria els noms dels directoris/fitxers tret que també conegués el vostre xifratge
397
- clau o hagués trencat el xifratge amb èxit. Aleshores, totes les apostes estan desactivades!
398
-
399
- ### Rendiment i memòria cau
400
- Les operacions d'emmagatzematge xifrat poden ser lentes. Les fitxes recursives i les eliminacions poden ser molt lentes.
401
- L'emmagatzematge a la memòria cau mitjançant redis ajuda enormement, però tingueu en compte que la memòria cau s'esborra quan s'escriu o s'elimini.
402
-
403
- ## Rotació de tecles
404
- Creeu un mòbiltto amb la vostra clau nova i, a continuació, reflectiu-hi les dades antigues:
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
- ## Interfície del controlador
417
- Un controlador és qualsevol fitxer JS que exporti una funció "storageClient" amb aquesta signatura:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : una cadena, la vostra clau API (per al controlador `local` aquest és el directori base)
422
- * `secret` : una cadena, el vostre secret de l'API (es pot ometre per al controlador `local` )
423
- * `opts` : un objecte, les propietats són per controlador:
424
- * Per a `local` , les `fileMode` i `dirMode` determinen com es creen fitxers i directoris de creació nous
425
- * Per a `s3` , la propietat `bucket` és necessària. Les propietats opcionals són:
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'objecte que retorna la funció storageClient ha de definir aquestes funcions:
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
- ## Registre
457
- Mobiletto utilitza la biblioteca de registre [winston](https://www.npmjs.com/package/winston).
458
-
459
- Els registres **contindran** els camins dels fitxers i els missatges d'error, però **mai** contindran claus, secrets,
460
- o qualsevol altra informació de configuració de connexió.
461
-
462
- ### Nivell de registre
463
- Utilitzeu la variable d'entorn `MOBILETTO_LOG_LEVEL` per establir el nivell de registre, utilitzant-ne un
464
- dels nivells `npm` definits a [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- El nivell predeterminat és `error` . El nivell més detallat és `silly` , encara que actualment mobiletto
467
- no registra en nivells inferiors a `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Fitxer de registre
472
- Per defecte, el registrador escriu a la consola. Per enviar registres a un fitxer, configureu el `MOBILETTO_LOG_FILE`
473
- variable d'entorn. Quan inicieu sessió en un fitxer, els registres ja no s'escriuran a la consola.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Per desactivar el registre:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>