@truthlocks/protect · الأمر: truthlock-protect
Console · تطبيق المستهلك · وثائق API
التثبيت
truthlocks أيضًا كاسم مستعار. تسجل هذه الحزمة عبر الإنترنت
بصمات الأصابع؛ استخدم @truthlocks/cli للتحقق من حزمة الإثبات دون اتصال.
اختر نوع حسابك
مفتاح API ليس رمز مستهلك. يستخدم CLI نقاط نهاية مختلفة لهذين الأمرين
سير العمل. تحدد مفاتيح API الاختبارية المضيف التجريبي. قم بتعيين
TRUTHLOCK_API_URL فقط عندما
تحتاج عمدًا إلى أصل API مختلف.
دليل البدء السريع لمساحة العمل
عيّنTRUTHLOCKS_API_KEY و TRUTHLOCKS_ISSUER_ID و TRUTHLOCKS_KEY_ID في بيئتك،
ثم حماية ملف موجود:
attestation_id و payload_b64url؛ احتفظ بهما. يحفظ خيار --output إيصالًا دون الكتابة فوق ملف موجود. تقوم هذه العملية بكتابة سجل.
يمكنك تحديد المصدر والمفتاح بشكل صريح بدلاً من ذلك:
document.sha256 و
تجزئة مستند صريحة. تتبع قواعد الوصول إلى مساحة العمل/API؛ رؤية المستهلك
لا تنطبق العلامات على سير العمل هذا.
دليل البدء السريع للمستهلك
عيّنTRUTHLOCK_TOKEN إلى رمز حامل مستهلك مصرح به، مع مفتاح API لمساحة العمل
متغيرات البيئة غير مضبوطة، ثم قم بالتشغيل:
--public فقط عندما تريد سجلًا عامًا
سجل المستهلك. تختار الخدمة مفتاح توقيع المستهلك؛ --algorithm،
--issuer-id و --key-id هما خياران لمساحة العمل ويتم رفضهما في وضع المستهلك.
التحقق من سجل وملف
استخدم الإيصال المحفوظ والملف الأصلي. يوفر الإيصال البايتات الدقيقة التي تم توقيعها؛ يوفر الملف بصمة الإصبع للمقارنة:--file.
لا يعيد بناء مطالبات مساحة العمل التعسفية أو تنسيقات الحمولة التاريخية.
لسجل مساحة عمل بدون إيصال محفوظ، قم بتوفير الحمولة الموقعة الأصلية
بايت باستخدام --payload-file ./signed-payload.json. لا تقم بإعادة تنسيق JSON هذا.
يتطلب رمز الخروج 0 كلاً من verdict: VALID و signature_verified: true.
تخرج الملفات المعدلة والإثباتات غير المكتملة بقيمة غير صفرية. لا يمكن لعملية بحث بالمعرف فقط التحقق
توقيع؛ فإنه يبلغ عن INCOMPLETE ما لم يتم تطبيق حالة أقوى مثل الإلغاء:
الأوامر
تسجيل المطور هو عملية إنشاء حساب منفصلة. لا ينشئ
جلسة مستهلك أو ضمان توفير مفتاح إصدار/توقيع بالفعل.
الخيارات والتخزين المحلي
protect يقبل --title، --description، --category، --content-type، --json،
--api-key، --issuer-id، --key-id، --algorithm، --idempotency-key و --output.
--public و --private ينطبقان فقط على المستهلكين. يتم الكشف عن فئة الملف تلقائيًا ما لم يتم توفيرها. لا يتم دعم الدلائل.
لا يزال المتغير التاريخي TRUTHLOCK_API_KEY مقبولاً. علامات مفتاح API الصريحة
ومتغيرات البيئة لها الأولوية على مفتاح المطور المحفوظ. مفتاح صريح
متغير بيئة رمز المستهلك له الأولوية على مفتاح المطور المحفوظ عندما
لم يتم توفير متغير بيئة مفتاح API.
يعيش رمز المستهلك المحفوظ في ~/.truthlock/config.json؛ تعيش بيانات اعتماد المطور
في ~/.truthlocks/credentials.json. هذه ملفات اعتماد محلية. احتفظ بها بعيدًا
من المستودعات والنسخ الاحتياطية المخصصة للنشر.
استكشاف الأخطاء وإصلاحها
تستخدم الطلبات مهلة 30 ثانية ويتم إرسالها مرة واحدة. يتم رفض عمليات إعادة التوجيه. حد المعدل
القيم المتبقية لا تُعرض كحصة شهرية.
الترقية من الإصدار 1.0
يضيف الإصدار 1.1.1 حمولات موقعة محتفظ بها وتحققًا تشفيريًا باستخدام الملفات الأصلية. يصحح الإصدار 1.1 رؤوس مفتاح API، والمستهلكcontent_hash، وتوقيع مساحة العمل، والخاص
إعدادات المستهلك الافتراضية، ومخرجات JSON، وأسماء الأوامر المستعارة، والتحقق الحقيقي. الأمثلة السابقة
التي ادعت أن البحث عن الحماية كان تحققًا تشفيريًا يجب استبدالها.
ترخيص MIT.
