Merge lp:~nataliabidart/ubuntuone-client/careful-logging into lp:ubuntuone-client

[Natalia Bidart]

- Do not log sensible data in CredentialsMangementTool (LP: #837488).

[Roberto Alsina (ralsina)]

+1

review: Approve

=== modified file 'ubuntuone/logger.py'
--- ubuntuone/logger.py	2011-08-17 12:41:58 +0000
+++ ubuntuone/logger.py	2011-08-30 16:22:23 +0000
@@ -240,9 +240,11 @@
             return True
 
 
-def log_call(log_func):
+def log_call(log_func, with_args=True, with_result=True):
     """Decorator to add a log entry using 'log_func'.
 
+    If not 'with_args', do not log arguments. Same apply to 'with_result'.
+
     An example of use would be:
 
     @log_call(logger.debug)
@@ -257,9 +259,19 @@
         @functools.wraps(f)
         def inner(*args, **kwargs):
             """Call f(*args, **kwargs)."""
-            log_func('%s: args %r, kwargs %r.', f.__name__, args, kwargs)
+            if with_args:
+                a, kw = args, kwargs
+            else:
+                a, kw = '<hidden args>', '<hidden kwargs>'
+            log_func('%s: args %r, kwargs %r.', f.__name__, a, kw)
+
             res = f(*args, **kwargs)
-            log_func('%s: result %r.', f.__name__, res)
+
+            if with_result:
+                log_func('%s: result %r.', f.__name__, res)
+            else:
+                log_func('%s: result %r.', f.__name__, '<hidden result>')
+
             return res
 
         return inner
 
=== modified file 'ubuntuone/platform/credentials/__init__.py'
--- ubuntuone/platform/credentials/__init__.py	2011-08-25 12:25:02 +0000
+++ ubuntuone/platform/credentials/__init__.py	2011-08-30 16:22:23 +0000
@@ -122,7 +122,8 @@
             self._proxy = yield source.get_creds_proxy()
         defer.returnValue(self._proxy)
 
-    @log_call(logger.debug)
+    # do not log returned credentials
+    @log_call(logger.debug, with_result=False)
     @defer.inlineCallbacks
     def find_credentials(self):
         """Find credentials for Ubuntu One.
@@ -199,7 +200,8 @@
 
         yield d
 
-    @log_call(logger.debug)
+    # do not log token
+    @log_call(logger.debug, with_args=False)
     @defer.inlineCallbacks
     def store_credentials(self, token):
         """Store credentials for Ubuntu One.
@@ -234,7 +236,8 @@
 
         yield d
 
-    @log_call(logger.debug)
+    # do not log returned credentials
+    @log_call(logger.debug, with_result=False)
     @defer.inlineCallbacks
     def register(self, window_id=0):
         """Register to Ubuntu One.
@@ -281,7 +284,8 @@
         result = yield d
         defer.returnValue(result)
 
-    @log_call(logger.debug)
+    # do not log returned credentials
+    @log_call(logger.debug, with_result=False)
     @defer.inlineCallbacks
     def login(self, window_id=0):
         """Login to Ubuntu One.
@@ -329,7 +333,8 @@
         result = yield d
         defer.returnValue(result)
 
-    @log_call(logger.debug)
+    # do not log password nor returned credentials
+    @log_call(logger.debug, with_args=False, with_result=False)
     @defer.inlineCallbacks
     def login_email_password(self, email, password):
         """Login to Ubuntu One.