Changeset 3258

Timestamp:

05/26/07 08:35:08 (1 year ago)

Author:

mscott

Message:

Merging branch for #53.

- Add `HashedPassword` field type and failing test for hashing unicode
  strings.

- Make `HashedValue` field accept unicode values -- they are encoded to
  utf8 strings before hashing and comparison operations.

- Deprecate `Password` field and show deprecation warning.
 
- Alter tests to no longer use `Password` field except when checking
  for deprecation warning of its usage.  Tests that previously used
  `Password` now use `HashedPassword`.
 
- Remove `schevo.icon.schema` and `schevo.identity` packages, as
  schema importing is no longer supported.  Also removed references to
  those from entry points in ``setup.py`` by entirely removing the
  `schevo.schema_export` section.
 
- Documentation about `HashedPassword`

- Documentation about deprecation of `Password` field type.

Files:

• trunk/Schevo/doc/SchevoSchemaDefinition.txt (modified) (3 diffs)
• trunk/Schevo/schevo/field.py (modified) (8 diffs)
• trunk/Schevo/schevo/fieldspec.py (modified) (1 diff)
• trunk/Schevo/schevo/icon/__init__.py (modified) (1 diff)
• trunk/Schevo/schevo/icon/schema (deleted)
• trunk/Schevo/schevo/identity (deleted)
• trunk/Schevo/setup.py (modified) (1 diff)
• trunk/Schevo/tests/test_calculated_field_unicode.py (modified) (2 diffs)
• trunk/Schevo/tests/test_field.py (modified) (1 diff)

trunk/Schevo/doc/SchevoSchemaDefinition.txt

@@ -486 +486 @@
-
-
-
-
+s
+.
-
-A **HashedValue** field, upon having its value set, will store a
-one-way hash of that value.
-
-
-
-
+
+
+
+
+
+
+
+
-
-This is useful for storing information about a user's password in a
@@ -522 +527 @@
-field, but that it is a multiple-line field.
-
-**Password** fields are used to store plaintext Unicode strings.  An
-application may assume that the contents of a `Password` field should
-not be displayed as plaintext.  **NOTE:** `Password` fields are not
-necessarily secure.  You may wish to use the `HashedValue field type`_
-instead.
-
-
-Blob fields
@@ -577 +576 @@
-Custom field types
-..................
+
+
+Deprecated field types
+......................
+
+Deprecated field types are those field types that are available in
+Schevo in order to support legacy schemata, but are no longer
+recommended for use.
+
+If you have a database schema that uses any of these field types, you
+should use a different field type instead.
+
+When you use a deprecated field type, Schevo will give a Python
+`DeprecationWarning` about such use to encourage you to use a
+different field type.
+
+The following types of fields are deprecated:
+
+- **Password**: Use one of the `HashedValue field types`_ instead.
+
+  If you wish to store a plain-text password in your schema, you can
+  do one of the following:
+
+  * Use the `Unicode` field type::
+
+        class Foo(E.Entity):
+            password = f.unicode()
+
+  * Create a custom `PlaintextPassword` field type::
+
+        class PlaintextPassword(F.Unicode):
+            pass
+
+        class Foo(E.Entity):
+            password = f.plaintext_password()
-
-

trunk/Schevo/schevo/field.py

@@ -190 +190 @@
-    was = None
-
+    _deprecated_class = False
+    _deprecated_class_see_also = None
-    _name = None
-
@@ -479 +481 @@
-
-class HashedValue(Field):
-
-
-
+
-
-    When you assign or set the value of this field, it stores a
@@ -487 +487 @@
-    value itself.  To see if another plaintext value 'matches' the
-    stored hash, use the compare() method.
+
+    When a unicode value, as opposed to a string value, is given to
+    hash or to compare to an existing hash, it will be encoded to a
+    UTF-8 encoded string before the hash or comparison operation
+    occurs.
-
-    hash_header: The value that is prepended to all hashed values, to
@@ -525 +530 @@
-        if value is UNASSIGNED:
-            return value
-
+isinstance(value, str) and 
-            # Short-circuit if the value is already hashed.
-            return value
-        else:
+            if isinstance(value, unicode):
+                value = value.encode('utf8')
-            return self.hash_encode(value)
-
@@ -540 +547 @@
-        algorithm.
-        """
+        if isinstance(value, unicode):
+            value = value.encode('utf8')
-        header_len = len(self.hash_header)
-        salt = hashed_value[header_len:header_len+12]
@@ -563 +572 @@
-
-
+class HashedPassword(HashedValue):
+    """Field that stores a password as a one-way hash."""
+
+
+# --------------------------------------------------------------------
+
+
-class String(Field):
-    """String field class.
@@ -642 +658 @@
-
-    data_type = unicode
-
-
-class Password(Unicode):
-    """Password field class.
-
-    Intended to designate a unicode field as something that stores a
-    plaintext string, but whose value shouldn't be exposed in a UI.
-    """
-
-    data_type = unicode
-
-    def __unicode__(self):
-        v = self.get()
-        if v is UNASSIGNED:
-            return Field.__unicode__(self)
-        else:
-            return u'(Hidden)'
-
-    def reversible(self, value=None):
-        return u''
-
-
@@ -1561 +1557 @@
-
-
+# --------------------------------------------------------------------
+
+
+class Password(Unicode):
+    """Password field class.
+
+    Intended to designate a unicode field as something that stores a
+    plaintext string, but whose value shouldn't be exposed in a UI.
+    """
+
+    data_type = unicode
+
+    _deprecated_class = True
+    _deprecated_class_see_also = 'http://schevo.org/wiki/SchevoSchemaDefinition'
+
+    def __unicode__(self):
+        v = self.get()
+        if v is UNASSIGNED:
+            return Field.__unicode__(self)
+        else:
+            return u'(Hidden)'
+
+    def reversible(self, value=None):
+        return u''
+
+
-optimize.bind_all(sys.modules[__name__])  # Last line of module.
-

trunk/Schevo/schevo/fieldspec.py

@@ -167 +167 @@
-                )
-            warn(msg, DeprecationWarning, 2)
+        # Warn about class deprecation if this class is deprecated.
+        if _Field._deprecated_class:
+            msg = (
+                "%r is a deprecated field type.  "
+                'See %s for more information.'
+                % (self.__class__.__name__, _Field._deprecated_class_see_also)
+                )
+            warn(msg, DeprecationWarning, 2)
-
-    def __call__(self, fn):

trunk/Schevo/schevo/icon/__init__.py

@@ -14 +14 @@
-# Needs to be imported right away.
-import schevo.entity
-import schevo.icon.schema
-
-

trunk/Schevo/setup.py

@@ -114 +114 @@
-    db = schevo.script.db:start
-    shell = schevo.script.shell:start
-
-    [schevo.schema_export]
-    icon=schevo.icon.schema
-    identity=schevo.identity.schema
-    """,
-    )

trunk/Schevo/tests/test_calculated_field_unicode.py

@@ -15 +15 @@
-    class Thing(E.Entity):
-        image = f.image()
-
+hashed_
-        @f.image()
-        def calc_image(self):
-            return self.image
-
+hashed_
-        def calc_password(self):
-            return self.password
@@ -31 +31 @@
-        # Unicode reprs of fields on thing itself.
-        assert unicode(thing.f.image) == u'(Binary data)'
-Hidden
+Encrypted
-        assert unicode(thing.f.calc_image) == u'(Binary data)'
-Hidden
+Encrypted
-        # Unicode reprs of fields on thing's default view.
-        thing_view = thing.v.default()
-        assert unicode(thing_view.f.image) == u'(Binary data)'
-Hidden
+Encrypted
-        assert unicode(thing_view.f.calc_image) == u'(Binary data)'
-Hidden
+Encrypted
-
-

trunk/Schevo/tests/test_field.py

@@ -531 +531 @@
-
-
-
+Hashed
-
-    def test_unicode_representation(self):
-
+Hashed
-        f.set('some-password')
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-