mysql-real-escape-string.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 62aa2694baf7fe904744a9b0f8a2a26e7fc3cf12 Maintainer: simp Status: ready -->
<!-- Credits: sammywg -->
<refentry xml:id="function.mysql-real-escape-string" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_real_escape_string</refname>
  <refpurpose>
   Maskiert spezielle Zeichen innerhalb einer Zeichenkette für die Verwendung
   in einer SQL-Anweisung
  </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_real_escape_string</function></member>
    <member><methodname>PDO::quote</methodname></member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mysql_real_escape_string</methodname>
   <methodparam><type>string</type><parameter>unescaped_string</parameter></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   Maskiert spezielle Zeichen in <parameter>unescaped_string</parameter> unter
   Berücksichtigung des aktuellen Zeichensatzes der Verbindung, so dass das
   Ergebnis ohne Probleme in <function>mysql_query</function> verwendet werden
   kann. Wenn Sie Binärdaten einfügen wollen, müssen Sie die Funktion auf
   jeden Fall verwenden.
  </para>
  <para>
   <function>mysql_real_escape_string</function> ruft die Funktion
   mysql_real_escape_string der MySQL-Bibliothek auf, die folgende Zeichen mit
   einem Backslash ('\') versieht: <literal>\x00</literal>,
   <literal>\n</literal>, <literal>\r</literal>, <literal>\</literal>,
   <literal>'</literal>, <literal>"</literal> und <literal>\x1a</literal>.
  </para>
  <para>
   Die Funktion muss (mit wenigen Ausnahmen) immer verwendet werden, um Daten
   abzusichern, bevor sie per Abrage an MySQL übermittelt werden.
  </para>

  <caution>
   <title>Sicherheit: Der Standardzeichensatz</title>
   <para>
    Der Zeichensatz muss entweder auf Ebene des Servers oder mittels der
    API-Funktion <function>mysql_set_charset</function> gesetzt werden, damit
    dieser <function>mysql_real_escape_string</function> beeinflusst. Siehe
    das Grundlagenkapitel zum Thema <link
    linkend="mysqlinfo.concepts.charset">Zeichensätze</link> für mehr
    Informationen.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>unescaped_string</parameter></term>
     <listitem>
      <para>
       Die zu maskierende Zeichenkette.
      </para>
     </listitem>
    </varlistentry>
    &mysql.linkid.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt eine maskierte Zeichenkette zurück oder im Fehlerfall &false;.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Wird diese Funktion ohne MySQL-Verbindung ausgeführt, werden ebenfalls
   PHP-Fehler der Stufe <constant>E_WARNUNG</constant> ausgelöst. Diese
   Funktion sollte nur mit einer gültigen MySQL-Verbindung verwendet werden.
  </para>
 </refsect1>
  <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Einfaches <function>mysql_real_escape_string</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
// Verbindung herstellen
$link = mysql_connect('mysql_host', 'mysql_user', 'mysql_password')
    OR die(mysql_error());

// Abfrage erstellen
$query = sprintf("SELECT * FROM users WHERE user='%s' AND password='%s'",
            mysql_real_escape_string($user),
            mysql_real_escape_string($password));
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>mysql_real_escape_string</function> benötigt eine Verbindung</title>
    <para>
     Diese Beispiel verdeutlicht, was geschieht, wenn beim Aufruf dieser
     Funktion keine MySQL-Verbindung vorhanden ist.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
// Wir sind nicht mit MySQL verbunden

$lastname  = "O'Reilly";
$_lastname = mysql_real_escape_string($lastname);

$query = "SELECT * FROM actors WHERE last_name = '$_lastname'";

var_dump($_lastname);
var_dump($query);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Warning: mysql_real_escape_string(): No such file or directory in /this/test/script.php on line 5
Warning: mysql_real_escape_string(): A link to the server could not be established in /this/test/script.php on line 5

bool(false)
string(41) "SELECT * FROM actors WHERE last_name = ''"
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Ein beispielhafter SQL-Injection-Angriff</title>
    <programlisting role="php">
<![CDATA[
<?php
// Wir haben $_POST['password'] nicht überprüft, es könnte
// jeder beliebiger Wert sein, den der Benutzer will!
$_POST['username'] = 'aidan';
$_POST['password'] = "' OR ''='";

// Datenbankabfrage zur Ueberpruefung der Logindaten
$query = "SELECT * FROM users WHERE user='{$_POST['username']}' AND password='{$_POST['password']}'";
mysql_query($query);

// Das bedeutet, der an MySQL gesendete Query wuerde sein:
echo $query;
?>
]]>
    </programlisting>
     <para>
      Die Abfrage, die an MySQL übermittelt wird:
     </para>
    <screen>
<![CDATA[
SELECT * FROM users WHERE user='aidan' AND password='' OR ''=''
]]>
    </screen>
    <para>
     Dies würde jedem erlauben, sich ohne valides Passwort einzuloggen.
    </para>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Sie müssen eine Verbindung zu MySQL geöffnet haben, bevor Sie
    <function>mysql_real_escape_string</function> verwenden, ansonsten
    erhalten Sie einen Fehler vom Typ <constant>E_WARNING</constant> und der
    Rückgabewert wird zu &false;. Ist <parameter>link_identifier</parameter>
    nicht angegeben, wird die letzte MySQL-Verbindung verwendet.
   </para>
  </note>
  <note>
   <para>
    Wenn die Funktion nicht verwendet wird, um die Daten zu maskieren, ist die
    Abfrage anfällig für
    <link linkend="security.database.sql-injection">SQL-Injection-Angriffe</link>.
   </para>
  </note>
  <note>
   <simpara>
    <function>mysql_real_escape_string</function> maskiert weder
    <literal>%</literal> noch <literal>_</literal>. Diese Zeichen werden in
    MySQL als Platzhalter interpretiert, wenn sie mit <literal>LIKE</literal>,
    <literal>GRANT</literal> oder <literal>REVOKE</literal> kombiniert werden.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysql_set_charset</function></member>
    <member><function>mysql_client_encoding</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->