aboutsummaryrefslogtreecommitdiff
path: root/doc/html/appdev/refs/api/krb5_read_password.html
diff options
context:
space:
mode:
authorCy Schubert <cy@FreeBSD.org>2025-03-19 22:12:25 +0000
committerCy Schubert <cy@FreeBSD.org>2025-03-19 22:12:25 +0000
commit8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch)
tree9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/appdev/refs/api/krb5_read_password.html
parent1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_read_password.html')
-rw-r--r--doc/html/appdev/refs/api/krb5_read_password.html97
1 files changed, 42 insertions, 55 deletions
diff --git a/doc/html/appdev/refs/api/krb5_read_password.html b/doc/html/appdev/refs/api/krb5_read_password.html
index 3f80a52ead36..0e5d899f6ecb 100644
--- a/doc/html/appdev/refs/api/krb5_read_password.html
+++ b/doc/html/appdev/refs/api/krb5_read_password.html
@@ -1,35 +1,26 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
<title>krb5_read_password - Read a password from keyboard input. &#8212; MIT Kerberos Documentation</title>
- <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '../../../',
- VERSION: '1.21.2',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true,
- SOURCELINK_SUFFIX: '.txt'
- };
- </script>
- <script type="text/javascript" src="../../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../../../_static/agogo.css" />
+ <link rel="stylesheet" type="text/css" href="../../../_static/kerb.css" />
+ <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
+ <script src="../../../_static/jquery.js"></script>
+ <script src="../../../_static/underscore.js"></script>
+ <script src="../../../_static/doctools.js"></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_salttype_to_string - Convert a salt type to a string." href="krb5_salttype_to_string.html" />
<link rel="prev" title="krb5_rd_safe - Process KRB-SAFE message." href="krb5_rd_safe.html" />
- </head>
- <body>
+ </head><body>
<div class="header-wrapper">
<div class="header">
@@ -61,56 +52,51 @@
<div class="bodywrapper">
<div class="body" role="main">
- <div class="section" id="krb5-read-password-read-a-password-from-keyboard-input">
+ <section id="krb5-read-password-read-a-password-from-keyboard-input">
<h1>krb5_read_password - Read a password from keyboard input.<a class="headerlink" href="#krb5-read-password-read-a-password-from-keyboard-input" title="Permalink to this headline">¶</a></h1>
-<dl class="function">
-<dt id="c.krb5_read_password">
-<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <code class="descname">krb5_read_password</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em>&nbsp;context</em>, const char *<em>&nbsp;prompt</em>, const char *<em>&nbsp;prompt2</em>, char *<em>&nbsp;return_pwd</em>, unsigned int *<em>&nbsp;size_return</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_read_password" title="Permalink to this definition">¶</a></dt>
+<dl class="c function">
+<dt class="sig sig-object c" id="c.krb5_read_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_read_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>, <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">prompt</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">prompt2</span></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">return_pwd</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">size_return</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_read_password" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<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>
+<dl class="field-list">
+<dt class="field-odd">param</dt>
+<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p>
<p><strong>[in]</strong> <strong>prompt</strong> - First user prompt when reading password</p>
<p><strong>[in]</strong> <strong>prompt2</strong> - Second user prompt (NULL to prompt only once)</p>
<p><strong>[out]</strong> <strong>return_pwd</strong> - Returned password</p>
-<p class="last"><strong>[inout]</strong> <strong>size_return</strong> - On input, maximum size of password; on output, size of password read</p>
-</td>
-</tr>
-</tbody>
-</table>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first simple">
-<li>0 Success</li>
+<p><strong>[inout]</strong> <strong>size_return</strong> - On input, maximum size of password; on output, size of password read</p>
+</dd>
+</dl>
+<dl class="field-list simple">
+<dt class="field-odd">retval</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p>0 Success</p></li>
</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple">
-<li>Error in reading or verifying the password</li>
-<li>Kerberos error codes</li>
+</dd>
+<dt class="field-even">return</dt>
+<dd class="field-even"><ul class="simple">
+<li><p>Error in reading or verifying the password</p></li>
+<li><p>Kerberos error codes</p></li>
</ul>
-</td>
-</tr>
-</tbody>
-</table>
+</dd>
+</dl>
<p>This function reads a password from keyboard input and stores it in <em>return_pwd</em> . <em>size_return</em> should be set by the caller to the amount of storage space available in <em>return_pwd</em> ; on successful return, it will be set to the length of the password read.</p>
<blockquote>
-<div><em>prompt</em> is printed to the terminal, followed by”:”, and then a password is read from the keyboard.</div></blockquote>
+<div><p><em>prompt</em> is printed to the terminal, followed by”:”, and then a password is read from the keyboard.</p>
+</div></blockquote>
<p>If <em>prompt2</em> is NULL, the password is read only once. Otherwise, <em>prompt2</em> is printed to the terminal and a second password is read. If the two passwords entered are not identical, KRB5_LIBOS_BADPWDMATCH is returned.</p>
<p>Echoing is turned off when the password is read.</p>
-</div>
+</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_read_password - Read a password from keyboard input.</a></li>
@@ -154,6 +140,7 @@
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
+
</div>
<div class="clearer"></div>
</div>
@@ -161,8 +148,8 @@
<div class="footer-wrapper">
<div class="footer" >
- <div class="right" ><i>Release: 1.21.2</i><br />
- &copy; <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT.
+ <div class="right" ><i>Release: 1.21.3</i><br />
+ &copy; <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT.
</div>
<div class="left">
generated by cgit v1.3 (git 2.53.0) at 2026-04-29 14:30:39 +0000