openstack
/
kolla-cli
Code Issues Proposed changes
kolla-cli/doc/build/html/_modules/kollacli/api/password.html

174 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>kollacli.api.password &mdash; kollacli 4.0.1.dev498 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '4.0.1.dev498',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="kollacli 4.0.1.dev498 documentation" href="../../../index.html" />
<link rel="up" title="Module code" href="../../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../index.html">kollacli 4.0.1.dev498 documentation</a> &raquo;</li>
<li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for kollacli.api.password</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright(c) 2016, Oracle and/or its affiliates. All Rights Reserved.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may</span>
<span class="c1"># not use this file except in compliance with the License. You may obtain</span>
<span class="c1"># a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT</span>
<span class="c1"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
<span class="c1"># License for the specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="kn">import</span> <span class="nn">kollacli.i18n</span> <span class="kn">as</span> <span class="nn">u</span>
<span class="kn">from</span> <span class="nn">kollacli.common.passwords</span> <span class="kn">import</span> <span class="n">clear_password</span>
<span class="kn">from</span> <span class="nn">kollacli.common.passwords</span> <span class="kn">import</span> <span class="n">get_password_names</span>
<span class="kn">from</span> <span class="nn">kollacli.common.passwords</span> <span class="kn">import</span> <span class="n">init_passwords</span>
<span class="kn">from</span> <span class="nn">kollacli.common.passwords</span> <span class="kn">import</span> <span class="n">set_password</span>
<span class="kn">from</span> <span class="nn">kollacli.common.passwords</span> <span class="kn">import</span> <span class="n">set_password_sshkey</span>
<span class="kn">from</span> <span class="nn">kollacli.common.utils</span> <span class="kn">import</span> <span class="n">check_arg</span>
<div class="viewcode-block" id="PasswordApi"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.password.PasswordApi">[docs]</a><span class="k">class</span> <span class="nc">PasswordApi</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<div class="viewcode-block" id="PasswordApi.password_set"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.password.PasswordApi.password_set">[docs]</a> <span class="k">def</span> <span class="nf">password_set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># type: (str, str) -&gt; None</span>
<span class="sd">&quot;&quot;&quot;Set password</span>
<span class="sd"> :param name: name of the password</span>
<span class="sd"> :type name: string</span>
<span class="sd"> :param value: value of the password</span>
<span class="sd"> :type value: string</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">check_arg</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s1">&#39;Password name&#39;</span><span class="p">),</span> <span class="nb">str</span><span class="p">)</span>
<span class="n">check_arg</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s1">&#39;Password value&#39;</span><span class="p">),</span> <span class="nb">str</span><span class="p">,</span> <span class="n">display_param</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
<span class="n">empty_ok</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">none_ok</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="n">set_password</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="PasswordApi.password_set_sshkey"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.password.PasswordApi.password_set_sshkey">[docs]</a> <span class="k">def</span> <span class="nf">password_set_sshkey</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">private_key</span><span class="p">,</span> <span class="n">public_key</span><span class="p">):</span>
<span class="c1"># type: (str, str, str) -&gt; None</span>
<span class="sd">&quot;&quot;&quot;Set password to an ssh key</span>
<span class="sd"> :param name: name of the password</span>
<span class="sd"> :type name: string</span>
<span class="sd"> :param private_key: ssh private key</span>
<span class="sd"> :type value: string</span>
<span class="sd"> :param public_key: ssh public key</span>
<span class="sd"> :type value: string</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">check_arg</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s1">&#39;Password name&#39;</span><span class="p">),</span> <span class="nb">str</span><span class="p">)</span>
<span class="n">check_arg</span><span class="p">(</span><span class="n">private_key</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s1">&#39;Private key&#39;</span><span class="p">),</span> <span class="nb">str</span><span class="p">,</span> <span class="n">display_param</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
<span class="n">check_arg</span><span class="p">(</span><span class="n">public_key</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s1">&#39;Public key&#39;</span><span class="p">),</span> <span class="nb">str</span><span class="p">,</span> <span class="n">display_param</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
<span class="n">set_password_sshkey</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">private_key</span><span class="p">,</span> <span class="n">public_key</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="PasswordApi.password_clear"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.password.PasswordApi.password_clear">[docs]</a> <span class="k">def</span> <span class="nf">password_clear</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; None</span>
<span class="sd">&quot;&quot;&quot;Clear password</span>
<span class="sd"> :param name: name of the password</span>
<span class="sd"> :type name: string</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">check_arg</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s1">&#39;Password name&#39;</span><span class="p">),</span> <span class="nb">str</span><span class="p">)</span>
<span class="n">clear_password</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="PasswordApi.password_get_names"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.password.PasswordApi.password_get_names">[docs]</a> <span class="k">def</span> <span class="nf">password_get_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; List[str]</span>
<span class="sd">&quot;&quot;&quot;Get password names</span>
<span class="sd"> :return: password names</span>
<span class="sd"> :rtype: list of strings</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">get_password_names</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="PasswordApi.password_init"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.password.PasswordApi.password_init">[docs]</a> <span class="k">def</span> <span class="nf">password_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="sd">&quot;&quot;&quot;Init empty passwords</span>
<span class="sd"> Init empty passwords and ssh keys in /etc/kolla/passwords.yml</span>
<span class="sd"> to auto-generated values</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">init_passwords</span><span class="p">()</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../index.html">kollacli 4.0.1.dev498 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Module code</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Oracle.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
View Git Blame Copy Permalink