openssl-x509-checkpurpose.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: seros Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-x509-checkpurpose">
 <refnamediv>
  <refname>openssl_x509_checkpurpose</refname>
  <refpurpose>Verifica si un certificado se puede usar para un propósito en particular</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>openssl_x509_checkpurpose</methodname>
   <methodparam><type>mixed</type><parameter>x509cert</parameter></methodparam>
   <methodparam><type>int</type><parameter>purpose</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>cainfo</parameter><initializer>array()</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>untrustedfile</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_x509_checkpurpose</function> examina un certificado para
   ver si se puede usar para el propósito <parameter>purpose</parameter> especificado.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>x509cert</parameter></term>
     <listitem>
      <para>
       El certificado examinado.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>purpose</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Propósitos de <function>openssl_x509_checkpurpose</function></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Constante</entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>X509_PURPOSE_SSL_CLIENT</entry>
           <entry>¿El certificado puede ser usado por el lado del cliente de una conexión
           SSL?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SSL_SERVER</entry>
           <entry>¿El certificado puede ser usado por el lado del servidor de una conexión
           SSL?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_NS_SSL_SERVER</entry>
           <entry>¿El certificado puede ser usado por un servidor SSL Netscape?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SMIME_SIGN</entry>
           <entry>¿Se puede usar el certificado para firmar un email S/MIME?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SMIME_ENCRYPT</entry>
           <entry>¿Se puede usar el certificado para encriptar un email S/MIME?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_CRL_SIGN</entry>
           <entry>¿Se puede usar el certificado para firmar una Lista de Revocación de Certificado
           (CRL en inglés)?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_ANY</entry>
           <entry>¿Se puede usar el certificado para Cualquier/Todos los propósitos?</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
       Estas opciones no son campos de bits - ¡sólo se puede especificar una!
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cainfo</parameter></term>
     <listitem>
      <para>
       <parameter>cainfo</parameter> debería ser una matriz de archivos/directorios de una AC
       de confianza, como está descrito en <link linkend="openssl.cert.verification">Verificación de
       Certificados</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>untrustedfile</parameter></term>
     <listitem>
      <para>
       Si se especifica debería ser el nombre de un archivo PEM codificado que contiene
       los certificados que se pueden usar para ayudar a verificar el certificado, aunque
       no se pone confianza en los certificados que vienen de ese archivo.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve &true; si el certificado se puede usar para el propósito previsto,
   &false; si no se puede, o -1 si se produjo un error.
  </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
-->