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