ملحق التوقيع
توقيع مستندات PDF و Word بتوقيع مرئي وختم رقمي
يقوم ملحق Signer بوضع توقيع مرئي على المستند، وبشكل افتراضي، يختمه بتوقيع رقمي يمكن لقارئ PDF التحقق منه. يوقع ملفات PDF و Word (.docx). يكون التوقيع المرئي دائمًا صورة PNG: مرسومة، مكتوبة، أو تم تحميلها من قبل الموقّع.
| الواجهة | متى تستخدمه |
|---|---|
DocumentSigner (C#) | توقع على الخادم، دون مشاركة المتصفح |
أداة مدمجة (doconutSigner.js) | تريد شاشة جاهزة للرفع، التوقيع والتنزيل في صفحتك |
نقاط النهاية HTTP (?sign=open|run|download) | تبني واجهة توقيع خاصة بك مقابل عقد خادم موثّق |
يتم وضع كل توقيع مرة واحدة، على صفحة واحدة. يمكن أن يصاحب التوقيع اسم الموقّع، والسبب، والموقع.
تثبيت الحزمة
ثبت أحدث نسخة مستقرة من ملحق Signer:
dotnet add package Doconut.NETStandard.Signerلتثبيت الملحق على الإصدار الذي تصفه هذه الوثائق، مرّر الإصدار بشكل منفصل:
dotnet add package Doconut.NETStandard.Signer --version 26.10.0احتفظ بحزمة Signer بنفس الإصدار كما هو في Doconut.NETStandard. معرف الحزمة هو Doconut.NETStandard.Signer؛ يظهر .<version> فقط في اسم الملف .nupkg الذي تم تنزيله.
ملف ترخيص الملحق، Doconut.Viewer.Signer.lic، يوضع في نفس المجلد مع Doconut.Viewer.lic؛ يتم قراءته مع ترخيص العارض.
تسجيل الملحق
مثل كل ملحق Doconut، يسجل Signer مع AddPlugin<TPlugin>() داخل AddDoconut():
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
});هذا كل ما تحتاجه الواجهة C#. الأداة ونقاط النهاية HTTP الخاصة بها هي خيار منفصل، AddSignerWidget() (انظر واجهة مدمجة).
يحتاج الملحق إلى ترخيص يمنح القدرة على Signer. بدون ذلك، يطرح AddDoconut() استثناءً عند بدء التشغيل، قبل أن يخدم التطبيق أي طلب:
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.يحدث الاستثناء عند عدم وجود ترخيص، أو ملف TRIAL قديم، أو ترخيص بدون Signer، أو ترخيص مدفوع يُستخدم خارج نافذة إصداره. تُقبل تراخيص Demo/NFR المؤقتة. انظر إعداد الترخيص لمعرفة كيفية تحميل التراخيص.
الترخيص والعلامة المائية
| حالة الترخيص | بدء التشغيل | التوقيع الموثق | التوقيع المرئي |
|---|---|---|---|
ترخيص مدفوع يمنح Signer، شهادة مكوّنة | يبدأ | مختوم بشهادتك، نظيف (watermarked: false) | نظيف |
ترخيص مدفوع يمنح Signer، بدون شهادة | يبدأ | مرفوض: No signing certificate configured. | نظيف |
| ترخيص مدفوع، شهادة منتهية أو غير صالحة بعد | يبدأ (مع تمكين الأداة، يتم تسجيل تحذير) | مرفوض: The signing certificate expired on yyyy-MM-dd. | نظيف |
| ترخيص Demo/NFR مؤقت، نشط أو منتهي | يبدأ | مختوم بشهادة العرض المدمجة، مع علامة مائية (watermarked: true) | مع علامة مائية |
بدون ترخيص، أو ملف TRIAL قديم، أو ترخيص بدون Signer، أو ترخيص مدفوع خارج نافذة إصداره | AddDoconut() يطرح استثناء | — | — |
القاعدة نفسها تنطبق على واجهة C# والأداة: يكون الناتج مملوءًا بعلامة مائية عندما لا يكون الترخيص ترخيصًا مدفوعًا للعارض أو يكون مؤقتًا. تحت ترخيص مؤقت، يوقع الملحق دائمًا باستخدام شهادة العرض المدمجة، ولا يُستخدم أي شهادة تقوم بتكوينها.
شهادة العرض تنتج ختمًا حقيقيًا، لكن قارئات PDF لا تثق بها. يمكن بناء واختبار التكامل من البداية إلى النهاية باستخدام ترخيص تجريبي؛ للحصول على ناتج نظيف وموثوق، تحتاج إلى ترخيص مدفوع وشهادة توقيع خاصة بك شهادة التوقيع.
الاستخدام من C#
DocumentSigner مسجل بواسطة AddDoconut() ويتم حله من حقن الاعتماد. مُنشئه داخلي، لذا لا تقم أبداً new إياه. حلّه بدون AddPlugin<SignerPlugin>() يسبب رمي No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().
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 الافتراضي هو Certified (توقيع مرئي + ختم رقمي)؛ WordOutput الافتراضي هو 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 يأخذ تدفق المصدر، امتداده (".pdf" أو ".docx")، الطلب، والشهادة لهذه المكالمة. الواجهة لا تقرأ SignerWidgetOptions.SigningCertificate؛ هذا الإعداد مخصص للأداة. مرّر null تحت رخصة تجريبية، أو في الوضع البصري.
SignResult يحتفظ بالمستند الموقع كتيار قابل للبحث، بالإضافة إلى Extension الخاص به (".pdf" أو ".docx") حتى تتمكن من تسمية الملف. أنت مالك التيار: قم بتحريره عندما تنتهي.
التوقيع البصري يطبع الصورة فقط ولا يحتاج إلى شهادة:
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);مصدر Word يتم توقيعه إلى PDF ما لم تطلب إخراج Word. سمِ النتيجة من result.Extension:
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 يرمى استثناءً بدلاً من الإرجاع عندما لا يمكن أن تنجح المكالمة:
| استثناء | رسالة | متى |
|---|---|---|
InvalidOperationException | No signing certificate configured. | وضع معتمد، رخصة مدفوعة، ولم يتم تمرير شهادة |
InvalidOperationException | The signing certificate expired on yyyy-MM-dd. / The signing certificate is not valid before yyyy-MM-dd. | وضع معتمد مع شهادة خارج نافذة صلاحيتها |
ArgumentException | The sign request is invalid: the visible signature needs PNG bytes and the placement must be a normalized rectangle on a 1-based page. | بايتات PNG فارغة، أو وضعية غير صالحة |
NotSupportedException | The signer supports PDF and Word (.docx) documents; got '{extension}'. | أي نوع مصدر آخر |
أوضاع التوقيع، إخراج Word والشهادات
أوضاع التوقيع
SignRequest.Mode يختار ما إذا كان التوقيع مختومًا.
| الوضع | ما ينتجه | الشهادة | قابل للتحقق |
|---|---|---|---|
SignatureMode.Certified (default) | التوقيع المرئي بالإضافة إلى ختم رقمي | مطلوب تحت رخصة مدفوعة | نعم |
SignatureMode.Visual | التوقيع المرئي فقط | ليس مطلوبًا أبدًا | لا: إنه صورة |
استخدم Certified عندما يجب أن يكون التوقيع قابلًا للإثبات: الموافقات، العقود، أي شيء يحتاج المدقق للتحقق منه للهوية والنزاهة. استخدم Visual عندما تحتاج فقط إلى مظهر التوقيع، أو لا تملك شهادة. رخصة مؤقتة تضيف علامة مائية لكليهما.
أختام PDF هي توقيعات منفصلة PKCS#7 (adbe.pkcs7.detached) باستخدام SHA-256، لمفاتيح RSA أو ECDSA. تحمل شهادات المصدر الموجودة في ملف PFX الخاص بك، لذا يمكن للقارئ الذي يثق بجذرك بناء السلسلة. الأختام الأصلية لـ Word هي توقيعات حزمة OOXML وتحمل شهادة الموقّع فقط.
مستندات Word
لمصدر .docx، يختار SignRequest.WordOutput الإخراج. يتم تجاهله لمصادر PDF، التي تنتج دائمًا ملف PDF.
| الإخراج | ما يحدث | دعم المُتحقق |
|---|---|---|
WordOutput.Pdf (افتراضي) | يتم تحويل المستند إلى PDF، ثم يُوقّع ويُختتم | واسع: ملف PDF موقع يُتحقق منه في كل مكان |
WordOutput.Docx | يبقى المستند بصيغة Word: تُوضع صورة التوقيع فيه، بالإضافة إلى توقيع حزمة OOXML | محدود: ليس كل عارض يُظهر توقيعات حزمة OOXML |
احتفظ بملف PDF ما لم يكن المستلم بحاجة إلى ملف Word قابل للتحرير ويقبل دعم المُتحقق المحدود.
إعداد الشهادة
لإغلاق باستخدام هويتك الخاصة، قدّم للملحق ملف PFX (PKCS#12) يتضمن المفتاح الخاص. للودجت، اضبط SignerWidgetOptions.SigningCertificate؛ للواجهة C#، مرّر الشهادة إلى SignAsync. قدّم إما البايتات أو المسار، بالإضافة إلى كلمة المرور:
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"],
};
});
});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"],
};
});
});تُحفظ الشهادة في الذاكرة فقط. لا يتم تسجيلها أبدًا، ولا تُعاد إلى العميل، ولا تُخزن، ولا تظهر كلمة المرور أبدًا في سطر سجل أو رسالة خطأ.
المتطلبات:
- حزمة PFX / PKCS#12 مع مفتاحها الخاص. ملف يحتوي على المفتاح العام فقط (
.cer,.crt) لا يمكنه التوقيع. صدّر سلسلة المُصدر معه، حتى تتمكن أختام PDF من حملها. - كلمة المرور الصحيحة.
- داخل نافذة الصلاحية الخاصة به. شهادة منتهية الصلاحية أو غير صالحة بعد لا توقف التطبيق: تُسجل كتحذير عند بدء التشغيل، وتُرفض التوقيعات الموثقة حتى يتم استبدالها. التوقيعات البصرية لا تتأثر.
- مُصدرة لتوقيع المستندات: استخدام المفتاح مع التوقيع الرقمي أو عدم الإنكار، واستخدام مفتاح ممتد، إذا كان موجودًا، يسمح بتوقيع المستندات، حماية البريد الإلكتروني أو مصادقة العميل. شهادة صُدرت لشيء آخر، مثل شهادة خادم TLS، لا تزال تُوقّع، لكن تُسجل كتحذير وتُظهر قارئات PDF علامة على التوقيع.
- الرموز المادية، البطاقات الذكية، HSMs ومتجر شهادات Windows غير مدعومة. صدّر الشهادة، مع مفتاحها الخاص وسلسلتها، إلى ملف PFX.
إنشاء ملف PFX من شهادة ومفتاحها الخاص باستخدام OpenSSL:
openssl pkcs12 -export -out signing.pfx -inkey private.key -in certificate.crt
# كلمة مرور التصدير التي يُطلب منك إدخالها هي SigningCertificate.Password.تصدير واحدة من متجر شهادات Windows: افتح certmgr.msc وابحث عن الشهادة (أيقونتها تُظهر مفتاحًا عندما يكون المفتاح الخاص موجودًا). انقر بزر الفأرة الأيمن عليها، اختر All Tasks → Export…، حدد Yes, export the private key، اختر Personal Information Exchange – PKCS #12 (.PFX)، وضع كلمة مرور.
فحوصات بدء التشغيل
عند تمكين الودجت، تُفحص الشهادة في SignerWidgetOptions.SigningCertificate مرة واحدة، داخل AddDoconut()، بحيث يفشل ملف PFX غير المُكوَّن بشكل صحيح عند بدء التشغيل بدلاً من التوقيع الأول. ثلاث مشكلات تُطلق InvalidOperationException:
| الرسالة | الإصلاح |
|---|---|
Doconut Signer: the certificate file was not found at '{path}'. | صحّح PfxPath؛ تأكد من نشر الملف وقابليته للقراءة من قبل حساب التطبيق |
Doconut Signer: the signing certificate could not be opened — the password is incorrect or the file is not a valid .pfx. | تحقق من كلمة المرور؛ تأكد من أن الملف هو .pfx حقيقي، وليس .cer أو .pem |
Doconut Signer: the signing certificate has no private key. Re-export the .pfx INCLUDING the private key. | صدّر ملف PFX مرة أخرى مع المفتاح الخاص |
إلا فإن المضيف يكتب سطرًا واحدًا إلى السجل عند بدء تشغيله. معلومات عندما تكون الشهادة جاهزة:
Doconut Signer: using certificate '{subject}' (valid until yyyy-MM-dd). Signatures are digitally sealed.تحذير عندما تكون منتهية الصلاحية، غير صالحة بعد، أو غير صادرة لتوقيع المستندات:
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.ومعلومات عندما لا تكون هناك شهادة مُكوَّنة:
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.السطر الأخير هو نفسه تحت جميع التراخيص. تحت ترخيص مدفوع لا تُستَخدم شهادة العرض التجريبية أبدًا: بدون شهادة، تعمل فقط التوقيعات البصرية.
الواجهة C# لا تُفحص عند بدء التشغيل. الشهادة التي تمرّرها إلى SignAsync تُقرأ عند التوقيع، لذا مسار أو كلمة مرور خاطئة تُفشل تلك الاستدعاء.
عنصر واجهة المستخدم القابل للإدراج
تمكين نقاط النهاية
نقاط النهاية ?sign=open|run|download للعنصر معطلة بشكل افتراضي. قم بتمكينها بجوار تسجيل الإضافة:
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>();
options.AddSignerWidget(widget =>
{
widget.MaxUploadMb = 25; // الافتراضي
widget.MaxSignatureImageKb = 512; // الافتراضي
// widget.SigningCertificate: راجع إعداد الشهادة; اتركه null لتجربة التوقيع (مع علامة مائية)
});
});AddSignerWidget() بدون أي وسيط يفعّل العنصر بالإعدادات الافتراضية. لا يمنح التوقيع بحد ذاته: فهو يحتاج إلى AddPlugin<SignerPlugin>()، أو يرفع استثناءً من AddDoconut():
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()، كل طلب ?sign= يرد بـ 404. لا يزال النص البرمجي يُقدَّم، لذا يحمّل العنصر ويظهر منطقة الإسقاط الخاصة به، ثم يُبلغ عن Signing is not enabled on this server. في الطلب الأول.
تضمينه
UseDoconutResources() يقدّم النص البرمجي على {ResourcesPath}/js/doconutSigner.js (الافتراضي /doconut-res/js/doconutSigner.js). هو ملف واحد مستقل لا يعتمد على أي شيء آخر:
<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) يأخذ محدد CSS أو عنصرًا، يرفع استثناءً إذا لم يُعثر على العنصر المستهدف، ويعيد مقبضًا.
يقوم المُوقّع بتحميل ملف PDF أو ملف .docx، يُنشئ توقيعًا (ارسم على لوحة، اكتب اسمًا بخط توقيع، أو صورة من PNG أو JPG أو GIF)، يسحبها ويُعيد تحجيمها على الصفحة، ثم يوقع ويحمّل النتيجة. العنصر يرسل دائمًا التوقيع كملف PNG؛ تُحوَّل الصورة المُحمَّلة في المتصفح إلى PNG بأبعاد 520×160.
الخيارات
| الخيار | النوع | الافتراضي | ملاحظات |
|---|---|---|---|
basePath | string | '/doconut' | مكان تقديم نقاط النهاية ?sign= وصور المعاينة |
resPath | string | '/doconut-res' | محجوز؛ العنصر يضم CSS الخاص به |
maxUploadMb | number | 25 | تحقق من جانب العميل فقط، لذا يفشل الملف الضخم بسرعة. الحد الأقصى على الخادم هو MaxUploadMb في AddSignerWidget |
maxSignatureKb | number | 512 | الحد الأقصى من جانب العميل لوضع الصورة. احفظه مساويًا للحد على الخادم وهو MaxSignatureImageKb |
previewWidth | number | 560 | عرض البكسل لمعاينة الصفحة |
licenseUrl | string | null | null | يحوّل إشعار العلامة المائية التجريبية إلى رابط لهذا العنوان |
signatureMode | string | 'certified' | نوع التوقيع الأولي: 'certified' أو 'visual'. أي قيمة أخرى تُصبح 'certified' |
showSignatureModeToggle | boolean | true | يعرض خيار التوقيع الرقمي / بصري فقط. مع false، يوقع العنصر باستخدام signatureMode |
wordOutput | string | 'pdf' | الإخراج الأولي لمصادر .docx: 'pdf' أو 'docx'. أي قيمة أخرى تُصبح 'pdf' |
showOutputFormatToggle | boolean | true | يعرض خيار PDF / Word، لمصادر .docx فقط. مع false، يستخدم العنصر wordOutput |
labels | object | {} | يتجاوز أي مجموعة فرعية من السلاسل الإنجليزية |
إخفاء زر التبديل لا يعطل الميزة؛ إنه يثبت القيمة. مثالان شائعان:
// كلا المفتاحين الظاهرين، التوقيع الرقمي افتراضيًا: موقع كامل ذاتي الخدمة
Doconut.signer('#host', { basePath: '/doconut', licenseUrl: '/pricing' });// بصري فقط، بدون مفتاح: ختم بسيط دون توقيع رقمي مقدم
Doconut.signer('#host', {
basePath: '/doconut',
signatureMode: 'visual',
showSignatureModeToggle: false
});الاستدعاءات
| الاستدعاء | يتم تشغيله عندما | الحمولة |
|---|---|---|
onReady | مرة واحدة عند التركيب (ليس مرة أخرى على reset()) | — |
onSourceLoaded | يتم فتح الملف وعرض معاينته | { file: { token, name, pages, ext } } |
onSigned | نجاح التوقيع | { downloadToken, downloadName, watermarked } |
onDownload | عند كل نقرة على تنزيل | { downloadName, downloadToken } |
onError | فشل خطوة الفتح أو التوقيع أو التنزيل، أو أن ملف وضع الصورة كبير جدًا | { message } |
يتم التقاط الاستدعاء الذي يرمي استثناءً وتسجيله؛ لا يعرقل تدفق الواجهة أبداً.
المعالجة الإجرائية
| الطريقة | السلوك |
|---|---|
reset() | يعيد إلى شاشة الإسقاط ويمسح التدفق الحالي. لا يُطلق onReady مرة أخرى. لا فعل بعد destroy() |
loadFile(file) | يبدأ التدفق بـ File. لا فعل ما لم تكون الواجهة في شاشة الإسقاط؛ استدعِ reset() أولاً إذا لزم الأمر |
destroy() | يزيل المستمعين، يفرغ التركيب، ويجمد النسخة |
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());التسميات
كل سلسلة لها قيمة افتراضية بالإنجليزية؛ labels يتجاوز أي مجموعة فرعية والبقية تبقى بالإنجليزية. القطع التي تتغير أثناء التشغيل تستخدم {placeholders}، مثل uploading: 'Uploading {name}…' و pages: '{n} pages'.
| المفتاح | القيمة الافتراضية بالإنجليزية |
|---|---|
dropPrompt | Drag & drop a PDF or Word file here |
dropHint | PDF or Word (.docx) |
chooseFile | Choose file |
signatureHeading | Your signature |
modeDraw / modeType / modeImage | Draw / Type / Image |
metaSummary | Signature details (optional) |
metaSignerName / metaReason / metaLocation | Signer name / Reason / Location |
signatureType | Signature type |
modeCertified / modeVisual | Digital signature / Visual only |
modeVisualNote | No certificate — a visible mark only, not cryptographically verifiable. |
outputFormat | Output format |
outputPdf / outputWord | PDF / Word (.docx) |
signAction | Sign document |
download | Download |
demoNotice | Demo — signed with the Doconut demo certificate; output is watermarked. |
signingNotEnabled | Signing is not enabled on this server. |
page / pages | 1 page / {n} pages |
المفاتيح الإضافية تغطي خطوة التحديد، شاشة الخطأ، النموذج المرتبط لإشعار العرض التجريبي (demoNoticePrefix، demoNoticeLink، demoNoticeSuffix) وإعلانات aria-live.
عند إجابة open أو run بـ 404 دون خطأ JSON، تعرض الواجهة signingNotEnabled. خطأ JSON من الخادم يظل هو السائد دائمًا، لذا تظل رسائل مثل انتهاء صلاحية الرفع مرئية.
التخصيص
تضيف الواجهة الفئة dsw إلى عنصر التركيب وتقرأ ألوانه ونصف قطره وخطوطه من خصائص CSS المخصصة، لذا يمكنك تخصيصه دون تعديل داخلياته:
#host.dsw {
--dsw-accent: #b0522b; /* روابط, تركيز, وضع نشط */
--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 */
}القيم الافتراضية: --dsw-accent: #2b6cb0، --dsw-bg: #ffffff، --dsw-fg: #1a202c، --dsw-muted: #718096، --dsw-border: #cbd5e0، --dsw-radius: 8px، خط واجهة نظام، وخط توقيع مائل.
بناء الواجهة الأمامية الخاصة بك
الواجهة هي عميل لهذا العقد HTTP. جميع المسارات الثلاثة تقع تحت المسار حيث يتم تركيب UseDoconut() (عادةً /doconut)، وتجيب 404 حتى يتم استدعاء AddSignerWidget(). الأخطاء تحمل جسم JSON، { "error": "..." }، باستثناء حيث تقول الجدول "الحالة فقط". قيمة غير معروفة لـ ?sign= تجيب بـ 400.
| المسار | الغرض | استجابة النجاح |
|---|---|---|
POST ?sign=open (multipart, one file) | رفع ملف PDF أو .docx وفتحها للمعاينة | 200 — { token, name, pages, ext } |
POST ?sign=run (JSON body) | توقيع الملف المرفوع | 200 — { downloadToken, downloadName, watermarked } |
GET ?sign=download&token=<downloadToken> | بث الملف الموقع | 200 — الملف، Content-Disposition: attachment، Cache-Control: no-store |
ext في استجابة open يتضمن النقطة الأولية (".docx"). يستخدم معاينة الصفحة مسار صورة المشاهد القياسي، {basePath}?token={token}&page={n}&thumb=1&width={px}؛ تصبح الصفحة المعروضة placement.page.
جسم run:
{
"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"
}| الحقل | ملاحظات |
|---|---|
token | الرمز المميز من open |
signature.kind | Drawn، Typed أو Image، غير حسّاس لحالة الأحرف؛ أي شيء آخر يصبح Drawn. مجرد تلميح: الحمولة دائمًا PNG |
signature.payload | PNG بصيغة base64 مجردة، بدون بادئة data:. يجب أن تكون PNG حقيقية ولا تتجاوز MaxSignatureImageKb بعد فك الترميز |
placement.page | يبدأ من 1 |
placement.x / y / w / h | 0..1 مُعَدل من الزاوية العليا اليسرى، مع x + w ≤ 1 و y + h ≤ 1 |
meta.signerName / reason / location | اختياري. كل واحد يُقَص، القيم الفارغة تُحذف، وكل واحد يُقَص عند 256 حرفًا |
wordOutput | pdf (الافتراضي) أو docx؛ يتم تجاهلها لمصادر PDF. أي شيء آخر يصبح pdf |
mode | certified (الافتراضي) أو visual. أي شيء آخر يصبح certified |
downloadName يتبع المخرجات: <source>-signed.pdf أو <source>-signed.docx، وdownload يرسل Content-Type المطابق.
يُحتفظ بالمصدر المرفوع والنتيجة الموقعة كل منهما لمدة 30 دقيقة. بعد ذلك، يجيب run وdownload بـ 404 ويجب فتح الملف مرة أخرى. جميع الرموز المميزة هي GUIDs.
| المسار | الحالة | متى | الجسم |
|---|---|---|---|
| any | 404 | الواجهة غير مفعلة | الحالة فقط |
| any | 405 | فعل غير صحيح (open و run يحتاجان POST، download يحتاج GET) | الحالة فقط |
open | 400 | ليس تحميلًا متعدد الأجزاء | Expected a multipart file upload. |
open | 400 | لا ملف، أو ملف فارغ | No file uploaded. |
open | 400 | أي شيء غير .pdf أو .docx | Signing supports PDF and Word (.docx) files only. |
open | 413 | الرفع يتجاوز MaxUploadMb | File is too large. |
run | 400 | الجسم ليس JSON صالحًا، أو فارغ | Malformed request. / Empty request. |
run | 400 | الرمز المميز مفقود أو ليس GUID | Invalid token. |
run | 404 | انتهت صلاحية الرفع أو لم يُفتح أبداً | Upload expired — please re-open the file. |
run | 400 | لا توقيع، أو لا تحديد | No signature supplied. / No placement supplied. |
run | 400 | الحمولة ليست base64، أو فارغة، أو كبيرة جدًا، أو ليست PNG | Signature image is not valid base64. / Signature image is empty. / Signature image is too large. / The signature image must be a PNG. |
run | 400 | التحديد خارج الصفحة | The signature or its placement is invalid. |
run | 400 | وضع معتمد، رخصة مدفوعة ولا شهادة | No signing certificate configured. |
run | 400 | وضع معتمد بشهادة خارج نافذة صلاحيتها | The signing certificate expired on yyyy-MM-dd. / The signing certificate is not valid before yyyy-MM-dd. |
open, run | 500 | فشل المعالجة | رسالة منقحة |
download | 400 | الرمز المميز مفقود أو ليس GUID | الحالة فقط |
download | 404 | رمز مميز غير معروف أو منتهي الصلاحية | الحالة فقط |
جولة كاملة مع fetch:
// file: الـ File لتوقيعه; pngBase64: التوقيع كـ PNG base64 نقي، بدون بادئة data:,
// على سبيل المثال canvas.toDataURL('image/png').split(',')[1].
async function signFile(file, pngBase64) {
const base = '/doconut';
// 1. open: رفع الملف
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: وقعه
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: احصل على الملف الموقّع
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);
}النقاط النهاية هي same-origin: هذا الإصدار لا يدعم CORS. قدّم واجهة المستخدم الخاصة بك وسكريبت الودجت من نفس الأصل مثل Doconut، أو استخدم reverse-proxy لكلا مساري /doconut (مسار الوسيط ومسار الموارد) تحت أصل واجهة المستخدم الخاصة بك.
في الإنتاج
-
قم بتثبيت الملحق بجوار حزمة النواة، بنفس الإصدار:
dotnet add package Doconut.NETStandard.Signer. -
أضف ملف الترخيص. ضع
Doconut.Viewer.Signer.licفي نفس المجلد معDoconut.Viewer.lic. -
احصل على شهادتك بصيغة PFX مع المفتاح الخاص وسلسلة المُصدر، من سلطة شهادات أو بنية PKI الخاصة بمنظمتك. لتجربة الأمور أولاً، استخدم ترخيصًا تجريبيًا (الشهادة التجريبية المدمجة، ذات علامة مائية) أو PFX موقّع ذاتيًا.
-
اقرأ الشهادة من الإعدادات، وبالتالي لا يتطلب تعديلها أي تغيير في الشيفرة:
json"DoconutSigner": { "PfxPath": "certs/your-certificate.pfx" }csharpvar 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خارجwwwroot، واحرص على عدم وضع كلمة المرور فيappsettings.json: أسرار المستخدم في التطوير (dotnet user-secrets set "DoconutSigner:Password" "<password>")، أو متغيّر بيئي (DoconutSigner__Password) أو مخزن في الإنتاج. -
تحقق من سجل بدء التشغيل. يجب أن يحتوي على
using certificate '{subject}' (valid until …). Signatures are digitally sealed.. تحذير يعني أن الشهادة منتهية الصلاحية، أو غير صالحة بعد، أو لم تُصدر لتوقيع المستندات.
الثقة في قارئات PDF. يعرض القارئ التوقيع كصحيح عندما يثق بجذر الشهادة. مع بنية PKI الخاصة بمنظمتك، هذا ينطبق على كل جهاز يثق بجذرك، وهو عادة كل جهاز داخل المنظمة. الشهادات التي يثق بها Adobe على أي جهاز (قائمة الثقة المعتمدة من Adobe) تُصدر، حسب علمنا، باستخدام المفتاح الخاص على رمز مادي أو HSM، ولا يمكن لهذا الملحق استخدامها: فهو يوقع فقط من ملف PFX. تأكد مع موفر شهادتك قبل الاعتماد على هذا النوع من الثقة.
مزارع الويب
يحافظ الودجت على كل تحميل ونتيجته في الذاكرة على العقدة التي قدمت open. خلف موازن تحميل بدون جلسات ثابتة، يمكن لطلب لاحق run، download أو طلب معاينة أن يصل إلى عقدة أخرى ولا يجد التحميل. سجّل مخزن الودجت المشترك المشفر مرة واحدة، بعد AddDoconut():
byte[] farmKey = Convert.FromBase64String(builder.Configuration["Doconut:FarmKey"]);
builder.Services.AddDoconutDistributedWidgets(store =>
{
store.RootPath = @"\\fileshare\doconut"; // مجلد يمكن لكل عقدة قراءته وكتابته
store.FarmKey = farmKey; // على الأقل 32 بايت، متطابق على كل عقدة
// store.Ttl = TimeSpan.FromMinutes(30); // مدة بقاء التحميل (الافتراضي)
});- لا يحتاج خادم واحد إلى أي شيء: بدون هذا الاستدعاء يُستخدم المخزن في الذاكرة.
- يتم تشفير التحميلات والنتائج أثناء التخزين على المشاركة (AES-256، تشفير ثم MAC)، ويُربط كل ملف برمز مميز خاص به، بحيث لا يمكن لأي رمز مميز قراءة ملف آخر.
- يجب أن يكون
FarmKeyعلى الأقل 32 بايت ومتطابقًا على كل عقدة. حمّله من مخزن أسرار؛ لا تقم بتضمينه صلبًا. التسجيل يُطلقArgumentExceptionعندما يكونRootPathمفقودًا أو يكونFarmKeyأقصر من 32 بايت. - وجه
RootPathإلى نفس الموقع المشترك الذي يستخدمه عارض موزع، وامنح كل عقدة نفس شهادة التوقيع.
مرجع API
الواجهة وخيارات الودجت موجودة في مساحة الاسم Doconut؛ وأنواع الطلب والنتيجة موجودة في Doconut.Core.Models.Signing. SignerPlugin موجود في Doconut.Plugins.Signer.
DocumentSigner
public sealed class DocumentSigner
{
public Task<SignResult> SignAsync(
Stream source, string sourceExtension, SignRequest request,
SigningCertificate? cert = null, CancellationToken ct = default);
}يتم حله عبر حقن الاعتماد؛ المُنشئ داخلي. sourceExtension هو ".pdf" أو ".docx". تحت رخصة مدفوعة يتم استخدام cert ويكون الناتج نظيفًا؛ تحت رخصة مؤقتة يتم استخدام شهادة العرض التجريبية المدمجة، ويتم تجاهل cert، ويكون الناتج مائيًا.
SignRequest
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
}توقيع مرئي واحد يُوضع مرة واحدة، بالإضافة إلى بيانات تعريف الموقّع الاختيارية.
VisibleSignature و SignatureKind
public sealed record VisibleSignature(SignatureKind Kind, byte[] PngBytes)
{
public bool IsValid { get; } // PngBytes ليس فارغًا
}
public enum SignatureKind { Drawn, Typed, Image }PngBytes هو PNG لكل نوع. التوقيع المرسوم أو المكتوب يكون شفافًا؛ الصورة التي تم تحميلها تحتفظ بالشفافية التي كانت عليها، لذا JPG غير شفاف يبقى غير شفاف. Kind هو مجرد تلميح.
SignaturePlacement
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؛ X، Y، W و H هي 0..1 مُعَدل من الزاوية العليا اليسرى.
SignatureMode و WordOutput
public enum SignatureMode { Certified, Visual } // Certified هو الافتراضي
public enum WordOutput { Pdf, Docx } // Pdf هو الافتراضي; تم تجاهله لمصادر PDFSignResult
public sealed record SignResult(Stream Stream, string Extension);المستند الموقّع كدفق قابل للتمرير، وامتداده مع النقطة (".pdf" أو ".docx").
SigningCertificate
public sealed class SigningCertificate
{
public byte[]? PfxBytes { get; init; }
public string? PfxPath { get; init; }
public string Password { get; init; } = "";
public bool HasMaterial { get; } // PfxBytes ليس فارغًا, أو PfxPath غير فارغ
}عيّن إما PfxBytes أو PfxPath، بالإضافة إلى Password.
SignerWidgetOptions
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)، الذي يُعيد DoconutOptions حتى يمكن ربط الاستدعاءات. قيمة null في SigningCertificate تعني شهادة العرض التجريبية تحت رخصة مؤقتة، وتوقيعات Visual فقط تحت رخصة مدفوعة.
استكشاف الأخطاء وإصلاحها
| العَرَض | السبب | الحل |
|---|---|---|
AddDoconut() يرمى The Signer plugin is registered via AddPlugin but no active license grants Signer. | لا رخصة، ملف TRIAL، رخصة بدون Signer، أو رخصة مدفوعة خارج نافذة الإصدار الخاصة بها | ثبت رخصة تمنح Signer، أو أزل AddPlugin<SignerPlugin>() |
AddDoconut() يرمى AddSignerWidget() was called but the Signer plugin is not registered. | الودجت مفعّل بدون ملحقه | أضف options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>() |
AddDoconut() يرمى Doconut Signer: the certificate file was not found at '{path}'. | PfxPath يشير إلى ملف مفقود | صحّح المسار؛ انشر الملف حيث يمكن لحساب التطبيق قراءته |
AddDoconut() يرمى Doconut Signer: the signing certificate could not be opened — the password is incorrect or the file is not a valid .pfx. | كلمة مرور خاطئة، أو ليس ملف PKCS#12 | تحقق من كلمة المرور؛ استخدم .pfx حقيقيًا |
AddDoconut() يرمى Doconut Signer: the signing certificate has no private key. Re-export the .pfx INCLUDING the private key. | تم تصدير ملف PFX بدون المفتاح الخاص | صدّره مرة أخرى مع المفتاح الخاص |
حل DocumentSigner يرمى No IDocumentSigner is registered. | SignerPlugin غير مسجل | أضف AddPlugin<SignerPlugin>() داخل AddDoconut() |
| الناتج مائي العلامة | الرخصة مؤقتة (Demo/NFR) | استخدم رخصة مدفوعة تمنح Signer |
run يجيب 400 No signing certificate configured. | رخصة مدفوعة، وضع Certified، ولا شهادة | قم بتهيئة SigningCertificate، أو وقع في وضع Visual |
run يجيب 400 The signing certificate expired on yyyy-MM-dd. | الشهادة منتهية الصلاحية | استبدلها؛ توقيعات Visual تستمر في العمل في هذه الأثناء |
| السجل يقول إن الناتج "يستخدم شهادة العرض التجريبية المدمجة"، ومع ذلك رخصة مدفوعة ترفض توقيعات Certified | يُكتب هذا السطر كلما لم تُضبط شهادة، بغض النظر عن الرخصة | قم بتهيئة SigningCertificate |
الودجت يُحمّل لكنه يقول Signing is not enabled on this server. | لم يُستدعَ AddSignerWidget()، أو basePath لا يتطابق مع مكان تثبيت UseDoconut() | استدعِ AddSignerWidget()؛ صحّح basePath |
run يجيب 400 The signature image must be a PNG.، Signature image is not valid base64. أو Signature image is too large. | واجهة مخصصة أرسلت عنوان URL من نوع data:، JPG، أو أكثر من MaxSignatureImageKb | أرسل PNG بصيغة base64 فقط ضمن الحد |
open يجيب 413 File is too large. | التحميل يتجاوز MaxUploadMb | ارفع MaxUploadMb في AddSignerWidget؛ فـ maxUploadMb للودجت هو فقط فحص من جانب العميل |
run أو download يجيب 404 Upload expired — please re-open the file. | انقضت نافذة الـ30 دقيقة، أو عقدة الويب-فارم لا تملك التحميل | افتح الملف مرة أخرى؛ في الفارم، سجّل AddDoconutDistributedWidgets |
.docx موقّع لا يظهر توقيعًا في بعض المشاهدين | إخراج Word يحمل توقيع حزمة OOXML، والذي لا يعرضه كثير من المشاهدين | وقع إلى PDF، وهو الافتراضي |
| قُرّاء PDF يقولون إن هوية الموقّع غير معروفة | القارئ لا يثق بجذر الشهادة (شهادة العرض التجريبية لا تُوثق أبدًا) | استخدم شهادة من جذر يثق به قرّاؤك |
| الودجت يفشل عندما تكون الواجهة على أصل مختلف | النقاط النهاية لا تدعم CORS | قدّم الواجهة من نفس الأصل، أو استخدم reverse-proxy لمسارات Doconut |
| السمة لا تُطبق | المحدد يستهدف عنصرًا داخل التركيب | استهدف التركيب نفسه: #host.dsw أو #host |
هل كانت هذه الصفحة مفيدة؟