powerbin 0.0.0-stage → 0.1.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.
- package/LICENSE +121 -0
- package/README.md +99 -2
- package/THIRD_PARTY_NOTICES.md +9579 -0
- package/dist/client.js +198 -0
- package/dist/crypto/powerbin_crypto.cjs +176 -0
- package/dist/crypto/powerbin_crypto.d.cts +8 -0
- package/dist/crypto/powerbin_crypto_bg.wasm +0 -0
- package/dist/crypto/powerbin_crypto_bg.wasm.d.ts +7 -0
- package/dist/index.js +105 -0
- package/package.json +47 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
Creative Commons Legal Code
|
|
2
|
+
|
|
3
|
+
CC0 1.0 Universal
|
|
4
|
+
|
|
5
|
+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
|
|
6
|
+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
|
|
7
|
+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
|
|
8
|
+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
|
|
9
|
+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
|
|
10
|
+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
|
|
11
|
+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
|
|
12
|
+
HEREUNDER.
|
|
13
|
+
|
|
14
|
+
Statement of Purpose
|
|
15
|
+
|
|
16
|
+
The laws of most jurisdictions throughout the world automatically confer
|
|
17
|
+
exclusive Copyright and Related Rights (defined below) upon the creator
|
|
18
|
+
and subsequent owner(s) (each and all, an "owner") of an original work of
|
|
19
|
+
authorship and/or a database (each, a "Work").
|
|
20
|
+
|
|
21
|
+
Certain owners wish to permanently relinquish those rights to a Work for
|
|
22
|
+
the purpose of contributing to a commons of creative, cultural and
|
|
23
|
+
scientific works ("Commons") that the public can reliably and without fear
|
|
24
|
+
of later claims of infringement build upon, modify, incorporate in other
|
|
25
|
+
works, reuse and redistribute as freely as possible in any form whatsoever
|
|
26
|
+
and for any purposes, including without limitation commercial purposes.
|
|
27
|
+
These owners may contribute to the Commons to promote the ideal of a free
|
|
28
|
+
culture and the further production of creative, cultural and scientific
|
|
29
|
+
works, or to gain reputation or greater distribution for their Work in
|
|
30
|
+
part through the use and efforts of others.
|
|
31
|
+
|
|
32
|
+
For these and/or other purposes and motivations, and without any
|
|
33
|
+
expectation of additional consideration or compensation, the person
|
|
34
|
+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
|
35
|
+
is an owner of Copyright and Related Rights in the Work, voluntarily
|
|
36
|
+
elects to apply CC0 to the Work and publicly distribute the Work under its
|
|
37
|
+
terms, with knowledge of his or her Copyright and Related Rights in the
|
|
38
|
+
Work and the meaning and intended legal effect of CC0 on those rights.
|
|
39
|
+
|
|
40
|
+
1. Copyright and Related Rights. A Work made available under CC0 may be
|
|
41
|
+
protected by copyright and related or neighboring rights ("Copyright and
|
|
42
|
+
Related Rights"). Copyright and Related Rights include, but are not
|
|
43
|
+
limited to, the following:
|
|
44
|
+
|
|
45
|
+
i. the right to reproduce, adapt, distribute, perform, display,
|
|
46
|
+
communicate, and translate a Work;
|
|
47
|
+
ii. moral rights retained by the original author(s) and/or performer(s);
|
|
48
|
+
iii. publicity and privacy rights pertaining to a person's image or
|
|
49
|
+
likeness depicted in a Work;
|
|
50
|
+
iv. rights protecting against unfair competition in regards to a Work,
|
|
51
|
+
subject to the limitations in paragraph 4(a), below;
|
|
52
|
+
v. rights protecting the extraction, dissemination, use and reuse of data
|
|
53
|
+
in a Work;
|
|
54
|
+
vi. database rights (such as those arising under Directive 96/9/EC of the
|
|
55
|
+
European Parliament and of the Council of 11 March 1996 on the legal
|
|
56
|
+
protection of databases, and under any national implementation
|
|
57
|
+
thereof, including any amended or successor version of such
|
|
58
|
+
directive); and
|
|
59
|
+
vii. other similar, equivalent or corresponding rights throughout the
|
|
60
|
+
world based on applicable law or treaty, and any national
|
|
61
|
+
implementations thereof.
|
|
62
|
+
|
|
63
|
+
2. Waiver. To the greatest extent permitted by, but not in contravention
|
|
64
|
+
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
|
65
|
+
irrevocably and unconditionally waives, abandons, and surrenders all of
|
|
66
|
+
Affirmer's Copyright and Related Rights and associated claims and causes
|
|
67
|
+
of action, whether now known or unknown (including existing as well as
|
|
68
|
+
future claims and causes of action), in the Work (i) in all territories
|
|
69
|
+
worldwide, (ii) for the maximum duration provided by applicable law or
|
|
70
|
+
treaty (including future time extensions), (iii) in any current or future
|
|
71
|
+
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
|
72
|
+
including without limitation commercial, advertising or promotional
|
|
73
|
+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
|
74
|
+
member of the public at large and to the detriment of Affirmer's heirs and
|
|
75
|
+
successors, fully intending that such Waiver shall not be subject to
|
|
76
|
+
revocation, rescission, cancellation, termination, or any other legal or
|
|
77
|
+
equitable action to disrupt the quiet enjoyment of the Work by the public
|
|
78
|
+
as contemplated by Affirmer's express Statement of Purpose.
|
|
79
|
+
|
|
80
|
+
3. Public License Fallback. Should any part of the Waiver for any reason
|
|
81
|
+
be judged legally invalid or ineffective under applicable law, then the
|
|
82
|
+
Waiver shall be preserved to the maximum extent permitted taking into
|
|
83
|
+
account Affirmer's express Statement of Purpose. In addition, to the
|
|
84
|
+
extent the Waiver is so judged Affirmer hereby grants to each affected
|
|
85
|
+
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
|
86
|
+
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
|
87
|
+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
|
88
|
+
maximum duration provided by applicable law or treaty (including future
|
|
89
|
+
time extensions), (iii) in any current or future medium and for any number
|
|
90
|
+
of copies, and (iv) for any purpose whatsoever, including without
|
|
91
|
+
limitation commercial, advertising or promotional purposes (the
|
|
92
|
+
"License"). The License shall be deemed effective as of the date CC0 was
|
|
93
|
+
applied by Affirmer to the Work. Should any part of the License for any
|
|
94
|
+
reason be judged legally invalid or ineffective under applicable law, such
|
|
95
|
+
partial invalidity or ineffectiveness shall not invalidate the remainder
|
|
96
|
+
of the License, and in such case Affirmer hereby affirms that he or she
|
|
97
|
+
will not (i) exercise any of his or her remaining Copyright and Related
|
|
98
|
+
Rights in the Work or (ii) assert any associated claims and causes of
|
|
99
|
+
action with respect to the Work, in either case contrary to Affirmer's
|
|
100
|
+
express Statement of Purpose.
|
|
101
|
+
|
|
102
|
+
4. Limitations and Disclaimers.
|
|
103
|
+
|
|
104
|
+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
|
105
|
+
surrendered, licensed or otherwise affected by this document.
|
|
106
|
+
b. Affirmer offers the Work as-is and makes no representations or
|
|
107
|
+
warranties of any kind concerning the Work, express, implied,
|
|
108
|
+
statutory or otherwise, including without limitation warranties of
|
|
109
|
+
title, merchantability, fitness for a particular purpose, non
|
|
110
|
+
infringement, or the absence of latent or other defects, accuracy, or
|
|
111
|
+
the present or absence of errors, whether or not discoverable, all to
|
|
112
|
+
the greatest extent permissible under applicable law.
|
|
113
|
+
c. Affirmer disclaims responsibility for clearing rights of other persons
|
|
114
|
+
that may apply to the Work or any use thereof, including without
|
|
115
|
+
limitation any person's Copyright and Related Rights in the Work.
|
|
116
|
+
Further, Affirmer disclaims responsibility for obtaining any necessary
|
|
117
|
+
consents, permissions or other rights required for any use of the
|
|
118
|
+
Work.
|
|
119
|
+
d. Affirmer understands and acknowledges that Creative Commons is not a
|
|
120
|
+
party to this document and has no duty or obligation with respect to
|
|
121
|
+
this CC0 or use of the Work.
|
package/README.md
CHANGED
|
@@ -1,3 +1,100 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PowerBin CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Reveal and burn a PowerBin one-time text message from your terminal. Requires
|
|
4
|
+
Node.js 22.12 or later. No account, pairing, global installation, or Rust toolchain
|
|
5
|
+
is needed to reveal a link.
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pnpx powerbin reveal 'https://your-powerbin.example/?link=<id>#<key>'
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Paste the **complete original link**, including the key after `#`, and quote it.
|
|
12
|
+
The CLI claims the ciphertext once, then decrypts it locally using the same Rust
|
|
13
|
+
cryptography as the PowerBin native and browser apps. The key and plaintext are
|
|
14
|
+
never sent to the server.
|
|
15
|
+
|
|
16
|
+
## Output and scripting
|
|
17
|
+
|
|
18
|
+
In a terminal, PowerBin prints the message with a short status. When stdout is
|
|
19
|
+
piped or redirected, it contains the exact UTF-8 message bytes, including the
|
|
20
|
+
original newlines. Status and errors go to stderr.
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
pnpx powerbin reveal '<complete link>' > message.txt
|
|
24
|
+
pnpx powerbin reveal '<complete link>' --raw
|
|
25
|
+
pnpx powerbin --help
|
|
26
|
+
pnpx powerbin --version
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
`--raw` writes exact bytes even in a terminal and suppresses the success status.
|
|
30
|
+
Normal terminal output escapes control characters from the message. Raw output
|
|
31
|
+
is intended for scripts and trusted text.
|
|
32
|
+
|
|
33
|
+
Use `--stdin` to supply a link through standard input instead of including it in
|
|
34
|
+
the command line or shell history:
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
pnpx powerbin reveal --stdin
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Paste one complete link and end the input with EOF, or pipe the link from another
|
|
41
|
+
program. PowerBin does not persist links or messages. Your terminal, clipboard,
|
|
42
|
+
shell, or redirected files may retain them.
|
|
43
|
+
|
|
44
|
+
Exit codes: `0` for success, `1` for a reveal/decryption/output failure, and `2`
|
|
45
|
+
for invalid arguments or a malformed link.
|
|
46
|
+
|
|
47
|
+
## One-time behavior
|
|
48
|
+
|
|
49
|
+
Running `reveal` checks compatibility without consuming the link, then claims it
|
|
50
|
+
once. There is no confirmation prompt. Version 0.1.1 and later require the server
|
|
51
|
+
to report `protocol_version: 2` in its availability response. Older servers and
|
|
52
|
+
legacy v1 links are rejected before the consuming request. Update the PowerBin
|
|
53
|
+
server and browser app together, reload the browser, and create a fresh link.
|
|
54
|
+
|
|
55
|
+
Missing or malformed keys are rejected before contacting the server. A validly
|
|
56
|
+
encoded but incorrect key can still consume the message before decryption fails.
|
|
57
|
+
|
|
58
|
+
The CLI never retries or follows redirects for the consuming request. If the
|
|
59
|
+
response is lost after the server claims the message, it cannot be recovered.
|
|
60
|
+
If saving or printing the plaintext fails after a successful reveal, the link
|
|
61
|
+
has already burned. Do not configure automatic retries around this command.
|
|
62
|
+
|
|
63
|
+
Opening a link in the browser or fetching the readable `curl '<link>'` view only
|
|
64
|
+
checks availability. Browser recipients must select **Reveal & burn** to consume
|
|
65
|
+
it. Curl itself cannot decrypt because the URL fragment is not sent to the server.
|
|
66
|
+
|
|
67
|
+
Links must use HTTPS. Plain HTTP is accepted only for loopback development
|
|
68
|
+
servers (`localhost`, `127.0.0.1`, and `[::1]`).
|
|
69
|
+
|
|
70
|
+
PowerBin is an unaudited demo. A guest link does not authenticate a named sender,
|
|
71
|
+
and burning cannot retract copies already saved or displayed.
|
|
72
|
+
|
|
73
|
+
## Development
|
|
74
|
+
|
|
75
|
+
The CLI uses TypeScript for the command and a small WASM wrapper around the
|
|
76
|
+
repository's shared `crypto` crate. The published package bundles compiled WASM
|
|
77
|
+
and has no runtime npm dependencies or installation scripts.
|
|
78
|
+
|
|
79
|
+
From the repository root:
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
pnpm install --frozen-lockfile
|
|
83
|
+
pnpm run cli:build
|
|
84
|
+
pnpm run cli:test
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Building requires Rust with the `wasm32-unknown-unknown` target and
|
|
88
|
+
`wasm-bindgen-cli` exactly 0.2.129. The build also recognizes this repository's
|
|
89
|
+
existing `.tools/cargo`, `.tools/rustup`, and `.tools/wasm-bindgen` installations.
|
|
90
|
+
The tests decrypt a fixture produced by the native Rust implementation and check
|
|
91
|
+
the real CLI against local HTTP servers.
|
|
92
|
+
|
|
93
|
+
Before releasing, build, run the tests, pack `cli`, and verify the tarball through
|
|
94
|
+
an isolated installation. Publish that verified tarball using the npm account
|
|
95
|
+
that owns the package. The `files` allowlist includes only runtime output,
|
|
96
|
+
documentation, and license notices.
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
CC0-1.0. Third-party Rust dependency licenses are included with the package.
|