/usr/share/pysieved/plugins/dovecot.py is in pysieved 1.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 | #! /usr/bin/python
## pysieved - Python managesieve server
## Copyright (C) 2007 Neale Pickett
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or (at
## your option) any later version.
## This program is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
## USA
import warnings
warnings.filterwarnings("ignore")
import __init__
import FileStorage
import urllib
import tempfile
import stat
import socket
import os
import subprocess
def b64_encode(s):
return s.encode('base64').replace('\n', '')
class PysievedPlugin(__init__.PysievedPlugin):
capabilities = ('fileinto reject envelope vacation imapflags '
'notify subaddress relational '
'comparator-i;ascii-numeric')
mechs = []
version = [ 1, 0 ]
def init(self, config):
self.mux = config.get('Dovecot', 'mux', False)
self.master = config.get('Dovecot', 'master', False)
self.service = config.get('Dovecot', 'service', 'pysieved')
self.sievec = config.get('Dovecot', 'sievec',
'/usr/lib/dovecot/sievec')
self.scripts_dir = config.get('Dovecot', 'scripts', '.pysieved')
self.active_file = config.get('Dovecot', 'active', '.dovecot.sieve')
self.uid = config.getint('Dovecot', 'uid', -1)
self.gid = config.getint('Dovecot', 'gid', -1)
# Drop privileges here if all users share the same uid/gid
if self.gid >= 0:
os.setgid(self.gid)
if self.uid >= 0:
os.setuid(self.uid)
# No sockets are open
self.auth_sock = None
self.user_sock = None
def open_auth_socket(self):
# The forked child should be short-lived enough that
# it should be ok to open the authentication socket
# only once
# We can do this only if a MUX socket was specified
if not self.mux:
raise ValueError('No MUX socket was specified')
# Open the socket
self.log(7, 'Opening socket %s' % self.mux)
self.auth_sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
self.auth_sock.connect(self.mux)
# Send our version and PID
init_string = ('VERSION\t%d\t%d\nCPID\t%d\n' %
(self.version[0],
self.version[1],
os.getpid()))
self.log(7, '> %r' % init_string)
self.auth_sock.sendall(init_string)
# Verify version
greet = self.auth_sock.recv(1024)
self.log(7, '< %r' % greet)
if greet.find('VERSION\t%d\t' % self.version[0]) == -1:
raise ValueError('Incompatible version number')
# Grab mechanisms
if len(self.mechs) == 0:
for line in greet.splitlines():
if line.startswith('MECH\t'):
parts = line.split('\t')
if parts[1].upper() not in [ mech.upper() for mech in self.mechs]:
self.log(7, 'Adding mechanism %s' % parts[1].upper())
self.mechs.append(parts[1].upper())
# All done
self.reqid = 0
def mechanisms(self):
# When first started, no mechanisms are known
# Open the authentication and get a list from the daemon
if len(self.mechs) == 0 and not self.auth_sock:
self.open_auth_socket()
return self.mechs
def do_sasl_first(self, mechanism, *args):
# Make sure the requested mechanism is supported
if mechanism.upper() not in [ mech.upper() for mech in self.mechs ]:
return {'result': 'NO',
'msg': 'Unsupported authentication mechanism'}
# Build authentication request
self.reqid = self.reqid + 1
if len(args) > 0:
auth_string = ('AUTH\t%d\t%s\tservice=%s\tresp=%s\n' %
(self.reqid,
mechanism.upper(),
self.service,
args[0]))
else:
auth_string = ('AUTH\t%d\t%s\tservice=%s\n' %
(self.reqid,
mechanism.upper(),
self.service))
# We should already have a socket open, just perform the dialog
return self.do_sasl_dialog(auth_string)
def do_sasl_next(self, b64_string):
# Build continuation request
cont_string = ('CONT\t%d\t%s\n' %
(self.reqid,
b64_string))
# We should already have a socket open, just perform the dialog
return self.do_sasl_dialog(cont_string)
def do_sasl_dialog(self, msg):
# We should have an open socket by now
if not self.auth_sock:
return {'result': 'BYE', 'msg': 'Server Error'}
# Dialog
self.log(7, '> %r' % msg)
self.auth_sock.sendall(msg)
ret = self.auth_sock.recv(1024)
self.log(7, '< %r' % ret)
# Parse result
if ret.startswith('OK'):
pass
elif ret.startswith('FAIL'):
return {'result': 'NO', 'msg': 'Authentication failed'}
elif ret.startswith('CONT\t'):
ret = (ret.splitlines())[0]
parts = ret.split('\t')
if len(parts) >= 3:
return {'result': 'CONT', 'msg': parts[2]}
else:
return {'result': 'CONT', 'msg': ''}
else:
return {'result': 'BYE', 'msg': 'Unexpected result'}
# Extract the authorized user
username = None
ret = (ret.splitlines())[0]
for part in ret.split('\t'):
if part.startswith('user='):
username = part[5:]
break
return {'result': 'OK', 'username': username}
def auth(self, params):
# Refer to do_sasl_first
ret = self.do_sasl_first('PLAIN',
b64_encode('\0' +
params['username'] + '\0' +
params['password']))
if ret['result'].startswith('OK'):
return True
return False
def lookup(self, params):
# We can do this only if a master socket was specified
if not self.master:
raise ValueError('No master socket was specified')
if not self.user_sock:
self.log(7, 'Opening socket %s' % self.master)
self.user_sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
self.user_sock.connect(self.master)
init_string = ('VERSION\t%d\t%d\n' %
(self.version[0],
self.version[1]))
self.log(7, '> %r' % init_string)
self.user_sock.sendall(init_string)
greet = self.user_sock.recv(1024)
self.log(7, '< %r' % greet)
if greet.find('VERSION\t%d\t' % self.version[0]) == -1:
raise ValueError('Incompatible major version number')
self.lookup_id = 0
self.lookup_id = self.lookup_id + 1
lookup_string = ('USER\t%d\t%s\tservice=%s\n' %
(self.lookup_id,
params['username'],
self.service))
self.log(7, '> %r' % lookup_string)
self.user_sock.sendall(lookup_string)
ret = self.user_sock.recv(1024)
self.log(7, '< %r' % ret)
if ret.startswith('USER\t'):
ret = (ret.splitlines())[0]
uid = None
gid = None
home = None
sieve = None
for part in ret.split('\t'):
if part.startswith('uid='):
uid = part[4:]
elif part.startswith('gid='):
gid = part[4:]
elif part.startswith('home='):
home = part[5:]
elif part.startswith('sieve='):
sieve = part[6:]
# Assuming we were started with elevated privileges, drop them now
if (self.gid < 0) and gid is not None and (int(gid) >= 0):
os.setgid(int(gid))
if (self.uid < 0) and uid is not None and (int(uid) >= 0):
os.setuid(int(uid))
if sieve:
return sieve
return home
else:
return None
def sieve_has_error(self, tmpdir, script):
self.log(5, 'checking script')
testfile = FileStorage.TempFile(tmpdir)
testfile.write(script)
testfile.close()
compiled = FileStorage.TempFile(tmpdir)
compiled.close()
self.log(7, 'Popen("%s %s %s")' % (self.sievec,
testfile.name,
compiled.name))
p = subprocess.Popen([self.sievec, testfile.name, compiled.name],
stdin=subprocess.PIPE, stdout=subprocess.PIPE,
stderr=subprocess.PIPE, close_fds=True)
(ret_str, err_str) = p.communicate()
ret_str = ret_str.strip()
err_str = err_str.strip()
rc = p.returncode
self.log(7, 'rc = %d' % rc)
if rc:
self.log(7, 'err_str = %s' % err_str)
self.log(5, 'check failed')
return err_str
self.log(5, 'check succeeded')
return None
def create_storage(self, params):
return FileStorage.FileStorage(self.scripts_dir,
self.active_file,
params['homedir'])
def pre_save(self, tmpdir, script):
err_str = self.sieve_has_error(tmpdir, script)
if err_str:
raise ValueError(err_str)
return script
def post_load(self, script):
return script
if __name__ == '__main__':
c = __init__.TestConfig(mux = '/var/spool/postfix/auth/dovecot',
master = '/var/run/dovecot/auth-master',
sievec = '/usr/lib/dovecot/sievec',
scripts = '.pysieved',
active = '.dovecot.sieve',
uid = -1, gid = -1)
n = PysievedPlugin(None, c)
print n.mechanisms()
print n.do_sasl_first('PLAIN',
b64_encode('\0%s\0%s' % ('levan@epix.net',
'foobar')))
print n.lookup({'username': 'levan@epix.net'})
|