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>
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.
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.
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/>.
27 from argparse import ArgumentParser
32 from .exception import FDroidException
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:
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:
51 global options, config
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()
68 # find root install prefix
69 tmp = os.path.dirname(sys.argv[0])
71 if os.path.basename(tmp) == 'bin':
72 egg_link = os.path.join(tmp, '..', 'local/lib/python2.7/site-packages/fdroidserver.egg-link')
73 if os.path.exists(egg_link):
74 # installed from local git repo
75 examplesdir = os.path.join(open(egg_link).readline().rstrip(), 'examples')
78 examplesdir = os.path.dirname(os.path.dirname(__file__)) + '/share/doc/fdroidserver/examples'
79 if not os.path.exists(examplesdir): # use UNIX layout
80 examplesdir = os.path.dirname(tmp) + '/share/doc/fdroidserver/examples'
82 # we're running straight out of the git repo
83 prefix = os.path.normpath(os.path.join(os.path.dirname(__file__), '..'))
84 examplesdir = prefix + '/examples'
87 fdroiddir = os.getcwd()
89 common.fill_config_defaults(test_config)
91 # track down where the Android SDK is, the default is to use the path set
92 # in ANDROID_HOME if that exists, otherwise None
93 if options.android_home is not None:
94 test_config['sdk_path'] = options.android_home
95 elif not common.test_sdk_exists(test_config):
96 if os.path.isfile('/usr/bin/aapt'):
97 # remove sdk_path and build_tools, they are not required
98 test_config.pop('sdk_path', None)
99 test_config.pop('build_tools', None)
100 # make sure at least aapt is found, since this can't do anything without it
101 test_config['aapt'] = common.find_sdk_tools_cmd('aapt')
103 # if neither --android-home nor the default sdk_path exist, prompt the user
104 default_sdk_path = '/opt/android-sdk'
105 if sys.platform == 'win32' or sys.platform == 'cygwin':
106 default_sdk_path = os.path.join(os.getenv('USERPROFILE'),
107 'AppData', 'Local', 'Android', 'android-sdk')
108 while not options.no_prompt:
110 s = input(_('Enter the path to the Android SDK (%s) here:\n> ') % default_sdk_path)
111 except KeyboardInterrupt:
114 if re.match('^\s*$', s) is not None:
115 test_config['sdk_path'] = default_sdk_path
117 test_config['sdk_path'] = s
118 if common.test_sdk_exists(test_config):
120 if not common.test_sdk_exists(test_config):
121 raise FDroidException("Android SDK not found.")
123 if not os.path.exists('config.py'):
124 # 'metadata' and 'tmp' are created in fdroid
125 if not os.path.exists('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)
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.')
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')
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')
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'] = ''
160 test_config['build_tools'] = dirname
161 common.write_to_config(test_config, 'build_tools')
162 common.ensure_build_tools_exists(test_config)
164 # now that we have a local config.py, read configuration...
165 config = common.read_config(options)
167 # the NDK is optional and there may be multiple versions of it, so it's
168 # left for the user to configure
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']
178 keystore = os.path.abspath(options.keystore)
179 if options.keystore == 'NONE':
180 keystore = options.keystore
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)
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'
208 files = glob.glob('/usr/lib/' + os.uname()[4] + '-*-gnu/opensc-pkcs11.so')
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,
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)
235 msg += _('Built repo based in "%s" with this config:') % fdroiddir
236 msg += '\n\n Android SDK:\t\t\t' + config['sdk_path']
238 msg += '\n Android SDK Build Tools:\t' + os.path.dirname(aapt)
239 msg += '\n Android NDK r12b (optional):\t$ANDROID_NDK'
240 msg += '\n ' + _('Keystore for signing key:\t') + keystore
241 if repo_keyalias is not None:
242 msg += '\n Alias for key in store:\t' + repo_keyalias
243 msg += '\n\n' + '''To complete the setup, add your APKs to "%s"
244 then run "fdroid update -c; fdroid update". You might also want to edit
245 "config.py" to set the URL, repo name, and more. You should also set up
246 a signing key (a temporary one might have been automatically generated).
248 For more info: https://f-droid.org/docs/Setup_an_F-Droid_App_Repo
249 and https://f-droid.org/docs/Signing_Process''' % os.path.join(fdroiddir, 'repo')