commit 8f7ba6a4f00cfdd5c571d83c36e988a6d89173ee Author: Janek Bevendorff Date: Mon Oct 19 18:29:41 2015 +0200 Initial commit diff --git a/.htaccess b/.htaccess new file mode 100644 index 0000000..8fdf534 --- /dev/null +++ b/.htaccess @@ -0,0 +1,8 @@ +RewriteEngine on +RewriteCond %{HTTPS} !=on +RewriteCond %{ENV:HTTPS} !=on +RewriteRule .* https://%{HTTP_HOST}%{REQUEST_URI} [R=301,L,NE] + +Options +ExecCGI +AddHandler cgi-script .py +DirectoryIndex index.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c304d1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..17ad562 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# VMailMgr chpw CGI + +This is a Python CGI script that lets virtual `VMailMgr`/`qmail` users change +their own mail passwords via a web interface. + +This script is specifically tailored to work on hosts at +[uberspace.de](https://uberspace.de). But it may also work on other qmail-based +systems as long as virtual mail users are managed via `VMailMgr`. + +## Installation +In order to make this script executable, you need to install `python-cdb` as +it is a required dependency: + + easy_install-2.7 python-cdb + +After that, simply extract all the repository contents into a folder under +your document root. No paths need to be configured. Only make sure that the +location is reachable via HTTPS. + +## Acknowledgements +This is a majorly refined version of a script originally developed by Dirk Boye. +See [dirkboye/mailpw_change](https://github.com/dirkboye/mailpw_change) at GitHub +for the original source code. + +## FAQ +* *Q:* Why still Python 2.7?
+ *A:* We need `python-cdb` to parse the weird binary password database. + Unfortunately, `python-cdb` seems to be only available for Python 2. + +* *Q:* Can I use the script via unencrypted HTTP?
+ *A:* No, HTTPS is hard-coded. So unless you change that in the code, you can't. + And honestly, you really shouldn't. + +* *Q:* Do I need to put the script in `/cgi-bin/`?
+ *A:* In most cases, no. The script comes with an `.htaccess` that enables CGI + execution for the current directory. Generally, that should work. If not, your + administrator may have disabled option overriding in which case you actually + need to put it in `/cgi-bin/`. But in most cases (and especially on Uberspaces) + it should work just fine. + +* *Q:* I only get an error 500 and the log file says something about suEXEC + policy violation. How do I fix that?
+ *A:* Make sure both the `index.py` as well as the containing directory have + the permissions `0755`. Any higher permissions will usually result in that error. diff --git a/index.py b/index.py new file mode 100755 index 0000000..036856f --- /dev/null +++ b/index.py @@ -0,0 +1,98 @@ +#!/usr/bin/env python2.7 +import cgi +import cgitb +import pwd, sys, os, cdb, subprocess +from subprocess import check_output, Popen, PIPE +from os.path import expanduser + +cgitb.enable() +home_dir = expanduser("~") + +def check_form(formvars, form): + for varname in formvars: + if varname not in form.keys(): + return False + else: + if type(form[varname].value) is not type(''): + return None + return True + +def read_template_file(filename, **vars): + with open('tpl/' + filename, 'r') as f: + template = f.read() + for key in vars: + template = template.replace('{$' + key + '}', vars[key]) + return template + +def check_oldpw(accountname, oldpass): + passwd_dbfile = os.path.abspath(home_dir + "/passwd.cdb"); + try: + db = cdb.init(passwd_dbfile) + except: + return 'No user database found.' + try: + cdb_user_data=db[accountname] + except: + return 'User not found or password incorrect.' + passhash = cdb_user_data[6:40] + # Hash algorithm is given between first two $ of passhash (here only md5 based BSD password is used) + hashtype = '1' + # Salt is given between next two $ + salt = passhash[3:11] + opensslargs = ['openssl', 'passwd', '-' + hashtype, '-salt', salt, oldpass]; + newhash = check_output(opensslargs).strip(); + if newhash == passhash: + return '' + return 'User not found or password incorrect.' + +def generate_headers(): + return "Content-Type: text/html; charset=utf-8\n" + +def main(): + main_content = '' + + form = cgi.FieldStorage() + if 'submit' in form.keys(): + formvars = ['accountname', 'oldpass', 'newpass', 'newpass2'] + form_ok = check_form(formvars, form) + if form_ok == True: + accountname = form['accountname'].value + accountname = accountname.split("@")[0] + oldpass = form['oldpass'].value + newpass = form['newpass'].value + newpass2 = form['newpass2'].value + if newpass == newpass2: + if check_oldpw(accountname, oldpass) == '': + vpasswdargs = ['vpasswd', accountname] + # Environmental variable HOME is needed for vpasswd to work + os.environ['HOME'] = home_dir + p = Popen(vpasswdargs, stdin=PIPE, stdout=PIPE, stderr=subprocess.STDOUT) + p.stdin.write(newpass + '\n') + p.stdin.write(newpass2 + '\n') + p.stdin.close() + if p.wait() == 0: + # We did it + main_content = read_template_file('success.tpl') + else: + main_content = read_template_file('fail.tpl', message=cgi.escape(p.stdout.read())) + else: + main_content = read_template_file('fail.tpl', message=cgi.escape( check_oldpw(accountname, oldpass))) + else: + main_content = read_template_file('fail.tpl', message='Passwords to not match.') + elif form_ok == False: + main_content = read_template_file('fail.tpl', message='All fields are required.') + else: + main_content = read_template_file('fail.tpl', message='Invalid data type supplied.') + else: + # Submit button not pressed, show form + formaction = cgi.escape("https://" + os.environ["HTTP_HOST"] + os.environ["REQUEST_URI"]) + form = read_template_file('form.tpl', formaction=formaction) + main_content = form + + response = generate_headers() + "\n" + response += read_template_file('main.tpl', main_content=main_content) + print(response) + +if __name__ == "__main__": + main() + diff --git a/tpl/.htaccess b/tpl/.htaccess new file mode 100644 index 0000000..cb24fd7 --- /dev/null +++ b/tpl/.htaccess @@ -0,0 +1,2 @@ +Order allow,deny +Deny from all diff --git a/tpl/fail.tpl b/tpl/fail.tpl new file mode 100644 index 0000000..8cd0d7a --- /dev/null +++ b/tpl/fail.tpl @@ -0,0 +1,5 @@ +
+

Oops, something went wrong…

+

Message: {$message}

+ Try again +
diff --git a/tpl/form.tpl b/tpl/form.tpl new file mode 100644 index 0000000..4be6dbc --- /dev/null +++ b/tpl/form.tpl @@ -0,0 +1,13 @@ +
+
+

+

+

+

+

+

+

+

+

+
+
diff --git a/tpl/main.tpl b/tpl/main.tpl new file mode 100644 index 0000000..f140814 --- /dev/null +++ b/tpl/main.tpl @@ -0,0 +1,82 @@ + + + +Change Mailbox Password + + + +
+

Change Mailbox Password

+ {$main_content} +
+ + diff --git a/tpl/success.tpl b/tpl/success.tpl new file mode 100644 index 0000000..8739697 --- /dev/null +++ b/tpl/success.tpl @@ -0,0 +1 @@ +

Your password was changed successfully.