ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>
Configuration of users and groups</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>
Configuration of users and groups</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>
Configuration of users and groups</h1>
</td>
<td class="filecell">include/users/widgets.ycp</td>
</tr>
<tr>
<td>Widgets definitions and helper functions</td>
</tr>
<tr>
<td>
<ul>
<li>Jiri Suchomel <jsuchome@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
<h1>Imports</h1>
<ul>
<li>Autologin</li>
<li>CWMTab</li>
<li>Label</li>
<li>Ldap</li>
<li>Message</li>
<li>Mode</li>
<li>Package</li>
<li>Popup</li>
<li>Progress</li>
<li>Report</li>
<li>Stage</li>
<li>String</li>
<li>Summary</li>
<li>Users</li>
<li>UsersCache</li>
<li>UsersLDAP</li>
<li>UsersRoutines</li>
<li>Wizard</li>
</ul>
<h1>Includes</h1>
<ul>
<li>users/complex.ycp</li>
<li>users/routines.ycp</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#AskForNISServerEncryptionPopup">AskForNISServerEncryptionPopup (string encr)</a>
</li>
<li>
<a href="#AutologinPopup">AutologinPopup ()</a>
</li>
<li>
<a href="#ChooseTypePopup">ChooseTypePopup (list<string> sets, string what)</a>
</li>
<li>
<a href="#CustomizePopup">CustomizePopup (string what)</a>
</li>
<li>
<a href="#DeleteGroupPopup">DeleteGroupPopup ()</a>
</li>
<li>
<a href="#DeleteUserPopup">DeleteUserPopup ()</a>
</li>
<li>
<a href="#EncryptionPopup">EncryptionPopup ()</a>
</li>
<li>
<a href="#GetExpertList">GetExpertList ()</a>
</li>
<li>
<a href="#GetLDAPExpertList">GetLDAPExpertList ()</a>
</li>
<li>
<a href="#GroupsDialogHelp">GroupsDialogHelp ()</a>
</li>
<li>
<a href="#HandleAuthData">HandleAuthData (string key, map event)</a>
</li>
<li>
<a href="#HandleBrowseDirectory">HandleBrowseDirectory (string key, map event)</a>
</li>
<li>
<a href="#HandleFilterLine">HandleFilterLine (string widget_id, map event)</a>
</li>
<li>
<a href="#HandleSummaryTable">HandleSummaryTable (string widget_id, map event)</a>
</li>
<li>
<a href="#InitAuthData">InitAuthData (string key)</a>
</li>
<li>
<a href="#InitDefaults">InitDefaults (string key)</a>
</li>
<li>
<a href="#InitFilterLine">InitFilterLine (string widget_id)</a>
</li>
<li>
<a href="#InitTabUsersGroups">InitTabUsersGroups (string widget_id)</a>
</li>
<li>
<a href="#LDAPSearchFilterPopup">LDAPSearchFilterPopup ()</a>
</li>
<li>
<a href="#StoreAuthData">StoreAuthData (string key, map event)</a>
</li>
<li>
<a href="#StoreDefaults">StoreDefaults (string key, map event)</a>
</li>
<li>
<a href="#SummaryTableInit">SummaryTableInit (string widget_id)</a>
</li>
<li>
<a href="#UsersDialogHelp">UsersDialogHelp ()</a>
</li>
<li>
<a href="#ValidateExpire">ValidateExpire (string key, map event)</a>
</li>
<li>
<a href="#ValidateGroupList">ValidateGroupList (string key, map event)</a>
</li>
<li>
<a href="#ValidateHomePrefix">ValidateHomePrefix (string key, map event)</a>
</li>
<li>
<a href="#ValidateShell">ValidateShell (string key, map event)</a>
</li>
<li>
<a href="#ValidateSkeleton">ValidateSkeleton (string key, map event)</a>
</li>
<li>
<a href="#get_module_data">get_module_data (string client)</a>
</li>
<li>
<a href="#help_main_end">help_main_end ()</a>
</li>
<li>
<a href="#help_main_start">help_main_start ()</a>
</li>
<li>
<a href="#reload_config">reload_config (list<string> clients)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="EncryptionPopup">local
<b>EncryptionPopup ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Popup for choosing the password encryption method.</p>
<div class="sigbox">
<span class="sig" id="AskForNISServerEncryptionPopup">local
<b>AskForNISServerEncryptionPopup (string encr)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
NIS server enabled together with non-DES encryption of passwords
In these popup, ask user what to do.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">encr</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="LDAPSearchFilterPopup">local
<b>LDAPSearchFilterPopup ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Popup for configuration user/group filter for making the LDAP search</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">modified?</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AutologinPopup">local
<b>AutologinPopup ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Popup for Login settings (Auotolgin feature, login without passwords)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">modified?</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="DeleteUserPopup">local
<b>DeleteUserPopup ()
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Popup for deleting user</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">for sequencer</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="DeleteGroupPopup">local
<b>DeleteGroupPopup ()
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Popup for deleting group</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">for sequencer</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CustomizePopup">local
<b>CustomizePopup (string what)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Dialog for definition of customized view</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">what</span>
</td>
<td class="descbox">"users" or "groups"</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if customs were odified</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ChooseTypePopup">local
<b>ChooseTypePopup (list<string> sets, string what)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
When there are more users/groups shown, choose which type should be created
after `add click</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sets</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">what</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetExpertList">local
<b>GetExpertList ()
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
return the list of menu items of "Expert Options" menubutton</p>
<div class="sigbox">
<span class="sig" id="GetLDAPExpertList">local
<b>GetLDAPExpertList ()
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
return the list of menu items for LDAP expert options</p>
<div class="sigbox">
<span class="sig" id="help_main_start">local
<b>help_main_start ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
First part of the help text.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">help text</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="help_main_end">local
<b>help_main_end ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Last part of the help text.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">help text</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UsersDialogHelp">local
<b>UsersDialogHelp ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Help for UsersDialog.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">help text</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GroupsDialogHelp">local
<b>GroupsDialogHelp ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Help for usersGroups.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">help text</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ValidateExpire">local
<b>ValidateExpire (string key, map event)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Validation function for the default value of account expiration</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ValidateSkeleton">local
<b>ValidateSkeleton (string key, map event)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Validation function for home directory skeleton directory</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ValidateHomePrefix">local
<b>ValidateHomePrefix (string key, map event)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Validation function for the default home prefix</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ValidateGroupList">local
<b>ValidateGroupList (string key, map event)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Validation function for the value of the default list of groups</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ValidateShell">local
<b>ValidateShell (string key, map event)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Validation function for the default login shell</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InitDefaults">local
<b>InitDefaults (string key)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize all the values in the dialog with new user defaults</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StoreDefaults">local
<b>StoreDefaults (string key, map event)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Store all the values from the dialog with new user defaults
(when leaving the dialog)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="HandleBrowseDirectory">local
<b>HandleBrowseDirectory (string key, map event)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
universal handler for directory browsing</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InitTabUsersGroups">local
<b>InitTabUsersGroups (string widget_id)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Handle the switch between tabs (load set of items for users or groups)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">widget_id</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SummaryTableInit">local
<b>SummaryTableInit (string widget_id)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize the contents of Summary Table widget</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">widget_id</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="HandleSummaryTable">local
<b>HandleSummaryTable (string widget_id, map event)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Handler for users/groups summary table</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">widget_id</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InitFilterLine">local
<b>InitFilterLine (string widget_id)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize the value of the label with current filter and filter selection</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">widget_id</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="HandleFilterLine">local
<b>HandleFilterLine (string widget_id, map event)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Handler for events generated by Set Filter widget</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">widget_id</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_module_data">local
<b>get_module_data (string client)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
helper function to get information about authentication from
appropriate module</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">client</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="reload_config">local
<b>reload_config (list<string> clients)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Reloads the configuration for given client and creates updated
summary widget contents
returns the summary value for richtext</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">clients</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InitAuthData">local
<b>InitAuthData (string key)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Init the widgets in Authentication tab</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="HandleAuthData">local
<b>HandleAuthData (string key, map event)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Handler for actions in Authentication tab</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StoreAuthData">local
<b>StoreAuthData (string key, map event)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Actions done when Authentication tab is left</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">event</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018