IntenseWebs/pgadmin4
3
0
Fork 0
mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2025-02-09 23:15:58 -06:00
Code Issues Packages Projects Releases Wiki Activity

Text improvement for the OS secret store feature. #5123

Browse Source
This commit is contained in:
Nikhil Mohite 2023-05-24 18:06:21 +05:30 committed by GitHub
parent 3e031ad334
commit fec63c6cf3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 56 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
web/pgadmin/browser/__init__.py
View File

@ -746,12 +746,12 @@ def get_nodes():
def form_master_password_response(existing=True, present=False, errmsg=None,
is_keyring=False):
keyring_name=''):
return make_json_response(data={
'present': present,
'reset': existing,
'errmsg': errmsg,
'is_keyring': is_keyring,
'keyring_name': keyring_name,
'is_error': True if errmsg else False
})
@ -821,7 +821,7 @@ def set_master_password():
not validate_master_password(data.get('password')):
return form_master_password_response(
present=False,
is_keyring=True,
keyring_name=config.KEYRING_NAME,
errmsg=gettext("Incorrect master password")
)
from pgadmin.model import Server
@ -835,6 +835,7 @@ def set_master_password():
KEY_RING_SERVICE_NAME, KEY_RING_DESKTOP_USER.format(
desktop_user.username)) or data['password']:
all_server = Server.query.all()
is_migrated = False
for server in all_server:
if server.password and data['password'] \
and server.save_password:
@ -845,6 +846,7 @@ def set_master_password():
# Store the password using OS password manager
keyring.set_password(KEY_RING_SERVICE_NAME, name,
password)
is_migrated = True
setattr(server, 'password', None)
db.session.commit()
@ -856,12 +858,12 @@ def set_master_password():
return form_master_password_response(
existing=True,
present=True,
is_keyring=True
keyring_name=config.KEYRING_NAME if is_migrated else ''
)
else:
return form_master_password_response(
present=False,
is_keyring=True
keyring_name=config.KEYRING_NAME
)
except Exception as e:
current_app.logger.warning(

23
web/pgadmin/browser/server_groups/servers/__init__.py
View File

@ -802,6 +802,10 @@ class ServerNode(PGChildNodeView):
data = request.form if request.form else json.loads(
request.data
)
old_server_name = ''
if 'name' in data:
old_server_name = server.name
if 'db_res' in data:
data['db_res'] = ','.join(data['db_res'])
@ -834,6 +838,25 @@ class ServerNode(PGChildNodeView):
)
try:
if len(old_server_name) and old_server_name != server.name and \
not config.DISABLED_LOCAL_PASSWORD_STORAGE:
# If server name is changed then update keyring with
# new server name
password = keyring.get_password(
KEY_RING_SERVICE_NAME,
KEY_RING_USERNAME_FORMAT.format(old_server_name,
server.id))
keyring.set_password(
KEY_RING_SERVICE_NAME,
KEY_RING_USERNAME_FORMAT.format(server.name, server.id),
password)
server_name = KEY_RING_USERNAME_FORMAT.format(
old_server_name, server.id)
# Delete saved password from OS password manager
keyring.delete_password(KEY_RING_SERVICE_NAME,
server_name)
db.session.commit()
except Exception as e:
current_app.logger.exception(e)

3
web/pgadmin/evaluate_config.py
View File

@ -117,11 +117,14 @@ def evaluate_and_patch_config(config: dict) -> dict:
if config.get('SERVER_MODE'):
config.setdefault('DISABLED_LOCAL_PASSWORD_STORAGE', True)
config.setdefault('KEYRING_NAME', '')
else:
k_name = keyring.get_keyring().name
if k_name == 'fail Keyring':
config.setdefault('DISABLED_LOCAL_PASSWORD_STORAGE', True)
config.setdefault('KEYRING_NAME', '')
else:
config.setdefault('DISABLED_LOCAL_PASSWORD_STORAGE', False)
config.setdefault('KEYRING_NAME', k_name)
return config

9
web/pgadmin/static/js/Dialogs/MasterPasswordContent.jsx
View File

@ -20,13 +20,14 @@ import HelpIcon from '@material-ui/icons/Help';
import { DefaultButton, PrimaryButton, PgIconButton } from '../components/Buttons';
import { useModalStyles } from '../helpers/ModalProvider';
import { FormFooterMessage, InputText, MESSAGE_TYPE } from '../components/FormComponents';
import { FormFooterMessage, FormNote, InputText, MESSAGE_TYPE } from '../components/FormComponents';
export default function MasterPasswordContent({ closeModal, onResetPassowrd, onOK, onCancel, setHeight, isPWDPresent, data, isKeyring}) {
export default function MasterPasswordContent({ closeModal, onResetPassowrd, onOK, onCancel, setHeight, isPWDPresent, data, keyringName}) {
const classes = useModalStyles();
const containerRef = useRef();
const firstEleRef = useRef();
const okBtnRef = useRef();
const isKeyring = keyringName.length > 0;
const [formData, setFormData] = useState({
password: ''
});
@ -67,7 +68,7 @@ export default function MasterPasswordContent({ closeModal, onResetPassowrd, onO
</span>
<br />
<span style={{ fontWeight: 'bold' }}>
{gettext('This is required to migrate the existing saved Server password and SSH tunnel password to OS password manager, as pgAdmin 4 will now use the OS password manager in Desktop mode.')}
<FormNote text={gettext(`pgAdmin now stores any saved passwords in ${keyringName}. Enter the master password for your existing pgAdmin saved passwords and they will be migrated to the operating system store when you click OK.`)}></FormNote>
</span>
</Box>
<Box marginTop='12px'>
@ -143,5 +144,5 @@ MasterPasswordContent.propTypes = {
setHeight: PropTypes.func,
isPWDPresent: PropTypes.bool,
data: PropTypes.object,
isKeyring: PropTypes.bool,
keyringName: PropTypes.string,
};

14
web/pgadmin/static/js/Dialogs/index.jsx
View File

@ -156,10 +156,16 @@ function masterPassCallbacks(masterpass_callback_queue) {
export function checkMasterPassword(data, masterpass_callback_queue, cancel_callback) {
const api = getApiInstance();
api.post(url_for('browser.set_master_password'), data).then((res)=> {
let isKeyring = res.data.data.keyring_name.length > 0;
if(!res.data.data.present) {
showMasterPassword(res.data.data.reset, res.data.data.errmsg, masterpass_callback_queue, cancel_callback, res.data.data.is_keyring);
showMasterPassword(res.data.data.reset, res.data.data.errmsg, masterpass_callback_queue, cancel_callback, res.data.data.keyring_name);
} else {
masterPassCallbacks(masterpass_callback_queue);
if(isKeyring) {
Notify.alert(gettext('Migration successful'),
gettext(`Passwords previously saved by pgAdmin have been successfully migrated to ${res.data.data.keyring_name} and removed from the pgAdmin store.`));
}
}
}).catch(function(error) {
Notify.pgRespErrorNotify(error);
@ -167,16 +173,16 @@ export function checkMasterPassword(data, masterpass_callback_queue, cancel_call
}
// This functions is used to show the master password dialog.
export function showMasterPassword(isPWDPresent, errmsg, masterpass_callback_queue, cancel_callback, is_keyring) {
export function showMasterPassword(isPWDPresent, errmsg, masterpass_callback_queue, cancel_callback, keyring_name) {
const api = getApiInstance();
let title = isPWDPresent ? gettext('Unlock Saved Passwords') : gettext('Set Master Password');
let title = keyring_name.length > 0 ? gettext('Migrate Saved Passwords') : isPWDPresent ? gettext('Unlock Saved Passwords') : gettext('Set Master Password');
mountDialog(title, (onClose, setNewSize)=> {
return <Theme>
<MasterPasswordContent
isPWDPresent= {isPWDPresent}
data={{'errmsg': errmsg}}
isKeyring={is_keyring}
keyringName={keyring_name}
setHeight={(containerHeight) => {
setNewSize(pgAdmin.Browser.stdW.md, containerHeight);
}}

1
web/pgadmin/static/js/Theme/dark.js
View File

@ -85,6 +85,7 @@ export default function(basicSettings) {
borderColor: '#4a4a4a',
inputBorderColor: '#6b6b6b',
inputDisabledBg: 'inherit',
errorColor: '#DA6758',
headerBg: '#424242',
activeBorder: '#d4d4d4',
activeColor: '#d4d4d4',

1
web/pgadmin/static/js/Theme/high_contrast.js
View File

@ -83,6 +83,7 @@ export default function(basicSettings) {
borderColor: '#A6B7C8',
inputBorderColor: '#6b6b6b',
inputDisabledBg: '#1F2932',
errorColor: '#DA6758',
headerBg: '#010B15',
activeBorder: '#fff',
activeColor: '#fff',

1
web/pgadmin/static/js/Theme/standard.js
View File

@ -89,6 +89,7 @@ export default function(basicSettings) {
backgroundColor: fade('#000', 0.65),
color: '#fff',
},
errorColor: '#E53935',
inputBorderColor: '#dde0e6',
inputDisabledBg: '#f3f5f9',
headerBg: '#fff',

2
web/pgadmin/static/js/helpers/ModalProvider.jsx
View File

@ -260,7 +260,7 @@ export const useModalStyles = makeStyles((theme) => ({
iconButtonStyle: {
marginLeft: 'auto',
marginRight: '4px'
}
},
}));
function ModalContainer({ id, title, content, dialogHeight, dialogWidth, onClose, fullScreen = false, isFullWidth = false, showFullScreen = false, isResizeable = false, minHeight = MIN_HEIGHT, minWidth = MIN_WIDTH, showTitle=true }) {

8
web/pgadmin/utils/constants.py
View File

@ -128,7 +128,7 @@ ACCESS_DENIED_MESSAGE = gettext(
"Rename, Delete or Create any files/folders")
KEY_RING_SERVICE_NAME = 'pgAdmin4-Masterpass-Service'
KEY_RING_USERNAME_FORMAT = 'pgAdmin4-{0}-{1}'
KEY_RING_TUNNEL_FORMAT = 'pgAdmin4-tunnel-{0}-{1}'
KEY_RING_DESKTOP_USER = 'desktop-user-{0}'
KEY_RING_SERVICE_NAME = 'pgAdmin4'
KEY_RING_USERNAME_FORMAT = KEY_RING_SERVICE_NAME + '-{0}-{1}'
KEY_RING_TUNNEL_FORMAT = KEY_RING_SERVICE_NAME + '-tunnel-{0}-{1}'
KEY_RING_DESKTOP_USER = KEY_RING_SERVICE_NAME + '-desktop-user-{0}'