@electron/asar - Electron Archive

Asar is a simple extensive archive format, it works like tar that concatenates all files together without compression, while having random access support.

Features

• Support random access
• Use JSON to store files' information
• Very easy to write a parser

Command line utility

Install

This module requires Node 10 or later.

1$ npm install --engine-strict @electron/asar

Usage

1$ asar --help
2
3  Usage: asar [options] [command]
4
5  Commands:
6
7    pack|p <dir> <output>
8       create asar archive
9
10    list|l <archive>
11       list files of asar archive
12
13    extract-file|ef <archive> <filename>
14       extract one file from archive
15
16    extract|e <archive> <dest>
17       extract archive
18
19
20  Options:
21
22    -h, --help     output usage information
23    -V, --version  output the version number
24

Excluding multiple resources from being packed

Given:

    app
(a) ├── x1
(b) ├── x2
(c) ├── y3
(d) │   ├── x1
(e) │   └── z1
(f) │       └── x2
(g) └── z4
(h)     └── w1

Exclude: a, b

1$ asar pack app app.asar --unpack-dir "{x1,x2}"

Exclude: a, b, d, f

1$ asar pack app app.asar --unpack-dir "**/{x1,x2}"

Exclude: a, b, d, f, h

1$ asar pack app app.asar --unpack-dir "{**/x1,**/x2,z4/w1}"

Using programmatically

Example

1const asar = require('@electron/asar');
2
3const src = 'some/path/';
4const dest = 'name.asar';
5
6await asar.createPackage(src, dest);
7console.log('done.');

Please note that there is currently no error handling provided!

Transform

You can pass in a transform option, that is a function, which either returns nothing, or a stream.Transform. The latter will be used on files that will be in the .asar file to transform them (e.g. compress).

1const asar = require('@electron/asar');
2
3const src = 'some/path/';
4const dest = 'name.asar';
5
6function transform (filename) {
7  return new CustomTransformStream()
8}
9
10await asar.createPackageWithOptions(src, dest, { transform: transform });
11console.log('done.');

Using with grunt

There is also an unofficial grunt plugin to generate asar archives at bwin/grunt-asar.

Format

Asar uses Pickle to safely serialize binary value to file.

The format of asar is very flat:

| UInt32: header_size | String: header | Bytes: file1 | ... | Bytes: file42 |

The header_size and header are serialized with Pickle class, and header_size's Pickle object is 8 bytes.

The header is a JSON string, and the header_size is the size of header's Pickle object.

Structure of header is something like this:

1{
2   "files": {
3      "tmp": {
4         "files": {}
5      },
6      "usr" : {
7         "files": {
8           "bin": {
9             "files": {
10               "ls": {
11                 "offset": "0",
12                 "size": 100,
13                 "executable": true,
14                 "integrity": {
15                   "algorithm": "SHA256",
16                   "hash": "...",
17                   "blockSize": 1024,
18                   "blocks": ["...", "..."]
19                 }
20               },
21               "cd": {
22                 "offset": "100",
23                 "size": 100,
24                 "executable": true,
25                 "integrity": {
26                   "algorithm": "SHA256",
27                   "hash": "...",
28                   "blockSize": 1024,
29                   "blocks": ["...", "..."]
30                 }
31               }
32             }
33           }
34         }
35      },
36      "etc": {
37         "files": {
38           "hosts": {
39             "offset": "200",
40             "size": 32,
41             "integrity": {
42                "algorithm": "SHA256",
43                "hash": "...",
44                "blockSize": 1024,
45                "blocks": ["...", "..."]
46              }
47           }
48         }
49      }
50   }
51}

offset and size records the information to read the file from archive, the offset starts from 0 so you have to manually add the size of header_size and header to the offset to get the real offset of the file.

offset is a UINT64 number represented in string, because there is no way to precisely represent UINT64 in JavaScript Number. size is a JavaScript Number that is no larger than Number.MAX_SAFE_INTEGER, which has a value of 9007199254740991 and is about 8PB in size. We didn't store size in UINT64 because file size in Node.js is represented as Number and it is not safe to convert Number to UINT64.

integrity is an object consisting of a few keys:

• A hashing algorithm, currently only SHA256 is supported.
• A hex encoded hash value representing the hash of the entire file.
• An array of hex encoded hashes for the blocks of the file. i.e. for a blockSize of 4KB this array contains the hash of every block if you split the file into N 4KB blocks.
• A integer value blockSize representing the size in bytes of each block in the blocks hashes above