Signer Eklentisi

PDF ve Word belgelerini görünür bir imza ve dijital mühürle imzalayın

Signer eklentisi bir belgeye görünür bir imza ekler ve varsayılan olarak PDF okuyucularının doğrulayabileceği bir dijital imza ile mühürler. PDF ve Word (.docx) dosyalarını imzalar. Görünür imza her zaman bir PNG görüntüsüdür: imzalayan tarafından çizilmiş, yazılmış veya yüklenmiş.

YüzeyNe zaman kullanılır
DocumentSigner (C#)Sunucuda imzalarsınız, tarayıcı kullanılmaz
Drop-in widget (doconutSigner.js)Sayfanızda hazır bir yükleme, imzalama ve indirme ekranı istiyorsunuz
HTTP endpoints (?sign=open|run|download)Belgelendirilmiş bir sunucu sözleşmesine karşı kendi imzalama arayüzünüzü oluşturursunuz

Her imza bir kez, tek bir sayfaya yerleştirilir. İmzalayanın adı, nedeni ve konumu onunla birlikte taşınabilir.

Paketi Yükleyin

En son kararlı Signer eklentisini kurun:

bash
dotnet add package Doconut.NETStandard.Signer

Bu belgelerin açıkladığı sürüme eklentiyi sabitlemek için sürümü ayrı olarak geçirin:

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

Signer paketini Doconut.NETStandard ile aynı sürümde tutun. Paket kimliği Doconut.NETStandard.Signer; .<version> yalnızca indirilen .nupkg dosya adında görünür.

Eklentinin lisans dosyası, Doconut.Viewer.Signer.lic, Doconut.Viewer.lic ile aynı klasöre konur; görüntüleyici lisansı ile birlikte okunur.

Eklentiyi Kaydedin

Her Doconut eklentisi gibi, Signer AddPlugin<TPlugin>() içinde AddDoconut() ile kaydedilir:

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

Bu, C# katmanının ihtiyacı olan tek şeydir. Widget ve HTTP uç noktaları ayrı bir opt‑in'dir, AddSignerWidget() (bkz. Gömülü widget).

Eklenti, Signer yetkisini veren bir lisansa ihtiyaç duyar. Böyle bir lisans olmadan, AddDoconut() başlangıçta, uygulama bir istek hizmet etmeden önce hata verir:

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.

Lisans yok, eski bir TRIAL dosyası, Signer içermeyen bir lisans ve sürüm penceresinin dışındaki bir ücretli lisans için hata verir. Geçici Demo/NFR lisansları kabul edilir. Lisansların nasıl yüklendiği için Lisans Kurulumu bölümüne bakın.

Lisanslama ve filigran

Lisans durumuBaşlangıçSertifikalı imzaGörsel imza
Ücretli lisans, Signer yetkisi verir, sertifika yapılandırılmışBaşlarSertifikanızla mühürlenir, temiz (watermarked: false)Temiz
Ücretli lisans, Signer yetkisi verir, sertifika yokBaşlarReddedildi: No signing certificate configured.Temiz
Ücretli lisans, sertifika süresi dolmuş veya henüz geçerli değilBaşlar (widget etkinleştirildiğinde, bir Uyarı kaydedilir)Reddedildi: The signing certificate expired on yyyy-MM-dd.Temiz
Geçici Demo/NFR lisansı, aktif veya süresi dolmuşBaşlarYerleşik demo sertifikasıyla mühürlenir, filigranlı (watermarked: true)Filigranlı
Lisans yok, eski bir TRIAL dosyası, Signer içermeyen bir lisans veya sürüm penceresinin dışındaki bir ücretli lisansAddDoconut() hata verir——

Kural, C# katmanı ve widget için aynıdır: lisans ücretli bir görüntüleyici lisansı değilse veya geçici ise çıktı filigranlı olur. Geçici bir lisans altında eklenti her zaman yerleşik demo sertifikasıyla imzalar ve yapılandırdığınız herhangi bir sertifika kullanılmaz.

Demo sertifikası gerçek bir mühür üretir, ancak PDF okuyucularına güvenilir değildir. Bir entegrasyon, değerlendirme lisansı üzerinde uçtan uca oluşturulup test edilebilir; temiz ve güvenilir çıktı almak için hem ücretli bir lisansa hem de kendi imzalama sertifikanıza ihtiyacınız vardır.

C#'dan Kullanım

DocumentSigner, AddDoconut() tarafından kaydedilir ve bağımlılık enjeksiyonundan çözülür. Yapıcı içsel olduğundan, asla new etmeyin. AddPlugin<SignerPlugin>() olmadan çözümlemek No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>(). fırlatır.

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 varsayılan olarak Certified (görünür imza + dijital mühür); WordOutput varsayılan olarak 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, kaynak akışı, uzantısını (".pdf" veya ".docx"), isteği ve sertifikayı bu çağrı için alır. Facade, SignerWidgetOptions.SigningCertificate'ı okumaz; bu ayar widget içindir. null'ı demo lisansı altında ya da Görsel modda geçirin.

SignResult, imzalı belgeyi aranabilir bir akış olarak tutar, ayrıca dosyayı adlandırabilmeniz için Extension'ını (".pdf" veya ".docx") içerir. Akış sizin: işiniz bittiğinde onu serbest bırakın.

Görsel bir imza yalnızca resmi damgalayarak çalışır ve sertifika gerektirmez:

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);

Bir Word kaynağı, Word çıktısı istemediğiniz sürece PDF'ye imzalanır. Sonucu result.Extension'dan adlandırın:

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, çağrı başarılı olamadığında döndürmek yerine fırlatır:

İstisnaMesajNe Zaman
InvalidOperationExceptionNo signing certificate configured.Sertifikalı mod, ücretli lisans ve sertifika gönderilmediğinde
InvalidOperationExceptionThe signing certificate expired on yyyy-MM-dd. / The signing certificate is not valid before yyyy-MM-dd.Sertifikalı mod, geçerlilik süresi dışındaki bir sertifika ile
ArgumentExceptionThe sign request is invalid: the visible signature needs PNG bytes and the placement must be a normalized rectangle on a 1-based page.Boş PNG baytları veya geçerli olmayan bir yerleştirme
NotSupportedExceptionThe signer supports PDF and Word (.docx) documents; got '{extension}'.Diğer herhangi bir kaynak türü

İmza modları, Word çıktısı ve sertifikalar

İmza modları

SignRequest.Mode, imzanın mühürlenip mühürlenmeyeceğini seçer.

ModNe üretirSertifikaDoğrulanabilir
SignatureMode.Certified (default)Görünür imza ve dijital bir mühürÜcretli lisans altında gereklidirEvet
SignatureMode.VisualYalnızca görünür imzaAsla gerekmezHayır: bu bir resim

Certified'ı, imzanın kanıtlanabilir olması gerektiğinde kullanın: onaylar, sözleşmeler, doğrulayıcının kimlik ve bütünlüğü kontrol etmesi gereken her şey. Visual'ı, yalnızca imzanın görünümüne ihtiyacınız olduğunda veya sertifikanız olmadığında kullanın. Geçici bir lisans her ikisine de filigran ekler.

PDF mühürleri, RSA veya ECDSA anahtarları için SHA-256 kullanan PKCS#7 ayrık imzalar (adbe.pkcs7.detached)dır. PFX dosyanızda bulunan veren sertifikalarını taşırlar, böylece kökünüzü güvenen bir okuyucu zinciri oluşturabilir. Word‑yerel mühürler OOXML paket imzalarıdır ve yalnızca imzalayanın sertifikasını içerir.

Word belgeleri

.docx kaynağı için, SignRequest.WordOutput çıktıyı seçer. PDF kaynakları için göz ardı edilir, çünkü her zaman bir PDF üretir.

ÇıktıNe olurDoğrulayıcı desteği
WordOutput.Pdf (varsayılan)Belge PDF'ye dönüştürülür, ardından imzalanır ve mühürlenirGeniş: imzalı bir PDF her yerde doğrulanır
WordOutput.DocxBelge Word olarak kalır: imza resmi içine yerleştirilir, ayrıca bir OOXML paket imzası eklenirSınırlı: her görüntüleyici OOXML paket imzalarını göstermez

Alıcı düzenlenebilir bir Word dosyasına ihtiyaç duymuyorsa ve sınırlı doğrulayıcı desteğini kabul ediyorsa PDF tutun.

Sertifika kurulumu

Kendi kimliğinizle mühürlemek için, eklentiye özel anahtarı içeren bir PFX (PKCS#12) dosyası verin. Widget için SignerWidgetOptions.SigningCertificate ayarlayın; C# arayüzü için sertifikayı SignAsync'a geçirin. Ya baytları ya da bir yolu, ayrıca şifreyi sağlayın:

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"],
        };
    });
});

Sertifika yalnızca bellek içinde tutulur. Asla günlük kaydına alınmaz, bir istemciye döndürülmez veya kalıcı olarak saklanmaz ve şifre hiçbir zaman bir günlük satırında ya da hata mesajında görünmez.

Gereksinimler:

  • Özel anahtarı olan bir PFX / PKCS#12 paketi. Sadece genel anahtar içeren bir dosya (.cer, .crt) imza atamaz. İhraç zincirini de dışa aktarın, böylece PDF mühürleri onu taşıyabilir.
  • Doğru şifre.
  • Geçerlilik süresi içinde. Süresi dolmuş veya henüz geçerli olmayan bir sertifika uygulamayı durdurmaz: başlangıçta Uyarı olarak kaydedilir ve Sertifikalı imzalar, yerine konulana kadar reddedilir. Görsel imzalar etkilenmez.
  • Belge imzalama için düzenlenmiş: digital signature veya non-repudiation anahtar kullanımına sahip ve varsa belge imzalama, e-posta koruması veya istemci kimlik doğrulaması sağlayan genişletilmiş anahtar kullanımı. TLS sunucu sertifikası gibi başka bir amaç için düzenlenmiş bir sertifika yine imza atar, ancak Uyarı olarak kaydedilir ve PDF okuyucular imzayı işaretler.
  • Donanım tokenları, akıllı kartlar, HSM'ler ve Windows sertifika deposu desteklenmez. Sertifikayı, özel anahtarı ve zinciriyle birlikte bir PFX'ye dışa aktarın.

OpenSSL ile bir sertifikadan ve özel anahtarından PFX oluşturun:

bash
openssl pkcs12 -export -out signing.pfx -inkey private.key -in certificate.crt
# İstenen dışa aktarma parolası SigningCertificate.Password'dir.

Windows sertifika deposundan bir tane dışa aktarın: certmgr.msc'ı açın ve sertifikayı bulun (özel anahtar mevcut olduğunda simgesi bir anahtar gösterir). Sağ tıklayın, All Tasks → Export… seçeneğini seçin, Yes, export the private key seçeneğini işaretleyin, Personal Information Exchange – PKCS #12 (.PFX) seçin ve bir şifre belirleyin.

Başlangıç kontrolleri

Widget etkinleştirildiğinde, SignerWidgetOptions.SigningCertificate içindeki sertifika bir kez, AddDoconut() içinde kontrol edilir, böylece hatalı yapılandırılmış bir PFX ilk imzadan ziyade başlangıçta başarısız olur. Üç sorun bir InvalidOperationException fırlatır:

MesajDüzeltme
Doconut Signer: the certificate file was not found at '{path}'.PfxPath'ı düzeltin; dosyanın uygulamanın hesabı tarafından dağıtıldığından ve okunabildiğinden emin olun
Doconut Signer: the signing certificate could not be opened — the password is incorrect or the file is not a valid .pfx.Şifreyi kontrol edin; dosyanın gerçek bir .pfx olduğundan, bir .cer veya .pem olmadığından emin olun
Doconut Signer: the signing certificate has no private key. Re-export the .pfx INCLUDING the private key.PFX'yi tekrar özel anahtarla dışa aktarın

Aksi takdirde, ana bilgisayar başlatıldığında günlüğe bir satır yazar. Sertifika hazır olduğunda bilgi:

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

Geçerli olmadığında, henüz geçerli olmadığında veya belge imzalama için düzenlenmediğinde bir Uyarı:

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.

Ve hiçbir sertifika yapılandırılmadığında Bilgi:

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.

Son satır her lisans altında aynıdır. Ücretli bir lisans altında demo sertifikası hiç kullanılmaz: sertifika olmadığında yalnızca Görsel imzalar çalışır.

C# arayüzü başlangıçta kontrol edilmez. SignAsync'a geçirdiğiniz sertifika imzalarken okunur, bu yüzden yanlış bir yol veya şifre o çağrıyı başarısız kılar.

Yerleştirilebilir widget

Uç noktaları etkinleştir

Widget'ın ?sign=open|run|download uç noktaları varsayılan olarak kapalıdır. Eklenti kaydı yanında bunları etkinleştirin:

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
    options.AddSignerWidget(widget =>
    {
        widget.MaxUploadMb = 25;           // varsayılan
        widget.MaxSignatureImageKb = 512;  // varsayılan
        // widget.SigningCertificate: Certificate kurulumuna bakın; demo (su damgalı) imzalama için null bırakın
    });
});

AddSignerWidget() argümansız olarak widget'ı varsayılanlarla etkinleştirir. Tek başına imzalama yetkisi vermez: AddPlugin<SignerPlugin>() gerekir, ya da AddDoconut() hata verir:

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.

AddSignerWidget() olmadan, her ?sign= isteği 404 yanıtını verir. Betik hâlâ sunulur, bu yüzden widget yüklenir ve bırakma bölgesini çizer, ardından ilk isteğinde Signing is not enabled on this server. rapor eder.

Göm

UseDoconutResources(), betiği {ResourcesPath}/js/doconutSigner.js adresinde (varsayılan /doconut-res/js/doconutSigner.js) sunar. Bağımlılığı olmayan tek bir, bağımsız dosyadır:

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) bir CSS seçicisi ya da bir öğe alır, bağlama bulunamazsa hata verir ve bir tutamaç döndürür.

İmzalayan bir PDF ya da .docx dosyası yükler, bir imza oluşturur (Draw bir kanvas üzerinde, Type bir ismi imza fontunda, ya da Image bir PNG, JPG veya GIF'den), sayfaya sürükler ve yeniden boyutlandırır, ardından imzalar ve sonucu indirir. Widget her zaman imzayı PNG olarak gönderir; yüklenen görsel tarayıcıda 520×160 boyutlarına uyan bir PNG'ye dönüştürülür.

Seçenekler

SeçenekTürVarsayılanNotlar
basePathstring'/doconut'?sign= uç noktalarının ve ön izleme görsellerinin sunulduğu yer
resPathstring'/doconut-res'Ayrılmış; widget kendi CSS'ini paketler
maxUploadMbnumber25Yalnızca istemci tarafı kontrolü, bu yüzden aşırı büyük bir dosya hızlıca reddedilir. Sunucu sınırı AddSignerWidget içinde MaxUploadMb
maxSignatureKbnumber512Görsel mod için istemci tarafı sınırı. Sunucunun MaxSignatureImageKb değerine eşit tutun
previewWidthnumber560Sayfa ön izlemesinin piksel genişliği
licenseUrlstring | nullnullDemo-su işareti uyarısını bu URL'ye bir bağlantıya dönüştürür
signatureModestring'certified'İlk imza türü: 'certified' veya 'visual'. Diğer tüm değerler 'certified' olur
showSignatureModeTogglebooleantrueDigital signature / Visual only seçeneğini gösterir. false ile widget, signatureMode ile imzalar
wordOutputstring'pdf'.docx kaynakları için ilk çıktı: 'pdf' veya 'docx'. Diğer tüm değerler 'pdf' olur
showOutputFormatTogglebooleantruePDF / Word seçeneğini gösterir, yalnızca .docx kaynakları için. false ile widget, wordOutput kullanır
labelsobject{}İngilizce dizelerin herhangi bir alt kümesini geçersiz kılar

Bir geçişi gizlemek özelliği devre dışı bırakmaz; değeri sabitler. İki yaygın yapılandırma:

javascript
// Her iki anahtar da gösterilir, dijital imza varsayılan olarak: tam bir self-service imzalayan.
Doconut.signer('#host', { basePath: '/doconut', licenseUrl: '/pricing' });
javascript
// Sadece görsel, toggle yok: dijital imza sunulmayan basit bir damga.
Doconut.signer('#host', {
  basePath: '/doconut',
  signatureMode: 'visual',
  showSignatureModeToggle: false
});

Geri Çağrılar

Geri ÇağrıNe zaman tetiklenirYük
onReadyMount sırasında bir kez (reset() üzerinde tekrar tetiklenmez)—
onSourceLoadedDosya açılır ve önizlemesi gösterilir{ file: { token, name, pages, ext } }
onSignedİmzalama başarılı olur{ downloadToken, downloadName, watermarked }
onDownloadHer İndir tıklamasında{ downloadName, downloadToken }
onErrorAçma, imzalama veya indirme adımı başarısız olur ya da Görüntü-modu dosyası çok büyük{ message }

Atılan bir geri çağrı yakalanır ve kaydedilir; widget akışını asla bozmaz.

Zorunlu İşleyici

YöntemDavranış
reset()Bırakma ekranına döner ve mevcut akışı temizler. onReady tekrar tetiklenmez. destroy() sonrası etkisizdir.
loadFile(file)Bir File ile akışı başlatır. Widget bırakma ekranında değilse etkisizdir; gerekirse önce reset() çağırın.
destroy()Dinleyicileri kaldırır, mount'u boşaltır ve örneği dondurur
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());

Etiketler

Her dize İngilizce varsayılan bir değere sahiptir; labels herhangi bir alt kümesini geçersiz kılar ve geri kalanlar İngilizce kalır. Çalışma zamanında değişen parçalar {placeholders} kullanır, örneğin uploading: 'Uploading {name}…' ve pages: '{n} pages'.

Anahtarİngilizce varsayılan
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

Diğer anahtarlar yerleştirme adımını, hata ekranını, demo bildirisinin bağlanmış formunu (demoNoticePrefix, demoNoticeLink, demoNoticeSuffix) ve aria-live duyurularını kapsar.

open veya run, JSON hatası olmadan 404 yanıtladığında, widget signingNotEnabled gösterir. Sunucudan gelen bir JSON hatası her zaman önceliklidir, bu yüzden süresi dolmuş bir yükleme gibi mesajlar görünür kalır.

Temalandırma

Widget, mount öğesine dsw sınıfını ekler ve renklerini, yarıçapını ve yazı tiplerini CSS özel özelliklerinden okur, böylece iç yapısına dokunmadan temalandırabilirsiniz:

css
#host.dsw {
  --dsw-accent: #b0522b;       /* bağlantılar, odak, aktif mod */
  --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;   /* Type modu */
}

Varsayılanlar: --dsw-accent: #2b6cb0, --dsw-bg: #ffffff, --dsw-fg: #1a202c, --dsw-muted: #718096, --dsw-border: #cbd5e0, --dsw-radius: 8px, bir sistem UI yazı tipi ve el yazısı imza yazı tipi.

Kendi ön ucunuzu oluşturun

Widget, bu HTTP sözleşmesi için bir istemcidir. Üç rota da UseDoconut()'in monte edildiği yolun altında bulunur (genellikle /doconut), ve AddSignerWidget() çağrılana kadar 404 yanıt verir. Hatalar bir JSON gövdesi, { "error": "..." } taşır, tablo "yalnızca durum" dediği yerler hariç. Bilinmeyen bir ?sign= değeri 400 yanıtlar.

RotaAmaçBaşarı yanıtı
POST ?sign=open (çok parçalı, bir dosya)Bir PDF veya .docx yükleyin ve önizleme için açın200 — { token, name, pages, ext }
POST ?sign=run (JSON gövdesi)Yüklenen dosyayı imzalayın200 — { downloadToken, downloadName, watermarked }
GET ?sign=download&token=<downloadToken>İmzalanmış dosyayı akış olarak gönder200 — dosya, Content-Disposition: attachment, Cache-Control: no-store

ext, open yanıtında, önde gelen noktayı (".docx") içerir. Sayfa önizlemesi standart görüntüleyici resim rotasını kullanır, {basePath}?token={token}&page={n}&thumb=1&width={px}; gösterilen sayfa placement.page olur.

run gövdesi:

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"
}
AlanNotlar
tokenopen'den gelen token
signature.kindDrawn, Typed veya Image, büyük/küçük harfe duyarsız; başka her şey Drawn olur. Sadece bir ipucu: yük her zaman bir PNG'dir.
signature.payloadÖn ek data: olmayan çıplak base64 PNG. Gerçek bir PNG olmalı ve çözüldükten sonra MaxSignatureImageKb'dan büyük olmamalıdır.
placement.page1 tabanlı
placement.x / y / w / hÜst sol köşeden normalize edilmiş 0..1, x + w ≤ 1 ve y + h ≤ 1 ile
meta.signerName / reason / locationOpsiyonel. Her biri kırpılır, boş değer atılır ve her biri 256 karakterde kesilir.
wordOutputpdf (varsayılan) veya docx; PDF kaynakları için yok sayılır. Başka her şey pdf olur.
modecertified (varsayılan) veya visual. Başka her şey certified olur.

downloadName çıktıyı izler: <source>-signed.pdf veya <source>-signed.docx, ve download eşleşen Content-Type gönderir.

Yüklenen kaynak ve imzalanmış sonuç 30 dakika boyunca saklanır. Bundan sonra, run ve download 404 yanıtlar ve dosya tekrar açılmalıdır. Tüm token'lar GUID'dir.

RotaDurumNe zamanGövde
any404Widget etkin değilyalnızca durum
any405Yanlış verb (open ve run POST gerekir, download GET gerekir)yalnızca durum
open400Çok parçalı bir yükleme değilExpected a multipart file upload.
open400Dosya yok ya da boşNo file uploaded.
open400.pdf veya .docx dışındaki her şeySigning supports PDF and Word (.docx) files only.
open413Yükleme MaxUploadMb'ı aşıyorFile is too large.
run400Gövde geçerli JSON değil ya da boşMalformed request. / Empty request.
run400Token eksik ya da GUID değilInvalid token.
run404Yükleme süresi doldu ya da hiç açılmadıUpload expired — please re-open the file.
run400İmza yok ya da yerleştirme yokNo signature supplied. / No placement supplied.
run400Yük base64 değil, boş, çok büyük ya da PNG değilSignature image is not valid base64. / Signature image is empty. / Signature image is too large. / The signature image must be a PNG.
run400Yerleştirme sayfanın dışındadırThe signature or its placement is invalid.
run400Sertifikalı mod, ücretli lisans ve sertifika yokNo signing certificate configured.
run400Geçerlilik süresi dışındaki bir sertifika ile sertifikalı modThe signing certificate expired on yyyy-MM-dd. / The signing certificate is not valid before yyyy-MM-dd.
open, run500İşleme başarısız olduTemizlenmiş bir mesaj
download400Token eksik ya da GUID değilyalnızca durum
download404Bilinmeyen ya da süresi dolmuş tokenyalnızca durum

fetch ile tam bir tur:

javascript
// file: imzalanacak File; pngBase64: veri: öneki olmadan çıplak base64 PNG,
// örneğin canvas.toDataURL('image/png').split(',')[1].
async function signFile(file, pngBase64) {
  const base = '/doconut';

  // 1. open: dosyayı yükle
  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: imzala
  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: imzalanmış dosyayı al
  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);
}

Uç noktalar same-origin'dır: bu sürüm CORS desteği içermez. UI'nizi ve widget betiğini Doconut ile aynı origin'den sunun, ya da UI'nizin origin'i altında her iki /doconut yolunu da ters proxy yapın (middleware yolu ve kaynak yolu).

Üretimde

  1. Eklentiyi kurun çekirdek paketinin yanına, aynı sürümde: dotnet add package Doconut.NETStandard.Signer.

  2. Lisans dosyasını ekleyin. Doconut.Viewer.Signer.lic'yi Doconut.Viewer.lic ile aynı klasöre koyun.

  3. Sertifikanızı bir PFX olarak alın özel anahtarı ve veren zinciriyle birlikte, bir sertifika otoritesinden ya da kuruluşunuzun kendi PKI'sından. İlk olarak denemek için, bir demo lisansı (yerleşik demo sertifikası, filigranlı) ya da kendinden imzalanmış bir PFX kullanın.

  4. Sertifikayı yapılandırmadan okuyun, böylece değiştirildiğinde kod değişikliği gerekmez:

    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"] ?? "",
        });
    });

    .pfx'yi wwwroot dışında tutun ve şifreyi appsettings.json içinde tutmayın: geliştirmede kullanıcı gizli bilgileri (dotnet user-secrets set "DoconutSigner:Password" "<password>"), bir ortam değişkeni (DoconutSigner__Password) ya da üretimde bir kasa.

  5. Başlangıç kaydını kontrol edin. using certificate '{subject}' (valid until …). Signatures are digitally sealed. okuması gerekir. Bir Uyarı, sertifikanın süresi dolmuş, henüz geçerli değil ya da belge imzalama için verilmemiş olduğu anlamına gelir.

PDF okuyucularına güvenin. Bir okuyucu, kök sertifikaya güvendiğinde imzayı geçerli gösterir. Kuruluşunuzun PKI'sı ile bu, kökünüzü güvenen her makinede geçerlidir; bu genellikle kuruluş içindeki tüm makineler demektir. Adobe'nun herhangi bir makinede güvendiği sertifikalar (Adobe Approved Trust List) bizim bildiğimize göre, özel anahtarın bir donanım token'ı ya da HSM'de olduğu şekilde verilir; bu eklenti bunu kullanamaz: yalnızca bir PFX'ten imzalar. Bu tür bir güvene dayanmadığınızdan önce sertifika sağlayıcınızla teyit edin.

Web çiftlikleri

Widget, open hizmet veren düğümde her yüklemeyi ve sonucunu bellekte tutar. Yapışkan oturumlar olmadan bir yük dengeleyicinin arkasında, daha sonraki bir run, download ya da önizleme isteği başka bir düğüme ulaşabilir ve yüklemeyi bulamaz. Paylaşılan, şifreli widget deposunu bir kez, AddDoconut() sonrasında kaydedin:

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

builder.Services.AddDoconutDistributedWidgets(store =>
{
    store.RootPath = @"\\fileshare\doconut";   // her düğümün okuyup yazabileceği bir klasör
    store.FarmKey = farmKey;                   // her düğümde aynı olan en az 32 bayt
    // store.Ttl = TimeSpan.FromMinutes(30);   // bir yüklemenin ne kadar süre saklanacağı (varsayılan)
});
  • Tek bir sunucu hiçbir şeye ihtiyaç duymaz: bu çağrı olmadan bellek içi depo kullanılır.
  • Yüklemeler ve sonuçlar paylaşılda (AES-256, encrypt-then-MAC) dinlenirken şifrelenir ve her dosya token'ına bağlanır, böylece bir token başka birinin dosyasını asla okuyamaz.
  • FarmKey en az 32 bayt olmalı ve her düğümde aynı olmalıdır. Bir gizli depodan yükleyin; asla sabit kodlamayın. Kayıt, RootPath eksik olduğunda veya FarmKey 32 bayttan kısa olduğunda bir ArgumentException fırlatır.
  • RootPath'yi dağıtılmış görüntüleyici tarafından kullanılan aynı paylaşılan konuma yönlendirin ve her düğüme aynı imzalama sertifikasını verin.

API referansı

Facade ve widget seçenekleri Doconut ad alanındadır; istek ve sonuç tipleri Doconut.Core.Models.Signing içindedir. SignerPlugin Doconut.Plugins.Signer içindedir.

DocumentSigner

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

Bağımlılık enjeksiyonundan çözülür; yapıcı içtedir. sourceExtension ".pdf" veya ".docx"'dır. Ücretli bir lisans altında cert kullanılır ve çıktı temiz olur; geçici bir lisans altında yerleşik demo sertifikası kullanılır, cert yok sayılır ve çıktı su işaretiyle olur.

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
}

Bir kez yerleştirilen tek bir görünür imza, artı isteğe bağlı imzalayan meta verileri.

VisibleSignature and SignatureKind

csharp
public sealed record VisibleSignature(SignatureKind Kind, byte[] PngBytes)
{
    public bool IsValid { get; }   // PngBytes boş değil
}

public enum SignatureKind { Drawn, Typed, Image }

PngBytes her tür için bir PNG'dir. Çizilmiş veya yazılmış bir imza şeffaftır; yüklenen bir görüntü sahip olduğu şeffaflığı korur, bu yüzden opak bir JPG opak kalır. Kind sadece bir ipucudur.

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 1 tabanlıdır; X, Y, W ve H üst‑sol köşeden normalize edilmiş 0..1'dır.

SignatureMode and WordOutput

csharp
public enum SignatureMode { Certified, Visual }   // Certified varsayılan değerdir
public enum WordOutput { Pdf, Docx }              // Pdf varsayılan değerdir; PDF kaynakları için yok sayılır

SignResult

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

İmzalanmış belge, aranabilir bir akış olarak ve uzantısı nokta ile birlikte (".pdf" veya ".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 boş değil, veya PfxPath boş değil
}

PfxBytes veya PfxPath ve ayrıca Password ayarlayın.

SignerWidgetOptions

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

DoconutOptions.AddSignerWidget(Action<SignerWidgetOptions>? configure = null) aracılığıyla ayarlayın, bu DoconutOptions döndürür, böylece çağrılar zincirlenebilir. Null bir SigningCertificate geçici lisans altında demo sertifikasını, ücretli lisans altında ise yalnızca Görsel imzaları ifade eder.

Sorun Giderme

BelirtiNedenÇözüm
AddDoconut() The Signer plugin is registered via AddPlugin but no active license grants Signer. fırlatırLisans yok, bir TRIAL dosyası, Signer içermeyen bir lisans veya sürüm penceresinin dışında bir ücretli lisansSigner sağlayan bir lisans kurun veya AddPlugin<SignerPlugin>() kaldırın
AddDoconut() AddSignerWidget() was called but the Signer plugin is not registered. fırlatırWidget, eklentisi olmadan etkinleştirildioptions.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>() ekleyin
AddDoconut() Doconut Signer: the certificate file was not found at '{path}'. fırlatırPfxPath eksik bir dosyaya işaret ediyorYolu düzeltin; dosyayı uygulamanın hesabının okuyabileceği bir yere dağıtın
AddDoconut() Doconut Signer: the signing certificate could not be opened — the password is incorrect or the file is not a valid .pfx. fırlatırYanlış şifre veya PKCS#12 dosyası değilŞifreyi kontrol edin; gerçek bir .pfx kullanın
AddDoconut() Doconut Signer: the signing certificate has no private key. Re-export the .pfx INCLUDING the private key. fırlatırPFX, özel anahtarı olmadan dışa aktarıldıÖzel anahtarıyla tekrar dışa aktarın
DocumentSigner çözümlemesi No IDocumentSigner is registered. fırlatırSignerPlugin kayıtlı değilAddPlugin<SignerPlugin>()'ı AddDoconut() içine ekleyin
Çıktı su işaretiyleLisans geçicidir (Demo/NFR)Signer sağlayan bir ücretli lisans kullanın
run 400 No signing certificate configured. yanıt verirÜcretli bir lisans, Sertifikalı mod ve sertifika yokSigningCertificate yapılandırın veya Görsel modda imzalayın
run 400 The signing certificate expired on yyyy-MM-dd. yanıt verirSertifika süresi dolmuşDeğiştirin; Görsel imzalar bu sürede çalışmaya devam eder
Günlük, çıktının "yerleşik demo sertifikasını kullandığını" söylüyor, ancak ücretli bir lisans Sertifikalı imzalara izin vermiyorBu satır, lisans ne olursa olsun, hiçbir sertifika yapılandırılmadığında yazılırSigningCertificate yapılandırın
Widget yüklenir ancak Signing is not enabled on this server. diyorAddSignerWidget() çağrılmadı veya basePath, UseDoconut()'ın monte edildiği yerde eşleşmiyorAddSignerWidget() çağırın; basePath düzeltin
run 400 The signature image must be a PNG., Signature image is not valid base64. veya Signature image is too large. yanıt verirÖzel bir UI bir data: URL'si, bir JPG veya MaxSignatureImageKb'dan fazlasını gönderdiCap içinde çıplak bir base64 PNG gönderin
open 413 File is too large. yanıt verirYükleme MaxUploadMb'ı aşıyorAddSignerWidget içinde MaxUploadMb yükseltin; widget'ın maxUploadMb sadece istemci tarafı bir kontrol
run veya download 404 Upload expired — please re-open the file. yanıt verir30 dakikalık pencere geçti veya bir web-farm düğümü yüklemeye sahip değilDosyayı tekrar açın; bir farm içinde AddDoconutDistributedWidgets kaydedin
İmzalanmış bir .docx bazı görüntüleyicilerde imza göstermiyorWord çıktısı bir OOXML paket imzası taşır, birçok görüntüleyici bunu göstermezPDF'ye imzalayın, varsayılan
PDF okuyucular imzalayanın kimliğini bilinmeyen diyorOkuyucu, sertifikanın köküne güvenmez (demo sertifikası asla güvenilir değildir)Okuyucularınızın güvendiği bir kökten bir sertifika kullanın
Widget, UI başka bir origin'de olduğunda başarısız olurUç noktalar CORS desteğine sahip değilUI'yi aynı origin'den sunun veya Doconut yollarını ters proxy yapın
Tema uygulanmıyorSeçici, mount içinde bir öğeyi hedefliyorMount'u doğrudan hedefleyin: #host.dsw veya #host

Bu sayfa yardımcı oldu mu?