doc/html/appdev/refs/api/krb5_set_password.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>krb5_set_password - Set a password for a principal using specified credentials. &mdash; MIT Kerberos Documentation</title>
  10
  11     <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  13     <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
  14
  15     <script type="text/javascript">
  16       var DOCUMENTATION_OPTIONS = {
  17         URL_ROOT:    '../../../',
  18         VERSION:     '1.15.1',
  19         COLLAPSE_INDEX: false,
  20         FILE_SUFFIX: '.html',
  21         HAS_SOURCE:  true
  22       };
  23     </script>
  24     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  25     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  26     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  27     <link rel="author" title="About these documents" href="../../../about.html" />
  28     <link rel="copyright" title="Copyright" href="../../../copyright.html" />
  29     <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" />
  30     <link rel="up" title="krb5 API" href="index.html" />
  31     <link rel="next" title="krb5_set_password_using_ccache - Set a password for a principal using cached credentials." href="krb5_set_password_using_ccache.html" />
  32     <link rel="prev" title="krb5_set_default_realm - Override the default realm for the specified context." href="krb5_set_default_realm.html" />
  33   </head>
  34   <body>
  35     <div class="header-wrapper">
  36         <div class="header">
  37
  38
  39             <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
  40
  41             <div class="rel">
  42
  43         <a href="../../../index.html" title="Full Table of Contents"
  44             accesskey="C">Contents</a> |
  45         <a href="krb5_set_default_realm.html" title="krb5_set_default_realm - Override the default realm for the specified context."
  46             accesskey="P">previous</a> |
  47         <a href="krb5_set_password_using_ccache.html" title="krb5_set_password_using_ccache - Set a password for a principal using cached credentials."
  48             accesskey="N">next</a> |
  49         <a href="../../../genindex.html" title="General Index"
  50             accesskey="I">index</a> |
  51         <a href="../../../search.html" title="Enter search criteria"
  52             accesskey="S">Search</a> |
  53     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_set_password -  Set a password for a principal using specified credentials.">feedback</a>
  54             </div>
  55         </div>
  56     </div>
  57
  58     <div class="content-wrapper">
  59       <div class="content">
  60         <div class="document">
  61
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <div class="section" id="krb5-set-password-set-a-password-for-a-principal-using-specified-credentials">
  67 <h1>krb5_set_password -  Set a password for a principal using specified credentials.<a class="headerlink" href="#krb5-set-password-set-a-password-for-a-principal-using-specified-credentials" title="Permalink to this headline">¶</a></h1>
  68 <dl class="function">
  69 <dt id="c.krb5_set_password">
  70 <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <tt class="descname">krb5_set_password</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em>&nbsp;context</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em>&nbsp;creds</em>, const char *<em>&nbsp;newpw</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em>&nbsp;change_password_for</em>, int *<em>&nbsp;result_code</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em>&nbsp;result_code_string</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em>&nbsp;result_string</em><big>)</big><a class="headerlink" href="#c.krb5_set_password" title="Permalink to this definition">¶</a></dt>
  71 <dd></dd></dl>
  72
  73 <table class="docutils field-list" frame="void" rules="none">
  74 <col class="field-name" />
  75 <col class="field-body" />
  76 <tbody valign="top">
  77 <tr class="field-odd field"><th class="field-name">param:</th><td class="field-body"><p class="first"><strong>[in]</strong> <strong>context</strong> - Library context</p>
  78 <p><strong>[in]</strong> <strong>creds</strong> - Credentials for kadmin/changepw service</p>
  79 <p><strong>[in]</strong> <strong>newpw</strong> - New password</p>
  80 <p><strong>[in]</strong> <strong>change_password_for</strong> - Change the password for this principal</p>
  81 <p><strong>[out]</strong> <strong>result_code</strong> - Numeric error code from server</p>
  82 <p><strong>[out]</strong> <strong>result_code_string</strong> - String equivalent to <em>result_code</em></p>
  83 <p class="last"><strong>[out]</strong> <strong>result_string</strong> - Data returned from the remote system</p>
  84 </td>
  85 </tr>
  86 </tbody>
  87 </table>
  88 <table class="docutils field-list" frame="void" rules="none">
  89 <col class="field-name" />
  90 <col class="field-body" />
  91 <tbody valign="top">
  92 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first simple">
  93 <li>0   Success and result_code is set to KRB5_KPASSWD_SUCCESS .</li>
  94 </ul>
  95 </td>
  96 </tr>
  97 <tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple">
  98 <li>Kerberos error codes.</li>
  99 </ul>
 100 </td>
 101 </tr>
 102 </tbody>
 103 </table>
 104 <p>This function uses the credentials <em>creds</em> to set the password <em>newpw</em> for the principal <em>change_password_for</em> . It implements the set password operation of RFC 3244, for interoperability with Microsoft Windows implementations.</p>
 105 <p>The error code and strings are returned in <em>result_code</em> , <em>result_code_string</em> and <em>result_string</em> .</p>
 106 <div class="admonition note">
 107 <p class="first admonition-title">Note</p>
 108 <p class="last">If <em>change_password_for</em> is NULL, the change is performed on the current principal. If <em>change_password_for</em> is non-null, the change is performed on the principal name passed in <em>change_password_for</em> .</p>
 109 </div>
 110 </div>
 111
 112
 113           </div>
 114         </div>
 115       </div>
 116         </div>
 117         <div class="sidebar">
 118     <h2>On this page</h2>
 119     <ul>
 120 <li><a class="reference internal" href="#">krb5_set_password -  Set a password for a principal using specified credentials.</a></li>
 121 </ul>
 122
 123     <br/>
 124     <h2>Table of contents</h2>
 125     <ul class="current">
 126 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 127 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 128 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 129 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 133 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 134 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 135 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 136 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 137 </ul>
 138 </li>
 139 </ul>
 140 </li>
 141 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 142 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 143 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 144 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 145 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 146 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 147 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 148 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 149 </ul>
 150
 151     <br/>
 152     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 153     <h4>Search</h4>
 154     <form class="search" action="../../../search.html" method="get">
 155       <input type="text" name="q" size="18" />
 156       <input type="submit" value="Go" />
 157       <input type="hidden" name="check_keywords" value="yes" />
 158       <input type="hidden" name="area" value="default" />
 159     </form>
 160         </div>
 161         <div class="clearer"></div>
 162       </div>
 163     </div>
 164
 165     <div class="footer-wrapper">
 166         <div class="footer" >
 167             <div class="right" ><i>Release: 1.15.1</i><br />
 168                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
 169             </div>
 170             <div class="left">
 171
 172         <a href="../../../index.html" title="Full Table of Contents"
 173             >Contents</a> |
 174         <a href="krb5_set_default_realm.html" title="krb5_set_default_realm - Override the default realm for the specified context."
 175             >previous</a> |
 176         <a href="krb5_set_password_using_ccache.html" title="krb5_set_password_using_ccache - Set a password for a principal using cached credentials."
 177             >next</a> |
 178         <a href="../../../genindex.html" title="General Index"
 179             >index</a> |
 180         <a href="../../../search.html" title="Enter search criteria"
 181             >Search</a> |
 182     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_set_password -  Set a password for a principal using specified credentials.">feedback</a>
 183             </div>
 184         </div>
 185     </div>
 186
 187   </body>
 188 </html>