Instalasi
Paket ini ada di npm dengan lisensi MIT, sedangkan kode sumber dan pengujiannya ada di GitHub. Gunakan pengelola paket pilihan Anda:
npm install caesar-cipher-jsyarn add caesar-cipher-jspnpm add caesar-cipher-jsPaket ini memerlukan Node.js 20 atau lebih baru dan tersedia sebagai modul ES dan CommonJS. Di browser, gunakan lewat bundler: alat di situs ini memuatnya dengan Vite. Versi ES berukuran sekitar 3,5 KB setelah gzip.
Mulai cepat
Impor fungsi yang Anda perlukan. Secara bawaan, pustaka ini mempertahankan huruf besar dan kecil serta tidak mengubah apa pun di luar alfabet.
import { encrypt, decrypt } from "caesar-cipher-js"; console.log(encrypt("Halo dunia!", 3));// Kdor gxqld!console.log(decrypt("Kdor gxqld!", 3));// Halo dunia!const { encrypt } = require("caesar-cipher-js"); console.log(encrypt("Halo dunia!", 3));// Kdor gxqld!Fungsi
Inilah yang paling sering dipakai. Pergeseran negatif juga berfungsi, begitu pula pergeseran yang lebih besar dari alfabet.
| Nama | Fungsinya |
|---|---|
encrypt(text, shift, options?) | Mengembalikan teks terenkripsi. |
decrypt(text, shift, options?) | Mengembalikan teks terdekripsi. |
bruteforce(text, options?) | Mencoba semua pergeseran dan mengembalikan array { shift, text, score? }. Opsi: alphabet, maxResults, scoreFunction. |
getScoreFunction(language) | Mengembalikan fungsi penilaian untuk suatu bahasa. |
mapDiacritics(text, language) | Mengganti huruf beraksen dengan huruf dasar. |
new CaesarCipher(options?) | Kemampuan yang sama dalam objek dengan pengaturan tersimpan. |
Opsi
encrypt, decrypt, dan konstruktor CaesarCipher menerima opsi yang sama:
| Opsi | Fungsinya |
|---|---|
alphabet | Alfabet untuk pergeseran. Bawaan: a sampai z. |
caseStrategy | maintain (bawaan), upper, atau lower. |
preserveCase | Bawaan true. Dengan false, hasilnya huruf kecil. |
preserveNonAlpha | Bawaan true. Dengan false, semua yang di luar alfabet dihapus. |
preserveSpaces | Bawaan true. Dengan false, spasi dihapus. |
preserveSpecialChars | Bawaan true. Dengan false, tanda baca dan angka dihapus. |
diacriticsLanguage | Atur ke french untuk mengubah huruf beraksen sebelum digeser. |
import { encrypt } from "caesar-cipher-js"; console.log(encrypt("Hello, World! 123", 3, { caseStrategy: "upper" }));// KHOOR, ZRUOG! 123console.log(encrypt("Hello, World! 123", 3, { preserveSpaces: false }));// Khoor,Zruog!123console.log(encrypt("Hello, World! 123", 3, { preserveNonAlpha: false }));// KhoorZruogAlfabet lain
Pustaka ini mengekspor alfabet untuk bahasa Inggris, Polandia, Jerman, Spanyol, dan Prancis, serta ALPHABET_ALPHANUMERIC_LOWER dengan angka, seperti pada contoh ini. Anda juga bisa memberikan string sendiri. Bahasa Indonesia memakai 26 huruf bawaan.
import { encrypt, ALPHABET_ALPHANUMERIC_LOWER } from "caesar-cipher-js"; console.log(encrypt("Kamar 101", 3, { alphabet: ALPHABET_ALPHANUMERIC_LOWER }));// Ndpdu 434Memecahkan sandi dengan bruteforce
bruteforce mengembalikan satu hasil per pergeseran, mulai dari 0. Agar jawaban yang paling mungkin muncul lebih dulu, berikan scoreFunction. getScoreFunction punya penilaian siap pakai untuk english, polish, german, spanish, dan french. Belum ada penilaian untuk bahasa Indonesia.
import { bruteforce, getScoreFunction } from "caesar-cipher-js"; const results = bruteforce("Wkh txlfn eurzq ira mxpsv ryhu wkh odcb grj", { scoreFunction: getScoreFunction("english"), maxResults: 2,}); for (const { shift, text } of results) { console.log(shift, text);}// 3 The quick brown fox jumps over the lazy dog// 9 Nby kocwe vliqh zir dogjm ipyl nby futs xiaNilai hanya membandingkan hasil satu sama lain, jadi periksa sendiri teksnya, terutama jika pesannya pendek.
Kelas CaesarCipher
Kelas ini mengingat pengaturannya, sehingga praktis jika Anda memakai opsi yang sama berkali-kali. Ada juga metode seperti setAlphabet dan reset() yang mengembalikan nilai bawaan.
import { CaesarCipher, ALPHABET_ALPHANUMERIC_LOWER } from "caesar-cipher-js"; const cipher = new CaesarCipher({ alphabet: ALPHABET_ALPHANUMERIC_LOWER });const secret = cipher.encrypt("Kamar 101", 3); console.log(secret);// Ndpdu 434console.log(cipher.decrypt(secret, 3));// Kamar 101Huruf beraksen
Huruf beraksen di luar alfabet biasanya tetap apa adanya. Untuk bahasa Prancis, diacriticsLanguage lebih dulu mengubah é menjadi e dan ç menjadi c agar ikut bergeser. Sejauh ini, hanya bahasa Prancis yang punya pemetaan ini.
import { encrypt, mapDiacritics } from "caesar-cipher-js"; console.log(mapDiacritics("Déjà vu à Noël", "french"));// Deja vu a Noelconsole.log(encrypt("Déjà vu à Noël", 3, { diacriticsLanguage: "french" }));// Ghmd yx d QrhoTypeScript
Paket ini sudah menyertakan tipenya, jadi tidak ada lagi yang perlu dipasang. Paket mengekspor EncryptOptions, DecryptOptions, BruteforceResult, dan lainnya.
import { encrypt, type EncryptOptions } from "caesar-cipher-js"; const options: EncryptOptions = { caseStrategy: "upper" };const result: string = encrypt("Hello", 3, options); console.log(result);// KHOORPustaka, API, atau kode sendiri?
Pilih pustaka untuk proyek JavaScript atau TypeScript: berjalan secara lokal, tanpa permintaan atau batas. Untuk bahasa lain, atau jika memerlukan ROT13 atau Vigenère, gunakan REST API. Jika sedang belajar, tulis sendiri sandinya dengan mengikuti tutorial JavaScript.
Pertanyaan yang sering diajukan
Apakah pustaka ini gratis?
Ya. Pustaka ini berlisensi MIT, sehingga bisa dipakai dalam proyek pribadi maupun komersial.
Bisakah ini melindungi data sungguhan?
Tidak. Sandi Caesar bisa dipecahkan dalam hitungan detik, seperti yang ditunjukkan bruteforce. Gunakan pustaka ini untuk belajar, teka-teki, dan permainan. Data sungguhan memerlukan enkripsi modern, misalnya Web Crypto API.
Apakah pustaka ini dipakai secara nyata?
Ya. Alat sandi Caesar di situs ini berjalan dengannya, termasuk pemecah sandi.