From f1b3ac932f5ece3b2ae82e880f2d87bf45b0347d Mon Sep 17 00:00:00 2001 From: leonardolara Date: Sun, 3 Nov 2024 19:20:46 -0300 Subject: [PATCH] initial translation in openssl/functions --- .../openssl/functions/openssl-pkey-derive.xml | 140 ++++++++++ .../functions/openssl-pkey-export-to-file.xml | 120 ++++++++ .../openssl/functions/openssl-pkey-export.xml | 118 ++++++++ .../openssl/functions/openssl-pkey-free.xml | 97 +++++++ .../functions/openssl-pkey-get-details.xml | 258 ++++++++++++++++++ .../functions/openssl-pkey-get-private.xml | 119 ++++++++ .../functions/openssl-pkey-get-public.xml | 105 +++++++ .../openssl/functions/openssl-pkey-new.xml | 153 +++++++++++ 8 files changed, 1110 insertions(+) create mode 100644 reference/openssl/functions/openssl-pkey-derive.xml create mode 100644 reference/openssl/functions/openssl-pkey-export-to-file.xml create mode 100644 reference/openssl/functions/openssl-pkey-export.xml create mode 100644 reference/openssl/functions/openssl-pkey-free.xml create mode 100644 reference/openssl/functions/openssl-pkey-get-details.xml create mode 100644 reference/openssl/functions/openssl-pkey-get-private.xml create mode 100644 reference/openssl/functions/openssl-pkey-get-public.xml create mode 100644 reference/openssl/functions/openssl-pkey-new.xml diff --git a/reference/openssl/functions/openssl-pkey-derive.xml b/reference/openssl/functions/openssl-pkey-derive.xml new file mode 100644 index 000000000..5734d296a --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-derive.xml @@ -0,0 +1,140 @@ + + + + + openssl_pkey_derive + Calcula o segredo compartilhado para o valor público da chave DH ou ECDH remota e local + + + + &reftitle.description; + + stringfalseopenssl_pkey_derive + OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key + #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key + intkey_length0 + + + openssl_pkey_derive pega um conjunto de public_key + e private_key e deriva um segredo compartilhado, para chaves DH ou EC. + + + + + + &reftitle.parameters; + + + public_key + + + public_key é a chave pública para a derivação. + Consulte Parâmetros de chave pública/privada para obter uma lista de valores válidos. + + + + + private_key + + + private_key é a chave privada para a derivação. + Consulte Parâmetros de chave pública/privada para obter uma lista de valores válidos. + + + + + key_length + + + Se não for zero, tentará definir o comprimento desejado do segredo derivado. + + + + Este parâmetro não deve ser utilizado, pois não funciona conforme o esperado. Ele nunca retorna um segredo + maior que o tamanho do primo. Se o comprimento desejado for menor que o tamanho do + primo, ele truncará o comprimento apenas para chaves ECDH, mas falhará para chaves DH. + + + + + + + + + &reftitle.returnvalues; + + O segredo derivado em caso de sucesso&return.falseforfailure;. + + + + + &reftitle.examples; + + + Exemplo de <function>openssl_pkey_derive</function> + + + + + + + + + diff --git a/reference/openssl/functions/openssl-pkey-export-to-file.xml b/reference/openssl/functions/openssl-pkey-export-to-file.xml new file mode 100644 index 000000000..c067efbd9 --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-export-to-file.xml @@ -0,0 +1,120 @@ + + + + + openssl_pkey_export_to_file + Obtém uma representação exportável de uma chave em um arquivo + + + + &reftitle.description; + + boolopenssl_pkey_export_to_file + #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringkey + stringoutput_filename + #[\SensitiveParameter]stringnullpassphrase&null; + arraynulloptions&null; + + + openssl_pkey_export_to_file salva uma versão ASCII blindada + (codificada em PEM) de key no arquivo nomeado por + output_filename. + + ¬e.openssl.cnf; + + + + &reftitle.parameters; + + + + key + + + + + + + output_filename + + + Caminho para o arquivo de saída. + + + + + passphrase + + + A chave pode ser opcionalmente protegida por uma senha definida no parâmetro + passphrase. + + + + + options + + + options pode ser usado para fazer ajuste fino do processo + de exportação especificando e/ou substituindo opções para o arquivo de + configuração do openssl. Consulte openssl_csr_new para obter + mais informações sobre options. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + key agora aceita uma instância de OpenSSLAsymmetricKey + ou OpenSSLCertificate; + anteriormente, um &resource; do tipo OpenSSL key ou OpenSSL X.509 + era aceito. + + + + + + + + diff --git a/reference/openssl/functions/openssl-pkey-export.xml b/reference/openssl/functions/openssl-pkey-export.xml new file mode 100644 index 000000000..8624a8be5 --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-export.xml @@ -0,0 +1,118 @@ + + + + + openssl_pkey_export + Obtém uma representação exportável de uma chave em uma string + + + + &reftitle.description; + + boolopenssl_pkey_export + #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringkey + stringoutput + #[\SensitiveParameter]stringnullpassphrase&null; + arraynulloptions&null; + + + openssl_pkey_export exporta a chave + key como uma string codificada em PEM e a armazena na + string output (que é passada por referência). + + ¬e.openssl.cnf; + + + + &reftitle.parameters; + + + + key + + + + + + + output + + + + + + + passphrase + + + A chave é opcionalmente protegida por uma senha informada em passphrase. + + + + + options + + + options pode ser usado para fazer ajuste fino do processo + de exportação especificando e/ou substituindo opções para o arquivo de + configuração do openssl. Consulte openssl_csr_new para obter + mais informações sobre options. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + key agora aceita uma instância de OpenSSLAsymmetricKey + ou OpenSSLCertificate; + anteriormente, um &resource; do tipo OpenSSL key ou OpenSSL X.509 + era aceito. + + + + + + + + diff --git a/reference/openssl/functions/openssl-pkey-free.xml b/reference/openssl/functions/openssl-pkey-free.xml new file mode 100644 index 000000000..e91f4ffdd --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-free.xml @@ -0,0 +1,97 @@ + + + + + openssl_pkey_free + Libera uma chave privada + + + + &warn.deprecated.function-8-0-0; + + + + &reftitle.description; + + voidopenssl_pkey_free + OpenSSLAsymmetricKeykey + + ¬e.resource-migration-8.0-dead-function; + + Esta função libera uma chave privada criada por + openssl_pkey_new. + + + + + &reftitle.parameters; + + + + key + + + Recurso que contém a chave. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Esta função agora está descontinuada e não tem mais efeito. + + + + 8.0.0 + + key agora aceita uma instância de OpenSSLAsymmetricKey; + anteriormente, um &resource; do tipo OpenSSL key era aceito. + + + + + + + + diff --git a/reference/openssl/functions/openssl-pkey-get-details.xml b/reference/openssl/functions/openssl-pkey-get-details.xml new file mode 100644 index 000000000..72ddc3524 --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-get-details.xml @@ -0,0 +1,258 @@ + + + + + openssl_pkey_get_details + Retorna um array com os detalhes da chave + + + + &reftitle.description; + + arrayfalseopenssl_pkey_get_details + OpenSSLAsymmetricKeykey + + + Esta função retorna os detalhes da chave (bits, chave, tipo). + + + + + &reftitle.parameters; + + + + key + + + Recurso que contém a chave. + + + + + + + + + &reftitle.returnvalues; + + Retorna um array com os principais detalhes em caso de sucesso ou &false; em caso de falha. + O array retornado tem os índices bits (número de bits), + key (representação em string da chave pública) e + type (tipo da chave que é uma das constantes + OPENSSL_KEYTYPE_RSA, + OPENSSL_KEYTYPE_DSA, + OPENSSL_KEYTYPE_DH, + OPENSSL_KEYTYPE_EC ou -1 que significa desconhecido). + + + Dependendo do tipo de chave utilizado, detalhes adicionais poderão ser retornados. Observe que + alguns elementos podem nem sempre estar disponíveis. + + + + + OPENSSL_KEYTYPE_RSA, uma chave de array adicional chamada "rsa", + contendo os dados da chave, é retornada. + + + + + + Chave + &Description; + + + + + "n" + módulo + + + "e" + expoente público + + + "d" + expoente privado + + + "p" + primo número 1 + + + "q" + primo número 2 + + + "dmp1" + expoente 1, d mod (p-1) + + + "dmq1" + expoente 2, d mod (q-1) + + + "iqmp" + coeficiente, (inverso de q) mod p + + + + + + + + OPENSSL_KEYTYPE_DSA, uma chave de array adicional chamada "dsa", + contendo os dados da chave, é retornada. + + + + + + Chave + &Description; + + + + + "p" + número primo (público) + + + "q" + sub-primo de 160 bits, q | p-1 (público) + + + "g" + gerador de subgrupo (público) + + + "priv_key" + chave privada x + + + "pub_key" + chave pública y = g^x + + + + + + + + OPENSSL_KEYTYPE_DH, uma chave de array adicional chamada "dh", + contendo os dados da chave, é retornada. + + + + + + Chave + &Description; + + + + + "p" + número primo (compartilhado) + + + "g" + gerador de Z_p (compartilhado) + + + "priv_key" + valor DH privado x + + + "pub_key" + valor DH público g^x + + + + + + + + OPENSSL_KEYTYPE_EC, uma chave de array adicional chamada "ec", + contendo os dados da chave, é retornada. + + + + + + Chave + &Description; + + + + + "curve_name" + nome da curva, consulte openssl_get_curve_names + + + "curve_oid" + identificador de objeto ASN1 (OID) para a curva EC. + + + "x" + coordenada x (pública) + + + "y" + coordenada y (pública) + + + "d" + chave privada + + + + + + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + key agora aceita uma instância de OpenSSLAsymmetricKey; + anteriormente, um &resource; do tipo OpenSSL key era aceito. + + + + + + + + diff --git a/reference/openssl/functions/openssl-pkey-get-private.xml b/reference/openssl/functions/openssl-pkey-get-private.xml new file mode 100644 index 000000000..bb64a6888 --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-get-private.xml @@ -0,0 +1,119 @@ + + + + + openssl_pkey_get_private + Obtém uma chave privada + + + + &reftitle.description; + + OpenSSLAsymmetricKeyfalseopenssl_pkey_get_private + #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key + #[\SensitiveParameter]stringnullpassphrase&null; + + + openssl_pkey_get_private analisa a chave privada + private_key e prepara-a para uso por outras funções. + + + + + &reftitle.parameters; + + + + private_key + + + private_key pode ser uma das seguintes opções: + + uma string no formato + file://caminho/para/arquivo.pem. O arquivo precisa + conter uma chave privada ou certificado (pode conter ambos) codificados em PEM. + + + Uma chave privada no formato PEM. + + + + + + passphrase + + + O parâmetro opcional passphrase contém uma senha que precisa ser usada + se a chave especificada for criptografada (protegida por uma senha). + + + + + + + + + &reftitle.returnvalues; + + Retorna uma instância de OpenSSLAsymmetricKey em caso de sucesso ou &false; em caso de erro. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Em caso de sucesso, esta função retorna uma instância OpenSSLAsymmetricKey agora; + anteriormente, retornava um &resource; do tipo OpenSSL key. + + + + 8.0.0 + + private_key agora aceita uma instância de OpenSSLAsymmetricKey + ou OpenSSLCertificate; + anteriormente, um &resource; do tipo OpenSSL key ou OpenSSL X.509 + era aceito. + + + + 8.0.0 + + passphrase agora pode ser nulo. + + + + + + + + diff --git a/reference/openssl/functions/openssl-pkey-get-public.xml b/reference/openssl/functions/openssl-pkey-get-public.xml new file mode 100644 index 000000000..aab1aa191 --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-get-public.xml @@ -0,0 +1,105 @@ + + + + + openssl_pkey_get_public + Extrai a chave pública do certificado e prepara-a para uso + + + + &reftitle.description; + + OpenSSLAsymmetricKeyfalseopenssl_pkey_get_public + OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key + + + openssl_pkey_get_public extrai a chave pública de + public_key e prepara-a para uso por outras + funções. + + + + + &reftitle.parameters; + + + + public_key + + + public_key pode ser uma das seguintes opções: + + uma instância de OpenSSLAsymmetricKey + uma string no formato + file://caminho/para/arquivo.pem. O arquivo precisa + conter uma chave pública ou certificado (pode conter ambos) codificados em PEM. + + + Uma chave pública no formato PEM. + + + + + + + + + + &reftitle.returnvalues; + + Retorna uma instância de OpenSSLAsymmetricKey em caso de sucesso ou &false; em caso de erro. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Em caso de sucesso, esta função retorna uma instância OpenSSLAsymmetricKey agora; + anteriormente, retornava um &resource; do tipo OpenSSL key. + + + + 8.0.0 + + public_key agora aceita uma instância de OpenSSLAsymmetricKey + ou OpenSSLCertificate; + anteriormente, um &resource; do tipo OpenSSL key ou OpenSSL X.509 + era aceito. + + + + + + + + diff --git a/reference/openssl/functions/openssl-pkey-new.xml b/reference/openssl/functions/openssl-pkey-new.xml new file mode 100644 index 000000000..dc4a794e2 --- /dev/null +++ b/reference/openssl/functions/openssl-pkey-new.xml @@ -0,0 +1,153 @@ + + + + + openssl_pkey_new + Gera uma nova chave privada + + + + &reftitle.description; + + OpenSSLAsymmetricKeyfalseopenssl_pkey_new + arraynulloptions&null; + + + openssl_pkey_new gera uma nova chave + privada. + Como obter o componente público da chave é mostrado no exemplo abaixo. + + ¬e.openssl.cnf; + + + + &reftitle.parameters; + + + + options + + + Pode ser feito ajuste fino na geração de chaves (como especificar o número de + bits) usando options. Consulte + openssl_csr_new para obter mais informações sobre + options. + + + + + + + + + &reftitle.returnvalues; + + Retorna uma instância de OpenSSLAsymmetricKey para + a chave privada em caso de sucesso ou &false; em caso de erro. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Em caso de sucesso, esta função retorna uma instância OpenSSLAsymmetricKey agora; + anteriormente, retornava um &resource; do tipo OpenSSL key. + + + + 7.1.0 + + A chave curve_name do parâmetro options foi + adicionada para tornar possível a criação de chaves EC com base nos algoritmos de Curva Elíptica. + + + + + + + + + &reftitle.examples; + + Obtendo a chave pública de uma chave privada + + +]]> + + &example.outputs.similar; + + + + + + + +