fdroidserver/init.py

   1 #!/usr/bin/env python3
   2 #
   3 # init.py - part of the FDroid server tools
   4 # Copyright (C) 2010-2013, Ciaran Gultnieks, ciaran@ciarang.com
   5 # Copyright (C) 2013-2014 Daniel Martí <mvdan@mvdan.cc>
   6 # Copyright (C) 2013 Hans-Christoph Steiner <hans@eds.org>
   7 #
   8 # This program is free software: you can redistribute it and/or modify
   9 # it under the terms of the GNU Affero General Public License as published by
  10 # the Free Software Foundation, either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU Affero General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Affero General Public License
  19 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 import glob
  22 import os
  23 import re
  24 import shutil
  25 import socket
  26 import sys
  27 from argparse import ArgumentParser
  28 import logging
  29
  30 from . import _
  31 from . import common
  32 from .exception import FDroidException
  33
  34 config = {}
  35 options = None
  36
  37
  38 def disable_in_config(key, value):
  39     '''write a key/value to the local config.py, then comment it out'''
  40     with open('config.py', 'r', encoding='utf8') as f:
  41         data = f.read()
  42     pattern = '\n[\s#]*' + key + '\s*=\s*"[^"]*"'
  43     repl = '\n#' + key + ' = "' + value + '"'
  44     data = re.sub(pattern, repl, data)
  45     with open('config.py', 'w', encoding='utf8') as f:
  46         f.writelines(data)
  47
  48
  49 def main():
  50
  51     global options, config
  52
  53     # Parse command line...
  54     parser = ArgumentParser()
  55     common.setup_global_opts(parser)
  56     parser.add_argument("-d", "--distinguished-name", default=None,
  57                         help=_("X.509 'Distinguished Name' used when generating keys"))
  58     parser.add_argument("--keystore", default=None,
  59                         help=_("Path to the keystore for the repo signing key"))
  60     parser.add_argument("--repo-keyalias", default=None,
  61                         help=_("Alias of the repo signing key in the keystore"))
  62     parser.add_argument("--android-home", default=None,
  63                         help=_("Path to the Android SDK (sometimes set in ANDROID_HOME)"))
  64     parser.add_argument("--no-prompt", action="store_true", default=False,
  65                         help=_("Do not prompt for Android SDK path, just fail"))
  66     options = parser.parse_args()
  67
  68     aapt = None
  69     fdroiddir = os.getcwd()
  70     test_config = dict()
  71     examplesdir = common.get_examples_dir()
  72     common.fill_config_defaults(test_config)
  73
  74     # track down where the Android SDK is, the default is to use the path set
  75     # in ANDROID_HOME if that exists, otherwise None
  76     if options.android_home is not None:
  77         test_config['sdk_path'] = options.android_home
  78     elif not common.test_sdk_exists(test_config):
  79         if os.path.isfile('/usr/bin/aapt'):
  80             # remove sdk_path and build_tools, they are not required
  81             test_config.pop('sdk_path', None)
  82             test_config.pop('build_tools', None)
  83             # make sure at least aapt is found, since this can't do anything without it
  84             test_config['aapt'] = common.find_sdk_tools_cmd('aapt')
  85         else:
  86             # if neither --android-home nor the default sdk_path
  87             # exist, prompt the user using platform-specific default
  88             default_sdk_path = '/opt/android-sdk'
  89             if sys.platform == 'win32' or sys.platform == 'cygwin':
  90                 p = os.path.join(os.getenv('USERPROFILE'),
  91                                  'AppData', 'Local', 'Android', 'android-sdk')
  92             elif sys.platform == 'darwin':
  93                 # on OSX, Homebrew is common and has an easy path to detect
  94                 p = '/usr/local/opt/android-sdk'
  95             else:
  96                 # if the Debian packages are installed, suggest them
  97                 p = '/usr/lib/android-sdk'
  98             if os.path.exists(p):
  99                 default_sdk_path = p
 100
 101             while not options.no_prompt:
 102                 try:
 103                     s = input(_('Enter the path to the Android SDK (%s) here:\n> ') % default_sdk_path)
 104                 except KeyboardInterrupt:
 105                     print('')
 106                     sys.exit(1)
 107                 if re.match('^\s*$', s) is not None:
 108                     test_config['sdk_path'] = default_sdk_path
 109                 else:
 110                     test_config['sdk_path'] = s
 111                 if common.test_sdk_exists(test_config):
 112                     break
 113     if not common.test_sdk_exists(test_config):
 114         raise FDroidException("Android SDK not found.")
 115
 116     if not os.path.exists('config.py'):
 117         # 'metadata' and 'tmp' are created in fdroid
 118         if not os.path.exists('repo'):
 119             os.mkdir('repo')
 120         shutil.copy(os.path.join(examplesdir, 'fdroid-icon.png'), fdroiddir)
 121         shutil.copyfile(os.path.join(examplesdir, 'config.py'), 'config.py')
 122         os.chmod('config.py', 0o0600)
 123         # If android_home is None, test_config['sdk_path'] will be used and
 124         # "$ANDROID_HOME" may be used if the env var is set up correctly.
 125         # If android_home is not None, the path given from the command line
 126         # will be directly written in the config.
 127         if 'sdk_path' in test_config:
 128             common.write_to_config(test_config, 'sdk_path', options.android_home)
 129     else:
 130         logging.warn('Looks like this is already an F-Droid repo, cowardly refusing to overwrite it...')
 131         logging.info('Try running `fdroid init` in an empty directory.')
 132         raise FDroidException('Repository already exists.')
 133
 134     if 'aapt' not in test_config or not os.path.isfile(test_config['aapt']):
 135         # try to find a working aapt, in all the recent possible paths
 136         build_tools = os.path.join(test_config['sdk_path'], 'build-tools')
 137         aaptdirs = []
 138         aaptdirs.append(os.path.join(build_tools, test_config['build_tools']))
 139         aaptdirs.append(build_tools)
 140         for f in os.listdir(build_tools):
 141             if os.path.isdir(os.path.join(build_tools, f)):
 142                 aaptdirs.append(os.path.join(build_tools, f))
 143         for d in sorted(aaptdirs, reverse=True):
 144             if os.path.isfile(os.path.join(d, 'aapt')):
 145                 aapt = os.path.join(d, 'aapt')
 146                 break
 147         if os.path.isfile(aapt):
 148             dirname = os.path.basename(os.path.dirname(aapt))
 149             if dirname == 'build-tools':
 150                 # this is the old layout, before versioned build-tools
 151                 test_config['build_tools'] = ''
 152             else:
 153                 test_config['build_tools'] = dirname
 154             common.write_to_config(test_config, 'build_tools')
 155         common.ensure_build_tools_exists(test_config)
 156
 157     # now that we have a local config.py, read configuration...
 158     config = common.read_config(options)
 159
 160     # the NDK is optional and there may be multiple versions of it, so it's
 161     # left for the user to configure
 162
 163     # find or generate the keystore for the repo signing key. First try the
 164     # path written in the default config.py.  Then check if the user has
 165     # specified a path from the command line, which will trump all others.
 166     # Otherwise, create ~/.local/share/fdroidserver and stick it in there.  If
 167     # keystore is set to NONE, that means that Java will look for keys in a
 168     # Hardware Security Module aka Smartcard.
 169     keystore = config['keystore']
 170     if options.keystore:
 171         keystore = os.path.abspath(options.keystore)
 172         if options.keystore == 'NONE':
 173             keystore = options.keystore
 174         else:
 175             keystore = os.path.abspath(options.keystore)
 176             if not os.path.exists(keystore):
 177                 logging.info('"' + keystore
 178                              + '" does not exist, creating a new keystore there.')
 179     common.write_to_config(test_config, 'keystore', keystore)
 180     repo_keyalias = None
 181     keydname = None
 182     if options.repo_keyalias:
 183         repo_keyalias = options.repo_keyalias
 184         common.write_to_config(test_config, 'repo_keyalias', repo_keyalias)
 185     if options.distinguished_name:
 186         keydname = options.distinguished_name
 187         common.write_to_config(test_config, 'keydname', keydname)
 188     if keystore == 'NONE':  # we're using a smartcard
 189         common.write_to_config(test_config, 'repo_keyalias', '1')  # seems to be the default
 190         disable_in_config('keypass', 'never used with smartcard')
 191         common.write_to_config(test_config, 'smartcardoptions',
 192                                ('-storetype PKCS11 -providerName SunPKCS11-OpenSC '
 193                                 + '-providerClass sun.security.pkcs11.SunPKCS11 '
 194                                 + '-providerArg opensc-fdroid.cfg'))
 195         # find opensc-pkcs11.so
 196         if not os.path.exists('opensc-fdroid.cfg'):
 197             if os.path.exists('/usr/lib/opensc-pkcs11.so'):
 198                 opensc_so = '/usr/lib/opensc-pkcs11.so'
 199             elif os.path.exists('/usr/lib64/opensc-pkcs11.so'):
 200                 opensc_so = '/usr/lib64/opensc-pkcs11.so'
 201             else:
 202                 files = glob.glob('/usr/lib/' + os.uname()[4] + '-*-gnu/opensc-pkcs11.so')
 203                 if len(files) > 0:
 204                     opensc_so = files[0]
 205                 else:
 206                     opensc_so = '/usr/lib/opensc-pkcs11.so'
 207                     logging.warn('No OpenSC PKCS#11 module found, ' +
 208                                  'install OpenSC then edit "opensc-fdroid.cfg"!')
 209             with open(os.path.join(examplesdir, 'opensc-fdroid.cfg'), 'r') as f:
 210                 opensc_fdroid = f.read()
 211             opensc_fdroid = re.sub('^library.*', 'library = ' + opensc_so, opensc_fdroid,
 212                                    flags=re.MULTILINE)
 213             with open('opensc-fdroid.cfg', 'w') as f:
 214                 f.write(opensc_fdroid)
 215     elif os.path.exists(keystore):
 216         to_set = ['keystorepass', 'keypass', 'repo_keyalias', 'keydname']
 217         if repo_keyalias:
 218             to_set.remove('repo_keyalias')
 219         if keydname:
 220             to_set.remove('keydname')
 221         logging.warning('\n' + _('Using existing keystore "{path}"').format(path=keystore)
 222                         + '\n' + _('Now set these in config.py:') + ' '
 223                         + ', '.join(to_set) + '\n')
 224     else:
 225         password = common.genpassword()
 226         c = dict(test_config)
 227         c['keystorepass'] = password
 228         c['keypass'] = password
 229         c['repo_keyalias'] = socket.getfqdn()
 230         c['keydname'] = 'CN=' + c['repo_keyalias'] + ', OU=F-Droid'
 231         common.write_to_config(test_config, 'keystorepass', password)
 232         common.write_to_config(test_config, 'keypass', password)
 233         common.write_to_config(test_config, 'repo_keyalias', c['repo_keyalias'])
 234         common.write_to_config(test_config, 'keydname', c['keydname'])
 235         common.genkeystore(c)
 236
 237     msg = '\n'
 238     msg += _('Built repo based in "%s" with this config:') % fdroiddir
 239     msg += '\n\n  Android SDK:\t\t\t' + config['sdk_path']
 240     if aapt:
 241         msg += '\n  Android SDK Build Tools:\t' + os.path.dirname(aapt)
 242     msg += '\n  Android NDK r12b (optional):\t$ANDROID_NDK'
 243     msg += '\n  ' + _('Keystore for signing key:\t') + keystore
 244     if repo_keyalias is not None:
 245         msg += '\n  Alias for key in store:\t' + repo_keyalias
 246     msg += '\n\n' + '''To complete the setup, add your APKs to "%s"
 247 then run "fdroid update -c; fdroid update".  You might also want to edit
 248 "config.py" to set the URL, repo name, and more.  You should also set up
 249 a signing key (a temporary one might have been automatically generated).
 250
 251 For more info: https://f-droid.org/docs/Setup_an_F-Droid_App_Repo
 252 and https://f-droid.org/docs/Signing_Process''' % os.path.join(fdroiddir, 'repo')
 253     logging.info(msg)