Plugin Signataire

Signer des documents PDF et Word avec une signature visible et un sceau numérique

Le plugin Signer place une signature visible sur un document et, par défaut, le scelle avec une signature numérique qu'un lecteur PDF peut vérifier. Il signe PDF et Word (.docx) fichiers. La signature visible est toujours une image PNG : dessinée, tapée ou téléchargée par le signataire.

SurfaceUtilisez‑le lorsque
DocumentSigner (C#)Vous signez sur le serveur, sans navigateur impliqué
Drop‑in widget (doconutSigner.js)Vous voulez un écran d'upload, de signature et de téléchargement prêt à l'emploi dans votre page
HTTP endpoints (?sign=open|run|download)Vous construisez votre propre UI de signature contre un contrat serveur documenté

Chaque signature est placée une fois, sur une page. Le nom du signataire, la raison et le lieu peuvent l'accompagner.

Installer le package

Installez le dernier plugin Signer stable :

bash
dotnet add package Doconut.NET8.Signer

Pour épingler le plugin à la version décrite dans cette documentation, passez la version séparément :

bash
dotnet add package Doconut.NET8.Signer --version 26.10.0

Conservez le package Signer à la même version que Doconut.NET8. L'ID du package est Doconut.NET8.Signer ; .<version> apparaît uniquement dans le nom de fichier .nupkg téléchargé.

Le fichier de licence du plugin, Doconut.Viewer.Signer.lic, se trouve dans le même dossier que Doconut.Viewer.lic ; il est lu avec la licence du visualiseur.

Plateformes. Le plugin fonctionne partout où Doconut.NET8 fonctionne : Windows et Linux basé sur glibc en x64 (pas Alpine ou autres distributions basées sur musl). Sous Linux, installez la bibliothèque de configuration des polices avant l'ouverture du premier document :

bash
apt-get update && apt-get install -y libfontconfig1

Sur RHEL, Fedora et les distributions similaires, le paquet est fontconfig. Sans cela, l'ouverture d'un document échoue avec The system library libfontconfig1 is missing. Install it (Debian/Ubuntu: apt-get install -y libfontconfig1) and see the Linux section of the Doconut documentation.

Enregistrer le plugin

Comme tout plugin Doconut, Signer s'enregistre avec AddPlugin<TPlugin>() à l'intérieur de AddDoconut() :

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
});

C'est tout ce dont la façade C# a besoin. Le widget et ses points de terminaison HTTP sont une option séparée, AddSignerWidget() (voir Widget intégré).

Le plugin nécessite une licence qui accorde la capacité Signer. Sans licence, AddDoconut() lève une exception au démarrage, avant que l'application ne serve une requête :

text
The Signer plugin is registered via AddPlugin but no active license grants Signer. Remove the AddPlugin<...>() call or install a license (or trial/demo) that includes Signer.

Il lève une exception en l'absence de licence, avec un fichier legacy TRIAL, une licence sans Signer, et une licence payante utilisée en dehors de sa fenêtre de version. Les licences temporaires Démo/NFR sont acceptées. Voir Configuration de la licence pour savoir comment les licences sont chargées.

Licence & filigrane

État de la licenceDémarrageSignature certifiéeSignature visuelle
Licence payante accordant Signer, certificat configuréDémarreScellée avec votre certificat, propre (watermarked: false)Propre
Licence payante accordant Signer, aucun certificatDémarreRefusée : No signing certificate configured.Propre
Licence payante, certificat expiré ou pas encore valideDémarre (avec le widget activé, un avertissement est journalisé)Refusée : The signing certificate expired on yyyy-MM-dd.Propre
Licence Démo/NFR temporaire, active ou expiréeDémarreScellée avec le certificat de démonstration intégré, filigranée (watermarked: true)Filigranée
Pas de licence, un fichier legacy TRIAL, une licence sans Signer, ou une licence payante hors de sa fenêtre de versionAddDoconut() lève une exception——

La règle est la même pour la façade C# et le widget : la sortie est filigranée lorsque la licence n'est pas une licence de visualiseur payante ou est temporaire. Sous une licence temporaire, le plugin signe toujours avec son certificat de démonstration intégré, et tout certificat que vous configurez n'est pas utilisé.

Le certificat de démonstration produit un sceau authentique, mais les lecteurs PDF ne le font pas confiance. Une intégration peut être construite et testée de bout en bout avec une licence d'évaluation ; pour obtenir une sortie propre et fiable, vous avez besoin à la fois d'une licence payante et de votre propre certificat de signature.

Utilisation depuis C#

DocumentSigner est enregistré par AddDoconut() et résolu via l'injection de dépendances. Son constructeur est interne, donc ne jamais new le. Résoudre cela sans AddPlugin<SignerPlugin>() lance No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

csharp
using Doconut;
using Doconut.Core.Models.Signing;

public sealed class ContractSigning
{
    private readonly DocumentSigner _signer;

    public ContractSigning(DocumentSigner signer) => _signer = signer;

    public async Task<byte[]> SignAsync(Stream pdf, byte[] signaturePng, SigningCertificate certificate, CancellationToken ct)
    {
        var request = new SignRequest(
            new VisibleSignature(SignatureKind.Drawn, signaturePng),
            new SignaturePlacement(Page: 1, X: 0.58, Y: 0.80, W: 0.32, H: 0.12),
            SignerName: "Ada Lovelace",
            Reason: "I approve this document",
            Location: "London, UK");
        // Mode par défaut Certified (signature visible + sceau numérique) ; WordOutput par défaut Pdf.

        SignResult result = await _signer.SignAsync(pdf, ".pdf", request, certificate, ct);
        using (result.Stream)
        using (var output = new MemoryStream())
        {
            await result.Stream.CopyToAsync(output, ct);
            return output.ToArray();
        }
    }
}

SignAsync prend le flux source, son extension (".pdf" ou ".docx"), la requête et le certificat pour cet appel. La façade ne lit pas SignerWidgetOptions.SigningCertificate ; ce paramètre est destiné au widget. Passez null sous une licence de démonstration, ou en mode Visual.

SignResult contient le document signé sous forme de flux recherchable, plus son Extension (".pdf" ou ".docx") afin que vous puissiez nommer le fichier. Vous possédez le flux : libérez‑le lorsque vous avez terminé.

Une signature Visuelle appose uniquement l'image et ne nécessite aucun certificat :

csharp
var signer = app.Services.GetRequiredService<DocumentSigner>();
byte[] signaturePng = File.ReadAllBytes("signature.png");

var request = new SignRequest(
    new VisibleSignature(SignatureKind.Image, signaturePng),
    new SignaturePlacement(Page: 1, X: 0.58, Y: 0.80, W: 0.32, H: 0.12),
    Mode: SignatureMode.Visual);

SignResult result = await signer.SignAsync(stream, ".pdf", request, ct: ct);

Une source Word est signée en PDF sauf si vous demandez une sortie Word. Nommez le résultat provenant de result.Extension :

csharp
var signer = app.Services.GetRequiredService<DocumentSigner>();
byte[] signaturePng = File.ReadAllBytes("signature.png");

var request = new SignRequest(
    new VisibleSignature(SignatureKind.Drawn, signaturePng),
    new SignaturePlacement(Page: 1, X: 0.58, Y: 0.80, W: 0.32, H: 0.12),
    WordOutput: WordOutput.Docx);

SignResult result = await signer.SignAsync(stream, ".docx", request, ct: ct);
string downloadName = "contract-signed" + result.Extension;   // ".docx"

SignAsync lève une exception au lieu de retourner lorsque l'appel ne peut pas réussir :

ExceptionMessageQuand
InvalidOperationExceptionNo signing certificate configured.Mode certifié, une licence payante, et aucun certificat fourni
InvalidOperationExceptionThe signing certificate expired on yyyy-MM-dd. / The signing certificate is not valid before yyyy-MM-dd.Mode certifié avec un certificat hors de sa période de validité
ArgumentExceptionThe sign request is invalid: the visible signature needs PNG bytes and the placement must be a normalized rectangle on a 1-based page.Octets PNG vides, ou un placement qui n'est pas valide
NotSupportedExceptionThe signer supports PDF and Word (.docx) documents; got '{extension}'.Tout autre type de source

Modes de signature, sortie Word et certificats

Modes de signature

SignRequest.Mode détermine si la signature est scellée.

ModeCe qu'il produitCertificatVérifiable
SignatureMode.Certified (default)La signature visible plus un sceau numériqueRequis sous une licence payanteOui
SignatureMode.VisualLa signature visible uniquementJamais nécessaireNon : c'est une image

Utilisez Certified lorsque la signature doit être vérifiable : approbations, contrats, tout ce qu'un vérificateur doit contrôler pour l'identité et l'intégrité. Utilisez Visual lorsque vous avez seulement besoin de l'apparence d'une signature, ou que vous n'avez aucun certificat. Une licence temporaire ajoute un filigrane aux deux.

Les sceaux PDF sont des signatures détachées PKCS#7 (adbe.pkcs7.detached) avec SHA-256, pour les clés RSA ou ECDSA. Ils contiennent les certificats de l'émetteur présents dans votre PFX, de sorte qu'un lecteur qui fait confiance à votre racine peut construire la chaîne. Les sceaux natifs Word sont des signatures de paquet OOXML et ne transportent que le certificat du signataire.

Documents Word

Pour une source .docx, SignRequest.WordOutput choisit la sortie. Elle est ignorée pour les sources PDF, qui produisent toujours un PDF.

SortieCe qui se passeSupport du vérificateur
WordOutput.Pdf (par défaut)Le document est converti en PDF, puis signé et scelléLarge : un PDF signé se vérifie partout
WordOutput.DocxLe document reste au format Word : l'image de la signature y est placée, ainsi qu'une signature de paquet OOXMLLimité : tous les visionneurs n'affichent pas les signatures de paquet OOXML

Conservez le PDF sauf si le destinataire a besoin d'un fichier Word modifiable et accepte le support limité du vérificateur.

Configuration du certificat

Pour sceller avec votre propre identité, fournissez au plugin un fichier PFX (PKCS#12) contenant la clé privée. Pour le widget, définissez SignerWidgetOptions.SigningCertificate ; pour la façade C#, transmettez le certificat à SignAsync. Fournissez soit les octets, soit un chemin, ainsi que le mot de passe :

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
    options.AddSignerWidget(widget =>
    {
        widget.SigningCertificate = new SigningCertificate
        {
            PfxBytes = File.ReadAllBytes("/secure/signing.pfx"),
            Password = builder.Configuration["Signing:PfxPassword"],
        };
    });
});
csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
    options.AddSignerWidget(widget =>
    {
        widget.SigningCertificate = new SigningCertificate
        {
            PfxPath = "/secure/signing.pfx",
            Password = builder.Configuration["Signing:PfxPassword"],
        };
    });
});

Le certificat n'est conservé qu'en mémoire. Il n'est jamais journalisé, renvoyé à un client, ou persistant, et le mot de passe n'apparaît jamais dans une ligne de journal ou un message d'erreur.

Exigences :

  • Un bundle PFX / PKCS#12 avec sa clé privée. Un fichier ne contenant que la clé publique (.cer, .crt) ne peut pas signer. Exportez la chaîne de l'émetteur avec celui‑ci, afin que les sceaux PDF puissent la porter.
  • Le mot de passe correct.
  • Dans sa période de validité. Un certificat expiré ou pas encore valide n'arrête pas l'application : il est journalisé comme un avertissement au démarrage, et les signatures certifiées sont refusées jusqu'à son remplacement. Les signatures visuelles restent inchangées.
  • Émis pour la signature de documents : une utilisation de clé avec signature numérique ou non‑répudiation, et une utilisation étendue de clé, le cas échéant, qui autorise la signature de documents, la protection des courriels ou l'authentification client. Un certificat émis pour autre chose, comme un certificat de serveur TLS, signe néanmoins, mais il est journalisé comme un avertissement et les lecteurs PDF signalent la signature.
  • Les jetons matériels, cartes à puce, HSM et le magasin de certificats Windows ne sont pas pris en charge. Exportez le certificat, avec sa clé privée et sa chaîne, vers un PFX.

Créer un PFX à partir d'un certificat et de sa clé privée avec OpenSSL :

bash
openssl pkcs12 -export -out signing.pfx -inkey private.key -in certificate.crt
# Le mot de passe d'exportation que vous êtes invité à saisir est SigningCertificate.Password.

Exportez‑en un depuis le magasin de certificats Windows : ouvrez certmgr.msc et trouvez le certificat (son icône montre une clé lorsque la clé privée est présente). Faites un clic droit, choisissez Toutes les tâches → Exporter…, sélectionnez Oui, exporter la clé privée, choisissez Échange d'informations personnelles – PKCS #12 (.PFX), et définissez un mot de passe.

Vérifications au démarrage

Lorsque le widget est activé, le certificat dans SignerWidgetOptions.SigningCertificate est vérifié une fois, à l'intérieur de AddDoconut(), de sorte qu'un PFX mal configuré échoue au démarrage plutôt qu'à la première signature. Trois problèmes déclenchent un InvalidOperationException :

MessageSolution
Doconut Signer: the certificate file was not found at '{path}'.Corrigez PfxPath ; assurez‑vous que le fichier est déployé et lisible par le compte de l'application
Doconut Signer: the signing certificate could not be opened — the password is incorrect or the file is not a valid .pfx.Vérifiez le mot de passe ; assurez‑vous que le fichier est un vrai .pfx, pas un .cer ou un .pem
Doconut Signer: the signing certificate has no private key. Re-export the .pfx INCLUDING the private key.Exportez à nouveau le PFX avec la clé privée

Sinon, l'hôte écrit une ligne dans le journal au démarrage. Information lorsque le certificat est prêt :

text
Doconut Signer: using certificate '{subject}' (valid until yyyy-MM-dd). Signatures are digitally sealed.

Un avertissement lorsqu'il est expiré, pas encore valide, ou non émis pour la signature de documents :

text
Doconut Signer: the signing certificate '{subject}' expired on yyyy-MM-dd. Certified signatures will be refused until it is replaced.
Doconut Signer: the signing certificate '{subject}' is not valid before yyyy-MM-dd. Certified signatures will be refused until then.
Doconut Signer: the signing certificate '{subject}' is not issued for document signing (its key usage excludes it). PDF readers will flag these signatures.

Et une information lorsqu'aucun certificat n'est configuré :

text
Doconut Signer: no signing certificate configured — output uses the built-in demo certificate and is watermarked. Set SignerWidgetOptions.SigningCertificate to sign with your own certificate.

Cette dernière ligne est identique sous toutes les licences. Sous une licence payante, le certificat de démonstration n'est jamais utilisé : sans certificat, seules les signatures visuelles fonctionnent.

La façade C# n'est pas vérifiée au démarrage. Le certificat que vous transmettez à SignAsync est lu lors de la signature, de sorte qu'un chemin ou un mot de passe incorrect entraîne l'échec de cet appel.

Widget intégré

Activer les points de terminaison

Les points de terminaison ?sign=open|run|download du widget sont désactivés par défaut. Activez‑les à côté de l’enregistrement du plugin :

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
    options.AddSignerWidget(widget =>
    {
        widget.MaxUploadMb = 25;           // par défaut
        widget.MaxSignatureImageKb = 512;  // par défaut
        // widget.SigningCertificate: voir la configuration du certificat ; le laisser null pour la signature de démonstration (filigrane)
    });
});

AddSignerWidget() sans argument active le widget avec les valeurs par défaut. Il ne permet pas la signature par lui‑même : il nécessite AddPlugin<SignerPlugin>(), ou AddDoconut() lève une exception :

text
AddSignerWidget() was called but the Signer plugin is not registered. Add options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>() (the widget needs it), or remove the AddSignerWidget() call.

Sans AddSignerWidget(), chaque requête ?sign= répond 404. Le script lui‑même est toujours servi, ainsi le widget se charge et dessine sa zone de dépôt, puis signale Signing is not enabled on this server. lors de sa première requête.

Intégrer le

UseDoconutResources() fournit le script à {ResourcesPath}/js/doconutSigner.js (par défaut /doconut-res/js/doconutSigner.js). C’est un fichier unique, autonome, sans dépendances :

html
<div id="host"></div>
<script src="/doconut-res/js/doconutSigner.js"></script>
<script>
  const handle = Doconut.signer('#host', { basePath: '/doconut' });
</script>

Doconut.signer(selectorOrElement, options) accepte un sélecteur CSS ou un élément, lève une exception si le point de montage n’est pas trouvé, et renvoie une poignée.

Le signataire téléverse un fichier PDF ou .docx, crée une signature (Dessiner sur un canevas, Taper un nom avec une police de signature, ou Image à partir d’un PNG, JPG ou GIF), la fait glisser et la redimensionne sur la page, puis signe et télécharge le résultat. Le widget envoie toujours la signature au format PNG ; une image téléversée est convertie dans le navigateur en PNG qui s’ajuste à 520 × 160.

Options

OptionTypeValeur par défautRemarques
basePathstring'/doconut'Où les points de terminaison ?sign= et les images d’aperçu sont servis
resPathstring'/doconut-res'Réservé ; le widget regroupe son propre CSS
maxUploadMbnumber25Vérification côté client uniquement, donc un fichier trop volumineux échoue rapidement. La limite du serveur est MaxUploadMb en AddSignerWidget
maxSignatureKbnumber512Limite côté client pour le mode Image. Gardez‑la égale à celle du serveur MaxSignatureImageKb
previewWidthnumber560Largeur en pixels de l’aperçu de la page
licenseUrlstring | nullnullTransforme l’avertissement de filigrane de démonstration en un lien vers cette URL
signatureModestring'certified'Type de signature initial : 'certified' ou 'visual'. Toute autre valeur devient 'certified'
showSignatureModeTogglebooleantrueAffiche le choix Signature numérique / Visuel uniquement. Avec false, le widget signe avec signatureMode
wordOutputstring'pdf'Sortie initiale pour les sources .docx : 'pdf' ou 'docx'. Toute autre valeur devient 'pdf'
showOutputFormatTogglebooleantrueAffiche le choix PDF / Word, uniquement pour les sources .docx. Avec false, le widget utilise wordOutput
labelsobject{}Remplace tout sous‑ensemble des chaînes anglaises

Masquer un bascule ne désactive pas la fonctionnalité ; cela fixe la valeur. Deux configurations courantes :

javascript
// Les deux commutateurs affichés, signature numérique par défaut : un signataire en libre-service complet.
Doconut.signer('#host', { basePath: '/doconut', licenseUrl: '/pricing' });
javascript
// Visuel uniquement, pas de commutateur : un simple tampon sans signature numérique offert.
Doconut.signer('#host', {
  basePath: '/doconut',
  signatureMode: 'visual',
  showSignatureModeToggle: false
});

Rappels

RappelSe déclenche quandDonnées
onReadyUne fois, à l’initialisation (pas de nouveau sur reset())—
onSourceLoadedLe fichier est ouvert et son aperçu affiché{ file: { token, name, pages, ext } }
onSignedLa signature réussit{ downloadToken, downloadName, watermarked }
onDownloadÀ chaque clic sur Télécharger{ downloadName, downloadToken }
onErrorUne étape d’ouverture, de signature ou de téléchargement échoue, ou un fichier en mode Image est trop volumineux{ message }

Un rappel qui lève une exception est intercepté et journalisé ; il ne rompt jamais le flux du widget.

Gestion impérative

MéthodeComportement
reset()Retourne à l'écran de dépôt et efface le flux actuel. Ne déclenche pas à nouveau onReady. Aucun effet après destroy()
loadFile(file)Démarre le flux avec un File. Aucun effet sauf si le widget est sur son écran de dépôt ; appelez reset() d'abord si nécessaire
destroy()Supprime les écouteurs, vide le montage et gèle l'instance
javascript
const signerWidget = Doconut.signer('#host', {
  basePath: '/doconut',
  onSigned: (result) => console.log('signed', result.downloadName, result.watermarked),
  onError: (error) => console.warn(error.message)
});
document.getElementById('start-over').addEventListener('click', () => signerWidget.reset());

Libellés

Chaque chaîne possède une valeur par défaut en anglais ; labels remplace tout sous‑ensemble et le reste reste en anglais. Les fragments qui changent à l'exécution utilisent {placeholders}, comme uploading: 'Uploading {name}…' et pages: '{n} pages'.

CléValeur par défaut en anglais
dropPromptDrag & drop a PDF or Word file here
dropHintPDF or Word (.docx)
chooseFileChoose file
signatureHeadingYour signature
modeDraw / modeType / modeImageDraw / Type / Image
metaSummarySignature details (optional)
metaSignerName / metaReason / metaLocationSigner name / Reason / Location
signatureTypeSignature type
modeCertified / modeVisualDigital signature / Visual only
modeVisualNoteNo certificate — a visible mark only, not cryptographically verifiable.
outputFormatOutput format
outputPdf / outputWordPDF / Word (.docx)
signActionSign document
downloadDownload
demoNoticeDemo — signed with the Doconut demo certificate; output is watermarked.
signingNotEnabledSigning is not enabled on this server.
page / pages1 page / {n} pages

D'autres clés couvrent l'étape de placement, l'écran d'erreur, le formulaire lié de l'avis de démonstration (demoNoticePrefix, demoNoticeLink, demoNoticeSuffix) et les annonces aria-live.

Lorsque open ou run répond 404 sans erreur JSON, le widget affiche signingNotEnabled. Une erreur JSON du serveur l'emporte toujours, ainsi les messages comme un téléchargement expiré restent visibles.

Thématisation

Le widget ajoute la classe dsw à son élément de montage et lit ses couleurs, rayons et polices à partir des propriétés personnalisées CSS, de sorte que vous pouvez le thématiser sans toucher à son interne :

css
#host.dsw {
  --dsw-accent: #b0522b;       /* liens, focus, mode actif */
  --dsw-bg: #fffaf3;
  --dsw-fg: #3b2a1a;
  --dsw-muted: #8a7a68;
  --dsw-border: #e0cbb0;
  --dsw-radius: 14px;
  --dsw-font: Georgia, "Times New Roman", serif;
  --dsw-signature-font: "Segoe Script", "Brush Script MT", cursive;   /* le mode Type */
}

Valeurs par défaut : --dsw-accent: #2b6cb0, --dsw-bg: #ffffff, --dsw-fg: #1a202c, --dsw-muted: #718096, --dsw-border: #cbd5e0, --dsw-radius: 8px, une police d'interface système, et une police cursive pour la signature.

Créez votre propre interface

Le widget est un client pour ce contrat HTTP. Les trois routes se trouvent sous le chemin où UseDoconut() est monté (normalement /doconut), et elles répondent 404 jusqu'à ce que AddSignerWidget() soit appelé. Les erreurs contiennent un corps JSON, { "error": "..." }, sauf lorsque le tableau indique « status only ». Une valeur inconnue de ?sign= répond 400.

RouteObjectifRéponse en cas de succès
POST ?sign=open (multipart, un fichier)Téléversez un PDF ou .docx et ouvrez‑le pour aperçu200 — { token, name, pages, ext }
POST ?sign=run (corps JSON)Signez le fichier téléversé200 — { downloadToken, downloadName, watermarked }
GET ?sign=download&token=<downloadToken>Diffusez le fichier signé200 — le fichier, Content-Disposition: attachment, Cache-Control: no-store

ext dans la réponse open inclut le point initial (".docx"). L'aperçu de la page utilise la route d'image du visualiseur standard, {basePath}?token={token}&page={n}&thumb=1&width={px} ; la page affichée devient placement.page.

Le corps run :

json
{
  "token": "GUID-from-open",
  "signature": { "kind": "Drawn", "payload": "<base64 PNG, no data: prefix>" },
  "placement": { "page": 1, "x": 0.58, "y": 0.80, "w": 0.32, "h": 0.12 },
  "meta": { "signerName": "Ada Lovelace", "reason": "I approve", "location": "London, UK" },
  "wordOutput": "pdf",
  "mode": "certified"
}
ChampNotes
tokenLe jeton de open
signature.kindDrawn, Typed ou Image, insensible à la casse ; tout autre devient Drawn. Un indice seulement : la charge utile est toujours un PNG
signature.payloadUn PNG base64 brut, sans préfixe data:. Il doit s'agir d'un vrai PNG et ne pas dépasser MaxSignatureImageKb une fois décodé
placement.pageIndexé à 1
placement.x / y / w / h0..1 normalisé depuis le coin supérieur gauche, avec x + w ≤ 1 et y + h ≤ 1
meta.signerName / reason / locationFacultatif. Chaque valeur est tronquée, une valeur vide est ignorée, et chaque champ est limité à 256 caractères
wordOutputpdf (par défaut) ou docx ; ignoré pour les sources PDF. Tout autre devient pdf
modecertified (par défaut) ou visual. Tout autre devient certified

downloadName suit la sortie : <source>-signed.pdf ou <source>-signed.docx, et download envoie le Content-Type correspondant.

La source téléversée et le résultat signé sont chacun conservés pendant 30 minutes. Après cela, run et download répondent 404 et le fichier doit être rouvert. Tous les jetons sont des GUID.

RouteStatutQuandCorps
any404Le widget n'est pas activéstatus only
any405Verbe incorrect (open et run nécessitent POST, download nécessite GET)status only
open400Pas un téléversement multipartExpected a multipart file upload.
open400Aucun fichier, ou un fichier videNo file uploaded.
open400Tout autre que .pdf ou .docxSigning supports PDF and Word (.docx) files only.
open413Le téléversement dépasse MaxUploadMbFile is too large.
run400Le corps n'est pas un JSON valide, ou est videMalformed request. / Empty request.
run400Le jeton est manquant ou n'est pas un GUIDInvalid token.
run404Le téléversement a expiré ou n'a jamais été ouvertUpload expired — please re-open the file.
run400Pas de signature, ou aucun placementNo signature supplied. / No placement supplied.
run400La charge utile n'est pas en base64, est vide, trop grande, ou n'est pas un PNGSignature image is not valid base64. / Signature image is empty. / Signature image is too large. / The signature image must be a PNG.
run400Le placement est hors de la pageThe signature or its placement is invalid.
run400Mode certifié, une licence payante et aucun certificatNo signing certificate configured.
run400Mode certifié avec un certificat hors de sa période de validitéThe signing certificate expired on yyyy-MM-dd. / The signing certificate is not valid before yyyy-MM-dd.
open, run500Traitement échouéUn message assaini
download400Le jeton est manquant ou n'est pas un GUIDstatus only
download404Jeton inconnu ou expiréstatus only

Un parcours complet avec fetch :

javascript
// file: le fichier à signer; pngBase64: la signature sous forme de PNG base64 brut, sans préfixe data:,
// par exemple canvas.toDataURL('image/png').split(',')[1].
async function signFile(file, pngBase64) {
  const base = '/doconut';

  // 1. open: téléverser le fichier
  const form = new FormData();
  form.append('file', file, file.name);
  const opened = await (await fetch(base + '?sign=open', { method: 'POST', body: form })).json();

  // 2. run: le signer
  const signed = await (await fetch(base + '?sign=run', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      token: opened.token,
      signature: { kind: 'Drawn', payload: pngBase64 },
      placement: { page: 1, x: 0.58, y: 0.80, w: 0.32, h: 0.12 },
      meta: { signerName: 'Ada Lovelace', reason: 'I approve', location: 'London, UK' },
      wordOutput: 'pdf',
      mode: 'certified'
    })
  })).json();

  // 3. download: récupérer le fichier signé
  const blob = await (await fetch(base + '?sign=download&token=' + encodeURIComponent(signed.downloadToken))).blob();
  const link = document.createElement('a');
  link.href = URL.createObjectURL(blob);
  link.download = signed.downloadName;
  link.click();
  URL.revokeObjectURL(link.href);
}

Les points de terminaison sont same-origin : cette version ne prend pas en charge CORS. Servez votre UI et le script du widget depuis la même origine que Doconut, ou reverse-proxy les deux chemins /doconut (le chemin du middleware et le chemin des ressources) sous l'origine de votre UI.

En production

  1. Installez le plugin à côté du paquet principal, à la même version : dotnet add package Doconut.NET8.Signer.

  2. Ajoutez le fichier de licence. Placez Doconut.Viewer.Signer.lic dans le même dossier que Doconut.Viewer.lic.

  3. Obtenez votre certificat au format PFX avec sa clé privée et sa chaîne d'émetteur, auprès d'une autorité de certification ou de la PKI interne de votre organisation. Pour tester d'abord, utilisez une licence de démonstration (le certificat de démonstration intégré, filigrané) ou un PFX auto-signé.

  4. Lisez le certificat depuis la configuration, afin que le modifier ne nécessite jamais de changement de code :

    json
    "DoconutSigner": { "PfxPath": "certs/your-certificate.pfx" }
    csharp
    var signerSettings = builder.Configuration.GetSection("DoconutSigner");
    
    builder.Services.AddDoconut(options =>
    {
        options.LicensePath = "Doconut.Viewer.lic";
        options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
        options.AddSignerWidget(widget => widget.SigningCertificate = new SigningCertificate
        {
            PfxPath = Path.Combine(builder.Environment.ContentRootPath, signerSettings["PfxPath"]),
            Password = signerSettings["Password"] ?? "",
        });
    });

    Conservez le .pfx en dehors de wwwroot, et gardez le mot de passe hors de appsettings.json : secrets utilisateur en développement (dotnet user-secrets set "DoconutSigner:Password" "<password>"), une variable d'environnement (DoconutSigner__Password) ou un coffre-fort en production.

  5. Vérifiez le journal de démarrage. Il devrait afficher using certificate '{subject}' (valid until …). Signatures are digitally sealed.. Un avertissement signifie que le certificat est expiré, pas encore valide, ou n'est pas émis pour la signature de documents.

Confiance dans les lecteurs PDF. Un lecteur affiche la signature comme valide lorsqu'il fait confiance à la racine du certificat. Avec la PKI de votre organisation, cela s'applique à chaque machine qui fait confiance à votre racine, ce qui est généralement chaque machine au sein de l'organisation. Les certificats qu'Adobe accepte sur n'importe quelle machine (la Adobe Approved Trust List) sont, à notre connaissance, émis avec la clé privée sur un token matériel ou un HSM, ce que ce plugin ne peut pas utiliser : il signe uniquement à partir d'un PFX. Confirmez avec votre fournisseur de certificats avant de vous fier à ce type de confiance.

Fermes Web

Le widget conserve chaque téléchargement et son résultat en mémoire sur le nœud qui a servi open. Derrière un équilibreur de charge sans sessions persistantes, une requête run, download ou de prévisualisation ultérieure peut atteindre un autre nœud et ne pas trouver le téléchargement. Enregistrez le magasin partagé et chiffré du widget une seule fois, après AddDoconut() :

csharp
byte[] farmKey = Convert.FromBase64String(builder.Configuration["Doconut:FarmKey"]);

builder.Services.AddDoconutDistributedWidgets(store =>
{
    store.RootPath = @"\\fileshare\doconut";   // un dossier que chaque nœud peut lire et écrire
    store.FarmKey = farmKey;                   // au moins 32 octets, identique sur chaque nœud
    // store.Ttl = TimeSpan.FromMinutes(30);   // durée pendant laquelle un téléversement est conservé (par défaut)
});
  • Un serveur unique n'a besoin de rien : sans cet appel, le magasin en mémoire est utilisé.
  • Les téléchargements et les résultats sont chiffrés au repos sur le partage (AES‑256, encrypt‑then‑MAC), et chaque fichier est lié à son token, de sorte qu'un token ne peut jamais lire le fichier d'un autre.
  • FarmKey doit faire au moins 32 octets et être identique sur chaque nœud. Chargez‑le depuis un magasin de secrets ; ne le codez jamais en dur. L'enregistrement lève un ArgumentException lorsque RootPath est manquant ou que FarmKey est plus court que 32 octets.
  • Pointez RootPath vers le même emplacement partagé utilisé par le visualiseur distribué, et fournissez à chaque nœud le même certificat de signature.

Référence de l'API

La façade et les options du widget se trouvent dans l'espace de noms Doconut ; les types de requête et de résultat sont dans Doconut.Core.Models.Signing. SignerPlugin se trouve dans Doconut.Plugins.Signer.

DocumentSigner

csharp
public sealed class DocumentSigner
{
    public Task<SignResult> SignAsync(
        Stream source, string sourceExtension, SignRequest request,
        SigningCertificate? cert = null, CancellationToken ct = default);
}

Résolu via l'injection de dépendances ; le constructeur est interne. sourceExtension est ".pdf" ou ".docx". Sous une licence payante, cert est utilisé et la sortie est propre ; sous une licence temporaire, le certificat de démonstration intégré est utilisé, cert est ignoré, et la sortie porte un filigrane.

SignRequest

csharp
public sealed record SignRequest(
    VisibleSignature   Signature,
    SignaturePlacement Placement,
    string?            SignerName = null,
    string?            Reason     = null,
    string?            Location   = null,
    WordOutput         WordOutput = WordOutput.Pdf,
    SignatureMode      Mode       = SignatureMode.Certified)
{
    public bool IsValid { get; }   // Signature.IsValid && Placement.IsValid
}

Une signature visible placée une fois, plus des métadonnées facultatives du signataire.

VisibleSignature et SignatureKind

csharp
public sealed record VisibleSignature(SignatureKind Kind, byte[] PngBytes)
{
    public bool IsValid { get; }   // PngBytes n'est pas vide
}

public enum SignatureKind { Drawn, Typed, Image }

PngBytes est un PNG pour chaque type. Une signature dessinée ou tapée est transparente ; une image téléchargée conserve la transparence qu'elle possédait, ainsi un JPG opaque reste opaque. Kind n'est qu'une indication.

SignaturePlacement

csharp
public readonly record struct SignaturePlacement(int Page, double X, double Y, double W, double H)
{
    public bool IsValid { get; }   // Page >= 1; X, Y >= 0; W, H > 0; X + W <= 1; Y + H <= 1
}

Page est basé sur 1 ; X, Y, W et H sont des 0..1 normalisés depuis le coin supérieur gauche.

SignatureMode et WordOutput

csharp
public enum SignatureMode { Certified, Visual }   // Certified est la valeur par défaut
public enum WordOutput { Pdf, Docx }              // Pdf est la valeur par défaut; ignoré pour les sources PDF

SignResult

csharp
public sealed record SignResult(Stream Stream, string Extension);

Le document signé sous forme de flux consultable, et son extension avec le point (".pdf" ou ".docx").

SigningCertificate

csharp
public sealed class SigningCertificate
{
    public byte[]? PfxBytes { get; init; }
    public string? PfxPath  { get; init; }
    public string  Password { get; init; } = "";
    public bool    HasMaterial { get; }   // PfxBytes n'est pas vide, ou PfxPath n'est pas vide
}

Définissez soit PfxBytes, soit PfxPath, ainsi que Password.

SignerWidgetOptions

csharp
public sealed class SignerWidgetOptions
{
    public int MaxUploadMb { get; set; } = 25;
    public int MaxSignatureImageKb { get; set; } = 512;
    public SigningCertificate? SigningCertificate { get; set; }
}

Défini via DoconutOptions.AddSignerWidget(Action<SignerWidgetOptions>? configure = null), qui renvoie le DoconutOptions afin que les appels puissent être chaînés. Un SigningCertificate nul signifie le certificat de démonstration sous licence temporaire, et les signatures Visuelles uniquement sous licence payante.

Dépannage

SymptômeCauseSolution
AddDoconut() lance The Signer plugin is registered via AddPlugin but no active license grants Signer.Pas de licence, un fichier TRIAL, une licence sans Signer, ou une licence payante hors de sa fenêtre de versionInstallez une licence qui accorde Signer, ou supprimez AddPlugin<SignerPlugin>()
AddDoconut() lance AddSignerWidget() was called but the Signer plugin is not registered.Le widget est activé sans son pluginAjoutez options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>()
AddDoconut() lance Doconut Signer: the certificate file was not found at '{path}'.PfxPath pointe vers un fichier manquantCorrigez le chemin ; déployez le fichier à un endroit où le compte de l'application peut le lire
AddDoconut() lance Doconut Signer: the signing certificate could not be opened — the password is incorrect or the file is not a valid .pfx.Mot de passe incorrect, ou ce n'est pas un fichier PKCS#12Vérifiez le mot de passe ; utilisez un vrai .pfx
AddDoconut() lance Doconut Signer: the signing certificate has no private key. Re-export the .pfx INCLUDING the private key.Le PFX a été exporté sans sa clé privéeExportez-le à nouveau avec la clé privée
La résolution de DocumentSigner lance No IDocumentSigner is registered.SignerPlugin n'est pas enregistréAjoutez AddPlugin<SignerPlugin>() à l'intérieur de AddDoconut()
La sortie porte un filigraneLa licence est temporaire (Démo/NFR)Utilisez une licence payante qui accorde Signer
run répond 400 No signing certificate configured.Une licence payante, le mode Certifié, et aucun certificatConfigurez SigningCertificate, ou signez en mode Visuel
run répond 400 The signing certificate expired on yyyy-MM-dd.Le certificat est périméRemplacez-le ; les signatures Visuelles continuent de fonctionner en attendant
Le journal indique que la sortie « utilise le certificat de démonstration intégré », pourtant une licence payante refuse les signatures CertifiéesCette ligne est écrite chaque fois qu'aucun certificat n'est configuré, quelle que soit la licenceConfigurez SigningCertificate
Le widget se charge mais indique Signing is not enabled on this server.AddSignerWidget() n'a pas été appelé, ou basePath ne correspond pas à l'endroit où UseDoconut() est montéAppelez AddSignerWidget() ; corrigez basePath
run répond 400 The signature image must be a PNG., Signature image is not valid base64. ou Signature image is too large.Une UI personnalisée a envoyé une URL data:, un JPG, ou plus de MaxSignatureImageKbEnvoyez un PNG base64 brut dans la capacité
open répond 413 File is too large.Le téléchargement dépasse MaxUploadMbAugmentez MaxUploadMb dans AddSignerWidget ; le maxUploadMb du widget n'est qu'une vérification côté client
run ou download répond 404 Upload expired — please re-open the file.La fenêtre de 30 minutes est écoulée, ou un nœud du web‑farm n'a pas le téléchargementRouvrez le fichier ; dans un farm, enregistrez AddDoconutDistributedWidgets
Un .docx signé n'affiche aucune signature dans certains visionneursLa sortie Word contient une signature de paquet OOXML, que de nombreux visionneurs n'affichent pasSignez en PDF, par défaut
Les lecteurs PDF indiquent que l'identité du signataire est inconnueLe lecteur ne fait pas confiance à la racine du certificat (le certificat de démonstration n'est jamais fiable)Utilisez un certificat provenant d'une racine de confiance pour vos lecteurs
Le widget échoue lorsque l'UI se trouve sur une autre origineLes points de terminaison n'ont pas de support CORSServez l'UI depuis la même origine, ou reverse‑proxy les chemins Doconut
Le thème ne s'applique pasLe sélecteur cible un élément à l'intérieur du montageCiblez le montage lui‑même : #host.dsw ou #host

Cette page était-elle utile ?