[feature] generate recovery code

with @tayane

4 files changed, 112 insertions, 0 deletions

diff --git a/client/src/leap/soledad/client/_recovery_code.py b/client/src/leap/soledad/client/_recovery_code.py
new file mode 100644
index 00000000..04235a29
--- /dev/null
+++ b/client/src/leap/soledad/client/_recovery_code.py
@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+# _recovery_code.py
+# Copyright (C) 2017 LEAP
+#
+# 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import binascii
+
+from leap.soledad.common.log import getLogger
+
+logger = getLogger(__name__)
+
+
+class RecoveryCode(object):
+
+    # When we turn this string to hex, it will double in size
+    code_length = 6
+
+    def generate(self):
+        logger.info("generating new recovery code...")
+        return binascii.hexlify(os.urandom(self.code_length))
diff --git a/client/src/leap/soledad/client/api.py b/client/src/leap/soledad/client/api.py
index 3b17f188..23f8570e 100644
--- a/client/src/leap/soledad/client/api.py
+++ b/client/src/leap/soledad/client/api.py
@@ -55,6 +55,7 @@ from leap.soledad.client import adbapi
 from leap.soledad.client import events as soledad_events
 from leap.soledad.client import interfaces as soledad_interfaces
 from leap.soledad.client import sqlcipher
+from leap.soledad.client._recovery_code import RecoveryCode
 from leap.soledad.client._secrets import Secrets
 from leap.soledad.client._crypto import SoledadCrypto
 
@@ -187,6 +188,7 @@ class Soledad(object):
         self._init_config_with_defaults()
         self._init_working_dirs()
 
+        self._recovery_code = RecoveryCode()
         self._secrets = Secrets(self)
         self._crypto = SoledadCrypto(self._secrets.remote_secret)
 
@@ -797,6 +799,9 @@ class Soledad(object):
         doc = {'type': 'servicetoken', 'service': service, 'token': token}
         return self.create_doc(doc)
 
+    def create_recovery_code(self):
+        return self._recovery_code.generate()
+
 
 def create_path_if_not_exists(path):
     try:
diff --git a/testing/tests/client/test_api.py b/testing/tests/client/test_api.py
new file mode 100644
index 00000000..3c6a8155
--- /dev/null
+++ b/testing/tests/client/test_api.py
@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# test_api.py
+# Copyright (C) 2017 LEAP
+#
+# 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+"""
+Tests for soledad api.
+"""
+
+from mock import MagicMock
+
+from test_soledad.util import BaseSoledadTest
+
+
+class ApiTestCase(BaseSoledadTest):
+
+    def test_recovery_code_creation(self):
+        recovery_code_mock = MagicMock()
+        generated_code = '4645a2f8997e5d0d'
+        recovery_code_mock.generate.return_value = generated_code
+        self._soledad._recovery_code = recovery_code_mock
+
+        code = self._soledad.create_recovery_code()
+
+        self.assertEqual(generated_code, code)
diff --git a/testing/tests/client/test_recovery_code.py b/testing/tests/client/test_recovery_code.py
new file mode 100644
index 00000000..7bbccc41
--- /dev/null
+++ b/testing/tests/client/test_recovery_code.py
@@ -0,0 +1,38 @@
+# -*- CODing: utf-8 -*-
+# test_recovery_code.py
+# Copyright (C) 2017 LEAP
+#
+# 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+"""
+Tests for recovery code generation.
+"""
+import binascii
+
+from mock import patch
+from twisted.trial import unittest
+from leap.soledad.client._recovery_code import RecoveryCode
+
+
+class RecoveryCodeTestCase(unittest.TestCase):
+
+    @patch('leap.soledad.client._recovery_code.os.urandom')
+    def test_generate_recovery_code(self, mock_os_urandom):
+        generated_random_code = '123456'
+        mock_os_urandom.return_value = generated_random_code
+        recovery_code = RecoveryCode()
+
+        code = recovery_code.generate()
+
+        mock_os_urandom.assert_called_with(RecoveryCode.code_length)
+        self.assertEqual(binascii.hexlify(generated_random_code), code)