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>
GPG Key Management</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>
GPG Key Management</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>
GPG Key Management</h1>
</td>
<td class="filecell">modules/KeyManager.ycp</td>
</tr>
<tr>
<td>Manages GPG keys in the package manager</td>
</tr>
<tr>
<td>
<ul>
<li>Ladislav Slezák <lslezak@novell.com></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>Directory</li>
<li>Report</li>
<li>String</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#DeleteKey">DeleteKey (string key_id)</a>
</li>
<li>
<a href="#GetKeys">GetKeys ()</a>
</li>
<li>
<a href="#ImportFromFile">ImportFromFile (string file, boolean trusted)</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#Read">Read ()</a>
</li>
<li>
<a href="#Reset">Reset ()</a>
</li>
<li>
<a href="#SearchGPGKey">SearchGPGKey (string key_id)</a>
</li>
<li>
<a href="#Write">Write ()</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#ReadCurrentKeys">ReadCurrentKeys ()</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="Reset">global
<b>Reset ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Reset the internal state of the module. The current configuration and all
changes are deleted.</p>
<div class="sigbox">
<span class="sig" id="ReadCurrentKeys">local
<b>ReadCurrentKeys ()
<span class="a"> -> </span>
<span class="t">list<map<string,any> ></span>
</b>
</span>
</div>
<p>
Read the current configuration from the package manager</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">the current configuration, nil when an error occurr</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Read">global
<b>Read ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Read the current configuration from the package manager. The previous changes are lost (@see Reset).
The target system of the package manager must be initialized before reading GPG keys!</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SearchGPGKey">global
<b>SearchGPGKey (string key_id)
<span class="a"> -> </span>
<span class="t">map<string,any></span>
</b>
</span>
</div>
<p>
Search a GPG key in the known keys</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key_id</span>
</td>
<td class="descbox">ID of the key</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">Data about the key or nil if the key was not found</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Write">global
<b>Write ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Apply the changes, update the current status</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Modified">global
<b>Modified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Has been something changed?</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if something has been changed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetKeys">global
<b>GetKeys ()
<span class="a"> -> </span>
<span class="t">list<map<string,any> ></span>
</b>
</span>
</div>
<p>
Return the current keys.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">list of known GPG keys ($[ "id" : string, "name" : string, "trusted" : boolean ])</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="DeleteKey">global
<b>DeleteKey (string key_id)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Delete the key from the package manager</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key_id</span>
</td>
<td class="descbox">ID of the key to delete</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 on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ImportFromFile">global
<b>ImportFromFile (string file, boolean trusted)
<span class="a"> -> </span>
<span class="t">map<string,any></span>
</b>
</span>
</div>
<p>
Import key from a file</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">file</span>
</td>
<td class="descbox">path to the file</td>
</tr>
<tr>
<td class="pbox">
<span class="p">trusted</span>
</td>
<td class="descbox">true if the key is trusted</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">map with the key, nil when import fails (invalid key, not existing file, already imported key...)</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