Files
@ 24e1099e4f29
Branch filter:
Location: kallithea/kallithea/model/ssh_key.py
24e1099e4f29
5.8 KiB
text/x-python
py3: make get_current_authuser handle missing tg context consistently and explicitly
tg context handling ends up using
tg.support.registry.StackedObjectProxy._current_obj for attribute access ...
which if no context has been pushed will end up in:
raise TypeError(
'No object (name: %s) has been registered for this '
'thread' % self.____name__)
utils2.get_current_authuser used code like:
if hasattr(tg.tmpl_context, 'authuser'):
Python 2 hasattr will call __getattr__ and return False if it throws any
exception. (It would thus catch the TypeError and silently fall through to use
the default user None.) This hasattr behavior is confusing and hard to use
correctly. Here, it was used incorrectly. It has been common practice to work
around by using something like:
getattr(x, y, None) is not None
Python 3 hasattr fixed this flaw and only catches AttributeError. The TypeError
would thus (rightfully) be propagated. That is a change that must be handled
when introducing py3 support.
The get_current_authuser code could more clearly and simple and py3-compatible
be written as:
return getattr(tmpl_context, 'authuser', None)
- but then we also have to handle the TypeError explicitly ... which we are
happy to do.
tg context handling ends up using
tg.support.registry.StackedObjectProxy._current_obj for attribute access ...
which if no context has been pushed will end up in:
raise TypeError(
'No object (name: %s) has been registered for this '
'thread' % self.____name__)
utils2.get_current_authuser used code like:
if hasattr(tg.tmpl_context, 'authuser'):
Python 2 hasattr will call __getattr__ and return False if it throws any
exception. (It would thus catch the TypeError and silently fall through to use
the default user None.) This hasattr behavior is confusing and hard to use
correctly. Here, it was used incorrectly. It has been common practice to work
around by using something like:
getattr(x, y, None) is not None
Python 3 hasattr fixed this flaw and only catches AttributeError. The TypeError
would thus (rightfully) be propagated. That is a change that must be handled
when introducing py3 support.
The get_current_authuser code could more clearly and simple and py3-compatible
be written as:
return getattr(tmpl_context, 'authuser', None)
- but then we also have to handle the TypeError explicitly ... which we are
happy to do.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | # -*- coding: utf-8 -*-
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
kallithea.model.ssh_key
~~~~~~~~~~~~~~~~~~~~~~~
SSH key model for Kallithea
"""
import errno
import logging
import os
import stat
import tempfile
from tg import config
from tg.i18n import ugettext as _
from kallithea.lib import ssh
from kallithea.lib.utils2 import str2bool
from kallithea.lib.vcs.exceptions import RepositoryError
from kallithea.model.db import User, UserSshKeys
from kallithea.model.meta import Session
log = logging.getLogger(__name__)
class SshKeyModelException(RepositoryError):
"""Exception raised by SshKeyModel methods to report errors"""
class SshKeyModel(object):
def create(self, user, description, public_key):
"""
:param user: user or user_id
:param description: description of SshKey
:param publickey: public key text
Will raise SshKeyModelException on errors
"""
try:
keytype, pub, comment = ssh.parse_pub_key(public_key)
except ssh.SshKeyParseError as e:
raise SshKeyModelException(_('SSH key %r is invalid: %s') % (public_key, e.message))
if not description.strip():
description = comment.strip()
user = User.guess_instance(user)
new_ssh_key = UserSshKeys()
new_ssh_key.user_id = user.user_id
new_ssh_key.description = description
new_ssh_key.public_key = public_key
for ssh_key in UserSshKeys.query().filter(UserSshKeys.fingerprint == new_ssh_key.fingerprint).all():
raise SshKeyModelException(_('SSH key %s is already used by %s') %
(new_ssh_key.fingerprint, ssh_key.user.username))
Session().add(new_ssh_key)
return new_ssh_key
def delete(self, fingerprint, user):
"""
Deletes ssh key with given fingerprint for the given user.
Will raise SshKeyModelException on errors
"""
ssh_key = UserSshKeys.query().filter(UserSshKeys.fingerprint == fingerprint)
user = User.guess_instance(user)
ssh_key = ssh_key.filter(UserSshKeys.user_id == user.user_id)
ssh_key = ssh_key.scalar()
if ssh_key is None:
raise SshKeyModelException(_('SSH key with fingerprint %r found') % fingerprint)
Session().delete(ssh_key)
def get_ssh_keys(self, user):
user = User.guess_instance(user)
user_ssh_keys = UserSshKeys.query() \
.filter(UserSshKeys.user_id == user.user_id).all()
return user_ssh_keys
def write_authorized_keys(self):
if not str2bool(config.get('ssh_enabled', False)):
log.error("Will not write SSH authorized_keys file - ssh_enabled is not configured")
return
authorized_keys = config.get('ssh_authorized_keys')
kallithea_cli_path = config.get('kallithea_cli_path', 'kallithea-cli')
if not authorized_keys:
log.error('Cannot write SSH authorized_keys file - ssh_authorized_keys is not configured')
return
log.info('Writing %s', authorized_keys)
authorized_keys_dir = os.path.dirname(authorized_keys)
try:
os.makedirs(authorized_keys_dir)
os.chmod(authorized_keys_dir, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR) # ~/.ssh/ must be 0700
except OSError as exception:
if exception.errno != errno.EEXIST:
raise
# Now, test that the directory is or was created in a readable way by previous.
if not (os.path.isdir(authorized_keys_dir) and
os.access(authorized_keys_dir, os.W_OK)):
raise SshKeyModelException("Directory of authorized_keys cannot be written to so authorized_keys file %s cannot be written" % (authorized_keys))
# Make sure we don't overwrite a key file with important content
if os.path.exists(authorized_keys):
with open(authorized_keys) as f:
for l in f:
if not l.strip() or l.startswith('#'):
pass # accept empty lines and comments
elif ssh.SSH_OPTIONS in l and ' ssh-serve ' in l:
pass # Kallithea entries are ok to overwrite
else:
raise SshKeyModelException("Safety check failed, found %r line in %s - please remove it if Kallithea should manage the file" % (l.strip(), authorized_keys))
fh, tmp_authorized_keys = tempfile.mkstemp('.authorized_keys', dir=os.path.dirname(authorized_keys))
with os.fdopen(fh, 'w') as f:
f.write("# WARNING: This .ssh/authorized_keys file is managed by Kallithea. Manual editing or adding new entries will make Kallithea back off.\n")
for key in UserSshKeys.query().join(UserSshKeys.user).filter(User.active == True):
f.write(ssh.authorized_keys_line(kallithea_cli_path, config['__file__'], key))
os.chmod(tmp_authorized_keys, stat.S_IRUSR | stat.S_IWUSR)
# This preliminary remove is needed for Windows, not for Unix.
# TODO In Python 3, the remove+rename sequence below should become os.replace.
if os.path.exists(authorized_keys):
os.remove(authorized_keys)
os.rename(tmp_authorized_keys, authorized_keys)
|