Codefeedback: Wie findet ihr diesen?

Stef · 10. Mai 2021

Hey zusammen,

ich habe in der letzten Stunde in PHP die Cäser-Verschlüsselung durch Transposition entwickelt. Ich nutze zum Teil redunanten Code und habe auch ein paar notwendige Verzweigungen drin. Ich finde, dass man diesen Code noch deutlich komprimieren kann nur komme zur Zeit nicht drauf wie.

Nun möchte ich einfach mal euer Feedback zu diesem Anwendungscode hören. Was findet ihr gut? Was findet ihr nicht gut? Was kann ich besser machen? Wie kann ich den Code komprimieren?

PHP

<?php

session_start();

/*

Caeser Verschlüsselung (Ersetzungschiffre)
Jeder Buchstabe wird durch einen anderen Buchstaben ersetzt

Was brauchen wir dafür?
1. Schlüsselraum das Alphabets: 26
2. Key, um wie viel Stellen die Buchstaben verschoben werden sollen (k)
3. Position des jeweiligen Buchstabens im Alphabet (p)

Verschlüsseln = p + k mod 26
Entschlüsseln = p - k mod 26
*/

$alphabet = [
  "a" => 1,
  "b" => 2,
  "c" => 3,
  "d" => 4,
  "e" => 5,
  "f" => 6,
  "g" => 7,
  "h" => 8,
  "i" => 9,
  "j" => 10,
  "k" => 11,
  "l" => 12,
  "m" => 13,
  "n" => 14,
  "o" => 15,
  "p" => 16,
  "q" => 17,
  "r" => 18,
  "s" => 19,
  "t" => 20,
  "u" => 21,
  "v" => 22,
  "w" => 23,
  "x" => 24,
  "y" => 25,
  "z" => 26
];

$keyRoom = count($alphabet);
$key = 3;

$decryptedText = null;
$cipherText = null;

if(isset($_POST["verschluesseln"])){
  $plainText = $_POST["plainText"] ?? null;

  if($plainText){
    $plainTextArray = str_split(strtolower($plainText));
    $output = "<strong>Der verschlüsselte Text lautet:</strong> ";

    foreach ($plainTextArray as $letter) {
        $letterTyp = null;
        $i = 0;

        if(array_key_exists($letter, $alphabet)){
          $newPosition = ($alphabet[$letter] + $key) % $keyRoom;

          if($newPosition === 0){
            $newPosition = 26;
          }
        }else{
          $newPosition = 0;
          $letterTyp = $letter;
        }

        foreach ($alphabet as $cipherKey => $value) {
          if($value === $newPosition){
            $cipherText .= $cipherKey;
          }else{
            if($i < 1){
              $cipherText .= $letterTyp;
              $i++;
            }
          }
        }
    }

    $output .= $cipherText;
    $_SESSION["cipherText"] = $cipherText;
  }

}else if(isset($_POST["entschluesseln"]) && isset($_SESSION["cipherText"])){
  $cipherTextArray = str_split($_SESSION["cipherText"]);
  $output = "<strong>Der entschlüsselte Text lautet:</strong> ";


  foreach ($cipherTextArray as $letter) {
    $letterTyp = null;
    $i = 0;

    if(array_key_exists($letter, $alphabet)){
      if(($alphabet[$letter] - $key) < 0){
        $result = $alphabet[$letter] - $key;
        $result += $keyRoom;

        $oldPosition = $result % $keyRoom;

      }else{
        $oldPosition = (abs($alphabet[$letter] - $key)) % $keyRoom;
      }

    }else{
      $oldPosition = 0;
      $letterTyp = $letter;
    }

    foreach ($alphabet as $plainKey => $value) {
      if($value === $oldPosition){
        $decryptedText .= $plainKey;
      }else{
        if($i < 1){
          $decryptedText .= $letterTyp;
          $i++;
        }
      }
    }

  }

  $output .= $decryptedText;

}


?>

<!DOCTYPE html>
<html lang="de" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>Cäser Verschlüsselung</title>

    <style>

      form{
        margin-bottom: 1em;
      }

      textarea{
        display: block;
      }


    </style>
  </head>
  <body>
      <h1>Cäser Verschlüsselung</h1>
      <form class="" method="post">
          <label for="plainText">Gebe hier deinen Klartext ein:</label>
          <textarea name="plainText" id="plainText" rows="10" cols="35"></textarea>

          <input type="submit" name="verschluesseln" value="Klartext verschlüsseln">
          <input type="submit" name="entschluesseln" value="Generieter Ciphertext entschlüsseln">
      </form>

      <?= $output ?? null;  ?>
  </body>
</html>

Alles anzeigen

Ich würde mich sehr über euer Feedback freuen.

Schöne Grüße,
Stef

cottton · 11. Mai 2021

Ich empfehle sowas immer ohne HTML zu schreiben.

Schreib Funktionen, oder Objekte, aber keine Loops mit HTML

$alphabetkannst Du schon mal generieren.

So in etwa (ungetested)

PHP

$alphabet = [];
// Note: start with $i = 1 for 1-26 array offsets.
for ($i = 1, $char = 'a'; $i <= 26; $i++) {
    $alphabet[$i] = $char;
    // Note: PHP gets the next char in alphabet on ++.
    $char++;
}

Und schon diese kleine Sache packst Du einfach schon mal weg in eine Funktion (z.B: generateAlphabetArray()).

Als nächstes willst Du ja en- und de-coden.

Also wird es sicher eine soUndSoEncode und soUndSoDecode Funktion geben.

Diese beiden werden dann sicherlich gemeinsamen Code nutzen (können).

Also packst Du diesen Code, wenn auch nur kleine Loops ect, in eine Funktion,

die beide dann nutzen können.

Oft schreib ich mir erstmal runter, wie ich das Ganze dann eigentlich aufrufen will,

ohne zu wissen, was mich erwaret.

In etwa (als Objekt (OOP)):

Code

// clear text example input
$text = 'foo bar baz';

// encode
$caesar = new Caesar();
$encryptedText = $caesar->encrypt($text); 

// decode
$clearText = $caesar->decrypt($encryptedText);

So wüsste ich schon mal, was ich für (public) Funktionen haben wöllte.

Dir selbst oder jemand, der es später nutzen würde, ist es dann relativ egal, was da drin passiert.

Hauptsache der Call ist "angenehm".

Wenn Du das dann als Webseite anzeigen willst, dann ist der Einbau ja recht einfach.

Es ist aber schön getrennt - Funktion (Caesar) und Controller (Input|output (HTML, ....)).

Stef · 21. Mai 2021

Hey cottton,

herzlichen dank dir für dein Feedback zu meinem Code.

Aus diesem konnte ich jetzt viel hilfreiches herauspicken und auch neues lernen.

Danke!

Eine Frage habe ich dazu noch, bei der ich bisher überhaupt nicht weiterkomme. Meine Verschlüsselung gibt immer nur Kleinbuchstaben aus, da ich in dem Array Alphabet nur Kleinbuchstaben stehen habe und daher nur mit Kleinbuchstaben arbeiten kann. Wie kann ich es nun so lösen, dass dabei auch die Groß- und Kleinschreibung beachtet wird, sodass beim verschlüsseln und entschlüsseln der Text so ausgegeben wird, wie er eingegeben wurde?

Hast du da für mich Tipps oder auch Denkanstöße?

Schöne Grüße,
Stef

cottton · 24. Mai 2021

Naja, ich würde in dem Fall auch nur das Array mit Gross- und Kleinbuchstaben füllen.

Die Zeile $plainTextArray = str_split(strtolower($plainText));musst Du dann natürlich ändern, damit nicht alles auf Kleinbuchstaben gezwungen wird.

Also strtolowerweg.

Jetzt fehlen Dir ja dann auch noch andere Zeichen, Wie z.B. der Punkt, Komma, ... .

Musst Du dann eben noch in das $alphabet array packen.

BTW, was ich schon eher hätte erwähnen können: range()

https://www.php.net/manual/de/function.range.php

Siehe comment: https://www.php.net/manual/de/function.range.php#114493

Code

echo implode("",range("q","9 "));
// prints qponmlkjihgfedcba`_^]\[ZYXWVUTSRQPONMLKJIHGFEDCBA@?>=<;:987654

Sieht interessant aus. Evtl kannst Du damit ein array mit Sonderzeichen erstellen.

prodev · 24. Mai 2021

Das Ganze geht theoretisch in einer Zeile Code (bis auf glaube ich Nummern und andere Zeichen gehen nicht):

Code

echo str_rot13("Hallo Welt!");

Ansonsten könntest du vielleicht mit ctype_upper() checken, ob der jeweilige Buchstabe groß ist und dann mit strtoupper() auch in der Verschlüsselung groß schreiben.

Stef · 28. Mai 2021

Hey,

vielen Dank für eure Antworten.

Ich habe durch diese jetzt viele neue Ideen, die ich jetzt nach und nach austesten werde

Ich melde mich wieder sobald ich den Code aktualisiert habe oder nicht weiter komme.

Schöne Grüße,
Stef

Stef · 29. Mai 2021

Guten Tag zusammen,

ich konnte mit Hilfe eurer Tipps und Empfehlungen die Verschlüsselung nun erweitern. Neben Kleinbuchstaben können nun auch Großbuchstaben und 26 Sonderzeichen (inklusive Zahlen) verschlüsselt werden.

Während der Implementierung der weiteren Zeichen stand ich vor kleineren Herausforderungen zu denen ich bisher noch keine optimale Lösung, sondern eher eine Übergangslösung gefunden habe.

Beim Erstellen des Sonderzeichen-Arrays musste ich 3 Elemente löschen. Nun ist zwischen de Arrayelementen, vor und nach den drei gelöschten Elementen, der Array-Key um den Wert drei unterschiedlich. Also:

Code

array(
    .....
    22 => "#",
    25 => ",",
    ....
)

Ich brauche das Array jedoch mit fortlaufenden Keys ohne eine Lücke.

Meine Frage dazu ist: Wie kann ich nach dem Löschen von Array Keys die dahinterliegenden Array Keys durch die gelöschten Array Keys ersetzen, damit keine Lücke entsteht?

Dazu habe ich noch keine Lösung gefunden.

Bei meinem Lösungsweg habe ich aus dem Array eine Zeichenkette erstellt und dann diese nochmal am Seperator gesplittet damit die Array Keys nun fortlaufend ohne Lücke sind. Nun ist es so, dass ich die Array Keys von 1-26 und nicht von 0-25 brauche. Nun stand ich vor dem Problem, wie ich die Array Keys um eins hochzählen kann. Da fand ich nur einen Umweg über eine for-Schleife in der ich das Array nochmal komplett neu erstellt habe.

Meine Frage dazu ist: Gibt es eine Funktion mit der ich alle Array Keys um 1 hochzählen kann?

Nun möchte ich auch nochmal den Code mit euch teilen:

PHP: index.php

<?php

session_start();

require "Caeser.php";

$caeser = new Caeser();

$cipherText;
$plainText;
$error = null;

if(isset($_POST["verschluesseln"])){
  if(!empty($_POST["plainText"])){
    $cipherText = $caeser->encrypt(trim($_POST["plainText"]));
    $_SESSION["cipherText"] = $cipherText;
  }else{
    $error = "Bitte geben Sie den zu verschlüsselnden Text ein!";
  }
}

if(isset($_POST["entschluesseln"]) && isset($_SESSION["cipherText"])){
  $plainText = $caeser->decrypt($_SESSION["cipherText"]);
}

$cipherOutput = !empty($cipherText) ? "Der verschlüsselte Text lautet: <strong>" . $cipherText . "</strong>" : null;
$decryptedOutput = !empty($plainText) ? "Der entschlüsselte Text lautet: <strong>" . $plainText . "</strong>" : null;

?>

<!DOCTYPE html>
<html lang="de" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>Cäser Verschlüsselung</title>

    <style>

      form{
        margin-bottom: 1em;
      }

      textarea{
        display: block;
      }


    </style>
  </head>
  <body>
      <h1>Cäser Verschlüsselung</h1>
      <form class="" method="post">
          <label for="plainText">Gebe hier deinen Klartext ein:</label>
          <textarea name="plainText" id="plainText" rows="10" cols="35"></textarea>

          <input type="submit" name="verschluesseln" value="Klartext verschlüsseln">
          <input type="submit" name="entschluesseln" value="Generierten Ciphertext entschlüsseln">
      </form>

      <?= $cipherOutput ?? $decryptedOutput;  ?>
      <?= $error; ?>
  </body>
</html>

Alles anzeigen

PHP: Caeser.php

<?php

/*

Caeser Verschlüsselung (Ersetzungschiffre)
Jeder Buchstabe wird durch einen anderen Buchstaben ersetzt

Was brauchen wir dafür?
1. Schlüsselraum das Alphabets: 26
2. Key, um wie viel Stellen die Buchstaben verschoben werden sollen (k)
3. Position des jeweiligen Buchstabens im Alphabet (p)

Verschlüsseln = p + k mod 26
Entschlüsseln = p - k mod 26

Verschlüsselt & Entschlüsselt:
- Groß- und Kleinbuchstaben
- Zahlen
- Folgende Zeichen:
  # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : = ?
*/

class Caeser{

  private $keyRoom = 26;
  private $key = 3;
  private $letterPosition;

  private $lowercaseAlphabet = [];
  private $uppercaseAplhapet = [];
  private $moreChars = [];

  private $cipherText = "";
  private $decryptedText = "";

  public function __construct(){
    $this->generateAlphabetWithLowercaseLetters();
    $this->generateAlphabetWithUppercaseLetters();
    $this->generateMoreExtraChars();
  }

  protected function generateAlphabetWithLowercaseLetters(){
    for($i = 1, $char = "a"; $i <= $this->keyRoom; $i++){
      $this->lowercaseAlphabet[$char] = $i;

      $char++;
    }
  }

  protected function generateAlphabetWithUppercaseLetters(){
    for($i = 1, $char = "A"; $i <= $this->keyRoom; $i++){
      $this->uppercaseAplhapet[$char] = $i;

      $char++;
    }
  }

  protected function generateMoreExtraChars(){
    $chars = array_diff(range("#","?"), array("<", ">", ";"));

    $chars = implode("|", $chars);
    $chars = explode("|", $chars);

    for($i = 1; $i <= 26; $i++){
      $this->moreChars[$chars[$i - 1]] = $i;
    }
  }

  public function encrypt($plainText){
    if(isset($plainText)){
      $lettersArray = str_split($plainText);

      foreach ($lettersArray as $letter) {
          $letterTyp = null;
          $i = 0;

          if(array_key_exists($letter, $this->moreChars)){
            $alphabet = $this->moreChars;
          }else{
            $alphabet = ctype_upper($letter) ?  $this->uppercaseAplhapet : $this->lowercaseAlphabet;
          }


          if(array_key_exists($letter, $alphabet)){
            $newPosition = ($alphabet[$letter] + $this->key) % $this->keyRoom;

            if($newPosition === 0){
              $newPosition = 26;
            }
          }else{
            $newPosition = 0;
            $letterTyp = $letter;
          }

          foreach ($alphabet as $cipherKey => $value) {
            if($value === $newPosition){
              $this->cipherText .= $cipherKey;
            }else{
              if($i < 1){
                $this->cipherText .= $letterTyp;
                $i++;
              }
            }
          }
      }

      return $this->cipherText;
    }
  }

  public function decrypt($cipherText){
    if($cipherText){
      $lettersArray = str_split($cipherText);

      foreach ($lettersArray as $letter) {
        $letterTyp = null;
        $i = 0;

        if(array_key_exists($letter, $this->moreChars)){
            $alphabet = $this->moreChars;
          }else{
            $alphabet = ctype_upper($letter) ?  $this->uppercaseAplhapet : $this->lowercaseAlphabet;
          }

        if(array_key_exists($letter, $alphabet)){
          if(($alphabet[$letter] - $this->key) < 0){
            $result = $alphabet[$letter] - $this->key;
            $result += $this->keyRoom;

            $oldPosition = $result % $this->keyRoom;

            if($oldPosition == 0){
              $oldPosition = 26;
            }

          }else{
            $oldPosition = ($alphabet[$letter] - $this->key) % $this->keyRoom;
          }

        }else{
          $oldPosition = 0;
          $letterTyp = $letter;
        }

        foreach ($alphabet as $plainKey => $value) {
          if($value === $oldPosition){
            $this->decryptedText .= $plainKey;
          }else{
            if($i < 1){
              $this->decryptedText .= $letterTyp;
              $i++;
            }
          }
        }
      }

      return $this->decryptedText;
    }
  }

}

Alles anzeigen

Schöne Grüße,
Stef

cottton · 29. Mai 2021

Zitat von Stef

Ich brauche das Array jedoch mit fortlaufenden Keys ohne eine Lücke.

Das geht mit array_values().

Zitat von Stef

Meine Frage dazu ist: Gibt es eine Funktion mit der ich alle Array Keys um 1 hochzählen kann?

PHP

$array = [
    0 => 'a',
    1 => 'b',
    2 => 'c',
    3 => 'd',
    4 => 'e',
];
$values = array_values($array);
$array = array_combine(range(1, count($values)), $values);
// Output:
// array (
//     1 => 'a',
//     2 => 'b',
//     3 => 'c',
//     4 => 'd',
//     5 => 'e',
// )

Alles anzeigen

Mit array_values() bekommst Du alle values.
Mit range erstellst Du ein Array mit values von 1 bis {soviele, wie es values gibt}.

Mit array_combine() kombinierst Du die keys mit den values.

Stef · 6. Juni 2021

Hey cottton,

vielen Dank dir

Schöne Grüße,
Stef

wolf · 11. August 2021

Zitat von cottton

$alphabet kannst Du schon mal generieren.
So in etwa (ungetested)

Sollte sogar so gehen

PHP

$alphabet = range('a', 'z');

https://www.php.net/manual/en/…1-function.range-examples

Codefeedback: Wie findet ihr diesen?

Jetzt mitmachen!

Teilen