@gerege-systems/eid-mongolia-sdk 0.14.2 → 0.15.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 +127 -42
- package/dist/{browser-CSZjH9Xs.d.cts → browser-8k_VDSP8.d.cts} +8 -183
- package/dist/{browser-CSZjH9Xs.d.ts → browser-BZ3hvv6-.d.ts} +8 -183
- package/dist/browser.d.cts +2 -1
- package/dist/browser.d.ts +2 -1
- package/dist/browser.js +5 -3
- package/dist/chunk-REWNE7PO.js +51 -0
- package/dist/{chunk-DXVHOZO7.js → chunk-TB2KQH3W.js} +1 -46
- package/dist/errors-Z7SgLVTr.d.cts +149 -0
- package/dist/errors-Z7SgLVTr.d.ts +149 -0
- package/dist/index.cjs +222 -245
- package/dist/index.d.cts +147 -156
- package/dist/index.d.ts +147 -156
- package/dist/index.js +209 -230
- package/dist/pades.cjs +3520 -0
- package/dist/pades.d.cts +128 -0
- package/dist/pades.d.ts +128 -0
- package/dist/pades.js +3484 -0
- package/package.json +16 -6
package/README.md
CHANGED
|
@@ -7,7 +7,8 @@ RP-API v3, Smart-ID нийцтэй. Бүрэн баримт: <https://developer.
|
|
|
7
7
|
> ⚠️ SDK **backend**-д ажиллана: бүх дуудлага API secret (`rp_sk_…`)-ээр баталгаажна, secret-ийг браузер/гар утсанд
|
|
8
8
|
> хэзээ ч задлахгүй. Браузерт зөвхөн таны backend-ийн өгсөн холбоос/QR/товч харагдана — «eID-ээр нэвтрэх» товч
|
|
9
9
|
> (`/button`) ч таны backend-ийг л дуудна (§1a). `@gerege-systems/eid-mongolia-sdk/browser`-ийн legacy device-link
|
|
10
|
-
> туслахууд 2026-10-07-оос ажиллахгүй (§4).
|
|
10
|
+
> туслахууд 2026-10-07-оос ажиллахгүй (§4). Үл хамаарах: `@gerege-systems/eid-mongolia-sdk/pades` (клиент талын PDF
|
|
11
|
+
> гарын үсэг, secret-гүй) хөтөч болон Node-д ажиллана (§3d).
|
|
11
12
|
|
|
12
13
|
## Суулгах
|
|
13
14
|
|
|
@@ -15,7 +16,8 @@ RP-API v3, Smart-ID нийцтэй. Бүрэн баримт: <https://developer.
|
|
|
15
16
|
npm install @gerege-systems/eid-mongolia-sdk
|
|
16
17
|
```
|
|
17
18
|
|
|
18
|
-
Node.js ≥
|
|
19
|
+
Node.js ≥ 18 (global `fetch`, `node:crypto`) — бүх entry (`.`, `/browser`, `/button`, `/pades`), CI-д Node 18 / 20 / 22-оор шалгагдана.
|
|
20
|
+
`/pades` мөн орчин үеийн хөтөчид (Web Crypto) ажиллана.
|
|
19
21
|
|
|
20
22
|
## 1. RP бүртгүүлэх
|
|
21
23
|
|
|
@@ -235,7 +237,7 @@ UTF8String/PrintableString/BMPString. `parseSubject` нь зөвхөн задл
|
|
|
235
237
|
> жагсаалтаар ирдэг; Smart-ID ба eID-д Notification төрлийн device link **байхгүй** (CA `docs/DEVICE_LINK_V3.md` §3).
|
|
236
238
|
> Хуучин `/dl?sessionId&vc` холбоос (`deviceLink`) push session-д ч юу ч өгөхгүй (сервер `DEVICE_LINK_REQUIRED`).
|
|
237
239
|
> Иргэн RP-ийг eID апптай ижил утсан дээр нээсэн бол push-ийн оронд **device-link Web2App** урсгал хэрэглэ
|
|
238
|
-
> (`auth.deviceLink*` / `
|
|
240
|
+
> (`auth.deviceLink*` / `signPdfDigest({ flow: "device-link" })` + `buildDeviceLink(…, "Web2App")`, §4) — товч аппыг шууд
|
|
239
241
|
> нээж, callback-аар буцна. Push-д «eID аппаа нээнэ үү» гэсэн текст л хангалттай.
|
|
240
242
|
|
|
241
243
|
## 3. Гарын үсэг (qualified signature)
|
|
@@ -324,42 +326,22 @@ const { representations } = await eid.organization.getRepresentations("PNOMN-123
|
|
|
324
326
|
// → [{ orgEtsi: "NTRMN-6235972", orgName: "Гэрэгэ Системс ХХК", role: "ceo", roleLabel: "Гүйцэтгэх захирал",
|
|
325
327
|
// rightType: "ADMIN", rightTypeLabel: "Админ", source: "REGISTRY", sourceLabel: "Улсын бүртгэл", … }]
|
|
326
328
|
|
|
327
|
-
// 2. PDF (
|
|
329
|
+
// 2. PDF: §3d (клиент талын PAdES) — signPdfDigest({ …, onBehalfOf }) + prepare({ claimedRole: rep.claimedRole }).
|
|
330
|
+
// 3. Raw digest гарын үсэг: eid.sign.digestByEtsi(id, digest, interactions, { onBehalfOf: "NTRMN-6235972" })
|
|
331
|
+
// — CMS-ийг та угсардаг тул мэдүүлсэн үүргийг (signer-attributes-v2) өөрөө нэмнэ.
|
|
328
332
|
try {
|
|
329
|
-
|
|
330
|
-
pdf: pdfBytes, fileName: "Гэрээ №12.pdf",
|
|
331
|
-
signer: { etsi: "PNOMN-12345678" }, flow: "notification",
|
|
332
|
-
onBehalfOf: "NTRMN-6235972",
|
|
333
|
-
});
|
|
334
|
-
showToUser(s.vc);
|
|
335
|
-
const r = await eid.session.waitForResult(s.sessionId);
|
|
336
|
-
// MUST: endResult OK, pdf.documentStatus READY, pdf.signer.onBehalfOf = хүссэн байгууллага,
|
|
337
|
-
// татсан файлын SHA-256 = pdf.outSha256, validation.indication "valid", ltv true.
|
|
338
|
-
if (r.pdf?.documentStatus !== "READY" || r.pdf.signer?.onBehalfOf !== "NTRMN-6235972") throw new Error("…");
|
|
339
|
-
const signed = await eid.pdf.documentVerified(s.sessionId, r.pdf); // SHA-256 ≠ pdf.outSha256 → ValidationError
|
|
340
|
-
console.log(r.pdf.signer.claimedRole); // "Гүйцэтгэх захирал, Гэрэгэ Системс ХХК (NTRMN-6235972)"
|
|
333
|
+
/* … */
|
|
341
334
|
} catch (e) {
|
|
342
335
|
if ((e instanceof ForbiddenError || e instanceof ApiError) && e.code) {
|
|
343
336
|
// REPRESENTATION_DENIED | REPRESENTATION_PENDING | REPRESENTATION_EXPIRED | ORG_NOT_ACTIVE |
|
|
344
|
-
// SIGNER_UNIDENTIFIED (403) · ORG_NOT_FOUND (404) · REPRESENTATION_REVOKED (403,
|
|
337
|
+
// SIGNER_UNIDENTIFIED (403) · ORG_NOT_FOUND (404) · REPRESENTATION_REVOKED (403, бүртгэлийн үед)
|
|
345
338
|
}
|
|
346
339
|
throw e;
|
|
347
340
|
}
|
|
348
|
-
|
|
349
|
-
// Raw digest гарын үсэгт ч мөн: eid.sign.digestByEtsi(id, digest, interactions, { onBehalfOf: "NTRMN-6235972" })
|
|
350
|
-
// — CMS/PDF-ийг та угсардаг тул мэдүүлсэн үүргийг (signer-attributes-v2) өөрөө нэмнэ.
|
|
351
341
|
```
|
|
352
342
|
|
|
353
|
-
|
|
354
|
-
`
|
|
355
|
-
(харуулсан урсгалаа). Гарын үсэгтэй PDF-ийг
|
|
356
|
-
`pdf.document()`-ийн оронд `pdf.documentVerified(sessionId, r.pdf)`-аар тат — `READY` + `outSha256` тулгалтыг хийнэ.
|
|
357
|
-
|
|
358
|
-
Түр алдаа — `ApiError.retryable` үнэн, `retryAfterMs`-ийн (CA-ийн `Retry-After`, секунд эсвэл огноо) дараа давтана:
|
|
359
|
-
prepare 429 `PDF_PREPARE_BUSY`, 503 `LTV_UNAVAILABLE` / `TSA_UNAVAILABLE`; document 503 `DOCUMENT_PENDING`,
|
|
360
|
-
`TSA_UNAVAILABLE`, `LTV_UNAVAILABLE` (`RETRYABLE_ERROR_CODES`). `headers` — хариуны header. PDF дуудлагын хугацаа
|
|
361
|
-
`pdfTimeoutMs` (анхдагч 80000). `pdf.document` санах ойд `pdfMaxBytes` (анхдагч `DEFAULT_PDF_MAX_BYTES` = 64 MiB)
|
|
362
|
-
хүртэл уншина; хэтэрвэл `ResponseTooLargeError`. JSON хариу 4 MiB-ээс хэтэрвэл мөн `ResponseTooLargeError` (таслахгүй).
|
|
343
|
+
Түр алдаа — `ApiError.retryable` үнэн, `retryAfterMs`-ийн (CA-ийн `Retry-After`, секунд эсвэл огноо) дараа давтана
|
|
344
|
+
(`RETRYABLE_ERROR_CODES`). `headers` — хариуны header. JSON хариу 4 MiB-ээс хэтэрвэл `ResponseTooLargeError` (таслахгүй).
|
|
363
345
|
`getRepresentations`-ийн `raw` — серверийн түүхий JSON.
|
|
364
346
|
|
|
365
347
|
**Хүнд харуулахдаа `roleLabel` / `rightTypeLabel` / `sourceLabel` ашигла** (representations болон session-ий
|
|
@@ -368,9 +350,7 @@ prepare 429 `PDF_PREPARE_BUSY`, 503 `LTV_UNAVAILABLE` / `TSA_UNAVAILABLE`; docum
|
|
|
368
350
|
машин утга, өөрөө орчуулахгүй. Хэл: `new EidClient({ …, language: "en" })` → дуудлага бүрд `Accept-Language`; анхдагч
|
|
369
351
|
илгээхгүй (сервер mn). Хуучин CA-д эдгээр талбар байхгүй.
|
|
370
352
|
|
|
371
|
-
|
|
372
|
-
Session-ий `onBehalfOf` блок (`role`/`roleLabel`/`rightType`/`rightTypeLabel`) нь хариу угсрах үеийн бүртгэл; `pdf.signer.onBehalfOf`/`claimedRole`
|
|
373
|
-
нь баримтад бичигдсэн утга.
|
|
353
|
+
Session-ий `onBehalfOf` блок (`role`/`roleLabel`/`rightType`/`rightTypeLabel`) нь хариу угсрах үеийн бүртгэл.
|
|
374
354
|
|
|
375
355
|
## 3b. Иргэний PKI самбар (`PKI_READ` эрх)
|
|
376
356
|
|
|
@@ -394,14 +374,111 @@ const ch = await eid.token.authChallenge();
|
|
|
394
374
|
const digest = tokenAuthDigest(ch.rpUUID, ch.challenge); // токен CKM_ECDSA → түүхий r||s
|
|
395
375
|
const who = await eid.token.authVerify(ch.challengeId, authCertDer, rs);
|
|
396
376
|
|
|
397
|
-
// токеноор PDF (
|
|
398
|
-
const p = await eid.pdf.tokenPrepare({ pdf, fileName: "Гэрээ.pdf", signerEtsi, certificate: signCertDer });
|
|
399
|
-
const rs = /* токен (PKCS#11): CKM_ECDSA(p.hashToSign) → түүхий r||s, 64 байт — p.expiresAt хүртэл */ new Uint8Array(64);
|
|
400
|
-
const blk = await eid.pdf.tokenFinalize(p.signingId, rs); // READY; 503 DOCUMENT_PENDING → ижил rs-ийг дахин
|
|
401
|
-
const signed = await eid.pdf.tokenDocument(p.signingId); // SHA-256 = blk.outSha256 тулга
|
|
377
|
+
// токеноор PDF: §3d — prepare() → токен CKM_ECDSA(dtbs) → r||s → complete() → registerSignature() (sessionID-гүй, medium "token")
|
|
402
378
|
```
|
|
403
379
|
|
|
404
|
-
`/token/auth
|
|
380
|
+
`/token/auth/*` нь CA-д байгаа ч `/.well-known/eid`-д хараахан жагсаагдаагүй (гэрээний тест WARN).
|
|
381
|
+
|
|
382
|
+
## 3d. PDF гарын үсэг (PAdES, клиент тал) — `@gerege-systems/eid-mongolia-sdk/pades`
|
|
383
|
+
|
|
384
|
+
**PDF eID-ийн сервер рүү ОЧИХГҮЙ** (Smart-ID / DigiDoc загвар). Баримтыг таны тал (браузер эсвэл Node) НАТИВ
|
|
385
|
+
TypeScript-ээр (WASM-гүй, Web Crypto) угсарна; CA зөвхөн 32 байт DTBS-д гарын үсгийн session (ердийн
|
|
386
|
+
`RAW_DIGEST_SIGNATURE`) ба CMS-ийн бүртгэлийг хийнэ. Гаралт: PAdES-BASELINE-LT (цагийн тэмдэг tsa.timeserver.mn, OCSP/CRL
|
|
387
|
+
DSS-д), Adobe / EU DSS-д «LTV enabled», баталгаажуулах (QR) хуудастай (mn анхдагч / en). Go reference
|
|
388
|
+
(`eid-mongolia-sdk-go/pades`, профайл `pades-client/1`)-тэй **байт-ижил** — conformance golden-оор CI-д шалгагдана.
|
|
389
|
+
|
|
390
|
+
| Функц | Хаана | Тайлбар |
|
|
391
|
+
|---|---|---|
|
|
392
|
+
| `prepare(pdf, { signerCert, claimedRole?, verifyPage?, fileName?, lang?, docId?, … })` | браузер / Node | `{ dtbs, digest, docId, state }` — сүлжээгүй |
|
|
393
|
+
| `eid.signPdfDigest({ dtbs, fileName, signer, flow?, onBehalfOf? })` | RP backend | DTBS-д гарын үсгийн session (push эсвэл device-link) |
|
|
394
|
+
| `complete(state, signature)` | браузер / Node | TSA + OCSP/CRL → `{ pdf, cms, docId, outSha256, inSha256, hasPage, pageSha256, … }` |
|
|
395
|
+
| `eid.registerSignature(registrationFromCompleted(done, { fileName, sessionID }))` | RP backend | `POST /pdf/signatures` — `/verify/{docID}` бүртгэл |
|
|
396
|
+
|
|
397
|
+
`/pades` хөтчийн bundle ~125 KB gzip (Noto Sans фонт asset-тэй, CI-д ≤ 300 KB); үндсэн entry үүнийг агуулахгүй. `/pades` (ба бүх багц) **Node ≥ 18** (CI: 18 / 20 / 22),
|
|
398
|
+
орчин үеийн хөтөч. Браузерийн CSP: `connect-src https://tsa.timeserver.mn https://ocsp.eidmongolia.mn
|
|
399
|
+
https://crl.eidmongolia.mn`. Хөтөчид гэрчилгээний `http://` AIA/CDP-г зөвхөн эдгээр хостод `https://` болгоно; үндэсний
|
|
400
|
+
CA-ийн CRL (`esign.gov.mn`) нь `crl.eidmongolia.mn` толин хуулбараас (бүх платформд). Шалгагч (`verify`) энд
|
|
401
|
+
**байхгүй** — бүрэн криптограф шалгалт Go backend SDK-д; `prepare` нь өмнөх гарын үсгийг «хөнгөн» шалгуураар (бүтэц,
|
|
402
|
+
CMS гарын үсэг, eID олгогч, timestamp, DSS) л шалгана.
|
|
403
|
+
|
|
404
|
+
**Зурагчийн гэрчилгээ.** `prepare` иргэний SIGN гэрчилгээг (`signingCertificateV2`) шаарддаг тул session-оос ӨМНӨ
|
|
405
|
+
хэрэгтэй — одоогоор `eid.person.certificates(etsi)` (`PKI_READ`; `type: "SIGN"`, `status: "VALID"`, `keyMedium: "MOBILE"`
|
|
406
|
+
мөрийн `certValue` + `documentNumber`). Session-ийг тэр `documentNumber`-ээр эхлүүлнэ — өөр төхөөрөмж зурвал `complete`
|
|
407
|
+
`SIGNATURE_INVALID`.
|
|
408
|
+
|
|
409
|
+
### Вэб RP (браузер prepare/complete, backend session)
|
|
410
|
+
|
|
411
|
+
```ts
|
|
412
|
+
// ── браузер ─────────────────────────────────────────────────────────────────────────────
|
|
413
|
+
import { prepare, complete } from "@gerege-systems/eid-mongolia-sdk/pades";
|
|
414
|
+
|
|
415
|
+
const { signerCert, documentNumber } = await api("/sign/pdf/signer"); // backend: person.certificates
|
|
416
|
+
const p = await prepare(pdfBytes, {
|
|
417
|
+
signerCert, verifyPage: true, fileName: "Гэрээ №12.pdf",
|
|
418
|
+
claimedRole, // байгууллагаар бол getRepresentations()-ийн claimedRole ЯГ ХЭВЭЭР
|
|
419
|
+
});
|
|
420
|
+
await idb.put("pades-state", p.state); // хуудас дахин ачаалагдаж болно
|
|
421
|
+
const s = await api("/sign/pdf/start", { dtbs: b64(p.dtbs), documentNumber, fileName: "Гэрээ №12.pdf" });
|
|
422
|
+
showToUser(s.vc); // эсвэл backend-ийн QR (§4)
|
|
423
|
+
const { signature } = await api(`/sign/pdf/${s.sessionId}/result`); // backend poll + validateSign
|
|
424
|
+
const done = await complete(p.state, signature); // TSA + OCSP/CRL + DSS
|
|
425
|
+
const { pdf, signerCert: _c, ...meta } = done; // PDF backend рүү очихгүй
|
|
426
|
+
await api(`/sign/pdf/${s.sessionId}/register`, { ...meta, cms: b64(done.cms) });
|
|
427
|
+
download(done.pdf, "Гэрээ №12.pdf");
|
|
428
|
+
|
|
429
|
+
// ── RP backend (Node) ─────────────────────────────────────────────────────────────────────
|
|
430
|
+
// /sign/pdf/start — sessionSecret (device-link) backend-ээс гарахгүй; s.digest-ийг session-д хадгал.
|
|
431
|
+
const s = await eid.signPdfDigest({
|
|
432
|
+
dtbs: req.body.dtbs, fileName: req.body.fileName,
|
|
433
|
+
signer: { documentNumber: req.body.documentNumber }, // эсвэл { etsi }
|
|
434
|
+
onBehalfOf: "NTRMN-6235972", // заавал биш
|
|
435
|
+
});
|
|
436
|
+
store(s.sessionId, { digest: s.digest, fileName: req.body.fileName });
|
|
437
|
+
// /sign/pdf/:id/result
|
|
438
|
+
const r = await eid.session.waitForResult(sessionId);
|
|
439
|
+
const sig = eid.validator.validateSign(r, store.get(sessionId).digest, { expectedFlowType: "Notification" });
|
|
440
|
+
reply({ signature: sig.signatureValueB64 });
|
|
441
|
+
// /sign/pdf/:id/register — CA CMS-ийг өөрөө шалгана (session digest = SHA-256(signedAttrs), cert, claimedRole)
|
|
442
|
+
// registrationFromCompleted: CA dto-той яг ижил бие (hasPage илгээхгүй, pageSha256 зөвхөн хуудастай үед); cms base64 ч болно.
|
|
443
|
+
const reg = await eid.registerSignature(registrationFromCompleted(req.body, {
|
|
444
|
+
fileName: store.get(sessionId).fileName, sessionID: sessionId, onBehalfOf: "NTRMN-6235972" }));
|
|
445
|
+
reply({ verifyUrl: reg.verifyUrl });
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
### Зөвхөн Node (backend бүгдийг хийнэ)
|
|
449
|
+
|
|
450
|
+
```ts
|
|
451
|
+
import { registrationFromCompleted } from "@gerege-systems/eid-mongolia-sdk";
|
|
452
|
+
import { prepare, complete, PadesError } from "@gerege-systems/eid-mongolia-sdk/pades";
|
|
453
|
+
|
|
454
|
+
const p = await prepare(pdfBytes, { signerCert, verifyPage: true, fileName: "Гэрээ №12.pdf" });
|
|
455
|
+
const s = await eid.signPdfDigest({ dtbs: p.dtbs, fileName: "Гэрээ №12.pdf", signer: { documentNumber } });
|
|
456
|
+
showToUser(s.vc);
|
|
457
|
+
const r = await eid.session.waitForResult(s.sessionId);
|
|
458
|
+
const sig = eid.validator.validateSign(r, s.digest);
|
|
459
|
+
let done;
|
|
460
|
+
for (let i = 0; ; i++) {
|
|
461
|
+
try {
|
|
462
|
+
done = await complete(p.state, sig.signatureValueB64);
|
|
463
|
+
break;
|
|
464
|
+
} catch (e) {
|
|
465
|
+
if (e instanceof PadesError && e.retryable && i < 3) continue; // TSA_UNAVAILABLE / LTV_UNAVAILABLE — ижил state+гарын үсэг
|
|
466
|
+
throw e;
|
|
467
|
+
}
|
|
468
|
+
}
|
|
469
|
+
await eid.registerSignature(registrationFromCompleted(done, { fileName: "Гэрээ №12.pdf", sessionID: s.sessionId }));
|
|
470
|
+
writeFileSync("signed.pdf", done.pdf);
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
`PadesError.code` (тогтвортой, бүх платформд ижил): `PDF_INVALID`, `PDF_ENCRYPTED`, `PDF_LOCKED` (DocMDP P=1),
|
|
474
|
+
`PDF_TOO_LARGE`, `PDF_TOO_MANY_SIGNATURES`, `PDF_PRIOR_SIGNATURE_INVALID`, `PDF_FOREIGN_SIGNATURE`, `SIGNER_INVALID`,
|
|
475
|
+
`REQUEST_INVALID`, `SIGNATURE_INVALID` (state хэвээр — дахин зуруулж болно), `TSA_UNAVAILABLE`, `LTV_UNAVAILABLE`
|
|
476
|
+
(`retryable`), `SELF_VALIDATION_FAILED`, `PLACEHOLDER_OVERFLOW`, `STATE_INVALID`, `INTERNAL`.
|
|
477
|
+
`state` нь бэлтгэсэн PDF-ийг агуулна — PDF-тэй ижил нууцлалтай хадгал. Формат нь Go SDK-тай ижил (хөтөчид `prepare`,
|
|
478
|
+
Go backend-д `complete` хийж болно).
|
|
479
|
+
|
|
480
|
+
0.14.0-д `eid.pdf` (`prepare`, `document`, `documentVerified`, `tokenPrepare`, `tokenFinalize`, `tokenDocument`) ба
|
|
481
|
+
`pdfTimeoutMs` / `pdfMaxBytes` устсан — PDF upload endpoint-ууд CA-д байхгүй болно.
|
|
405
482
|
|
|
406
483
|
## 4. QR ба ижил төхөөрөмж — device link v3
|
|
407
484
|
|
|
@@ -532,8 +609,9 @@ OK ирж болзошгүй. Иймд `ResponseValidator`:
|
|
|
532
609
|
| `CertChoiceInvalidError` | 409 `CERT_CHOICE_INVALID` — linked sign-ийн certificate-choice хүчингүй; `ApiError`-ийн дэд анги |
|
|
533
610
|
| `RequestInvalidError` | 400 `REQUEST_INVALID` — хүсэлт буруу (ж: `linkedSessionID` дутуу); `ApiError`-ийн дэд анги |
|
|
534
611
|
| `ApiError` | бусад HTTP алдаа (`.status`, `.body`, серверийн `.code`, `.retryAfterMs`, `.headers`, `.retryable` — ж: 404 `ORG_NOT_FOUND`) |
|
|
535
|
-
| `ResponseTooLargeError` | хариу SDK-ийн хязгаараас их (JSON 4 MiB
|
|
612
|
+
| `ResponseTooLargeError` | хариу SDK-ийн хязгаараас их (JSON 4 MiB) — `.op`, `.limit` |
|
|
536
613
|
| `NetworkError` | timeout/сүлжээ (`.op` — таних тэмдэггүй зам, `.timeout`) |
|
|
614
|
+
| `PadesError` (`/pades`) | клиент талын PAdES — `.code` (§3d), `.retryable` |
|
|
537
615
|
| `DeviceLinkError` | device-link холбоос угсрах боломжгүй (`deviceLinkBase` https биш, token/secret/lang хэлбэр, төрөлд хэрэгтэй талбар дутуу) |
|
|
538
616
|
|
|
539
617
|
## mTLS (eIDAS qualified орчин)
|
|
@@ -550,10 +628,17 @@ const eid = new EidClient({
|
|
|
550
628
|
|
|
551
629
|
```bash
|
|
552
630
|
npm install
|
|
553
|
-
npm run lint
|
|
554
|
-
npm test
|
|
631
|
+
npm run lint # tsc --noEmit
|
|
632
|
+
npm test # build + node --test (pades golden — Go reference-тэй байт-ижил)
|
|
633
|
+
npm run golden:check # test/fixtures/pades/golden + src/pades/assets ↔ бэхэлсэн Go commit
|
|
634
|
+
npm run size:pades # /pades хөтчийн bundle gzip ≤ 300 KB
|
|
555
635
|
```
|
|
556
636
|
|
|
637
|
+
`/pades`-ийн conformance fixture (golden: оролт, тестийн PKI-ийн гэрчилгээ, TSA/OCSP/CRL-ийн тогтмол хариу, хүлээгдэх
|
|
638
|
+
sha256) ба фонт/гинжийн asset-ийг Go reference-ээс `node scripts/sync-pades-golden.mjs` хуулна (`GO_SDK_COMMIT` —
|
|
639
|
+
tag `pades-golden-vN`); CI `--check`-ээр бэхэлсэн commit-тэй тулгана. Профайл: Go репогийн `pades/PROFILE.md`,
|
|
640
|
+
`PAGE_SPEC.md`, `PRECHECKS.md`, `WIRE.md`.
|
|
641
|
+
|
|
557
642
|
### Гэрээний шалгалт
|
|
558
643
|
|
|
559
644
|
SDK-ийн дууддаг RP-API зам бүр (`src/contract.ts`) live [`/.well-known/eid`](https://rp.eidmongolia.mn/.well-known/eid)-ийн
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import './errors-Z7SgLVTr.cjs';
|
|
2
|
+
|
|
1
3
|
/** Сертификатын баталгаажуулалтын түвшин (eIDAS LoA). QUALIFIED — хууль ёсны гарын үсэгт. */
|
|
2
4
|
type CertificateLevel = "ADVANCED" | "QUALIFIED" | "QSCD";
|
|
3
5
|
/** Гарын үсгийн протокол: auth → ACSP_V2, sign → RAW_DIGEST_SIGNATURE (Smart-ID v3). */
|
|
@@ -177,11 +179,6 @@ interface SessionResult {
|
|
|
177
179
|
* RP энэ талбарыг л итгэж уншина (клиентийн сонголтод биш). docs/ORG_LOGIN.md.
|
|
178
180
|
*/
|
|
179
181
|
onBehalfOf: OrgResult | null;
|
|
180
|
-
/**
|
|
181
|
-
* PAdES (`POST /pdf/sign/prepare`) session-ий `pdf` блок — PDF урсгал биш бол null (талбар алга = хуучин SDK-аар
|
|
182
|
-
* угсарсан объект). {@link PdfSessionBlock}.
|
|
183
|
-
*/
|
|
184
|
-
pdf?: PdfSessionBlock | null;
|
|
185
182
|
/**
|
|
186
183
|
* COMPLETE+OK auth session-ий `person` блок (CA бүртгэлээс: кирилл нэр, төрсөн огноо, хүйс — гэрчилгээнд байдаггүй).
|
|
187
184
|
* Зөвхөн session эзэмшигч RP-д; CA иргэнийг олоогүй бол null. ГАРЫН ҮСЭГТ ОРДОГГҮЙ — validateAuth-ийн дараа
|
|
@@ -223,35 +220,6 @@ interface TokenCertSessionBlock {
|
|
|
223
220
|
authSerialHex?: string;
|
|
224
221
|
signSerialHex?: string;
|
|
225
222
|
}
|
|
226
|
-
/** PDF баримтын төлөв: PENDING → READY (эсвэл FAILED / EXPIRED). */
|
|
227
|
-
type PdfDocumentStatus = "PENDING" | "READY" | "FAILED" | "EXPIRED";
|
|
228
|
-
/** PAdES гаралтын гарын үсэг зурагч. */
|
|
229
|
-
interface PdfSigner {
|
|
230
|
-
etsi: string;
|
|
231
|
-
certSerial: string;
|
|
232
|
-
/** Байгууллагын нэрийн өмнөөс бол байгууллагын ETSI (`NTRMN-…`) — баримтад бичигдсэн утга. */
|
|
233
|
-
onBehalfOf?: string;
|
|
234
|
-
/** CMS signer-attributes-v2-д бичигдсэн мэдүүлсэн үүрэг: «<албан тушаал>, <нэр> (NTRMN-…)». */
|
|
235
|
-
claimedRole?: string;
|
|
236
|
-
}
|
|
237
|
-
/** GET /session/{id}-ийн `pdf` объект (PAdES, CA угсарна). */
|
|
238
|
-
interface PdfSessionBlock {
|
|
239
|
-
docID: string;
|
|
240
|
-
documentStatus: PdfDocumentStatus | string;
|
|
241
|
-
/** FAILED үед — ж: `REPRESENTATION_REVOKED` (prepare-ээс хойш эрх хасагдсан, баримт үүсээгүй). */
|
|
242
|
-
errorCode?: string;
|
|
243
|
-
/** Гарын үсэгтэй PDF-ийн SHA-256 (hex) — татсан файлтай тулгана. */
|
|
244
|
-
outSha256?: string;
|
|
245
|
-
size?: number;
|
|
246
|
-
expiresAt?: string;
|
|
247
|
-
signatureLevel?: string;
|
|
248
|
-
signer?: PdfSigner;
|
|
249
|
-
validation?: {
|
|
250
|
-
indication: string;
|
|
251
|
-
ltv: boolean;
|
|
252
|
-
signatures: number;
|
|
253
|
-
};
|
|
254
|
-
}
|
|
255
223
|
/** Иргэний төлөөлж чадах нэг байгууллага (GET /organization/representations/etsi/{personEtsi}). */
|
|
256
224
|
interface Representation {
|
|
257
225
|
/** `NTRMN-<бүртгэл>` — `onBehalfOf`-д өгөх утга. */
|
|
@@ -275,6 +243,11 @@ interface Representation {
|
|
|
275
243
|
source: "REGISTRY" | "MANUAL" | string;
|
|
276
244
|
/** Эх үүсвэрийн хүнд харуулах нэр (REGISTRY → «Улсын бүртгэл», MANUAL → «Захирал нэмсэн»; хэл нь `roleLabel`-тэй ижил). Хуучин CA-д байхгүй. */
|
|
277
245
|
sourceLabel?: string;
|
|
246
|
+
/**
|
|
247
|
+
* CMS signer-attributes-v2-д бичих мэдүүлсэн үүрэг («<албан тушаал>, <нэр> (NTRMN-…)») — клиент талын PAdES-д
|
|
248
|
+
* `pades.prepare({claimedRole})`-д ЯГ ХЭВЭЭР өгнө (CA бүртгэлд дахин тооцож тулгана). Хуучин CA-д байхгүй.
|
|
249
|
+
*/
|
|
250
|
+
claimedRole?: string;
|
|
278
251
|
/** ISO 8601. */
|
|
279
252
|
validFrom: string;
|
|
280
253
|
/** ISO 8601; байхгүй = хугацаагүй. */
|
|
@@ -360,152 +333,4 @@ interface OpenOrShowQROptions {
|
|
|
360
333
|
*/
|
|
361
334
|
declare function openOrShowQR(session: DeviceLinkInput, opts: OpenOrShowQROptions): "opened" | "qr";
|
|
362
335
|
|
|
363
|
-
|
|
364
|
-
declare class EidError extends Error {
|
|
365
|
-
constructor(message: string);
|
|
366
|
-
}
|
|
367
|
-
/** HTTP хариуны нэмэлт мэдээлэл (алдааны төрлүүдэд). */
|
|
368
|
-
interface HttpErrorInit {
|
|
369
|
-
/** Хариуны header-ууд. */
|
|
370
|
-
headers?: Headers;
|
|
371
|
-
/** Retry-After (секунд эсвэл HTTP-огноо задалсан), мс; байхгүй/буруу бол undefined. */
|
|
372
|
-
retryAfterMs?: number;
|
|
373
|
-
}
|
|
374
|
-
/**
|
|
375
|
-
* HTTP 401 — API secret буруу/байхгүй. Тохиргооны (RP secret) алдаа. CA-ийн өөрийн 401 нь JSON `{"error"[,"code"]}` —
|
|
376
|
-
* `serverMessage` (ба байвал `code`) бөглөгдөнө; JSON биш (proxy / nginx) бол хоёул undefined — үүгээр CA-ийн 401-ийг
|
|
377
|
-
* proxy-ийнхоос ялгана.
|
|
378
|
-
*/
|
|
379
|
-
declare class AuthenticationError extends EidError {
|
|
380
|
-
/** Серверийн `{"code"}`; байхгүй / JSON биш (proxy) бол undefined. */
|
|
381
|
-
readonly code?: string;
|
|
382
|
-
/** Серверийн `{"error"}` текст (логт); JSON биш (proxy) бол undefined. */
|
|
383
|
-
readonly serverMessage?: string;
|
|
384
|
-
/** Хариуны бие (таслагдаагүй текст). */
|
|
385
|
-
readonly body?: string;
|
|
386
|
-
readonly headers?: Headers;
|
|
387
|
-
constructor(message: string, init?: {
|
|
388
|
-
code?: string;
|
|
389
|
-
serverMessage?: string;
|
|
390
|
-
body?: string;
|
|
391
|
-
headers?: Headers;
|
|
392
|
-
});
|
|
393
|
-
}
|
|
394
|
-
/**
|
|
395
|
-
* HTTP 403 — IP allowlist/mTLS зөвшөөрөөгүй, RP-д эрх алга, эсвэл onBehalfOf-ийн төлөөлөл татгалзсан.
|
|
396
|
-
* Сервер `{"error","code"}` буцаасан бол `code` (ж: `REPRESENTATION_DENIED`) — салааллыг үүгээр хийнэ.
|
|
397
|
-
*/
|
|
398
|
-
declare class ForbiddenError extends EidError {
|
|
399
|
-
/** Серверийн тогтвортой алдааны код (`{"code"}`), байхгүй бол undefined. */
|
|
400
|
-
readonly code?: string | undefined;
|
|
401
|
-
readonly headers?: Headers;
|
|
402
|
-
/** Retry-After (мс), байхгүй бол undefined. */
|
|
403
|
-
readonly retryAfterMs?: number;
|
|
404
|
-
constructor(message: string,
|
|
405
|
-
/** Серверийн тогтвортой алдааны код (`{"code"}`), байхгүй бол undefined. */
|
|
406
|
-
code?: string | undefined, init?: HttpErrorInit);
|
|
407
|
-
}
|
|
408
|
-
/** RP-API-аас ирсэн бусад HTTP алдаа (4xx/5xx). status ба хариуны биеийг агуулна. */
|
|
409
|
-
declare class ApiError extends EidError {
|
|
410
|
-
readonly status: number;
|
|
411
|
-
readonly body: string;
|
|
412
|
-
/** Серверийн тогтвортой алдааны код (`{"error","code"}`-ийн `code`), байхгүй бол undefined. */
|
|
413
|
-
readonly code?: string | undefined;
|
|
414
|
-
readonly headers?: Headers;
|
|
415
|
-
/**
|
|
416
|
-
* Retry-After (мс, секунд эсвэл HTTP-огноо задалсан); байхгүй/буруу бол undefined. CA түр алдаанд (429
|
|
417
|
-
* PDF_PREPARE_BUSY / RATE_LIMITED, 503 DOCUMENT_PENDING / TSA_UNAVAILABLE / LTV_UNAVAILABLE г.м.) тавина.
|
|
418
|
-
*/
|
|
419
|
-
readonly retryAfterMs?: number;
|
|
420
|
-
constructor(status: number, body: string,
|
|
421
|
-
/** Серверийн тогтвортой алдааны код (`{"error","code"}`-ийн `code`), байхгүй бол undefined. */
|
|
422
|
-
code?: string | undefined, init?: HttpErrorInit);
|
|
423
|
-
/**
|
|
424
|
-
* CA-ийн түр алдаа ({@link RETRYABLE_ERROR_CODES}-ийн нэг, эсвэл 429/503 + Retry-After): `retryAfterMs`-ийн дараа
|
|
425
|
-
* ижил хүсэлтийг давтаж болно.
|
|
426
|
-
*/
|
|
427
|
-
get retryable(): boolean;
|
|
428
|
-
}
|
|
429
|
-
/**
|
|
430
|
-
* 409 `NO_SIGNING_CERTIFICATE` — иргэнд (баримтад) идэвхтэй төхөөрөмж / SIGN credential / хүчинтэй гарын үсгийн
|
|
431
|
-
* гэрчилгээ алга: sign ба certificate-choice session start, `/pdf/sign/prepare`. Session үүсээгүй. Танихгүй
|
|
432
|
-
* лавлагаанд ч ижил хариу (бүртгэл задлахгүй) — хэрэглэгчид «eID гарын үсгийн гэрчилгээгүй» гэж харуулна.
|
|
433
|
-
*/
|
|
434
|
-
declare class NoSigningCertificateError extends ApiError {
|
|
435
|
-
}
|
|
436
|
-
/**
|
|
437
|
-
* 409 `CERT_CHOICE_INVALID` — linked sign-ийн `linkedSessionID` (certificate-choice) хүчингүй: өөр RP, COMPLETE+OK биш,
|
|
438
|
-
* өөр documentNumber, 5 минутаас хуучин, гэрчилгээ солигдсон, эсвэл аль хэдийн ашиглагдсан. Certificate-choice-ийг
|
|
439
|
-
* дахин эхлүүлнэ.
|
|
440
|
-
*/
|
|
441
|
-
declare class CertChoiceInvalidError extends ApiError {
|
|
442
|
-
}
|
|
443
|
-
/** 400 `REQUEST_INVALID` — хүсэлтийн бие/талбар буруу (ж: linked sign-д `linkedSessionID` дутуу). Програмын алдаа. */
|
|
444
|
-
declare class RequestInvalidError extends ApiError {
|
|
445
|
-
}
|
|
446
|
-
/**
|
|
447
|
-
* CA-ийн түр (давтаж болох) алдааны кодууд — `ApiError.code`. PDF_PREPARE_BUSY (429 prepare, Retry-After 5),
|
|
448
|
-
* DOCUMENT_PENDING (503 document, 5), TSA_UNAVAILABLE (503, 30), LTV_UNAVAILABLE (503, 60), RATE_LIMITED (429 токен),
|
|
449
|
-
* STATE_UNAVAILABLE (503 токен), ISSUANCE_PENDING (503 токены үр дүн, 5).
|
|
450
|
-
*/
|
|
451
|
-
type RetryableErrorCode = "PDF_PREPARE_BUSY" | "DOCUMENT_PENDING" | "TSA_UNAVAILABLE" | "LTV_UNAVAILABLE" | "RATE_LIMITED" | "STATE_UNAVAILABLE" | "ISSUANCE_PENDING";
|
|
452
|
-
/** {@link RetryableErrorCode}-ийн бүх утга. */
|
|
453
|
-
declare const RETRYABLE_ERROR_CODES: readonly RetryableErrorCode[];
|
|
454
|
-
/** RFC 9110 §10.2.3: delay-seconds эсвэл HTTP-date → мс. Буруу / өнгөрсөн / 24 цагаас их → undefined. */
|
|
455
|
-
declare function parseRetryAfter(value: string | null | undefined, now?: number): number | undefined;
|
|
456
|
-
/**
|
|
457
|
-
* Байгууллагын нэрийн өмнөөс (`onBehalfOf`) урсгалын татгалзлын кодууд — `ForbiddenError.code` /
|
|
458
|
-
* `ApiError.code`-д ирнэ. 403: REPRESENTATION_DENIED (идэвхтэй төлөөлөгч биш), REPRESENTATION_PENDING (PIN2-оор
|
|
459
|
-
* баталгаажуулаагүй), REPRESENTATION_EXPIRED (хугацааны гадна), ORG_NOT_ACTIVE, SIGNER_UNIDENTIFIED (anonymous
|
|
460
|
-
* session); 404: ORG_NOT_FOUND; PDF баримт татахад 403 REPRESENTATION_REVOKED (prepare-ээс хойш эрх хасагдсан —
|
|
461
|
-
* баримт үүсээгүй).
|
|
462
|
-
*/
|
|
463
|
-
type OnBehalfErrorCode = "REPRESENTATION_DENIED" | "REPRESENTATION_PENDING" | "REPRESENTATION_EXPIRED" | "ORG_NOT_ACTIVE" | "SIGNER_UNIDENTIFIED" | "ORG_NOT_FOUND" | "REPRESENTATION_REVOKED";
|
|
464
|
-
/** {@link OnBehalfErrorCode}-ийн бүх утга (runtime шалгалтад). */
|
|
465
|
-
declare const ON_BEHALF_ERROR_CODES: readonly OnBehalfErrorCode[];
|
|
466
|
-
/**
|
|
467
|
-
* Сүлжээ/timeout — upstream хариу өгсөнгүй. Мессеж ба `op`-д хувь хүний таних тэмдэг ОРОХГҮЙ (замын `/etsi/{…}`,
|
|
468
|
-
* `/document/{…}` → `…`) — шууд лог руу бичиж болно.
|
|
469
|
-
*/
|
|
470
|
-
declare class NetworkError extends EidError {
|
|
471
|
-
/** "GET /session/…" (таних тэмдэг хасагдсан зам). */
|
|
472
|
-
readonly op?: string;
|
|
473
|
-
/** Хүсэлт хугацаа хэтэрсэн. */
|
|
474
|
-
readonly timeout?: boolean;
|
|
475
|
-
constructor(message: string, init?: {
|
|
476
|
-
op?: string;
|
|
477
|
-
timeout?: boolean;
|
|
478
|
-
});
|
|
479
|
-
}
|
|
480
|
-
/**
|
|
481
|
-
* Хариуны бие SDK-ийн хязгаараас их (JSON 4 MiB, PDF `pdfMaxBytes`) — бие таслагдаж задлагдахгүй. `op` — method +
|
|
482
|
-
* таних тэмдэггүй зам.
|
|
483
|
-
*/
|
|
484
|
-
declare class ResponseTooLargeError extends EidError {
|
|
485
|
-
readonly op: string;
|
|
486
|
-
readonly limit: number;
|
|
487
|
-
constructor(op: string, limit: number);
|
|
488
|
-
}
|
|
489
|
-
/**
|
|
490
|
-
* Session амжилтгүй дууссан (endResult ≠ OK): TIMEOUT, USER_REFUSED*, DOCUMENT_UNUSABLE гм.
|
|
491
|
-
* endResult-оор салгаж RP UI-д тохирох мессеж харуулна.
|
|
492
|
-
*/
|
|
493
|
-
declare class SessionFailedError extends EidError {
|
|
494
|
-
readonly endResult: string;
|
|
495
|
-
constructor(endResult: string);
|
|
496
|
-
}
|
|
497
|
-
/**
|
|
498
|
-
* Хариуны баталгаажуулалт бүтэлгүйтсэн — cert chain итгэлцэлгүй, signature challenge-тэй
|
|
499
|
-
* таарсангүй, эсвэл certLevel хүрэлцээгүй. ЭНЭ алдаа гарвал хариунд ИТГЭХГҮЙ
|
|
500
|
-
* (хуурамч/proxy хийгдсэн байж болзошгүй).
|
|
501
|
-
*/
|
|
502
|
-
declare class ValidationError extends EidError {
|
|
503
|
-
}
|
|
504
|
-
/**
|
|
505
|
-
* Device-link (App2App/Web2App) холбоос угсрах боломжгүй — хариунд `deviceLinkBase` байхгүй,
|
|
506
|
-
* эсвэл sessionId/vc/суурь URL хэлбэр буруу. Session-ийг дахин эхлүүлнэ; холбоосыг таахгүй.
|
|
507
|
-
*/
|
|
508
|
-
declare class DeviceLinkError extends EidError {
|
|
509
|
-
}
|
|
510
|
-
|
|
511
|
-
export { type AcspContext as A, type SessionState as B, type CertificateLevel as C, type DeviceLinkSession as D, EidError as E, type FlowType as F, type SignContext as G, type HashAlgorithm as H, type Interaction as I, type SignatureAlgorithmParameters as J, type SignatureProtocol as K, type TokenCertStatus as L, deviceLink as M, type NotificationSession as N, ON_BEHALF_ERROR_CODES as O, type PersonBlock as P, isMobileUserAgent as Q, type RpCredentials as R, type SignatureAlgorithm as S, type TokenCertSessionBlock as T, openOrShowQR as U, ValidationError as V, parseExpiresAt as W, parseRetryAfter as X, sessionExpiry as Y, startExpiry as Z, type SessionResult as a, type PdfSessionBlock as b, type RepresentationsResponse as c, ApiError as d, AuthenticationError as e, CertChoiceInvalidError as f, DEFAULT_SIGN_SESSION_TTL_MS as g, DeviceLinkError as h, type DeviceLinkInput as i, type EndResult as j, ForbiddenError as k, type HttpErrorInit as l, type NavigatorLike as m, NetworkError as n, NoSigningCertificateError as o, type OnBehalfErrorCode as p, type OpenOrShowQROptions as q, type OrgResult as r, type PdfDocumentStatus as s, type PdfSigner as t, RETRYABLE_ERROR_CODES as u, type Representation as v, RequestInvalidError as w, ResponseTooLargeError as x, type RetryableErrorCode as y, SessionFailedError as z };
|
|
336
|
+
export { type AcspContext as A, type CertificateLevel as C, type DeviceLinkSession as D, type EndResult as E, type FlowType as F, type HashAlgorithm as H, type Interaction as I, type NotificationSession as N, type OpenOrShowQROptions as O, type PersonBlock as P, type RpCredentials as R, type SignatureAlgorithm as S, type TokenCertSessionBlock as T, type SessionResult as a, type RepresentationsResponse as b, DEFAULT_SIGN_SESSION_TTL_MS as c, type DeviceLinkInput as d, type NavigatorLike as e, type OrgResult as f, type Representation as g, type SessionState as h, type SignContext as i, type SignatureAlgorithmParameters as j, type SignatureProtocol as k, type TokenCertStatus as l, deviceLink as m, isMobileUserAgent as n, openOrShowQR as o, parseExpiresAt as p, startExpiry as q, sessionExpiry as s };
|