blob: b72da7bde20c6d34c05e852b5b85da99cd9b2292 [file] [log] [blame]
Mao Huang700663d2015-08-12 09:58:59 +08001# Copyright 2015 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5"""The DRM Keys Provisioning Server (DKPS) implementation."""
6
7# TODO(littlecvr): Implement "without filter mode", which lets OEM encrypts DRM
8# keys directly with ODM's public key, and the key server
9# merely stores them without knowing anything about them.
10
11# TODO(littlecvr): Allow using pre-generated server GPG key when initializing.
12
13import argparse
Mao Huang9076f632015-09-24 17:38:47 +080014import hashlib
Mao Huang700663d2015-08-12 09:58:59 +080015import imp
16import json
Mao Huang041483e2015-09-14 23:28:18 +080017import logging
Mao Huang700663d2015-08-12 09:58:59 +080018import os
19import shutil
20import SimpleXMLRPCServer
21import sqlite3
Mao Huang041483e2015-09-14 23:28:18 +080022import sys
Mao Huang700663d2015-08-12 09:58:59 +080023import textwrap
24
25import gnupg
26
27
28SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
Mao Huang041483e2015-09-14 23:28:18 +080029LOG_FILE_PATH = os.path.join(SCRIPT_DIR, 'dkps.log')
Mao Huang700663d2015-08-12 09:58:59 +080030FILTERS_DIR = os.path.join(SCRIPT_DIR, 'filters')
Mao Huang9076f632015-09-24 17:38:47 +080031PARSERS_DIR = os.path.join(SCRIPT_DIR, 'parsers')
Mao Huang700663d2015-08-12 09:58:59 +080032CREATE_DATABASE_SQL_FILE_PATH = os.path.join(
33 SCRIPT_DIR, 'sql', 'create_database.sql')
34
35
36class ProjectNotFoundException(ValueError):
37 """Raised when no project was found in the database."""
38 pass
39
40
41class InvalidUploaderException(ValueError):
42 """Raised when the signature of the uploader can't be verified."""
43 pass
44
45
46class InvalidRequesterException(ValueError):
47 """Raised when the signature of the requester can't be verified."""
48 pass
49
50
51def GetSQLite3Connection(database_file_path):
52 """Returns a tuple of SQLite3's (connection, cursor) to database_file_path.
53
54 If the connection has been created before, it is returned directly. If it's
55 not, this function creates the connection, ensures that the foreign key
56 constraint is enabled, and returns.
57
58 Args:
59 database_file_path: path to the SQLite3 database file.
60 """
61 database_file_path = os.path.realpath(database_file_path)
62
63 # Return if the connection to database_file_path has been created before.
64 try:
65 connection = GetSQLite3Connection.connection_dict[database_file_path]
66 return (connection, connection.cursor())
67 except KeyError:
68 pass
69 except AttributeError:
70 GetSQLite3Connection.connection_dict = {}
71
72 # Create connection.
73 connection = sqlite3.connect(database_file_path)
74 connection.row_factory = sqlite3.Row
75 cursor = connection.cursor()
76
77 # Enable foreign key constraint since SQLite3 disables it by default.
78 cursor.execute('PRAGMA foreign_keys = ON')
79 # Check if foreign key constraint is enabled.
80 cursor.execute('PRAGMA foreign_keys')
81 if cursor.fetchone()[0] != 1:
82 raise RuntimeError('Failed to enable SQLite3 foreign key constraint')
83
84 GetSQLite3Connection.connection_dict[database_file_path] = connection
85
86 return (connection, cursor)
87
88
89class DRMKeysProvisioningServer(object):
90 """The DRM Keys Provisioning Server (DKPS) class."""
91
92 def __init__(self, database_file_path, gnupg_homedir):
93 """DKPS constructor.
94
95 Args:
96 database_file_path: path to the SQLite3 database file.
97 gnupg_homedir: path to the GnuPG home directory.
98 """
99 self.database_file_path = database_file_path
100 self.gnupg_homedir = gnupg_homedir
101
102 if not os.path.isdir(self.gnupg_homedir):
103 self.gpg = None
104 else:
105 self.gpg = gnupg.GPG(gnupghome=self.gnupg_homedir)
106
107 if not os.path.isfile(self.database_file_path):
108 self.db_connection, self.db_cursor = (None, None)
109 else:
110 self.db_connection, self.db_cursor = GetSQLite3Connection(
111 self.database_file_path)
112
Mao Huang3963b372015-12-11 15:20:19 +0800113 def Initialize(self, gpg_gen_key_args_dict=None, server_key_file_path=None):
114 """Creates the SQLite3 database and GnuPG home, and imports, or generates a
115 GPG key for the server to use.
Mao Huang700663d2015-08-12 09:58:59 +0800116
117 Args:
118 gpg_gen_key_args_dict: will be passed directly as the keyword arguments to
Mao Huang3963b372015-12-11 15:20:19 +0800119 python-gnupg's gen_key() function if server_key_file_path is None.
120 Can be used to customize the key generator process, such as key_type,
121 key_length, etc. See python-gnupg's doc for what can be customized.
122 server_key_file_path: path to the server key to use. If not None, the
123 system will simply import this key and use it as the server key; if
124 None, the system will generate a new key.
Mao Huang700663d2015-08-12 09:58:59 +0800125
126 Raises:
127 RuntimeError is the database and GnuPG home have already been initialized.
128 """
Mao Huang700663d2015-08-12 09:58:59 +0800129 # Create GPG instance and database connection.
130 self.gpg = gnupg.GPG(gnupghome=self.gnupg_homedir)
131 self.db_connection, self.db_cursor = GetSQLite3Connection(
132 self.database_file_path)
133
Mao Huang3963b372015-12-11 15:20:19 +0800134 # If any key exists, the system has already been initialized.
135 if self.gpg.list_keys():
136 raise RuntimeError('Already initialized')
Mao Huang700663d2015-08-12 09:58:59 +0800137
Mao Huang3963b372015-12-11 15:20:19 +0800138 if server_key_file_path: # use existing key
139 server_key_fingerprint, _ = self._ImportGPGKey(server_key_file_path)
140 else: # generate a new GPG key
141 if gpg_gen_key_args_dict is None:
142 gpg_gen_key_args_dict = {}
143 if 'name_real' not in gpg_gen_key_args_dict:
144 gpg_gen_key_args_dict['name_real'] = 'DKPS Server'
145 if 'name_email' not in gpg_gen_key_args_dict:
146 gpg_gen_key_args_dict['name_email'] = 'chromeos-factory-dkps@google.com'
147 if 'name_comment' not in gpg_gen_key_args_dict:
148 gpg_gen_key_args_dict['name_comment'] = 'DRM Keys Provisioning Server'
149 key_input_data = self.gpg.gen_key_input(**gpg_gen_key_args_dict)
150 server_key_fingerprint = self.gpg.gen_key(key_input_data).fingerprint
Mao Huang700663d2015-08-12 09:58:59 +0800151
152 # Create and set up the schema of the database.
153 with open(CREATE_DATABASE_SQL_FILE_PATH) as f:
154 create_database_sql = f.read()
155 with self.db_connection:
156 self.db_cursor.executescript(create_database_sql)
157
158 # Record the server key fingerprint.
159 with self.db_connection:
160 self.db_cursor.execute(
161 'INSERT INTO settings (key, value) VALUES (?, ?)',
Mao Huang3963b372015-12-11 15:20:19 +0800162 ('server_key_fingerprint', server_key_fingerprint))
Mao Huang700663d2015-08-12 09:58:59 +0800163
164 def Destroy(self):
165 """Destroys the database and GnuPG home directory.
166
167 This is the opposite of Initialize(). It essentially removes the SQLite3
168 database file and GnuPG home directory.
169 """
170 # Remove database.
171 if self.db_connection:
172 self.db_connection.close()
173 if os.path.exists(self.database_file_path):
174 os.remove(self.database_file_path)
175
176 # Remove GnuPG home.
177 if self.gpg:
178 self.gpg = None
179 if os.path.exists(self.gnupg_homedir):
180 shutil.rmtree(self.gnupg_homedir)
181
182 def AddProject(self, name, uploader_key_file_path, requester_key_file_path,
Mao Huang9076f632015-09-24 17:38:47 +0800183 parser_module_file_name, filter_module_file_name=None):
Mao Huang700663d2015-08-12 09:58:59 +0800184 """Adds a project.
185
186 Args:
187 name: name of the project, must be unique.
188 uploader_key_file_path: path to the OEM's public key file.
189 requester_key_file_path: path to the ODM's public key file.
Mao Huang9076f632015-09-24 17:38:47 +0800190 parser_module_file_name: file name of the parser python module.
Mao Huang700663d2015-08-12 09:58:59 +0800191 filter_module_file_name: file name of the filter python module.
192
193 Raises:
194 ValueError if either the uploader's or requester's key are imported (which
195 means they are used by another project).
196 """
Mao Huang9076f632015-09-24 17:38:47 +0800197 # Try to load the parser and filter modules.
198 self._LoadParserModule(parser_module_file_name)
Mao Huang700663d2015-08-12 09:58:59 +0800199 if filter_module_file_name is not None:
200 self._LoadFilterModule(filter_module_file_name)
201
202 # Try to import uploader and requester keys and add project info into the
203 # database, if failed at any step, delete imported keys.
204 uploader_key_fingerprint, requester_key_fingerprint = (None, None)
205 uploader_key_already_exists, requester_key_already_exists = (False, False)
206 try:
207 uploader_key_fingerprint, uploader_key_already_exists = (
208 self._ImportGPGKey(uploader_key_file_path))
209 if uploader_key_already_exists:
210 raise ValueError('Uploader key already exists')
211 requester_key_fingerprint, requester_key_already_exists = (
212 self._ImportGPGKey(requester_key_file_path))
213 if requester_key_already_exists:
214 raise ValueError('Requester key already exists')
215 with self.db_connection:
216 self.db_cursor.execute(
Mao Huang9076f632015-09-24 17:38:47 +0800217 'INSERT INTO projects ('
218 ' name, uploader_key_fingerprint, requester_key_fingerprint, '
219 ' parser_module_file_name, filter_module_file_name) '
220 'VALUES (?, ?, ?, ?, ?)',
Mao Huang700663d2015-08-12 09:58:59 +0800221 (name, uploader_key_fingerprint, requester_key_fingerprint,
Mao Huang9076f632015-09-24 17:38:47 +0800222 parser_module_file_name, filter_module_file_name))
Mao Huang700663d2015-08-12 09:58:59 +0800223 except BaseException:
224 if not uploader_key_already_exists and uploader_key_fingerprint:
225 self.gpg.delete_keys(uploader_key_fingerprint)
226 if not requester_key_already_exists and requester_key_fingerprint:
227 self.gpg.delete_keys(requester_key_fingerprint)
228 raise
229
230 def UpdateProject(self, name, uploader_key_file_path=None,
231 requester_key_file_path=None, filter_module_file_name=None):
232 """Updates a project.
233
234 Args:
235 name: name of the project, must be unique.
236 uploader_key_file_path: path to the OEM's public key file.
237 requester_key_file_path: path to the ODM's public key file.
238 filter_module_file_name: file name of the filter python module.
239
240 Raises:
241 RuntimeError if SQLite3 can't update the project row (for any reason).
242 """
243 # Try to load the filter module.
244 if filter_module_file_name is not None:
245 self._LoadFilterModule(filter_module_file_name)
246
247 project = self._FetchProjectByName(name)
248
249 # Try to import uploader and requester keys and add project info into the
250 # database, if failed at any step, delete any newly imported keys.
251 uploader_key_fingerprint, requester_key_fingerprint = (None, None)
252 old_uploader_key_fingerprint = project['uploader_key_fingerprint']
253 old_requester_key_fingerprint = project['requester_key_fingerprint']
254 same_uploader_key, same_requester_key = (True, True)
255 try:
256 sql_set_clause_list = ['filter_module_file_name = ?']
257 sql_parameters = [filter_module_file_name]
258
259 if uploader_key_file_path:
260 uploader_key_fingerprint, same_uploader_key = self._ImportGPGKey(
261 uploader_key_file_path)
262 sql_set_clause_list.append('uploader_key_fingerprint = ?')
263 sql_parameters.append(uploader_key_fingerprint)
264
265 if requester_key_file_path:
266 requester_key_fingerprint, same_requester_key = self._ImportGPGKey(
267 uploader_key_file_path)
268 sql_set_clause_list.append('requester_key_fingerprint = ?')
269 sql_parameters.append(requester_key_fingerprint)
270
271 sql_set_clause = ','.join(sql_set_clause_list)
272 sql_parameters.append(name)
273 with self.db_connection:
274 self.db_cursor.execute(
275 'UPDATE projects SET %s WHERE name = ?' % sql_set_clause,
276 tuple(sql_parameters))
277 if self.db_cursor.rowcount != 1:
278 raise RuntimeError('Failed to update project %s' % name)
279 except BaseException:
280 if not same_uploader_key and uploader_key_fingerprint:
281 self.gpg.delete_keys(uploader_key_fingerprint)
282 if not same_requester_key and requester_key_fingerprint:
283 self.gpg.delete_keys(requester_key_fingerprint)
284 raise
285
286 if not same_uploader_key:
287 self.gpg.delete_keys(old_uploader_key_fingerprint)
288 if not same_requester_key:
289 self.gpg.delete_keys(old_requester_key_fingerprint)
290
291 def RemoveProject(self, name):
292 """Removes a project.
293
294 Args:
295 name: the name of the project specified when added.
296 """
297 project = self._FetchProjectByName(name)
298
299 self.gpg.delete_keys(project['uploader_key_fingerprint'])
300 self.gpg.delete_keys(project['requester_key_fingerprint'])
301
302 with self.db_connection:
303 self.db_cursor.execute(
304 'DELETE FROM drm_keys WHERE project_name = ?', (name,))
305 self.db_cursor.execute('DELETE FROM projects WHERE name = ?', (name,))
306
307 def ListProjects(self):
308 """Lists all projects."""
309 self.db_cursor.execute('SELECT * FROM projects ORDER BY name ASC')
310 return self.db_cursor.fetchall()
311
312 def Upload(self, encrypted_serialized_drm_keys):
313 """Uploads a list of DRM keys to the server. This is an atomic operation. It
314 will either succeed and save all the keys, or fail and save no keys.
315
316 Args:
317 encrypted_serialized_drm_keys: the serialized DRM keys signed by the
318 uploader and encrypted by the server's public key.
319
320 Raises:
321 InvalidUploaderException if the signature of the uploader can not be
322 verified.
323 """
324 decrypted_obj = self.gpg.decrypt(encrypted_serialized_drm_keys)
325 project = self._FetchProjectByUploaderKeyFingerprint(
326 decrypted_obj.fingerprint)
327 serialized_drm_keys = decrypted_obj.data
328
Mao Huang9076f632015-09-24 17:38:47 +0800329 # Pass to the parse function.
330 parser_module = self._LoadParserModule(project['parser_module_file_name'])
331 drm_key_list = parser_module.Parse(serialized_drm_keys)
332
333 drm_key_hash_list = []
334 for drm_key in drm_key_list:
335 drm_key_hash_list.append(hashlib.sha1(json.dumps(drm_key)).hexdigest())
336
Mao Huang700663d2015-08-12 09:58:59 +0800337 # Pass to the filter function.
338 filter_module = self._LoadFilterModule(project['filter_module_file_name'])
Mao Huang9076f632015-09-24 17:38:47 +0800339 filtered_drm_key_list = filter_module.Filter(drm_key_list)
Mao Huang700663d2015-08-12 09:58:59 +0800340
341 # Fetch server key for signing.
342 server_key_fingerprint = self._FetchServerKeyFingerprint()
343
344 # Sign and encrypt each key by server's private key and requester's public
345 # key, respectively.
346 encrypted_serialized_drm_key_list = []
347 requester_key_fingerprint = project['requester_key_fingerprint']
348 for drm_key in filtered_drm_key_list:
349 encrypted_obj = self.gpg.encrypt(
350 json.dumps(drm_key), requester_key_fingerprint,
351 always_trust=True, sign=server_key_fingerprint)
352 encrypted_serialized_drm_key_list.append(encrypted_obj.data)
353
354 # Insert into the database.
355 with self.db_connection:
356 self.db_cursor.executemany(
Mao Huang9076f632015-09-24 17:38:47 +0800357 'INSERT INTO drm_keys ('
358 ' project_name, drm_key_hash, encrypted_drm_key) '
359 'VALUES (?, ?, ?)',
Mao Huang700663d2015-08-12 09:58:59 +0800360 zip([project['name']] * len(encrypted_serialized_drm_key_list),
Mao Huang9076f632015-09-24 17:38:47 +0800361 drm_key_hash_list, encrypted_serialized_drm_key_list))
Mao Huang700663d2015-08-12 09:58:59 +0800362
363 def AvailableKeyCount(self, requester_signature):
364 """Queries the number of remaining keys.
365
366 Args:
367 requester_signature: a message signed by the requester. Since the server
368 doesn't need any additional info from the requester, the requester can
369 simply sign a random string and send it here.
370
371 Returns:
372 The number of remaining keys that can be requested.
373
374 Raises:
375 InvalidRequesterException if the signature of the requester can not be
376 verified.
377 """
378 verified = self.gpg.verify(requester_signature)
379 if not verified:
380 raise InvalidRequesterException(
381 'Invalid requester, check your signing key')
382
383 project = self._FetchProjectByRequesterKeyFingerprint(verified.fingerprint)
384
385 self.db_cursor.execute(
386 'SELECT COUNT(*) AS available_key_count FROM drm_keys '
387 'WHERE project_name = ? AND device_serial_number IS NULL',
388 (project['name'],))
389 return self.db_cursor.fetchone()['available_key_count']
390
391 def Request(self, encrypted_device_serial_number):
392 """Requests a DRM key by device serial number.
393
394 Args:
395 encrypted_device_serial_number: the device serial number signed by the
396 requester and encrypted by the server's public key.
397
398 Raises:
399 InvalidRequesterException if the signature of the requester can not be
400 verified. RuntimeError if no available keys left in the database.
401 """
402 decrypted_obj = self.gpg.decrypt(encrypted_device_serial_number)
403 project = self._FetchProjectByRequesterKeyFingerprint(
404 decrypted_obj.fingerprint)
405 device_serial_number = decrypted_obj.data
406
407 def FetchDRMKeyByDeviceSerialNumber(project_name, device_serial_number):
408 self.db_cursor.execute(
409 'SELECT * FROM drm_keys WHERE project_name = ? AND '
410 'device_serial_number = ?',
411 (project_name, device_serial_number))
412 return self.db_cursor.fetchone()
413
414 row = FetchDRMKeyByDeviceSerialNumber(project['name'], device_serial_number)
415 if row: # the SN has already paired
416 return row['encrypted_drm_key']
417
418 # Find an unpaired key.
419 with self.db_connection:
420 # SQLite3 does not support using LIMIT clause in UPDATE statement by
421 # default, unless SQLITE_ENABLE_UPDATE_DELETE_LIMIT flag is defined during
422 # compilation. Since this script may be deployed on partner's computer,
423 # we'd better assume they don't have this flag on.
424 self.db_cursor.execute(
425 'UPDATE drm_keys SET device_serial_number = ? '
426 'WHERE id = (SELECT id FROM drm_keys WHERE project_name = ? AND '
427 ' device_serial_number IS NULL LIMIT 1)',
428 (device_serial_number, project['name']))
429 if self.db_cursor.rowcount != 1: # insufficient keys
430 raise RuntimeError(
431 'Insufficient DRM keys, ask for the OEM to upload more')
432
433 row = FetchDRMKeyByDeviceSerialNumber(project['name'], device_serial_number)
434 if row:
435 return row['encrypted_drm_key']
436 else:
437 raise RuntimeError('Failed to find paired DRM key')
438
439 def ListenForever(self, ip, port):
440 """Starts the XML RPC server waiting for commands.
441
442 Args:
443 ip: IP to bind.
444 port: port to bind.
445 """
446 server = SimpleXMLRPCServer.SimpleXMLRPCServer((ip, port), allow_none=True)
447
448 server.register_introspection_functions()
449 server.register_function(self.AvailableKeyCount)
450 server.register_function(self.Upload)
451 server.register_function(self.Request)
452
Mao Huang041483e2015-09-14 23:28:18 +0800453 # Redirect stdout and stderr to log file.
454 log_file = open(LOG_FILE_PATH, 'a')
455 sys.stdout = log_file
456 sys.stderr = log_file
457
Mao Huang700663d2015-08-12 09:58:59 +0800458 server.serve_forever()
459
460 def _ImportGPGKey(self, key_file_path):
461 """Imports a GPG key from a file.
462
463 Args:
464 key_file_path: path to the GPG key file.
465
466 Returns:
467 A tuple (key_fingerprint, key_already_exists). The 1st element is the
468 imported key's fingerprint, and the 2nd element is True if the key was
469 already in the database before importing, False otherwise.
470 """
471 with open(key_file_path) as f:
472 import_results = self.gpg.import_keys(f.read())
473 key_already_exists = (import_results.imported == 0)
474 key_fingerprint = import_results.fingerprints[0]
475 return (key_fingerprint, key_already_exists)
476
477 def _LoadFilterModule(self, filter_module_file_name):
478 """Loads the filter module.
479
480 Args:
Mao Huang9076f632015-09-24 17:38:47 +0800481 filter_module_file_name: file name of the filter module in FILTERS_DIR.
Mao Huang700663d2015-08-12 09:58:59 +0800482
483 Returns:
484 The loaded filter module on success.
485
486 Raises:
487 Exception if failed, see imp.load_source()'s doc for what could be raised.
488 """
489 return imp.load_source(
490 'filter_module', os.path.join(FILTERS_DIR, filter_module_file_name))
491
Mao Huang9076f632015-09-24 17:38:47 +0800492 def _LoadParserModule(self, parser_module_file_name):
493 """Loads the parser module.
494
495 Args:
496 parser_module_file_name: file name of the parser module in PARSERS_DIR.
497
498 Returns:
499 The loaded parser module on success.
500
501 Raises:
502 Exception if failed, see imp.load_source()'s doc for what could be raised.
503 """
504 return imp.load_source(
505 'parser_module', os.path.join(PARSERS_DIR, parser_module_file_name))
506
Mao Huang700663d2015-08-12 09:58:59 +0800507 def _FetchServerKeyFingerprint(self):
508 """Returns the server GPG key's fingerprint."""
509 self.db_cursor.execute(
510 "SELECT * FROM settings WHERE key = 'server_key_fingerprint'")
511 row = self.db_cursor.fetchone()
512 if not row:
513 raise ValueError('Server key fingerprint not exists')
514 return row['value']
515
516 def _FetchOneProject(self, name=None, # pylint: disable=W0613
517 uploader_key_fingerprint=None, # pylint: disable=W0613
518 requester_key_fingerprint=None, # pylint: disable=W0613
519 exception_type=None, error_msg=None):
520 """Fetches the project by name, uploader key fingerprint, or requester key
521 fingerprint.
522
523 This function combines the name, uploader_key_fingerprint,
524 requester_key_fingerprint conditions (if not None) with the AND operator,
525 and tries to fetch one project from the database.
526
527 Args:
528 name: name of the project.
529 uploader_key_fingerprint: uploader key fingerprint of the project.
530 requester_key_fingerprint: requester key fingerprint of the project.
531 exception_type: if no project was found and exception_type is not None,
532 raise exception_type with error_msg.
533 error_msg: if no project was found and exception_type is not None, raise
534 exception_type with error_msg.
535
536 Returns:
537 A project that matches the name, uploader_key_fingerprint, and
538 requester_key_fingerprint conditiions.
539
540 Raises:
541 exception_type with error_msg if not project was found.
542 """
543 where_clause_list = []
544 params = []
545 local_vars = locals()
546 for param_name in ['name', 'uploader_key_fingerprint',
547 'requester_key_fingerprint']:
548 if local_vars[param_name] is not None:
549 where_clause_list.append('%s = ?' % param_name)
550 params.append(locals()[param_name])
551 if not where_clause_list:
552 raise ValueError('No conditions given to fetch the project')
553 where_clause = 'WHERE ' + ' AND '.join(where_clause_list)
554
555 self.db_cursor.execute(
556 'SELECT * FROM projects %s' % where_clause, tuple(params))
557 project = self.db_cursor.fetchone()
558
559 if not project and exception_type:
560 raise exception_type(error_msg)
561
562 return project
563
564 def _FetchProjectByName(self, name):
565 return self._FetchOneProject(
566 name=name, exception_type=ProjectNotFoundException,
567 error_msg=('Project %s not found' % name))
568
569 def _FetchProjectByUploaderKeyFingerprint(self, uploader_key_fingerprint):
570 return self._FetchOneProject(
571 uploader_key_fingerprint=uploader_key_fingerprint,
572 exception_type=InvalidUploaderException,
573 error_msg='Invalid uploader, check your signing key')
574
575 def _FetchProjectByRequesterKeyFingerprint(self, requester_key_fingerprint):
576 return self._FetchOneProject(
577 requester_key_fingerprint=requester_key_fingerprint,
578 exception_type=InvalidRequesterException,
579 error_msg='Invalid requester, check your signing key')
580
581
582def _ParseArguments():
583 parser = argparse.ArgumentParser()
584 parser.add_argument(
585 '-d', '--database_file_path', default=os.path.join(SCRIPT_DIR, 'dkps.db'),
586 help='path to the SQLite3 database file, default to "dkps.db" in the '
587 'same directory of this script')
588 parser.add_argument(
589 '-g', '--gnupg_homedir', default=os.path.join(SCRIPT_DIR, 'gnupg'),
590 help='path to the GnuGP home directory, default to "gnupg" in the same '
591 'directory of this script')
592 subparsers = parser.add_subparsers(dest='command')
593
594 parser_add = subparsers.add_parser('add', help='adds a new project')
595 parser_add.add_argument('-n', '--name', required=True,
596 help='name of the new project')
597 parser_add.add_argument('-u', '--uploader_key_file_path', required=True,
598 help="path to the uploader's public key file")
599 parser_add.add_argument('-r', '--requester_key_file_path', required=True,
600 help="path to the requester's public key file")
Mao Huang9076f632015-09-24 17:38:47 +0800601 parser_add.add_argument('-p', '--parser_module_file_name', required=True,
602 help='file name of the parser module')
Mao Huang700663d2015-08-12 09:58:59 +0800603 parser_add.add_argument('-f', '--filter_module_file_name', default=None,
604 help='file name of the filter module')
605
606 subparsers.add_parser('destroy', help='destroys the database')
607
608 parser_update = subparsers.add_parser('update',
609 help='updates an existing project')
610 parser_update.add_argument('-n', '--name', required=True,
611 help='name of the project')
612 parser_update.add_argument('-u', '--uploader_key_file_path', default=None,
613 help="path to the uploader's public key file")
614 parser_update.add_argument('-r', '--requester_key_file_path', default=None,
615 help="path to the requester's public key file")
616 parser_update.add_argument('-f', '--filter_module_file_name', default=None,
617 help='file name of the filter module')
618
619 parser_init = subparsers.add_parser('init', help='initializes the database')
620 parser_init.add_argument(
621 '-g', '--gpg_gen_key_args', action='append', nargs=2, default={},
622 help='arguments to use when generating GPG key for server')
623
624 subparsers.add_parser('list', help='lists all projects')
625
626 parser_listen = subparsers.add_parser(
627 'listen', help='starts the server, waiting for upload or request keys')
628 parser_listen.add_argument(
629 '--ip', default='0.0.0.0', help='IP to bind, default to 0.0.0.0')
630 parser_listen.add_argument(
631 '--port', type=int, default=5438, help='port to listen, default to 5438')
632
633 parser_rm = subparsers.add_parser('rm', help='removes an existing project')
634 parser_rm.add_argument('-n', '--name', required=True,
635 help='name of the project to remove')
636
637 return parser.parse_args()
638
639
640def main():
641 args = _ParseArguments()
642
Mao Huang041483e2015-09-14 23:28:18 +0800643 # TODO(littlecvr): Customizable logging level.
644 # TODO(littlecvr): Also print on stdout if it's not running in background.
645 logging.basicConfig(
646 filename=LOG_FILE_PATH,
647 format='%(asctime)s:%(levelname)s:%(funcName)s:%(lineno)d:%(message)s',
648 level=logging.DEBUG)
649 logging.debug('Parsed arguments: %r', args)
650
Mao Huang700663d2015-08-12 09:58:59 +0800651 dkps = DRMKeysProvisioningServer(args.database_file_path, args.gnupg_homedir)
652 if args.command == 'init':
653 # Convert from command line arguments to a dict.
654 gpg_gen_key_args_dict = {}
655 for pair in args.gpg_gen_key_args:
656 gpg_gen_key_args_dict[pair[0]] = pair[1]
657 dkps.Initialize(gpg_gen_key_args_dict)
658 elif args.command == 'destroy':
659 message = (
660 'This action will remove all projects and keys information and is NOT '
661 'recoverable! Are you sure? (y/N)')
662 answer = raw_input(textwrap.fill(message, 80) + ' ')
663 if answer.lower() != 'y' and answer.lower() != 'yes':
664 print 'OK, nothing will be removed.'
665 else:
666 print 'Removing all projects and keys information...',
667 dkps.Destroy()
668 print 'done.'
669 elif args.command == 'listen':
670 dkps.ListenForever(args.ip, args.port)
671 elif args.command == 'list':
672 print dkps.ListProjects()
673 elif args.command == 'add':
674 dkps.AddProject(
675 args.name, args.uploader_key_file_path, args.requester_key_file_path,
676 args.filter_module_file_name)
677 elif args.command == 'update':
678 dkps.UpdateProject(
679 args.name, args.uploader_key_file_path, args.requester_key_file_path,
680 args.filter_module_file_name)
681 elif args.command == 'rm':
682 dkps.RemoveProject(args.name)
683 else:
684 raise ValueError('Unknown command %s' % args.command)
685
686
687if __name__ == '__main__':
688 main()