docs/api/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.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.date.html">luci.http.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.mime.html">luci.http.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.json.html">luci.json</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.sys.html">luci.sys</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 107         </li>
 108
 109         <li>
 110                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 111         </li>
 112
 113         <li>
 114                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 115         </li>
 116
 117         <li><strong>luci.sys.user</strong></li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.util.html">luci.util</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/luci.xml.html">luci.xml</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.html">nixio</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.File.html">nixio.File</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.README.html">nixio.README</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 177         </li>
 178
 179         <li>
 180                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 181         </li>
 182
 183 </ul>
 184
 185
 186
 187 <!-- File list -->
 188
 189
 190
 191
 192
 193
 194
 195 </div><!-- id="navigation" -->
 196
 197 <div id="content">
 198
 199 <h1>Class <code>luci.sys.user</code></h1>
 200
 201 <p>
 202
 203 LuCI system utilities / user related functions.
 204 </p>
 205
 206
 207
 208
 209
 210
 211
 212 <h2>Functions</h2>
 213 <table class="function_list">
 214
 215         <tr>
 216         <td class="name" nowrap><a href="#getuser">getuser</a>&nbsp;(uid)</td>
 217         <td class="summary">
 218
 219 Retrieve user information for given uid.</td>
 220         </tr>
 221
 222         <tr>
 223         <td class="name" nowrap><a href="#user.checkpasswd">checkpasswd</a>&nbsp;(username, pass)</td>
 224         <td class="summary">
 225
 226 Test whether given string matches the password of a given system user.</td>
 227         </tr>
 228
 229         <tr>
 230         <td class="name" nowrap><a href="#user.getpasswd">getpasswd</a>&nbsp;(username)</td>
 231         <td class="summary">
 232
 233 Retrieve the current user password hash.</td>
 234         </tr>
 235
 236         <tr>
 237         <td class="name" nowrap><a href="#user.setpasswd">setpasswd</a>&nbsp;(username, password)</td>
 238         <td class="summary">
 239
 240 Change the password of given user.</td>
 241         </tr>
 242
 243 </table>
 244
 245
 246
 247
 248
 249
 250 <br/>
 251 <br/>
 252
 253
 254 <h2><a name="functions"></a>Functions</h2>
 255 <dl class="function">
 256
 257
 258
 259 <dt><a name="getuser"></a><strong>getuser</strong>&nbsp;(uid)</dt>
 260 <dd>
 261
 262
 263 Retrieve user information for given uid.
 264
 265
 266
 267 <h3>Parameters</h3>
 268 <ul>
 269
 270         <li>
 271           uid: Number containing the Unix user id
 272         </li>
 273
 274 </ul>
 275
 276
 277
 278
 279
 280
 281 <h3>Return value:</h3>
 282 Table containing the following fields:
 283                                 { "uid", "gid", "name", "passwd", "dir", "shell", "gecos" }
 284
 285
 286
 287 </dd>
 288
 289
 290
 291
 292 <dt><a name="user.checkpasswd"></a><strong>checkpasswd</strong>&nbsp;(username, pass)</dt>
 293 <dd>
 294
 295
 296 Test whether given string matches the password of a given system user.
 297
 298
 299
 300 <h3>Parameters</h3>
 301 <ul>
 302
 303         <li>
 304           username: String containing the Unix user name
 305         </li>
 306
 307         <li>
 308           pass: String containing the password to compare
 309         </li>
 310
 311 </ul>
 312
 313
 314
 315
 316
 317
 318 <h3>Return value:</h3>
 319 Boolean indicating whether the passwords are equal
 320
 321
 322
 323 </dd>
 324
 325
 326
 327
 328 <dt><a name="user.getpasswd"></a><strong>getpasswd</strong>&nbsp;(username)</dt>
 329 <dd>
 330
 331
 332 Retrieve the current user password hash.
 333
 334
 335
 336 <h3>Parameters</h3>
 337 <ul>
 338
 339         <li>
 340           username: String containing the username to retrieve the password for
 341         </li>
 342
 343 </ul>
 344
 345
 346
 347
 348
 349
 350 <h3>Return values:</h3>
 351 <ol>
 352
 353         <li>String containing the hash or nil if no password is set.
 354
 355         <li>Password database entry
 356
 357 </ol>
 358
 359
 360
 361 </dd>
 362
 363
 364
 365
 366 <dt><a name="user.setpasswd"></a><strong>setpasswd</strong>&nbsp;(username, password)</dt>
 367 <dd>
 368
 369
 370 Change the password of given user.
 371
 372
 373
 374 <h3>Parameters</h3>
 375 <ul>
 376
 377         <li>
 378           username: String containing the Unix user name
 379         </li>
 380
 381         <li>
 382           password: String containing the password to compare
 383         </li>
 384
 385 </ul>
 386
 387
 388
 389
 390
 391
 392 <h3>Return value:</h3>
 393 Number containing 0 on success and >= 1 on error
 394
 395
 396
 397 </dd>
 398
 399
 400 </dl>
 401
 402
 403
 404
 405
 406 </div> <!-- id="content" -->
 407
 408 </div> <!-- id="main" -->
 409
 410 <div id="about">
 411         <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>
 412 </div> <!-- id="about" -->
 413
 414 </div> <!-- id="container" -->
 415 </body>
 416 </html>