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 _evaluate_sections(self, sections, session):
66 section = sections.section
68 action = section.get('Action', None)
70 raise CommandError('Encountered section without Action field')
71 self.result.append('Action: {0}'.format(action))
74 self.action_dm(self.fingerprint, section, session)
76 raise CommandError('Unknown action: {0}'.format(action))
82 def _notify_uploader(self):
85 bcc = 'X-DAK: dak process-command'
86 if 'Dinstall::Bcc' in cnf:
87 bcc = '{0}\nBcc: {1}'.format(bcc, cnf['Dinstall::Bcc'])
89 cc = set(fix_maintainer(address)[1] for address in self.cc)
92 '__DAK_ADDRESS__': cnf['Dinstall::MyEmailAddress'],
93 '__MAINTAINER_TO__': fix_maintainer(self.uploader)[1],
94 '__CC__': ", ".join(cc),
96 '__RESULTS__': "\n".join(self.result),
97 '__FILENAME__': self.filename,
100 message = TemplateSubst(subst, os.path.join(cnf['Dir::Templates'], 'process-command.processed'))
105 """evaluate commands file
108 @returns: C{True} if the file was processed sucessfully,
113 session = DBConn().session()
115 keyrings = session.query(Keyring).filter_by(active=True).order_by(Keyring.priority)
116 keyring_files = [ k.keyring_name for k in keyrings ]
118 raw_contents = open(self.path, 'r').read()
119 signed_file = SignedFile(raw_contents, keyring_files)
120 if not signed_file.valid:
121 self.log.log(['invalid signature', self.filename])
124 self.fingerprint = session.query(Fingerprint).filter_by(fingerprint=signed_file.primary_fingerprint).one()
125 if self.fingerprint.keyring is None:
126 self.log.log(['singed by key in unknown keyring', self.filename])
128 assert self.fingerprint.keyring.active
130 self.log.log(['processing', self.filename, 'signed-by={0}'.format(self.fingerprint.fingerprint)])
132 with tempfile.TemporaryFile() as fh:
133 fh.write(signed_file.contents)
135 sections = apt_pkg.TagFile(fh)
138 addresses = gpg_get_key_addresses(self.fingerprint.fingerprint)
139 if len(addresses) > 0:
140 self.uploader = addresses[0]
144 section = sections.section
145 if 'Uploader' in section:
146 self.uploader = section['Uploader']
147 # TODO: Verify first section has valid Archive field
148 if 'Archive' not in section:
149 raise CommandError('No Archive field in first section.')
151 # TODO: send mail when we detected a replay.
152 self._check_replay(signed_file, session)
154 self._evaluate_sections(sections, session)
155 self.result.append('')
156 except Exception as e:
157 self.log.log(['ERROR', e])
158 self.result.append("There was an error processing this section:\n{0}".format(e))
161 self._notify_uploader()
164 self.log.log(['done', self.filename])
168 def _split_packages(self, value):
169 names = value.split()
171 if not re_field_package.match(name):
172 raise CommandError('Invalid package name "{0}"'.format(name))
175 def action_dm(self, fingerprint, section, session):
178 if 'Command::DM::AdminKeyrings' not in cnf \
179 or 'Command::DM::ACL' not in cnf \
180 or 'Command::DM::Keyrings' not in cnf:
181 raise CommandError('DM command is not configured for this archive.')
183 allowed_keyrings = cnf.value_list('Command::DM::AdminKeyrings')
184 if fingerprint.keyring.keyring_name not in allowed_keyrings:
185 raise CommandError('Key {0} is not allowed to set DM'.format(fingerprint.fingerprint))
187 acl_name = cnf.get('Command::DM::ACL', 'dm')
188 acl = session.query(ACL).filter_by(name=acl_name).one()
190 fpr = session.query(Fingerprint).filter_by(fingerprint=section['Fingerprint']).one()
191 if fpr.keyring is None or fpr.keyring.keyring_name not in cnf.value_list('Command::DM::Keyrings'):
192 raise CommandError('Key {0} is not in DM keyring.'.format(fpr.fingerprint))
193 addresses = gpg_get_key_addresses(fpr.fingerprint)
194 if len(addresses) > 0:
195 self.cc.append(addresses[0])
197 self.log.log(['dm', 'fingerprint', fpr.fingerprint])
198 self.result.append('Fingerprint: {0}'.format(fpr.fingerprint))
199 if len(addresses) > 0:
200 self.log.log(['dm', 'uid', addresses[0]])
201 self.result.append('Uid: {0}'.format(addresses[0]))
203 for source in self._split_packages(section.get('Allow', '')):
204 if session.query(ACLPerSource).filter_by(acl=acl, fingerprint=fpr, source=source).first() is None:
207 aps.fingerprint = fpr
209 aps.created_by = fingerprint
210 aps.reason = section.get('Reason')
212 self.log.log(['dm', 'allow', fpr.fingerprint, source])
213 self.result.append('Allowed: {0}'.format(source))
215 self.result.append('Already-Allowed: {0}'.format(source))
219 for source in self._split_packages(section.get('Deny', '')):
220 session.query(ACLPerSource).filter_by(acl=acl, fingerprint=fpr, source=source).delete()
221 self.log.log(['dm', 'deny', fpr.fingerprint, source])
222 self.result.append('Denied: {0}'.format(source))