Files
archived-doc-pt-br/reference/mcrypt/functions/mcrypt-generic-init.xml
2026-01-19 03:24:29 +00:00

99 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e849a6c4225bd992474793ec6983df7898cae0be Maintainer: leonardolara Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-generic-init">
<refnamediv>
<refname>mcrypt_generic_init</refname>
<refpurpose>Esta função inicializa todos os buffers necessários para criptografia</refpurpose>
</refnamediv>
<refsynopsisdiv>
&warn.deprecated.function-7-1-0.removed-7-2-0;
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mcrypt_generic_init</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>iv</parameter></methodparam>
</methodsynopsis>
<simpara>
É necessário chamar esta função antes de cada chamada a
<function>mcrypt_generic</function> ou
<function>mdecrypt_generic</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<simpara>
O descritor de criptografia.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<simpara>
O comprimento máximo da chave deve ser aquele obtido chamando
<function>mcrypt_enc_get_key_size</function> e todo valor menor
que esse é válido.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>iv</parameter></term>
<listitem>
<simpara>
O IV normalmente deve ter o tamanho do bloco de algoritmos, mas
o tamanho deve ser obtido chamando
<function>mcrypt_enc_get_iv_size</function>. O IV é ignorado no ECB. O IV
DEVE existir nos modos CFB, CBC, fluxo, nOFB e OFB. Ele precisa ser
aleatório e único (mas não secreto). O mesmo IV deve ser usado para
criptografia/descriptografia. Se não houver intenção de usá-lo, deve ser definido
como zeros, mas isso não é recomendado.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
A função retorna um valor negativo em caso de erro: -3 quando o comprimento da chave
estiver incorreto, -4 quando houver um problema de alocação de memória e qualquer
outro valor de retorno é um erro desconhecido. Se ocorrer um erro, um aviso
será exibido apropriadamente. &false; é retornado se forem passados
parâmetros incorretos.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>mcrypt_module_open</function></member>
</simplelist>
</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
-->