doc/modules/nixio.crypto.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.ip.html">luci.ip</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/nixio.html">nixio</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 107         </li>
 108
 109         <li>
 110                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 111         </li>
 112
 113         <li>
 114                 <a href="../modules/nixio.File.html">nixio.File</a>
 115         </li>
 116
 117         <li>
 118                 <a href="../modules/nixio.README.html">nixio.README</a>
 119         </li>
 120
 121         <li>
 122                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 123         </li>
 124
 125         <li>
 126                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 127         </li>
 128
 129         <li>
 130                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 131         </li>
 132
 133         <li>
 134                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 135         </li>
 136
 137         <li>
 138                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 139         </li>
 140
 141         <li>
 142                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 143         </li>
 144
 145         <li><strong>nixio.crypto</strong></li>
 146
 147         <li>
 148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 149         </li>
 150
 151 </ul>
 152
 153
 154
 155 <!-- File list -->
 156
 157
 158
 159
 160
 161
 162
 163 </div><!-- id="navigation" -->
 164
 165 <div id="content">
 166
 167 <h1>Class <code>nixio.crypto</code></h1>
 168
 169 <p>
 170  Cryptographical library.</p>
 171
 172
 173
 174
 175
 176
 177
 178 <h2>Functions</h2>
 179 <table class="function_list">
 180
 181         <tr>
 182         <td class="name" nowrap><a href="#nixio.crypto.hash">hash</a>&nbsp;(algo)</td>
 183         <td class="summary">
 184  Create a hash object.</td>
 185         </tr>
 186
 187         <tr>
 188         <td class="name" nowrap><a href="#nixio.crypto.hmac">hmac</a>&nbsp;(algo, key)</td>
 189         <td class="summary">
 190  Create a HMAC object.</td>
 191         </tr>
 192
 193 </table>
 194
 195
 196
 197
 198
 199
 200 <br/>
 201 <br/>
 202
 203
 204 <h2><a name="functions"></a>Functions</h2>
 205 <dl class="function">
 206
 207
 208
 209 <dt><a name="nixio.crypto.hash"></a><strong>hash</strong>&nbsp;(algo)</dt>
 210 <dd>
 211
 212  Create a hash object.
 213
 214
 215 <h3>Parameters</h3>
 216 <ul>
 217
 218         <li>
 219           algo: Algorithm ["sha1", "md5"]
 220         </li>
 221
 222 </ul>
 223
 224
 225
 226
 227
 228
 229 <h3>Return value:</h3>
 230 CryptoHash Object
 231
 232
 233
 234 </dd>
 235
 236
 237
 238
 239 <dt><a name="nixio.crypto.hmac"></a><strong>hmac</strong>&nbsp;(algo, key)</dt>
 240 <dd>
 241
 242  Create a HMAC object.
 243
 244
 245 <h3>Parameters</h3>
 246 <ul>
 247
 248         <li>
 249           algo: Algorithm ["sha1", "md5"]
 250         </li>
 251
 252         <li>
 253           key: HMAC-Key
 254         </li>
 255
 256 </ul>
 257
 258
 259
 260
 261
 262
 263 <h3>Return value:</h3>
 264 CryptoHash Object
 265
 266
 267
 268 </dd>
 269
 270
 271 </dl>
 272
 273
 274
 275
 276
 277 </div> <!-- id="content" -->
 278
 279 </div> <!-- id="main" -->
 280
 281 <div id="about">
 282         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 283 </div> <!-- id="about" -->
 284
 285 </div> <!-- id="container" -->
 286 </body>
 287 </html>