Skip to content
This repository was archived by the owner on Jan 27, 2018. It is now read-only.

Python 3 support #33

Open
rdoursenaud wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Python 3 support #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf3f678
Update setuptools entry point to certbot
rdoursenaud Jul 21, 2017
d8baff0
Python 3 compatibility
rdoursenaud Jul 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 49 additions & 62 deletions letsencrypt_gandi/shs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
import logging
import os
import re
import xmlrpclib
try:
import xmlrpclib
except ImportError:
import xmlrpc.client as xmlrpclib
import tempfile
import subprocess

Expand Down Expand Up @@ -44,6 +47,8 @@ def get_user_environment():
return new_env


@zope.interface.implementer(interfaces.IAuthenticator, interfaces.IInstaller)
@zope.interface.provider(interfaces.IPluginFactory)
class GandiSHSConfigurator(common.Plugin):
# pylint: disable=too-many-instance-attributes,too-many-public-methods

Expand All @@ -53,9 +58,6 @@ class GandiSHSConfigurator(common.Plugin):
:type config: :class:`~letsencrypt.interfaces.IConfig`
"""

zope.interface.implements(interfaces.IAuthenticator, interfaces.IInstaller)
zope.interface.classProvides(interfaces.IPluginFactory)

description = "Gandi Simple Hosting - Alpha"

htaccess_content = None
Expand Down Expand Up @@ -192,7 +194,7 @@ def _lookup_shs(self):

def _base_path(self):
if re.match('^php', self.shs_info['type']):
return 'vhosts/{vhost}/htdocs/'.format(vhost=self.vhost)
return 'vhosts/{vhost}/htdocs'.format(vhost=self.vhost)
elif re.match('^(python|nodejs)', self.shs_info['type']):
return 'vhosts/default'
# if ruby
Expand Down Expand Up @@ -246,25 +248,24 @@ def _try_shs_auth(self, user, sftp_url):
sftp = subprocess.Popen(process, stdin=subprocess.PIPE, close_fds=True,
env=get_user_environment())

print >> sftp.stdin, 'exit'

ret = sftp.wait()
sftp.communicate('exit\n'.encode())

if ret != 0:
if sftp.returncode != 0:
raise errors.PluginError("Couldn't connect to the instance at {url}"
.format(url=sftp_url))

def _upload_tmpfile(self, tmpfile, user, sftp_url, path, destfile, mkdir):

process = ['sftp', '-b', '-',
'-o', 'UserKnownHostsFile={home}/.ssh/known_hosts'.format(home=get_user_environment()['HOME']),
'-o', 'UserKnownHostsFile={home}/.ssh/known_hosts'.format(home=get_user_environment()['HOME']),
'{user}@{sftp_url}'.format(user=user, sftp_url=sftp_url)]

logger.info("sftp %s", process)

sftp = subprocess.Popen(process, stdin=subprocess.PIPE, close_fds=True,
env=get_user_environment())

commands = ''
for p in mkdir:
# sftp will abort if any of the following commands fail:
# get, put, reget, reput, rename, ln, rm, mkdir, chdir, ls, lchdir,
Expand All @@ -273,17 +274,16 @@ def _upload_tmpfile(self, tmpfile, user, sftp_url, path, destfile, mkdir):
# prefixing the command with a '-' character (for example,
# -rm /tmp/blah*).

print >> sftp.stdin, '-mkdir {path}'.format(path=p)
commands += '-mkdir {path}\n'.format(path=p)

print >> sftp.stdin, 'cd {path}'.format(path=path)
print >> sftp.stdin, 'put {tmpfile} {destfile}'.format(
tmpfile=tmpfile, destfile=destfile)
print >> sftp.stdin, 'chmod 444 {destfile}'.format(destfile=destfile)
print >> sftp.stdin, 'exit'
commands += 'cd {path}\n'.format(path=path)
commands += 'put {tmpfile} {destfile}\n'.format(tmpfile=tmpfile, destfile=destfile)
commands += 'chmod 444 {destfile}\n'.format(destfile=destfile)
commands += 'exit\n'

ret = sftp.wait()
sftp.communicate(commands.encode())

if ret != 0:
if sftp.returncode != 0:
raise errors.PluginError("Couldn't place file in domain: {0}"
.format(path))

Expand All @@ -302,18 +302,13 @@ def _patch_htaccess(self, path, user, sftp_url):
sftp = subprocess.Popen(process, stdin=subprocess.PIPE, close_fds=True,
env=get_user_environment())

print >> sftp.stdin, 'cd {path}/.well-known'.format(path=path)
try:
tmpfile = tempfile.mkstemp(suffix='.letsencrypt.gandi.shs')
print >> sftp.stdin, 'get .htaccess {tmpfile}'.format(
tmpfile=tmpfile[1])
print >> sftp.stdin, 'exit'
sftp.wait()
with open(tmpfile[1], 'r') as htaccess:
content = htaccess.read()
finally:
os.close(tmpfile[0])
os.remove(tmpfile[1])
commands = ''
commands += 'cd {path}/.well-known\n'.format(path=path)
with tempfile.NamedTemporaryFile(suffix='.letsencrypt.gandi.shs') as htaccess:
commands += 'get .htaccess {tmpfile}\n'.format(tmpfile=htaccess.name)
commands += 'exit\n'
sftp.communicate(commands.encode())
content = htaccess.read()

if content:
new_content = content + HTACCESS_PATCH
Expand All @@ -323,21 +318,16 @@ def _patch_htaccess(self, path, user, sftp_url):
sftp = subprocess.Popen(process, stdin=subprocess.PIPE, close_fds=True,
env=get_user_environment())

print >> sftp.stdin, 'cd {path}/.well-known'.format(path=path)
try:
# Patch
tmpfile = tempfile.mkstemp(suffix='.letsencrypt.gandi.shs')
os.write(tmpfile[0], new_content)
commands = ''
commands += 'cd {path}/.well-known\n'.format(path=path)
with tempfile.NamedTemporaryFile(suffix='.letsencrypt.gandi.shs') as htaccess:
htaccess.write(new_content.encode())

# Upload with patch
print >> sftp.stdin, 'put {tmpfile} .htaccess'.format(
tmpfile=tmpfile[1])
print >> sftp.stdin, 'chmod 644 .htaccess'
print >> sftp.stdin, 'exit'
sftp.wait()
finally:
os.close(tmpfile[0])
os.remove(tmpfile[1])
commands += 'put {tmpfile} .htaccess\n'.format(tmpfile=htaccess.name)
commands += 'chmod 644 .htaccess\n'
commands += 'exit\n'
sftp.communicate(commands.encode())

return content

Expand All @@ -354,23 +344,19 @@ def _unpatch_htaccess(self, path, user, sftp_url):
sftp = subprocess.Popen(process, stdin=subprocess.PIPE, close_fds=True,
env=get_user_environment())

commands = ''
if not self.htaccess_content:
print >> sftp.stdin, 'cd {path}/.well-known'.format(path=path)
print >> sftp.stdin, '-rm .htaccess'
print >> sftp.stdin, 'exit'
sftp.wait()
commands += 'cd {path}/.well-known\n'.format(path=path)
commands += '-rm .htaccess\n'
commands += 'exit\n'
sftp.communicate(commands.encode())
else:
print >> sftp.stdin, 'cd {path}/.well-known'.format(path=path)
try:
tmpfile = tempfile.mkstemp(suffix='.letsencrypt.gandi.shs')
os.write(tmpfile[0], self.htaccess_content)
print >> sftp.stdin, 'put {tmpfile} .htaccess'.format(
tmpfile=tmpfile[1])
print >> sftp.stdin, 'exit'
sftp.wait()
finally:
os.close(tmpfile[0])
os.remove(tmpfile[1])
commands += 'cd {path}/.well-known\n'.format(path=path)
with tempfile.mkstemp(suffix='.letsencrypt.gandi.shs') as tmpfile:
os.write(tmpfile[0], self.htaccess_content.encode())
commands += 'put {tmpfile} .htaccess\n'.format(tmpfile=tmpfile[1])
commands += 'exit\n'
sftp.communicate(commands.encode())

def cleanup(self, achalls):
"""Revert all challenges."""
Expand All @@ -397,7 +383,8 @@ def _cleanup_one(self, achall, user, sftp_url):
sftp = subprocess.Popen(process, stdin=subprocess.PIPE, close_fds=True,
env=get_user_environment())

print >> sftp.stdin, 'rm {path}'.format(path=path)
commands = ''
commands += 'rm {path}\n'.format(path=path)
for p in dirs:
# sftp will abort if any of the following commands fail:
# get, put, reget, reput, rename, ln, rm, mkdir, chdir, ls, lchdir,
Expand All @@ -406,11 +393,11 @@ def _cleanup_one(self, achall, user, sftp_url):
# prefixing the command with a '-' character (for example,
# -rm /tmp/blah*).

print >> sftp.stdin, 'rmdir {path}'.format(path=p)
commands += '-rmdir {path}\n'.format(path=p)

print >> sftp.stdin, 'exit'
commands += 'exit\n'

sftp.wait()
sftp.communicate(commands.encode())

#
# Installer Section
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
include_package_data=True,
install_requires=install_requires,
entry_points={
'letsencrypt.plugins': [
'certbot.plugins': [
'gandi-shs = letsencrypt_gandi.shs:GandiSHSConfigurator',
],
},
Expand Down