doc/modules/luci.sys.user.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><strong>luci.sys.user</strong></li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/nixio.html">nixio</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/nixio.File.html">nixio.File</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/nixio.README.html">nixio.README</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 145         </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>luci.sys.user</code></h1>
 168
 169 <p>
 170
 171 LuCI system utilities / user related functions.
 172 </p>
 173
 174
 175
 176
 177
 178
 179
 180 <h2>Functions</h2>
 181 <table class="function_list">
 182
 183         <tr>
 184         <td class="name" nowrap><a href="#getuser">getuser</a>&nbsp;(uid)</td>
 185         <td class="summary">
 186
 187 Retrieve user informations for given uid.</td>
 188         </tr>
 189
 190         <tr>
 191         <td class="name" nowrap><a href="#user.checkpasswd">checkpasswd</a>&nbsp;(username, pass)</td>
 192         <td class="summary">
 193
 194 Test whether given string matches the password of a given system user.</td>
 195         </tr>
 196
 197         <tr>
 198         <td class="name" nowrap><a href="#user.getpasswd">getpasswd</a>&nbsp;(username)</td>
 199         <td class="summary">
 200
 201 Retrieve the current user password hash.</td>
 202         </tr>
 203
 204         <tr>
 205         <td class="name" nowrap><a href="#user.setpasswd">setpasswd</a>&nbsp;(username, password)</td>
 206         <td class="summary">
 207
 208 Change the password of given user.</td>
 209         </tr>
 210
 211 </table>
 212
 213
 214
 215
 216
 217
 218 <br/>
 219 <br/>
 220
 221
 222 <h2><a name="functions"></a>Functions</h2>
 223 <dl class="function">
 224
 225
 226
 227 <dt><a name="getuser"></a><strong>getuser</strong>&nbsp;(uid)</dt>
 228 <dd>
 229
 230
 231 Retrieve user informations for given uid.
 232
 233
 234
 235 <h3>Parameters</h3>
 236 <ul>
 237
 238         <li>
 239           uid: Number containing the Unix user id
 240         </li>
 241
 242 </ul>
 243
 244
 245
 246
 247
 248
 249 <h3>Return value:</h3>
 250 Table containing the following fields:
 251                                 { "uid", "gid", "name", "passwd", "dir", "shell", "gecos" }
 252
 253
 254
 255 </dd>
 256
 257
 258
 259
 260 <dt><a name="user.checkpasswd"></a><strong>checkpasswd</strong>&nbsp;(username, pass)</dt>
 261 <dd>
 262
 263
 264 Test whether given string matches the password of a given system user.
 265
 266
 267
 268 <h3>Parameters</h3>
 269 <ul>
 270
 271         <li>
 272           username: String containing the Unix user name
 273         </li>
 274
 275         <li>
 276           pass: String containing the password to compare
 277         </li>
 278
 279 </ul>
 280
 281
 282
 283
 284
 285
 286 <h3>Return value:</h3>
 287 Boolean indicating wheather the passwords are equal
 288
 289
 290
 291 </dd>
 292
 293
 294
 295
 296 <dt><a name="user.getpasswd"></a><strong>getpasswd</strong>&nbsp;(username)</dt>
 297 <dd>
 298
 299
 300 Retrieve the current user password hash.
 301
 302
 303
 304 <h3>Parameters</h3>
 305 <ul>
 306
 307         <li>
 308           username: String containing the username to retrieve the password for
 309         </li>
 310
 311 </ul>
 312
 313
 314
 315
 316
 317
 318 <h3>Return values:</h3>
 319 <ol>
 320
 321         <li>String containing the hash or nil if no password is set.
 322
 323         <li>Password database entry
 324
 325 </ol>
 326
 327
 328
 329 </dd>
 330
 331
 332
 333
 334 <dt><a name="user.setpasswd"></a><strong>setpasswd</strong>&nbsp;(username, password)</dt>
 335 <dd>
 336
 337
 338 Change the password of given user.
 339
 340
 341
 342 <h3>Parameters</h3>
 343 <ul>
 344
 345         <li>
 346           username: String containing the Unix user name
 347         </li>
 348
 349         <li>
 350           password: String containing the password to compare
 351         </li>
 352
 353 </ul>
 354
 355
 356
 357
 358
 359
 360 <h3>Return value:</h3>
 361 Number containing 0 on success and >= 1 on error
 362
 363
 364
 365 </dd>
 366
 367
 368 </dl>
 369
 370
 371
 372
 373
 374 </div> <!-- id="content" -->
 375
 376 </div> <!-- id="main" -->
 377
 378 <div id="about">
 379         <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>
 380 </div> <!-- id="about" -->
 381
 382 </div> <!-- id="container" -->
 383 </body>
 384 </html>