Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 13eec89779171a321fe518ddb0e0fec6 > files > 222

freetds-doc-0.91-8.mga5.x86_64.rpm

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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/xhtml;charset=UTF-8"/>
<title>FreeTDS API: Authentication</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Authentication<br/>
<small>
[<a class="el" href="a00305.html">LibTDS API</a>]</small>
</h1>
<p>Functions for handling authentication.  
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html">names_blob_prefix_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html">tds_answer</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00111.html">tds_ntlm_auth</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga19a04836d558f3c018b597e8dea1e0e0"></a><!-- doxytag: member="auth::offsetof" ref="ga19a04836d558f3c018b597e8dea1e0e0" args="(st, m)" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>offsetof</b>(st, m)&nbsp;&nbsp;&nbsp;((size_t) ( (char *)&amp;((st *)(0))-&gt;m - (char *)0 ))</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf86575aec89b156f7940308c20ff9734"></a><!-- doxytag: member="auth::TDSANSWER" ref="gaf86575aec89b156f7940308c20ff9734" args="" -->
typedef struct <a class="el" href="a00087.html">tds_answer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>TDSANSWER</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad6590918d36557b1e3967172bfabf6d5"></a><!-- doxytag: member="auth::TDSNTLMAUTH" ref="gad6590918d36557b1e3967172bfabf6d5" args="" -->
typedef struct <a class="el" href="a00111.html">tds_ntlm_auth</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>TDSNTLMAUTH</b></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga64f8b5dbeb79dfc60b821d3f4c5318e5"></a><!-- doxytag: member="auth::convert_to_upper" ref="ga64f8b5dbeb79dfc60b821d3f4c5318e5" args="(char *buf, size_t len)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>convert_to_upper</b> (char *buf, size_t len)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacd7007b809d8829d0e41cbb4c25057e9"></a><!-- doxytag: member="auth::convert_to_usc2le_string" ref="gacd7007b809d8829d0e41cbb4c25057e9" args="(TDSSOCKET *tds, const char *s, size_t len, char *out)" -->
static size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>convert_to_usc2le_string</b> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, const char *s, size_t len, char *out)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga67f0778fbd903f151a3aa29a4a857e29"></a><!-- doxytag: member="auth::fill_names_blob_prefix" ref="ga67f0778fbd903f151a3aa29a4a857e29" args="(names_blob_prefix_t *prefix)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>fill_names_blob_prefix</b> (<a class="el" href="a00075.html">names_blob_prefix_t</a> *prefix)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga532e85c995a56e3d19cd07135ca13c55"></a><!-- doxytag: member="auth::generate_random_buffer" ref="ga532e85c995a56e3d19cd07135ca13c55" args="(unsigned char *out, int len)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>generate_random_buffer</b> (unsigned char *out, int len)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1ad01bd73e545ff80aa2fb6db6e110ee"></a><!-- doxytag: member="auth::make_lm_v2_response" ref="ga1ad01bd73e545ff80aa2fb6db6e110ee" args="(const unsigned char ntlm_v2_hash[16], const unsigned char *client_data, TDS_INT client_data_len, const unsigned char challenge[8])" -->
static unsigned char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>make_lm_v2_response</b> (const unsigned char ntlm_v2_hash[16], const unsigned char *client_data, TDS_INT client_data_len, const unsigned char challenge[8])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4b07b0291e63773ed0c85d5d1d27db5b"></a><!-- doxytag: member="auth::make_ntlm_hash" ref="ga4b07b0291e63773ed0c85d5d1d27db5b" args="(TDSSOCKET *tds, const char *passwd, unsigned char ntlm_hash[16])" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><b>make_ntlm_hash</b> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, const char *passwd, unsigned char ntlm_hash[16])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga40cbb3248826698259bde47be5436ac7"></a><!-- doxytag: member="auth::make_ntlm_v2_hash" ref="ga40cbb3248826698259bde47be5436ac7" args="(TDSSOCKET *tds, const char *passwd, unsigned char ntlm_v2_hash[16])" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><b>make_ntlm_v2_hash</b> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, const char *passwd, unsigned char ntlm_v2_hash[16])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga69c6767f90dbf3179cc4400bf72b0a4c"></a><!-- doxytag: member="auth::tds7_send_auth" ref="ga69c6767f90dbf3179cc4400bf72b0a4c" args="(TDSSOCKET *tds, const unsigned char *challenge, TDS_UINT flags, const unsigned char *names_blob, TDS_INT names_blob_len)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><b>tds7_send_auth</b> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, const unsigned char *challenge, TDS_UINT flags, const unsigned char *names_blob, TDS_INT names_blob_len)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00296.html#ga28e0d7563f4ec6149532762696a3ceb3">tds_answer_challenge</a> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, <a class="el" href="a00094.html">TDSCONNECTION</a> *connection, const unsigned char *challenge, TDS_UINT *flags, const unsigned char *names_blob, TDS_INT names_blob_len, <a class="el" href="a00087.html">TDSANSWER</a> *answer, unsigned char **ntlm_v2_response)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Crypt a given password using schema required for NTLMv1 or NTLM2 authentication.  <a href="#ga28e0d7563f4ec6149532762696a3ceb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac9b2821a71b5280036ea48c41e46c8cc"></a><!-- doxytag: member="auth::tds_answer_challenge_ntlmv2" ref="gac9b2821a71b5280036ea48c41e46c8cc" args="(TDSSOCKET *tds, TDSCONNECTION *connection, const unsigned char *challenge, TDS_UINT *flags, const unsigned char *names_blob, TDS_INT names_blob_len, TDSANSWER *answer, unsigned char **ntlm_v2_response)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><b>tds_answer_challenge_ntlmv2</b> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, <a class="el" href="a00094.html">TDSCONNECTION</a> *connection, const unsigned char *challenge, TDS_UINT *flags, const unsigned char *names_blob, TDS_INT names_blob_len, <a class="el" href="a00087.html">TDSANSWER</a> *answer, unsigned char **ntlm_v2_response)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadb736d7be0af6895c9dd9c0c138231a5"></a><!-- doxytag: member="auth::tds_convert_key" ref="gadb736d7be0af6895c9dd9c0c138231a5" args="(const unsigned char *key_56, DES_KEY *ks)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>tds_convert_key</b> (const unsigned char *key_56, <a class="el" href="a00067.html">DES_KEY</a> *ks)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5a4e10e21b514a7d91fd7baff8d90b06"></a><!-- doxytag: member="auth::tds_encrypt_answer" ref="ga5a4e10e21b514a7d91fd7baff8d90b06" args="(const unsigned char *hash, const unsigned char *challenge, unsigned char *answer)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>tds_encrypt_answer</b> (const unsigned char *hash, const unsigned char *challenge, unsigned char *answer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga553101b21b311f0b1eacdb9033b5360f"></a><!-- doxytag: member="auth::tds_ntlm_free" ref="ga553101b21b311f0b1eacdb9033b5360f" args="(TDSSOCKET *tds, TDSAUTHENTICATION *tds_auth)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><b>tds_ntlm_free</b> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, <a class="el" href="a00088.html">TDSAUTHENTICATION</a> *tds_auth)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00088.html">TDSAUTHENTICATION</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00296.html#ga679f2d22b4a4bdefe0fa475d63503778">tds_ntlm_get_auth</a> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build a NTLMSPP packet to send to server.  <a href="#ga679f2d22b4a4bdefe0fa475d63503778"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa3db31c67f47e37df817fdef6dfeb3b4"></a><!-- doxytag: member="auth::tds_ntlm_handle_next" ref="gaa3db31c67f47e37df817fdef6dfeb3b4" args="(TDSSOCKET *tds, struct tds_authentication *auth, size_t len)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><b>tds_ntlm_handle_next</b> (<a class="el" href="a00122.html">TDSSOCKET</a> *tds, struct <a class="el" href="a00088.html">tds_authentication</a> *auth, size_t len)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0ebff3de68aa881c6ebd875b8964b923"></a><!-- doxytag: member="auth::unix_to_nt_time" ref="ga0ebff3de68aa881c6ebd875b8964b923" args="(TDS_UINT8 *nt, time_t t)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00296.html#ga0ebff3de68aa881c6ebd875b8964b923">unix_to_nt_time</a> (TDS_UINT8 *nt, time_t t)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">put a 8 byte filetime from a time_t This takes GMT as input <br/></td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1dd4c7c104596b477eec26e028a1eadb"></a><!-- doxytag: member="auth::ntlm_id" ref="ga1dd4c7c104596b477eec26e028a1eadb" args="[]" -->
static const unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>ntlm_id</b> [] = &quot;NTLMSSP&quot;</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions for handling authentication. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga28e0d7563f4ec6149532762696a3ceb3"></a><!-- doxytag: member="challenge.c::tds_answer_challenge" ref="ga28e0d7563f4ec6149532762696a3ceb3" args="(TDSSOCKET *tds, TDSCONNECTION *connection, const unsigned char *challenge, TDS_UINT *flags, const unsigned char *names_blob, TDS_INT names_blob_len, TDSANSWER *answer, unsigned char **ntlm_v2_response)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int tds_answer_challenge </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00122.html">TDSSOCKET</a> *&nbsp;</td>
          <td class="paramname"> <em>tds</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00094.html">TDSCONNECTION</a> *&nbsp;</td>
          <td class="paramname"> <em>connection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&nbsp;</td>
          <td class="paramname"> <em>challenge</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TDS_UINT *&nbsp;</td>
          <td class="paramname"> <em>flags</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&nbsp;</td>
          <td class="paramname"> <em>names_blob</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TDS_INT&nbsp;</td>
          <td class="paramname"> <em>names_blob_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00087.html">TDSANSWER</a> *&nbsp;</td>
          <td class="paramname"> <em>answer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char **&nbsp;</td>
          <td class="paramname"> <em>ntlm_v2_response</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Crypt a given password using schema required for NTLMv1 or NTLM2 authentication. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>passwd</em>&nbsp;</td><td>clear text domain password </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>challenge</em>&nbsp;</td><td>challenge data given by server </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>NTLM flags from server side </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>answer</em>&nbsp;</td><td>buffer where to store crypted password </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga679f2d22b4a4bdefe0fa475d63503778"></a><!-- doxytag: member="challenge.c::tds_ntlm_get_auth" ref="ga679f2d22b4a4bdefe0fa475d63503778" args="(TDSSOCKET *tds)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00088.html">TDSAUTHENTICATION</a>* tds_ntlm_get_auth </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00122.html">TDSSOCKET</a> *&nbsp;</td>
          <td class="paramname"> <em>tds</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Build a NTLMSPP packet to send to server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>tds</em>&nbsp;</td><td>A pointer to the TDSSOCKET structure managing a client/server operation. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>authentication info </dd></dl>

</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 17 22:22:31 2011 for FreeTDS API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>