@signature-kit/a1 0.2.0 → 0.3.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/CHANGELOG.md +8 -0
- package/README.md +29 -9
- package/dist/config.js +2 -2
- package/dist/signer.d.ts +4 -4
- package/dist/signer.d.ts.map +1 -1
- package/dist/signer.js +25 -15
- package/package.json +5 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
- Emit distinct `SignatureKitError` codes for expired, not-yet-valid, and
|
|
6
|
+
missing Brazilian CPF/CNPJ certificate profile failures.
|
|
7
|
+
|
|
8
|
+
- Report A1 schema decode names as local strings after the core schema-name
|
|
9
|
+
catalog removal; public A1 signing behavior is unchanged.
|
|
10
|
+
|
|
3
11
|
## 0.2.0
|
|
4
12
|
|
|
5
13
|
- Redact presigned-URL credentials from error messages when fetching remote PKCS#12 material.
|
package/README.md
CHANGED
|
@@ -1,25 +1,45 @@
|
|
|
1
1
|
# @signature-kit/a1
|
|
2
2
|
|
|
3
|
-
Local A1 / PKCS#12 signer adapter that exposes signing power through the core SignerAdapter
|
|
3
|
+
Local A1 / PKCS#12 signer adapter that exposes signing power through the core `SignerAdapter` and `Signatures` service contracts.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
|
-
bun add @signature-kit/a1 effect
|
|
8
|
+
bun add @signature-kit/a1 @signature-kit/signatures effect
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
`effect` is a direct runtime dependency. PKCS#12 passwords stay `Redacted` until the explicit parse/import boundary.
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
- `@signature-kit/a1/signer`
|
|
13
|
+
## Public surface
|
|
15
14
|
|
|
16
|
-
|
|
15
|
+
- `@signature-kit/a1/config` — `A1SignerOptionsSchema`, remote-source schemas, and `A1CertificateProfileSchema`.
|
|
16
|
+
- `@signature-kit/a1/signer` — `createA1SignerAdapter`, `loadA1SignerAdapter`, `a1SignerLayer`, `a1SignaturesLayer`, `parseA1CertificateProfile`, `fetchA1Pkcs12`, `a1SignaturesLayerFromUrl`, and `parseA1CertificateProfileFromUrl`.
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
`a1SignaturesLayer(options)` is the usual application-boundary layer for local PDF/XML signing. URL helpers fetch a remote `.pfx`/`.p12` through `SignatureHttpClient`; presigned URLs are redacted in error messages through the diagnostic URL path.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Example
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
```ts
|
|
23
|
+
import { a1SignaturesLayer } from "@signature-kit/a1/signer";
|
|
24
|
+
import { signatures } from "@signature-kit/signatures";
|
|
25
|
+
import { Effect, Redacted } from "effect";
|
|
26
|
+
|
|
27
|
+
declare const content: Uint8Array;
|
|
28
|
+
declare const pfx: Uint8Array;
|
|
29
|
+
|
|
30
|
+
const program = signatures
|
|
31
|
+
.sign({
|
|
32
|
+
content,
|
|
33
|
+
algorithm: "rsa-sha256",
|
|
34
|
+
})
|
|
35
|
+
.pipe(Effect.provide(a1SignaturesLayer({ pfx, password: Redacted.make("secret") })));
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Errors and i18n
|
|
39
|
+
|
|
40
|
+
A1 parse, import, sign, and certificate-profile failures surface as `SignatureKitError` from `@signature-kit/signatures`. Applications can render localized copy through `errorMessage` from `@signature-kit/i18n` with the `signatureKitErrorMessages` catalog from `@signature-kit/signatures`.
|
|
41
|
+
|
|
42
|
+
Docs: <https://signaturekit.dev/en-US/docs/a1-signing/browser-pdf-flow>.
|
|
23
43
|
|
|
24
44
|
## License
|
|
25
45
|
|
package/dist/config.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* A1 signer adapter options.
|
|
3
3
|
*/
|
|
4
|
-
import { redactedStringSchema } from "@signature-kit/
|
|
5
|
-
import { SignatureHttpHeadersSchema } from "@signature-kit/
|
|
4
|
+
import { redactedStringSchema } from "@signature-kit/signatures";
|
|
5
|
+
import { SignatureHttpHeadersSchema } from "@signature-kit/http";
|
|
6
6
|
import { Schema } from "effect";
|
|
7
7
|
export const A1SignerOptionsSchema = Schema.Struct({
|
|
8
8
|
pfx: Schema.Uint8Array,
|
package/dist/signer.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* The first e-signature adapter: A1 / PKCS#12.
|
|
3
3
|
*/
|
|
4
|
-
import { Signatures } from "@signature-kit/
|
|
5
|
-
import { SignatureHttpClient } from "@signature-kit/
|
|
6
|
-
import type { Certificate, SignerAdapter } from "@signature-kit/
|
|
7
|
-
import { SignatureKitError } from "@signature-kit/
|
|
4
|
+
import { Signatures } from "@signature-kit/signatures";
|
|
5
|
+
import { SignatureHttpClient } from "@signature-kit/http";
|
|
6
|
+
import type { Certificate, SignerAdapter } from "@signature-kit/signatures";
|
|
7
|
+
import { SignatureKitError } from "@signature-kit/signatures";
|
|
8
8
|
import { Context, Effect, Layer } from "effect";
|
|
9
9
|
import { type A1CertificateProfile, type A1RemoteFetch, type A1RemoteSource, type A1SignerOptions } from "./config";
|
|
10
10
|
export type A1SignerMaterial = {
|
package/dist/signer.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAsB,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAChG,OAAO,EACL,iBAAiB,EAKlB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAS,OAAO,EAAE,MAAM,EAAE,KAAK,EAA2B,MAAM,QAAQ,CAAC;AAChF,OAAO,EAIL,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,eAAe,EACrB,MAAM,UAAU,CAAC;AAmHlB,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;CAChC,CAAC;;AAEF,qBAAa,QAAS,SAAQ,aAE7B;CAAG;AA+EJ,kFAAkF;AAClF,eAAO,MAAM,qBAAqB,GAAI,aAAa,WAAW,KAAG,aA4DhE,CAAC;AAiBF,mFAAmF;AACnF,eAAO,MAAM,aAAa,GAAI,SAAS,eAAe,KAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CACzC,CAAC;AAExD,gEAAgE;AAChE,eAAO,MAAM,mBAAmB,GAC9B,SAAS,eAAe,KACvB,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,iBAAiB,CACmB,CAAC;AAErE,+EAA+E;AAC/E,eAAO,MAAM,yBAAyB,GACpC,SAAS,eAAe,KACvB,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,iBAAiB,CACa,CAAC;AAEtE,6EAA6E;AAC7E,eAAO,MAAM,iBAAiB,GAC5B,SAAS,eAAe,KACvB,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,iBAAiB,CACkD,CAAC;AAuB/F,0EAA0E;AAC1E,eAAO,MAAM,aAAa,GACxB,QAAQ,aAAa,KACpB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,CAoChE,CAAC;AAEJ,qFAAqF;AACrF,eAAO,MAAM,wBAAwB,GACnC,QAAQ,cAAc,KACrB,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,CAqB9D,CAAC;AAEJ,oFAAoF;AACpF,eAAO,MAAM,gCAAgC,GAC3C,QAAQ,cAAc,KACrB,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,iBAAiB,EAAE,mBAAmB,CAiB1E,CAAC"}
|
package/dist/signer.js
CHANGED
|
@@ -1,17 +1,19 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* The first e-signature adapter: A1 / PKCS#12.
|
|
3
3
|
*/
|
|
4
|
-
import { Signatures } from "@signature-kit/
|
|
5
|
-
import { SignatureHttpClient } from "@signature-kit/
|
|
6
|
-
import { SignatureKitError, SignatureKitErrorCodeValue, SignatureKitOperationValue,
|
|
4
|
+
import { Signatures } from "@signature-kit/signatures";
|
|
5
|
+
import { SignatureHttpClient } from "@signature-kit/http";
|
|
6
|
+
import { SignatureKitError, SignatureKitErrorCodeValue, SignatureKitOperationValue, SignInputSchema, VerifyInputSchema, } from "@signature-kit/signatures";
|
|
7
7
|
import { daysUntilExpiry, parseCertificate, toSignerIdentity } from "@signature-kit/certificates";
|
|
8
8
|
import { pemToDer } from "@signature-kit/crypto/pem";
|
|
9
|
-
import { Context, Effect, Layer, Redacted, Schema } from "effect";
|
|
9
|
+
import { Clock, Context, Effect, Layer, Match, Redacted, Schema } from "effect";
|
|
10
10
|
import { A1RemoteFetchSchema, A1RemoteSourceSchema, A1SignerOptionsSchema, } from "./config";
|
|
11
11
|
const RSA_ALGORITHM_NAME = "RSASSA-PKCS1-v1_5";
|
|
12
|
+
const RsaAlgorithmHashSchema = Schema.Literals(["SHA-1", "SHA-256", "SHA-512"]);
|
|
13
|
+
const rsaAlgorithmHash = (algorithm) => Match.value(algorithm).pipe(Match.when("rsa-sha1", () => "SHA-1"), Match.when("rsa-sha256", () => "SHA-256"), Match.when("rsa-sha512", () => "SHA-512"), Match.exhaustive);
|
|
12
14
|
const rsaAlgorithm = (algorithm) => ({
|
|
13
15
|
name: RSA_ALGORITHM_NAME,
|
|
14
|
-
hash: algorithm
|
|
16
|
+
hash: rsaAlgorithmHash(algorithm),
|
|
15
17
|
});
|
|
16
18
|
/** Copy into a fresh ArrayBuffer-backed view so it satisfies `BufferSource`. */
|
|
17
19
|
const toBufferSource = (data) => {
|
|
@@ -71,22 +73,30 @@ const loadA1Certificate = (options) => Schema.decodeUnknownEffect(A1SignerOption
|
|
|
71
73
|
retryable: false,
|
|
72
74
|
reason: "Invalid A1 signer options.",
|
|
73
75
|
operation: SignatureKitOperationValue.schemaDecode,
|
|
74
|
-
schemaName:
|
|
76
|
+
schemaName: "A1SignerOptions",
|
|
75
77
|
issueMessage: String(issue),
|
|
76
78
|
});
|
|
77
79
|
}), Effect.flatMap((valid) => parseCertificate(valid.pfx, valid.password)));
|
|
78
80
|
const certificateProfile = (certificate) => Effect.gen(function* () {
|
|
79
|
-
|
|
81
|
+
const currentTime = yield* Clock.currentTimeMillis;
|
|
82
|
+
if (currentTime > certificate.validity.notAfter.getTime()) {
|
|
80
83
|
return yield* Effect.fail(new SignatureKitError({
|
|
81
|
-
code: SignatureKitErrorCodeValue.
|
|
84
|
+
code: SignatureKitErrorCodeValue.certificateExpired,
|
|
82
85
|
retryable: false,
|
|
83
|
-
reason: `A1 certificate
|
|
86
|
+
reason: `A1 certificate expired at ${certificate.validity.notAfter.toISOString()}.`,
|
|
87
|
+
}));
|
|
88
|
+
}
|
|
89
|
+
if (currentTime < certificate.validity.notBefore.getTime()) {
|
|
90
|
+
return yield* Effect.fail(new SignatureKitError({
|
|
91
|
+
code: SignatureKitErrorCodeValue.certificateNotYetValid,
|
|
92
|
+
retryable: false,
|
|
93
|
+
reason: `A1 certificate is not valid before ${certificate.validity.notBefore.toISOString()}.`,
|
|
84
94
|
}));
|
|
85
95
|
}
|
|
86
96
|
const document = certificate.brazilian.cnpj ?? certificate.brazilian.cpf;
|
|
87
97
|
if (document === null) {
|
|
88
98
|
return yield* Effect.fail(new SignatureKitError({
|
|
89
|
-
code: SignatureKitErrorCodeValue.
|
|
99
|
+
code: SignatureKitErrorCodeValue.missingBrIdentifier,
|
|
90
100
|
retryable: false,
|
|
91
101
|
reason: "A1 certificate does not contain a Brazilian CPF or CNPJ.",
|
|
92
102
|
}));
|
|
@@ -120,7 +130,7 @@ export const createA1SignerAdapter = (certificate) => {
|
|
|
120
130
|
retryable: false,
|
|
121
131
|
reason: "Invalid sign input.",
|
|
122
132
|
operation: SignatureKitOperationValue.schemaDecode,
|
|
123
|
-
schemaName:
|
|
133
|
+
schemaName: "SignInput",
|
|
124
134
|
issueMessage: String(issue),
|
|
125
135
|
});
|
|
126
136
|
}), Effect.flatMap((valid) => signingKey(valid.algorithm).pipe(Effect.flatMap((key) => signWithKey(key, valid.algorithm, valid.content)), Effect.map((signature) => ({ algorithm: valid.algorithm, signature }))))),
|
|
@@ -130,7 +140,7 @@ export const createA1SignerAdapter = (certificate) => {
|
|
|
130
140
|
retryable: false,
|
|
131
141
|
reason: "Invalid verify input.",
|
|
132
142
|
operation: SignatureKitOperationValue.schemaDecode,
|
|
133
|
-
schemaName:
|
|
143
|
+
schemaName: "VerifyInput",
|
|
134
144
|
issueMessage: String(issue),
|
|
135
145
|
});
|
|
136
146
|
}), Effect.flatMap((valid) => verificationKey(valid.algorithm).pipe(Effect.flatMap((key) => verifyWithKey(key, valid.algorithm, valid.signature, valid.content)), Effect.map((val32) => ({ valid: val32, algorithm: valid.algorithm }))))),
|
|
@@ -174,7 +184,7 @@ export const fetchA1Pkcs12 = (source) => Schema.decodeUnknownEffect(A1RemoteFetc
|
|
|
174
184
|
code: SignatureKitErrorCodeValue.invalidInput,
|
|
175
185
|
retryable: false,
|
|
176
186
|
operation: SignatureKitOperationValue.schemaDecode,
|
|
177
|
-
schemaName:
|
|
187
|
+
schemaName: "A1RemoteFetch",
|
|
178
188
|
issueMessage: String(issue),
|
|
179
189
|
})), Effect.flatMap((valid) => SignatureHttpClient.use((http) => http
|
|
180
190
|
.requestBytes({
|
|
@@ -195,7 +205,7 @@ export const a1SignaturesLayerFromUrl = (source) => Layer.effect(Signatures, Sch
|
|
|
195
205
|
code: SignatureKitErrorCodeValue.invalidInput,
|
|
196
206
|
retryable: false,
|
|
197
207
|
operation: SignatureKitOperationValue.schemaDecode,
|
|
198
|
-
schemaName:
|
|
208
|
+
schemaName: "A1RemoteSource",
|
|
199
209
|
issueMessage: String(issue),
|
|
200
210
|
})), Effect.flatMap((valid) => fetchA1Pkcs12(valid).pipe(Effect.flatMap((pfx) => loadA1Certificate({ pfx, password: valid.password })), Effect.map(createA1SignerAdapter)))));
|
|
201
211
|
/** Parse and validate the A1 certificate metadata from a remote (URL) container. */
|
|
@@ -203,6 +213,6 @@ export const parseA1CertificateProfileFromUrl = (source) => Schema.decodeUnknown
|
|
|
203
213
|
code: SignatureKitErrorCodeValue.invalidInput,
|
|
204
214
|
retryable: false,
|
|
205
215
|
operation: SignatureKitOperationValue.schemaDecode,
|
|
206
|
-
schemaName:
|
|
216
|
+
schemaName: "A1RemoteSource",
|
|
207
217
|
issueMessage: String(issue),
|
|
208
218
|
})), Effect.flatMap((valid) => fetchA1Pkcs12(valid).pipe(Effect.flatMap((pfx) => parseA1CertificateProfile({ pfx, password: valid.password })))));
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@signature-kit/a1",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist",
|
|
@@ -29,9 +29,10 @@
|
|
|
29
29
|
"test": "vitest run"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@signature-kit/certificates": "^0.2.
|
|
33
|
-
"@signature-kit/
|
|
34
|
-
"@signature-kit/
|
|
32
|
+
"@signature-kit/certificates": "^0.2.1",
|
|
33
|
+
"@signature-kit/crypto": "^0.2.1",
|
|
34
|
+
"@signature-kit/http": "^0.1.0",
|
|
35
|
+
"@signature-kit/signatures": "^0.1.0",
|
|
35
36
|
"effect": "4.0.0-beta.86"
|
|
36
37
|
},
|
|
37
38
|
"nx": {
|