Kode Error ​

Kode error bersama untuk pustaka klien yang didukung secara resmi oleh DAT.

Setiap kode memiliki dua nilai — dampak dan percobaan ulang — dan sebagian ditandai tambahan dengan label mencurigakan.

Dampak — kerusakan yang dialami layanan ​

Ini kriteria untuk memasang alert. Yang dilihat hanya satu hal: "apakah layanan sedang berhenti".

Tanpa dampak bukan objek alert. Jika satu masukan salah harus diperiksa oleh seluruh penanggung jawab, alert kehilangan maknanya.

Mencurigakan — selidiki jika berlanjut ​

Kode dengan label Mencurigakan dalam satu kejadian adalah bagian dari operasi normal. Klien bisa mengirim nilai yang salah kapan saja, dan menyaringnya memang tugas pustaka.

Namun jika error semacam ini terjadi terus-menerus, atau menumpuk dari sumber tertentu, penyebabnya salah satu dari dua ini.

• Kesalahan konfigurasi — deployment salah, klien versi lama masih tertinggal, atau sertifikat tidak selaras.
• Percobaan peretasan — upaya memanipulasi token atau kunci agar lolos verifikasi, atau penelusuran untuk menemukan nilai yang valid.

Karena itu kode-kode ini sebaiknya dijadikan metrik berbasis jumlah. Cukup memberi tahu saat melewati ambang batas.

Percobaan Ulang ​

Token ​

Masalah pada string token yang diterima itu sendiri.

Sertifikat ​

Masalah format string sertifikat, dan apakah sertifikat itu bisa dipakai sekarang.

DAT_CERT_NOT_FOUND dan DAT_CERT_NOT_SYNCED tampak sama gejalanya tetapi responsnya berbeda. Yang pertama adalah cid yang tidak pernah kita terbitkan sehingga menunggu pun tidak akan muncul; yang kedua cukup menunggu sinkronisasi selesai.

Satu kejadian DAT_CERT_NOT_FOUND cukup disaring saja, tetapi lonjakan mendadak berarti deployment tidak selaras atau token palsu sedang beredar.

Tanda Tangan ​

Enkripsi ​

Masalah enkripsi dan dekripsi payload secure.

Payload secure yang kosong bukan error. Masukan kosong menghasilkan keluaran kosong dan tidak memunculkan kode apa pun.

Pada jalur yang melewati verifikasi tanda tangan, tag GCM adalah satu-satunya pemeriksaan integritas. Karena itu DAT_CRYPTO_TAG_MISMATCH tidak disatukan dalam satu kode dengan kegagalan dekripsi lainnya.

Kunci ​

Tiga hal yang tampak mirip tetapi berbeda:

Manajer ​

Kondisi objek yang menyimpan sertifikat dan memakainya untuk menerbitkan serta memverifikasi.

Penyebab (cause) dari DAT_MANAGER_NO_ISSUABLE_CERTIFICATE adalah salah satu dari empat. Tindakan yang harus diambil berbeda sama sekali untuk tiap penyebab.

Jika server penerbitan dikonfigurasi hanya menerima sertifikat verifikasi, DAT_CERT_VERIFY_ONLY akan muncul. Menunggu tidak akan pernah menyelesaikannya, jadi bukan objek percobaan ulang.

Konfigurasi ​

Masalah nilai yang diteruskan pemanggil. Semua kode keluarga CONFIG adalah error yang harus diperbaiki di kode; jika muncul saat operasional, berarti deployment-nya salah.

Internal ​

Masalah lingkungan eksekusi dan runtime.

DAT_INTERNAL_UNAVAILABLE selesai dengan memperbaiki lingkungan deployment, sedangkan DAT_INTERNAL_UNKNOWN umumnya gangguan runtime atau bug pustaka.

Sinkronisasi CMS ​

Jika sinkronisasi CMS tidak dipakai, kode-kode ini tidak muncul.

Kode yang membuat sinkronisasi dinilai gagal permanen (UNAUTHORIZED, FORBIDDEN, ENDPOINT_NOT_FOUND, MALFORMED, IMPORT_FAILED) semuanya kritis. Mencoba lagi tidak menyelesaikannya sementara sertifikat terus kedaluwarsa, sehingga jika dibiarkan layanan pasti berhenti.

Sebaliknya UNREACHABLE dan SERVER_ERROR bersifat sebagian. Layanan tetap berjalan dengan sertifikat yang ada dan pulih sendiri pada siklus berikutnya — namun jika terus gagal, pada akhirnya berpindah menjadi kritis. Pasang alert berdasarkan jumlah kegagalan beruntun.

Server ​

Kode yang dikeluarkan server CMS. Klien tidak membuat kode ini, hanya menerimanya.

Amplop respons:

{
  "code": "DAT_REQ_ALG_UNSUPPORTED",
  "details": { "algorithm": "BOGUS-ALG" }
}

Error yang muncul saat membuat dan menangani sertifikat juga dikeluarkan server memakai kode bersama di atas (DAT_CERT_*, DAT_KEY_*, DAT_CONFIG_*).

Saat menerima kode server ​

Klien membungkus kode server dengan kode CMS miliknya sendiri, dan menyimpan aslinya di cause.

Cari berdasarkan gejala ​

Lampiran ​

Sintaks Kode ​

DAT_<area>_<penyebab>

• Jika penyebab yang sama muncul di area berbeda, nama penyebabnya sama. DAT_TOKEN_MALFORMED dan DAT_CERT_MALFORMED hanya berbeda objeknya, maknanya sama.
• _UNKNOWN adalah khusus fallback untuk tiap area. Ia tidak dipakai dalam arti "algoritma tidak dikenal" (untuk itu ada _UNSUPPORTED).
• String kode adalah kontrak publik. Pesan boleh diubah bebas, tetapi kode tidak.

Akses per Klien ​

Peristiwa keamanan hanya mengembalikan true untuk dua kode di mana pemalsuan atau manipulasi sudah pasti (DAT_SIG_MISMATCH, DAT_CRYPTO_TAG_MISMATCH). Label curiga pada dokumen ini mencakup lingkup yang lebih luas (termasuk token, kunci, dan permintaan yang dimanipulasi), dan untuk saat ini hanya klasifikasi dokumen, tidak diekspos sebagai API klien.

Tingkat dampak juga merupakan klasifikasi dokumen. Kode yang sama bisa berbeda pukulannya tergantung di mana ia muncul — misalnya DAT_KEY_INVALID tidak berdampak apa-apa saat menyaring token yang masuk, tetapi jika muncul saat membaca sertifikat di tengah sinkronisasi CMS, seluruh sinkronisasi gagal.

Penyebab dasar tidak dibuang. DAT_MANAGER_NO_ISSUABLE_CERTIFICATE dan DAT_CMS_IMPORT_FAILED meneruskan penyebabnya melalui rantai exception masing-masing bahasa (cause / __cause__ / InnerException / Unwrap()).