betz            Thu Jun 16 14:31:04 2005 EDT

  Added files:                 
    /phpdoc/en/reference/kadm5/functions        kadm5-chpass-principal.xml 
                                                kadm5-create-principal.xml 
                                                kadm5-delete-principal.xml 
                                                kadm5-destroy.xml 
                                                kadm5-flush.xml 
                                                kadm5-get-policies.xml 
                                                kadm5-get-principals.xml 
                                                kadm5-get-principal.xml 
                                                kadm5-init-with-password.xml 
                                                kadm5-modify-principal.xml 
  Log:
  move kadm5 docs form peardoc
  
http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-chpass-principal.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5-chpass-principal">
 <refnamediv>
  <refname>kadm5_chpass_principal</refname>
  <refpurpose>Changes the principal's password.</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>kadm5_chpass_principal</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
   
<methodparam><type>string</type><parameter>principal</parameter></methodparam>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_chpass_principal</function> sets the new password
   <parameter>password</parameter> for the <parameter>principal</parameter>.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Example of changing principal's password</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

kadm5_chpass_principal($handle, "[EMAIL PROTECTED]", "newpassword");

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-create-principal.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5-create-principal">
 <refnamediv>
  <refname>kadm5_create_principal</refname>
  <refpurpose>Creates a kerberos principal with the given 
parameters.</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>kadm5_create_principal</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
   
<methodparam><type>string</type><parameter>principal</parameter></methodparam>
   <methodparam 
choice="opt"><type>string</type><parameter>password</parameter></methodparam>
   <methodparam 
choice="opt"><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_create_principal</function> creates a
   <parameter>principal</parameter> with the given
   <parameter>password</parameter>. If <parameter>password</parameter>
   is omitted or is &null;, a random key will be generated.
  </para>
  <para>
   It is possible to specify several optional parameters within the
   array <parameter>options</parameter>. Allowed are the following options:
   KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES,
   KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY,
   KADM5_MAX_RLIFE.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Example of principal's creation</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

$attributes = KRB5_KDB_REQUIRES_PRE_AUTH | KRB5_KDB_DISALLOW_PROXIABLE;
$options = array(KADM5_PRINC_EXPIRE_TIME => 0,
                 KADM5_POLICY => "default",
                 KADM5_ATTRIBUTES => $attributes);

kadm5_create_principal($handle, "[EMAIL PROTECTED]", "password", $options);

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-delete-principal.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5-delete-principal">
 <refnamediv>
  <refname>kadm5_delete_principal</refname>
  <refpurpose>Deletes a kerberos principal.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>kadm5_delete_principal</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
   
<methodparam><type>string</type><parameter>principal</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_delete_principal</function> remove the
   <parameter>principal</parameter> from the Kerberos database.
  </para>
 </refsect1>
  
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>kadm5_delete_principal</function>example</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

kadm5_delete_principal($handle, "[EMAIL PROTECTED]");

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-destroy.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5-destroy">
 <refnamediv>
  <refname>kadm5_destroy</refname>
  <refpurpose>Closes the connection to the admin server and releases all 
related resources.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>kadm5_destroy</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-flush.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-flush.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-flush.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5-flush">
 <refnamediv>
  <refname>kadm5_flush</refname>
  <refpurpose>Flush all changes to the Kerberos database, leaving the connection
        to the Kerberos admin server open.</refpurpose>
   </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>kadm5_flush</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-get-policies.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="pecl.kadm5.kadm5-get-policies">
 <refnamediv>
  <refname>kadm5_get_policies</refname>
  <refpurpose>Gets all policies from the Kerberos database.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>kadm5_get_policies</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_get_policies</function> returns an array containing the
   policies's names.
  </para>
 </refsect1>
  
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns array of policies on success, or &false; on failure.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>kadm5_get_policies</function>example</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

print "<h1>get_policies</h1>\n";
$policies = kadm5_get_policies($handle);
for ($i=0; $i < count($policies); $i++)
    print "$policies[$i]<br />\n";

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-get-principals.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5.kadm5-get-principals">
 <refnamediv>
  <refname>kadm5_get_principals</refname>
  <refpurpose>Gets all principals from the Kerberos database.</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>kadm5_get_principals</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_get_principals</function>returns an array containing the
   principals's names.
  </para>
 </refsect1>
  
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns array of principals on success, or &false; on failure.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>kadm5_get_principals</function>example</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

print "<h1>get_principals</h1>\n";
$principals = kadm5_get_principals($handle);
for ($i=0; $i < count($principals); $i++)
    print "$principals[$i]<br />\n";

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-get-principal.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5-get-principal">
 <refnamediv>
  <refname>kadm5_get_principal</refname>
  <refpurpose>Gets the principal's entries from the Kerberos 
database.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>kadm5_get_principal</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
   
<methodparam><type>string</type><parameter>principal</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_get_principal</function> returns an associative array
   containing the following keys: KADM5_PRINCIPAL, KADM5_PRINC_EXPIRE_TIME,
   KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_MOD_NAME,
   KADM5_MOD_TIME, KADM5_KVNO, KADM5_POLICY, KADM5_MAX_RLIFE,
   KADM5_LAST_SUCCESS, KADM5_LAST_FAILED, KADM5_FAIL_AUTH_COUNT.
  </para>
 </refsect1>
  
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns array of options on success, or &false; on failure.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>kadm5_get_principal</function>example</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

print "<h1>get_principal [EMAIL PROTECTED]</h1>\n";

$options = kadm5_get_principal($handle, "[EMAIL PROTECTED]" );

$keys = array_keys($options);
for ($i=0; $i < count($keys); $i++) {
    $value = $options[$keys[$i]];
    print "$keys[$i]: $value<br>\n";
}

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-init-with-password.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
<refentry id="function.kadm5-init-with-password">
 <refnamediv>
  <refname>kadm5_init_with_password</refname>
  <refpurpose>Opens a conncetion to the KADM5 library and initializes any
   neccessary state information.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>kadm5_init_with_password</methodname>
   
<methodparam><type>string</type><parameter>admin_server</parameter></methodparam>
   <methodparam><type>string</type><parameter>realm</parameter></methodparam>
   
<methodparam><type>string</type><parameter>principal</parameter></methodparam>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_init_with_password</function> opens a connection with the
   KADM5 library using the <parameter>principal</parameter> and the given
   <parameter>password</parameter> to obtain initial credentials from the
   <parameter>admin_server</parameter>. The parameter
   <parameter>realm</parameter> defines the authentication domain for the
   connection.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>        
   Returns a KADM5 handle on success, or &false; on failure.
  </para>
 </refsect1>
     
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>KADM5 initialization example</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

$attributes = KRB5_KDB_REQUIRES_PRE_AUTH | KRB5_KDB_DISALLOW_PROXIABLE;
$options = array(KADM5_PRINC_EXPIRE_TIME => 0,
                 KADM5_POLICY => "default",
                 KADM5_ATTRIBUTES => $attributes);

kadm5_create_principal($handle, "[EMAIL PROTECTED]", "password", $options);

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Connection should be closed after use with
    <function>kadm5_destroy</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>kadm5_destroy</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:"../../../../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
-->


http://cvs.php.net/co.php/phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml?r=1.1&p=1
Index: phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml
+++ phpdoc/en/reference/kadm5/functions/kadm5-modify-principal.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/kadm5.xml, last change in rev 1.3 -->
  <refentry id="function.kadm5-modify-principal">
   <refnamediv>
    <refname>kadm5_modify_principal</refname>
    <refpurpose>Modifies a kerberos principal with the given 
parameters.</refpurpose>
   </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>kadm5_modify_principal</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
   
<methodparam><type>string</type><parameter>principal</parameter></methodparam>
   <methodparam 
choice="opt"><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>kadm5_create_principal</function>
   modifies a <parameter>principal</parameter> according to the given
   <parameter>options</parameter>. Allowed are the following options:
   KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES,
   KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY,
   KADM5_MAX_RLIFE, KADM5_FAIL_AUTH_COUNT.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>xample of modifying principal</title>
    <programlisting role="php">
<![CDATA[
<?php

$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", 
"password");

$attributes = KRB5_KDB_REQUIRES_PRE_AUTH;
$options = array(KADM5_PRINC_EXPIRE_TIME => 3451234,
                 KADM5_POLICY => "gonicus",
                 KADM5_ATTRIBUTES => $attributes);

kadm5_modify_principal($handle, "[EMAIL PROTECTED]", "password", $options);

kadm5_destroy($handle);
?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->

Reply via email to