@originator-profile/vite-plugin 0.0.1 → 0.6.0-beta.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 +201 -0
- package/NOTICE +5 -0
- package/README.md +190 -43
- package/dist/index.d.ts +32 -0
- package/dist/index.js +252 -0
- package/package.json +55 -8
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -1,45 +1,192 @@
|
|
|
1
1
|
# @originator-profile/vite-plugin
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
##
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@originator-profile/vite-plugin)
|
|
4
|
+
|
|
5
|
+
Vite plugin that signs [Website Profiles](https://docs.originator-profile.org/en/opb/site-profile/) (WSP) and [Content Attestations](https://docs.originator-profile.org/en/opb/content-attestation/) (CA) at build time.
|
|
6
|
+
|
|
7
|
+
```js
|
|
8
|
+
// vite.config.js
|
|
9
|
+
import { defineConfig } from "vite";
|
|
10
|
+
import { originatorProfile } from "@originator-profile/vite-plugin";
|
|
11
|
+
|
|
12
|
+
export default defineConfig({
|
|
13
|
+
plugins: [
|
|
14
|
+
originatorProfile({
|
|
15
|
+
issuers: {
|
|
16
|
+
"dns:example.com": import.meta.env.SIGNING_KEY,
|
|
17
|
+
},
|
|
18
|
+
}),
|
|
19
|
+
],
|
|
20
|
+
});
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Install
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install -D @originator-profile/vite-plugin
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Options
|
|
30
|
+
|
|
31
|
+
### `issuers`
|
|
32
|
+
|
|
33
|
+
**Required.** A mapping of [OP ID](https://docs.originator-profile.org/en/opb/dns-uri-op-id/) to signing key. Each key must be the private key paired with the public key in the issuer's [Core Profile](https://docs.originator-profile.org/en/opb/cp/).
|
|
34
|
+
|
|
35
|
+
Values can be a JWK object or a JSON string (parsed internally).
|
|
36
|
+
|
|
37
|
+
```js
|
|
38
|
+
originatorProfile({
|
|
39
|
+
issuers: {
|
|
40
|
+
"dns:example.com": import.meta.env.SIGNING_KEY_PROD,
|
|
41
|
+
"dns:localhost": import.meta.env.SIGNING_KEY_LOCAL,
|
|
42
|
+
},
|
|
43
|
+
});
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
The plugin looks up the signing key for each WSP and CA by matching its `issuer` field against this mapping.
|
|
47
|
+
|
|
48
|
+
### `expiresIn`
|
|
49
|
+
|
|
50
|
+
Duration until signed credentials expire, relative to build time. Defaults to `"1y"`.
|
|
51
|
+
|
|
52
|
+
Accepts any string supported by [`ms`](https://github.com/vercel/ms), such as `"1y"` (1 year), `"30d"` (30 days), `"12h"` (12 hours), or `"6m"` (6 minutes — note that `m` is minutes, not months).
|
|
53
|
+
|
|
54
|
+
### `wsp.input`
|
|
55
|
+
|
|
56
|
+
Path to the unsigned Site Profile input file, relative to the Vite project root. Defaults to `"./sp.json"`.
|
|
57
|
+
|
|
58
|
+
## WSP Signing
|
|
59
|
+
|
|
60
|
+
Place an unsigned [Site Profile](https://docs.originator-profile.org/en/opb/site-profile/) at `<root>/sp.json`. During build, the plugin signs each WSP in the `sites` array and emits the result to `/.well-known/sp.json`.
|
|
61
|
+
|
|
62
|
+
The `originators` array is passed through as-is. See the [`UnsignedWebsiteProfile` model](https://github.com/originator-profile/originator-profile/blob/main/packages/model/src/unsigned-website-profile.ts) for the schema of each entry in `sites`.
|
|
63
|
+
|
|
64
|
+
**Input** (`sp.json`):
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"originators": [
|
|
69
|
+
{
|
|
70
|
+
"core": "eyJ...",
|
|
71
|
+
"annotations": ["eyJ..."],
|
|
72
|
+
"media": ["eyJ..."]
|
|
73
|
+
}
|
|
74
|
+
],
|
|
75
|
+
"sites": [
|
|
76
|
+
{
|
|
77
|
+
"@context": [
|
|
78
|
+
"https://www.w3.org/ns/credentials/v2",
|
|
79
|
+
"https://originator-profile.org/ns/credentials/v1",
|
|
80
|
+
"https://originator-profile.org/ns/cip/v1",
|
|
81
|
+
{ "@language": "en" }
|
|
82
|
+
],
|
|
83
|
+
"type": ["VerifiableCredential", "WebsiteProfile"],
|
|
84
|
+
"issuer": "dns:example.com",
|
|
85
|
+
"credentialSubject": {
|
|
86
|
+
"id": "https://example.com",
|
|
87
|
+
"type": "WebSite",
|
|
88
|
+
"name": "Example Site",
|
|
89
|
+
"description": "An example website",
|
|
90
|
+
"image": {
|
|
91
|
+
"id": "https://example.com/logo.png"
|
|
92
|
+
},
|
|
93
|
+
"allowedOrigin": ["https://example.com"]
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Output** (`/.well-known/sp.json`):
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"originators": [
|
|
105
|
+
{
|
|
106
|
+
"core": "eyJ...",
|
|
107
|
+
"annotations": ["eyJ..."],
|
|
108
|
+
"media": ["eyJ..."]
|
|
109
|
+
}
|
|
110
|
+
],
|
|
111
|
+
"sites": ["eyJ...signed"]
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## CA Signing
|
|
116
|
+
|
|
117
|
+
Embed unsigned Content Attestations in your HTML as a `<script>` element with type `application/prs.originator-profile.unsigned-cas+json`. During build, the plugin signs each CA and replaces the script with a [Content Attestation Set](https://docs.originator-profile.org/en/opb/content-attestation-set/) using the standard `application/cas+json` type, matching the [embedded method](https://docs.originator-profile.org/en/opb/link-to-html/#embedded-method) in the spec. Any pre-signed `application/cas+json` script in the page is passed through unchanged.
|
|
118
|
+
|
|
119
|
+
See the [`UnsignedContentAttestation` model](https://github.com/originator-profile/originator-profile/blob/main/packages/model/src/content-attestation/unsigned-content-attestation.ts) for the schema of each entry. The `main` property can be set on any entry to mark it as the main content attestation.
|
|
120
|
+
|
|
121
|
+
**Input** (HTML):
|
|
122
|
+
|
|
123
|
+
```html
|
|
124
|
+
<script type="application/prs.originator-profile.unsigned-cas+json">
|
|
125
|
+
[
|
|
126
|
+
{
|
|
127
|
+
"@context": [
|
|
128
|
+
"https://www.w3.org/ns/credentials/v2",
|
|
129
|
+
"https://originator-profile.org/ns/credentials/v1",
|
|
130
|
+
"https://originator-profile.org/ns/cip/v1",
|
|
131
|
+
{ "@language": "en" }
|
|
132
|
+
],
|
|
133
|
+
"type": ["VerifiableCredential", "ContentAttestation"],
|
|
134
|
+
"issuer": "dns:example.com",
|
|
135
|
+
"credentialSubject": {
|
|
136
|
+
"id": "urn:uuid:78550fa7-f846-4e0f-ad5c-8d34461cb95b",
|
|
137
|
+
"type": "Article",
|
|
138
|
+
"headline": "Article Title",
|
|
139
|
+
"image": {
|
|
140
|
+
"id": "https://example.com/image.png"
|
|
141
|
+
},
|
|
142
|
+
"description": "Article description",
|
|
143
|
+
"author": ["Jane Smith"],
|
|
144
|
+
"datePublished": "2025-01-01T00:00:00Z"
|
|
145
|
+
},
|
|
146
|
+
"allowedUrl": ["https://example.com/articles/1"],
|
|
147
|
+
"target": [
|
|
148
|
+
{
|
|
149
|
+
"type": "TextTargetIntegrity",
|
|
150
|
+
"cssSelector": "#article",
|
|
151
|
+
"content": "data:text/html,<article id=\"article\">...</article>"
|
|
152
|
+
}
|
|
153
|
+
],
|
|
154
|
+
"main": true
|
|
155
|
+
}
|
|
156
|
+
]
|
|
157
|
+
</script>
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
**Output** (HTML):
|
|
161
|
+
|
|
162
|
+
```html
|
|
163
|
+
<script type="application/cas+json">
|
|
164
|
+
[{ "attestation": "eyJ...signed", "main": true }]
|
|
165
|
+
</script>
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Entries without `main: true` are serialized as bare JWT strings. Entries with `main: true` are serialized as `{ "attestation": "eyJ...", "main": true }`.
|
|
169
|
+
|
|
170
|
+
## Limitations
|
|
171
|
+
|
|
172
|
+
### `ExternalResourceTargetIntegrity` requires manual `integrity` attribute
|
|
173
|
+
|
|
174
|
+
When using [`ExternalResourceTargetIntegrity`](https://docs.originator-profile.org/en/opb/content-integrity-descriptor/external-resource/), verifiers [locate target elements by matching the `integrity` HTML attribute](https://docs.originator-profile.org/en/opb/content-integrity-descriptor/external-resource/#how-to-identify-element-location). This plugin computes the `integrity` value and includes it in the signed CA, but **does not** automatically add the `integrity` attribute to the corresponding HTML elements.
|
|
175
|
+
|
|
176
|
+
You must manually set the `integrity` attribute on each `<img>`, `<source>`, or other resource element to match the signed value:
|
|
177
|
+
|
|
178
|
+
```html
|
|
179
|
+
<img src="https://example.com/image.png" integrity="sha256-..." />
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### `VisibleTextTargetIntegrity` may not match browser verification
|
|
183
|
+
|
|
184
|
+
[`VisibleTextTargetIntegrity`](https://docs.originator-profile.org/en/opb/content-integrity-descriptor/visible-text/) computes integrity from the "as rendered" visible text (`element.innerText`), which depends on browser layout and CSS. This plugin computes integrity at build time using a DOM parser without rendering, so the result may differ from what the browser extension calculates. Use `TextTargetIntegrity` or `HtmlTargetIntegrity` for reliable build-time integrity computation.
|
|
185
|
+
|
|
186
|
+
### DOM target integrity is computed against the pre-transform HTML
|
|
187
|
+
|
|
188
|
+
When a DOM target (`HtmlTargetIntegrity`, `TextTargetIntegrity`, `VisibleTextTargetIntegrity`) is used without an explicit `content` field, this plugin uses the HTML page **before** the unsigned CA script is replaced with the signed `application/cas+json` Set. As a result, CSS selectors that match elements outside of the unsigned CA script tag are safe, but selectors that target the script's own content (e.g., `script[type="application/cas+json"]`) will not match the served HTML after build.
|
|
189
|
+
|
|
190
|
+
## License
|
|
191
|
+
|
|
192
|
+
Apache-2.0
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { Plugin } from 'vite';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
|
|
4
|
+
declare const OriginatorProfileOptions: z.ZodObject<{
|
|
5
|
+
issuers: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
6
|
+
kty: z.ZodString;
|
|
7
|
+
use: z.ZodOptional<z.ZodString>;
|
|
8
|
+
key_ops: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
9
|
+
alg: z.ZodOptional<z.ZodString>;
|
|
10
|
+
kid: z.ZodString;
|
|
11
|
+
x5u: z.ZodOptional<z.ZodString>;
|
|
12
|
+
x5c: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
13
|
+
x5t: z.ZodOptional<z.ZodString>;
|
|
14
|
+
"x5t#S256": z.ZodOptional<z.ZodString>;
|
|
15
|
+
}, z.core.$loose>]>>;
|
|
16
|
+
expiresIn: z.ZodOptional<z.ZodString>;
|
|
17
|
+
wsp: z.ZodOptional<z.ZodObject<{
|
|
18
|
+
input: z.ZodOptional<z.ZodString>;
|
|
19
|
+
}, z.core.$strip>>;
|
|
20
|
+
}, z.core.$strip>;
|
|
21
|
+
type OriginatorProfileOptions = z.infer<typeof OriginatorProfileOptions>;
|
|
22
|
+
|
|
23
|
+
declare function isLocalPath(value: string): boolean;
|
|
24
|
+
declare function fileToDataUrl(filePath: string): string;
|
|
25
|
+
declare function resolveLocalContent(obj: {
|
|
26
|
+
content?: string | string[];
|
|
27
|
+
} | undefined, baseDir: string): void;
|
|
28
|
+
declare function parseExpiresIn(expiresIn: string, from: Date): Date;
|
|
29
|
+
|
|
30
|
+
declare function originatorProfile(options: OriginatorProfileOptions): Plugin;
|
|
31
|
+
|
|
32
|
+
export { fileToDataUrl, isLocalPath, originatorProfile, parseExpiresIn, resolveLocalContent };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
import { readFileSync } from 'node:fs';
|
|
2
|
+
import { resolve, dirname } from 'node:path';
|
|
3
|
+
import rehypeParse from 'rehype-parse';
|
|
4
|
+
import { unified } from 'unified';
|
|
5
|
+
import { visit } from 'unist-util-visit';
|
|
6
|
+
import { Jwk, UnsignedWebsiteProfile, OriginatorProfile, OpId } from '@originator-profile/model';
|
|
7
|
+
import { addMilliseconds } from 'date-fns';
|
|
8
|
+
import mime from 'mime';
|
|
9
|
+
import ms from 'ms';
|
|
10
|
+
import { ContentAttestation, WebsiteProfile } from '@originator-profile/opvc';
|
|
11
|
+
import { z } from 'zod';
|
|
12
|
+
|
|
13
|
+
function isLocalPath(value) {
|
|
14
|
+
return !value.startsWith("data:") && !/^https?:\/\//.test(value);
|
|
15
|
+
}
|
|
16
|
+
function fileToDataUrl(filePath) {
|
|
17
|
+
const bytes = readFileSync(filePath);
|
|
18
|
+
const mimeType = mime.getType(filePath) ?? "application/octet-stream";
|
|
19
|
+
return `data:${mimeType};base64,${bytes.toString("base64")}`;
|
|
20
|
+
}
|
|
21
|
+
function resolveLocalContent(obj, baseDir) {
|
|
22
|
+
if (!obj?.content) return;
|
|
23
|
+
if (typeof obj.content === "string") {
|
|
24
|
+
if (isLocalPath(obj.content)) {
|
|
25
|
+
obj.content = fileToDataUrl(resolve(baseDir, obj.content));
|
|
26
|
+
}
|
|
27
|
+
} else {
|
|
28
|
+
obj.content = obj.content.map(
|
|
29
|
+
(c) => isLocalPath(c) ? fileToDataUrl(resolve(baseDir, c)) : c
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
function parseExpiresIn(expiresIn, from) {
|
|
34
|
+
let millis;
|
|
35
|
+
try {
|
|
36
|
+
millis = ms(expiresIn);
|
|
37
|
+
} catch {
|
|
38
|
+
millis = void 0;
|
|
39
|
+
}
|
|
40
|
+
if (typeof millis !== "number") {
|
|
41
|
+
throw new Error(
|
|
42
|
+
`Invalid expiresIn: "${expiresIn}". See https://github.com/vercel/ms for accepted formats (e.g., "1y", "30d", "12h").`
|
|
43
|
+
);
|
|
44
|
+
}
|
|
45
|
+
return addMilliseconds(from, millis);
|
|
46
|
+
}
|
|
47
|
+
function parseKey(value, issuer) {
|
|
48
|
+
if (typeof value !== "string") return value;
|
|
49
|
+
const context = issuer ? ` for issuer "${issuer}"` : "";
|
|
50
|
+
let parsed;
|
|
51
|
+
try {
|
|
52
|
+
parsed = JSON.parse(value);
|
|
53
|
+
} catch {
|
|
54
|
+
throw new Error(`Invalid signing key${context}: expected valid JSON`);
|
|
55
|
+
}
|
|
56
|
+
const result = Jwk.safeParse(parsed);
|
|
57
|
+
if (!result.success) {
|
|
58
|
+
throw new Error(
|
|
59
|
+
`Invalid signing key${context}: ${result.error.issues[0].message}`
|
|
60
|
+
);
|
|
61
|
+
}
|
|
62
|
+
return result.data;
|
|
63
|
+
}
|
|
64
|
+
function resolveKey(issuers, issuer) {
|
|
65
|
+
const key = issuers[issuer];
|
|
66
|
+
if (!key) {
|
|
67
|
+
throw new Error(
|
|
68
|
+
`No signing key found for issuer "${issuer}". Registered issuers: ${Object.keys(issuers).join(", ")}`
|
|
69
|
+
);
|
|
70
|
+
}
|
|
71
|
+
return key;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
const DOM_TARGET_TYPES = /* @__PURE__ */ new Set([
|
|
75
|
+
"HtmlTargetIntegrity",
|
|
76
|
+
"TextTargetIntegrity",
|
|
77
|
+
"VisibleTextTargetIntegrity"
|
|
78
|
+
]);
|
|
79
|
+
async function signCas(entries, ctx, baseDir, html) {
|
|
80
|
+
const htmlDataUrl = html ? `data:text/html,${encodeURIComponent(html)}` : void 0;
|
|
81
|
+
return await Promise.all(
|
|
82
|
+
entries.map(async (entry) => {
|
|
83
|
+
const { main, ...uca } = structuredClone(entry);
|
|
84
|
+
resolveLocalContent(
|
|
85
|
+
uca.credentialSubject.image,
|
|
86
|
+
baseDir
|
|
87
|
+
);
|
|
88
|
+
for (const target of uca.target) {
|
|
89
|
+
resolveLocalContent(target, baseDir);
|
|
90
|
+
if (htmlDataUrl && DOM_TARGET_TYPES.has(target.type) && !target.integrity && !target.content) {
|
|
91
|
+
target.content = htmlDataUrl;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
const key = resolveKey(ctx.issuers, uca.issuer);
|
|
95
|
+
const jwt = await ContentAttestation.sign(uca, key, {
|
|
96
|
+
issuedAt: ctx.issuedAt,
|
|
97
|
+
expiredAt: ctx.expiredAt
|
|
98
|
+
});
|
|
99
|
+
return main ? { attestation: jwt, main: true } : jwt;
|
|
100
|
+
})
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const SiteProfileInput = z.object({
|
|
105
|
+
originators: z.array(OriginatorProfile).min(1, "originators must not be empty"),
|
|
106
|
+
sites: z.array(UnsignedWebsiteProfile).min(1, "sites must not be empty")
|
|
107
|
+
});
|
|
108
|
+
async function signSiteProfile(input, ctx, baseDir) {
|
|
109
|
+
const signedSites = await Promise.all(
|
|
110
|
+
input.sites.map(async (originalUwsp) => {
|
|
111
|
+
const uwsp = structuredClone(originalUwsp);
|
|
112
|
+
resolveLocalContent(
|
|
113
|
+
uwsp.credentialSubject.image,
|
|
114
|
+
baseDir
|
|
115
|
+
);
|
|
116
|
+
const key = resolveKey(ctx.issuers, uwsp.issuer);
|
|
117
|
+
return await WebsiteProfile.sign(uwsp, key, {
|
|
118
|
+
issuedAt: ctx.issuedAt,
|
|
119
|
+
expiredAt: ctx.expiredAt
|
|
120
|
+
});
|
|
121
|
+
})
|
|
122
|
+
);
|
|
123
|
+
return {
|
|
124
|
+
originators: input.originators,
|
|
125
|
+
sites: signedSites
|
|
126
|
+
};
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
const ExpiresIn = z.string().refine(
|
|
130
|
+
(v) => {
|
|
131
|
+
try {
|
|
132
|
+
return typeof ms(v) === "number";
|
|
133
|
+
} catch {
|
|
134
|
+
return false;
|
|
135
|
+
}
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
message: 'Invalid duration. See https://github.com/vercel/ms for accepted formats (e.g., "1y", "30d", "12h").'
|
|
139
|
+
}
|
|
140
|
+
);
|
|
141
|
+
const SigningKey = z.union([z.string(), Jwk]);
|
|
142
|
+
const OriginatorProfileOptions = z.object({
|
|
143
|
+
issuers: z.record(OpId, SigningKey).refine((v) => Object.keys(v).length > 0, {
|
|
144
|
+
message: "At least one issuer is required"
|
|
145
|
+
}),
|
|
146
|
+
expiresIn: ExpiresIn.optional(),
|
|
147
|
+
wsp: z.object({
|
|
148
|
+
input: z.string().optional()
|
|
149
|
+
}).optional()
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
async function buildSiteProfile(root, wspInput, signingCtx) {
|
|
153
|
+
const inputPath = resolve(root, wspInput ?? "./sp.json");
|
|
154
|
+
const inputDir = dirname(inputPath);
|
|
155
|
+
const input = JSON.parse(readFileSync(inputPath, "utf-8"));
|
|
156
|
+
return signSiteProfile(SiteProfileInput.parse(input), signingCtx, inputDir);
|
|
157
|
+
}
|
|
158
|
+
const UNSIGNED_CAS_TYPE = "application/prs.originator-profile.unsigned-cas+json";
|
|
159
|
+
const SIGNED_CAS_TYPE = "application/cas+json";
|
|
160
|
+
const htmlParser = unified().use(rehypeParse);
|
|
161
|
+
function findUnsignedCasScripts(html) {
|
|
162
|
+
const tree = htmlParser.parse(html);
|
|
163
|
+
const matches = [];
|
|
164
|
+
visit(tree, "element", (node) => {
|
|
165
|
+
if (node.tagName !== "script") return;
|
|
166
|
+
if (node.properties.type !== UNSIGNED_CAS_TYPE) return;
|
|
167
|
+
const startOffset = node.position?.start.offset;
|
|
168
|
+
const endOffset = node.position?.end.offset;
|
|
169
|
+
if (startOffset === void 0 || endOffset === void 0) return;
|
|
170
|
+
const jsonContent = node.children.map((c) => c.type === "text" ? c.value : "").join("");
|
|
171
|
+
matches.push({ startOffset, endOffset, jsonContent });
|
|
172
|
+
});
|
|
173
|
+
return matches;
|
|
174
|
+
}
|
|
175
|
+
function escapeForScript(json) {
|
|
176
|
+
return json.replace(/<\//g, "<\\/");
|
|
177
|
+
}
|
|
178
|
+
function originatorProfile(options) {
|
|
179
|
+
OriginatorProfileOptions.parse(options);
|
|
180
|
+
let root;
|
|
181
|
+
let issuers;
|
|
182
|
+
let issuedAt;
|
|
183
|
+
let expiredAt;
|
|
184
|
+
return {
|
|
185
|
+
name: "originator-profile",
|
|
186
|
+
configResolved(config) {
|
|
187
|
+
root = config.root;
|
|
188
|
+
issuedAt = /* @__PURE__ */ new Date();
|
|
189
|
+
expiredAt = parseExpiresIn(options.expiresIn ?? "1y", issuedAt);
|
|
190
|
+
issuers = Object.fromEntries(
|
|
191
|
+
Object.entries(options.issuers).map(([id, key]) => [
|
|
192
|
+
id,
|
|
193
|
+
parseKey(key, id)
|
|
194
|
+
])
|
|
195
|
+
);
|
|
196
|
+
},
|
|
197
|
+
configureServer(server) {
|
|
198
|
+
server.middlewares.use(
|
|
199
|
+
"/.well-known/sp.json",
|
|
200
|
+
async (_req, res, next) => {
|
|
201
|
+
try {
|
|
202
|
+
const output = await buildSiteProfile(root, options.wsp?.input, {
|
|
203
|
+
issuers,
|
|
204
|
+
issuedAt,
|
|
205
|
+
expiredAt
|
|
206
|
+
});
|
|
207
|
+
res.setHeader("Content-Type", "application/json");
|
|
208
|
+
res.end(JSON.stringify(output));
|
|
209
|
+
} catch (err) {
|
|
210
|
+
next(err);
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
);
|
|
214
|
+
},
|
|
215
|
+
async transformIndexHtml(html) {
|
|
216
|
+
const matches = findUnsignedCasScripts(html);
|
|
217
|
+
if (matches.length === 0) return html;
|
|
218
|
+
const signingCtx = { issuers, issuedAt, expiredAt };
|
|
219
|
+
const replacements = await Promise.all(
|
|
220
|
+
matches.map(async (m) => {
|
|
221
|
+
const entries = JSON.parse(m.jsonContent);
|
|
222
|
+
const signed = await signCas(entries, signingCtx, root, html);
|
|
223
|
+
return {
|
|
224
|
+
startOffset: m.startOffset,
|
|
225
|
+
endOffset: m.endOffset,
|
|
226
|
+
replacement: `<script type="${SIGNED_CAS_TYPE}">${escapeForScript(JSON.stringify(signed))}<\/script>`
|
|
227
|
+
};
|
|
228
|
+
})
|
|
229
|
+
);
|
|
230
|
+
replacements.sort((a, b) => b.startOffset - a.startOffset);
|
|
231
|
+
let result = html;
|
|
232
|
+
for (const { startOffset, endOffset, replacement } of replacements) {
|
|
233
|
+
result = result.slice(0, startOffset) + replacement + result.slice(endOffset);
|
|
234
|
+
}
|
|
235
|
+
return result;
|
|
236
|
+
},
|
|
237
|
+
async generateBundle() {
|
|
238
|
+
const output = await buildSiteProfile(root, options.wsp?.input, {
|
|
239
|
+
issuers,
|
|
240
|
+
issuedAt,
|
|
241
|
+
expiredAt
|
|
242
|
+
});
|
|
243
|
+
this.emitFile({
|
|
244
|
+
type: "asset",
|
|
245
|
+
fileName: ".well-known/sp.json",
|
|
246
|
+
source: JSON.stringify(output)
|
|
247
|
+
});
|
|
248
|
+
}
|
|
249
|
+
};
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
export { fileToDataUrl, isLocalPath, originatorProfile, parseExpiresIn, resolveLocalContent };
|
package/package.json
CHANGED
|
@@ -1,10 +1,57 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@originator-profile/vite-plugin",
|
|
3
|
-
"version": "0.0.1",
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
"
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
}
|
|
3
|
+
"version": "0.6.0-beta.1",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"homepage": "https://docs.originator-profile.org",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/originator-profile/originator-profile.git",
|
|
9
|
+
"directory": "packages/vite-plugin"
|
|
10
|
+
},
|
|
11
|
+
"publishConfig": {
|
|
12
|
+
"access": "public"
|
|
13
|
+
},
|
|
14
|
+
"type": "module",
|
|
15
|
+
"exports": {
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"default": "./dist/index.js"
|
|
18
|
+
},
|
|
19
|
+
"files": [
|
|
20
|
+
"dist",
|
|
21
|
+
"README.md",
|
|
22
|
+
"LICENSE",
|
|
23
|
+
"NOTICE"
|
|
24
|
+
],
|
|
25
|
+
"dependencies": {
|
|
26
|
+
"date-fns": "^4.1.0",
|
|
27
|
+
"mime": "^4.1.0",
|
|
28
|
+
"ms": "^2.1.3",
|
|
29
|
+
"rehype-parse": "^9.0.1",
|
|
30
|
+
"unified": "^11.0.5",
|
|
31
|
+
"unist-util-visit": "^5.1.0",
|
|
32
|
+
"zod": "^4.3.6",
|
|
33
|
+
"@originator-profile/model": "0.6.0-beta.1",
|
|
34
|
+
"@originator-profile/opvc": "0.6.0-beta.1"
|
|
35
|
+
},
|
|
36
|
+
"peerDependencies": {
|
|
37
|
+
"vite": "^6.0.0 || ^7.0.0 || ^8.0.0"
|
|
38
|
+
},
|
|
39
|
+
"devDependencies": {
|
|
40
|
+
"@types/ms": "2.1.0",
|
|
41
|
+
"eslint": "10.2.0",
|
|
42
|
+
"jose": "6.2.2",
|
|
43
|
+
"pkgroll": "2.27.0",
|
|
44
|
+
"typescript": "6.0.2",
|
|
45
|
+
"vite": "8.0.8",
|
|
46
|
+
"vitest": "4.1.4",
|
|
47
|
+
"eslint-config-originator-profile": "0.6.0-beta.1",
|
|
48
|
+
"@originator-profile/cryptography": "0.6.0-beta.1",
|
|
49
|
+
"@originator-profile/tsconfig": "0.6.0-beta.1"
|
|
50
|
+
},
|
|
51
|
+
"scripts": {
|
|
52
|
+
"build": "pkgroll --clean-dist",
|
|
53
|
+
"test": "vitest run",
|
|
54
|
+
"lint": "eslint --fix .",
|
|
55
|
+
"type-check": "tsc --noEmit"
|
|
56
|
+
}
|
|
57
|
+
}
|