1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
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"/-->
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" -->
27 <li><a href=
"../index.html">Index
</a></li>
38 <a href=
"../modules/luci.dispatcher.html">luci.dispatcher
</a>
42 <a href=
"../modules/luci.http.html">luci.http
</a>
46 <a href=
"../modules/luci.http.conditionals.html">luci.http.conditionals
</a>
50 <a href=
"../modules/luci.http.date.html">luci.http.date
</a>
54 <a href=
"../modules/luci.http.mime.html">luci.http.mime
</a>
58 <a href=
"../modules/luci.i18n.html">luci.i18n
</a>
62 <a href=
"../modules/luci.ip.html">luci.ip
</a>
66 <a href=
"../modules/luci.ip.cidr.html">luci.ip.cidr
</a>
70 <a href=
"../modules/luci.json.html">luci.json
</a>
74 <a href=
"../modules/luci.jsonc.html">luci.jsonc
</a>
78 <a href=
"../modules/luci.jsonc.parser.html">luci.jsonc.parser
</a>
82 <a href=
"../modules/luci.model.ipkg.html">luci.model.ipkg
</a>
86 <a href=
"../modules/luci.model.uci.html">luci.model.uci
</a>
90 <a href=
"../modules/luci.rpcc.html">luci.rpcc
</a>
94 <a href=
"../modules/luci.rpcc.ruci.html">luci.rpcc.ruci
</a>
98 <a href=
"../modules/luci.sys.html">luci.sys
</a>
102 <a href=
"../modules/luci.sys.init.html">luci.sys.init
</a>
106 <a href=
"../modules/luci.sys.iptparser.html">luci.sys.iptparser
</a>
110 <a href=
"../modules/luci.sys.net.html">luci.sys.net
</a>
114 <a href=
"../modules/luci.sys.process.html">luci.sys.process
</a>
117 <li><strong>luci.sys.user
</strong></li>
120 <a href=
"../modules/luci.sys.wifi.html">luci.sys.wifi
</a>
124 <a href=
"../modules/luci.util.html">luci.util
</a>
128 <a href=
"../modules/nixio.html">nixio
</a>
132 <a href=
"../modules/nixio.CHANGELOG.html">nixio.CHANGELOG
</a>
136 <a href=
"../modules/nixio.CryptoHash.html">nixio.CryptoHash
</a>
140 <a href=
"../modules/nixio.File.html">nixio.File
</a>
144 <a href=
"../modules/nixio.README.html">nixio.README
</a>
148 <a href=
"../modules/nixio.Socket.html">nixio.Socket
</a>
152 <a href=
"../modules/nixio.TLSContext.html">nixio.TLSContext
</a>
156 <a href=
"../modules/nixio.TLSSocket.html">nixio.TLSSocket
</a>
160 <a href=
"../modules/nixio.UnifiedIO.html">nixio.UnifiedIO
</a>
164 <a href=
"../modules/nixio.bin.html">nixio.bin
</a>
168 <a href=
"../modules/nixio.bit.html">nixio.bit
</a>
172 <a href=
"../modules/nixio.crypto.html">nixio.crypto
</a>
176 <a href=
"../modules/nixio.fs.html">nixio.fs
</a>
191 </div><!-- id="navigation" -->
195 <h1>Class
<code>luci.sys.user
</code></h1>
199 LuCI system utilities / user related functions.
209 <table class=
"function_list">
212 <td class=
"name" nowrap
><a href=
"#getuser">getuser
</a> (uid)
</td>
215 Retrieve user information for given uid.
</td>
219 <td class=
"name" nowrap
><a href=
"#user.checkpasswd">checkpasswd
</a> (username, pass)
</td>
222 Test whether given string matches the password of a given system user.
</td>
226 <td class=
"name" nowrap
><a href=
"#user.getpasswd">getpasswd
</a> (username)
</td>
229 Retrieve the current user password hash.
</td>
233 <td class=
"name" nowrap
><a href=
"#user.setpasswd">setpasswd
</a> (username, password)
</td>
236 Change the password of given user.
</td>
250 <h2><a name=
"functions"></a>Functions
</h2>
251 <dl class=
"function">
255 <dt><a name=
"getuser"></a><strong>getuser
</strong> (uid)
</dt>
259 Retrieve user information for given uid.
267 uid: Number containing the Unix user id
277 <h3>Return value:
</h3>
278 Table containing the following fields:
279 {
"uid",
"gid",
"name",
"passwd",
"dir",
"shell",
"gecos" }
288 <dt><a name=
"user.checkpasswd"></a><strong>checkpasswd
</strong> (username, pass)
</dt>
292 Test whether given string matches the password of a given system user.
300 username: String containing the Unix user name
304 pass: String containing the password to compare
314 <h3>Return value:
</h3>
315 Boolean indicating whether the passwords are equal
324 <dt><a name=
"user.getpasswd"></a><strong>getpasswd
</strong> (username)
</dt>
328 Retrieve the current user password hash.
336 username: String containing the username to retrieve the password for
346 <h3>Return values:
</h3>
349 <li>String containing the hash or nil if no password is set.
351 <li>Password database entry
362 <dt><a name=
"user.setpasswd"></a><strong>setpasswd
</strong> (username, password)
</dt>
366 Change the password of given user.
374 username: String containing the Unix user name
378 password: String containing the password to compare
388 <h3>Return value:
</h3>
389 Number containing
0 on success and
>=
1 on error
402 </div> <!-- id="content" -->
404 </div> <!-- id="main" -->
407 <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>
408 </div> <!-- id="about" -->
410 </div> <!-- id="container" -->