-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
initial translation in reference/rnp/functions
- Loading branch information
1 parent
ea425ae
commit 54fef00
Showing
4 changed files
with
380 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: 79bc1248b2295d9c9f0837d1ddcaea9d7c2853a7 Maintainer: leonardolara Status: ready --> | ||
<refentry xml:id="function.rnp-import-keys" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
<refnamediv> | ||
<refname>rnp_import_keys</refname> | ||
<refpurpose>Importa chaves da string PHP para o chaveiro e recebe JSON descrevendo chaves novas/atualizadas</refpurpose> | ||
</refnamediv> | ||
|
||
<refsect1 role="description"> | ||
&reftitle.description; | ||
<methodsynopsis> | ||
<type class="union"><type>string</type><type>false</type></type><methodname>rnp_import_keys</methodname> | ||
<methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam> | ||
<methodparam><type>string</type><parameter>input</parameter></methodparam> | ||
<methodparam><type>int</type><parameter>flags</parameter></methodparam> | ||
</methodsynopsis> | ||
<para> | ||
</para> | ||
|
||
</refsect1> | ||
|
||
<refsect1 role="parameters"> | ||
&reftitle.parameters; | ||
<variablelist> | ||
<varlistentry> | ||
<term><parameter>ffi</parameter></term> | ||
<listitem> | ||
<para> | ||
&rnp.parameter.ffi-description; | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>input</parameter></term> | ||
<listitem> | ||
<para> | ||
Pacotes OpenPGP contendo chaves a serem carregadas. Pode ser binário ou blindado ASCII. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>flags</parameter></term> | ||
<listitem> | ||
<para> | ||
Consulte as constantes predefinidas <constant>RNP_LOAD_SAVE_*</constant>. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
</variablelist> | ||
</refsect1> | ||
|
||
<refsect1 role="returnvalues"> | ||
&reftitle.returnvalues; | ||
<para> | ||
String JSON com informações sobre chaves novas e atualizadas em caso de sucesso&return.falseforfailure;. | ||
</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 | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: 79bc1248b2295d9c9f0837d1ddcaea9d7c2853a7 Maintainer: leonardolara Status: ready --> | ||
<refentry xml:id="function.rnp-import-signatures" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
<refnamediv> | ||
<refname>rnp_import_signatures</refname> | ||
<refpurpose>Importa assinaturas independentes para o chaveiro e recebe JSON descrevendo chaves atualizadas</refpurpose> | ||
</refnamediv> | ||
|
||
<refsect1 role="description"> | ||
&reftitle.description; | ||
<methodsynopsis> | ||
<type class="union"><type>string</type><type>false</type></type><methodname>rnp_import_signatures</methodname> | ||
<methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam> | ||
<methodparam><type>string</type><parameter>input</parameter></methodparam> | ||
<methodparam><type>int</type><parameter>flags</parameter></methodparam> | ||
</methodsynopsis> | ||
<para> | ||
</para> | ||
|
||
</refsect1> | ||
|
||
<refsect1 role="parameters"> | ||
&reftitle.parameters; | ||
<variablelist> | ||
<varlistentry> | ||
<term><parameter>ffi</parameter></term> | ||
<listitem> | ||
<para> | ||
&rnp.parameter.ffi-description; | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>input</parameter></term> | ||
<listitem> | ||
<para> | ||
Pacotes OpenPGP contendo assinaturas a serem importadas. Pode ser binário ou blindado ASCII. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>flags</parameter></term> | ||
<listitem> | ||
<para> | ||
Atualmente precisar ser 0. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
</variablelist> | ||
</refsect1> | ||
|
||
<refsect1 role="returnvalues"> | ||
&reftitle.returnvalues; | ||
<para> | ||
String JSON com informações sobre chaves atualizadas em caso de sucesso&return.falseforfailure;. | ||
</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 | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: 79bc1248b2295d9c9f0837d1ddcaea9d7c2853a7 Maintainer: leonardolara Status: ready --> | ||
<refentry xml:id="function.rnp-key-export-autocrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
<refnamediv> | ||
<refname>rnp_key_export_autocrypt</refname> | ||
<refpurpose> | ||
Exporte o mínimo de chaves para o recurso de criptografia automática (apenas 5 pacotes: chave, uid, assinatura, | ||
subchave de criptografia, assinatura) | ||
</refpurpose> | ||
</refnamediv> | ||
|
||
<refsect1 role="description"> | ||
&reftitle.description; | ||
<methodsynopsis> | ||
<type class="union"><type>string</type><type>false</type></type><methodname>rnp_key_export_autocrypt</methodname> | ||
<methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam> | ||
<methodparam><type>string</type><parameter>key_fp</parameter></methodparam> | ||
<methodparam><type>string</type><parameter>subkey_fp</parameter></methodparam> | ||
<methodparam><type>string</type><parameter>uid</parameter></methodparam> | ||
<methodparam><type>int</type><parameter>flags</parameter></methodparam> | ||
</methodsynopsis> | ||
<para> | ||
</para> | ||
|
||
</refsect1> | ||
|
||
<refsect1 role="parameters"> | ||
&reftitle.parameters; | ||
<variablelist> | ||
<varlistentry> | ||
<term><parameter>ffi</parameter></term> | ||
<listitem> | ||
<para> | ||
&rnp.parameter.ffi-description; | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>key_fp</parameter></term> | ||
<listitem> | ||
<para> | ||
Impressão digital da chave primária. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>subkey_fp</parameter></term> | ||
<listitem> | ||
<para> | ||
Subchave para exportar. Pode ser uma string vazia | ||
para selecionar a primeira subchave adequada. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>uid</parameter></term> | ||
<listitem> | ||
<para> | ||
ID do usuário a ser exportado. Pode ser uma string vazia | ||
se a chave exportada tiver apenas um uid. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>flags</parameter></term> | ||
<listitem> | ||
<para> | ||
Apenas <constant>RNP_KEY_EXPORT_BASE64</constant> é suportada atualmente. Ativá-la | ||
exportaria dados de chave codificados em base64 em vez de binários. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
</variablelist> | ||
</refsect1> | ||
|
||
<refsect1 role="returnvalues"> | ||
&reftitle.returnvalues; | ||
<para> | ||
Pacotes OpenPGP de chave exportada em caso de sucesso&return.falseforfailure;. | ||
</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 | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: 79bc1248b2295d9c9f0837d1ddcaea9d7c2853a7 Maintainer: leonardolara Status: ready --> | ||
<refentry xml:id="function.rnp-key-export-revocation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
<refnamediv> | ||
<refname>rnp_key_export_revocation</refname> | ||
<refpurpose>Gera e exporta assinatura de revogação de chave primária</refpurpose> | ||
</refnamediv> | ||
|
||
<refsect1 role="description"> | ||
&reftitle.description; | ||
<methodsynopsis> | ||
<type class="union"><type>string</type><type>false</type></type><methodname>rnp_key_export_revocation</methodname> | ||
<methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam> | ||
<methodparam><type>string</type><parameter>key_fp</parameter></methodparam> | ||
<methodparam><type>int</type><parameter>flags</parameter></methodparam> | ||
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> | ||
</methodsynopsis> | ||
<para> | ||
Nota: para revogar uma chave é preciso importar esta assinatura para o armazenamento de chaves ou usar | ||
a função <function>rnp_key_revoke</function>. | ||
</para> | ||
|
||
</refsect1> | ||
|
||
<refsect1 role="parameters"> | ||
&reftitle.parameters; | ||
<variablelist> | ||
<varlistentry> | ||
<term><parameter>ffi</parameter></term> | ||
<listitem> | ||
<para> | ||
&rnp.parameter.ffi-description; | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>key_fp</parameter></term> | ||
<listitem> | ||
<para> | ||
Impressão digital da chave primária a ser revogada. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>flags</parameter></term> | ||
<listitem> | ||
<para> | ||
<constant>RNP_KEY_EXPORT_ARMORED</constant> ou 0. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term><parameter>options</parameter></term> | ||
<listitem> | ||
<para> | ||
Um array associativo com opções. | ||
</para> | ||
<informaltable> | ||
<tgroup cols="2"> | ||
<thead> | ||
<row> | ||
<entry>Chave</entry> | ||
<entry>Tipo de dado</entry> | ||
<entry>&Description;</entry> | ||
</row> | ||
</thead> | ||
<tbody> | ||
<row> | ||
<entry><literal>"hash"</literal></entry> | ||
<entry>string</entry> | ||
<entry>Define o algoritmo de hash usado durante cálculo da assinatura.</entry> | ||
</row> | ||
<row> | ||
<entry><literal>"code"</literal></entry> | ||
<entry>string</entry> | ||
<entry>Código do motivo da revogação. Valores possíveis são: 'no' (não), 'superseded' (substituída), 'compromised' (comprometida) e | ||
'retired' (aposentada). Se não definida, o valor 'no' será usado por padrão.</entry> | ||
</row> | ||
<row> | ||
<entry><literal>"reason"</literal></entry> | ||
<entry>string</entry> | ||
<entry>Representação textual do motivo da revogação.</entry> | ||
</row> | ||
</tbody> | ||
</tgroup> | ||
</informaltable> | ||
</listitem> | ||
</varlistentry> | ||
</variablelist> | ||
</refsect1> | ||
|
||
<refsect1 role="returnvalues"> | ||
&reftitle.returnvalues; | ||
<para> | ||
Assinatura de revogação exportada em caso de sucesso&return.falseforfailure;. | ||
</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 | ||
--> |