Skip to content

Sync EN: mongodb driver ClientEncryption #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lacatoire wants to merge 1 commit into from
Closed

Sync EN: mongodb driver ClientEncryption #752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 65 additions & 67 deletions reference/mongodb/mongodb/driver/clientencryption.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4639881688d3faaf0073ad71fe0a4b730aea15a0 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: lacatoire Status: ready --><!-- CREDITS: leonardolara -->

<reference xml:id="class.mongodb-driver-clientencryption" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

Expand All @@ -11,11 +11,11 @@
<!-- {{{ MongoDB\Driver\ClientEncryption intro -->
<section xml:id="mongodb-driver-clientencryption.intro">
&reftitle.intro;
<para>
<simpara>
A classe <classname>MongoDB\Driver\ClientEncryption</classname> lida com
a criação de chaves de dados para criptografia no lado do cliente e também com
criptografia e descriptografia manuais de valores.
</para>
</simpara>
</section>
<!-- }}} -->

Expand Down Expand Up @@ -95,70 +95,70 @@
<varlistentry xml:id="mongodb-driver-clientencryption.constants.deterministic">
<term><constant>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</constant></term>
<listitem>
<para>Especifica um algoritmo para <link xlink:href="&url.mongodb.docs;core/csfle/fundamentals/encryption-algorithms/#deterministic-encryption">criptografia determinística</link>, que é adequado para consultas.</para>
<simpara>Especifica um algoritmo para <link xlink:href="&url.mongodb.docs;core/csfle/fundamentals/encryption-algorithms/#deterministic-encryption">criptografia determinística</link>, que é adequado para consultas.</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.random">
<term><constant>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</constant></term>
<listitem>
<para>Especifica um algoritmo para <link xlink:href="&url.mongodb.docs;core/csfle/fundamentals/encryption-algorithms/#randomized-encryption">criptografia aleatorizada</link></para>
<simpara>Especifica um algoritmo para <link xlink:href="&url.mongodb.docs;core/csfle/fundamentals/encryption-algorithms/#randomized-encryption">criptografia aleatorizada</link></simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.algorithm-indexed">
<term><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant></term>
<listitem>
<para>Especifica um algoritmo para uma carga criptografada e indexada, que pode ser usada com criptografia consultável.</para>
<para>Para inserir ou consultado com uma carga criptografada e indexada, a classe <classname>MongoDB\Driver\Manager</classname> precisa ser configurada com a opção <literal>"autoEncryption"</literal> do driver. A opção de autocriptografia <literal>"bypassQueryAnalysis"</literal> pode ser &true;. A opção de autocriptografia <literal>"bypassAutoEncryption"</literal> precisa ser &false;.</para>
<simpara>Especifica um algoritmo para uma carga criptografada e indexada, que pode ser usada com criptografia consultável.</simpara>
<simpara>Para inserir ou consultado com uma carga criptografada e indexada, a classe <classname>MongoDB\Driver\Manager</classname> precisa ser configurada com a opção <literal>"autoEncryption"</literal> do driver. A opção de autocriptografia <literal>"bypassQueryAnalysis"</literal> pode ser &true;. A opção de autocriptografia <literal>"bypassAutoEncryption"</literal> precisa ser &false;.</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.algorithm-unindexed">
<term><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</constant></term>
<listitem>
<para>Especifica um algoritmo para uma carga criptografada e não indexada.</para>
<simpara>Especifica um algoritmo para uma carga criptografada e não indexada.</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.algorithm-range">
<term><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant></term>
<listitem>
<para>
<simpara>
Especifica um algoritmo para uma carga criptografada por intervalo, que pode ser usada
com criptgrafia consultável.
</para>
<para>
</simpara>
<simpara>
Para consultar com uma carga criptografada por intervalo, a classe
<classname>MongoDB\Driver\Manager</classname> precisa ser configurada com a opção de driver
<literal>"autoEncryption"</literal>. A
opção de criptografia automática <literal>"bypassQueryAnalysis"</literal> pode ser
&true;. A opção de criptografia automática <literal>"bypassAutoEncryption"</literal>
deve ser &false;.
</para>
</simpara>
<note>
<para>A extensão ainda não oferece suporte a consultas de intervalo para tipos de campo Decimal128 BSON.</para>
<simpara>A extensão ainda não oferece suporte a consultas de intervalo para tipos de campo Decimal128 BSON.</simpara>
</note>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.query-type-equality">
<term><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</constant></term>
<listitem>
<para>
<simpara>
Especifica um tipo de consulta de igualdade, que é usada em conjunto com
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>.
</para>
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.query-type-range">
<term><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE</constant></term>
<listitem>
<para>
<simpara>
Especifica um tipo de consulta de intervalo, que é usada em conjunto com
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>.
</para>
</simpara>
</listitem>
</varlistentry>

Expand All @@ -168,57 +168,55 @@

<section role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.0.0</entry>
<entry>
<para>
Removidas as constantes <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</constant>
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</constant>.
</para>
</entry>
</row>
<row>
<entry>PECL mongodb 1.20.0</entry>
<entry>
<para>
Adicionadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE</constant>.
</para>
<para>
Descontinuadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</constant>
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</constant>.
</para>
</entry>
</row>
<row>
<entry>PECL mongodb 1.16.0</entry>
<entry>
Adicionadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</constant>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.0.0</entry>
<entry>
<simpara>
Removidas as constantes <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</constant>
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</constant>.
</entry>
</row>
<row>
<entry>PECL mongodb 1.14.0</entry>
<entry>
Adicionadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>,
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</constant>,
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</constant>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 1.20.0</entry>
<entry>
<simpara>
Adicionadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE</constant>.
</simpara>
<simpara>
Descontinuadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</constant>
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</constant>.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 1.16.0</entry>
<entry>
Adicionadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</constant>
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</constant>.
</entry>
</row>
<row>
<entry>PECL mongodb 1.14.0</entry>
<entry>
Adicionadas <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>,
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</constant>,
e <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</constant>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

<section xml:id="mongodb-driver-clientencryption.seealso">
Expand Down
18 changes: 9 additions & 9 deletions reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 9e9578a5c4288bf10c1675da131c79c4e28252a8 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: lacatoire Status: ready --><!-- CREDITS: leonardolara -->

<refentry xml:id="mongodb-driver-clientencryption.addkeyaltname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
Expand All @@ -14,10 +14,10 @@
<methodparam><type>MongoDB\BSON\Binary</type><parameter>keyId</parameter></methodparam>
<methodparam><type>string</type><parameter>keyAltName</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adiciona <parameter>keyAltName</parameter> ao conjunto de nomes alternativos para o
documento da chave com o UUID <parameter>keyId</parameter> fornecido.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -26,30 +26,30 @@
<varlistentry>
<term><parameter>keyId</parameter></term>
<listitem>
<para>
<simpara>
Uma instância <classname>MongoDB\BSON\Binary</classname> com subtipo 4
(UUID) identificando o documento da chave.
</para>
</simpara>
</listitem>
</varlistentry>

<varlistentry>
<term><parameter>keyAltName</parameter></term>
<listitem>
<para>
<simpara>
Nome alternativo a ser adicionado ao documento da chave.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Retorna a versão anterior do documento da chave ou &null; se nenhum documento
corresponder.
</para>
</simpara>
</refsect1>

<refsect1 role="errors">
Expand Down
92 changes: 45 additions & 47 deletions reference/mongodb/mongodb/driver/clientencryption/construct.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: cc6f9ee922cc02771942f435f66fbd008bf5788d Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: lacatoire Status: ready --><!-- CREDITS: leonardolara -->

<refentry xml:id="mongodb-driver-clientencryption.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
Expand All @@ -13,9 +13,9 @@
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\Driver\ClientEncryption::__construct</methodname>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Constrói um novo objeto <classname>MongoDB\Driver\ClientEncryption</classname> com as opções especificadas.
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand Down Expand Up @@ -63,50 +63,48 @@

<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.16.0</entry>
<entry>
<para>
O provedor AWS KMS para criptografia do lado do cliente agora aceita uma
opção <literal>"sessionToken"</literal>, que pode ser usada para
autenticação com credenciais temporárias da AWS.
</para>
<para>
Adicionado <literal>"tlsDisableOCSPEndpointCheck"</literal> à
opção <literal>"tlsOptions"</literal>.
</para>
<para>
Se um documento vazio for especificado para o provedor KMS <literal>"azure"</literal> ou
<literal>"gcp"</literal>, o driver tentará
configurar o provedor usando
<link xlink:href="&url.mongodb.specs;/blob/master/source/client-side-encryption/client-side-encryption.rst#automatic-credentials">Credenciais Automáticas</link>.
</para>
</entry>
</row>
<row>
<entry>PECL mongodb 1.15.0</entry>
<entry>
<para>
Se um documento vazio for especificado para o provedor KMS <literal>"aws"</literal>,
o driver tentará configurar o provedor usando
<link xlink:href="&url.mongodb.specs;/blob/master/source/client-side-encryption/client-side-encryption.rst#automatic-credentials">Credenciais Automáticas</link>.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.16.0</entry>
<entry>
<simpara>
O provedor AWS KMS para criptografia do lado do cliente agora aceita uma
opção <literal>"sessionToken"</literal>, que pode ser usada para
autenticação com credenciais temporárias da AWS.
</simpara>
<simpara>
Adicionado <literal>"tlsDisableOCSPEndpointCheck"</literal> à
opção <literal>"tlsOptions"</literal>.
</simpara>
<simpara>
Se um documento vazio for especificado para o provedor KMS <literal>"azure"</literal> ou
<literal>"gcp"</literal>, o driver tentará
configurar o provedor usando
<link xlink:href="&url.mongodb.specs;/blob/master/source/client-side-encryption/client-side-encryption.rst#automatic-credentials">Credenciais Automáticas</link>.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 1.15.0</entry>
<entry>
<simpara>
Se um documento vazio for especificado para o provedor KMS <literal>"aws"</literal>,
o driver tentará configurar o provedor usando
<link xlink:href="&url.mongodb.specs;/blob/master/source/client-side-encryption/client-side-encryption.rst#automatic-credentials">Credenciais Automáticas</link>.
</simpara>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="seealso">
Expand Down
Loading
Loading