mobiletto 1.1.10 → 1.1.11

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 +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -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 +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto är ett JavaScript-lagringsabstraktionslager, med valfri transparent kryptering på klientsidan.
5
+
6
+ # Innehåll
7
+ * [Varför Mobiletto?](#Why-Mobiletto?)
8
+ * [Snabbstart](#Snabbstart)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Källa](#Källa)
11
+ * [Basic usage](#Basic-usage)
12
+ * [Metadata](#Metadata)
13
+ * [Alternativ importstil](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Spegling](#Spegling)
16
+ * [Transparent kryptering](#Transparent-kryptering)
17
+ * [Nyckelrotation](#Key-rotation)
18
+ * [Driver interface](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Läs detta på ett annat språk
22
+ Detta README.md-dokument har översatts, via [hokeylization](https://github.com/cobbzilla/hokeylization), till
23
+ **[alla språk som stöds av Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Jag är säker på att det inte är perfekt, men jag hoppas att det är bättre än ingenting!
26
+
27
+ [🇸🇦 arabiska](../ar/README.md)
28
+ [🇧🇩 bengaliska](../bn/README.md)
29
+ [🇩🇪 tyska](../de/README.md)
30
+ [🇺🇸 engelska](../en/README.md)
31
+ [🇪🇸 spanska](../es/README.md)
32
+ [🇫🇷 franska](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 hindi](../hi/README.md)
35
+ [🇮🇩 indonesiska](../id/README.md)
36
+ [🇮🇹 italienska](../it/README.md)
37
+ [🇯🇵 japanska](../ja/README.md)
38
+ [🇰🇷 koreanska](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 polska](../pl/README.md)
41
+ [🇧🇷 portugisiska](../pt/README.md)
42
+ [🇷🇺 ryska](../ru/README.md)
43
+ [🇰🇪 swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 turkiska](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 vietnamesiska](../vi/README.md)
48
+ [🇨🇳 kinesiska](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Alla språk ...](../README.md)**
52
+ ----
53
+
54
+ ### Finns det ett problem med denna översättning av README?
55
+ Denna speciella översättning av originalet [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ kan vara felaktiga -- *korrigeringar är mycket välkomna!* Skicka en [pull request på GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ eller om du inte är bekväm med att göra det, [öppna ett problem](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ När du skapar ett nytt GitHub-nummer om en översättning, vänligen gör:
60
+ * inkludera sidans URL (kopiera/klistra in från webbläsarens adressfält)
61
+ * inkludera den exakta texten som är fel (kopiera/klistra in från webbläsaren)
62
+ * vänligen beskriv vad som är fel -- är översättningen felaktig? är formateringen trasig på något sätt?
63
+ * kom gärna med ett förslag på en bättre översättning eller hur texten bör formateras korrekt
64
+ * **Tack!**
65
+
66
+ ## Varför Mobiletto?
67
+
68
+ ### Adjö leverantörens inlåsning!
69
+ De olika molnlagringsleverantörerna har inkompatibla API:er. Även de som strävar efter "S3-kompatibilitet"
70
+ har idiosynkratiska beteenden.
71
+
72
+ När du väljer en viss lagringsleverantör för din app, om du kodar direkt till deras API, din app
73
+ är nu beroende av den tjänsten. Allt eftersom tiden går och koden ackumuleras, byter leverantörer
74
+ allt mer ohållbar. Välkommen till den roliga världen av leverantörslåsning!
75
+
76
+ Mobiletto designades för att lösa detta problem. Genom att koda din app till mobilettos API kan du enkelt
77
+ byt lagringsleverantör och vet att din apps lagringslager kommer att bete sig identiskt.
78
+
79
+ ### Omfattande testning
80
+ Alla förare testas för identiskt beteende med 60+ tester för varje förare.
81
+ Vi testar alla förare med varje kombination av:
82
+ * Kryptering: både aktiverad och inaktiverad
83
+ * Redis cache: både aktiverad och inaktiverad
84
+
85
+ Detta tillvägagångssätt ger oss trygghet i att mobiletto kommer att bete sig likadant oavsett vilken drivrutin du använder,
86
+ och oavsett om du aktiverar cachning och/eller kryptering.
87
+
88
+ ### Drivrutinsstöd
89
+ Aktuella Mobiletto-lagringsdrivrutiner:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokalt filsystem
93
+
94
+ *Bidrag för att stödja fler molnlagringsleverantörer är mycket välkomna!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto är avsedd att användas som ett bibliotek av annan JavaScript-kod.
98
+
99
+ För att arbeta med mobiletto på kommandoraden, använd [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Källa
102
+ * [mobiletto på GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto på npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Snabbstart
106
+ Ett kort exempel med drivrutinen för mobiletto `s3` .
107
+
108
+ Den här koden skulle köras på samma sätt om drivrutinen var `b2` eller `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Grundläggande användning
139
+ Ett mycket mer omfattande exempel som visar de flesta funktioner som erbjuds:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Metadata
241
+ Kommandot `metadata` returnerar metadata om en enda filsystempost.
242
+ På samma sätt är returvärdet från kommandot `list` en array av metadataobjekt.
243
+
244
+ Ett metadataobjekt ser ut så här:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ `type` kan vara `file` , `dir` , `link` eller `special` .
255
+
256
+ Beroende på typ av drivrutin kan ett `list` kommando inte returnera alla fält. `name` och `type`
257
+ ska alltid vara närvarande. Ett efterföljande `metadata` kommando kommer att returnera alla tillgängliga egenskaper.
258
+
259
+ ## Alternativ importstil
260
+ Importera den fullständiga modulen och använd `connect` -funktionen:
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Cachning
268
+ Mobiletto fungerar bäst med en <a href="https://redis.io">redis-</a> cache.
269
+
270
+ Mobiletto kommer att försöka ansluta till en redis-instans på 127.0.0.1:6379
271
+
272
+ Du kan åsidosätta någon av dessa:
273
+ * Ställ in `MOBILETTO_REDIS_HOST` var, mobiletto ansluta här istället för localhost
274
+ * Ställ in `MOBILETTO_REDIS_PORT` var, denna port kommer att användas
275
+
276
+ Mobiletto kommer att lagra alla sina redis-nycklar med prefixet `_mobiletto__` . Du kan ändra detta
277
+ genom att ställa in `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ Du kan också ställa in cachelagring per anslutning med objektet `opts.redisConfig` :
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### Vill du inte ha redis caching?
291
+ För att inaktivera: skicka `enabled: false` i ditt `opts.redisConfig` objekt när du upprättar din anslutning.
292
+
293
+ Som diskuteras nedan kommer att inaktivera cachning ha en negativ effekt på prestandan och få fler förfrågningar
294
+ till förvaring som du verkligen behöver.
295
+
296
+ ### Cachningsvägledning
297
+ **Krypterad lagring**: läsning/skrivning av krypterad lagring är bara lite långsammare än normalt,
298
+ men att navigera runt i kataloger (vilket vissa saker gör) är ganska dyrt. Använder en redis cache
299
+ kommer att ge dig en betydande prestandaökning.
300
+
301
+ Standardcachen är säker, men fungerar inte bra om du har många skriv-/borttagningsåtgärder.
302
+ Varje skriv- eller borttagningsoperation ogiltigförklarar hela cachen, vilket säkerställer att efterföljande läsningar kommer att se
303
+ senaste ändringarna.
304
+
305
+ ### CLI-verktyg
306
+ Om du använder ett CLI-verktyg som [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ du vill definitivt att redis-cachen är aktiverad, eftersom den varar över anrop av kommandot `mo` .
308
+
309
+ ## Spegling
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ `mirror` utför en engångskopia av alla filer från en mobiltto till en annan.
318
+ Den kör ingen process för att underhålla spegeln över tid. Kör kommandot `mirror` igen
319
+ för att synkronisera eventuella saknade filer.
320
+
321
+ Returvärdet från `mirror` är ett enkelt objekt med räknare för hur många filer som lyckades
322
+ speglade och hur många filer hade fel:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ VARNING: Spegling av stora datamängder kan vara mycket tidskrävande och bandbreddskrävande
330
+
331
+ Med `mirror` kan det ibland vara förvirrande att förstå vem som är
332
+ läsare och vem som är författare. Föreställ dig det som en uppgiftsbeskrivning: "vänsterhandsmobilen"
333
+ är saken som tilldelas (speglad data skriven), och "höger mobiltto" (den
334
+ argument till `mirror` ) är värdet som tilldelas (speglad data läses).
335
+
336
+ ## Transparent kryptering
337
+ Aktivera transparent kryptering på klientsidan:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ Vad händer? En separat "katalogpost" (dirent) katalog (krypterad) spårar vilka filer som finns i den
357
+ katalog (alias dirent-katalogen).
358
+ * `list` läser kataloginmatningsfilerna, dekrypterar varje listad sökväg; returnerar sedan metadata för varje fil
359
+ * `list` kommandon är mer ineffektiva, speciellt för kataloger med ett stort antal filer
360
+ * `write` skriver dirent-filer i varje förälders dirent-katalog, rekursivt; skriver sedan filen
361
+ * `write` kommandon kommer att medföra O(N)-skrivningar, med N = djup i kataloghierarkin
362
+ * `remove` tar bort motsvarande dirent-fil och dess överordnade om den är tom, rekursivt; tar sedan bort filen
363
+ * Icke-rekursiva `remove` kommandon kommer att medföra O(N)-läsningar och potentiellt lika många borttagningar, med N = djup i kataloghierarkin
364
+ * Rekursiva `remove` kommandon på stora och djupa filsystem kan vara dyrt
365
+
366
+ Observera att även med kryptering på klientsidan aktiverad, en motståndare med full insyn i din krypterade serversida
367
+ lagring, även utan nyckel, kan fortfarande se det totala antalet kataloger och hur många filer som finns i varje, och med
368
+ lite ansträngning, upptäck en del eller hela den övergripande strukturen i kataloghierarkin.
369
+ *Obs! Använd en relativt platt struktur för bättre säkerhet.*
370
+ Motståndaren skulle inte veta namnen på katalogerna/filerna om de inte också kände till din kryptering
371
+ nyckel eller på annat sätt hade lyckats knäcka krypteringen. Då är alla spel avstängda!
372
+
373
+ ### Prestanda och cachning
374
+ Operationer på krypterad lagring kan vara långsamma. Rekursiva listor och borttagningar kan vara mycket långsamma.
375
+ Cachning via redis hjälper enormt, men observera att cachen töms vid alla skrivningar eller borttagningar.
376
+
377
+ ## Tangentrotation
378
+ Skapa en mobiltto med din nya nyckel och spegla sedan den gamla datan i den:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## Drivrutinsgränssnitt
391
+ En drivrutin är en JS-fil som exporterar en 'storageClient'-funktion med denna signatur:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : en sträng, din API-nyckel (för den `local` drivrutinen är detta baskatalogen)
396
+ * `secret` : en sträng, din API-hemlighet (kan utelämnas för den `local` drivrutinen)
397
+ * `opts` : ett objekt, egenskaperna är per drivrutin:
398
+ * För `local` bestämmer egenskaperna `fileMode` och `dirMode` hur nya skapande filer och kataloger skapas
399
+ * För `s3` krävs egenskapen `bucket` . Valfria egenskaper är:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ Objektet som storageClient-funktionen returnerar måste definiera dessa funktioner:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Loggning
431
+ Mobiletto använder loggningsbiblioteket [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Loggar **kommer** att innehålla sökvägar och felmeddelanden, men kommer **aldrig** att innehålla nycklar, hemligheter,
434
+ eller annan information om anslutningskonfiguration.
435
+
436
+ ### Loggnivå
437
+ Använd `MOBILETTO_LOG_LEVEL` för att ställa in loggnivån med en
438
+ av `npm` som definieras i [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Standardnivån är `error` . Den mest utförliga nivån är "fånigt", även om `silly` för närvarande är
441
+ loggar inte på nivåer under `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Loggfil
446
+ Som standard skriver loggern till konsolen. För att skicka loggar till en fil, ställ in `MOBILETTO_LOG_FILE`
447
+ miljöfaktor. När du loggar till en fil kommer loggar inte längre att skrivas till konsolen.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Så här stänger du av loggning:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>