2016-06-20 17:05:31 +08:00
|
|
|
<!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"/>
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
2017-03-20 19:37:47 +08:00
|
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
2017-02-05 22:46:39 +08:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
2016-06-20 17:05:31 +08:00
|
|
|
<title>libwebsockets: SHA and B64 helpers</title>
|
|
|
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
|
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
|
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
|
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
|
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
|
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
|
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
$(document).ready(initResizable);
|
|
|
|
|
</script>
|
|
|
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
|
|
|
<div id="titlearea">
|
|
|
|
|
<table cellspacing="0" cellpadding="0">
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr style="height: 56px;">
|
|
|
|
|
<td id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
|
|
|
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
|
|
|
<div id="projectname">libwebsockets
|
|
|
|
|
</div>
|
|
|
|
|
<div id="projectbrief">Lightweight C library for HTML5 websockets</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
<!-- end header part -->
|
2017-03-20 19:37:47 +08:00
|
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
2017-02-05 22:46:39 +08:00
|
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
|
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
$(function() {
|
|
|
|
|
initMenu('',false,false,'search.php','Search');
|
|
|
|
|
});
|
|
|
|
|
</script>
|
|
|
|
|
<div id="main-nav"></div>
|
2016-06-20 17:05:31 +08:00
|
|
|
</div><!-- top -->
|
|
|
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
|
|
|
<div id="nav-tree">
|
|
|
|
|
<div id="nav-tree-contents">
|
|
|
|
|
<div id="nav-sync" class="sync"></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
|
|
|
class="ui-resizable-handle">
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
$(document).ready(function(){initNavTree('group__sha.html','');});
|
|
|
|
|
</script>
|
|
|
|
|
<div id="doc-content">
|
|
|
|
|
<div class="header">
|
|
|
|
|
<div class="summary">
|
|
|
|
|
<a href="#func-members">Functions</a> </div>
|
|
|
|
|
<div class="headertitle">
|
|
|
|
|
<div class="title">SHA and B64 helpers</div> </div>
|
|
|
|
|
</div><!--header-->
|
|
|
|
|
<div class="contents">
|
|
|
|
|
<table class="memberdecls">
|
|
|
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
|
|
|
Functions</h2></td></tr>
|
|
|
|
|
<tr class="memitem:ga7b09ab74646266f0b555103b3bb8dfe5"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sha.html#ga7b09ab74646266f0b555103b3bb8dfe5">lws_SHA1</a> (const unsigned char *d, size_t n, unsigned char *md)</td></tr>
|
|
|
|
|
<tr class="separator:ga7b09ab74646266f0b555103b3bb8dfe5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
|
|
<tr class="memitem:gaf39765e4a3b413efb65e4698b2ec3575"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sha.html#gaf39765e4a3b413efb65e4698b2ec3575">lws_b64_encode_string</a> (const char *in, int in_len, char *out, int out_size)</td></tr>
|
|
|
|
|
<tr class="separator:gaf39765e4a3b413efb65e4698b2ec3575"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
|
|
<tr class="memitem:ga66316e6a5a0644a09d5a10e919dfdd8d"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sha.html#ga66316e6a5a0644a09d5a10e919dfdd8d">lws_b64_decode_string</a> (const char *in, char *out, int out_size)</td></tr>
|
|
|
|
|
<tr class="separator:ga66316e6a5a0644a09d5a10e919dfdd8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
|
|
|
<h2>SHA and B64 helpers</h2>
|
|
|
|
|
<p>These provide SHA-1 and B64 helper apis </p>
|
|
|
|
|
<h2 class="groupheader">Function Documentation</h2>
|
2017-02-05 22:46:39 +08:00
|
|
|
<a id="ga66316e6a5a0644a09d5a10e919dfdd8d"></a>
|
2017-03-20 19:37:47 +08:00
|
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga66316e6a5a0644a09d5a10e919dfdd8d">◆ </a></span>lws_b64_decode_string()</h2>
|
2017-02-05 22:46:39 +08:00
|
|
|
|
2016-06-20 17:05:31 +08:00
|
|
|
<div class="memitem">
|
|
|
|
|
<div class="memproto">
|
|
|
|
|
<table class="memname">
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="memname">LWS_VISIBLE LWS_EXTERN int lws_b64_decode_string </td>
|
|
|
|
|
<td>(</td>
|
|
|
|
|
<td class="paramtype">const char * </td>
|
|
|
|
|
<td class="paramname"><em>in</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">char * </td>
|
|
|
|
|
<td class="paramname"><em>out</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">int </td>
|
|
|
|
|
<td class="paramname"><em>out_size</em> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>)</td>
|
|
|
|
|
<td></td><td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div><div class="memdoc">
|
|
|
|
|
|
|
|
|
|
<p><code>#include <<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>></code></p>
|
|
|
|
|
<p><a class="el" href="group__sha.html#ga66316e6a5a0644a09d5a10e919dfdd8d">lws_b64_decode_string()</a>: decode a string from base 64</p>
|
|
|
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
|
|
|
<table class="params">
|
|
|
|
|
<tr><td class="paramname">in</td><td>incoming buffer </td></tr>
|
|
|
|
|
<tr><td class="paramname">out</td><td>result buffer </td></tr>
|
|
|
|
|
<tr><td class="paramname">out_size</td><td>length of result buffer</td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<p>Decodes a string using b64 </p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2017-02-05 22:46:39 +08:00
|
|
|
<a id="gaf39765e4a3b413efb65e4698b2ec3575"></a>
|
2017-03-20 19:37:47 +08:00
|
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf39765e4a3b413efb65e4698b2ec3575">◆ </a></span>lws_b64_encode_string()</h2>
|
2017-02-05 22:46:39 +08:00
|
|
|
|
2016-06-20 17:05:31 +08:00
|
|
|
<div class="memitem">
|
|
|
|
|
<div class="memproto">
|
|
|
|
|
<table class="memname">
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="memname">LWS_VISIBLE LWS_EXTERN int lws_b64_encode_string </td>
|
|
|
|
|
<td>(</td>
|
|
|
|
|
<td class="paramtype">const char * </td>
|
|
|
|
|
<td class="paramname"><em>in</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">int </td>
|
|
|
|
|
<td class="paramname"><em>in_len</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">char * </td>
|
|
|
|
|
<td class="paramname"><em>out</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">int </td>
|
|
|
|
|
<td class="paramname"><em>out_size</em> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>)</td>
|
|
|
|
|
<td></td><td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div><div class="memdoc">
|
|
|
|
|
|
|
|
|
|
<p><code>#include <<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>></code></p>
|
|
|
|
|
<p><a class="el" href="group__sha.html#gaf39765e4a3b413efb65e4698b2ec3575">lws_b64_encode_string()</a>: encode a string into base 64</p>
|
|
|
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
|
|
|
<table class="params">
|
|
|
|
|
<tr><td class="paramname">in</td><td>incoming buffer </td></tr>
|
|
|
|
|
<tr><td class="paramname">in_len</td><td>length of incoming buffer </td></tr>
|
|
|
|
|
<tr><td class="paramname">out</td><td>result buffer </td></tr>
|
|
|
|
|
<tr><td class="paramname">out_size</td><td>length of result buffer</td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<p>Encodes a string using b64 </p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2017-02-05 22:46:39 +08:00
|
|
|
<a id="ga7b09ab74646266f0b555103b3bb8dfe5"></a>
|
2017-03-20 19:37:47 +08:00
|
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7b09ab74646266f0b555103b3bb8dfe5">◆ </a></span>lws_SHA1()</h2>
|
2017-02-05 22:46:39 +08:00
|
|
|
|
2016-06-20 17:05:31 +08:00
|
|
|
<div class="memitem">
|
|
|
|
|
<div class="memproto">
|
|
|
|
|
<table class="memname">
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="memname">LWS_VISIBLE LWS_EXTERN unsigned char* lws_SHA1 </td>
|
|
|
|
|
<td>(</td>
|
|
|
|
|
<td class="paramtype">const unsigned char * </td>
|
|
|
|
|
<td class="paramname"><em>d</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">size_t </td>
|
|
|
|
|
<td class="paramname"><em>n</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">unsigned char * </td>
|
|
|
|
|
<td class="paramname"><em>md</em> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>)</td>
|
|
|
|
|
<td></td><td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div><div class="memdoc">
|
|
|
|
|
|
|
|
|
|
<p><code>#include <<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>></code></p>
|
|
|
|
|
<p><a class="el" href="group__sha.html#ga7b09ab74646266f0b555103b3bb8dfe5">lws_SHA1()</a>: make a SHA-1 digest of a buffer</p>
|
|
|
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
|
|
|
<table class="params">
|
|
|
|
|
<tr><td class="paramname">d</td><td>incoming buffer </td></tr>
|
|
|
|
|
<tr><td class="paramname">n</td><td>length of incoming buffer </td></tr>
|
|
|
|
|
<tr><td class="paramname">md</td><td>buffer for message digest (must be >= 20 bytes)</td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<p>Reduces any size buffer into a 20-byte SHA-1 hash. </p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><!-- contents -->
|
|
|
|
|
</div><!-- doc-content -->
|
|
|
|
|
<!-- start footer part -->
|
|
|
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="footer">Generated by
|
|
|
|
|
<a href="http://www.doxygen.org/index.html">
|
2017-03-20 19:37:47 +08:00
|
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
2016-06-20 17:05:31 +08:00
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
