aboutsummaryrefslogblamecommitdiff
path: root/doc/html/appdev/refs/macros/KRB5_RESPONDER_QUESTION_OTP.html
blob: 5abc09c97fe75eba4940c3d523ea4626ca207c76 (plain) (tree)
1
2
3
4
5
6
7
8
 


                                                              


                                                                         
                                                                                 


                                                                                  


                                   
                              

                              

                                 





                                                                                  

                                                                    
                                                                             
































                                                                                                                        
                                        




                                                                                                                                                                                          
                                                                                                                                                                   



                                                                                                                                                                             
















                                                                                                                                                                                                                                                                      
                                                         






                                                                                                                                                                                                                                                                  






                                            

                                                                                                                       






















                                                                                                                                       
                                                                                                                                         




































                                                                                                                                                

                                                                                      



















                                                                                                          

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>KRB5_RESPONDER_QUESTION_OTP &#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.1',
        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="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_RESPONDER_QUESTION_PASSWORD" href="KRB5_RESPONDER_QUESTION_PASSWORD.html" />
    <link rel="prev" title="KRB5_RESPONDER_OTP_FORMAT_HEXADECIMAL" href="KRB5_RESPONDER_OTP_FORMAT_HEXADECIMAL.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_RESPONDER_OTP_FORMAT_HEXADECIMAL.html" title="KRB5_RESPONDER_OTP_FORMAT_HEXADECIMAL"
            accesskey="P">previous</a> |
        <a href="KRB5_RESPONDER_QUESTION_PASSWORD.html" title="KRB5_RESPONDER_QUESTION_PASSWORD"
            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_RESPONDER_QUESTION_OTP">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">
            
  <div class="section" id="krb5-responder-question-otp">
<span id="krb5-responder-question-otp-data"></span><h1>KRB5_RESPONDER_QUESTION_OTP<a class="headerlink" href="#krb5-responder-question-otp" title="Permalink to this headline"></a></h1>
<dl class="data">
<dt id="KRB5_RESPONDER_QUESTION_OTP">
<code class="descname">KRB5_RESPONDER_QUESTION_OTP</code><a class="headerlink" href="#KRB5_RESPONDER_QUESTION_OTP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<p>OTP responder question.</p>
<p>The OTP responder question is asked when the KDC indicates that an OTP value is required in order to complete the authentication. The JSON format of the challenge is:</p>
<div class="highlight-c"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s">&quot;service&quot;</span><span class="o">:</span> <span class="o">&lt;</span><span class="n">string</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
  <span class="s">&quot;tokenInfo&quot;</span><span class="o">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s">&quot;flags&quot;</span><span class="o">:</span>     <span class="o">&lt;</span><span class="n">number</span><span class="o">&gt;</span><span class="p">,</span>
      <span class="s">&quot;vendor&quot;</span><span class="o">:</span>    <span class="o">&lt;</span><span class="n">string</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
      <span class="s">&quot;challenge&quot;</span><span class="o">:</span> <span class="o">&lt;</span><span class="n">string</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
      <span class="s">&quot;length&quot;</span><span class="o">:</span>    <span class="o">&lt;</span><span class="n">number</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
      <span class="s">&quot;format&quot;</span><span class="o">:</span>    <span class="o">&lt;</span><span class="n">number</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
      <span class="s">&quot;tokenID&quot;</span><span class="o">:</span>   <span class="o">&lt;</span><span class="n">string</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
      <span class="s">&quot;algID&quot;</span><span class="o">:</span>     <span class="o">&lt;</span><span class="n">string</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
    <span class="p">},</span>
    <span class="p">...</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The answer to the question MUST be JSON formatted:</p>
<div class="highlight-c"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s">&quot;tokeninfo&quot;</span><span class="o">:</span> <span class="o">&lt;</span><span class="n">number</span><span class="o">&gt;</span><span class="p">,</span>
  <span class="s">&quot;value&quot;</span><span class="o">:</span>     <span class="o">&lt;</span><span class="n">string</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
  <span class="s">&quot;pin&quot;</span><span class="o">:</span>       <span class="o">&lt;</span><span class="n">string</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span><span class="o">&gt;</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
<p>For more detail, please see RFC 6560.</p>
<table border="1" class="docutils">
<colgroup>
<col width="61%" />
<col width="39%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">KRB5_RESPONDER_QUESTION_OTP</span></code></td>
<td><code class="docutils literal"><span class="pre">&quot;otp&quot;</span></code></td>
</tr>
</tbody>
</table>
</div>


          </div>
        </div>
      </div>
        </div>
        <div class="sidebar">
    <h2>On this page</h2>
    <ul>
<li><a class="reference internal" href="#">KRB5_RESPONDER_QUESTION_OTP</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"><a class="reference internal" href="../api/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 current"><a class="reference internal" href="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.21.1</i><br />
                &copy; <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT.
            </div>
            <div class="left">
                
        <a href="../../../index.html" title="Full Table of Contents"
            >Contents</a> |
        <a href="KRB5_RESPONDER_OTP_FORMAT_HEXADECIMAL.html" title="KRB5_RESPONDER_OTP_FORMAT_HEXADECIMAL"
            >previous</a> |
        <a href="KRB5_RESPONDER_QUESTION_PASSWORD.html" title="KRB5_RESPONDER_QUESTION_PASSWORD"
            >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_RESPONDER_QUESTION_OTP">feedback</a>
            </div>
        </div>
    </div>

  </body>
</html>