chore(sdk): prepare package manifest for gitea npm registry and document release flow

2026-10-20 16:45:03 -03:00
parent b19d09a236
commit 8d0e587114
3 changed files with 198 additions and 34 deletions
@@ -1,42 +1,85 @@
 # @cybercore/signer-sdk

-SDK oficial em JavaScript para integração de aplicações web com o agente desktop **CyberCore Signer** via protocolo **CCSP/1**.
+SDK oficial em JavaScript/TypeScript para integração de aplicações web com o agente desktop **CyberCore Signer** via protocolo **CCSP/1**.

-Permite que sistemas web executem assinaturas digitais ICP-Brasil padrão **A1** (.pfx/.p12) e **A3** (Tokens USB e Smart Cards) instalados localmente na máquina do usuário, mantendo as chaves privadas e o PIN sob proteção estrita do hardware.
+Permite que sistemas web solicitem assinaturas digitais ICP-Brasil padrão **A1** (.pfx/.p12) e **A3** (Tokens USB e Smart Cards via PKCS#11 / Windows Store) instalados localmente na máquina do usuário, mantendo as chaves privadas e o PIN sob proteção estrita e exclusiva do computador do cliente.

 ---

-## 🚀 Instalação e Uso Rápido
+## 📦 Instalação via Registry npm Privado

-### 1. Inclusão Direta no HTML (ES Module)
-```html
-<script type="module">
-  import { CyberCoreSigner } from './src/signer-sdk.js';
+Configure o escopo `@cybercore` no arquivo `.npmrc` da sua aplicação web:

-  const signer = new CyberCoreSigner({
-    applicationName: 'Portal Minha Empresa'
-  });
+```ini
+# .npmrc
+@cybercore:registry=https://git.cybercore.com.br/api/packages/cybercore/npm/
+//git.cybercore.com.br/api/packages/cybercore/npm/:_authToken=${GITEA_NPM_TOKEN}
+always-auth=true
+```

-  // 1. Verifica se o agente desktop está rodando
-  if (await signer.isInstalled()) {
-    console.log('Agente detectado!');
+Em seguida, instale o pacote:
+```bash
+npm install @cybercore/signer-sdk
+# ou
+yarn add @cybercore/signer-sdk
+# ou
+pnpm add @cybercore/signer-sdk
+```

-    // 2. Conecta e solicita autorização ao usuário
+---
+
+## 🚀 Uso Rápido (TypeScript / JavaScript ES Modules)
+
+```typescript
+import {
+  CyberCoreSigner,
+  AgentNotRunningError,
+  UserCancelledError
+} from '@cybercore/signer-sdk';
+
+const signer = new CyberCoreSigner({
+  applicationName: 'Portal Corporativo ERP',
+  timeoutMs: 30000 // 30 segundos
+});
+
+async function executarAssinatura() {
+  try {
+    // 1. Verifica se o agente desktop está ativo na bandeja do sistema
+    if (!(await signer.isInstalled())) {
+      alert('Por favor, abra o CyberCore Signer na bandeja do sistema.');
+      return;
+    }
+
+    // 2. Conecta e obtém autorização visual do usuário
    await signer.connect();

    // 3. Obtém certificados disponíveis
    const certs = await signer.getCertificates();
-    console.log('Certificados encontrados:', certs);
+    if (certs.length === 0) {
+      alert('Nenhum certificado A1 ou token A3 conectado.');
+      return;
+    }

-    // 4. Assina um documento (o SDK calcula o SHA-256 no próprio navegador)
-    const result = await signer.sign({
+    // 4. Assina o digest de um documento (o hash é gerado no próprio navegador)
+    const resultado = await signer.sign({
      certificateId: certs[0].id,
-      data: 'Texto ou buffer do contrato para assinatura'
+      data: 'Conteúdo ou contrato em texto a ser assinado',
+      documentName: 'contrato.pdf'
    });

-    console.log('Assinatura Base64:', result.signature);
+    console.log('Assinatura Base64:', resultado.signature);
+    console.log('Certificado X.509:', resultado.certificate);
+
+  } catch (err) {
+    if (err instanceof AgentNotRunningError) {
+      alert(err.actionableGuidance);
+    } else if (err instanceof UserCancelledError) {
+      console.info('Assinatura cancelada pelo usuário.');
+    } else {
+      console.error('Falha na operação:', err);
+    }
  }
-</script>
+}
 ```

 ---
@@ -45,20 +88,33 @@ Permite que sistemas web executem assinaturas digitais ICP-Brasil padrão **A1**

 | Método | Retorno | Descrição |
 |---|---|---|
-| `isInstalled(timeoutMs)` | `Promise<boolean>` | Verifica se o CyberCore Signer está ativo na porta local `21325`. |
-| `getStatus()` | `Promise<Object>` | Retorna status de prontidão, versão e sistema operacional. |
-| `getVersion()` | `Promise<Object>` | Retorna versões do agente e do protocolo CCSP. |
-| `getCapabilities()` | `Promise<Object>` | Retorna algoritmos suportados (`SHA256withRSA`, etc.) e tipos de certificados. |
+| `isInstalled(timeoutMs?)` | `Promise<boolean>` | Verifica se o CyberCore Signer está ativo na porta local (`21325`). |
+| `getStatus(timeoutMs?)` | `Promise<StatusResponse>` | Retorna status de prontidão, versão e sistema operacional. |
+| `getVersion()` | `Promise<VersionInfo>` | Retorna versões do agente e do protocolo CCSP. |
+| `getCapabilities()` | `Promise<CapabilitiesResponse>` | Retorna algoritmos suportados (`SHA256withRSA`, etc.) e tipos de certificados. |
 | `connect()` | `Promise<boolean>` | Realiza o handshake de autorização da aplicação web com o usuário. |
-| `getCertificates()` | `Promise<Array>` | Retorna a lista de certificados A1 e A3 disponíveis na máquina. |
-| `sign(options)` | `Promise<Object>` | Solicita a assinatura digital de um digest ou documento. |
-| `verify(options)` | `Promise<boolean>` | Validação criptográfica da integridade da assinatura. |
+| `getCertificates()` | `Promise<CertificateDto[]>` | Retorna a lista de certificados A1 e A3 disponíveis na máquina. |
+| `sign(params)` | `Promise<SignResult>` | Assinatura desacoplada de digest SHA-256 (recomendado para alta performance). |
+| `signPdfDocument(params)` | `Promise<SignPdfDocumentResult>` | Assinatura PAdES completa de PDF com estampa gráfica e posicionamento visual. |
+| `signXmlDocument(params)` | `Promise<SignXmlDocumentResult>` | Assinatura XAdES-BES / XMLDSig Enveloped de arquivos XML ou notas fiscais. |
+| `authenticate(params)` | `Promise<AuthenticateResult>` | Login seguro sem senha por desafio criptográfico (Challenge-Response). |
+| `getSealThemes()` | `Promise<SealThemesResponse>` | Consulta temas de selos gráficos visuais disponíveis no agente. |
+| `verify(params)` | `Promise<boolean>` | Validação sintática e integridade da assinatura no client. |

 ---

-## 🔒 Princípios de Segurança e Privacidade
+## 📂 Exemplos Prontos

- **Apenas o Digest é transmitido:** O documento completo nunca sai do navegador da aplicação web. O SDK calcula o hash SHA-256 localmente antes de invocar o agente.
- **Isolamento Total:** A comunicação ocorre exclusivamente via loopback em `127.0.0.1:21325`.
- **Autorização Prévia:** Aplicações web desconhecidas devem ser autorizadas visualmente pelo usuário na tela do CyberCore Signer antes de listar certificados.
- **PIN Protegido:** O PIN do token A3 nunca trafega pela web e nunca é enviado a nenhum servidor remoto.
+Consulte a pasta [`examples/`](./examples/) para implementações completas:
+- [`01-crypto-login.js`](./examples/01-crypto-login.js) — Autenticação sem senha via desafio.
+- [`02-sign-digest.js`](./examples/02-sign-digest.js) — Assinatura desacoplada de digest SHA-256.
+- [`03-sign-pades.js`](./examples/03-sign-pades.js) — Assinatura de PDF com carimbo visual ICP-Brasil / Gov.br.
+- [`04-error-handling.js`](./examples/04-error-handling.js) — Tratamento completo e acionável de erros.
+
+---
+
+## 🔒 Segurança, Conectividade e Protocolo
+
+- **Especificação do Protocolo:** Consulte a documentação formal em [`docs/CCSP.md`](../docs/CCSP.md) e o esquema JSON em [`docs/ccsp-v1.schema.json`](../docs/ccsp-v1.schema.json).
+- **Compatibilidade HTTPS e Private Network Access (PNA):** Consulte [`docs/browser-compatibility.md`](../docs/browser-compatibility.md).
+- **Processo de Release do Pacote:** Consulte [`docs/sdk-release-process.md`](../docs/sdk-release-process.md).