Buat kunci sandi untuk login tanpa sandi

Kunci sandi membuat akun pengguna lebih aman, lebih mudah, dan lebih mudah digunakan.

Eiji Kitamura

Menggunakan kunci sandi, bukan sandi, adalah cara tepat bagi situs untuk membuat akun penggunanya lebih aman, lebih sederhana, lebih mudah digunakan, dan tanpa sandi. Dengan kunci sandi, pengguna dapat login ke situs atau aplikasi hanya dengan menggunakan sidik jari, wajah, atau PIN perangkat.

Kunci sandi harus dibuat, dikaitkan dengan akun pengguna, dan disimpan kunci publiknya di server Anda sebelum pengguna dapat menggunakannya untuk login.

Cara kerjanya

Pengguna dapat diminta untuk membuat kunci sandi dalam salah satu situasi berikut:

  • Saat pengguna login menggunakan sandi.
  • Saat pengguna login menggunakan kunci sandi dari perangkat lain (yaitu, authenticatorAttachment adalah cross-platform).
  • Di halaman khusus tempat pengguna dapat mengelola kunci sandi mereka.

Untuk membuat kunci sandi, gunakan WebAuthn API.

Keempat komponen alur pendaftaran kunci sandi adalah:

  • Backend: Server backend yang menyimpan database akun yang menyimpan kunci publik dan metadata lainnya tentang kunci sandi tersebut.
  • Frontend: Frontend Anda yang berkomunikasi dengan browser dan mengirimkan permintaan pengambilan ke backend.
  • Browser: Browser pengguna yang menjalankan JavaScript Anda.
  • Authenticator: Pengautentikasi pengguna yang membuat dan menyimpan kunci sandi. Perangkat ini dapat digunakan di perangkat yang sama dengan browser (misalnya, saat menggunakan Windows Hello) atau di perangkat lain, seperti ponsel.
Diagram pendaftaran kunci sandi

Proses untuk menambahkan kunci sandi baru ke akun pengguna yang ada adalah sebagai berikut:

  1. Pengguna login ke situs.
  2. Setelah login, pengguna meminta untuk membuat kunci sandi di frontend, misalnya, dengan menekan tombol "Buat kunci sandi".
  3. Frontend meminta informasi dari backend untuk membuat kunci sandi, seperti informasi pengguna, tantangan, dan ID kredensial yang akan dikecualikan.
  4. Frontend memanggil navigator.credentials.create() untuk membuat kunci sandi. Panggilan ini akan menampilkan promise.
  5. Kunci sandi dibuat setelah pengguna mengizinkan penggunaan kunci layar perangkat. Promise di-resolve dan kredensial kunci publik ditampilkan ke frontend.
  6. Frontend mengirimkan kredensial kunci publik ke backend dan menyimpan ID kredensial dan kunci publik yang terkait dengan akun pengguna untuk autentikasi mendatang.

Kompatibilitas

WebAuthn didukung oleh sebagian besar browser, tetapi ada sedikit kesenjangan. Lihat Dukungan Perangkat - kunci sandi.dev untuk mempelajari kombinasi browser dan sistem operasi yang mendukung pembuatan kunci sandi.

Buat kunci sandi baru

Berikut ini cara kerja frontend yang seharusnya dilakukan berdasarkan permintaan untuk membuat kunci sandi baru.

Deteksi fitur

Sebelum menampilkan tombol "Buat kunci sandi baru", periksa apakah:

  • Browser mendukung WebAuthn.
  • Perangkat mendukung pengautentikasi platform (dapat membuat kunci sandi dan melakukan autentikasi dengan kunci sandi).
  • Browser mendukung UI kondisional WebAuthn.
// Availability of `window.PublicKeyCredential` means WebAuthn is usable.  
// `isUserVerifyingPlatformAuthenticatorAvailable` means the feature detection is usable.  
// `​​isConditionalMediationAvailable` means the feature detection is usable.  
if (window.PublicKeyCredential &&  
    PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable &&  
    PublicKeyCredential.​​isConditionalMediationAvailable) {  
  // Check if user verifying platform authenticator is available.  
  Promise.all([  
    PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable(),  
    PublicKeyCredential.​​isConditionalMediationAvailable(),  
  ]).then(results => {  
    if (results.every(r => r === true)) {  
      // Display "Create a new passkey" button  
    }  
  });  
}

Hingga semua kondisi terpenuhi, kunci sandi tidak akan didukung di browser ini. Tombol "Buat kunci sandi baru" tidak akan ditampilkan hingga tanggal tersebut.

Mengambil informasi penting dari backend

Saat pengguna mengklik tombol tersebut, ambil informasi penting untuk memanggil navigator.credentials.create() dari backend:

  • challenge: Tantangan yang dibuat server di ArrayBuffer untuk pendaftaran ini. Tindakan ini diperlukan tetapi tidak digunakan saat pendaftaran kecuali jika melakukan pengesahan—topik lanjutan yang tidak dibahas di sini.
  • user.id: ID unik pengguna. Nilai ini harus berupa ArrayBuffer yang tidak menyertakan informasi identitas pribadi, misalnya, alamat email atau nama pengguna. Nilai acak 16 byte yang dihasilkan per akun akan berfungsi dengan baik.
  • user.name: Kolom ini harus berisi ID unik untuk akun yang akan dikenali pengguna, seperti alamat email atau nama pengguna. Nama ini akan ditampilkan di pemilih akun. (Jika menggunakan nama pengguna, gunakan nilai yang sama dengan autentikasi sandi.)
  • user.displayName: Kolom ini wajib diisi dan lebih mudah digunakan untuk akun. Kolom ini tidak harus unik, dan dapat berupa nama pilihan pengguna. Jika situs Anda tidak memiliki nilai yang sesuai untuk disertakan di sini, teruskan string kosong. Informasi ini dapat ditampilkan di pemilih akun, bergantung pada browser.
  • excludeCredentials: Mencegah pendaftaran perangkat yang sama dengan memberikan daftar ID kredensial yang sudah terdaftar. Anggota transports, jika disediakan, harus berisi hasil panggilan getTransports() selama pendaftaran setiap kredensial.

Memanggil WebAuthn API untuk membuat kunci sandi

Panggil navigator.credentials.create() untuk membuat kunci sandi baru. API menampilkan janji, menunggu interaksi pengguna yang menampilkan dialog modal.

const publicKeyCredentialCreationOptions = {
  challenge: *****,
  rp: {
    name: "Example",
    id: "example.com",
  },
  user: {
    id: *****,
    name: "john78",
    displayName: "John",
  },
  pubKeyCredParams: [{alg: -7, type: "public-key"},{alg: -257, type: "public-key"}],
  excludeCredentials: [{
    id: *****,
    type: 'public-key',
    transports: ['internal'],
  }],
  authenticatorSelection: {
    authenticatorAttachment: "platform",
    requireResidentKey: true,
  }
};

const credential = await navigator.credentials.create({
  publicKey: publicKeyCredentialCreationOptions
});

// Encode and send the credential to the server for verification.

Parameter yang tidak dijelaskan di atas adalah:

  • rp.id: ID RP adalah domain dan situs dapat menentukan domainnya atau akhiran yang dapat didaftarkan. Misalnya, jika asal RP adalah https://login.example.com:1337, ID RP dapat berupa login.example.com atau example.com. Jika ID RP ditetapkan sebagai example.com, pengguna dapat melakukan autentikasi di login.example.com atau di subdomain apa pun di example.com.

  • rp.name: Nama RP.

  • pubKeyCredParams: Kolom ini menentukan algoritma kunci publik yang didukung RP. Sebaiknya tetapkan ke [{alg: -7, type: "public-key"},{alg: -257, type: "public-key"}]. Tindakan ini menentukan dukungan untuk ECDSA dengan P-256 dan RSA PKCS#1 serta memberikan cakupan lengkap (jika mendukung hal ini).

  • authenticatorSelection.authenticatorAttachment: Tetapkan parameter ini ke "platform" jika pembuatan kunci sandi ini adalah upgrade dari sandi, misalnya dalam promosi setelah login. "platform" menunjukkan bahwa RP menginginkan pengautentikasi platform (autentikasi yang disematkan ke perangkat platform) yang tidak akan meminta untuk memasukkan, misalnya, kunci keamanan USB. Pengguna memiliki opsi yang lebih sederhana untuk membuat kunci sandi.

  • authenticatorSelection.requireResidentKey: Tetapkan nilai ini ke boolean "true". Kredensial yang dapat ditemukan (kunci yang tersimpan) menyimpan informasi pengguna ke kunci sandi dan memungkinkan pengguna memilih akun setelah autentikasi.

  • authenticatorSelection.userVerification: Menunjukkan apakah verifikasi pengguna yang menggunakan kunci layar perangkat adalah "required", "preferred", atau "discouraged". Defaultnya adalah "preferred", yang berarti pengautentikasi dapat melewati verifikasi pengguna. Tetapkan string ini ke "preferred" atau hapus properti.

Mengirim kredensial kunci publik yang ditampilkan ke backend

Setelah pengguna memberikan izin untuk menggunakan kunci layar perangkat, kunci sandi akan dibuat dan Promise akan di-resolve dan menampilkan objek PublicKeyCredential ke frontend.

Janji dapat ditolak karena berbagai alasan. Anda dapat menangani error ini dengan memeriksa properti name objek Error:

  • InvalidStateError: Kunci sandi sudah ada di perangkat. Tidak ada dialog error yang akan ditampilkan kepada pengguna dan situs tidak boleh memperlakukan hal ini sebagai error—pengguna ingin perangkat lokal didaftarkan dan demikian.
  • NotAllowedError: Pengguna telah membatalkan operasi.
  • Pengecualian lainnya: Terjadi error yang tidak terduga. Browser menampilkan dialog error kepada pengguna.

Objek kredensial kunci publik berisi properti berikut:

  • id: ID yang dienkode Base64URL dari kunci sandi yang dibuat. ID ini membantu browser menentukan apakah kunci sandi yang cocok ada di perangkat saat autentikasi. Nilai ini perlu disimpan dalam database di backend.
  • rawId: Versi ArrayBuffer dari ID kredensial.
  • response.clientDataJSON: Data klien berenkode ArrayBuffer.
  • response.attestationObject: Objek pengesahan yang dienkode ArrayBuffer. Objek ini berisi informasi penting seperti ID RP, flag, dan kunci publik.
  • authenticatorAttachment: Menampilkan "platform" saat kredensial ini dibuat di perangkat yang mendukung kunci sandi.
  • type: Kolom ini selalu ditetapkan ke "public-key".

Jika Anda menggunakan library untuk menangani objek kredensial kunci publik di backend, sebaiknya kirim seluruh objek ke backend setelah mengenkodenya sebagian dengan base64url.

Simpan kredensial

Setelah menerima kredensial kunci publik di backend, teruskan ke library FIDO untuk memproses objek.

Selanjutnya, Anda dapat menyimpan informasi yang diambil dari kredensial ke database untuk digunakan di masa mendatang. Daftar berikut menyertakan beberapa properti umum yang akan disimpan:

  • ID Kredensial (Kunci utama)
  • ID Pengguna
  • Kunci publik

Kredensial kunci publik juga menyertakan informasi berikut yang mungkin ingin Anda simpan di database:

Untuk mengautentikasi pengguna, baca Login dengan kunci sandi melalui isi otomatis formulir.

Referensi