[MERGE] improved and reviewed base_crypt for v6 (promoted from extra-addons)

bzr revid: odo@openerp.com-20101229133835-9ysqp1vyp60af50t

5 files changed, 399 insertions, 0 deletions

diff --git a/addons/base_crypt/__init__.py b/addons/base_crypt/__init__.py
new file mode 100755
index 00000000000..a8b9a6b0740
--- /dev/null
+++ b/addons/base_crypt/__init__.py
@@ -0,0 +1,23 @@
+##############################################################################
+#    
+#    OpenERP, Open Source Management Solution
+#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.     
+#
+##############################################################################
+
+from service import security
+import crypt
+
diff --git a/addons/base_crypt/__openerp__.py b/addons/base_crypt/__openerp__.py
new file mode 100755
index 00000000000..d6c0bbd82e3
--- /dev/null
+++ b/addons/base_crypt/__openerp__.py
@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#    
+#    OpenERP, Open Source Management Solution
+#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+{
+    "name" : "Base - Password Encryption",
+    "version" : "1.1",
+    "author" : "FS3 & OpenERP SA",
+    "maintainer" : "OpenERP SA",
+    "website" : "http://www.openerp.com",
+    "category" : "Generic Modules/Base",
+    "description": """This module replaces the cleartext password in the database with a password hash,
+preventing anyone from reading the original password.
+For your existing user base, the removal of the cleartext passwords occurs the first time
+a user logs into the database, after installing base_crypt.
+After installing this module it won't be possible to recover a forgotten password for your
+users, the only solution is for an admin to set a new password.
+
+Note: installing this module does not mean you can ignore basic security measures,
+as the password is still transmitted unencrypted on the network (by the client),
+unless you are using a secure protocol such as XML-RPCS.
+                    """,
+    "depends" : ["base"],
+    "data" : [],
+    "active": False,
+    "installable": True,
+}
diff --git a/addons/base_crypt/crypt.py b/addons/base_crypt/crypt.py
new file mode 100755
index 00000000000..259404dc95b
--- /dev/null
+++ b/addons/base_crypt/crypt.py
@@ -0,0 +1,256 @@
+# Notice:
+# ------
+#
+# Implements encrypting functions.
+#
+# Copyright (c) 2008, F S 3 Consulting Inc.
+#
+# Maintainer:
+# Alec Joseph Rivera (agi<at>fs3.ph)
+#
+#
+# Warning:
+# -------
+#
+# This program as  such is intended to be used by  professional programmers
+# who take the whole responsibility of assessing all potential consequences
+# resulting  from its eventual  inadequacies and  bugs.  End users  who are
+# looking  for a  ready-to-use  solution  with  commercial  guarantees  and
+# support are strongly adviced to contract a Free Software Service Company.
+#
+# 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.
+
+from random import seed, sample
+from string import letters, digits
+from osv import fields,osv
+import pooler
+import tools
+from tools.translate import _
+from service import security
+
+magic_md5 = '$1$'
+
+def gen_salt( length=8, symbols=letters + digits ):
+    seed()
+    return ''.join( sample( symbols, length ) )
+
+# The encrypt_md5 is based on Mark Johnson's md5crypt.py, which in turn is
+# based on  FreeBSD src/lib/libcrypt/crypt.c (1.2)  by  Poul-Henning Kamp.
+# Mark's port can be found in  ActiveState ASPN Python Cookbook.  Kudos to
+# Poul and Mark. -agi
+#
+# Original license:
+#
+# * "THE BEER-WARE LICENSE" (Revision 42):
+# *
+# * <phk@login.dknet.dk>  wrote  this file.  As  long as  you retain  this
+# * notice  you can do  whatever you want with this stuff. If we meet some
+# * day,  and you think this stuff is worth it,  you can buy me  a beer in
+# * return.
+# *
+# * Poul-Henning Kamp
+
+import md5
+
+def encrypt_md5( raw_pw, salt, magic=magic_md5 ):
+    hash = md5.new( raw_pw + magic + salt )
+    stretch = md5.new( raw_pw + salt + raw_pw).digest()
+
+    for i in range( 0, len( raw_pw ) ):
+        hash.update( stretch[i % 16] )
+
+    i = len( raw_pw )
+
+    while i:
+        if i & 1:
+            hash.update('\x00')
+        else:
+            hash.update( raw_pw[0] )
+        i >>= 1
+
+    saltedmd5 = hash.digest()
+
+    for i in range( 1000 ):
+        hash = md5.new()
+
+        if i & 1:
+            hash.update( raw_pw )
+        else:
+            hash.update( saltedmd5 )
+
+        if i % 3:
+            hash.update( salt )
+        if i % 7:
+            hash.update( raw_pw )
+        if i & 1:
+            hash.update( saltedmd5 )
+        else:
+            hash.update( raw_pw )
+
+        saltedmd5 = hash.digest()
+
+    itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'
+
+    rearranged = ''
+    for a, b, c in ((0, 6, 12), (1, 7, 13), (2, 8, 14), (3, 9, 15), (4, 10, 5)):
+        v = ord( saltedmd5[a] ) << 16 | ord( saltedmd5[b] ) << 8 | ord( saltedmd5[c] )
+
+        for i in range(4):
+            rearranged += itoa64[v & 0x3f]
+            v >>= 6
+
+    v = ord( saltedmd5[11] )
+
+    for i in range( 2 ):
+        rearranged += itoa64[v & 0x3f]
+        v >>= 6
+
+    return magic + salt + '$' + rearranged
+
+class users(osv.osv):
+    _name="res.users"
+    _inherit="res.users"
+    # agi - 022108
+    # Add handlers for 'input_pw' field.
+
+    def set_pw(self, cr, uid, id, name, value, args, context):
+        if not value:
+            raise osv.except_osv(_('Error'), _("Please specify the password !"))
+
+        obj = pooler.get_pool(cr.dbname).get('res.users')
+        if not hasattr(obj, "_salt_cache"):
+            obj._salt_cache = {}
+
+        salt = obj._salt_cache[id] = gen_salt()
+        encrypted = encrypt_md5(value, salt)
+        cr.execute('update res_users set password=%s where id=%s',
+            (encrypted.encode('utf-8'), int(id)))
+        cr.commit()
+        del value
+
+    def get_pw( self, cr, uid, ids, name, args, context ):
+        cr.execute('select id, password from res_users where id in %s', (tuple(map(int, ids)),))
+        stored_pws = cr.fetchall()
+        res = {}
+
+        for id, stored_pw in stored_pws:
+            res[id] = stored_pw
+
+        return res
+
+    _columns = {
+        # The column size could be smaller as it is meant to store a hash, but
+        # an existing column cannot be downsized; thus we use the original
+        # column size.
+        'password': fields.function(get_pw, fnct_inv=set_pw, type='char',
+            method=True, size=64, string='Password', invisible=True,
+            store=True),
+    }
+
+    def login(self, db, login, password):
+        cr = pooler.get_db(db).cursor()
+        cr.execute('select password, id from res_users where login=%s',
+            (login.encode('utf-8'),))
+        stored_pw = id = cr.fetchone()
+
+        if stored_pw:
+            stored_pw = stored_pw[0]
+            id = id[1]
+        else:
+            # Return early if there is no such login.
+            return False
+
+        stored_pw = self.maybe_encrypt(cr, stored_pw, id)
+
+        # Calculate an encrypted password from the user-provided
+        # password.
+        obj = pooler.get_pool(db).get('res.users')
+        if not hasattr(obj, "_salt_cache"):
+            obj._salt_cache = {}
+        salt = obj._salt_cache[id] = stored_pw[len(magic_md5):11]
+        encrypted_pw = encrypt_md5(password, salt)
+
+        # Check if the encrypted password matches against the one in the db.
+        cr.execute('select id from res_users where id=%s and password=%s and active', (int(id), encrypted_pw.encode('utf-8')))
+        res = cr.fetchone()
+        cr.close()
+
+        if res:
+            return res[0]
+        else:
+            return False
+
+    def check(self, db, uid, passwd):
+        # Get a chance to hash all passwords in db before using the uid_cache.
+        obj = pooler.get_pool(db).get('res.users')
+        if not hasattr(obj, "_salt_cache"):
+            obj._salt_cache = {}
+            self._uid_cache.get(db, {}).clear()
+
+        cached_pass = self._uid_cache.get(db, {}).get(uid)
+        if (cached_pass is not None) and cached_pass == passwd:
+            return True
+
+        cr = pooler.get_db(db).cursor()
+        if uid not in obj._salt_cache:
+            cr.execute('select login from res_users where id=%s', (int(uid),))
+            stored_login = cr.fetchone()
+            if stored_login:
+                stored_login = stored_login[0]
+
+            if not self.login(db,stored_login,passwd):
+                return False
+
+        salt = obj._salt_cache[uid]
+        cr.execute('select count(id) from res_users where id=%s and password=%s',
+            (int(uid), encrypt_md5(passwd, salt)))
+        res = cr.fetchone()[0]
+        cr.close()
+        if not bool(res):
+            raise Exception('AccessDenied')
+
+        if res:
+            if self._uid_cache.has_key(db):
+                ulist = self._uid_cache[db]
+                ulist[uid] = passwd
+            else:
+                self._uid_cache[db] = {uid: passwd}
+        return bool(res)
+
+    def maybe_encrypt(self, cr, pw, id):
+        # If the password 'pw' is not encrypted, then encrypt all passwords
+        # in the db. Returns the (possibly newly) encrypted password for 'id'.
+
+        if pw[0:len(magic_md5)] != magic_md5:
+            cr.execute('select id, password from res_users')
+            res = cr.fetchall()
+            for i, p in res:
+                encrypted = p
+                if p[0:len(magic_md5)] != magic_md5:
+                    encrypted = encrypt_md5(p, gen_salt())
+                    cr.execute('update res_users set password=%s where id=%s',
+                        (encrypted.encode('utf-8'), int(i)))
+                if i == id:
+                    encrypted_res = encrypted
+            cr.commit()
+            return encrypted_res
+        return pw
+
+users()
+# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
diff --git a/addons/base_crypt/i18n/base_crypt.pot b/addons/base_crypt/i18n/base_crypt.pot
new file mode 100755
index 00000000000..d62691cb699
--- /dev/null
+++ b/addons/base_crypt/i18n/base_crypt.pot
@@ -0,0 +1,37 @@
+# Translation of OpenERP Server.
+# This file contains the translation of the following modules:
+#	* base_crypt
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: OpenERP Server 5.0.6\n"
+"Report-Msgid-Bugs-To: support@openerp.com\n"
+"POT-Creation-Date: 2009-11-26 09:12:09+0000\n"
+"PO-Revision-Date: 2009-11-26 09:12:09+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: base_crypt
+#: model:ir.module.module,description:base_crypt.module_meta_information
+msgid "Module for password encryption."
+msgstr ""
+
+#. module: base_crypt
+#: constraint:ir.ui.view:0
+msgid "Invalid XML for View Architecture!"
+msgstr ""
+
+#. module: base_crypt
+#: model:ir.module.module,shortdesc:base_crypt.module_meta_information
+msgid "Base"
+msgstr ""
+
+#. module: base_crypt
+#: field:res.users,input_pw:0
+msgid "Password"
+msgstr ""
+
diff --git a/addons/base_crypt/i18n/sv.po b/addons/base_crypt/i18n/sv.po
new file mode 100644
index 00000000000..a20776a2100
--- /dev/null
+++ b/addons/base_crypt/i18n/sv.po
@@ -0,0 +1,40 @@
+# Translation of OpenERP Server.
+# This file contains the translation of the following modules:
+#	* base_crypt
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: OpenERP Server 5.0.14\n"
+"Report-Msgid-Bugs-To: support@openerp.com\n"
+"POT-Creation-Date: 2009-11-26 09:12+0000\n"
+"PO-Revision-Date: 2010-11-23 02:16+0000\n"
+"Last-Translator: Olivier Dony (OpenERP) <Unknown>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Launchpad-Export-Date: 2010-12-15 05:38+0000\n"
+"X-Generator: Launchpad (build Unknown)\n"
+
+#. module: base_crypt
+#: model:ir.module.module,description:base_crypt.module_meta_information
+msgid "Module for password encryption."
+msgstr ""
+
+#. module: base_crypt
+#: constraint:ir.ui.view:0
+msgid "Invalid XML for View Architecture!"
+msgstr ""
+
+#. module: base_crypt
+#: model:ir.module.module,shortdesc:base_crypt.module_meta_information
+msgid "Base"
+msgstr ""
+
+#. module: base_crypt
+#: field:res.users,input_pw:0
+msgid "Password"
+msgstr ""
+
+#~ msgid "Module for password encryption.KKKKKKKKKKKKKKKKKKK"
+#~ msgstr "Module for password encryption.KKKKKKKKKKKKKKKKKKK"