Przejdź do treści

Caesar Cipher JS

Mała biblioteka npm do szyfru Cezara w JavaScript i TypeScript, bez zależności. Panel poniżej uruchamia ją naprawdę.

Terminal
npm install caesar-cipher-js
JavaScript
import { encrypt, decrypt } from "caesar-cipher-js"; console.log(encrypt("Witaj świecie!", 3));// Zlwdm śzlhflh!console.log(decrypt("Zlwdm śzlhflh!", 3));// Witaj świecie!
reklama

Instalacja

Pakiet jest w npm na licencji MIT, a kod źródłowy i testy znajdziesz na GitHubie. Użyj menedżera pakietów, który wolisz:

Terminal
npm install caesar-cipher-jsyarn add caesar-cipher-jspnpm add caesar-cipher-js

Wymaga Node.js 20 lub nowszego i jest dostępny jako moduły ES oraz CommonJS. W przeglądarce używaj go przez bundler: narzędzia na tej stronie ładują go przez Vite. Wersja ES po spakowaniu gzipem ma około 3,5 KB.

Szybki start

Zaimportuj potrzebną funkcję. Domyślnie biblioteka zachowuje wielkość liter i nie rusza niczego spoza alfabetu, dlatego „ś” w przykładzie zostaje bez zmian.

JavaScript
import { encrypt, decrypt } from "caesar-cipher-js"; console.log(encrypt("Witaj świecie!", 3));// Zlwdm śzlhflh!console.log(decrypt("Zlwdm śzlhflh!", 3));// Witaj świecie!
CommonJS
const { encrypt } = require("caesar-cipher-js"); console.log(encrypt("Witaj świecie!", 3));// Zlwdm śzlhflh!

Funkcje

Tych będziesz używać najczęściej. Działa też ujemne przesunięcie oraz przesunięcie większe niż alfabet.

NazwaCo robi
encrypt(text, shift, options?)Zwraca zaszyfrowany tekst.
decrypt(text, shift, options?)Zwraca odszyfrowany tekst.
bruteforce(text, options?)Sprawdza wszystkie przesunięcia i zwraca tablicę { shift, text, score? }. Opcje: alphabet, maxResults, scoreFunction.
getScoreFunction(language)Zwraca funkcję oceniającą dla danego języka.
mapDiacritics(text, language)Zamienia litery z akcentami na podstawowe.
new CaesarCipher(options?)Te same możliwości w obiekcie z zapisanymi ustawieniami.

Opcje

encrypt, decrypt i konstruktor CaesarCipher przyjmują te same opcje:

OpcjaCo robi
alphabetAlfabet, w którym odbywa się przesunięcie. Domyślnie od a do z.
caseStrategymaintain (domyślnie), upper lub lower.
preserveCaseDomyślnie true. Przy false wynik jest małymi literami.
preserveNonAlphaDomyślnie true. Przy false wszystko spoza alfabetu jest usuwane.
preserveSpacesDomyślnie true. Przy false spacje są usuwane.
preserveSpecialCharsDomyślnie true. Przy false interpunkcja i cyfry są usuwane.
diacriticsLanguageUstaw french, aby zamienić litery z akcentami przed przesunięciem.
JavaScript
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 }));// KhoorZruog

Polskie litery i inne alfabety

Biblioteka udostępnia alfabety dla polskiego, angielskiego, niemieckiego, hiszpańskiego i francuskiego oraz ALPHABET_ALPHANUMERIC_LOWER z cyframi. Możesz też podać dowolny własny napis. Polski alfabet ma tu 35 znaków:

JavaScript
import { encrypt, ALPHABET_POLISH_LOWER } from "caesar-cipher-js"; console.log(encrypt("Zażółć gęślą jaźń", 3, { alphabet: ALPHABET_POLISH_LOWER }));// Acbrńę jhvnć łcąp

Łamanie szyfru funkcją bruteforce

bruteforce zwraca po jednym wyniku na przesunięcie, zaczynając od 0. Aby najbardziej prawdopodobna odpowiedź była pierwsza, podaj scoreFunction. getScoreFunction ma gotową ocenę dla języków english, polish, german, spanish i french.

JavaScript
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 xia

Ocena tylko porównuje wyniki między sobą, więc sam sprawdź tekst, zwłaszcza gdy wiadomość jest krótka.

Klasa CaesarCipher

Klasa pamięta ustawienia, co przydaje się, gdy wiele razy używasz tych samych opcji. Ma też metody takie jak setAlphabet oraz reset(), która przywraca ustawienia domyślne.

JavaScript
import { CaesarCipher, ALPHABET_POLISH_LOWER } from "caesar-cipher-js"; const cipher = new CaesarCipher({ alphabet: ALPHABET_POLISH_LOWER });const secret = cipher.encrypt("Zażółć gęślą jaźń", 3); console.log(secret);// Acbrńę jhvnć łcąpconsole.log(cipher.decrypt(secret, 3));// Zażółć gęślą jaźń

Litery z akcentami

Litery z akcentami spoza alfabetu zwykle zostają bez zmian. W języku francuskim diacriticsLanguage najpierw zamienia é na e i ç na c, żeby też je przesunąć. Na razie tylko francuski ma takie mapowanie, a polskie litery obsługuje po prostu polski alfabet.

JavaScript
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 Qrho

TypeScript

Pakiet zawiera typy, więc nie trzeba niczego doinstalowywać. Eksportuje między innymi EncryptOptions, DecryptOptions i BruteforceResult.

TypeScript
import { encrypt, type EncryptOptions } from "caesar-cipher-js"; const options: EncryptOptions = { caseStrategy: "upper" };const result: string = encrypt("Hello", 3, options); console.log(result);// KHOOR

Biblioteka, API czy własny kod?

Bibliotekę wybierz do projektu w JavaScript lub TypeScript: działa lokalnie, bez żądań i limitów. W innych językach albo gdy potrzebujesz ROT13 lub Vigenère’a, użyj REST API. Jeśli się uczysz, napisz szyfr samodzielnie według tutoriala JavaScript.

Najczęstsze pytania

Czy biblioteka jest darmowa?

Tak. Jest na licencji MIT, więc możesz jej używać w projektach prywatnych i komercyjnych.

Czy mogę tym chronić prawdziwe dane?

Nie. Szyfr Cezara da się złamać w kilka sekund, co pokazuje bruteforce. Używaj biblioteki do nauki, łamigłówek i gier. Prawdziwe dane chroń współczesnym szyfrowaniem, na przykład przez Web Crypto API.

Czy jest używana w praktyce?

Tak. Działa na niej narzędzie szyfru Cezara na tej stronie, razem z łamaczem.

Co dalej