1 """module to handle command files
3 @contact: Debian FTP Master <ftpmaster@debian.org>
4 @copyright: 2012, Ansgar Burchardt <ansgar@debian.org>
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 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 General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with this program; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 from daklib.config import Config
28 from daklib.dbconn import *
29 from daklib.gpg import SignedFile
30 from daklib.regexes import re_field_package
31 from daklib.textutils import fix_maintainer
32 from daklib.utils import gpg_get_key_addresses, send_mail, TemplateSubst
34 class CommandError(Exception):
37 class CommandFile(object):
38 def __init__(self, path, log=None):
40 from daklib.daklog import Logger
46 self.filename = os.path.basename(path)
48 def _check_replay(self, signed_file, session):
51 @note: Will commit changes to the database.
53 @type signed_file: L{daklib.gpg.SignedFile}
55 @param session: database session
57 # Mark commands file as seen to prevent replays.
58 signature_history = SignatureHistory.from_signed_file(signed_file)
59 session.add(signature_history)
62 def _quote_section(self, section):
64 for l in str(section).splitlines():
65 lines.append("> {0}".format(l))
66 return "\n".join(lines)
68 def _evaluate_sections(self, sections, session):
73 section = sections.section
74 self.result.append(self._quote_section(section))
76 action = section.get('Action', None)
78 raise CommandError('Encountered section without Action field')
81 self.action_dm(self.fingerprint, section, session)
82 elif action == 'break-the-archive':
83 self.action_break_the_archive(self.fingerprint, section, session)
85 raise CommandError('Unknown action: {0}'.format(action))
87 self.result.append('')
93 def _notify_uploader(self):
96 bcc = 'X-DAK: dak process-command'
97 if 'Dinstall::Bcc' in cnf:
98 bcc = '{0}\nBcc: {1}'.format(bcc, cnf['Dinstall::Bcc'])
100 cc = set(fix_maintainer(address)[1] for address in self.cc)
103 '__DAK_ADDRESS__': cnf['Dinstall::MyEmailAddress'],
104 '__MAINTAINER_TO__': fix_maintainer(self.uploader)[1],
105 '__CC__': ", ".join(cc),
107 '__RESULTS__': "\n".join(self.result),
108 '__FILENAME__': self.filename,
111 message = TemplateSubst(subst, os.path.join(cnf['Dir::Templates'], 'process-command.processed'))
116 """evaluate commands file
119 @returns: C{True} if the file was processed sucessfully,
124 session = DBConn().session()
126 keyrings = session.query(Keyring).filter_by(active=True).order_by(Keyring.priority)
127 keyring_files = [ k.keyring_name for k in keyrings ]
129 raw_contents = open(self.path, 'r').read()
130 signed_file = SignedFile(raw_contents, keyring_files)
131 if not signed_file.valid:
132 self.log.log(['invalid signature', self.filename])
135 self.fingerprint = session.query(Fingerprint).filter_by(fingerprint=signed_file.primary_fingerprint).one()
136 if self.fingerprint.keyring is None:
137 self.log.log(['singed by key in unknown keyring', self.filename])
139 assert self.fingerprint.keyring.active
141 self.log.log(['processing', self.filename, 'signed-by={0}'.format(self.fingerprint.fingerprint)])
143 with tempfile.TemporaryFile() as fh:
144 fh.write(signed_file.contents)
146 sections = apt_pkg.TagFile(fh)
149 addresses = gpg_get_key_addresses(self.fingerprint.fingerprint)
150 if len(addresses) > 0:
151 self.uploader = addresses[0]
155 section = sections.section
156 if 'Uploader' in section:
157 self.uploader = section['Uploader']
158 # TODO: Verify first section has valid Archive field
159 if 'Archive' not in section:
160 raise CommandError('No Archive field in first section.')
162 # TODO: send mail when we detected a replay.
163 self._check_replay(signed_file, session)
165 self._evaluate_sections(sections, session)
166 self.result.append('')
167 except Exception as e:
168 self.log.log(['ERROR', e])
169 self.result.append("There was an error processing this section. No changes were committed.\nDetails:\n{0}".format(e))
172 self._notify_uploader()
178 def _split_packages(self, value):
179 names = value.split()
181 if not re_field_package.match(name):
182 raise CommandError('Invalid package name "{0}"'.format(name))
185 def action_dm(self, fingerprint, section, session):
188 if 'Command::DM::AdminKeyrings' not in cnf \
189 or 'Command::DM::ACL' not in cnf \
190 or 'Command::DM::Keyrings' not in cnf:
191 raise CommandError('DM command is not configured for this archive.')
193 allowed_keyrings = cnf.value_list('Command::DM::AdminKeyrings')
194 if fingerprint.keyring.keyring_name not in allowed_keyrings:
195 raise CommandError('Key {0} is not allowed to set DM'.format(fingerprint.fingerprint))
197 acl_name = cnf.get('Command::DM::ACL', 'dm')
198 acl = session.query(ACL).filter_by(name=acl_name).one()
200 fpr_hash = section['Fingerprint'].translate(None, ' ')
201 fpr = session.query(Fingerprint).filter_by(fingerprint=fpr_hash).first()
203 raise CommandError('Unknown fingerprint {0}'.format(fpr_hash))
204 if fpr.keyring is None or fpr.keyring.keyring_name not in cnf.value_list('Command::DM::Keyrings'):
205 raise CommandError('Key {0} is not in DM keyring.'.format(fpr.fingerprint))
206 addresses = gpg_get_key_addresses(fpr.fingerprint)
207 if len(addresses) > 0:
208 self.cc.append(addresses[0])
210 self.log.log(['dm', 'fingerprint', fpr.fingerprint])
211 self.result.append('Fingerprint: {0}'.format(fpr.fingerprint))
212 if len(addresses) > 0:
213 self.log.log(['dm', 'uid', addresses[0]])
214 self.result.append('Uid: {0}'.format(addresses[0]))
216 for source in self._split_packages(section.get('Allow', '')):
217 # Check for existance of source package to catch typos
218 if session.query(DBSource).filter_by(source=source).first() is None:
219 raise CommandError('Tried to grant permissions for unknown source package: {0}'.format(source))
221 if session.query(ACLPerSource).filter_by(acl=acl, fingerprint=fpr, source=source).first() is None:
224 aps.fingerprint = fpr
226 aps.created_by = fingerprint
227 aps.reason = section.get('Reason')
229 self.log.log(['dm', 'allow', fpr.fingerprint, source])
230 self.result.append('Allowed: {0}'.format(source))
232 self.result.append('Already-Allowed: {0}'.format(source))
236 for source in self._split_packages(section.get('Deny', '')):
237 count = session.query(ACLPerSource).filter_by(acl=acl, fingerprint=fpr, source=source).delete()
239 raise CommandError('Tried to remove upload permissions for package {0}, '
240 'but no upload permissions were granted before.'.format(source))
242 self.log.log(['dm', 'deny', fpr.fingerprint, source])
243 self.result.append('Denied: {0}'.format(source))
247 def action_break_the_archive(self, fingerprint, section, session):
249 uid = fingerprint.uid
250 if uid is not None and uid.name is not None:
251 name = uid.name.split()[0]
253 self.result.append("DAK9000: I'm sorry, {0}. I'm afraid I can't do that.".format(name))