./0000755000175100017510000000000012271535704010143 5ustar chaaschaas./pysieved.ini0000644000175100017510000001075712271535704012506 0ustar chaaschaas[main] # Authentication back-end to use auth = passwd # User DB back-end to use userdb = passwd # Storage back-end to use storage = Dovecot # Who are SIEVE scripts intended for ? (Dovecot or Exim) consumer = Dovecot # Bind to what address? (Ignored with --stdin) #bindaddr = 127.0.0.1 # Listen on what port? (Ignored with --stdin) port = 2000 # Write a pidfile here pidfile = /var/run/pysieved.pid # Prepend this path to result of userdb lookup if not absolute #base = /var/mail # Where to create temporary files #tmpdir = /tmp [TLS] # Require STARTTLS before authentication #required = False # TLS private key file #key = /etc/ssl/private/woozle.org.key # TLS certificate file #cert = /etc/ssl/private/woozle.org.pem # Passphrase if the TLS private key is encrypted # (this file should not be world-readable !) #passphrase = magic [SASL] # How do we identify ourself to saslauthd? service = managesieve # Where's the magic mux file? mux = /var/run/saslauthd/mux [PAM] # How do we identify ourself to PAM? service = pysieved [Virtual] # Path to storage. %u = user, %d = domain path = /usr/local/virtual/%d/%u # What domain to use if no domain name is specified by the user #defaultdomain = # What UID and GID should own all files? -1 to not bother uid = 1001 gid = 1001 [LDAP] # Where the LDAP server is located. ldap_url = ldap://127.0.0.1 # Credentials to connect to the LDAP server and perform the user search. bind_dn = cn=root bind_pw = foobar # Whether to use the bind method of authentication # (the alternative is to have pysieved compare passwords, # which requires the password attribute to be readable # with the above credentials). auth_bind = True # Base, scope and filter to perform the user search. # In the filter, the available substitutions are : # %l : login (as provided by the user for authentication) # %u : username part of login # %d : domain part of login (defaultdomain if none) # %m : email address (as derived from %u@%d) base = scope = sub filter = uid=%u #default_domain = # What UID and GID to use if not found in LDAP ? default_uid = 1001 default_gid = 1001 # Attributes to look for. #pw_attr = userPassword #uid_attr = uidNumber #gid_attr = gidNumber #home_attr = homeDirectory [MySQL] dbhost = localhost dbuser = user dbpass = pass dbname = db auth_query = SELECT username FROM users WHERE username = "%(username)s" AND password = "%(password)s" AND (active = "1") user_query = SELECT homedir FROM users WHERE username = "%(username)s" AND (active = "1") list_query = SELECT name FROM sieve WHERE address = "%(username)s" get_query = SELECT script FROM sieve WHERE address = "%(username)s" AND name = "%(name)s" update_query = UPDATE sieve SET script = "%(script)s" WHERE address = "%(username)s" AND name = "%(name)s" insert_query = INSERT INTO sieve ( address , name , script ) values ( "%(username)s" , "%(name)s" , "%(script)s" ) delete_query = DELETE FROM sieve WHERE address = "%(username)s" AND name = "%(name)s" active_query = SELECT name FROM sieve WHERE address = "%(username)s" AND active > 0 LIMIT 1 set_active_query = UPDATE sieve SET active = 1 WHERE address = "%(username)s" AND name = "%(name)s" clear_active_query = UPDATE sieve SET active = 0 WHERE address = "%(username)s" AND active > 0 [htpasswd] passwdfile = /etc/exim/virtual/passwd [Dovecot] # Path to Dovecot's auth socket (do not set unless you're using Dovecot auth) #mux = /var/spool/postfix/auth/dovecot # Path to Dovecot's master socket (if using Dovecot userdb lookup) #master = /var/run/dovecot/auth-master # Path to sievec sievec = /usr/lib/dovecot/sievec # Where in user directory to store scripts scripts = .pysieved # Filename used for the active SIEVE filter (see README.Dovecot) active = .dovecot.sieve # What user/group owns the mail storage (-1 to never setuid/setgid) uid = -1 gid = -1 [Exim] # Path to sendmail sendmail = /usr/sbin/sendmail # Where in user directory to store scripts scripts = .pysieved # Filename used for the active SIEVE filter active = .forward # What user/group owns the mail storage (-1 to never setuid/setgid) uid = -1 gid = -1 [Courier] # Courier's authentication socket mux = /var/run/courier-authlib/socket # Service name to use for communications on that socket service = managesieve # What user/group owns the mail storage (-1 to never setuid/setgid) uid = -1 gid = -1 [lmtpd] # Where in user directory to store scripts scripts = .pysieved # Filename used for the active SIEVE filter active = ssfilter # Program to validate SIEVE scripts checker = /usr/bin/sieve-check ./README.Exim0000644000175100017510000000723612271535704011734 0ustar chaaschaasPysieved integration with Exim ============================== Pysieved can be used to store SIEVE scripts for Exim. Since Exim does not export authentication or userdb mechanisms, the exim plugin cannot be used for those purposes. You will have to configure one of the other plugins to duplicate the way Exim gets that information. This document only describes storage options for Exim. Storing SIEVE scripts as .forward --------------------------------- By default, Exim recognizes a special form of the .forward file as a SIEVE script : if the file starts with the line '# Sieve filter', SIEVE processing will be enabled. If you use the exim plugin as pysieved storage, you will find that scripts get written to a .pysieved subdirectory in the user's home and the .forward becomes a symbolic link to the active script within that subdirectory. Exim's sendmail replacement will be used to validate the scripts as they get saved. pysieved.ini : [main] ... storage = Exim consumer = Exim ... You can customize the exim plugin by configuring an exim section in pysieved.ini : pysieved.ini : [Exim] sendmail = /usr/sbin/sendmail scripts = .pysieved active = .forward Storing scripts in MySQL ------------------------ Exim can retrieve data from a number of sources, including MySQL, which is the subject of this section. Note that you will be using the MySQL plugin for storage, instead of Exim. The Exim plugin will be declared as the consumer. pysieved.ini : [main] ... storage = MySQL consumer = Exim ... ### Table for scripts storage You will have to create a MySQL table to store the SIEVE rules. One good example is the following structure : CREATE TABLE IF NOT EXISTS `sieve` ( `address` varchar(128) NOT NULL, `name` varchar(128) NOT NULL, `script` text NOT NULL, `active` tinyint(4) NOT NULL, KEY `address` (`address`,`name`,`active`) ) ENGINE=MyISAM DEFAULT CHARSET=latin1; Additional queries will have to be defined in the MySQL section. The sample pysieved.ini file contains the queries that go with the above table ### Configuring Exim In order to access the SIEVE scripts that were stored using the above method, you now need to change the "data" lookup to return the desired content. E.g. you can add the following router : exim4.conf : sieve_virtual_user: driver = redirect allow_fail allow_defer data = ${lookup mysql {SELECT script FROM users,sieve \ where users.username = '$local_part@$domain' \ and users.username = sieve.address ;}} directory_transport = sieve_users_directory file_transport = sieve_users_directory pipe_transport = address_pipe allow_filter = true ### you can change this... only check to be owned by the correct ### user sieve_vacation_directory=/var/spool/maildir/.sieve_vacation_db_$local_part@$domain It must be used before your default router, in a way that a user without sieve scripts will receive mail through it. The router references a transport, "sieve_users_directory". Here is a simple example of it, it shoud be added to your transport section of exim4.conf : exim4.conf : sieve_users_directory: driver = appendfile group = mail mode = 0660 mode_fail_narrower = false envelope_to_add = true return_path_add = true maildir_format = true directory = ${lookup mysql{ select homedir from users \ where username='$local_part@$domain' }{$value}{fail}}${sg {.$address_file}{^(.INBOX|.inbox)} {}} ./contrib/0000755000175100017510000000000012271535704011603 5ustar chaaschaas./contrib/pysieved.xinetd0000644000175100017510000000053612271535704014654 0ustar chaaschaas# default: off # description: managesieve server allows for server side mail filtering # author: Joakim Ryden service sieve { disable = no socket_type = stream wait = no user = mail group = mail server = /usr/local/sbin/pysieved.py server_args = --inetd only_from = 127.0.0.1 umask = 002 log_on_failure += USERID } ./contrib/pysieved.spec0000644000175100017510000000407612271535704014316 0ustar chaaschaas# spec file for RPM # Contributed by Farkas Levente # # Copy this up one directory (out of contrib/) before trying to build an # RPM! # %{!?python_sitelib: %define python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")} Summary: Python Managesieve Server Name: pysieved Version: 1.0 Release: 0 License: GPL Group: System Environment/Daemons URL: http://woozle.org/~neale/src/pysieved/ Source0: %{name}-%{version}.tar.gz #Source0: %{name}-HEAD.tar.gz #Patch: pysieved-dovecot.patch BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root BuildRequires: python BuildArch: noarch %description Python Managesieve Server %prep %setup -q -n %{name} #%patch -p1 %build sed -i "s|/usr/local/sbin/pysieved.py|%{_sbindir}/%{name}|" contrib/pysieved.xinetd sed -i "s|--inetd|--inetd --config %{_sysconfdir}/pysieved.ini|" contrib/pysieved.xinetd sed -i "s|/usr/lib/dovecot/sievec|/usr/libexec/dovecot/sievec|" pysieved.ini sed -i "s|/usr/lib/dovecot/sievec|/usr/libexec/dovecot/sievec|" plugins/dovecot.py %install %{__mkdir_p} $RPM_BUILD_ROOT%{python_sitelib}/%{name} for i in plugins *.py ; do %{__cp} -a $i $RPM_BUILD_ROOT%{python_sitelib}/%{name}/ done %{__mkdir_p} $RPM_BUILD_ROOT%{_sysconfdir} install -p -m640 pysieved.ini $RPM_BUILD_ROOT%{_sysconfdir}/ ln -s ../../../../..%{_sysconfdir}/pysieved.ini $RPM_BUILD_ROOT%{python_sitelib}/%{name}/%{name}.ini %{__mkdir_p} $RPM_BUILD_ROOT%{_sbindir} ln -s ../../%{python_sitelib}/%{name}/%{name}.py $RPM_BUILD_ROOT%{_sbindir}/%{name} %{__mkdir_p} $RPM_BUILD_ROOT%{_sysconfdir}/xinetd.d install -p -m644 contrib/pysieved.xinetd $RPM_BUILD_ROOT%{_sysconfdir}/xinetd.d/%{name} %clean rm -rf $RPM_BUILD_ROOT %files %defattr(-,root,root,-) %doc COPYING README README.Dovecot THANKS %config %attr(640,mail,mail) %{_sysconfdir}/%{name}.ini %config %attr(644,root,root) %{_sysconfdir}/xinetd.d/%{name} %{python_sitelib}/%{name} %{_sbindir}/%{name} %changelog * Mon Jul 9 2007 - Initial build. ./COPYING0000644000175100017510000010451312271535704011202 0ustar chaaschaas GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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 3 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, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ./config.py0000644000175100017510000000401012271535704011755 0ustar chaaschaas#! /usr/bin/env 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 ConfigParser class Config: def __init__(self, filename): try: self.c = ConfigParser.RawConfigParser() self.c.read(filename) except: self.c = None def get(self, section, option, default=None): try: return self.c.get(section, option) except: if default is None: raise KeyError("Must specify %s in section %s in config file" % (option, section)) else: return default def getint(self, section, option, default=None): try: return self.c.getint(section, option) except: if default is None: raise KeyError("Must specify %s in section %s in config file" % (option, section)) else: return default def getboolean(self, section, option, default=None): try: return self.c.getboolean(section, option) except: if default is None: raise KeyError("Must specify %s in section %s in config file" % (option, section)) else: return default ./version.py0000644000175100017510000000147412271535704012210 0ustar chaaschaas#! /usr/bin/env 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 version = "1.2" ./plugins/0000755000175100017510000000000012271535704011624 5ustar chaaschaas./plugins/exim.py0000644000175100017510000001160512271535704013143 0ustar chaaschaas#! /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 __init__ import FileStorage import socket import os import subprocess import re class EximStorage(FileStorage.FileStorage): def __init__(self, mydir, active_file, homedir): self.mydir = mydir self.active_file = active_file self.homedir = homedir self.basedir = os.path.join(self.homedir, self.mydir) self.active = os.path.join(self.homedir, self.active_file) self.sieve_hdr = '# Sieve filter' self.sieve_re = re.compile('^' + re.escape(self.sieve_hdr), re.S) # Create our directory if needed if not os.path.exists(self.basedir): os.mkdir(self.basedir) # If they already have a script, shuffle it into where we want it if os.path.exists(self.active) and not os.path.islink(self.active): try: # Make sure this is an Exim Sieve filter script = file(self.active).read() if re.match(self.sieve_re, script): os.rename(self.active, os.path.join(self.basedir, 'exim')) self.set_active('exim') except IOError: pass def __setitem__(self, k, v): if not re.match(self.sieve_re, v): self.log(5, 'Adding Sieve filter header') v = self.sieve_hdr + '\n' + v FileStorage.FileStorage.__setitem__(self, k, v) class PysievedPlugin(__init__.PysievedPlugin): capabilities = ('envelope fileinto encoded-character ' 'enotify subaddress vacation copy ' 'comparator-i;ascii-casemap comparator-en;ascii-casemap ' 'comparator-i;octet comparator-i;ascii-numeric') def init(self, config): self.sendmail = config.get('Exim', 'sendmail', '/usr/sbin/sendmail') self.scripts_dir = config.get('Exim', 'scripts', '.pysieved') self.active_file = config.get('Exim', 'active', '.forward') self.uid = config.getint('Exim', 'uid', -1) self.gid = config.getint('Exim', 'gid', -1) self.sieve_hdr = '# Sieve filter' self.sieve_re = re.compile('^' + re.escape(self.sieve_hdr), re.S) # 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) def sieve_has_error(self, tmpdir, script): self.log(5, 'checking script') testfile = FileStorage.TempFile(tmpdir) testfile.write(script) testfile.close() self.log(7, 'Popen("%s -bf %s")' % (self.sendmail, testfile.name)) p = subprocess.Popen([self.sendmail, '-bf', testfile.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 or 'check failed' # It has been reported that exim -bf always returns 0 # and errors are reported on standard output instead. if err_str.find('Sieve error') > 0: 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 EximStorage(self.scripts_dir, self.active_file, params['homedir']) def pre_save(self, tmpdir, script): # It has been reported that Exim doesn't like CRLF. script = script.replace('\r\n', '\n') if not re.match(self.sieve_re, script): script = self.sieve_hdr + '\n' + 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 ./plugins/FileStorage.py0000644000175100017510000000774512271535704014417 0ustar chaaschaas#! /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 __init__ import urllib import tempfile import stat import os #################################### ## Storage stuff def quote(str): return urllib.quote(str, '') def unquote(str): return urllib.unquote(str) def write_out(basedir, final, txt): script = TempFile(basedir) script.write(txt) script.close() os.rename(script.name, final) class TempFile: """Like NamedTemporaryFile but won't complain if unlink fails""" def __init__(self, dir): fd, self.name = tempfile.mkstemp(dir=dir) self.file = os.fdopen(fd, 'w+b') self.unlink = os.unlink def __getattr__(self, name): return getattr(self.file, name) def close(self): if not self.file: return self.file.close() self.file = None def __del__(self): self.close() try: self.unlink(self.name) except OSError: pass class FileStorage(__init__.ScriptStorage): def __init__(self, mydir, active_file, homedir): self.mydir = mydir self.active_file = active_file self.homedir = homedir self.basedir = os.path.join(self.homedir, self.mydir) self.active = os.path.join(self.homedir, self.active_file) # Create our directory if needed if not os.path.exists(self.basedir): os.mkdir(self.basedir) # If they already have a script, shuffle it into where we want it if os.path.exists(self.active) and not os.path.islink(self.active): rename_to = ''.join([ self.active_file, '.orig']) os.rename(self.active, os.path.join(self.basedir, quote(rename_to))) self.set_active(rename_to) def __setitem__(self, k, v): write_out(self.basedir, os.path.join(self.basedir, quote(k)), v) def __getitem__(self, k): fn = os.path.join(self.basedir, quote(k)) try: return file(fn).read() except IOError: raise KeyError('Unknown script') def __delitem__(self, k): if k and self.is_active(k): raise ValueError('Script is active') fn = os.path.join(self.basedir, quote(k)) try: os.unlink(fn) except OSError: raise KeyError('Unknown script') def __iter__(self): for s in os.listdir(self.basedir): if s[0] == '.': continue if s[-1] == '~': continue yield unquote(s) def has_key(self, k): fn = os.path.join(self.basedir, quote(k)) return os.path.exists(fn) def is_active(self, k): fn = os.path.join(self.basedir, quote(k)) if not self.has_key(k): raise KeyError('Unknown script %s' % k) try: return os.path.samefile(fn, self.active) except OSError: return False def set_active(self, k): if k: fn = os.path.join(self.mydir, quote(k)) if not self.has_key(k): raise KeyError('Unknown script') try: os.unlink(self.active) except OSError: pass if k: os.symlink(fn, self.active) ./plugins/mysql.py0000644000175100017510000002251012271535704013343 0ustar chaaschaas#! /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 MySQLdb import MySQLdb.constants.CR import re import __init__ expand_names = ( 'username', 'password', 'name', 'script', ) expand_re_str = '%\((' + '|'.join(expand_names) + ')\)s|' + \ '"%\((' + '|'.join(expand_names) + ')\)s"|' + \ '\'%\((' + '|'.join(expand_names) + ')\)s\'' expand_re = re.compile(expand_re_str) def expand_query(query, params): values = [] for match in expand_re.finditer(query): sub = match.group().replace('"', '').replace('\'', '') values.append(params[sub[2:-2]]) query = re.sub(expand_re, '%s', query) return (query, values) class MysqlConnection: def __init__(self, log, dbhost, dbuser, dbpass, dbname): self.log = log self.dbhost = dbhost self.dbuser = dbuser self.dbpass = dbpass self.dbname = dbname self.conn = None def __del__(self): if self.conn: try: self.conn.close() except: pass self.conn = None def connect(self): self.log(5, 'connecting to database %s on %s' % (self.dbname, self.dbhost)) try: self.conn = MySQLdb.connect(host = self.dbhost, user = self.dbuser, passwd = self.dbpass, db = self.dbname) self.log(5, 'connected to database %s on %s' % (self.dbname, self.dbhost)) return True except MySQLdb.MySQLError, e: self.conn = None self.log(5, 'failed connection to database %s on %s: %s' % (self.dbname, self.dbhost, str(e))) return False def demand_connect(self): if self.conn is None: return self.connect() try: self.conn.ping() except MySQLdb.MySQLError, e: if e[0] == MySQLdb.constants.CR.SERVER_GONE_ERROR: self.log(5, 'lost connection to database %s on %s' % (self.dbname, self.dbhost)) return self.connect() return False return True def cursor(self): if self.demand_connect(): return self.conn.cursor() else: raise RuntimeError('not connected to database') def close(): if self.conn: try: self.conn.close() except: pass self.conn = None class MysqlStorage(__init__.ScriptStorage): def __init__(self, log, conn, params, config): self.log = log self.conn = conn self.params = params self.list_query = config.get('MySQL', 'list_query') self.get_query = config.get('MySQL', 'get_query') self.update_query = config.get('MySQL', 'update_query') self.insert_query = config.get('MySQL', 'insert_query') self.delete_query = config.get('MySQL', 'delete_query') self.active_query = config.get('MySQL', 'active_query') self.set_active_query = config.get('MySQL', 'set_active_query') self.clear_active_query = config.get('MySQL', 'clear_active_query') def expand_query(self, query, params): self.log(9, 'expand_query input: %s / %r' % (query, params)) query, values = expand_query(query, params) self.log(9, 'expand_query output: %s / %r' % (query, values)) return (query, values) def __iter__(self): query, values = self.expand_query(self.list_query, dict(self.params)) cursor = self.conn.cursor() cursor.execute(query, values) results = cursor.fetchall() for row in results: if row: yield row[0] else: break def has_key(self, k): query, values = self.expand_query(self.get_query, dict(self.params, name = k)) cursor = self.conn.cursor() cursor.execute(query, values) if cursor.fetchone(): return True return False def __getitem__(self, k): if k != None and not self.has_key(k): raise KeyError('Unknown script') query, values = self.expand_query(self.get_query, dict(self.params, name = k)) cursor = self.conn.cursor() cursor.execute(query, values) row = cursor.fetchone() return row[0] def __setitem__(self, k, v): if self.has_key(k): query, values = self.expand_query(self.update_query, dict(self.params, name = k, script = v)) else: query, values = self.expand_query(self.insert_query, dict(self.params, name = k, script = v)) cursor = self.conn.cursor() cursor.execute(query, values) def __delitem__(self, k): if self.is_active(k): raise ValueError('Script is active') query, values = self.expand_query(self.delete_query, dict(self.params, name = k)) cursor = self.conn.cursor() cursor.execute(query, values) def get_active(self): query, values = self.expand_query(self.active_query, dict(self.params)) cursor = self.conn.cursor() cursor.execute(query, values) row = cursor.fetchone() if row: return row[0] return None def is_active(self, k): if k != None and not self.has_key(k): raise KeyError('Unknown script') return self.get_active() == k def set_active(self, k): if k: self.log(5, 'Set active %s' % k) if not self.has_key(k): self.log(5, 'No script named %s' % k) raise KeyError('Unknown script') self.log(7, 'Found script %s' % k) else: self.log(5, 'Set active None') self.log(7, 'Clearing active script') query, values = self.expand_query(self.clear_active_query, dict(self.params)) cursor = self.conn.cursor() cursor.execute(query, values) self.log(7, 'Done clearing active script') if k: self.log(7, 'Activating %s' % k) query, values = self.expand_query(self.set_active_query, dict(self.params, name = k)) cursor = self.conn.cursor() cursor.execute(query, values) self.log(7, 'Done activating %s' % k) self.log(5, 'Done set active') class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): dbhost = config.get('MySQL', 'dbhost') dbuser = config.get('MySQL', 'dbuser') dbpass = config.get('MySQL', 'dbpass') dbname = config.get('MySQL', 'dbname') self.auth_query = config.get('MySQL', 'auth_query') self.user_query = config.get('MySQL', 'user_query') self.config = config self.conn = MysqlConnection(self.log, dbhost, dbuser, dbpass, dbname) def __del__(self): self.conn.close() def expand_query(self, query, params): self.log(9, 'expand_query input: %s / %r' % (query, params)) query, values = expand_query(query, params) self.log(9, 'expand_query output: %s / %r' % (query, values)) return (query, values) def auth(self, params): cursor = self.conn.cursor() query, values = self.expand_query(self.auth_query, params) cursor.execute(query, values) row = cursor.fetchone() cursor.close() # Only return true if there was a row result if row: return True return False def lookup(self, params): cursor = self.conn.cursor() query, values = self.expand_query(self.user_query, params) cursor.execute(query, values) row = cursor.fetchone() assert row, 'No results from select (invalid user?)' cursor.close() return row[0] def create_storage(self, params): return MysqlStorage(self.log, self.conn, params, self.config) ./plugins/lmtpd.py0000644000175100017510000000516312271535704013323 0ustar chaaschaas#! /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 __init__ import warnings import os import FileStorage import subprocess class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): self.capabilities = ('fileinto reject envelope comparator-i;ascii-numeric relational subaddress copy') self.scripts_dir = config.get('lmtpd', 'scripts', '.pysieved') self.active_file = config.get('lmtpd', 'active', 'ssfilter') self.checker = config.get('lmtpd', 'checker', '/usr/bin/sieve-check') if not os.path.exists(self.checker): raise OSError('Sieve check not found') def create_storage(self, params): return FileStorage.FileStorage(self.scripts_dir, self.active_file, params['homedir']) def sieve_has_error(self, tmpdir, script): testfile = FileStorage.TempFile(tmpdir) testfile.write(script) testfile.close() self.log(7, 'Popen("%s %s")' % (self.checker, testfile.name)) p = subprocess.Popen([self.checker, testfile.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 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 ./plugins/courier.py0000644000175100017510000000650312271535704013652 0ustar chaaschaas#! /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 __init__ import warnings import os import socket class PysievedPlugin(__init__.PysievedPlugin): def __fetchAuth(self, username, password): if len(self.mux)==0: return '' self.log(7, 'Opening socket %s' % self.mux) try: authSocket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) authSocket.connect(self.mux) except Error: return '' if password is None: authBuffer = 'PRE . %s %s\n' % (self.service, username) else: authBuffer = '%s\nlogin\n%s\n%s\n' % (self.service, username, password) authBuffer = 'AUTH %d\n%s' % (len(authBuffer), authBuffer) self.log(7, '> %r' % authBuffer) authSocket.sendall(authBuffer) authBuffer = authSocket.recv(2048) self.log(7, '< %r' % authBuffer) self.log(7, 'Closing socket %s' % self.mux) authSocket.close() return authBuffer def init(self, config): self.mux = config.get('Courier', 'mux', '') self.uid = config.getint('Courier', 'uid', -1) self.gid = config.getint('Courier', 'gid', -1) self.service = config.get('Courier', 'service', 'managesieve') # 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) def auth(self, params): authBuffer = self.__fetchAuth(params['username'], params['password']) if len(authBuffer) == 0: return False for authLine in authBuffer.split('\n'): if authLine.find('USERNAME') == 0: return True if authLine.find('UID') == 0: return True return False def lookup(self, params): authBuffer = self.__fetchAuth(params['username'], None) if len(authBuffer) == 0: return False newUid = -1 newGid = -1 maildir = None for authLine in authBuffer.split('\n'): if authLine.find('MAILDIR') == 0: maildir = authLine.split('=')[1] elif authLine.find('GID') == 0: newUid = int(authLine.split('=')[1]) elif authLine.find('UID') == 0: newGid = int(authLine.split('=')[1]) # TODO - check privileges, and drop them if neccecery if newGid >= 0 and self.gid == -1: os.setgid(newGid) if newUid >= 0 and self.uid == -1: os.setuid(newUid) return maildir ./plugins/virtual.py0000755000175100017510000000471412271535704013675 0ustar chaaschaas#! /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 __init__ import re import os path_re = re.compile(r'%((\d+)(\.\d+)?)?([ud%])') class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): self.uid = config.getint('Virtual', 'uid', None) self.gid = config.getint('Virtual', 'gid', None) self.defaultdomain = config.get('Virtual', 'defaultdomain', None) self.path = config.get('Virtual', 'path', None) assert ((self.uid is not None) and (self.gid is not None) and self.path) def lookup(self, params): if self.gid >= 0: os.setgid(self.gid) if self.uid >= 0: os.setuid(self.uid) try: user, domain = params['username'].split('@', 1) except ValueError: user, domain = params['username'], self.defaultdomain def repl(m): l = m.group(2) r = m.group(3) c = m.group(4) if c == '%': return '%' elif c == 'u': s = user elif c == 'd': s = domain if l: l = int(l) if r: r = int(r[1:]) return s[l:l+r] else: return s[:l] else: return s username = path_re.sub(repl, self.path) return username if __name__ == '__main__': c = __init__.TestConfig(uid=-1, gid=-1, defaultdomain="woozle.snerk", path='/shared/spool/active/%d/%0.1u/%1.1u/%u/sieve/') n = PysievedPlugin(None, c) print n.lookup({'username': 'neale@woozle.org'}) ./plugins/accept.py0000644000175100017510000000416112271535704013437 0ustar chaaschaas#! /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 __init__ import warnings class ScriptStorage(__init__.ScriptStorage): def __init__(self): self.scripts = {} self.active = None def __setitem__(self, k, v): self.scripts[k] = v def __getitem__(self, k): return self.scripts[k] def __delitem__(self, k): if self.active == k: raise ValueError('Script is active') del self.scripts[k] def __iter__(self): for k in self.scripts: yield k def has_key(self, k): return self.scripts.has_key(k) def is_active(self, k): return self.active == k def set_active(self, k): if k != None and k not in self.scripts: raise KeyError('Unknown script') self.active = k class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): self.warn = config.getboolean('Accept', 'warn', True) def auth(self, params): if self.warn: warnings.warn('The "accept" module is for testing only!') return True def lookup(self, params): if self.warn: warnings.warn('The "accept" module is for testing only!') return '/tmp' def create_storage(self, params): if self.warn: warnings.warn('The "accept" module is for testing only!') return ScriptStorage() ./plugins/dovecot.py0000644000175100017510000002545012271535704013647 0ustar chaaschaas#! /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 __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'}) ./plugins/sasl.py0000644000175100017510000000357312271535704013150 0ustar chaaschaas#! /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 __init__ import socket import struct def pack(s): return struct.pack('!H', len(s)) + s class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): self.mux = config.get('SASL', 'mux', '/var/run/saslauthd/mux') self.service = config.get('SASL', 'service', 'pysieved') def sasl(self, *args): s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) s.connect(self.mux) s.send(''.join([pack(x) for x in args])) r = s.recv(2) (n,) = struct.unpack('!H', r) return s.recv(n) def auth(self, params): ret = self.sasl(params['username'], params['password'], self.service, '') self.log(2, 'Auth returns %r' % ret) if ret.startswith('OK'): return True return False if __name__ == '__main__': import sys class C: def get(self, section, key, default): return default n = new(C()) print n.auth({'username': sys.argv[1], 'password': sys.argv[2]}) ./plugins/__init__.py0000755000175100017510000001245312271535704013745 0ustar chaaschaas#! /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 class PysievedPlugin: # Override this capabilities = 'fileinto reject' mechs = [ 'PLAIN' ] def __init__(self, log_func, config): if log_func: self.log = log_func else: def print_log(l, msg): print '%s %s' % ("=" * l, msg) self.log = print_log self.init(config) def init(self, config): # Override this pass def mechanisms(self): return self.mechs def do_sasl_first(self, mechanism, *args): """Handle the initial part of the SASL dialog This is just a wrapper around the auth() method if the requested mechanism is PLAIN. Returns a dictionary with the following elements : { 'result': 'OK' (pass), 'NO' (fail), 'BYE' (fatal) or 'CONT' (more), 'msg': error string (fail or fatal) or server response (more), 'username': authorized username (pass) } """ if mechanism.upper() != 'PLAIN': return {'result': 'NO', 'msg': 'Unsupported authentication mechanism'} if len(args) != 1: return {'result': 'NO', 'msg': 'Must provide authentication credentials'} _, user, passwd = args[0].decode('base64').split('\0', 2) params = {'username': user, 'password': passwd} if self.auth(params): return {'result': 'OK', 'username': user} else: return {'result': 'NO', 'msg': 'Bad username or password'} def do_sasl_next(self, b64_string): """Handle the continuation of the SASL dialog Returns a dictionary with the following elements : { 'result': 'OK' (pass), 'NO' (fail), 'BYE' (fatal) or 'CONT' (more), 'msg': error string (fail or fatal) or server response (more), 'username': authorized username (pass) } """ raise NotImplementedError() def auth(self, params): """Authenticate a user. Params will contain 'username' and 'password'. Returns true if authentication was successful. """ raise NotImplementedError() def lookup(self, params): """Setuid and return home directory. Params will contain 'username' and 'password'. """ raise NotImplementedError() def create_storage(self, params): """Return a storage object. Params will contain 'username', 'password', and 'homedir' """ raise NotImplementedError() def sieve_has_error(self, tmpdir, script): """Checks if the script is syntactically correct. tmpdir is a location to create temporary files for syntax checking script is the formatted SIEVE filter returned by pre_save() """ raise NotImplementedError() def pre_save(self, tmpdir, script): """Formats the script to fit the local delivery agent's requirements. tmpdir is a location to create temporary files for syntax checking script is the raw SIEVE filter as received from the MANAGESIEVE client """ raise NotImplementedError() def post_load(self, script): """Removes any changes introduced by pre_save(). script is the SIEVE filter as read from storage """ raise NotImplementedError() class ScriptStorage: def __setitem__(self, k, v): if False: # If it doesn't validate, return ValueError raise ValueError('explanation') raise NotImplementedError() def __getitem__(self, k): raise NotImplementedError() def __delitem__(self, k): if self.is_active(k): raise ValueError('Script is active') raise NotImplementedError() def __iter__(self): raise NotImplementedError() def has_key(self, k): raise NotImplementedError() def is_active(self, k): raise NotImplementedError() def set_active(self, k): if k != None and not self.has_key(k): raise KeyError('Unknown script') raise NotImplementedError() class TestConfig: def __init__(self, **kwargs): self.dict = kwargs.copy() def get(self, sect, key, default = None): return self.dict.get(key, default) def getboolean(self, sect, key, default = False): try: if self.dict[key]: return True else: return False except: return default def getint(self, sect, key, default): try: return int(self.dict[key]) except: return default ./plugins/ldapplugin.py0000755000175100017510000001670312271535704014347 0ustar chaaschaas#!/usr/bin/python -tt ## 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 crypt import os import re import sys import ldap import ldap.filter import __init__ expand_re = re.compile('%[udlm]') scope_map = { 'base': ldap.SCOPE_BASE, 'sub': ldap.SCOPE_SUBTREE, 'one': ldap.SCOPE_ONELEVEL, } class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): self.ldap_url = config.get('LDAP', 'ldap_url', None) self.bind_dn = config.get('LDAP', 'bind_dn', None) self.bind_pw = config.get('LDAP', 'bind_pw', None) self.auth_bind = config.getboolean('LDAP', 'auth_bind', True) self.base = config.get('LDAP', 'base', '') self.scope = scope_map[config.get('LDAP', 'scope', 'sub')] self.filter = config.get('LDAP', 'filter', 'uid=%u') self.default_domain = config.get('LDAP', 'default_domain', None) self.default_uid = config.getint('LDAP', 'default_uid', -1) self.default_gid = config.getint('LDAP', 'default_gid', -1) self.pw_attr = config.get('LDAP', 'pw_attr', 'userPassword') self.uid_attr = config.get('LDAP', 'uid_attr', 'uidNumber') self.gid_attr = config.get('LDAP', 'gid_attr', 'gidNumber') self.home_attr = config.get('LDAP', 'home_attr', 'homeDirectory') assert ((self.ldap_url is not None) and (self.bind_dn is not None) and (self.bind_pw is not None)) def expand_filter(self, filter, params): # Here are the possible substitutions. login = params['username'] try: user, domain = login.split('@', 1) except ValueError: user, domain = params['username'], self.default_domain if domain is not None: email = '@'.join([user, domain]) else: email = None # We need to provide as many arguments to ldap.filter.filter_format() # as there are substitution patterns in the filter. values = [] for match in expand_re.finditer(filter): sub = match.group() if sub == '%u': values.append(user) elif sub == '%d': if not domain: raise RuntimeError('undefined domain in filter expansion') values.append(domain) elif sub == '%l': values.append(login) elif sub == '%m': if not email: raise RuntimeError('incomplete e-mail address in filter expansion') values.append(email) next = match.end() # ldap.filter.filter_format() expands '%s'. format = re.sub(expand_re, '%s', filter) return ldap.filter.filter_format(format, values) def auth(self, params): # Connect to server. self.log(7, 'Connecting to %s' % self.ldap_url) ld = ldap.initialize(self.ldap_url) self.log(8, 'Binding as %s' % self.bind_dn) ld.simple_bind_s(self.bind_dn, self.bind_pw) # Look for account. filter = self.expand_filter(self.filter, params) self.log(8, 'Searching for %s (base: %s)' % (filter, self.base)) results = ld.search_s(self.base, self.scope, filter, [self.pw_attr]) if not results: self.log(8, 'No match for %s' % filter) self.log(7, 'Disconnecting from %s' % self.ldap_url) ld.unbind_s() return False dn = results[0][0] self.log(8, 'Found entry %s' % dn) if self.auth_bind: # Try the bind method. try: self.log(8, 'Attempting bind as %s' % dn) ld.simple_bind_s(dn, params['password']) self.log(8, 'Bind succeeded for %s' % dn) result = True except ldap.INVALID_CREDENTIALS: self.log(8, 'Bind failed for %s' % dn) result = False else: # Grab the password so we can check it. if self.pw_attr not in results[0][1]: raise RuntimeError('no password attribute was returned') pw = results[0][1][self.pw_attr][0] # Is it a crypted password ? if pw.lower().startswith('{crypt}'): self.log(8, 'This is a crypted password') pw = pw[7:] check = crypt.crypt(params['password'], pw) result = check == pw else: # Compare clear-text passwords. result = params['password'] == pw self.log(8, 'Good password ? %s' % result) # All done. self.log(7, 'Disconnecting from %s' % self.ldap_url) ld.unbind_s() return result def lookup(self, params): # Connect to server. self.log(7, 'Connecting to %s' % self.ldap_url) ld = ldap.initialize(self.ldap_url) self.log(7, 'Binding as %s' % self.bind_dn) ld.simple_bind_s(self.bind_dn, self.bind_pw) # Look for account. filter = self.expand_filter(self.filter, params) self.log(8, 'Searching for %s (base = %s)' % (filter, self.base)) results = ld.search_s(self.base, self.scope, filter, [self.home_attr, self.uid_attr, self.gid_attr]) if not results: self.log(8, 'No match for %s' % filter) self.log(7, 'Disconnecting from %s' % self.ldap_url) ld.unbind_s() return None dn = results[0][0] self.log(8, 'Found entry %s' % dn) home = results[0][1].get(self.home_attr, [None])[0] self.log(8, 'Home is %s' % home) # Change uid/gid if found. uid = results[0][1].get(self.uid_attr, [None])[0] gid = results[0][1].get(self.gid_attr, [None])[0] if gid is not None and (int(gid) > 0): os.setgid(int(gid)) elif self.default_gid > 0: os.setgid(self.default_gid) if uid is not None and (int(uid) > 0): os.setuid(int(uid)) elif self.default_uid > 0: os.setuid(self.default_uid) # All done. self.log(7, 'Disconnecting from %s' % self.ldap_url) ld.unbind_s() return home if __name__ == '__main__': c = __init__.TestConfig(ldap_url = 'ldap://127.0.0.1', bind_dn = 'cn=root', bind_pw = 'foobar', auth_bind = True, default_domain = 'epix.net', default_uid = -1, default_gid = -1) n = PysievedPlugin(None, c) print n.expand_filter('u = %u, d = %d, l = %l, m = %m', {'username': 'levan'}) print n.auth({'username': 'levan', 'password': 'foobar'}) print n.lookup({'username': 'levan'}) ./plugins/passwd.py0000644000175100017510000000462712271535704013510 0ustar chaaschaas#! /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 __init__ import crypt import pwd import spwd import os class PysievedPlugin(__init__.PysievedPlugin): def auth(self, params): try: spwent = spwd.getspnam(params['username']) except KeyError: # This may be caused by insufficient permissions. # Although the result is the same, let's try and be # more informative about the failure case. # Unless the system is misconfigured, there should # be an entry for the current uid. If we can look # it up, then it is not a permissions problem. pwent = pwd.getpwuid(0) try: spwent = spwd.getspnam(pwent[0]) except KeyError: raise NotImplementedError('insufficient permissions to authenticate against shadow database') return False sp_pwd = spwent[1] check = crypt.crypt(params['password'], sp_pwd) return check == sp_pwd def lookup(self, params): pwent = pwd.getpwnam(params['username']) uid = pwent[2] gid = pwent[3] os.setgid(gid) os.setuid(uid) return pwent[5] if __name__ == '__main__': c = __init__.TestConfig(uid = -1, gid = -1) n = PysievedPlugin(None, c) # We use the current user for testing, otherwise the set[gu]id() # calls in lookup() will fail. pwent = pwd.getpwuid(os.getuid()) print 'Testing with username %s' % pwent[0] try: print n.auth({'username': pwent[0], 'password': 'foobar'}) except NotImplementedError, e: print str(e) print n.lookup({'username': pwent[0]}) ./plugins/pam.py0000644000175100017510000000561112271535704012756 0ustar chaaschaas#! /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 __init__ import PAM class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): self.service = config.get('PAM', 'service', 'pysieved') def auth(self, params): def conv(auth, query_list, *ign): if hasattr(auth, 'userdata'): self.log(1, "PyPAM 0.5.0 may be buggy, we suggest using 0.4.2") resp = [] for query, qtype in query_list: if qtype == PAM.PAM_PROMPT_ECHO_ON: self.log(7, '< %s (%s)' % (query, 'PAM_PROMPT_ECHO_ON')) resp.append(('', 0)) self.log(7, '> %s' % '') elif qtype == PAM.PAM_PROMPT_ECHO_OFF: # Read string with echo turned off self.log(7, '< %s (%s)' % (query, 'PAM_PROMPT_ECHO_OFF')) resp.append((params['password'], 0)) self.log(7, '> %s' % params['password']) elif type == PAM.PAM_PROMPT_ERROR_MSG: self.log(7, '< %s (%s)' % (query, 'PAM_PROMPT_ERROR_MSG')) resp.append(('', 0)) self.log(7, '> %s' % '') elif type == PAM.PAM_PROMPT_TEXT_INFO: self.log(7, '< %s (%s)' % (query, 'PAM_PROMPT_TEXT_INFO')) resp.append(('', 0)) self.log(7, '> %s' % '') else: return None return resp auth = PAM.pam() auth.start(self.service) auth.set_item(PAM.PAM_USER, params['username']) auth.set_item(PAM.PAM_CONV, conv) try: auth.authenticate() auth.acct_mgmt() except PAM.error: return None return True if __name__ == '__main__': import sys class C: def get(*meh): return 'pysieved' def log(l, s): print 'LOG (%d): %s' % (l, s) n = new(log, C()) ret = n.auth({'username': sys.argv[1], 'password': sys.argv[2]}) if ret: print 'Authentication worked' else: print 'Authentication failed' ./plugins/htpasswd.py0000644000175100017510000000260112271535704014032 0ustar chaaschaas#! /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 __init__ from crypt import crypt class PysievedPlugin(__init__.PysievedPlugin): def init(self, config): self.passfile = config.get('htpasswd', 'passwdfile', '/etc/exim/virtual/passwd') self.passwd = {} for l in file(self.passfile): parts = l.rstrip().split(':', 1) self.passwd[parts[0]] = parts[1] def auth(self, params): try: cpass = self.passwd[params['username']] except KeyError: return False return cpass == crypt(params['password'], cpass[:2]) ./daemon.py0000755000175100017510000000267512271535704011775 0ustar chaaschaas#! /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 os import sys def daemon(pidfile=None, stdout=None, stderr=None): # Do this first so errors print out right away if pidfile: f = file(pidfile, 'w') else: f = None pid = os.fork() if pid: # Exit first parent os._exit(0) # Decouple from parent os.setsid() # Second fork pid = os.fork() if pid: # Exit second parent os._exit(0) # Remap std files os.close(0) if stdout: sys.stdout = stdout os.close(1) if stderr: sys.stderr = stderr os.close(2) # Write pid if f: f.write(str(os.getpid())) f.close() ./test.ini0000644000175100017510000000154312271535704011626 0ustar chaaschaas[Test] #user = foo #password = bar #domain = example.org #uid = -1 #gid = -1 #verbosity = 0 [Dovecot] #skip = False #mux = /var/spool/postfix/auth/dovecot #master = /var/run/dovecot/auth-master #sievec = /usr/local/libexec/dovecot/sievec [Exim] #skip = False #sendmail = /usr/sbin/sendmail [htpasswd] #skip = False #passwdfile = /etc/exim/virtual/passwd [MySQL] #skip = False #dbhost = localhost #dbuser = user #dbpass = pass #dbname = db #auth_query = SELECT username FROM users WHERE username = "%(username)s" AND password = "%(password)s" AND (active = "1") #user_query = SELECT homedir FROM users WHERE username = "%(username)s" AND (active = "1") [PAM] #skip = False [passwd] #skip = False [SASL] #skip = False #mux = /var/state/saslauthd/mux #service = pysieved [Courier] #skip = False #mux = /var/run/courier-authlib/socket #uid = -1 #gid - -1 ./pysieved.py0000755000175100017510000002345512271535704012361 0ustar chaaschaas#! /usr/bin/env 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 optparse import SocketServer import socket import os import managesieve import syslog import sys from config import Config try: from tlslite.api import * have_tls = True except: have_tls = False class Server(SocketServer.ForkingTCPServer): allow_reuse_address = True def main(): parser = optparse.OptionParser() parser.add_option('-i', '--inetd', help='Run once on stdin (inetd mode)', action='store_true', dest='stdin', default=False) parser.add_option('-l', '--port', help='What port to run on (default 2000)', action='store', dest='port', default=None, type='int') parser.add_option('-b', '--bindaddr', help='What IP address to bind to (default all)', action='store', dest='bindaddr', default=None) parser.add_option('-p', '--pidfile', help='Where to write a PID file', action='store', dest='pidfile', default=None) parser.add_option('-c', '--config', help='Location of config file', action='store', dest='config', default='/usr/local/etc/pysieved.ini') parser.add_option('-v', '--verbosity', help="Set logging verbosity level (default 1)", action='store', dest='verbosity', default=1, type='int') parser.add_option('-d', '--debug', help='Log to stderr (implies --no-daemon)', action='store_true', dest='debug', default=False) parser.add_option('-B', '--base', help='Mail base directory', action='store', dest='base', default='') parser.add_option('-t', '--tmpdir', help='Temp directory', action='store', dest='tmpdir', default='') parser.add_option('-T', '--tls', help='STARTTLS required before authentication', action='store_true', dest='tls_required', default=False) parser.add_option('-K', '--key', help='TLS private key file', action='store', dest='tls_key', default='') parser.add_option('-C', '--cert', help='TLS certificate file', action='store', dest='tls_cert', default='') parser.add_option('--no-daemon', help='Do not daemonize (but stay in foreground)', action='store_true', dest='nodaemon', default=False) (options, args) = parser.parse_args() # Read config file config = Config(options.config) port = options.port or config.getint('main', 'port', 2000) addr = options.bindaddr or config.get('main', 'bindaddr', '') pidfile = options.pidfile or config.get('main', 'pidfile', '/var/run/pysieved.pid') base = options.base or config.get('main', 'base', '') tmpdir = options.tmpdir or config.get('main', 'tmpdir', '') or \ os.environ.get('TMPDIR', '/tmp') tls_required = options.tls_required or config.getboolean('TLS', 'required', False) tls_key = options.tls_key or config.get('TLS', 'key', '') tls_cert = options.tls_cert or config.get('TLS', 'cert', '') tls_passphrase = config.get('TLS', 'passphrase', '') if options.debug: options.nodaemon = True # Define the log function syslog.openlog('pysieved[%d]' % (os.getpid()), 0, syslog.LOG_MAIL) def log(l, s): if l <= options.verbosity: if options.debug: sys.stderr.write('%s %s\n' % ("=" * l, s)) else: if l > 0: lvl = syslog.LOG_NOTICE elif l == 0: lvl = syslog.LOG_WARNING else: lvl = syslog.LOG_ERR syslog.syslog(lvl, s) # Load TLS key and cert tls_privateKey = None tls_certChain = None if tls_key or tls_cert: # Expect to use TLS if not have_tls: log(1, "TLSLite is not available. STARTTLS will not be offered") tls_required = False elif not tls_key: log(1, "Cannot enable TLS without a key. STARTTLS will not be offered") tls_required = False elif not tls_cert: log(1, "Cannot enable TLS without a certificate. STARTTLS will not be offered") tls_required = False else: try: tls_read_cert = open(tls_cert).read() tls_x509 = X509() tls_x509.parse(tls_read_cert) tls_certChain = X509CertChain([tls_x509]) tls_read_key = open(tls_key).read() def passphrase(): return tls_passphrase tls_privateKey = parsePEMKey(tls_read_key, private=True, passwordCallback=passphrase) except: log(1, "Failed to load TLS key or certificate. STARTTLS will not be offered.") tls_certChain = None tls_privateKey = None tls_required = False ## ## Import plugins ## auth = __import__('plugins.%s' % config.get('main', 'auth', 'SASL').lower(), None, None, True) userdb = __import__('plugins.%s' % config.get('main', 'userdb', 'passwd').lower(), None, None, True) storage = __import__('plugins.%s' % config.get('main', 'storage', 'Dovecot').lower(), None, None, True) consumer = __import__('plugins.%s' % config.get('main', 'consumer', 'Dovecot').lower(), None, None, True) # If the same plugin is used in two places, recycle it authenticate = auth.PysievedPlugin(log, config) if userdb == auth: homedir = authenticate else: homedir = userdb.PysievedPlugin(log, config) if storage == auth: store = authenticate elif storage == userdb: store = homedir else: store = storage.PysievedPlugin(log, config) if consumer == auth: consume = authenticate elif consumer == userdb: consume = homedir elif consumer == storage: consume = store else: consume = consumer.PysievedPlugin(log, config) class handler(managesieve.RequestHandler): capabilities = consume.capabilities def __init__(self, *args): self.params = {} managesieve.RequestHandler.__init__(self, *args) def log(self, l, s): log(l, s) def list_mech(self): mechs = authenticate.mechanisms() self.log(5, "Announcing mechanisms : %r" % mechs) return mechs def do_sasl_first(self, mechanism, *args): self.log(5, "Starting SASL authentication (%s) : %s" % (mechanism, ' '.join(args))) ret = authenticate.do_sasl_first(mechanism, *args); if ret['result'] == 'CONT': self.log(5, "Need more SASL authentication : %r" % ret) else: self.log(5, "Finished SASL authentication : %r" % ret) return ret def do_sasl_next(self, b64_string): self.log(5, "Continuing SASL authentication : %s" % b64_string) ret = authenticate.do_sasl_next(b64_string); if ret['result'] == 'CONT': self.log(5, "Need more SASL authentication : %r" % ret) else: self.log(5, "Finished SASL authentication : %r" % ret) return ret def authenticate(self, username, passwd): self.log(5, "Authenticating %s" % username) self.params['username'] = username self.params['password'] = passwd return authenticate.auth(self.params) def get_homedir(self, username): self.params['username'] = username ret = homedir.lookup(self.params) self.log(5, "Plugin returned home : %r" % ret) if ret and not os.path.isabs(ret) and base: ret = os.path.join(base, ret) self.log(5, "Added base to home : %r" % ret) return ret def new_storage(self, homedir): self.params['homedir'] = homedir return store.create_storage(self.params) def get_tls_params(self): return {'required': tls_required, 'key': tls_privateKey, 'cert': tls_certChain} def pre_save(self, script): return consume.pre_save(tmpdir, script) def post_load(self, script): return consume.post_load(script) if options.stdin: sock = socket.fromfd(0, socket.AF_INET, socket.SOCK_STREAM) h = handler(sock, sock.getpeername(), None) else: import daemon s = Server((addr, port), handler) if not options.nodaemon: daemon.daemon(pidfile=pidfile) log(1, 'Listening on %s port %d' % (addr or "INADDR_ANY", port)) s.serve_forever() if __name__ == '__main__': main() ./README.Dovecot0000644000175100017510000001561412271535704012434 0ustar chaaschaasPysieved integration with Dovecot ================================= Dovecot authentication ---------------------- If you want to use Dovecot authentication, set the mux config item in the [Dovecot] session to the path to a client socket as defined in dovecot.conf, e.g. : dovecot.conf : auth default { socket listen { client { path = /var/run/dovecot/auth-client mode = 0666 } } } pysieved.ini : [Dovecot] mux = /var/run/dovecot/auth-client Dovecot userdb lookup --------------------- If you don't place user filters in their home directory but use the dovecot-sieve plugin's "sieve" variable to define their location, skip to the next section. If you want to use Dovecot userdb to get the uid/gid/home of the user, set the master config item in the [Dovecot] session to the path to a master socket as defined in dovecot.conf, e.g. : dovecot.conf : auth default { socket listen { master { path = /var/run/dovecot/auth-master mode = 0600 } } } pysieved.ini : [Dovecot] master = /var/run/dovecot/auth-master Dovecot SIEVE without a home directory -------------------------------------- Some people do not define a home directory for "virtual" dovecot accounts. Instead, they use a common directory containing per-use filters, e.g. in dovecot.conf : plugin { ... sieve = /var/sieve-scripts/%u.sieve } In that case, pysieved's virtual plugin is more appropriate for userdb lookups. Please note that pysieved supports different substitution variables, described in the sample pysieved.ini. For instance, you can use the template above as-is if you login with a simple username (no @ sign), but if you use a full e-mail address, the corresponding path setting would be : pysieved.ini: [Virtual] path = /var/sieve-scripts/%u@%d.sieve Dovecot socket permissions -------------------------- In an environment where all users are virtual and share the same uid/gid, it is possible to run pysieved as non-root by specifying NUMERIC uid/gid values in the [Dovecot] section, e.g. : pysieved.ini : [Dovecot] uid=1000 gid=100 If you do not intend to run pysieved as non-root, skip directly to the next section. Otherwise, special care may be needed so that pysieved can access the 'mux' and 'master' sockets (and write the pidfile) : read on ! The pidfile can be moved to a directory that is writeable by the specified uid/gid, e.g. : pysieved.ini : [main] pidfile = /var/run/pysieved/pysieved.pid The Dovecot client socket (mux) can safely be exported with 0666 permissions if the default value of 0660 does not work. As for the master socket, it can have restrictive permissions, as recommended in the Dovecot documentation, if you make it owned by the same user who owns the mail storage (which works out well if using the Dovecot deliver LDA with Postfix). E.g. : dovecot.conf : auth default { socket listen { master { path = /var/run/dovecot/auth-master mode = 0600 user = vmail group = vmail } } } pysieved.ini : [Dovecot] master = /var/run/dovecot/auth-master master.cf : dovecot unix - n n - - pipe flags=DRhu user=vmail:vmail argv=/usr/local/libexec/dovecot/deliver -f $sender -d $recipient User vmail and group vmail should be replaced with the correct names for the uid/gid that owns the virtual mail storage. Pysieved should also run with this uid/gid. Sharing the Dovecot's authentication socket with Postfix -------------------------------------------------------- If you use Postfix + Dovecot SASL, a common scenario places the client socket inside the Postfix chroot area, such as /var/spool/postfix/private/auth where the private directory is accessible only by the postfix user. If you also want to run pysieved with restricted uid/gid as described in the previous section (this is not necessary if you run pysieved with root privileges), you will have to make a few changes to the standard configuration. ### Using multiple authentication sockets If your version of Dovecot will allow the definition of multiple authentication sockets, the easiest way to accomodate both Postfix and pysieved is to use 2 different ones. The following example has been reported by David Ramsden to work with Dovecot 1.1.11, and may be fine for earlier 1.1 versions. dovecot.conf : auth default { socket listen { master { ... } client { path = /var/spool/postfix/private/auth ... } } socket listen { client { path = /var/run/dovecot/auth-client ... } } } ### Using a single authentication socket If you must use the same socket for Postfix and pysieved running with restricted uid/gid, you MUST move it to a different, public, directory. E.g. : dovecot.conf : auth default { socket listen { client { path = /var/run/dovecot/auth-client mode = 0666 } } } pysieved.ini : [Dovecot] mux = /var/run/dovecot/auth-client main.cf : smtpd_sasl_type = dovecot smtpd_sasl_path = /var/run/dovecot/auth-client master.cf: # service type private unpriv chroot wakeup maxproc command + args smtp inet n - n - - smtpd Note that if the socket is not under /var/spool/postfix you cannot chroot smtpd, hence the master.cf line above. If you insist on chrooting smtpd, place the socket under /var/spool/postfix but outside of the private directory and use a relative smtpd_sasl_path. E.g. : smtpd_sasl_path = auth/dovecot for a socket located at /var/spool/postfix/auth/dovecot. If the home directory is the Maildir ------------------------------------ You may have a setup where your users' home directories are their Maildirs. In this case, dovecot IMAPd will show "pysieved" and "dovecot.sieve" folders. There are several solutions to this problem, as detailed in [this email by Philippe Levan](http://woozle.org/list-archives/pysieved/msg00155.html): > A few options to not show a .dovecot.sieve file : > > 1. define a Dovecot home directory != mail directory > e.g. : > home resolved via userdb and > mail_location = maildir:~/Maildir > (http://wiki.dovecot.org/VirtualUsers#homedirs) > > 2. configure a "sieve" variable or return a "sieve" extra field > during userdb lookup pointing to an alternate name/location > e.g. : > plugin { > sieve = dovecot.sieve > } > (http://wiki.dovecot.org/LDA/Sieve) > > 3. hack the code in dovecot-sieve-X.X.X/src/cmusieve-plugin.c line 11 > e.g. : > #define SIEVE_SCRIPT_PATH "~/dovecot.sieve" The latter two require modifying the "active" value in the [Dovecot] section of the configuration file: [Dovecot] active = dovecot.sieve ./TODO0000644000175100017510000000016012271535704010630 0ustar chaaschaas* Figure out why sieveshell (from cyrus) doesn't like what we send it. * Does daemon mode really leave zombies? ./test.py0000755000175100017510000004674412271535704011516 0ustar chaaschaas#! /usr/bin/env 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 getpass import optparse import os import pwd import socket import sys import unittest from config import Config from plugins import TestConfig DEFAULT = { 'config': './test.ini', # This will be replaced currently logged-in user. 'user': 'foor', 'password': '', # This will be replaced by the current host's domain. 'domain': 'example.org', 'uid': -1, 'gid': -1, 'verbosity': 0, } class PluginsTest(unittest.TestCase): def setUp(self): global CONF global config self.conf = CONF self.config = config self.good_script = 'require ["fileinto"];\nfileinto "TEST";' self.bad_script = 'foo;' if self.conf['verbosity'] > 0: print def tearDown(self): sys.stdout.flush() def testDovecotAuth(self): try: from plugins import dovecot except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Dovecot', 'skip', False): print 'skipping (conf), ', return mux = self.config.get('Dovecot', 'mux', '') if not mux: print 'skipping (conf), ', return c = TestConfig(mux = mux, master = '', uid = -1, gid = -1) p = dovecot.PysievedPlugin(printlog, c) self.generic_sasl(p, self.conf['user'], self.conf['password']) def testDovecotLookup(self): try: from plugins import dovecot except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Dovecot', 'skip', False): print 'skipping (conf), ', return master = self.config.get('Dovecot', 'master', '') if not master: print 'skipping (conf), ', return c = TestConfig(mux = '', master = master, uid = -1, gid = -1) p = dovecot.PysievedPlugin(printlog, c) self.generic_lookup(p, self.conf['user']) def testDovecotSieveHasError(self): try: from plugins import dovecot except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Dovecot', 'skip', False): print 'skipping (conf), ', return sievec = self.config.get('Dovecot', 'sievec', '') if not sievec: print 'skipping (conf), ', return c = TestConfig(mux = '', master = '', sievec = sievec, uid = -1, gid = -1) p = dovecot.PysievedPlugin(printlog, c) self.assertEquals(None, p.sieve_has_error('/tmp', self.good_script)) self.assertNotEquals(None, p.sieve_has_error('/tmp', self.bad_script)) def testDovecotPreSave(self): try: from plugins import dovecot except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Dovecot', 'skip', False): print 'skipping (conf), ', return sievec = self.config.get('Dovecot', 'sievec', '') if not sievec: print 'skipping (conf), ', return c = TestConfig(mux = '', master = '', sievec = sievec, uid = -1, gid = -1) p = dovecot.PysievedPlugin(printlog, c) self.assertEquals(self.good_script, p.pre_save('/tmp', self.good_script)) def testDovecotPostLoad(self): try: from plugins import dovecot except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Dovecot', 'skip', False): print 'skipping (conf), ', return c = TestConfig(mux = '', master = '', uid = -1, gid = -1) p = dovecot.PysievedPlugin(printlog, c) self.assertEquals(self.good_script, p.post_load(self.good_script)) def testEximSieveHasError(self): try: from plugins import exim except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Exim', 'skip', False): print 'skipping (conf), ', return sendmail = self.config.get('Exim', 'sendmail', '') if not sendmail: print 'skipping (conf), ', return c = TestConfig(sendmail = sendmail, uid = -1, gid = -1) p = exim.PysievedPlugin(printlog, c) self.assertEquals(None, p.sieve_has_error('/tmp', '# Sieve filter\n' + self.good_script)) self.assertNotEquals(None, p.sieve_has_error('/tmp', self.bad_script)) def testEximPreSave(self): try: from plugins import exim except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Exim', 'skip', False): print 'skipping (conf), ', return sendmail = self.config.get('Exim', 'sendmail', '') if not sendmail: print 'skipping (conf), ', return c = TestConfig(sendmail = sendmail, uid = -1, gid = -1) p = exim.PysievedPlugin(printlog, c) self.assertEquals('# Sieve filter\n' + self.good_script, p.pre_save('/tmp', self.good_script)) def testEximPostLoad(self): try: from plugins import exim except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Exim', 'skip', False): print 'skipping (conf), ', return c = TestConfig(mux = '', master = '', uid = -1, gid = -1) p = exim.PysievedPlugin(printlog, c) self.assertEquals('# Sieve filter\n' + self.good_script, p.post_load('# Sieve filter\n' + self.good_script)) def testHtpasswdAuth(self): try: from plugins import htpasswd except ImportError: print 'skipping (deps), ', return if self.config.getboolean('htpasswd', 'skip', False): print 'skipping (conf), ', return passfile = self.config.get('htpasswd', 'passwdfile', '') if not passfile: print 'skipping (conf), ', return c = TestConfig(passwdfile = passfile) p = htpasswd.PysievedPlugin(printlog, c) if '@' in self.conf['user']: user = self.conf['user'].split('@')[0] else: user = self.conf['user'] self.generic_auth(p, user, self.conf['password']) self.generic_sasl(p, user, self.conf['password']) def testMysqlExpandQuery(self): try: from plugins import mysql except ImportError: print 'skipping (deps), ', return if self.config.getboolean('MySQL', 'skip', False): print 'skipping (conf), ', return auth_query = 'SELECT username FROM user WHERE username = %(username)s AND password = %(password)s and ACTIVE = 1' query, values = mysql.expand_query(auth_query, { 'username': 'foo', 'password': 'bar' }) self.assertEquals('SELECT username FROM user WHERE username = %s AND password = %s and ACTIVE = 1', query) self.assertEquals(2, len(values)) self.assertEquals('foo', values[0]) self.assertEquals('bar', values[1]) def testMysqlAuth(self): try: from plugins import mysql except ImportError: print 'skipping (deps), ', return if self.config.getboolean('MySQL', 'skip', False): print 'skipping (conf), ', return dbhost = self.config.get('MySQL', 'dbhost', '') dbname = self.config.get('MySQL', 'dbname', '') dbuser = self.config.get('MySQL', 'dbuser', '') dbpass = self.config.get('MySQL', 'dbpass', '') auth_query = self.config.get('MySQL', 'auth_query', '') if not (dbhost and dbname and dbuser and dbpass and auth_query): print 'skipping (conf), ', return c = TestConfig(dbhost = dbhost, dbname = dbname, dbuser = dbuser, dbpass = dbpass, auth_query = auth_query, user_query = '') p = mysql.PysievedPlugin(printlog, c) self.generic_auth(p, self.conf['user'], self.conf['password']) self.generic_sasl(p, self.conf['user'], self.conf['password']) def testMysqlLookup(self): try: from plugins import mysql except ImportError: print 'skipping (deps), ', return if self.config.getboolean('MySQL', 'skip', False): print 'skipping (conf), ', return dbhost = self.config.get('MySQL', 'dbhost', '') dbname = self.config.get('MySQL', 'dbname', '') dbuser = self.config.get('MySQL', 'dbuser', '') dbpass = self.config.get('MySQL', 'dbpass', '') user_query = self.config.get('MySQL', 'user_query', '') if not (dbhost and dbname and dbuser and dbpass and user_query): print 'skipping (conf), ', return c = TestConfig(dbhost = dbhost, dbname = dbname, dbuser = dbuser, dbpass = dbpass, auth_query = '', user_query = user_query) p = mysql.PysievedPlugin(printlog, c) self.generic_lookup(p, self.conf['user']) def testPamAuth(self): try: from plugins import pam except ImportError: print 'skipping (deps), ', return if self.config.getboolean('PAM', 'skip', False): print 'skipping (conf), ', return service = config.get('PAM', 'service', 'pysieved') c = TestConfig(service = service) p = pam.PysievedPlugin(printlog, c) if '@' in self.conf['user']: user = self.conf['user'].split('@')[0] else: user = self.conf['user'] self.generic_auth(p, user, self.conf['password']) self.generic_sasl(p, user, self.conf['password']) def testPasswdLookup(self): try: from plugins import passwd except ImportError: print 'skipping (deps), ', return if self.config.getboolean('passwd', 'skip', False): print 'skipping (conf), ', return c = TestConfig() p = passwd.PysievedPlugin(printlog, c) if '@' in self.conf['user']: user = self.conf['user'].split('@')[0] else: user = self.conf['user'] self.generic_lookup(p, user) def testSaslAuth(self): try: from plugins import sasl except ImportError: print 'skipping (deps), ', return if self.config.getboolean('SASL', 'skip', False): print 'skipping (conf), ', return mux = config.get('SASL', 'mux', '') service = config.get('SASL', 'service', 'pysieved') if not mux: print 'skipping (conf), ', return c = TestConfig(mux = mux, service = service) p = sasl.PysievedPlugin(printlog, c) self.generic_auth(p, self.conf['user'], self.conf['password']) self.generic_sasl(p, self.conf['user'], self.conf['password']) def testVirtualLookup(self): try: from plugins import virtual except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Virtual', 'skip', False): print 'skipping (conf), ', return c = TestConfig(uid = -1, gid = -1, defaultdomain = self.conf['domain'], path = '/shared/spool/active/%d/%0.1u/%1.1u/%u/sieve/') p = virtual.PysievedPlugin(printlog, c) try: user, domain = self.conf['user'].split('@', 1) except ValueError: user, domain = self.conf['user'], self.conf['domain'] home = p.lookup({'username': user}) printlog(2, 'lookup(%s) = %s' % (user, home)) self.assertEqual('/shared/spool/active/%s/%s/%s/%s/sieve/' % (self.conf['domain'], user[0], user[1], user), home) home = p.lookup({'username': '@'.join([user, domain])}) printlog(2, 'lookup(%s) = %s' % ('@'.join([user, domain]), home)) self.assertEqual('/shared/spool/active/%s/%s/%s/%s/sieve/' % (domain, user[0], user[1], user), home) def testCourierAuth(self): try: from plugins import courier except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Courier', 'skip', False): print 'skipping (conf), ', return mux = config.get('Courier', 'mux', '') uid = config.getint('Courier', 'uid', -1) gid = config.getint('Courier', 'uid', -1) if not mux: print 'skipping (conf), ', return c = TestConfig(mux = mux, uid = uid, gid = gid) p = courier.PysievedPlugin(printlog, c) if '@' in self.conf['user']: user = self.conf['user'].split('@')[0] else: user = self.conf['user'] self.generic_auth(p, user, self.conf['password']) self.generic_sasl(p, user, self.conf['password']) def testCourierLookup(self): try: from plugins import courier except ImportError: print 'skipping (deps), ', return if self.config.getboolean('Courier', 'skip', False): print 'skipping (conf), ', return mux = config.get('Courier', 'mux', '') uid = config.getint('Courier', 'uid', -1) gid = config.getint('Courier', 'uid', -1) if not mux: print 'skipping (conf), ', return c = TestConfig(mux = mux, uid = uid, gid = gid) p = courier.PysievedPlugin(printlog, c) if '@' in self.conf['user']: user = self.conf['user'].split('@')[0] else: user = self.conf['user'] self.generic_lookup(p, user) def generic_auth(self, plugin, login, password): auth = plugin.auth({'username': login, 'password': password}) printlog(2, 'auth(%s) = %r' % (login, auth)) self.assert_(auth) def generic_sasl(self, plugin, login, password): mechs = plugin.mechanisms() printlog(2, 'mechanisms() = %r' % mechs) self.assert_('PLAIN' in mechs) auth = plugin.do_sasl_first('PLAIN', b64_encode('\0%s\0%s' % (login, password))) printlog(2, 'do_sasl_first(%s) = %r' % (login, auth)) self.assert_('result' in auth) self.assert_(auth['result'] in ('OK', 'NO', 'BYE', 'CONT')) self.assertEquals('OK', auth['result']) self.assert_('username' in auth) def generic_lookup(self, plugin, user): home = plugin.lookup({'username': user}) printlog(2, 'lookup(%s) = %r' % (user, home)) self.assert_(home is not None) def printlog(l, s): global CONF if l <= CONF['verbosity']: print '=' * l, s def b64_encode(s): return s.encode('base64').replace('\n', '') def pick(name, options, config, defaults = {}, type = 'string'): # Command-line options take priority. try: value = getattr(options, name) except AttributeError: value = None except: raise # Try values from the configuration file next. if not value: if type == 'int': value = config.getint('Test', name, defaults.get(name, -1)) else: value = config.get('Test', name, defaults.get(name, None)) return value def main(defaults): global CONF global config # Parse command-line options. parser = optparse.OptionParser() parser.add_option('-c', '--config', help='Configuration file (default: %s)' % defaults.get('config', None), action='store', dest='config', default=defaults.get('config', None)) parser.add_option('-d', '--domain', help='Default domain', action='store', dest='domain', default=None) parser.add_option('-u', '--user', help='Test username', action='store', dest='user', default=None) parser.add_option('-p', '--password', help='Test password', action='store', dest='password', default=None) parser.add_option('-U', '--uid', help='Default uid', \ action='store', type='int', dest='uid', default=None) parser.add_option('-G', '--gid', help='Default gid', action='store', type='int', dest='gid', default=None) parser.add_option('-v', '--verbosity', help='Verbosity level', action='store', type='int', dest='verbosity', default=0) (options, args) = parser.parse_args() # Read config file. config = Config(options.config) # Build test configuration. CONF = {} CONF['user'] = pick('user', options, config, defaults) CONF['password'] = pick('password', options, config, defaults) CONF['domain'] = pick('domain', options, config, defaults) CONF['uid'] = pick('uid', options, config, defaults, 'int') CONF['gid'] = pick('gid', options, config, defaults, 'int') CONF['verbosity'] = pick('verbosity', options, config, defaults, 'int') print 'Testing with :' print '\tuser =\t%s' % CONF['user'] print '\tdomain =\t%s' % CONF['domain'] print '\tuid =\t%d' % CONF['uid'] print '\tgid =\t%d' % CONF['gid'] print if not CONF['password']: CONF['password'] = getpass.getpass('%s\'s password: ' % CONF['user']) print # Run test suite. suite = unittest.TestLoader().loadTestsFromTestCase(PluginsTest) unittest.TextTestRunner(verbosity=2).run(suite) if __name__ == '__main__': # User currently logged-in user as default. try: pw = pwd.getpwuid(os.getuid()) DEFAULT['user'] = pw[0] except: pass # Try and derive the domain from the current host's FQDN. try: fqdn = socket.getfqdn() if '.' in fqdn: DEFAULT['domain'] = '.'.join(fqdn.split('.')[-2:]) except: pass main(DEFAULT) ./managesieve.py0000755000175100017510000003176312271535704013016 0ustar chaaschaas#! /usr/bin/env 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 SocketServer import socket import time import os import sys try: from tlslite.api import * have_tls = True except: have_tls = False import version maxsize = 100000 def compact_traceback(): """Return a compact (1-line) traceback. Lifted from asyncore.py from the Python 2.4 distribution. """ t, v, tb = sys.exc_info() tbinfo = [] assert tb # Must have a traceback while tb: tbinfo.append(( tb.tb_frame.f_code.co_filename, tb.tb_frame.f_code.co_name, str(tb.tb_lineno) )) tb = tb.tb_next # just to be safe del tb file, function, line = tbinfo[-1] info = ' '.join(['[%s|%s|%s]' % x for x in tbinfo]) return (file, function, line), t, v, info class Hangup(Exception): pass class AuthenticateFirst(Exception): pass class RequestHandler(SocketServer.BaseRequestHandler): def __init__(self, request, client_address, server): self.user = None self.storage = None self.tls = None self.tls_params = self.get_tls_params() SocketServer.BaseRequestHandler.__init__(self, request, client_address, server) def log(self, l, s): print time.time(), "=" * l, s def send(self, *args): out = [] def flush(out): s = ' '.join(out) + '\r\n' self.log(3, 'S: %r' % s) self.write(s) del out[:] for a in args: if type(a) == type(()): out.append(' '.join(a)) elif len(a) > 200 or '"' in a: out.append('{%d}' % len(a)) flush(out) self.log(3, 'S: %r' % a) self.write(a) else: out.append('"%s"' % a) flush(out) def _rsp(self, rsp, code, reason): out = rsp if code: out += ' (%s)' % code if reason: out += ' "%s"' % reason out += '\r\n' self.log(3, 'S: %r' % out) self.write(out) def ok(self, code=None, reason=None): self._rsp('OK', code, reason) def no(self, code=None, reason=None): self._rsp('NO', code, reason) def bye(self, code=None, reason=None): self._rsp('BYE', code, reason) def bread(self, n): out = self.buf while len(out) < n: r = self.read(n - len(out)) if not r: raise Hangup() out += r self.buf = out[n:] s = out[:n] self.log(3, 'C: %r' % s) return s def readline(self): out = self.buf while True: pos = out.find('\r\n') if pos > -1: self.buf = out[pos+2:] s = out[:pos] self.log(3, 'C: %r' % (s + '\r\n')) return s r = self.read(1024) if not r: raise Hangup() out += r def handle(self): self.buf = '' self.write = lambda s: self.request.send(s) self.read = lambda n: self.request.recv(n) self.log(1, 'Connect from %r' % (self.client_address,)) self.do_capability() try: while True: try: cmd = self.get_command() except AssertionError, str: self.no(reason=str) continue try: func = getattr(self, 'do_%s' % (cmd[0].lower())) except AttributeError: self.no(reason='Unknown command') continue try: func(*cmd[1:]) except AuthenticateFirst: self.no(reason='Authenticate first') except TypeError, exc: if exc.args[0].startswith('do_') and 'arguments' in exc.args[0]: self.no(reason='Wrong number of arguments') continue else: raise except Hangup: pass except: nil, t, v, tbinfo = compact_traceback() self.log(-1, '[ERROR] %s:%s %s' % (t, v, tbinfo)) self.bye(reason='Server error') raise def finish(self): self.log(1, 'Disconnect') def get_command(self): oparts = [''] while True: s = self.readline() parts = s.split(' ') closed = True if not parts[0]: break for p in parts: if p[0] == '"': closed = False p = p[1:] if (p[-1] == '"' and (len(p) == 1 or p[-2] != '\\')): closed = True p = p[:-1] elif not closed: p += ' ' p = p.replace('\\"', '"') oparts[-1] += p if closed: oparts.append('') assert not oparts[-1], ('Misquoted argument', oparts) del oparts[-1] # Pull out {31+}-style parameters o = oparts[-1] if len(o) > 3 and o[0] == '{' and o[-2:] == '+}': try: n = int(o[1:-2]) except ValueError: continue oparts[-1] = self.bread(n) else: break assert oparts != [''], 'No command given' return oparts def check_auth(self): "Fail if not authenticated" if not self.storage: raise AuthenticateFirst() def do_authenticate(self, mechanism, *args): "2.1. AUTHENTICATE Command" assert not self.storage, 'Already authenticated' if self.tls_params['required'] and not self.tls: return self.no(code='ENCRYPT-NEEDED') # Handle initial exchange ret = self.do_sasl_first(mechanism, *args) while ret['result'] == 'CONT': # Server requests more data line = ('{%d}\r\n' % len(ret['msg'])) self.log(3, 'S: %r' % line) self.write(line) line = ('%s\r\n' % ret['msg']) self.log(3, 'S: %r' % line) self.write(line) # Read client string s = self.readline() if len(s) > 3 and s[0] == '{' and s[-2:] == '+}': # Literal string try: n = int(s[1:-2]) except ValueError: # Can't parse length return self.no(reason='Malformed string literal') else: s = self.bread(n) # Data should be followed by CRLF misc = self.readline() if len(misc) > 0: return self.no(reason='Malformed string literal') elif len(s) > 1 and s[0] == '"' and s[-1] == '"': # Quoted string s = s[1:-1] elif s == '*': # A single '*' cancels the exchange return self.no(reason='Authentication cancelled') else: # Neither literal nor quoted return self.no(reason='Malformed string') # Process client string ret = self.do_sasl_next(s) # Final result if ret['result'] == 'NO': return self.no(reason=ret['msg']) elif ret['result'] == 'BYE': self.bye(reason=ret['msg']) raise Hangup() # OK, get storage location for authorized user home = self.get_homedir(ret['username']) if not home: self.bye(reason='Server Error') raise Hangup() self.storage = self.new_storage(home) self.log(1, 'Authenticated user %s' % ret['username']) return self.ok() def do_starttls(self): "2.2. STARTTLS Command" assert not self.storage, 'Already authenticated' assert have_tls, 'No TLS support' assert self.tls_params['key'], 'Undefined TLS private key' assert self.tls_params['cert'], 'Undefined TLS certificate' self.ok(reason='Begin TLS negotiation now') try: self.buf = '' self.tls = TLSConnection(self.request) self.tls.handshakeServer(certChain=self.tls_params['cert'], privateKey=self.tls_params['key'], reqCert=False) self.write = lambda s: self.tls.write(s) self.read = lambda n: self.tls.read(n) return self.do_capability() except: import traceback traceback.print_exc() def do_logout(self): "2.3. LOGOUT Command" self.ok() raise Hangup() def do_capability(self): "2.4. CAPABILITY Command" self.send('IMPLEMENTATION', version.version) if self.tls or not self.tls_params['required']: self.send('SASL', ' '.join(self.list_mech())) else: self.send('SASL') self.send('SIEVE', self.capabilities) if self.tls_params['key'] and self.tls_params['cert'] and not self.tls: self.send('STARTTLS') self.ok() def do_havespace(self, name, size): "2.5. HAVESPACE Command" self.check_auth() try: s = int(size) except ValueError: return self.no(reason='Not a number') if int(size) < maxsize: return self.ok() else: return self.no(code='QUOTA', reason='Quota exceeded') def do_putscript(self, name, content): "2.6. PUTSCRIPT Command" self.check_auth() try: self.storage[name] = self.pre_save(content) except ValueError, reason: return self.no(reason=reason) return self.ok() def do_listscripts(self): "2.7. LISTSCRIPTS Command" self.check_auth() for i in self.storage: if self.storage.is_active(i): self.send(i, ('ACTIVE',)) else: self.send(i) return self.ok() def do_setactive(self, name): "2.8. SETACTIVE Command" self.check_auth() try: if not name: self.storage.set_active(None) else: self.storage.set_active(name) except KeyError: return self.no(reason='No script by that name') except Exception, e: self.log(3, 'caught exception %s: %s' % (type(e), str(e))) return self.no() return self.ok() def do_getscript(self, name): "2.9. GETSCRIPT Command" self.check_auth() try: s = self.post_load(self.storage[name]) except KeyError: return self.no(reason='No script by that name') line = ('{%d}\r\n' % len(s)) self.log(3, 'S: %r' % line) self.write(line) line = ('%s\r\n' % s) self.log(3, 'S: %r' % line) self.write(line) return self.ok() def do_deletescript(self, name): "2.10. DELETESCRIPT Command" self.check_auth() try: del self.storage[name] except ValueError: return self.no(reason='Script is active') except KeyError: return self.no(reason='No script by that name') return self.ok() def list_mech(self): raise NotImplementedError() def do_sasl_first(self, mechanism, *args): raise NotImplementedError() def do_sasl_next(self, b64_string): raise NotImplementedError() def authenticate(self, username, passwd): raise NotImplementedError() def get_homedir(self, username): raise NotImplementedError() def new_storage(self, homedir): raise NotImplementedError() def get_tls_params(self): return {'required': False, 'key': None, 'cert': None} def pre_save(self, script): raise NotImplementedError() def post_load(self, script): raise NotImplementedError() ./THANKS0000644000175100017510000000335212271535704011061 0ustar chaaschaasThanks to: * Robert Schetterer for convincing me to make things more modular, plus weeks worth of patient debugging * Petr Smotek for writing the MySQL auth and userdb modules * Joakim Ryden for the xinetd configuration * David Anderson for the initial htpasswd2 module, and a tip about the Dovecot Authentication Protocol * Jonathan Stewart for a few bugfixes * Philippe Levan for: * lots of work off the dovecot module, including implementing real SASL * providing better technical support than I do on the mail list * the "activefile" patch to work around dotfile symlinks with Dovecot IMAPd * fixing a really awful "bindaddr" patch I created and didn't test * fixing up README.Dovecot to address selinux permission problems * Christian Rößner for a bugfix to the dovecot module * Konrad Rzentarzewski for a bugfix to the mysql module and an addition to the capabilities announcement * Paweł Andziak for a bug report and potential fix * Florian Heinle for a bug report that led to removal of Konrad's capabilities addition :) * Farkas Levente for the RPM spec file * Modestas Vainius for a bugfix to pam.py * David Ramsden for the Dovecot tip to use multiple authentication sockets for Postfix and pysieved * Claudemir Todo Bom for the original code to store Exim SIEVE scripts in MySQL. * Hrvoje Habjani for the Courier authentication code and lmtp storage/consumer code. ./README0000644000175100017510000000603612271535704011030 0ustar chaaschaaspysieved: Python Managesieve Server =================================== This is a GPL managesieve server. It uses a plug-in architecture to support different authentication, homedir lookup, and storage back-ends. Originally written by Neale Pickett for use with avelsieve (SquirrelMail), Postfix and Dovecot. It should work with other managesieve clients too. Please share with us your successes and failures. Plugin architecture ------------------- The server ships with the following plug-ins: Authentication: * [Dovecot](http://gitorious.org/pysieved/pages/Dovecot) * /etc/passwd, /etc/shadow ([dev branch](http://gitorious.org/pysieved/pysieved/commits/dev)) * PAM * SASL * LDAP ([dev branch](http://gitorious.org/pysieved/pysieved/commits/dev)) * MySQL * Courier ([dev branch](http://gitorious.org/pysieved/pysieved/commits/dev)) Homedir lookup & session initiation: * Dovecot * /etc/passwd * LDAP * MySQL * simple virtual hosting (eg. /var/lib/virtual/username) Storage: * Dovecot (.dovecot.sieve) * Exim (.forward) * MySQL ([dev branch](http://gitorious.org/pysieved/pysieved/commits/dev)) * lmtpd ([dev branch](http://gitorious.org/pysieved/pysieved/commits/dev)) Consumer ([dev branch](http://gitorious.org/pysieved/pysieved/commits/dev)): * Dovecot * [Exim](http://gitorious.org/pysieved/pages/Exim) * lmtpd ([dev branch](http://gitorious.org/pysieved/pysieved/commits/dev)) Additional back-ends are easy to write, just copy one of the existing back-ends and start hacking. No modifications are needed to any existing code, so you don't have to worry about things like the managesieve protocol or forking. Download -------- Version 1.2 was released on January 27, 2014. You can get the latest version [as a tarball](http://gitorious.org/pysieved/pysieved/archive-tarball/master), or with git: git clone git://gitorious.org/pysieved/pysieved.git A [web view of revisions](http://gitorious.org/pysieved/pysieved) is also available for those without git. If you like being on the bleeding edge, try the [dev branch](http://gitorious.org/pysieved/pysieved/commits/dev) Installation ------------ Put all the files somewhere, for instance /usr/local/lib/pysieved. Copy pysieved.ini into /usr/local/etc/, and edit to taste. It's commented. To run from inetd, add the following line to /etc/inetd.conf: sieve stream tcp nowait root /usr/bin/python python /usr/local/lib/pysieved/pysieved.py --inetd To run as a daemon, just run python pysieved.py Troubleshooting --------------- If you encounter problems, try the tips in the [TROUBLESHOOTING document](http://gitorious.org/pysieved/pages/Troubleshooting). Mail list / IRC channel ----------------------- If you use pysieved, please join the pysieved mail list by emailing [pysieved-subscribe@woozle.org](mailto:pysieved-subscribe@woozle.org) or visiting the [subscription page](http://woozle.org/lists/pysieved). To talk about pysieved on IRC, join us in [#pysieved on irc.oftc.net](irc://irc.oftc.net/pysieved). -------- Neale Pickett and Philippe Levan ./TROUBLESHOOTING0000644000175100017510000001220112271535704012351 0ustar chaaschaasTroubleshooting Pysieved ======================== Before you start ---------------- Make sure SIEVE is working for your mail server without pysieved. For Dovecot, manually create a .dovecot.sieve file in the user's "home directory" or whatever directory you configured in the dovecot-sieve (aka cmusieve) plugin. Sample filter : require ["fileinto"]; if header :contains "Subject" "Test" { fileinto "Test"; stop; } For Exim, the file to use is .forward in the user's home directory. In addition to the SIEVE code itself, the .forward file for Exim must contain and start with the line : # Sieve filter If a message with "Test" in the subject does not get delivered to the "Test" folder, you need to troubleshoot Dovecot or Exim first. Hints : * Is SIEVE support compiled in/configured ? - Did you list the older cmusieve or rewritten sieve plugin in Dovecot's lda section's mail_plugins ? - Is the library present in the mail_plugin_dir ? * Is Dovecot looking for the script in the right place ? - Is your userdb returning a home for the user ? - Otherwise, did you set the plugin's sieve variable ? * Is the script syntactically correct ? - Dovecot uses sievec to compile the script into bytecode. - Exim has a test function in its modified sendmail. If you are planning to use Dovecot as the auth and/or userdb plugin, please make sure that logins to Dovecot via POP3 or IMAP are working. Check the logs -------------- By default pysieved will send some basic information to syslog. Depending on your system logger's configuration, that information may end up in different files, usually under /var/log. Some systems have a single file for all mail-related logs, some systems spread it between different files based on severity, and others may create a log file based on the program name. If in doubt, check your system logger's configuration file. Although you will get limited information at the default verbosity level, it will tell you whether pysieved actually saw a connection (if not, you'd better check your MANAGESIEVE client's configuration) and whether authentication succeeded. If you see a connection but there are no log entries about successful logins, either the auth or the userdb plugin failed. Don't forget to check the logs relevant to the plugin(s) you selected, such as Dovecot's syslogs. Increase the verbosity level ---------------------------- If logging at the default level does not seem to provide any useful information, you can increase pysieved's verbosity level. The best way to do that without having to go back and check the logs every time is to run it in debug mode at the highest verbosity level. python pysieved.py -d -v 9 The debug option keeps pysieved running in the foreground and attached to your terminal so that you can see log messages and exceptions. You will need a verbosity level of at least 3 to see all interactions between pysieved and the client that connected to it. Some plugins, such as Dovecot will log additional information at level 4 and up. Even if the output doesn't mean anything to you, this is the most complete information that you can provide us when asking for help. A note of caution : if the output shows that PLAIN authentication is being used, you may want to obfuscate the base64-encoded string that follows, as the password can easily be recovered from it. While you are at it, you can check for yourself that the credentials that are sent to pysieved are what you would expect. For instance, if you see this : C: AUTHENTICATE "PLAIN" "AHVzZXIAcGFzcw==" You can do this : perl -MMIME::Base64 -e 'print decode_base64("AHVzZXIAcGFzcw==")' | od -c 0000000 \0 u s e r \0 p a s s 0000012 Simulate a connection to pysieved --------------------------------- As long as you haven't required encryption and you configured an authentication plugin that accepts PLAIN authentication, you can manually interact with pysieved to make sure it is working, independently from whatever client you plan on using. First, you will need the base64-encoded credentials : perl -MMIME::Base64 -e 'print encode_base64("\0user\0pass")' AHVzZXIAcGFzcw== That's \0, followed by your login name, followed by \0, and finally your password. If your login name is a full e-mail address, you will need to escape the @ sign with a backslash i.e. "\0user\@domain\0password". Now you are ready to use telnet to interact with pysieved (in the following sample session, whenever 'OK' appears, pysieved is waiting for you to enter the next line) : telnet localhost 2000 Trying 127.0.0.1... Connected to localhost. Escape character is '^]'. "IMPLEMENTATION" "pysieved 0.91+DEV" "SASL" "LOGIN PLAIN" "SIEVE" "fileinto reject envelope vacation imapflags notify subaddress relational comparator-i;ascii-numeric" "STARTTLS" OK AUTHENTICATE "PLAIN" "AHVzZXIAcGFzcw==" OK LISTSCRIPTS "phpscript" ACTIVE OK GETSCRIPT "phpscript" {86} require ["fileinto"]; if header :contains "Subject" "Test" { fileinto "Test"; stop; } OK LOGOUT OK Connection to localhost closed by foreign host.