Skip to content

Commit

Permalink
initial translation in openssl/functions
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardolara committed Oct 23, 2024
1 parent 6135a18 commit 70bb678
Show file tree
Hide file tree
Showing 9 changed files with 1,050 additions and 0 deletions.
92 changes: 92 additions & 0 deletions reference/openssl/functions/openssl-cipher-iv-length.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d1e3ea622e5d4f542cd36eca59a9f22aa0142633 Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.openssl-cipher-iv-length" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>openssl_cipher_iv_length</refname>
<refpurpose>Obtém o comprimento do vetor de inicialização da cifra</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>openssl_cipher_iv_length</methodname>
<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
</methodsynopsis>
<para>
Obtém o comprimento do vetor de inicialização (iv) da cifra
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cipher_algo</parameter></term>
<listitem>
<para>
O método de criptografia, consulte <function>openssl_get_cipher_methods</function> para uma lista de valores possíveis.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna o comprimento da cifra em caso de sucesso, ou &false; em caso de falha.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<para>
Emite um erro de nível <constant>E_WARNING</constant> quando o algoritmo
de criptografia é desconhecido.
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="openssl-cipher-iv-length.example.basic">
<title>Exemplo de <function>openssl_cipher_iv_length</function></title>
<programlisting role="php">
<![CDATA[
<?php
$method = 'AES-128-CBC';
$ivlen = openssl_cipher_iv_length($method);
echo $ivlen;
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
16
]]>
</screen>
</example>
</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
-->
90 changes: 90 additions & 0 deletions reference/openssl/functions/openssl-cipher-key-length.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.openssl-cipher-key-length" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>openssl_cipher_key_length</refname>
<refpurpose>Obtém o comprimento da chave da cifra</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>openssl_cipher_key_length</methodname>
<methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
</methodsynopsis>
<para>
Obtém o comprimento da chave da cifra.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cipher_algo</parameter></term>
<listitem>
<para>
O método de criptografia, consulte <function>openssl_get_cipher_methods</function> para uma lista de valores possíveis.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna o comprimento da cifra em caso de sucesso, ou &false; em caso de falha.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<para>
Emite um erro de nível <constant>E_WARNING</constant> quando o algoritmo
de criptografia é desconhecido.
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo de <function>openssl_cipher_key_length</function></title>
<programlisting role="php">
<![CDATA[
<?php
$method = 'AES-128-CBC';
var_dump(openssl_cipher_key_length($method));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
int(16)
]]>
</screen>
</example>
</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
-->
98 changes: 98 additions & 0 deletions reference/openssl/functions/openssl-cms-decrypt.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.openssl-cms-decrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>openssl_cms_decrypt</refname>
<refpurpose>Descriptografa uma mensagem CMS</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_cms_decrypt</methodname>
<methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
<methodparam choice="opt"><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type><type>null</type></type><parameter>private_key</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
</methodsynopsis>
<para>
Descriptografa uma mensagem CMS.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>input_filename</parameter></term>
<listitem>
<para>
O nome de um arquivo que contém conteúdo criptografado.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>output_filename</parameter></term>
<listitem>
<para>
O nome do arquivo para depositar o conteúdo descriptografado.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>certificate</parameter></term>
<listitem>
<para>
O nome do arquivo que contém um certificado do destinatário.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>private_key</parameter></term>
<listitem>
<para>
O nome do arquivo que contém uma chave <acronym>PKCS</acronym>#8.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
A codificação do arquivo de entrada. Uma das constantes <constant>OPENSSL_ENCODING_SMIME</constant>,
<constant>OPENSSL_ENCODING_DER</constant> ou <constant>OPENSSL_ENCODING_PEM</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->
Loading

0 comments on commit 70bb678

Please sign in to comment.