Remove parameters containing passwords from Notifications.

compute.manager methods often takes password parameters in methods
that are wrapped with exception handlers and notifiers. What can
happen is these passwords will get bundled up and sent outside of
the system.

This patch will strip out any parameter with *_pass* in the name.

The side effect of this is that all notification will have the
error parameters in the 'args' part of the notification payload.
Previously only the positional args were in the 'args' part and
keyword args were placed in the payload directly.

This may affect consumers of the error notifications.

Change-Id: I2e7822eb5416d315ceb690f739e4dba9d52a7954

nova/exception.py

@@ -31,6 +31,7 @@ import webob.exc
 
 from nova.openstack.common import excutils
 from nova.openstack.common import log as logging
+from nova import safe_utils
 
 LOG = logging.getLogger(__name__)
 
@@ -71,6 +72,11 @@ class ProcessExecutionError(IOError):
         IOError.__init__(self, message)
 
 
+def _cleanse_dict(original):
+    """Strip all admin_password, new_pass, rescue_pass keys from a dict."""
+    return dict((k, v) for k, v in original.iteritems() if not "_pass" in k)
+
+
 def wrap_exception(notifier=None, publisher_id=None, event_type=None,
                    level=None):
     """This decorator wraps a method to catch any exceptions that may
@@ -89,8 +95,10 @@ def wrap_exception(notifier=None, publisher_id=None, event_type=None,
             except Exception, e:
                 with excutils.save_and_reraise_exception():
                     if notifier:
-                        payload = dict(args=args, exception=e)
-                        payload.update(kw)
+                        payload = dict(exception=e)
+                        call_dict = safe_utils.getcallargs(f, *args, **kw)
+                        cleansed = _cleanse_dict(call_dict)
+                        payload.update({'args': cleansed})
 
                         # Use a temp vars so we don't shadow
                         # our outer definitions.

nova/safe_utils.py

@@ -0,0 +1,55 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2010 United States Government as represented by the
+# Administrator of the National Aeronautics and Space Administration.
+# Copyright 2011 Justin Santa Barbara
+# All Rights Reserved.
+#
+#    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.
+
+"""Utilities and helper functions that won't produce circular imports."""
+
+import inspect
+
+
+def getcallargs(function, *args, **kwargs):
+    """This is a simplified inspect.getcallargs (2.7+).
+
+    It should be replaced when python >= 2.7 is standard.
+    """
+    keyed_args = {}
+    argnames, varargs, keywords, defaults = inspect.getargspec(function)
+
+    keyed_args.update(kwargs)
+
+    #NOTE(alaski) the implicit 'self' or 'cls' argument shows up in
+    # argnames but not in args or kwargs.  Uses 'in' rather than '==' because
+    # some tests use 'self2'.
+    if 'self' in argnames[0] or 'cls' == argnames[0]:
+        # The function may not actually be a method or have im_self.
+        # Typically seen when it's stubbed with mox.
+        if inspect.ismethod(function) and hasattr(function, 'im_self'):
+            keyed_args[argnames[0]] = function.im_self
+        else:
+            keyed_args[argnames[0]] = None
+
+    remaining_argnames = filter(lambda x: x not in keyed_args, argnames)
+    keyed_args.update(dict(zip(remaining_argnames, args)))
+
+    if defaults:
+        num_defaults = len(defaults)
+        for argname, value in zip(argnames[-num_defaults:], defaults):
+            if argname not in keyed_args:
+                keyed_args[argname] = value
+
+    return keyed_args

nova/utils.py

@@ -1381,39 +1381,6 @@ def get_wrapped_function(function):
     return _get_wrapped_function(function)
 
 
-def getcallargs(function, *args, **kwargs):
-    """This is a simplified inspect.getcallargs (2.7+).
-
-    It should be replaced when python >= 2.7 is standard.
-    """
-    keyed_args = {}
-    argnames, varargs, keywords, defaults = inspect.getargspec(function)
-
-    keyed_args.update(kwargs)
-
-    #NOTE(alaski) the implicit 'self' or 'cls' argument shows up in
-    # argnames but not in args or kwargs.  Uses 'in' rather than '==' because
-    # some tests use 'self2'.
-    if 'self' in argnames[0] or 'cls' == argnames[0]:
-        # The function may not actually be a method or have im_self.
-        # Typically seen when it's stubbed with mox.
-        if inspect.ismethod(function) and hasattr(function, 'im_self'):
-            keyed_args[argnames[0]] = function.im_self
-        else:
-            keyed_args[argnames[0]] = None
-
-    remaining_argnames = filter(lambda x: x not in keyed_args, argnames)
-    keyed_args.update(dict(zip(remaining_argnames, args)))
-
-    if defaults:
-        num_defaults = len(defaults)
-        for argname, value in zip(argnames[-num_defaults:], defaults):
-            if argname not in keyed_args:
-                keyed_args[argname] = value
-
-    return keyed_args
-
-
 class ExceptionHelper(object):
     """Class to wrap another and translate the ClientExceptions raised by its
     function calls to the actual ones"""