File: krb5_get_init_creds_password.html

package info (click to toggle)
krb5 1.22.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 52,648 kB
  • sloc: ansic: 293,109; python: 10,357; cpp: 9,477; makefile: 7,035; sh: 6,189; perl: 1,650; asm: 1,212; yacc: 933; javascript: 789; awk: 344; csh: 147; xml: 135; lisp: 104
file content (177 lines) | stat: -rw-r--r-- 12,695 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<!DOCTYPE html>

<html lang="en" data-content_root="../../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>krb5_get_init_creds_password - Get initial credentials using a password. &#8212; MIT Kerberos Documentation</title>
    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../../_static/agogo.css?v=879f3c71" />
    <link rel="stylesheet" type="text/css" href="../../../_static/kerb.css?v=6a0b3979" />
    <script src="../../../_static/documentation_options.js?v=6dbce55c"></script>
    <script src="../../../_static/doctools.js?v=888ff710"></script>
    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="author" title="About these documents" href="../../../about.html" />
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" />
    <link rel="copyright" title="Copyright" href="../../../copyright.html" />
    <link rel="next" title="krb5_get_profile - Retrieve configuration profile from the context." href="krb5_get_profile.html" />
    <link rel="prev" title="krb5_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options." href="krb5_get_init_creds_opt_set_tkt_life.html" /> 
  </head><body>
    <div class="header-wrapper">
        <div class="header">
            
            
            <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
            
            <div class="rel">
                
        <a href="../../../index.html" title="Full Table of Contents"
            accesskey="C">Contents</a> |
        <a href="krb5_get_init_creds_opt_set_tkt_life.html" title="krb5_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options."
            accesskey="P">previous</a> |
        <a href="krb5_get_profile.html" title="krb5_get_profile - Retrieve configuration profile from the context."
            accesskey="N">next</a> |
        <a href="../../../genindex.html" title="General Index"
            accesskey="I">index</a> |
        <a href="../../../search.html" title="Enter search criteria"
            accesskey="S">Search</a> |
    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_get_init_creds_password -  Get initial credentials using a password.">feedback</a>
            </div>
        </div>
    </div>

    <div class="content-wrapper">
      <div class="content">
        <div class="document">
            
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="krb5-get-init-creds-password-get-initial-credentials-using-a-password">
<h1>krb5_get_init_creds_password -  Get initial credentials using a password.<a class="headerlink" href="#krb5-get-init-creds-password-get-initial-credentials-using-a-password" title="Link to this heading">¶</a></h1>
<dl class="c function">
<dt class="sig sig-object c" id="c.krb5_get_init_creds_password">
<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code"><span class="n"><span class="pre">krb5_error_code</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_password</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context"><span class="n"><span class="pre">krb5_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">context</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">password</span></span>, <a class="reference internal" href="../types/krb5_prompter_fct.html#c.krb5_prompter_fct" title="krb5_prompter_fct"><span class="n"><span class="pre">krb5_prompter_fct</span></span></a><span class="w"> </span><span class="n"><span class="pre">prompter</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="n"><span class="pre">start_time</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_tkt_service</span></span>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">k5_gic_options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_password" title="Link to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="field-list">
<dt class="field-odd">param<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p>
<p><strong>[out]</strong> <strong>creds</strong> - New credentials</p>
<p><strong>[in]</strong> <strong>client</strong> - Client principal</p>
<p><strong>[in]</strong> <strong>password</strong> - Password (or NULL)</p>
<p><strong>[in]</strong> <strong>prompter</strong> - Prompter function</p>
<p><strong>[in]</strong> <strong>data</strong> - Prompter callback data</p>
<p><strong>[in]</strong> <strong>start_time</strong> - Time when ticket becomes valid (0 for now)</p>
<p><strong>[in]</strong> <strong>in_tkt_service</strong> - Service name of initial credentials (or NULL)</p>
<p><strong>[in]</strong> <strong>k5_gic_options</strong> - Initial credential options</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">retval<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p>0   Success</p></li>
<li><p>EINVAL   Invalid argument</p></li>
<li><p>KRB5_KDC_UNREACH   Cannot contact any KDC for requested realm</p></li>
<li><p>KRB5_PREAUTH_FAILED   Generic Pre-athentication failure</p></li>
<li><p>KRB5_LIBOS_PWDINTR   Password read interrupted</p></li>
<li><p>KRB5_REALM_CANT_RESOLVE   Cannot resolve network address for KDC in requested realm</p></li>
<li><p>KRB5KDC_ERR_KEY_EXP   Password has expired</p></li>
<li><p>KRB5_LIBOS_BADPWDMATCH   Password mismatch</p></li>
<li><p>KRB5_CHPW_PWDNULL   New password cannot be zero length</p></li>
<li><p>KRB5_CHPW_FAIL   Password change failed</p></li>
</ul>
</dd>
<dt class="field-even">return<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p>Kerberos error codes</p></li>
</ul>
</dd>
</dl>
<p>This function requests KDC for an initial credentials for <em>client</em> using <em>password</em> . If <em>password</em> is NULL, a password will be prompted for using <em>prompter</em> if necessary. If <em>in_tkt_service</em> is specified, it is parsed as a principal name (with the realm ignored) and used as the service principal for the request; otherwise the ticket-granting service is used.</p>
</section>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
        </div>
        <div class="sidebar">
          
    <h2>On this page</h2>
    <ul>
<li><a class="reference internal" href="#">krb5_get_init_creds_password -  Get initial credentials using a password.</a></li>
</ul>

    <br/>
    <h2>Table of contents</h2>
    <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
<li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
<li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
</ul>

    <br/>
    <h4><a href="../../../index.html">Full Table of Contents</a></h4>
    <h4>Search</h4>
    <form class="search" action="../../../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>

        </div>
        <div class="clearer"></div>
      </div>
    </div>

    <div class="footer-wrapper">
        <div class="footer" >
            <div class="right" ><i>Release: 1.22.1</i><br />
                &copy; <a href="../../../copyright.html">Copyright</a> 1985-2025, MIT.
            </div>
            <div class="left">
                
        <a href="../../../index.html" title="Full Table of Contents"
            >Contents</a> |
        <a href="krb5_get_init_creds_opt_set_tkt_life.html" title="krb5_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options."
            >previous</a> |
        <a href="krb5_get_profile.html" title="krb5_get_profile - Retrieve configuration profile from the context."
            >next</a> |
        <a href="../../../genindex.html" title="General Index"
            >index</a> |
        <a href="../../../search.html" title="Enter search criteria"
            >Search</a> |
    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_get_init_creds_password -  Get initial credentials using a password.">feedback</a>
            </div>
        </div>
    </div>

  </body>
</html>