Skip to content

C
converse.js
Commit b7946229 authored by Michal Čihař's avatar Michal Čihař
Browse files
Options

Factor out ssh operations to separate module 

Issue #597
Signed-off-by: default avatarMichal Čihař <michal@cihar.com>
parent ca3ea780
Hide whitespace changes
Inline Side-by-side
Showing with 222 additions and 182 deletions
weblate/trans/admin_views.py
View file @ b7946229
......@@ -29,36 +29,17 @@ from weblate import settings_example
from weblate import appsettings
from weblate.accounts.avatar import HAS_LIBRAVATAR
from weblate.accounts.forms import HAS_PYUCA
from weblate.trans.util import get_configuration_errors, get_clean_env
from weblate.trans.util import get_configuration_errors
from weblate.trans.ssh import (
generate_ssh_key, get_key_data, add_host_key,
get_host_keys, can_generate_key, is_home_writable
)
import weblate
import django
import subprocess
import hashlib
import os
# List of default domain names on which warn user
DEFAULT_DOMAINS = ('example.net', 'example.com')
# SSH key files
KNOWN_HOSTS_FILE = os.path.expanduser('~/.ssh/known_hosts')
RSA_KEY_FILE = os.path.expanduser('~/.ssh/id_rsa.pub')
def is_key_line(key):
"""
Checks whether this line looks like a valid known_hosts line.
"""
if not key:
return False
if key[0] == '#':
return False
return (
' ssh-rsa ' in key
or ' ecdsa-sha2-nistp256 ' in key
or ' ssh-ed25519 ' in key
)
@staff_member_required
def report(request):
......@@ -176,7 +157,7 @@ def performance(request):
# Writable home directory
checks.append((
_('Home directory'),
os.access(os.path.expanduser('~'), os.W_OK),
is_home_writable(),
'production-home'
))
......@@ -206,159 +187,15 @@ def performance(request):
)
def parse_hosts_line(line):
"""
Parses single hosts line into tuple host, key fingerprint.
"""
host, keytype, key = line.strip().split(None, 3)[:3]
fp_plain = hashlib.md5(key.decode('base64')).hexdigest()
fingerprint = ':'.join(
[a + b for a, b in zip(fp_plain[::2], fp_plain[1::2])]
)
if host.startswith('|1|'):
# Translators: placeholder SSH hashed hostname
host = _('[hostname hashed]')
return host, keytype, fingerprint
def get_host_keys():
"""
Returns list of host keys.
"""
try:
result = []
with open(KNOWN_HOSTS_FILE, 'r') as handle:
for line in handle:
line = line.strip()
if is_key_line(line):
result.append(parse_hosts_line(line))
except IOError:
return []
return result
def get_key_data():
"""
Parses host key and returns it.
"""
# Read key data if it exists
if os.path.exists(RSA_KEY_FILE):
with open(RSA_KEY_FILE) as handle:
key_data = handle.read()
key_type, key_fingerprint, key_id = key_data.strip().split(None, 2)
return {
'key': key_data,
'type': key_type,
'fingerprint': key_fingerprint,
'id': key_id,
}
return None
def generate_ssh_key(request):
"""
Generates SSH key.
"""
# Create directory if it does not exist
key_dir = os.path.dirname(RSA_KEY_FILE)
# Try generating key
try:
if not os.path.exists(key_dir):
os.makedirs(key_dir)
subprocess.check_output(
[
'ssh-keygen', '-q',
'-N', '',
'-C', 'Weblate',
'-t', 'rsa',
'-f', RSA_KEY_FILE[:-4]
],
stderr=subprocess.STDOUT,
env=get_clean_env(),
)
messages.success(request, _('Created new SSH key.'))
except (subprocess.CalledProcessError, OSError) as exc:
messages.error(
request,
_('Failed to generate key: %s') %
getattr(exc, 'output', str(exc))
)
def add_host_key(request):
"""
Adds host key for a host.
"""
host = request.POST.get('host', '')
port = request.POST.get('port', '')
if len(host) == 0:
messages.error(request, _('Invalid host name given!'))
else:
cmdline = ['ssh-keyscan']
if port:
cmdline.extend(['-p', port])
cmdline.append(host)
try:
output = subprocess.check_output(
cmdline,
stderr=subprocess.STDOUT,
env=get_clean_env(),
)
keys = []
for key in output.splitlines():
key = key.strip()
if not is_key_line(key):
continue
keys.append(key)
host, keytype, fingerprint = parse_hosts_line(key)
messages.warning(
request,
_(
'Added host key for %(host)s with fingerprint '
'%(fingerprint)s (%(keytype)s), '
'please verify that it is correct.'
) % {
'host': host,
'fingerprint': fingerprint,
'keytype': keytype,
}
)
if len(keys) == 0:
messages.error(
request,
_('Failed to fetch public key for a host!')
)
with open(KNOWN_HOSTS_FILE, 'a') as handle:
for key in keys:
handle.write('%s\n' % key)
except (subprocess.CalledProcessError, OSError) as exc:
messages.error(
request,
_('Failed to get host key: %s') % exc.output
)
@staff_member_required
def ssh(request):
"""
Show information and manipulate with SSH key.
"""
# Check whether we can generate SSH key
try:
ret = subprocess.check_call(
['which', 'ssh-keygen'],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
env=get_clean_env(),
)
can_generate = (ret == 0 and not os.path.exists(RSA_KEY_FILE))
except subprocess.CalledProcessError:
can_generate = False
can_generate = can_generate_key()
if not os.access(os.path.expanduser('~'), os.W_OK):
if not is_home_writable():
can_generate = False
messages.error(
request,
......
weblate/trans/ssh.py 0 → 100644
View file @ b7946229
# -*- coding: utf-8 -*-
#
# Copyright © 2012 - 2014 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <http://weblate.org/>
#
# 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/>.
#
import subprocess
import hashlib
import os
from django.utils.translation import ugettext as _
from django.contrib import messages
from weblate.trans.util import get_clean_env
# SSH key files
KNOWN_HOSTS_FILE = os.path.expanduser('~/.ssh/known_hosts')
RSA_KEY_FILE = os.path.expanduser('~/.ssh/id_rsa.pub')
def is_key_line(key):
"""
Checks whether this line looks like a valid known_hosts line.
"""
if not key:
return False
if key[0] == '#':
return False
return (
' ssh-rsa ' in key
or ' ecdsa-sha2-nistp256 ' in key
or ' ssh-ed25519 ' in key
)
def parse_hosts_line(line):
"""
Parses single hosts line into tuple host, key fingerprint.
"""
host, keytype, key = line.strip().split(None, 3)[:3]
fp_plain = hashlib.md5(key.decode('base64')).hexdigest()
fingerprint = ':'.join(
[a + b for a, b in zip(fp_plain[::2], fp_plain[1::2])]
)
if host.startswith('|1|'):
# Translators: placeholder SSH hashed hostname
host = _('[hostname hashed]')
return host, keytype, fingerprint
def get_host_keys():
"""
Returns list of host keys.
"""
try:
result = []
with open(KNOWN_HOSTS_FILE, 'r') as handle:
for line in handle:
line = line.strip()
if is_key_line(line):
result.append(parse_hosts_line(line))
except IOError:
return []
return result
def get_key_data():
"""
Parses host key and returns it.
"""
# Read key data if it exists
if os.path.exists(RSA_KEY_FILE):
with open(RSA_KEY_FILE) as handle:
key_data = handle.read()
key_type, key_fingerprint, key_id = key_data.strip().split(None, 2)
return {
'key': key_data,
'type': key_type,
'fingerprint': key_fingerprint,
'id': key_id,
}
return None
def generate_ssh_key(request):
"""
Generates SSH key.
"""
# Create directory if it does not exist
key_dir = os.path.dirname(RSA_KEY_FILE)
# Try generating key
try:
if not os.path.exists(key_dir):
os.makedirs(key_dir)
subprocess.check_output(
[
'ssh-keygen', '-q',
'-N', '',
'-C', 'Weblate',
'-t', 'rsa',
'-f', RSA_KEY_FILE[:-4]
],
stderr=subprocess.STDOUT,
env=get_clean_env(),
)
messages.success(request, _('Created new SSH key.'))
except (subprocess.CalledProcessError, OSError) as exc:
messages.error(
request,
_('Failed to generate key: %s') %
getattr(exc, 'output', str(exc))
)
def add_host_key(request):
"""
Adds host key for a host.
"""
host = request.POST.get('host', '')
port = request.POST.get('port', '')
if len(host) == 0:
messages.error(request, _('Invalid host name given!'))
else:
cmdline = ['ssh-keyscan']
if port:
cmdline.extend(['-p', port])
cmdline.append(host)
try:
output = subprocess.check_output(
cmdline,
stderr=subprocess.STDOUT,
env=get_clean_env(),
)
keys = []
for key in output.splitlines():
key = key.strip()
if not is_key_line(key):
continue
keys.append(key)
host, keytype, fingerprint = parse_hosts_line(key)
messages.warning(
request,
_(
'Added host key for %(host)s with fingerprint '
'%(fingerprint)s (%(keytype)s), '
'please verify that it is correct.'
) % {
'host': host,
'fingerprint': fingerprint,
'keytype': keytype,
}
)
if len(keys) == 0:
messages.error(
request,
_('Failed to fetch public key for a host!')
)
with open(KNOWN_HOSTS_FILE, 'a') as handle:
for key in keys:
handle.write('%s\n' % key)
except (subprocess.CalledProcessError, OSError) as exc:
messages.error(
request,
_('Failed to get host key: %s') % exc.output
)
def is_home_writable():
return os.access(os.path.expanduser('~'), os.W_OK)
def can_generate_key():
"""
Checks whether we can generate key.
"""
try:
ret = subprocess.check_call(
['which', 'ssh-keygen'],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
env=get_clean_env(),
)
if ret == 0 and not os.path.exists(RSA_KEY_FILE):
return is_home_writable()
return False
except subprocess.CalledProcessError:
return False
weblate/trans/tests/test_admin.py
View file @ b7946229
......@@ -19,7 +19,7 @@
#
from weblate.trans.tests.test_views import ViewTestCase
import weblate.trans.admin_views
import weblate.trans.ssh
from django.test import TestCase
from django.core.urlresolvers import reverse
from django.utils.unittest import SkipTest
......@@ -54,8 +54,8 @@ class AdminTest(ViewTestCase):
tempdir = tempfile.mkdtemp()
rsafile = os.path.join(tempdir, 'id_rsa.pub')
try:
backup = weblate.trans.admin_views.RSA_KEY_FILE
weblate.trans.admin_views.RSA_KEY_FILE = rsafile
backup = weblate.trans.ssh.RSA_KEY_FILE
weblate.trans.ssh.RSA_KEY_FILE = rsafile
response = self.client.get(reverse('admin-ssh'))
self.assertContains(response, 'Generate SSH key')
......@@ -67,15 +67,15 @@ class AdminTest(ViewTestCase):
self.assertContains(response, 'Created new SSH key')
finally:
weblate.trans.admin_views.RSA_KEY_FILE = backup
weblate.trans.ssh.RSA_KEY_FILE = backup
shutil.rmtree(tempdir)
def test_ssh_add(self):
tempdir = tempfile.mkdtemp()
hostsfile = os.path.join(tempdir, 'known_hosts')
try:
backup = weblate.trans.admin_views.KNOWN_HOSTS_FILE
weblate.trans.admin_views.KNOWN_HOSTS_FILE = hostsfile
backup = weblate.trans.ssh.KNOWN_HOSTS_FILE
weblate.trans.ssh.KNOWN_HOSTS_FILE = hostsfile
# Verify there is button for adding
response = self.client.get(reverse('admin-ssh'))
......@@ -94,7 +94,7 @@ class AdminTest(ViewTestCase):
with open(hostsfile) as handle:
self.assertIn('github.com', handle.read())
finally:
weblate.trans.admin_views.KNOWN_HOSTS_FILE = backup
weblate.trans.ssh.KNOWN_HOSTS_FILE = backup
shutil.rmtree(tempdir)
def test_performace(self):
......@@ -158,9 +158,9 @@ class AdminTest(ViewTestCase):
class SSHKeysTest(TestCase):
def test_parse(self):
try:
backup = weblate.trans.admin_views.KNOWN_HOSTS_FILE
weblate.trans.admin_views.KNOWN_HOSTS_FILE = TEST_HOSTS
hosts = weblate.trans.admin_views.get_host_keys()
backup = weblate.trans.ssh.KNOWN_HOSTS_FILE
weblate.trans.ssh.KNOWN_HOSTS_FILE = TEST_HOSTS
hosts = weblate.trans.ssh.get_host_keys()
self.assertEqual(len(hosts), 50)
finally:
weblate.trans.admin_views.KNOWN_HOSTS_FILE = backup
weblate.trans.ssh.KNOWN_HOSTS_FILE = backup
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7