[#10] Added security level param to API methods.

Author: todofixthis

iota/multisig/api.py

@@ -6,6 +6,7 @@
 
 from iota import Address, Iota, ProposedTransaction
 from iota.commands import discover_commands
+from iota.crypto.addresses import AddressGenerator
 from iota.crypto.types import Digest
 from iota.multisig import commands
 from iota.multisig.types import MultisigAddress
@@ -22,7 +23,7 @@ class MultisigIota(Iota):
   **CAUTION:** Make sure you understand how multisig works before
   attempting to use it.  If you are not careful, you could easily
   compromise the security of your private keys, send IOTAs to
-  inaccessible addresses, etc.
+  unspendable addresses, etc.
 
   References:
     - https://github.com/iotaledger/wiki/blob/master/multisigs.md
@@ -53,8 +54,13 @@ def create_multisig_address(self, digests):
       digests = digests,
     )
 
-  def get_digests(self, index=0, count=1):
-    # type: (int, int) -> dict
+  def get_digests(
+      self,
+      index = 0,
+      count = 1,
+      security_level = AddressGenerator.DEFAULT_SECURITY_LEVEL,
+  ):
+    # type: (int, int, int) -> dict
     """
     Generates one or more key digests from the seed.
 
@@ -66,6 +72,14 @@ def get_digests(self, index=0, count=1):
     :param count:
       Number of digests to generate.
 
+    :param security_level:
+      Number of iterations to use when generating new addresses.
+
+      Larger values take longer, but the resulting signatures are more
+      secure.
+
+      This value must be between 1 and 3, inclusive.
+
     :return:
       Dict with the following items::
 
@@ -76,13 +90,19 @@ def get_digests(self, index=0, count=1):
          }
     """
     return commands.GetDigestsCommand(self.adapter)(
-      seed  = self.seed,
-      index = index,
-      count = count,
+      seed          = self.seed,
+      index         = index,
+      count         = count,
+      securityLevel = security_level,
     )
 
-  def get_private_keys(self, index=0, count=1):
-    # type: (int, int) -> dict
+  def get_private_keys(
+      self,
+      index = 0,
+      count = 1,
+      security_level = AddressGenerator.DEFAULT_SECURITY_LEVEL,
+  ):
+    # type: (int, int, int) -> dict
     """
     Generates one or more private keys from the seed.
 
@@ -95,6 +115,14 @@ def get_private_keys(self, index=0, count=1):
     :param count:
       Number of keys to generate.
 
+    :param security_level:
+      Number of iterations to use when generating new keys.
+
+      Larger values take longer, but the resulting signatures are more
+      secure.
+
+      This value must be between 1 and 3, inclusive.
+
     :return:
       Dict with the following items::
 
@@ -109,16 +137,17 @@ def get_private_keys(self, index=0, count=1):
       - https://github.com/iotaledger/wiki/blob/master/multisigs.md#how-m-of-n-works
     """
     return commands.GetPrivateKeysCommand(self.adapter)(
-      seed  = self.seed,
-      index = index,
-      count = count,
+      seed          = self.seed,
+      index         = index,
+      count         = count,
+      securityLevel = security_level,
     )
 
   def prepare_multisig_transfer(
       self,
       transfers,
       multisig_input,
-      change_address=None,
+      change_address = None,
   ):
     # type: (Iterable[ProposedTransaction], MultisigAddress, Optional[Address]) -> dict
     """

iota/multisig/commands/get_digests.py

@@ -2,12 +2,15 @@
 from __future__ import absolute_import, division, print_function, \
   unicode_literals
 
+from typing import Optional
+
 import filters as f
+
 from iota.commands import FilterCommand, RequestFilter
+from iota.crypto.addresses import AddressGenerator
 from iota.crypto.types import Seed
 from iota.filters import Trytes
 from iota.multisig.commands.get_private_keys import GetPrivateKeysCommand
-from typing import Optional
 
 __all__ = [
   'GetDigestsCommand',
@@ -30,15 +33,18 @@ def get_response_filter(self):
     pass
 
   def _execute(self, request):
-    count = request['count'] # type: Optional[int]
-    index = request['index'] # type: int
-    seed  = request['seed'] # type: Seed
-
-    gpk_result = GetPrivateKeysCommand(self.adapter)(
-      seed  = seed,
-      count = count,
-      index = index,
-    )
+    count           = request['count'] # type: Optional[int]
+    index           = request['index'] # type: int
+    seed            = request['seed'] # type: Seed
+    security_level  = request['securityLevel'] # type: int
+
+    gpk_result =\
+      GetPrivateKeysCommand(self.adapter)(
+        seed          = seed,
+        count         = count,
+        index         = index,
+        securityLevel = security_level,
+      )
 
     return {
       'digests': [key.get_digest() for key in gpk_result['keys']],
@@ -49,15 +55,26 @@ class GetDigestsRequestFilter(RequestFilter):
   def __init__(self):
     super(GetDigestsRequestFilter, self).__init__(
       {
-        # ``count`` and ``index`` are optional.
-        'count':  f.Type(int) | f.Min(1) | f.Optional(default=1),
-        'index':  f.Type(int) | f.Min(0) | f.Optional(default=0),
+        # Optional Parameters
+        'count':
+          f.Type(int) | f.Min(1) | f.Optional(default=1),
+
+        'index':
+          f.Type(int) | f.Min(0) | f.Optional(default=0),
+
+        'securityLevel':
+            f.Type(int)
+          | f.Min(1)
+          | f.Optional(default=AddressGenerator.DEFAULT_SECURITY_LEVEL),
 
-        'seed':   f.Required | Trytes(result_type=Seed),
+        # Required Parameters
+        'seed':
+          f.Required | Trytes(result_type=Seed),
       },
 
       allow_missing_keys = {
         'count',
         'index',
+        'securityLevel',
       },
     )

iota/multisig/commands/get_private_keys.py

@@ -2,12 +2,15 @@
 from __future__ import absolute_import, division, print_function, \
   unicode_literals
 
+from typing import Optional
+
 import filters as f
+
 from iota.commands import FilterCommand, RequestFilter
+from iota.crypto.addresses import AddressGenerator
 from iota.crypto.signing import KeyGenerator
 from iota.crypto.types import Seed
 from iota.filters import Trytes
-from typing import Optional
 
 __all__ = [
   'GetPrivateKeysCommand',
@@ -31,30 +34,43 @@ def get_response_filter(self):
     pass
 
   def _execute(self, request):
-    count = request['count'] # type: Optional[int]
-    index = request['index'] # type: int
-    seed  = request['seed'] # type: Seed
+    count           = request['count'] # type: Optional[int]
+    index           = request['index'] # type: int
+    seed            = request['seed'] # type: Seed
+    security_level  = request['securityLevel'] # type: int
 
     generator = KeyGenerator(seed)
 
     return {
-      'keys': generator.get_keys(start=index, count=count),
+      'keys':
+        generator.get_keys(start=index, count=count, iterations=security_level),
     }
 
 
 class GetPrivateKeysRequestFilter(RequestFilter):
   def __init__(self):
     super(GetPrivateKeysRequestFilter, self).__init__(
       {
-        # ``count`` and ``index`` are optional.
-        'count':  f.Type(int) | f.Min(1) | f.Optional(default=1),
-        'index':  f.Type(int) | f.Min(0) | f.Optional(default=0),
+        # Optional Parameters
+        'count':
+          f.Type(int) | f.Min(1) | f.Optional(default=1),
+
+        'index':
+          f.Type(int) | f.Min(0) | f.Optional(default=0),
+
+        'securityLevel':
+            f.Type(int)
+          | f.Min(1)
+          | f.Optional(default=AddressGenerator.DEFAULT_SECURITY_LEVEL),
 
-        'seed':   f.Required | Trytes(result_type=Seed),
+        # Required Parameters
+        'seed':
+          f.Required | Trytes(result_type=Seed),
       },
 
       allow_missing_keys = {
         'count',
         'index',
+        'securityLevel',
       },
     )