php-doc-en/reference/mcrypt/functions/mcrypt-ofb.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
  <refentry id="function.mcrypt-ofb">
   <refnamediv>
    <refname>mcrypt_ofb</refname>
    <refpurpose>Encrypt/decrypt data in OFB mode</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>mcrypt_ofb</methodname>
      <methodparam><type>int</type><parameter>cipher</parameter></methodparam>
      <methodparam><type>string</type><parameter>key</parameter></methodparam>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
      <methodparam><type>string</type><parameter>iv</parameter></methodparam>
     </methodsynopsis>
     <methodsynopsis>
      <type>string</type><methodname>mcrypt_ofb</methodname>
      <methodparam><type>string</type><parameter>cipher</parameter></methodparam>
      <methodparam><type>string</type><parameter>key</parameter></methodparam>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam>
     </methodsynopsis>
    <para>
     The first prototype is when linked against libmcrypt 2.2.x, the
     second when linked against libmcrypt 2.4.x.
    </para>
    <para>
     <function>mcrypt_ofb</function> encrypts or decrypts (depending
     on <parameter>mode</parameter>) the <parameter>data</parameter>
     with <parameter>cipher</parameter> and <parameter>key</parameter>
     in OFB cipher mode and returns the resulting string.
    </para>    
    <para>
     <parameter>Cipher</parameter> is one of the MCRYPT_ciphername
     constants.
    </para>
    <para>
     <parameter>Key</parameter> is the key supplied to the
     algorithm. It must be kept secret.
    </para>
    <para>
     <parameter>Data</parameter> is the data which shall be
     encrypted/decrypted.
    </para> 
    <para>
     <parameter>Mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
    </para>
    <para>
     <parameter>IV</parameter> is the initialization vector.
    </para>
    <para>
     See also: <function>mcrypt_cbc</function>,
     <function>mcrypt_cfb</function>, and
     <function>mcrypt_ecb</function>.
    </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:"../../../../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
-->