mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
b95d28e6ec
Functions which return false on failure should state that in their signature as well. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351135 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.5 KiB
XML
131 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-csr-get-subject">
|
|
<refnamediv>
|
|
<refname>openssl_csr_get_subject</refname>
|
|
<refpurpose>Returns the subject of a CSR</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>array</type><type>false</type></type><methodname>openssl_csr_get_subject</methodname>
|
|
<methodparam><type>mixed</type><parameter>csr</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>use_shortnames</parameter><initializer>&true;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>openssl_csr_get_subject</function> returns subject
|
|
distinguished name information encoded in the <parameter>csr</parameter>
|
|
including fields commonName (CN), organizationName (O), countryName (C) etc.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&openssl.param.csr;
|
|
<varlistentry>
|
|
<term><parameter>use_shortnames</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>shortnames</parameter> controls how the data is indexed in the
|
|
array - if <parameter>shortnames</parameter> is &true; (the default) then
|
|
fields will be indexed with the short name form, otherwise, the long name
|
|
form will be used - e.g.: CN is the shortname form of commonName.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an associative array with subject description, &return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>openssl_csr_get_subject() example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$subject = array(
|
|
"countryName" => "CA",
|
|
"stateOrProvinceName" => "Alberta",
|
|
"localityName" => "Calgary",
|
|
"organizationName" => "XYZ Widgets Inc",
|
|
"organizationalUnitName" => "PHP Documentation Team",
|
|
"commonName" => "Wez Furlong",
|
|
"emailAddress" => "wez@example.com",
|
|
);
|
|
$private_key = openssl_pkey_new(array(
|
|
"private_key_bits" => 2048,
|
|
"private_key_type" => OPENSSL_KEYTYPE_RSA,
|
|
));
|
|
$configargs = array(
|
|
'digest_alg' => 'sha512WithRSAEncryption'
|
|
);
|
|
$csr = openssl_csr_new($subject, $privkey, $configargs);
|
|
print_r(openssl_csr_get_subject($csr));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[C] => CA
|
|
[ST] => Alberta
|
|
[L] => Calgary
|
|
[O] => XYZ Widgets Inc
|
|
[OU] => PHP Documentation Team
|
|
[CN] => Wez Furlong
|
|
[emailAddress] => wez@example.com
|
|
)
|
|
]]>
|
|
</screen>
|
|
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>openssl_csr_new</function></member>
|
|
<member><function>openssl_csr_get_public_key</function></member>
|
|
<member><function>openssl_x509_parse</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|