@attocash/cli 0.4.0 → 0.5.0
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.
- package/README.md +6 -2
- package/dist/internal-marketplace.d.ts +1 -0
- package/dist/internal-marketplace.js +1 -0
- package/dist/marketplace/approval-files.js +38 -12
- package/dist/marketplace/wallet-setup.js +10 -0
- package/dist/storage/private-permissions.d.ts +19 -0
- package/dist/storage/private-permissions.js +88 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ Requires **Node.js 24.15.0 or newer** and an accessible OS password store:
|
|
|
19
19
|
| --- | --- |
|
|
20
20
|
| macOS | Keychain access for the CLI |
|
|
21
21
|
| Linux | `secret-tool` (usually `libsecret-tools`), an unlocked Secret Service provider such as GNOME Keyring or KWallet, and access to its D-Bus session |
|
|
22
|
-
| Windows | Credential Manager access
|
|
22
|
+
| Windows | Credential Manager access and the [Microsoft Visual C++ v14 runtime](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) matching Node.js architecture |
|
|
23
23
|
|
|
24
24
|
```sh
|
|
25
25
|
npm install --global @attocash/cli
|
|
@@ -36,6 +36,10 @@ The executable is `atto`. There is no plaintext recovery-phrase fallback when
|
|
|
36
36
|
the password store is unavailable. Headless Linux environments need a working
|
|
37
37
|
Secret Service session too; check it with `atto doctor`.
|
|
38
38
|
|
|
39
|
+
Windows uses Node.js filesystem support and normal per-user profile permissions.
|
|
40
|
+
Recovery material stays in Credential Manager; no permission-checking executable
|
|
41
|
+
or additional SDK is needed.
|
|
42
|
+
|
|
39
43
|
## Set up the wallet
|
|
40
44
|
|
|
41
45
|
Run this in your own interactive terminal:
|
|
@@ -249,7 +253,7 @@ shared spending limits and a durable request ID. See
|
|
|
249
253
|
|
|
250
254
|
Review Marketplace's exact request file and typed challenge in your own terminal.
|
|
251
255
|
See [local proof approvals](https://github.com/attocash/integrations/blob/main/docs/cli-reference.md#review-a-marketplace-wallet-approval)
|
|
252
|
-
for origin checks
|
|
256
|
+
for origin checks and private-file requirements on each supported platform.
|
|
253
257
|
|
|
254
258
|
## Profiles and recovery
|
|
255
259
|
|
|
@@ -24,3 +24,4 @@ export declare function signMarketplaceAttoController(options: {
|
|
|
24
24
|
terminalConfirmed: true;
|
|
25
25
|
}): Promise<import("./marketplace/proof-approval.js").MarketplaceProofApprovalResponse>;
|
|
26
26
|
export { inspectMarketplaceWalletSetup, withUnchangedMarketplaceWalletSetup, type MarketplaceWalletSetupSnapshot } from './marketplace/wallet-setup.js';
|
|
27
|
+
export { assertPrivatePermissions, assertPrivatePermissionsBatch, securePrivatePermissions, syncPrivateDirectory, type PrivatePath } from './storage/private-permissions.js';
|
|
@@ -49,3 +49,4 @@ export async function signMarketplaceAttoController(options) {
|
|
|
49
49
|
}
|
|
50
50
|
}
|
|
51
51
|
export { inspectMarketplaceWalletSetup, withUnchangedMarketplaceWalletSetup } from './marketplace/wallet-setup.js';
|
|
52
|
+
export { assertPrivatePermissions, assertPrivatePermissionsBatch, securePrivatePermissions, syncPrivateDirectory } from './storage/private-permissions.js';
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { randomBytes } from 'node:crypto';
|
|
2
|
-
import { closeSync, constants,
|
|
2
|
+
import { closeSync, constants, fstatSync, fsyncSync, linkSync, lstatSync, openSync, readFileSync, unlinkSync, writeFileSync } from 'node:fs';
|
|
3
3
|
import { basename, dirname, join, resolve } from 'node:path';
|
|
4
4
|
import { AttoError } from '../domain/errors.js';
|
|
5
|
+
import { assertPrivatePermissions, securePrivatePermissions, syncPrivateDirectory } from '../storage/private-permissions.js';
|
|
5
6
|
const MAX_REQUEST_BYTES = 32_768;
|
|
6
7
|
const PRIVATE_FILE_MODE = 0o600;
|
|
7
8
|
export function readMarketplaceProofApprovalRequest(pathValue) {
|
|
@@ -10,14 +11,15 @@ export function readMarketplaceProofApprovalRequest(pathValue) {
|
|
|
10
11
|
const path = resolve(pathValue);
|
|
11
12
|
let descriptor;
|
|
12
13
|
try {
|
|
14
|
+
assertRealParent(path);
|
|
13
15
|
const before = lstatSync(path);
|
|
14
|
-
if (!before.isFile() || before.isSymbolicLink() ||
|
|
15
|
-
|| (before.mode & 0o022) !== 0 || before.size < 2 || before.size > MAX_REQUEST_BYTES)
|
|
16
|
+
if (!before.isFile() || before.isSymbolicLink() || before.nlink !== 1
|
|
17
|
+
|| (process.platform !== 'win32' && (!ownedByCurrentUser(before.uid) || (before.mode & 0o022) !== 0)) || before.size < 2 || before.size > MAX_REQUEST_BYTES)
|
|
16
18
|
throw invalidFile();
|
|
17
19
|
descriptor = openSync(path, constants.O_RDONLY | constants.O_NOFOLLOW);
|
|
18
20
|
const info = fstatSync(descriptor);
|
|
19
|
-
if (!info.isFile() || info.dev !== before.dev || info.ino !== before.ino
|
|
20
|
-
|| (info.mode & 0o022) !== 0 || info.size < 2 || info.size > MAX_REQUEST_BYTES)
|
|
21
|
+
if (!info.isFile() || info.nlink !== 1 || info.dev !== before.dev || info.ino !== before.ino
|
|
22
|
+
|| (process.platform !== 'win32' && (!ownedByCurrentUser(info.uid) || (info.mode & 0o022) !== 0)) || info.size < 2 || info.size > MAX_REQUEST_BYTES)
|
|
21
23
|
throw invalidFile();
|
|
22
24
|
const bytes = readFileSync(descriptor);
|
|
23
25
|
if (bytes.length > MAX_REQUEST_BYTES)
|
|
@@ -43,17 +45,19 @@ export function writeMarketplaceProofApprovalResponse(requestPathValue, response
|
|
|
43
45
|
if (!/^[a-f0-9]{32}\.request\.json$/.test(requestName) || requestName.slice(0, 32) !== response.handoffId)
|
|
44
46
|
throw invalidFile();
|
|
45
47
|
const directoryPath = dirname(requestPath);
|
|
48
|
+
assertRealParent(requestPath);
|
|
46
49
|
const directory = lstatSync(directoryPath);
|
|
47
50
|
const request = lstatSync(requestPath);
|
|
48
|
-
if (!directory.isDirectory() || directory.isSymbolicLink() || !
|
|
49
|
-
|| (
|
|
51
|
+
if (!directory.isDirectory() || directory.isSymbolicLink() || !request.isFile() || request.isSymbolicLink() || request.nlink !== 1
|
|
52
|
+
|| (process.platform !== 'win32' && (!ownedByCurrentUser(directory.uid) || (directory.mode & 0o022) !== 0
|
|
53
|
+
|| !ownedByCurrentUser(request.uid))))
|
|
50
54
|
throw invalidFile();
|
|
51
55
|
const responsePath = join(directoryPath, `${response.handoffId}.response.json`);
|
|
52
56
|
const temporaryPath = join(directoryPath, `.${randomBytes(16).toString('hex')}.tmp`);
|
|
53
57
|
let descriptor;
|
|
54
58
|
try {
|
|
55
59
|
descriptor = openSync(temporaryPath, constants.O_WRONLY | constants.O_CREAT | constants.O_EXCL | constants.O_NOFOLLOW, PRIVATE_FILE_MODE);
|
|
56
|
-
|
|
60
|
+
securePrivatePermissions(temporaryPath, 'file');
|
|
57
61
|
writeFileSync(descriptor, `${JSON.stringify(response)}\n`, { encoding: 'utf8' });
|
|
58
62
|
fsyncSync(descriptor);
|
|
59
63
|
closeSync(descriptor);
|
|
@@ -66,13 +70,24 @@ export function writeMarketplaceProofApprovalResponse(requestPathValue, response
|
|
|
66
70
|
throw new AttoError('MARKETPLACE_APPROVAL_EXISTS', 'An approval response file already exists. Keep the exact response or request a new Marketplace challenge.');
|
|
67
71
|
throw error;
|
|
68
72
|
}
|
|
69
|
-
const directoryFd = openSync(directoryPath, constants.O_RDONLY | constants.O_DIRECTORY);
|
|
70
73
|
try {
|
|
71
|
-
|
|
74
|
+
unlinkSync(temporaryPath);
|
|
75
|
+
}
|
|
76
|
+
catch (error) {
|
|
77
|
+
if (error.code !== 'ENOENT')
|
|
78
|
+
throw error;
|
|
72
79
|
}
|
|
73
|
-
|
|
74
|
-
|
|
80
|
+
assertPrivatePermissions(responsePath, 'file');
|
|
81
|
+
if (process.platform === 'win32') {
|
|
82
|
+
const publishedFd = openSync(responsePath, constants.O_RDWR | constants.O_NOFOLLOW);
|
|
83
|
+
try {
|
|
84
|
+
fsyncSync(publishedFd);
|
|
85
|
+
}
|
|
86
|
+
finally {
|
|
87
|
+
closeSync(publishedFd);
|
|
88
|
+
}
|
|
75
89
|
}
|
|
90
|
+
syncPrivateDirectory(directoryPath);
|
|
76
91
|
return responsePath;
|
|
77
92
|
}
|
|
78
93
|
catch (error) {
|
|
@@ -89,6 +104,17 @@ export function writeMarketplaceProofApprovalResponse(requestPathValue, response
|
|
|
89
104
|
catch { /* No temp file remains if link failed or cleanup already ran. */ }
|
|
90
105
|
}
|
|
91
106
|
}
|
|
107
|
+
function assertRealParent(path) {
|
|
108
|
+
for (let current = dirname(path);;) {
|
|
109
|
+
const info = lstatSync(current);
|
|
110
|
+
if (!info.isDirectory() || info.isSymbolicLink())
|
|
111
|
+
throw invalidFile();
|
|
112
|
+
const parent = dirname(current);
|
|
113
|
+
if (parent === current)
|
|
114
|
+
return;
|
|
115
|
+
current = parent;
|
|
116
|
+
}
|
|
117
|
+
}
|
|
92
118
|
function ownedByCurrentUser(uid) {
|
|
93
119
|
return typeof process.getuid === 'function' && uid === process.getuid();
|
|
94
120
|
}
|
|
@@ -8,6 +8,7 @@ import { AttoError } from '../domain/errors.js';
|
|
|
8
8
|
import { SpendLedger } from '../spending/ledger.js';
|
|
9
9
|
import { inspectWalletProfile } from '../storage/profiles.js';
|
|
10
10
|
import { StateStore } from '../storage/state.js';
|
|
11
|
+
import { assertPrivatePermissionsBatch } from '../storage/private-permissions.js';
|
|
11
12
|
export function formatSpendingPolicy(policy) {
|
|
12
13
|
const perPayment = policy.perRequest ? `${policy.perRequest.amount} ${policy.perRequest.unit}` : 'Unlimited';
|
|
13
14
|
const rolling = policy.rolling.length
|
|
@@ -68,6 +69,15 @@ async function withExistingWallet(options, action) {
|
|
|
68
69
|
if (!existsSync(join(profile.directory, 'state.sqlite'))) {
|
|
69
70
|
throw new AttoError('WALLET_NOT_INITIALIZED', 'Choose an initialized existing CLI wallet or use advanced wallet setup.');
|
|
70
71
|
}
|
|
72
|
+
// Check the existing Windows database before even read-only schema inspection.
|
|
73
|
+
// New wallet state is still opened only after the normal lifecycle lease.
|
|
74
|
+
if (process.platform === 'win32')
|
|
75
|
+
assertPrivatePermissionsBatch([
|
|
76
|
+
{ path: profile.directory, kind: 'directory' },
|
|
77
|
+
...['', '-journal', '-wal', '-shm'].map(suffix => ({
|
|
78
|
+
path: join(profile.directory, `state.sqlite${suffix}`), kind: 'file', optional: suffix !== '',
|
|
79
|
+
})),
|
|
80
|
+
]);
|
|
71
81
|
// Compact setup must not implicitly upgrade or repair an older profile.
|
|
72
82
|
const inspection = new DatabaseSync(join(profile.directory, 'state.sqlite'), { readOnly: true });
|
|
73
83
|
try {
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export type PrivatePathKind = 'file' | 'directory';
|
|
2
|
+
export interface PrivatePath {
|
|
3
|
+
path: string;
|
|
4
|
+
kind: PrivatePathKind;
|
|
5
|
+
/** Missing sidecars are allowed; existing artifacts always require validation. */
|
|
6
|
+
optional?: boolean;
|
|
7
|
+
}
|
|
8
|
+
/** Check ordinary file metadata and POSIX ownership/modes. Windows uses the
|
|
9
|
+
* permissions inherited from the user's directory; Node does not verify ACLs. */
|
|
10
|
+
export declare function assertPrivatePermissionsBatch(paths: readonly PrivatePath[]): void;
|
|
11
|
+
export declare function assertPrivatePermissions(path: string, kind: PrivatePathKind): void;
|
|
12
|
+
/** Apply POSIX owner-only modes before writing; check metadata on Windows. */
|
|
13
|
+
export declare function securePrivatePermissions(path: string, kind: PrivatePathKind): void;
|
|
14
|
+
/**
|
|
15
|
+
* POSIX persists directory entries. Windows has no portable directory-fsync
|
|
16
|
+
* equivalent: callers must fsync the published file, including after a rename
|
|
17
|
+
* or link. This does not promise power-loss durability of the parent namespace.
|
|
18
|
+
*/
|
|
19
|
+
export declare function syncPrivateDirectory(path: string): void;
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { chmodSync, closeSync, constants, fsyncSync, lstatSync, openSync } from 'node:fs';
|
|
2
|
+
import { dirname, resolve, win32 } from 'node:path';
|
|
3
|
+
/** Check ordinary file metadata and POSIX ownership/modes. Windows uses the
|
|
4
|
+
* permissions inherited from the user's directory; Node does not verify ACLs. */
|
|
5
|
+
export function assertPrivatePermissionsBatch(paths) {
|
|
6
|
+
privatePermissionsBatch(paths, false);
|
|
7
|
+
}
|
|
8
|
+
export function assertPrivatePermissions(path, kind) {
|
|
9
|
+
assertPrivatePermissionsBatch([{ path, kind }]);
|
|
10
|
+
}
|
|
11
|
+
/** Apply POSIX owner-only modes before writing; check metadata on Windows. */
|
|
12
|
+
export function securePrivatePermissions(path, kind) {
|
|
13
|
+
privatePermissionsBatch([{ path, kind }], true);
|
|
14
|
+
}
|
|
15
|
+
function privatePermissionsBatch(paths, secure) {
|
|
16
|
+
for (const entry of paths) {
|
|
17
|
+
if (entry.kind !== 'file' && entry.kind !== 'directory')
|
|
18
|
+
throw privatePermissionsError();
|
|
19
|
+
const path = checkedPath(entry.path);
|
|
20
|
+
try {
|
|
21
|
+
const info = inspectPath(path, entry.kind);
|
|
22
|
+
if (process.platform !== 'win32') {
|
|
23
|
+
const mode = entry.kind === 'directory' ? 0o700 : 0o600;
|
|
24
|
+
if (secure)
|
|
25
|
+
chmodSync(path, mode);
|
|
26
|
+
else if ((info.mode & 0o777) !== mode)
|
|
27
|
+
throw privatePermissionsError();
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
catch (error) {
|
|
31
|
+
if (!entry.optional || error.code !== 'ENOENT')
|
|
32
|
+
throw error;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* POSIX persists directory entries. Windows has no portable directory-fsync
|
|
38
|
+
* equivalent: callers must fsync the published file, including after a rename
|
|
39
|
+
* or link. This does not promise power-loss durability of the parent namespace.
|
|
40
|
+
*/
|
|
41
|
+
export function syncPrivateDirectory(path) {
|
|
42
|
+
if (process.platform === 'win32')
|
|
43
|
+
return;
|
|
44
|
+
const descriptor = openSync(path, constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW);
|
|
45
|
+
try {
|
|
46
|
+
fsyncSync(descriptor);
|
|
47
|
+
}
|
|
48
|
+
finally {
|
|
49
|
+
closeSync(descriptor);
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
function checkedPath(path) {
|
|
53
|
+
if (typeof path !== 'string' || path.length === 0 || path.includes('\0'))
|
|
54
|
+
throw privatePermissionsError();
|
|
55
|
+
if (process.platform !== 'win32')
|
|
56
|
+
return resolve(path);
|
|
57
|
+
// Exclude DOS devices, alternate streams and Win32 name aliases. They do not
|
|
58
|
+
// identify an ordinary local file with the same semantics as our callers.
|
|
59
|
+
if (!/^[a-z]:[\\/]/i.test(path) || /[\u0000-\u001f\u007f]/.test(path))
|
|
60
|
+
throw privatePermissionsError();
|
|
61
|
+
for (const component of path.slice(3).split(/[\\/]/)) {
|
|
62
|
+
if (component === '.' || component === '..' || /[<>:"|?*]/.test(component) || /[. ]$/.test(component)
|
|
63
|
+
|| /^(?:con|prn|aux|nul|conin\$|conout\$|com[1-9¹²³]|lpt[1-9¹²³])(?:\.|$)/i.test(component))
|
|
64
|
+
throw privatePermissionsError();
|
|
65
|
+
}
|
|
66
|
+
return win32.resolve(path);
|
|
67
|
+
}
|
|
68
|
+
function inspectPath(path, kind) {
|
|
69
|
+
const parentDirectory = process.platform === 'win32' ? win32.dirname : dirname;
|
|
70
|
+
let ancestor = parentDirectory(path);
|
|
71
|
+
for (;;) {
|
|
72
|
+
if (lstatSync(ancestor).isSymbolicLink())
|
|
73
|
+
throw privatePermissionsError();
|
|
74
|
+
const parent = parentDirectory(ancestor);
|
|
75
|
+
if (parent === ancestor)
|
|
76
|
+
break;
|
|
77
|
+
ancestor = parent;
|
|
78
|
+
}
|
|
79
|
+
const info = lstatSync(path);
|
|
80
|
+
if (info.isSymbolicLink() || (kind === 'directory' ? !info.isDirectory() : !info.isFile()))
|
|
81
|
+
throw privatePermissionsError();
|
|
82
|
+
if (process.platform !== 'win32' && (typeof process.getuid !== 'function' || info.uid !== process.getuid()))
|
|
83
|
+
throw privatePermissionsError();
|
|
84
|
+
return info;
|
|
85
|
+
}
|
|
86
|
+
function privatePermissionsError() {
|
|
87
|
+
return Object.assign(new Error('Private file metadata or permissions could not be verified.'), { code: 'PRIVATE_PERMISSIONS' });
|
|
88
|
+
}
|