Files
doc-fr/reference/openssl/constants.xml
2024-07-29 21:54:50 +01:00

847 lines
24 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 434366e9284206b3b073a49bddf7c42e85427aa0 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<appendix xml:id="openssl.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<section xml:id="openssl.purpose-check">
<title>Options de validations générales</title>
<variablelist>
<varlistentry xml:id="constant.x509-purpose-ssl-client">
<term>
<constant>X509_PURPOSE_SSL_CLIENT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.x509-purpose-ssl-server">
<term>
<constant>X509_PURPOSE_SSL_SERVER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.x509-purpose-ns-ssl-server">
<term>
<constant>X509_PURPOSE_NS_SSL_SERVER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.x509-purpose-smime-sign">
<term>
<constant>X509_PURPOSE_SMIME_SIGN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.x509-purpose-smime-encrypt">
<term>
<constant>X509_PURPOSE_SMIME_ENCRYPT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.x509-purpose-crl-sign">
<term>
<constant>X509_PURPOSE_CRL_SIGN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.x509-purpose-any">
<term>
<constant>X509_PURPOSE_ANY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openssl.padding">
<title>Options de remplissage (<literal>Padding</literal>) pour le cryptage asymétrique</title>
<variablelist>
<varlistentry xml:id="constant.openssl-pkcs1-padding">
<term>
<constant>OPENSSL_PKCS1_PADDING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-sslv23-padding">
<term>
<constant>OPENSSL_SSLV23_PADDING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-no-padding">
<term>
<constant>OPENSSL_NO_PADDING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-pkcs1-oaep-padding">
<term>
<constant>OPENSSL_PKCS1_OAEP_PADDING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openssl.key-types">
<title>Types de clés</title>
<variablelist>
<varlistentry xml:id="constant.openssl-keytype-rsa">
<term>
<constant>OPENSSL_KEYTYPE_RSA</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-keytype-dsa">
<term>
<constant>OPENSSL_KEYTYPE_DSA</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-keytype-dh">
<term>
<constant>OPENSSL_KEYTYPE_DH</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-keytype-ec">
<term>
<constant>OPENSSL_KEYTYPE_EC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Cette constante n'est disponible que lorsque PHP est compilé avec OpenSSL 0.9.8+.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openssl.pkcs7.flags">
<title>Constantes/options <acronym>PKCS7</acronym></title>
<para>
Les fonctions S/MIME utilisent des options qui sont spécifiées
par un champ de bits. Les valeurs valides sont :
<table>
<title>Constantes <acronym>PKCS7</acronym></title>
<tgroup cols="2">
<thead>
<row>
<entry>Constante</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.pkcs7-text">
<entry>
<constant>PKCS7_TEXT</constant>
(<type>int</type>)
</entry>
<entry>
Ajoute le texte plein en clair dans les en-têtes du message
signé/chiffré. Lors du déchiffrement ou la vérification,
il supprime purement et simplement ces données. Si le
message chiffré ou signé n'est pas du type MIME, une erreur
surviendra.
</entry>
</row>
<row xml:id="constant.pkcs7-binary">
<entry>
<constant>PKCS7_BINARY</constant>
(<type>int</type>)
</entry>
<entry>
Normalement, le message est converti au format canonique
qui utilise effectivement des <literal>CR</literal> et <literal>LF</literal>
comme fin de ligne, comme demandé dans les spécifications de S/MIME.
Lorsque cette option est activée, le message ne sera
pas converti. Cela sert lorsque vous manipulez des données
binaires qui ne sont pas au format MIME.
</entry>
</row>
<row xml:id="constant.pkcs7-nointern">
<entry>
<constant>PKCS7_NOINTERN</constant>
(<type>int</type>)
</entry>
<entry>
Lors de la vérification d'un message, les certificats
(s'il y en a) inclus dans le message sont normalement
utilisés pour rechercher le certificat de signature. Avec
cette option, seul le certificat spécifié par le
paramètre <parameter>untrusted_certificates_filename</parameter> de la fonction
<function>openssl_pkcs7_verify</function> est utilisé.
Les certificats fournis peuvent toujours être utilisés,
avec un niveau de confiance réduit.
</entry>
</row>
<row xml:id="constant.pkcs7-noverify">
<entry>
<constant>PKCS7_NOVERIFY</constant>
(<type>int</type>)
</entry>
<entry>
Ne vérifie pas les certificats des signataires d'un message
signé.
</entry>
</row>
<row xml:id="constant.pkcs7-nochain">
<entry>
<constant>PKCS7_NOCHAIN</constant>
(<type>int</type>)
</entry>
<entry>
N'enchaîne pas les vérifications des signataires de
certificats. C'est-à-dire, n'utilise pas les certificats
contenu dans le message.
</entry>
</row>
<row xml:id="constant.pkcs7-nocerts">
<entry>
<constant>PKCS7_NOCERTS</constant>
(<type>int</type>)
</entry>
<entry>
Lors de la signature d'un message, le certificat du signataire
est normalement inclus. Avec cette option, c'est
désactivé. Cela va réduire la taille du message,
mais le vérificateur devra avoir une copie locale du certificat
du signataire (passée au paramètre
<parameter>untrusted_certificates_filename</parameter>, avec la fonction
<function>openssl_pkcs7_verify</function>).
</entry>
</row>
<row xml:id="constant.pkcs7-noattr">
<entry>
<constant>PKCS7_NOATTR</constant>
(<type>int</type>)
</entry>
<entry>
Normalement, lorsqu'un message est signé, un jeu d'attributs
contenant l'heure de signature et l'algorithme symétrique
supporté, est inclus dans le message. Avec cette option,
il n'est pas inclus.
</entry>
</row>
<row xml:id="constant.pkcs7-detached">
<entry>
<constant>PKCS7_DETACHED</constant>
(<type>int</type>)
</entry>
<entry>
Lors de la signature d'un message, utilise la signature
en texte clair, avec le type MIME <literal>"multipart/signed"</literal>.
C'est la valeur par défaut du paramètre
<parameter>flags</parameter>
pour la fonction <function>openssl_pkcs7_sign</function>.
Si vous annulez cette option, le message sera signé de
manière opaque, ce qui résiste mieux à la traduction
des relais mail (certains anciens serveurs mail corrompent les
messages), mais empêche la lecture par les client emails qui ne
connaissent pas S/MIME.
</entry>
</row>
<row xml:id="constant.pkcs7-nosigs">
<entry>
<constant>PKCS7_NOSIGS</constant>
(<type>int</type>)
</entry>
<entry>
Ne vérifie pas les signatures d'un message
</entry>
</row>
<row xml:id="constant.pkcs7-nooldmimetype">
<entry>
<constant>PKCS7_NOOLDMIMETYPE</constant>
(<type>int</type>)
</entry>
<entry>
Disponible à partir de PHP 8.3.0.
Définit l'en-tête HTTP Content-Type sur <literal>application/pkcs7-mime</literal> au lieu de
<literal>application/x-pkcs7-mime</literal> pour chiffrer un message.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
<section xml:id="openssl.cms.flags">
<title>Drapeaux/Constantes <acronym>CMS</acronym></title>
<para>
Les fonctions CMS utilise des drapeaux qui sont spécifiés utilisant
un masque de bit qui inclus une ou plusieurs des valeurs suivantes :
<table>
<title><acronym>CMS</acronym> CONSTANTS</title>
<tgroup cols="2">
<thead>
<row>
<entry>&Constants;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.openssl-cms-text">
<entry>
<constant>OPENSSL_CMS_TEXT</constant>
(<type>int</type>)
</entry>
<entry>
Ajoute l'en-tête content type <literal>text/plain</literal> au message chiffré/signé.
Lors du déchiffrement/vérification, ces en-têtes sont enlevés de la
sortie, si le message déchiffré ou vérifié n'est pas du type <acronym>MIME</acronym>
<literal>text/plain</literal> alors une erreur surviendra.
</entry>
</row>
<row xml:id="constant.openssl-cms-binary">
<entry>
<constant>OPENSSL_CMS_BINARY</constant>
(<type>int</type>)
</entry>
<entry>
Normalement le message d'entrée est converti en sa forme "canonique"
qui en réalité utilise <literal>CR</literal> et <literal>LF</literal>
comme fin de ligne: tel que requis par la spécification CMS. Quand
cette option est présente, aucune translation n'est effectué. Ceci
est utile lors de la gestion de données binaire qui peuvent ne pas
être en format CMS.
</entry>
</row>
<row xml:id="constant.openssl-cms-nointern">
<entry>
<constant>OPENSSL_CMS_NOINTERN</constant>
(<type>int</type>)
</entry>
<entry>
Lors de la vérification d'un message, les certificats (le cas échéant)
inclus dans le message sont normalement recherchés pour le certificat
de signature. Avec cette option, seuls les certificats spécifiés dans
le paramètre <parameter>untrusted_certificates_filename</parameter>
de <function>openssl_cms_verify</function> sont utilisés.
Les certificats fournis peuvent cependant toujours être utilisés comme
des autorités de certification non fiables.
</entry>
</row>
<row xml:id="constant.openssl-cms-noverify">
<entry>
<constant>OPENSSL_CMS_NOVERIFY</constant>
(<type>int</type>)
</entry>
<entry>
Ne vérifie pas le certificat du signataire d'un message signé.
</entry>
</row>
<row xml:id="constant.openssl-cms-nocerts">
<entry>
<constant>OPENSSL_CMS_NOCERTS</constant>
(<type>int</type>)
</entry>
<entry>
Lors de la signature d'un message le certificat du signataire est
normalement inclus, avec cette option il est exclus. Ceci réduira
la taille du message signé mais le vérificateur doit avoir une copie
du certificat du signataire disponible localement (passé en utilisant
<parameter>untrusted_certificates_filename</parameter> de
<function>openssl_cms_verify</function> par exemple).
</entry>
</row>
<row xml:id="constant.openssl-cms-noattr">
<entry>
<constant>OPENSSL_CMS_NOATTR</constant>
(<type>int</type>)
</entry>
<entry>
Normalement quand un message est signé, un jeu d'attributs sont
inclus qui inclus l'heure de signature et les algorithmes symétriques
supportés. Avec cette options ils ne sont pas inclus.
</entry>
</row>
<row xml:id="constant.openssl-cms-detached">
<entry>
<constant>OPENSSL_CMS_DETACHED</constant>
(<type>int</type>)
</entry>
<entry>
Lors de la signature d'un message, la signature cleartext est utilisé
avec le MIME type <literal>"multipart/signed"</literal>. Ceci est le
comportement par défaut, si vous ne spécifiez aucun
<parameter>flags</parameter> à <function>openssl_cms_sign</function>.
Si vous désactivez cette option, le message sera signé en utilisant
une signature opaque, qui est plus résistante à la translation par
les relais mail mais ne peut pas être lu par les agents mail qui ne
supportent pas S/MIME.
</entry>
</row>
<row xml:id="constant.openssl-cms-nosigs">
<entry>
<constant>OPENSSL_CMS_NOSIGS</constant>
(<type>int</type>)
</entry>
<entry>Ne tente pas de vérifier les signatures d'un message</entry>
</row>
<row xml:id="constant.openssl-cms-oldmimetype">
<entry>
<constant>OPENSSL_CMS_OLDMIMETYPE</constant>
(<type>int</type>)
</entry>
<entry>
Disponible à partir de PHP 8.3.0.
Définit l'en-tête HTTP Content-Type sur <literal>application/x-pkcs7-mime</literal> au lieu de
<literal>application/pkcs7-mime</literal> pour chiffrer un message.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
<section xml:id="openssl.signature-algos">
<title>Algorithme de signature</title>
<variablelist>
<varlistentry xml:id="constant.openssl-algo-dss1">
<term>
<constant>OPENSSL_ALGO_DSS1</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-sha1">
<term>
<constant>OPENSSL_ALGO_SHA1</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Utilisé comme algorithme par défaut pour les fonctions
<function>openssl_sign</function> et
<function>openssl_verify</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-sha224">
<term>
<constant>OPENSSL_ALGO_SHA224</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-sha256">
<term>
<constant>OPENSSL_ALGO_SHA256</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-sha384">
<term>
<constant>OPENSSL_ALGO_SHA384</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-sha512">
<term>
<constant>OPENSSL_ALGO_SHA512</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-rmd160">
<term>
<constant>OPENSSL_ALGO_RMD160</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-md5">
<term>
<constant>OPENSSL_ALGO_MD5</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-md4">
<term>
<constant>OPENSSL_ALGO_MD4</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-algo-md2">
<term>
<constant>OPENSSL_ALGO_MD2</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Cette constante n'est disponible que
lorsque PHP est compilé avec le support MD2. Il est nécessaire de
passer le CFLAG <literal>-DHAVE_OPENSSL_MD2_H</literal> lors de la compilation de PHP
et de passer <literal>enable-md2</literal> lors de la compilation de OpenSSL 1.0.0+.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openssl.ciphers">
<title>Chiffrements</title>
<variablelist>
<varlistentry xml:id="constant.openssl-default-stream-ciphers">
<term>
<constant>OPENSSL_DEFAULT_STREAM_CIPHERS</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
Liste des chiffrements par défaut.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-cipher-rc2-40">
<term>
<constant>OPENSSL_CIPHER_RC2_40</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-cipher-rc2-128">
<term>
<constant>OPENSSL_CIPHER_RC2_128</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-cipher-rc2-64">
<term>
<constant>OPENSSL_CIPHER_RC2_64</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-cipher-des">
<term>
<constant>OPENSSL_CIPHER_DES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-cipher-3des">
<term>
<constant>OPENSSL_CIPHER_3DES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry xml:id="constant.openssl-cipher-aes-128-cbc">
<term>
<constant>OPENSSL_CIPHER_AES_128_CBC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-cipher-aes-192-cbc">
<term>
<constant>OPENSSL_CIPHER_AES_192_CBC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-cipher-aes-256-cbc">
<term>
<constant>OPENSSL_CIPHER_AES_256_CBC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openssl.constversion">
<title>Constantes de version</title>
<variablelist>
<varlistentry xml:id="constant.openssl-version-text">
<term>
<constant>OPENSSL_VERSION_TEXT</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-version-number">
<term>
<constant>OPENSSL_VERSION_NUMBER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openssl.constsni">
<title>Constantes d'identification du nom de serveur</title>
<variablelist>
<varlistentry xml:id="constant.openssl-tlsext-server-name">
<term>
<constant>OPENSSL_TLSEXT_SERVER_NAME</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Si le support SNI est disponible ou non.
</simpara>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>
Cette constante n'est disponible que lorsque PHP est compilé avec
OpenSSL 0.9.8j ou ultérieur
</para>
</note>
</section>
<section xml:id="openssl.constants.other">
<title>Autres constantes</title>
<variablelist>
<varlistentry xml:id="constant.openssl-raw-data">
<term>
<constant>OPENSSL_RAW_DATA</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Si <constant>OPENSSL_RAW_DATA</constant> est définie dans
<function>openssl_encrypt</function> ou <function>openssl_decrypt</function>,
les données retournées sont retournées tel quel.
Quand ceci n'est pas spécifié, les données retournées à l'appeleur sont
encodées en Base64.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-dont-zero-pad-key">
<term>
<constant>OPENSSL_DONT_ZERO_PAD_KEY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Empêche <function>openssl_encrypt</function> de remplir les clés
qui sont plus courtes que la longueur de clé par défaut.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-zero-padding">
<term>
<constant>OPENSSL_ZERO_PADDING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Par défaut, les opérations de cryptage sont complétées en utilisant
des blocs standards et la complétion est vérifiée et supprimée
lors du décryptage. Si la constante <constant>OPENSSL_ZERO_PADDING</constant>
est définie dans le paramètre <parameter>options</parameter> de la fonction
<function>openssl_encrypt</function> ou <function>openssl_decrypt</function>
alors aucune complétion ne sera réalisée, la quantité totale
de données cryptées devra alors être un multiple de la taille du bloc
ou bien une erreur surviendra.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-encoding-smime">
<term>
<constant>OPENSSL_ENCODING_SMIME</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Indique que l'encodage est S/MIME.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-encoding-der">
<term>
<constant>OPENSSL_ENCODING_DER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Indique que l'encodage est DER (Distinguished Encoding Rules).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.openssl-encoding-pem">
<term>
<constant>OPENSSL_ENCODING_PEM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Indique que l'encodage est PEM (Privacy-Enhanced Mail).
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
</appendix>
<!-- 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
-->