codekingpro/portable-devtools
114k
1
2
3<!DOCTYPE html>
4
5<html lang="en" data-content_root="./">
6 <head>
7 <meta charset="utf-8" />
8 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
9
10 <title>Master Password — pgAdmin 4 8.6 documentation</title>
11 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
12 <link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
13
14 <script src="_static/documentation_options.js?v=d4c83366"></script>
15 <script src="_static/doctools.js?v=9a2dae69"></script>
16 <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
17
18 <script src="_static/sidebar.js"></script>
19
20 <link rel="index" title="Index" href="genindex.html" />
21 <link rel="search" title="Search" href="search.html" />
22 <link rel="next" title="Connect to Server" href="connect_to_server.html" />
23 <link rel="prev" title="Google Cloud SQL Deployment" href="cloud_google_cloud_sql.html" />
24 </head><body>
25 <div class="related" role="navigation" aria-label="related navigation">
26 <h3>Navigation</h3>
27 <ul>
28 <li class="right" style="margin-right: 10px">
29 <a href="genindex.html" title="General Index"
30 accesskey="I">index</a></li>
31 <li class="right" >
32 <a href="connect_to_server.html" title="Connect to Server"
33 accesskey="N">next</a> |</li>
34 <li class="right" >
35 <a href="cloud_google_cloud_sql.html" title="Google Cloud SQL Deployment"
36 accesskey="P">previous</a> |</li>
37 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
38 <li class="nav-item nav-item-1"><a href="connecting.html" accesskey="U">Connecting To A Server</a> »</li>
39 <li class="nav-item nav-item-this"><a href="">Master Password</a></li>
40 </ul>
41 </div>
42
43 <div class="document">
44 <div class="documentwrapper">
45 <div class="bodywrapper">
46 <div class="body" role="main">
47
48 <section id="master-password">
49<span id="id1"></span><h1><span class="target" id="index-0"></span>Master Password<a class="headerlink" href="#master-password" title="Link to this heading">¶</a></h1>
50<div class="admonition note">
51<p class="admonition-title">Note</p>
52<p>pgAdmin 4 uses the operating system password store by default to store the saved server passwords in desktop mode from version 7.2 onwards and Master password will not be required.
53If the operating system password store is not available then pgAdmin 4 will continue to use a master password as per the configuration settings.</p>
54</div>
55<p>A master password is required to secure and later unlock the saved server
56passwords. This is applicable for desktop mode and in server mode if authentication source contains OAuth2 or Kerberos or Webserver.</p>
57<ul class="simple">
58<li><p>You are prompted to enter the master password when you open the window for
59the first time after starting the application.</p></li>
60<li><p>Once you set the master password, all the existing saved passwords will be
61re-encrypted using the master password.</p></li>
62<li><p>The server passwords which are saved in the SQLite DB file or External
63Database are encrypted and decrypted using the master password.</p></li>
64</ul>
65<img alt="Set master password" class="align-center" src="_images/master_password_set.png" />
66<div class="admonition note">
67<p class="admonition-title">Note</p>
68<p>pgAdmin aims to be <strong>secure by default</strong>, however, you can disable the master
69password by setting the configuration parameter <em>MASTER_PASSWORD_REQUIRED=False</em>.
70See <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">The config.py File</span></a> for more information on configuration parameters and how
71they can be changed or enforced across an organisation.</p>
72</div>
73<div class="admonition note">
74<p class="admonition-title">Note</p>
75<p>If the master password is disabled, then all the saved passwords will
76be removed.</p>
77</div>
78<div class="admonition warning">
79<p class="admonition-title">Warning</p>
80<p>If the master password is disabled, then the saved passwords will
81be encrypted using a key which is derived from information within the
82configuration database. Use of a master password ensures that the encryption
83key does not need to be stored anywhere, and thus prevents possible access
84to server credentials if the configuration database becomes available to an
85attacker.</p>
86<p>It is <strong>strongly</strong> recommended that you use the master password if you use
87the <em>Save Password</em> option.</p>
88</div>
89<ul class="simple">
90<li><p>The master password is not stored anywhere on the physical storage. It is
91temporarily stored in the application memory and it does not get saved when
92the application is restarted.</p></li>
93<li><p>You are prompted to enter the master password when pgAdmin server is
94restarted.</p></li>
95</ul>
96<img alt="Enter master password" class="align-center" src="_images/master_password_enter.png" />
97<ul class="simple">
98<li><p>If you forget the master password, you can use the <em>Reset Master Password</em>
99button to reset the password.</p></li>
100</ul>
101<img alt="Reset master password" class="align-center" src="_images/master_password_reset.png" />
102<div class="admonition warning">
103<p class="admonition-title">Warning</p>
104<p>Resetting the master password will also remove all saved passwords
105and close all existing established connections.</p>
106</div>
107</section>
108
109
110 <div class="clearer"></div>
111 </div>
112 </div>
113 </div>
114 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
115 <div class="sphinxsidebarwrapper">
116<h3><a href="index.html">Table of Contents</a></h3>
117<ul class="current">
118<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
119<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
120<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
121<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
122<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
123<li class="toctree-l2"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
124<li class="toctree-l2 current"><a class="current reference internal" href="#">Master Password</a></li>
125<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
126<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
127<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
128</ul>
129</li>
130<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
131<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
132<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
133<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
134<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
135<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
136<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
137<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
138<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
139<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
140<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
141</ul>
142
143<search id="searchbox" style="display: none" role="search">
144 <h3 id="searchlabel">Quick search</h3>
145 <div class="searchformwrapper">
146 <form class="search" action="search.html" method="get">
147 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
148 <input type="submit" value="Go" />
149 </form>
150 </div>
151</search>
152<script>document.getElementById('searchbox').style.display = "block"</script>
153 </div>
154<div id="sidebarbutton" title="Collapse sidebar">
155<span>«</span>
156</div>
157
158 </div>
159 <div class="clearer"></div>
160 </div>
161 <div class="related" role="navigation" aria-label="related navigation">
162 <h3>Navigation</h3>
163 <ul>
164 <li class="right" style="margin-right: 10px">
165 <a href="genindex.html" title="General Index"
166 >index</a></li>
167 <li class="right" >
168 <a href="connect_to_server.html" title="Connect to Server"
169 >next</a> |</li>
170 <li class="right" >
171 <a href="cloud_google_cloud_sql.html" title="Google Cloud SQL Deployment"
172 >previous</a> |</li>
173 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
174 <li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
175 <li class="nav-item nav-item-this"><a href="">Master Password</a></li>
176 </ul>
177 </div>
178 <div class="footer" role="contentinfo">
179 <div class="related" role="navigation" aria-label="related navigation">
180 <ul>
181 <li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
182 <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
183 <li class="right" ><a href="connect_to_server.html" title="Connect to Server" accesskey="N">next</a> |</li>
184 <li class="right" ><a href="cloud_google_cloud_sql.html" title="Google Cloud SQL Deployment" accesskey="P">previous</a> |</li>
185 </ul>
186 </div>
187 </div>
188 </body>
189</html>